I'm a doctor, not a mechanic

UE2:ParticleGenerator (U2XMP)

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

Contents

Package: 
ParticleSystems
Known classes within ParticleGenerator:
ActorCollisionNotifier, ActorParticleTemplate, AnchorForce, AttractionForce, CollisionAnchor, CollisionDiscForce, CollisionGlider, CollisionSphereForce, ColorForce, DecayForce, DestroyOnDamage, FadeForce, FadeInForce, FadeOutForce, FlameDamageNotifier, Force, FrictionForce, FT_ParticleDamage, GeoCollideAndMerge, GeometryCollider, GeometryColliderEx, GlobalAccelerator, ImpactHandlerForce, InertiaForce, LGalt_GeometryCollider, LGalt_GeometryColliderFertile, LGalt_GeometryColliderFertileScripted, LG_ParticleDamage, LG_ParticleDamageEx, LimitedResizeForce, LocationGrouped, LocatorForce, MaxVelocityForce, MeshAnchor, MinDecayForce, MoveZig, MultiTemplateForce, NeuralNetForce, OnDestroyForce, OscillatingPerParticleForce, ParticleDamage, ParticleDecalTemplate, ParticleTemplate, PerParticleFriction, PerParticleGravity, PointParticleTemplate, RecursiveParticleTemplate, RepulsionForce, ResizeForce, RigidBody, RotatingParticleTemplate, RotationForce, RotationGrouped, SlipForce, SpringForce, SpringLocator, Sprite3DParticleTemplate, SpriteParticleTemplate, StrandParticleTemplate, StreakParticleTemplate, TarpCollider, TexturedStreakParticleTemplate, TriangleForce, TriangleParticleTemplate, TriForce, TriParticleTemplate, VariablePerParticleGravity, ViewVelocityScaledParticleTemplate, VoidDestroyer, WetWindshildParticleTemplate, WindForce
Direct subclasses:
ParticleBlower, BarbbieHareDesigner, BreakableGlass, ParticleSalamander, LineManager, ParticleAffector, ParticleRadiator, ParticleSkeleton, PulseLineGenerator, TarpBuilder
This class in other games:
U2

$Author: Mfox $ $Date: 2/27/03 7:06p $ $Revision: 25 $ Name: ParticleGenerator.uc Author: Aaron R Leiby Date: 4 March 2000 Description: Base class of all particle generators. How to use this class:

Constants[edit]

PARTICLEVERSION_Current[edit]

Value: 3


PARTICLEVERSION_AutoLit[edit]

Value: 3


PARTICLEVERSION_AffectingForces[edit]

Value: 2


PARTICLEVERSION_NumParticlesFix[edit]

Value: 1


Properties[edit]

Property group 'ParticleAdvanced'[edit]

bCollisionBound[edit]

Type: bool

Modifiers: public


bInterpolate[edit]

Type: bool

Modifiers: public


bLockParticles[edit]

Type: bool

Modifiers: public

Disable forces, cleaning, and render relative to the system.

bShowBoundingBox[edit]

Type: bool

Modifiers: public


DefaultForces[edit]

Type: array<class<Force> >

Modifiers: public

Forces automatically installed when spawned.

Default value, index 0: Class'ParticleSystems.DecayForce'

Default value, index 1: Class'ParticleSystems.LocatorForce'

IdleTime[edit]

Type: float

Modifiers: public


IgnoredForces[edit]

Type: array<name>

Modifiers: public


MaxTickSize[edit]

Type: float

Modifiers: public


Default value: 0.008333

ParticleLifeSpan[edit]

Type: float

Modifiers: public


ParticleVersion[edit]

Type: int

Modifiers: public


PrimeTime[edit]

Type: float

Modifiers: public


Property group 'ParticleGenerator'[edit]

bOn[edit]

Type: bool

Modifiers: public


Default value: True

Forces[edit]

Type: OrderedArray<Force>

Modifiers: public, editinline


ParticleTemplates[edit]

Type: OrderedArray<ParticleTemplate>

Modifiers: public, editinline


Property group 'ParticleSelection'[edit]

bLinearFrequenciesChanged[edit]

Type: bool

Modifiers: public


Default value: True

SelectionMethod[edit]

Type: Select

Modifiers: public


Default value: SELECT_Random

Property group 'Sound'[edit]

SoundLoop[edit]

Type: Sound

Modifiers: public


SoundOff[edit]

Type: Sound

Modifiers: public


SoundOn[edit]

Type: Sound

Modifiers: public


Property group 'TriggerSupport'[edit]

bInitiallyOn[edit]

Type: bool

Modifiers: public


Default value: True

MaxParticles[edit]

Type: int

Modifiers: public

Maximum particles emitted per trigger.

RampDownTime[edit]

Type: float

Modifiers: public


RampUpTime[edit]

Type: float

Modifiers: public


TimerDuration[edit]

Type: float

Modifiers: public


Trig[edit]

Type: Button

Modifiers: public


Default value: "SendTrigger"

UnTrig[edit]

Type: Button

Modifiers: public


Default value: "SendUnTrigger"

Internal variables[edit]

bAttachment[edit]

Type: bool

Modifiers: private

Set if we are a golem attachment.

InternalTimer[edit]

Type: float

Modifiers: private


LargestWeight[edit]

Type: float

Modifiers: private

The currently largest linear weight.

LastBoundSizeSquared[edit]

Type: float

Modifiers: private, transient


LastLocation[edit]

Type: Object.Vector

Modifiers: private, transient


LastPitch[edit]

Type: float

Modifiers: private, transient


LastRoll[edit]

Type: float

Modifiers: private, transient


LastTimeDrawn[edit]

Type: float

Modifiers: private, transient


LastYaw[edit]

Type: float

Modifiers: private, transient


LockedLocalToWorld[edit]

Type: Object.Matrix

Modifiers: private

Used interally for rendering locked systems relatively.

Default value:

Member Value
WPlane
Member Value
W 1.0
XPlane
Member Value
X 1.0
YPlane
Member Value
Y 1.0
ZPlane
Member Value
Z 1.0

ParticleCount[edit]

Type: int

Modifiers: private

Used internally to enforce ParticleCount.

RampDir[edit]

Type: Ramp

Modifiers: private


RampTimer[edit]

Type: float

Modifiers: private


TemplateIndex[edit]

Type: int

Modifiers: private

Current index into the particle template list.

TemplateIteration[edit]

Type: int

Modifiers: private


VolumeScale[edit]

Type: float

Modifiers: protected


Default values[edit]

Property Value
bAcceptsProjectors True
bBlockNonZeroExtentTraces False
bBlockZeroExtentTraces False
bCanTeleport True
bEdCanOverlap True
bUnlit True
DrawType DT_Custom
RemoteRole ROLE_None
Style STY_Translucent
VisibilityHeight 5000.0
VisibilityRadius 5000.0

Enums[edit]

Ramp[edit]

RAMP_None 
RAMP_Up 
RAMP_Down 

Select[edit]

SELECT_Linear 
Cyclically iterate through the ParticleTemplates array.
SELECT_Random 
Randomly pick a particle from the ParticleTemplates array.

Functions[edit]

Static native functions[edit]

ParticleGetLocation[edit]

static native function Object.Vector ParticleGetLocation (Object.ParticleHandle P)


ParticleGetVelocity[edit]

static native function Object.Vector ParticleGetVelocity (Object.ParticleHandle P)


ParticleSetLocation[edit]

static native function ParticleSetLocation (Object.ParticleHandle P, Object.Vector Loc)


ParticleSetVelocity[edit]

static native function ParticleSetVelocity (Object.ParticleHandle P, Object.Vector Vel)


Other static functions[edit]

CreateNew[edit]

public static function ParticleGenerator CreateNew (Actor Helper, ParticleGenerator Template, optional Object.Vector Location)


DynamicCreateNew[edit]

public static function ParticleGenerator DynamicCreateNew (Actor Helper, Class Type, string TemplateName, optional Object.Vector Location)


Native functions[edit]

AddForce[edit]

public native event AddForce (Force AddedForce)


AddTemplate[edit]

public native event AddTemplate (ParticleTemplate T)


Clean[edit]

public native event Clean ()


Conform[edit]

public native event Conform (ParticleGenerator Image, optional bool bDeleteExisting)


Duplicate[edit]

public native event Duplicate (out ParticleGenerator D, Level L)


ExchangeTemplate[edit]

public native event ExchangeTemplate (ParticleTemplate Old, ParticleTemplate New)


GetParticleTemplates[edit]

public native event GetParticleTemplates (out Object T)


LockParticles[edit]

public native event LockParticles ()


ManualTick[edit]

public native event ManualTick (float DeltaSeconds)


RegisterExternallyAffectedTemplates[edit]

public native event RegisterExternallyAffectedTemplates ()


RemoveForce[edit]

public native event RemoveForce (Force RemovedForce)


RemoveForceType[edit]

public native event RemoveForceType (name ClassName, optional bool bAndSubclasses)


RemoveTemplate[edit]

public native event RemoveTemplate (ParticleTemplate T)


RemoveTemplateType[edit]

public native event RemoveTemplateType (name ClassName, optional bool bAndSubclasses)


UnLockParticles[edit]

public native event UnLockParticles ()


UnRegisterExternallyAffectedTemplates[edit]

public native event UnRegisterExternallyAffectedTemplates ()


ValidateComponents[edit]

public native event ValidateComponents ()


GetMaxLifeSpan[edit]

public native function float GetMaxLifeSpan ()


Events[edit]

Destroyed[edit]

simulated event Destroyed ()

Overrides: Actor.Destroyed


PostBeginPlay[edit]

simulated event PostBeginPlay ()

Overrides: Actor.PostBeginPlay


PreBeginPlay[edit]

simulated event PreBeginPlay ()

Overrides: Actor.PreBeginPlay


TurnOff[edit]

simulated event TurnOff ()


TurnOn[edit]

simulated event TurnOn ()


Other instance functions[edit]

AutoDestroy[edit]

function AutoDestroy ()

Overrides: Actor.AutoDestroy


ParticleDestroy[edit]

public simulated function ParticleDestroy ()


SendTrigger[edit]

simulated function SendTrigger ()


SendUnTrigger[edit]

simulated function SendUnTrigger ()


SetAttachment[edit]

public function SetAttachment (bool B)


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)