I love the smell of UnrealEd crashing in the morning. – tarquin
UE3:ParticleSystem (UT3)
 |
Object >> ParticleSystem |
Contents
- 1 Properties
- 1.1 Property group 'Bounds'
- 1.2 Property group 'LOD'
- 1.3 Property group 'ParticleSystem'
- 1.4 Property group 'Thumbnail'
- 1.5 Internal variables
- 1.5.1 bHasPhysics
- 1.5.2 bLit
- 1.5.3 bRegenerateLODDuplicate
- 1.5.4 bShouldResetPeakCounts
- 1.5.5 CurveEdSetup
- 1.5.6 EditorLODSetting
- 1.5.7 Emitters
- 1.5.8 FloorMesh
- 1.5.9 FloorPosition
- 1.5.10 FloorRotation
- 1.5.11 FloorScale
- 1.5.12 FloorScale3D
- 1.5.13 PreviewComponent
- 1.5.14 ThumbnailAngle
- 1.5.15 ThumbnailDistance
- 1.5.16 ThumbnailImage
- 1.5.17 ThumbnailImageOutOfDate
- 1.5.18 UpdateTime_Delta
- 2 Enums
- 3 Native functions
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
Properties[edit]
Property group 'Bounds'[edit]
bUseFixedRelativeBoundingBox[edit]
Type: bool
Whether to use the fixed relative bounding box or calculate it every frame.
FixedRelativeBoundingBox[edit]
Type: Object.Box
Fixed relative bounding box for particle system.
Default value:
| Member | Value | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| IsValid | 0 | ||||||||
| Max |
|
||||||||
| Min |
|
Property group 'LOD'[edit]
LODDistanceCheckTime[edit]
Type: float
How often (in seconds) the system should perform the LOD distance check.
Default value: 5.0
LODDistances[edit]
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.
LODMethod[edit]
Type: ParticleSystemLODMethod
The method of LOD level determination to utilize for this particle system
Property group 'ParticleSystem'[edit]
SecondsBeforeInactive[edit]
Type: float
Number of seconds of emitter not being rendered that need to pass before it no longer gets ticked/ becomes inactive.
SystemUpdateMode[edit]
Type: EParticleSystemUpdateMode
UpdateTime_FPS[edit]
Type: float
UpdateTime_FPS - the frame per second to update at in FixedTime mode
Default value: 60.0
WarmupTime[edit]
Type: float
WarmupTime - the time to warm-up the particle system when first rendered
Property group 'Thumbnail'[edit]
bUseRealtimeThumbnail[edit]
Type: bool
Inidicates the old 'real-time' thumbnail rendering should be used
ThumbnailWarmup[edit]
Type: float
The time to warm-up the system for the thumbnail image
Default value: 1.0
Internal variables[edit]
bHasPhysics[edit]
Type: bool
Modifiers: transient
Set during load time to indicate that physics is used...
bLit[edit]
Type: bool
Boolean to indicate whether the particle system can ignore lights or not
Default value: True
bRegenerateLODDuplicate[edit]
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.
bShouldResetPeakCounts[edit]
Type: bool
EDITOR ONLY: Indicates that Cascade would like to have the PeakActiveParticles count reset
CurveEdSetup[edit]
Type: InterpCurveEdSetup
Modifiers: export
Used for curve editor to remember curve-editing setup.
EditorLODSetting[edit]
Type: int
LOD setting for intepolation (set by Cascade) Range [0..100]
Emitters[edit]
Type: array<ParticleEmitter>
Modifiers: editinline, export
Emitters - internal - the array of emitters in the system
FloorMesh[edit]
Type: string
Default value: "EditorMeshes.AnimTreeEd_PreviewFloor"
FloorPosition[edit]
Type: Object.Vector
FloorRotation[edit]
Type: Object.Rotator
FloorScale[edit]
Type: float
Default value: 1.0
FloorScale3D[edit]
Type: Object.Vector
Default value:
| Member | Value |
|---|---|
| X | 1.0 |
| Y | 1.0 |
| Z | 1.0 |
PreviewComponent[edit]
Type: ParticleSystemComponent
Modifiers: transient
The component used to preview the particle system in Cascade
ThumbnailAngle[edit]
Type: Object.Rotator
The angle to use when rendering the thumbnail image
ThumbnailDistance[edit]
Type: float
The distance to place the system when rendering the thumbnail image
Default value: 200.0
ThumbnailImage[edit]
Type: Texture2D
Internal: The PSys thumbnail image
ThumbnailImageOutOfDate[edit]
Type: bool
Internal: Indicates the PSys thumbnail image is out of date
Default value: True
UpdateTime_Delta[edit]
Type: float
UpdateTime_Delta - internal
Default value: 1.0
Enums[edit]
EParticleSystemUpdateMode[edit]
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
ParticleSystemLODMethod[edit]
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
Native functions[edit]
GetCurrentLODMethod[edit]
Return the currently set LOD method
GetLODDistance[edit]
Return the distance for the given LOD level
GetLODLevelCount[edit]
Return the number of LOD levels for this particle system
SetCurrentLODMethod[edit]
Set the LOD method
SetLODDistance[edit]
Set the distance for the given LOD index
