UE2:ParticleGenerator (U2XMP)

From Unreal Wiki, The Unreal Engine Documentation Site
U2XMP Object >> Actor >> ParticleGenerator
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:

$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

PARTICLEVERSION_Current

Value: 3


PARTICLEVERSION_AutoLit

Value: 3


PARTICLEVERSION_AffectingForces

Value: 2


PARTICLEVERSION_NumParticlesFix

Value: 1


Properties

Property group 'ParticleAdvanced'

bCollisionBound

Type: bool

Modifiers: public


bInterpolate

Type: bool

Modifiers: public


bLockParticles

Type: bool

Modifiers: public

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

bShowBoundingBox

Type: bool

Modifiers: public


DefaultForces

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

Type: float

Modifiers: public


IgnoredForces

Type: array<name>

Modifiers: public


MaxTickSize

Type: float

Modifiers: public


Default value: 0.008333

ParticleLifeSpan

Type: float

Modifiers: public


ParticleVersion

Type: int

Modifiers: public


PrimeTime

Type: float

Modifiers: public


Property group 'ParticleGenerator'

bOn

Type: bool

Modifiers: public


Default value: True

Forces

Type: OrderedArray<Force>

Modifiers: public, editinline


ParticleTemplates

Type: OrderedArray<ParticleTemplate>

Modifiers: public, editinline


Property group 'ParticleSelection'

bLinearFrequenciesChanged

Type: bool

Modifiers: public


Default value: True

SelectionMethod

Type: Select

Modifiers: public


Default value: SELECT_Random

Property group 'Sound'

SoundLoop

Type: Sound

Modifiers: public


SoundOff

Type: Sound

Modifiers: public


SoundOn

Type: Sound

Modifiers: public


Property group 'TriggerSupport'

bInitiallyOn

Type: bool

Modifiers: public


Default value: True

MaxParticles

Type: int

Modifiers: public

Maximum particles emitted per trigger.

RampDownTime

Type: float

Modifiers: public


RampUpTime

Type: float

Modifiers: public


TimerDuration

Type: float

Modifiers: public


Trig

Type: Button

Modifiers: public


Default value: "SendTrigger"

UnTrig

Type: Button

Modifiers: public


Default value: "SendUnTrigger"

Internal variables

bAttachment

Type: bool

Modifiers: private

Set if we are a golem attachment.

InternalTimer

Type: float

Modifiers: private


LargestWeight

Type: float

Modifiers: private

The currently largest linear weight.

LastBoundSizeSquared

Type: float

Modifiers: private, transient


LastLocation

Type: Object.Vector

Modifiers: private, transient


LastPitch

Type: float

Modifiers: private, transient


LastRoll

Type: float

Modifiers: private, transient


LastTimeDrawn

Type: float

Modifiers: private, transient


LastYaw

Type: float

Modifiers: private, transient


LockedLocalToWorld

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

Type: int

Modifiers: private

Used internally to enforce ParticleCount.

RampDir

Type: Ramp

Modifiers: private


RampTimer

Type: float

Modifiers: private


TemplateIndex

Type: int

Modifiers: private

Current index into the particle template list.

TemplateIteration

Type: int

Modifiers: private


VolumeScale

Type: float

Modifiers: protected


Default values

Enums

Ramp

RAMP_None
RAMP_Up
RAMP_Down

Select

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

Functions

Static native functions

ParticleGetLocation

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


ParticleGetVelocity

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


ParticleSetLocation

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


ParticleSetVelocity

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


Other static functions

CreateNew

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


DynamicCreateNew

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


Native functions

AddForce

public native event AddForce (Force AddedForce)


AddTemplate

public native event AddTemplate (ParticleTemplate T)


Clean

public native event Clean ()


Conform

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


Duplicate

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


ExchangeTemplate

public native event ExchangeTemplate (ParticleTemplate Old, ParticleTemplate New)


GetParticleTemplates

public native event GetParticleTemplates (out Object T)


LockParticles

public native event LockParticles ()


ManualTick

public native event ManualTick (float DeltaSeconds)


RegisterExternallyAffectedTemplates

public native event RegisterExternallyAffectedTemplates ()


RemoveForce

public native event RemoveForce (Force RemovedForce)


RemoveForceType

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


RemoveTemplate

public native event RemoveTemplate (ParticleTemplate T)


RemoveTemplateType

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


UnLockParticles

public native event UnLockParticles ()


UnRegisterExternallyAffectedTemplates

public native event UnRegisterExternallyAffectedTemplates ()


ValidateComponents

public native event ValidateComponents ()


GetMaxLifeSpan

public native function float GetMaxLifeSpan ()


Events

Destroyed

simulated event Destroyed ()

Overrides: Actor.Destroyed


PostBeginPlay

simulated event PostBeginPlay ()

Overrides: Actor.PostBeginPlay


PreBeginPlay

simulated event PreBeginPlay ()

Overrides: Actor.PreBeginPlay


TurnOff

simulated event TurnOff ()


TurnOn

simulated event TurnOn ()


Other instance functions

AutoDestroy

function AutoDestroy ()

Overrides: Actor.AutoDestroy


ParticleDestroy

public simulated function ParticleDestroy ()


SendTrigger

simulated function SendTrigger ()


SendUnTrigger

simulated function SendUnTrigger ()


SetAttachment

public function SetAttachment (bool B)


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)