I love the smell of UnrealEd crashing in the morning. – tarquin

UE2:ParticleSprayer (U2XMP)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
U2XMP Object >> Actor >> ParticleSprayer
Package: 
ParticleSystems

ParticleSprayer.uc $Author: Mfox $ $Date: 6/25/02 11:40p $ $Revision: 6 $

Description: How to use this class:

Place in a level.
Aim in the desired direction.
Set properties as desired.

Todo:

Decide whether ParticleSprayers should have no replication, or if they

should be triggered, etc on the server-side, and have the variables

replicated to the clients. Currently there is no replication. If we ever want to do puzzles with it, it should probably run server-side and replicate changes to the clients.

Add rotation interpolation.

Properties[edit]

Property group 'Decals'[edit]

DecalMaxLifeSpan[edit]

Type: float

Set to zero to use decal's default values.

DecalMinLifeSpan[edit]

Type: float


DecalPercent[edit]

Type: float

Percent of decals per particles.

Default value: 0.1

DecalType[edit]

Type: class<Decal>

Type of Decals to spray.

Property group 'Display'[edit]

MaxAnimRate[edit]

Type: float


MinAnimRate[edit]

Type: float


Property group 'ParticleSprayer'[edit]

bDisableTick[edit]

Type: bool


Default value: True

bGrouped[edit]

Type: bool


bInitiallyOn[edit]

Type: bool


Default value: True

bInterpolate[edit]

Type: bool


bIsWindResistant[edit]

Type: bool


bLinearFrequenciesChanged[edit]

Type: bool


Default value: True

bLOSClip[edit]

Type: bool


bOn[edit]

Type: bool


bRotationGrouped[edit]

Type: bool


Gravity[edit]

Type: Object.Vector


MeshData[edit]

Type: AdditionalData

Array size: 16


MinVolume[edit]

Type: float


NumTemplates[edit]

Type: byte


ParticleDistribution[edit]

Type: EDistribution


Particles[edit]

Type: Texture

Array size: 16


PrimeCount[edit]

Type: float


RotationPoint[edit]

Type: Object.Vector


Spread[edit]

Type: float


Default value: 45.0

Templates[edit]

Type: STRUCT_Particle

Array size: 16


Default value, index 0:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 1:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 10:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 11:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 12:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 13:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 14:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 15:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 16:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 17:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 18:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 19:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 20:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 21:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 22:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

Default value, index 23:

Member Value
LifeSpan 1.0
MaxDrawScale 1.0
MaxScaleGlow 1.0
MinDrawScale 1.0
MinScaleGlow 1.0
Weight 1.0

TimerDuration[edit]

Type: float


Volume[edit]

Type: float


Default value: 10.0

VolumeScalePct[edit]

Type: float


Default value: 0.5

Internal variables[edit]

CumulativeFreqs[edit]

Type: float

Array size: 16


DecalTimer[edit]

Type: float


FollowActor[edit]

Type: Actor


FollowOffset[edit]

Type: Object.Vector


Frequencies[edit]

Type: float

Array size: 16


InternalTimer[edit]

Type: float


RelativeOffset[edit]

Type: Object.Vector


RelativeRotation[edit]

Type: Object.Rotator


Default values[edit]

Property Value
bDirectional True
bGameRelevant True
bSpecialRotationRep True
bStatic True
RemoteRole ROLE_None
RenderIteratorClass Class'ParticleSystems.ParticleSprayerRI'
Rotation
Member Value
Pitch 16384
Style STY_Translucent
Texture Texture'ParticleSystems.Icons.S_ParticleSprayer'
VisibilityHeight 1600.0
VisibilityRadius 1600.0

Enums[edit]

EDistribution[edit]

DIST_Random 
Randomly pick a particle from the particle list.
DIST_Linear 
Cyclically iterate though the particle list.

Structs[edit]

AdditionalData[edit]

Object.Rotator MaxInitialRotation 
Object.Rotator MinInitialRotation 
Object.Rotator MaxRotationRate 
Object.Rotator MinRotationRate 

STRUCT_Particle[edit]

float LifeSpan 
Number of seconds before destruction.
float Weight 
Relative probability of being chosen with DIST_Random.
float MaxInitialVelocity 
Velocity to start out with.
float MinInitialVelocity 
float MaxDrawScale 
DrawScale to start out with.
float MinDrawScale 
float MaxScaleGlow 
ScaleGlow to start out with.
float MinScaleGlow 
byte GrowPhase 
Number of toggles per lifespan. (Toggles meaning inverting the GrowRate)
float MaxGrowRate 
DrawScale per second. (positive values mean grow)
float MinGrowRate 
(negative values mean shrink)
byte FadePhase 
Number of toggles per lifespan. (Toggles meaning inverting the FadeRate)
float MaxFadeRate 
ScaleGlow per second. (positive values mean fade in)
float MinFadeRate 
(negative values mean fade out)

Functions[edit]

Native functions[edit]

RotateParticles[edit]

native(1004) final function RotateParticles (Object.Rotator Delta, optional Object.Vector Origin)


ShiftParticles[edit]

native(1003) final function ShiftParticles (Object.Vector Delta)


Events[edit]

PreBeginPlay[edit]

simulated event PreBeginPlay ()

Overrides: Actor.PreBeginPlay


Tick[edit]

simulated event Tick (float DeltaTime)

Overrides: Actor.Tick


Other instance functions[edit]

See ParticleSprayer instance functions.

States[edit]

TriggerControl[edit]

Modifiers: simulated

TriggerControl.Trigger[edit]

simulated function Trigger (Actor Other, Pawn EventInstigator, optional name EventName)

Overrides: Actor.Trigger (global)


TriggerControl.UnTrigger[edit]

simulated function UnTrigger (Actor Other, Pawn EventInstigator, optional name EventName)

Overrides: Actor.UnTrigger (global)


TriggerTimed[edit]

Modifiers: simulated

TriggerTimed.Trigger[edit]

simulated function Trigger (Actor Other, Pawn EventInstigator, optional name EventName)

Overrides: Actor.Trigger (global)


TriggerToggle[edit]

Modifiers: simulated

TriggerToggle.Trigger[edit]

simulated function Trigger (Actor Other, Pawn EventInstigator, optional name EventName)

Overrides: Actor.Trigger (global)