Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.ParticleModule

Extends
Object
Modifiers
native ( Particle ) editinlinenew hidecategories ( Object ) abstract

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

Core.Object
|   
+-- Engine.ParticleModule

Direct Known Subclasses:

ParticleModuleAccelerationBase, ParticleModuleAttractorBase, ParticleModuleBeamBase, ParticleModuleCameraBase, ParticleModuleCollisionBase, ParticleModuleColorBase, ParticleModuleEventBase, ParticleModuleKillBase, ParticleModuleLifetimeBase, ParticleModuleLocationBase, ParticleModuleMaterialBase, ParticleModuleOrbitBase, ParticleModuleOrientationBase, ParticleModuleParameterBase, ParticleModuleRequired, ParticleModuleRotationBase, ParticleModuleRotationRateBase, ParticleModuleSizeBase, ParticleModuleSpawnBase, ParticleModuleStoreSpawnTimeBase, ParticleModuleSubUVBase, ParticleModuleTrailBase, ParticleModuleTypeDataBase, ParticleModuleUberBase, ParticleModuleVelocityBase

Constants Summary
Inherited Contants from Core.Object
AspectRatio16x9, AspectRatio4x3, AspectRatio5x4, DegToRad, DegToUnrRot, INDEX_NONE, InvAspectRatio16x9, InvAspectRatio4x3, InvAspectRatio5x4, MaxInt, Pi, RadToDeg, RadToUnrRot, UnrRotToDeg, UnrRotToRad

Variables Summary
boolbCurvesAsColor
boolbEditable
boolbEnabled
boolbFinalUpdateModule
boolbRequiresLoopingNotification
boolbSpawnModule
boolbSupported3DDrawMode
boolbSupportsRandomSeed
boolbUpdateModule
boolLODDuplicate
byteLODValidity
Cascade
boolb3DDrawMode
colorModuleEditorColor
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
EModuleType
EPMT_General, EPMT_TypeData, EPMT_Beam, EPMT_Trail, EPMT_Spawn, EPMT_Required, EPMT_Event
EParticleSourceSelectionMethod
EPSSM_Random, EPSSM_Sequential
Inherited Enumerations from Core.Object
AlphaBlendType, EAspectRatioAxisConstraint, EAutomatedRunResult, EAxis, EDebugBreakType, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
ParticleCurvePair
CurveName, CurveObject
ParticleRandomSeedInfo
ParameterName, bGetSeedFromInstance, bInstanceSeedIsIndex, bResetSeedOnEmitterLooping, RandomSeeds
Inherited Structures from Core.Object
Array_Mirror, BitArray_Mirror, BoneAtom, Box, BoxSphereBounds, Color, Cylinder, double, FColorVertexBuffer_Mirror, Guid, IndirectArray_Mirror, InlinePointerArray_Mirror, InterpCurveFloat, InterpCurveLinearColor, InterpCurvePointFloat, InterpCurvePointLinearColor, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, OctreeElementId, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, RenderCommandFence_Mirror, Rotator, Set_Mirror, SHVector, SHVectorRGB, SparseArray_Mirror, TAlphaBlend, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Functions Summary
Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, Atan2, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClampRotAxisFromBase, ClampRotAxisFromRange, ClassIsChildOf, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, DebugBreak, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, EvalInterpCurveFloat, EvalInterpCurveVector, EvalInterpCurveVector2D, Exp, FCeil, FClamp, FCubicInterp, FFloor, FindDeltaAngle, FindObject, FInterpConstantTo, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, float, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetBuildChangelistNumber, GetDotDistance, GetEngineVersion, GetEnum, GetFuncName, GetHeadingAngle, GetMappedRangeValue, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetRightMost, GetRotatorAxis, GetScriptTrace, GetStateName, GetSystemTime, GetUnAxes, GotoState, InCylinder, InStr, InverseTransformNormal, InverseTransformVector, IsA, IsChildState, IsInState, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, LerpColor, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, MakeRotationMatrix, MakeRotationTranslationMatrix, MakeRotator, MatrixGetAxis, MatrixGetOrigin, MatrixGetRotator, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, NoZDot, OrthoRotation, ParseLocalizedPropertyPath, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointDistToSegment, PointProjectToPlane, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, RTransform, SaveConfig, SClampRotAxis, ScriptTrace, SetUTracing, Sin, Split, SplitString, Sqrt, Square, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformNormal, TransformVector, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VRandCone, VRandCone2, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=


Variables Detail

bCurvesAsColor Source code

var bool bCurvesAsColor;
If TRUE, the module displays vector curves as colors

bEditable Source code

var bool bEditable;
If TRUE, the module has had editing enabled on it

bEnabled Source code

var bool bEnabled;
If TRUE, the module is enabled

bFinalUpdateModule Source code

var bool bFinalUpdateModule;
If TRUE, the module performs operations on particles during final update

bRequiresLoopingNotification Source code

var bool bRequiresLoopingNotification;
If TRUE, the module should be told when looping

bSpawnModule Source code

var bool bSpawnModule;
If TRUE, the module performs operations on particles during Spawning

bSupported3DDrawMode Source code

var bool bSupported3DDrawMode;
If TRUE, the module supports rendering a 3D visualization helper

bSupportsRandomSeed Source code

var bool bSupportsRandomSeed;
If TRUE, the module supports RandomSeed setting

bUpdateModule Source code

var bool bUpdateModule;
If TRUE, the module performs operations on particles during Updating

LODDuplicate Source code

var bool LODDuplicate;
If TRUE, this flag indicates that auto-generation for LOD will result in an exact duplicate of the module, regardless of the percentage. If FALSE, it will result in a module with different settings.

LODValidity Source code

var const byte LODValidity;
The LOD levels this module is present in. Bit-flags are used to indicate validity for a given LOD level. For example, if ((1 << Level) & LODValidity) != 0 then the module is used in that LOD.

Cascade

b3DDrawMode Source code

var(Cascade) bool b3DDrawMode;
If TRUE, the module should render its 3D visualization helper

ModuleEditorColor Source code

var(Cascade) color ModuleEditorColor;
The color to draw the modules curves in the curve editor. If bCurvesAsColor is TRUE, it overrides this value.


Enumerations Detail

EModuleType Source code

enum EModuleType
{
EPMT_General, EPMT_TypeData, EPMT_Beam, EPMT_Trail, EPMT_Spawn, EPMT_Required, EPMT_Event
};
ModuleType Indicates the kind of emitter the module can be applied to. ie, EPMT_Beam - only applies to beam emitters. The TypeData field is present to speed up finding the TypeData module.

EParticleSourceSelectionMethod Source code

enum EParticleSourceSelectionMethod
{
EPSSM_Random, EPSSM_Sequential
};
Particle Selection Method, for any emitters that utilize particles as the source points.


Structures Detail

ParticleCurvePair Source code

struct native ParticleCurvePair
{
var string CurveName;
var object CurveObject;
};


ParticleRandomSeedInfo Source code

struct ParticleRandomSeedInfo
{
var(ParticleModule) bool bGetSeedFromInstance;
var(ParticleModule) bool bInstanceSeedIsIndex;
var(ParticleModule) bool bResetSeedOnEmitterLooping;
var(ParticleModule) name ParameterName;
var(ParticleModule) array<int> RandomSeeds;
};
Sequential - select a particle in order
bGetSeedFromInstance:
If TRUE, the module will attempt to get the seed from the owner instance. If that fails, it will fall back to getting it from the RandomSeeds array.
bInstanceSeedIsIndex:
If TRUE, the seed value retrieved from teh instance will be an index into the array of seeds.
bResetSeedOnEmitterLooping:
If TRUE, then reset the seed upon the emitter looping.
ParameterName:
The name to expose to the placed instances for setting this seed
RandomSeeds:
The random seed values to utilize for the module. More than 1 means the instance will randomly select one.


Defaultproperties

defaultproperties
{
	bSupported3DDrawMode=false
	b3DDrawMode=false
	bEnabled=true
	bEditable=true

	LODDuplicate=true
	bSupportsRandomSeed=false
	bRequiresLoopingNotification=false
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: ti 22-3-2011 19:56:54.032 - Created with UnCodeX