I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE3:ParticleSystem (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> ParticleSystem

Contents

Package: 
Engine
This class in other games:
UDK

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

[edit] Properties

[edit] Property group 'Bounds'

[edit] bUseFixedRelativeBoundingBox

Type: bool

Whether to use the fixed relative bounding box or calculate it every frame.

[edit] FixedRelativeBoundingBox

Type: Object.Box

Fixed relative bounding box for particle system.

Default value:

Member Value
IsValid 0
Max
Member Value
X 1.0
Y 1.0
Z 1.0
Min
Member Value
X -1.0
Y -1.0
Z -1.0

[edit] Property group 'LOD'

[edit] LODDistanceCheckTime

Type: float

How often (in seconds) the system should perform the LOD distance check.

Default value: 5.0

[edit] LODDistances

Type: array<float>

Modifiers: editfixedsize

The array of distances for each LOD level in the system. Used when LODMethod is set to PARTICLESYSTEMLODMETHOD_Automatic.

Example: System with 3 LOD levels LODDistances(0) = 0.0 LODDistances(1) = 2500.0 LODDistances(2) = 5000.0

In this case, when the system is [ 0.0 .. 2499.9] from the camera, LOD level 0 will be used. [2500.0 .. 4999.9] from the camera, LOD level 1 will be used. [5000.0 .. INFINITY] from the camera, LOD level 2 will be used.

[edit] LODMethod

Type: ParticleSystemLODMethod

The method of LOD level determination to utilize for this particle system

[edit] Property group 'ParticleSystem'

[edit] SecondsBeforeInactive

Type: float

Number of seconds of emitter not being rendered that need to pass before it no longer gets ticked/ becomes inactive.

[edit] SystemUpdateMode

Type: EParticleSystemUpdateMode


[edit] UpdateTime_FPS

Type: float

UpdateTime_FPS - the frame per second to update at in FixedTime mode

Default value: 60.0

[edit] WarmupTime

Type: float

WarmupTime - the time to warm-up the particle system when first rendered

[edit] Property group 'Thumbnail'

[edit] bUseRealtimeThumbnail

Type: bool

Inidicates the old 'real-time' thumbnail rendering should be used

[edit] ThumbnailWarmup

Type: float

The time to warm-up the system for the thumbnail image

Default value: 1.0

[edit] Internal variables

[edit] bHasPhysics

Type: bool

Modifiers: transient

Set during load time to indicate that physics is used...

[edit] bLit

Type: bool

Boolean to indicate whether the particle system can ignore lights or not

Default value: True

[edit] bRegenerateLODDuplicate

Type: bool

Internal value that tracks the regenerate LOD levels preference. If TRUE, when autoregenerating LOD levels in code, the low level will be a duplicate of the high.

[edit] bShouldResetPeakCounts

Type: bool

EDITOR ONLY: Indicates that Cascade would like to have the PeakActiveParticles count reset

[edit] CurveEdSetup

Type: InterpCurveEdSetup

Modifiers: export

Used for curve editor to remember curve-editing setup.

[edit] EditorLODSetting

Type: int

LOD setting for intepolation (set by Cascade) Range [0..100]

[edit] Emitters

Type: array<ParticleEmitter>

Modifiers: editinline, export

Emitters - internal - the array of emitters in the system

[edit] FloorMesh

Type: string


Default value: "EditorMeshes.AnimTreeEd_PreviewFloor"

[edit] FloorPosition

Type: Object.Vector


[edit] FloorRotation

Type: Object.Rotator


[edit] FloorScale

Type: float


Default value: 1.0

[edit] FloorScale3D

Type: Object.Vector


Default value:

Member Value
X 1.0
Y 1.0
Z 1.0

[edit] PreviewComponent

Type: ParticleSystemComponent

Modifiers: transient

The component used to preview the particle system in Cascade

[edit] ThumbnailAngle

Type: Object.Rotator

The angle to use when rendering the thumbnail image

[edit] ThumbnailDistance

Type: float

The distance to place the system when rendering the thumbnail image

Default value: 200.0

[edit] ThumbnailImage

Type: Texture2D

Internal: The PSys thumbnail image

[edit] ThumbnailImageOutOfDate

Type: bool

Internal: Indicates the PSys thumbnail image is out of date

Default value: True

[edit] UpdateTime_Delta

Type: float

UpdateTime_Delta - internal

Default value: 1.0

[edit] Enums

[edit] EParticleSystemUpdateMode

ParticleSystemUpdateMode Enumeration indicating the method by which the system should be updated

EPSUM_RealTime 
RealTime - update via the delta time passed in
EPSUM_FixedTime 
FixedTime - update via a fixed time step

[edit] ParticleSystemLODMethod

ParticleSystemLODMethod Enumeration indicating the method by which the system should perform LOD determination

PARTICLESYSTEMLODMETHOD_Automatic 
Automatically set the LOD level
PARTICLESYSTEMLODMETHOD_DirectSet 
LOD level is directly set by the game

[edit] Native functions

[edit] GetCurrentLODMethod

native function ParticleSystemLODMethod GetCurrentLODMethod ()

Return the currently set LOD method

[edit] GetLODDistance

native function float GetLODDistance (int LODLevelIndex)

Return the distance for the given LOD level

[edit] GetLODLevelCount

native function int GetLODLevelCount ()

Return the number of LOD levels for this particle system

[edit] SetCurrentLODMethod

native function SetCurrentLODMethod (ParticleSystemLODMethod InMethod)

Set the LOD method

[edit] SetLODDistance

native function bool SetLODDistance (int LODLevelIndex, float InDistance)

Set the distance for the given LOD index