There is no spoon

UE3:AnimNotify_Trails (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> AnimNotify >> AnimNotify_Trails
Package: 
Engine

AnimNotify for having a Trails emitter spawn based on an animation.

Properties[edit]

Property group 'AnimNotify_Trails'[edit]

bPreview[edit]

Type: bool

Modifiers: editoronly

If TRUE, the particle system will play in the viewer as well as in game

bSkipIfOwnerIsHidden[edit]

Type: bool

If Owner is hidden, skip particle effect

Default value: True

Property group 'Trails'[edit]

bIsExtremeContent[edit]

Type: bool

If this effect should be considered extreme content

ControlPointSocketName[edit]

Type: name

The control point socket - controls the UV tiling as well as tapering the two edges to this point.

Default value: 'MidControl'

FirstEdgeSocketName[edit]

Type: name

The first edge socket - with the second edge defines the edges of the trail

Default value: 'EndControl'

PSTemplate[edit]

Type: ParticleSystem

The Particle system to play

SamplesPerSecond[edit]

Type: float

The frame rate (FPS) to sample the animation at for trail points

Default value: 60.0

SecondEdgeSocketName[edit]

Type: name

The second edge socket - with the first edge defines the edges of the trail

Default value: 'StartControl'

Internal variables[edit]

AnimNodeSeq[edit]

Type: AnimNodeSequence

Modifiers: transient


bResampleRequired[edit]

Type: bool


CurrentTime[edit]

Type: float

Modifiers: transient

Used by the event functions...

EndTime[edit]

Type: float

The end time (will auto-adjust Duration setting, and vice-versa)

LastStartTime[edit]

Type: float

Locally store 'start' time to determine when regenerating the curve data is required.

SampleTimeStep[edit]

Type: float

Modifiers: deprecated

The timestep at which to sample the animation for trail points

Default value: 0.016

TimeStep[edit]

Type: float

Modifiers: transient


TrailSampleData[edit]

Type: array<TrailSamplePoint>

Modifiers: deprecated


TrailSampledData[edit]

Type: array<TrailSample>

The sampled data for the trail

Structs[edit]

TrailSample[edit]

Modifiers: native

float RelativeTime 
The time value at this sample point, relative to the starting time.
Object.Vector FirstEdgeSample 
The sample for the first edge
Object.Vector SecondEdgeSample 
The sample for the second edge
Object.Vector ControlPointSample 
The sample for the control point

TrailSamplePoint[edit]

Modifiers: native

float RelativeTime 
The time value at this sample point, relative to the starting time.
TrailSocketSamplePoint FirstEdgeSample 
The sample for the first edge
TrailSocketSamplePoint SecondEdgeSample 
The sample for the second edge
TrailSocketSamplePoint ControlPointSample 
The sample for the control point

TrailSocketSamplePoint[edit]

Modifiers: native

Object.Vector Position 
Position of the socket relative to the root-bone at the sample point
Object.Vector Velocity 
Velocity of the socket at the sample point

Native functions[edit]

GetNumSteps[edit]

function native int GetNumSteps (int InLastTrailIndex) const

Called from NotifyTick or NotifyEnd, this function will return the number of steps to take for a notify call given the index of the last sample that was processed.

Parameters:

  • InLastTrailIndex - The index of the last sample that was processed.

Returns:

INT The number of steps to take for the notify.