Cogito, ergo sum

UE2:ParticleGenerator (U2)

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

Contents

Package: 
ParticleSystems
Known classes within ParticleGenerator:
ActorCollisionNotifier, ActorParticleTemplate, AnchorForce, AttractionForce, CollisionAnchor, CollisionDiscForce, CollisionGlider, CollisionSphereForce, ColorForce, DecayForce, DestroyOnDamage, FadeForce, FadeInForce, FadeOutForce, Force, FrictionForce, GeoCollideAndMerge, GeometryCollider, GeometryColliderEx, GlobalAccelerator, InertiaForce, LimitedResizeForce, LocationGrouped, LocatorForce, MaxVelocityForce, MeshAnchor, MinDecayForce, MoveZig, MultiTemplateForce, NeuralNetForce, OnDestroyForce, OscillatingPerParticleForce, ParticleDamage, ParticleDecalTemplate, ParticleSalamanderForce, 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:
BarbbieHareDesigner, LineManager, ParticleAffector, ParticleBlower, ParticleRadiator, ParticleSalamander, ParticleSkeleton, PulseLineGenerator, TarpBuilder
This class in other games:
U2XMP

$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


bInterpolate

Type: bool


bLockParticles

Type: bool

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

bShowBoundingBox

Type: bool


DefaultForces

Type: array<class<Force> >

Forces automatically installed when spawned.

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

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

IdleTime

Type: float


IgnoredForces

Type: array<name>


MaxTickSize

Type: float


Default value: 0.008333

ParticleLifeSpan

Type: float


ParticleVersion

Type: int


PrimeTime

Type: float


Property group 'ParticleGenerator'

bOn

Type: bool


Default value: True

Forces

Type: OrderedArray<Force>

Modifiers: editinline


ParticleTemplates

Type: OrderedArray<ParticleTemplate>

Modifiers: editinline


Property group 'ParticleSelection'

bLinearFrequenciesChanged

Type: bool


Default value: True

SelectionMethod

Type: Select


Default value: SELECT_Random

Property group 'Sound'

SoundLoop

Type: Sound


SoundOff

Type: Sound


SoundOn

Type: Sound


Property group 'TriggerSupport'

bInitiallyOn

Type: bool


Default value: True

MaxParticles

Type: int

Maximum particles emitted per trigger.

RampDownTime

Type: float


RampUpTime

Type: float


TimerDuration

Type: float


Trig

Type: Button


Default value: "SendTrigger"

UnTrig

Type: Button


Default value: "SendUnTrigger"

Internal variables

bAttachDelayTick

Type: bool

Delay tick till render if attached to a skeletal mesh bone.

Default value: True

bAttachment

Type: bool

Set if we are a golem attachment. (DEPRICATED)

bForceDelayTick

Type: bool

Delay tick till render even if not attached to skeletal mesh bone.

InternalTimer

Type: float


LargestWeight

Type: float

The currently largest linear weight.

LastBoundSizeSquared

Type: float

Modifiers: transient


LastDeltaSeconds

Type: float

Modifiers: transient

cached for latent ticks - i.e. weapon attachments.

LastLocation

Type: Object.Vector

Modifiers: transient


LastPitch

Type: float

Modifiers: transient


LastRoll

Type: float

Modifiers: transient


LastTimeDrawn

Type: float

Modifiers: transient


LastYaw

Type: float

Modifiers: transient


LockedLocalToWorld

Type: Object.Matrix

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

Used internally to enforce ParticleCount.

RampDir

Type: Ramp


RampTimer

Type: float


TemplateIndex

Type: int

Current index into the particle template list.

TemplateIteration

Type: int


VolumeScale

Type: float


Default values

Property Value
bBlockNonZeroExtentTraces False
bBlockZeroExtentTraces False
bCanTeleport True
bUnlit True
CullDistance 5000.0
DrawType DT_Custom
RemoteRole ROLE_None
Style STY_Translucent

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

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


DynamicCreateNew

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


ZapParticleGenerator

static function ZapParticleGenerator (out ParticleGenerator PG)


Native functions

AddForce

native event AddForce (Force AddedForce)


AddTemplate

native event AddTemplate (ParticleTemplate T)


Clean

native event Clean ()


Conform

native event Conform (ParticleGenerator Image, optional bool bDeleteExisting)


Duplicate

native event Duplicate (out ParticleGenerator D, Level L)


ExchangeTemplate

native event ExchangeTemplate (ParticleTemplate Old, ParticleTemplate New)


GetParticleTemplates

native event GetParticleTemplates (out Object T)


LockParticles

native event LockParticles ()


ManualTick

native event ManualTick (float DeltaSeconds)


RegisterExternallyAffectedTemplates

native event RegisterExternallyAffectedTemplates ()


RemoveForce

native event RemoveForce (Force RemovedForce)


RemoveForceType

native event RemoveForceType (name ClassName, optional bool bAndSubclasses)


RemoveTemplate

native event RemoveTemplate (ParticleTemplate T)


RemoveTemplateType

native event RemoveTemplateType (name ClassName, optional bool bAndSubclasses)


UnLockParticles

native event UnLockParticles ()


UnRegisterExternallyAffectedTemplates

native event UnRegisterExternallyAffectedTemplates ()


ValidateComponents

native event ValidateComponents ()


GetMaxLifeSpan

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 ()


ParticleDestroy

simulated function ParticleDestroy ()


SendTrigger

simulated function SendTrigger ()


SendUnTrigger

simulated function SendUnTrigger ()


SetAttachment

function SetAttachment (bool B)


SetParticleLifeSpan

simulated function SetParticleLifeSpan (float Seconds)


States

TriggerControl

Modifiers: simulated

TriggerControl.Trigger

simulated event Trigger (Actor Other, Pawn EventInstigator)

Overrides: Actor.Trigger (global)


TriggerControl.UnTrigger

simulated event UnTrigger (Actor Other, Pawn EventInstigator)

Overrides: Actor.UnTrigger (global)


TriggerTimed

Modifiers: simulated

TriggerTimed.Trigger

simulated event Trigger (Actor Other, Pawn EventInstigator)

Overrides: Actor.Trigger (global)


TriggerToggle

Modifiers: simulated

TriggerToggle.Trigger

simulated event Trigger (Actor Other, Pawn EventInstigator)

Overrides: Actor.Trigger (global)