Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

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

Property group 'Decals'

DecalMaxLifeSpan

Type: float

Set to zero to use decal's default values.

DecalMinLifeSpan

Type: float


DecalPercent

Type: float

Percent of decals per particles.

Default value: 0.1

DecalType

Type: class<Decal>

Type of Decals to spray.

Property group 'Display'

MaxAnimRate

Type: float


MinAnimRate

Type: float


Property group 'ParticleSprayer'

bDisableTick

Type: bool


Default value: True

bGrouped

Type: bool


bInitiallyOn

Type: bool


Default value: True

bInterpolate

Type: bool


bIsWindResistant

Type: bool


bLinearFrequenciesChanged

Type: bool


Default value: True

bLOSClip

Type: bool


bOn

Type: bool


bRotationGrouped

Type: bool


Gravity

Type: Object.Vector


MeshData

Type: AdditionalData

Array size: 16


MinVolume

Type: float


NumTemplates

Type: byte


ParticleDistribution

Type: EDistribution


Particles

Type: Texture

Array size: 16


PrimeCount

Type: float


RotationPoint

Type: Object.Vector


Spread

Type: float


Default value: 45.0

Templates

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

Type: float


Volume

Type: float


Default value: 10.0

VolumeScalePct

Type: float


Default value: 0.5

Internal variables

CumulativeFreqs

Type: float

Array size: 16


DecalTimer

Type: float


FollowActor

Type: Actor


FollowOffset

Type: Object.Vector


Frequencies

Type: float

Array size: 16


InternalTimer

Type: float


RelativeOffset

Type: Object.Vector


RelativeRotation

Type: Object.Rotator


Default values

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

EDistribution

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

Structs

AdditionalData

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

STRUCT_Particle

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

Native functions

RotateParticles

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


ShiftParticles

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


Events

PreBeginPlay

simulated event PreBeginPlay ()

Overrides: Actor.PreBeginPlay


Tick

simulated event Tick (float DeltaTime)

Overrides: Actor.Tick


Other instance functions

See ParticleSprayer instance functions.

States

TriggerControl

Modifiers: simulated

TriggerControl.Trigger

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

Overrides: Actor.Trigger (global)


TriggerControl.UnTrigger

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

Overrides: Actor.UnTrigger (global)


TriggerTimed

Modifiers: simulated

TriggerTimed.Trigger

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

Overrides: Actor.Trigger (global)


TriggerToggle

Modifiers: simulated

TriggerToggle.Trigger

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

Overrides: Actor.Trigger (global)