Describes the NxParameterized::Interface for 'EmitterEffect' : An emitter effect. More...

#include <params.h>

Public Attributes
String	EffectProperties.UserString
	'EffectProperties.UserString' : An aribtrary user string that can be set by an artist/designer/programmer
Bool	EffectProperties.Enable
	'EffectProperties.Enable' : Whether or not this effect is to be initially enabled on startup
F32	EffectProperties.Position.TranslateX
	'EffectProperties.Position.TranslateX' : Nudge up to +/- one meter in each direction
F32	EffectProperties.Position.TranslateY
	'EffectProperties.Position.TranslateY' : Nudge up to +/- one meter in each direction
F32	EffectProperties.Position.TranslateZ
	'EffectProperties.Position.TranslateZ' : Nudge up to +/- one meter in each direction
F32	EffectProperties.Orientation.RotateX
	'EffectProperties.Orientation.RotateX' : Rotate on the X axis (0-360 degrees)
F32	EffectProperties.Orientation.RotateY
	'EffectProperties.Orientation.RotateY' : Rotate on the Y axis (0-360 degrees)
F32	EffectProperties.Orientation.RotateZ
	'EffectProperties.Orientation.RotateZ' : Rotate on the Z axis (0-360 degrees)
F32	EffectProperties.InitialDelayTime
	'EffectProperties.InitialDelayTime' : Initial time to delay before spawning this effect
F32	EffectProperties.Duration
	'EffectProperties.Duration' : The duration of the effect in secontds
U32	EffectProperties.RepeatCount
	'EffectProperties.RepeatCount' : The number of times to repeat the effect; 9999 means repeate forever
F32	EffectProperties.RepeatDelay
	'EffectProperties.RepeatDelay' : The time to delay activation each time the effect repeats in seconds; this can be different than the initial delay time
F32	EffectProperties.RandomizeRepeatTime
	'EffectProperties.RandomizeRepeatTime' : Amount of randomization to the repeat cycle; a value of zero (default) means no random and a value of one means completely random.
PlaybackMode	EffectProperties.Path.PlaybackMode
	'EffectProperties.Path.PlaybackMode' : The mode to play back the path
F32	EffectProperties.Path.PathDuration
	'EffectProperties.Path.PathDuration' : The duration of the path if one is not otherwise provided
U32	EffectProperties.Path.LoopIndex
	'EffectProperties.Path.LoopIndex' : The array index to loop back to
Transform	EffectProperties.Path.ControlPoints[]
	'EffectProperties.Path.ControlPoints[]' : The array of control points to fit the curve to
F32	EffectProperties.Path.Scale[].x
	'EffectProperties.Path.Scale[].x' : The x-axis value for this vector
F32	EffectProperties.Path.Scale[].y
	'EffectProperties.Path.Scale[].y' : The y-axis value for this vector
F32	EffectProperties.Path.Speed[].x
	'EffectProperties.Path.Speed[].x' : The x-axis value for this vector
F32	EffectProperties.Path.Speed[].y
	'EffectProperties.Path.Speed[].y' : The y-axis value for this vector
Bool	EmitterVelocityChanges.AdjustLifetime.AdjustEnabled
	'EmitterVelocityChanges.AdjustLifetime.AdjustEnabled' : True if adjusting emitter properties based on velocity
F32	EmitterVelocityChanges.AdjustLifetime.VelocityLow
	'EmitterVelocityChanges.AdjustLifetime.VelocityLow' : Low velocity range to match the low
F32	EmitterVelocityChanges.AdjustLifetime.VelocityHigh
	'EmitterVelocityChanges.AdjustLifetime.VelocityHigh' : High velocity range to match the high value
F32	EmitterVelocityChanges.AdjustLifetime.LowValue
	'EmitterVelocityChanges.AdjustLifetime.LowValue' : The multiplier when the velocity equals VelocityLow
F32	EmitterVelocityChanges.AdjustLifetime.HighValue
	'EmitterVelocityChanges.AdjustLifetime.HighValue' : The multiplier when the velocity equals VelocityHigh
Bool	EmitterVelocityChanges.AdjustEmitterRate.AdjustEnabled
	'EmitterVelocityChanges.AdjustEmitterRate.AdjustEnabled' : True if adjusting emitter properties based on velocity
F32	EmitterVelocityChanges.AdjustEmitterRate.VelocityLow
	'EmitterVelocityChanges.AdjustEmitterRate.VelocityLow' : Low velocity range to match the low
F32	EmitterVelocityChanges.AdjustEmitterRate.VelocityHigh
	'EmitterVelocityChanges.AdjustEmitterRate.VelocityHigh' : High velocity range to match the high value
F32	EmitterVelocityChanges.AdjustEmitterRate.LowValue
	'EmitterVelocityChanges.AdjustEmitterRate.LowValue' : The multiplier when the velocity equals VelocityLow
F32	EmitterVelocityChanges.AdjustEmitterRate.HighValue
	'EmitterVelocityChanges.AdjustEmitterRate.HighValue' : The multiplier when the velocity equals VelocityHigh
Ref	Emitter
	'Emitter' : Emitter Asset

Detailed Description

Describes the NxParameterized::Interface for 'EmitterEffect' : An emitter effect.

EmitterEffect contains 35 fully qualified names
---------------------------------------------
  1 : String         EffectProperties.UserString                             
  2 : Bool           EffectProperties.Enable                                 
  3 : F32            EffectProperties.Position.TranslateX                    
  4 : F32            EffectProperties.Position.TranslateY                    
  5 : F32            EffectProperties.Position.TranslateZ                    
  6 : F32            EffectProperties.Orientation.RotateX                    
  7 : F32            EffectProperties.Orientation.RotateY                    
  8 : F32            EffectProperties.Orientation.RotateZ                    
  9 : F32            EffectProperties.InitialDelayTime                       
 10 : F32            EffectProperties.Duration                               
 11 : U32            EffectProperties.RepeatCount                            
 12 : F32            EffectProperties.RepeatDelay                            
 13 : F32            EffectProperties.RandomizeRepeatTime                    
 14 : PlaybackMode   EffectProperties.Path.PlaybackMode                      
 15 : F32            EffectProperties.Path.PathDuration                      
 16 : U32            EffectProperties.Path.LoopIndex                         
 17 : ArraySizeName  ControlPoints                                           
 18 : Transform      EffectProperties.Path.ControlPoints[]                   
 19 : ArraySizeName  Scale                                                   
 20 : F32            EffectProperties.Path.Scale[].x                         
 21 : F32            EffectProperties.Path.Scale[].y                         
 22 : ArraySizeName  Speed                                                   
 23 : F32            EffectProperties.Path.Speed[].x                         
 24 : F32            EffectProperties.Path.Speed[].y                         
 25 : Bool           EmitterVelocityChanges.AdjustLifetime.AdjustEnabled     
 26 : F32            EmitterVelocityChanges.AdjustLifetime.VelocityLow       
 27 : F32            EmitterVelocityChanges.AdjustLifetime.VelocityHigh      
 28 : F32            EmitterVelocityChanges.AdjustLifetime.LowValue          
 29 : F32            EmitterVelocityChanges.AdjustLifetime.HighValue         
 30 : Bool           EmitterVelocityChanges.AdjustEmitterRate.AdjustEnabled  
 31 : F32            EmitterVelocityChanges.AdjustEmitterRate.VelocityLow    
 32 : F32            EmitterVelocityChanges.AdjustEmitterRate.VelocityHigh   
 33 : F32            EmitterVelocityChanges.AdjustEmitterRate.LowValue       
 34 : F32            EmitterVelocityChanges.AdjustEmitterRate.HighValue      
 35 : Ref            Emitter

Member Data Documentation

F32 EmitterEffect::EffectProperties.Duration

'EffectProperties.Duration' : The duration of the effect in secontds

Bool EmitterEffect::EffectProperties.Enable

'EffectProperties.Enable' : Whether or not this effect is to be initially enabled on startup

F32 EmitterEffect::EffectProperties.InitialDelayTime

'EffectProperties.InitialDelayTime' : Initial time to delay before spawning this effect

F32 EmitterEffect::EffectProperties.Orientation.RotateX

'EffectProperties.Orientation.RotateX' : Rotate on the X axis (0-360 degrees)

F32 EmitterEffect::EffectProperties.Orientation.RotateY

'EffectProperties.Orientation.RotateY' : Rotate on the Y axis (0-360 degrees)

F32 EmitterEffect::EffectProperties.Orientation.RotateZ

'EffectProperties.Orientation.RotateZ' : Rotate on the Z axis (0-360 degrees)

Transform EmitterEffect::EffectProperties.Path.ControlPoints[]

'EffectProperties.Path.ControlPoints[]' : The array of control points to fit the curve to

U32 EmitterEffect::EffectProperties.Path.LoopIndex

'EffectProperties.Path.LoopIndex' : The array index to loop back to

F32 EmitterEffect::EffectProperties.Path.PathDuration

'EffectProperties.Path.PathDuration' : The duration of the path if one is not otherwise provided

PlaybackMode EmitterEffect::EffectProperties.Path.PlaybackMode

'EffectProperties.Path.PlaybackMode' : The mode to play back the path

F32 EmitterEffect::EffectProperties.Path.Scale[].x

'EffectProperties.Path.Scale[].x' : The x-axis value for this vector

F32 EmitterEffect::EffectProperties.Path.Scale[].y

'EffectProperties.Path.Scale[].y' : The y-axis value for this vector

F32 EmitterEffect::EffectProperties.Path.Speed[].x

'EffectProperties.Path.Speed[].x' : The x-axis value for this vector

F32 EmitterEffect::EffectProperties.Path.Speed[].y

'EffectProperties.Path.Speed[].y' : The y-axis value for this vector

F32 EmitterEffect::EffectProperties.Position.TranslateX

'EffectProperties.Position.TranslateX' : Nudge up to +/- one meter in each direction

F32 EmitterEffect::EffectProperties.Position.TranslateY

'EffectProperties.Position.TranslateY' : Nudge up to +/- one meter in each direction

F32 EmitterEffect::EffectProperties.Position.TranslateZ

'EffectProperties.Position.TranslateZ' : Nudge up to +/- one meter in each direction

F32 EmitterEffect::EffectProperties.RandomizeRepeatTime

'EffectProperties.RandomizeRepeatTime' : Amount of randomization to the repeat cycle; a value of zero (default) means no random and a value of one means completely random.

U32 EmitterEffect::EffectProperties.RepeatCount

'EffectProperties.RepeatCount' : The number of times to repeat the effect; 9999 means repeate forever

F32 EmitterEffect::EffectProperties.RepeatDelay

'EffectProperties.RepeatDelay' : The time to delay activation each time the effect repeats in seconds; this can be different than the initial delay time

String EmitterEffect::EffectProperties.UserString

'EffectProperties.UserString' : An aribtrary user string that can be set by an artist/designer/programmer

Ref EmitterEffect::Emitter

'Emitter' : Emitter Asset

Bool EmitterEffect::EmitterVelocityChanges.AdjustEmitterRate.AdjustEnabled

'EmitterVelocityChanges.AdjustEmitterRate.AdjustEnabled' : True if adjusting emitter properties based on velocity

F32 EmitterEffect::EmitterVelocityChanges.AdjustEmitterRate.HighValue

'EmitterVelocityChanges.AdjustEmitterRate.HighValue' : The multiplier when the velocity equals VelocityHigh

F32 EmitterEffect::EmitterVelocityChanges.AdjustEmitterRate.LowValue

'EmitterVelocityChanges.AdjustEmitterRate.LowValue' : The multiplier when the velocity equals VelocityLow

F32 EmitterEffect::EmitterVelocityChanges.AdjustEmitterRate.VelocityHigh

'EmitterVelocityChanges.AdjustEmitterRate.VelocityHigh' : High velocity range to match the high value

F32 EmitterEffect::EmitterVelocityChanges.AdjustEmitterRate.VelocityLow

'EmitterVelocityChanges.AdjustEmitterRate.VelocityLow' : Low velocity range to match the low

Bool EmitterEffect::EmitterVelocityChanges.AdjustLifetime.AdjustEnabled

'EmitterVelocityChanges.AdjustLifetime.AdjustEnabled' : True if adjusting emitter properties based on velocity

F32 EmitterEffect::EmitterVelocityChanges.AdjustLifetime.HighValue

'EmitterVelocityChanges.AdjustLifetime.HighValue' : The multiplier when the velocity equals VelocityHigh

F32 EmitterEffect::EmitterVelocityChanges.AdjustLifetime.LowValue

'EmitterVelocityChanges.AdjustLifetime.LowValue' : The multiplier when the velocity equals VelocityLow

F32 EmitterEffect::EmitterVelocityChanges.AdjustLifetime.VelocityHigh

'EmitterVelocityChanges.AdjustLifetime.VelocityHigh' : High velocity range to match the high value

F32 EmitterEffect::EmitterVelocityChanges.AdjustLifetime.VelocityLow

'EmitterVelocityChanges.AdjustLifetime.VelocityLow' : Low velocity range to match the low

The documentation for this struct was generated from the following file:

params.h

Public Attributes

Detailed Description

Member Data Documentation