JetFieldSamplerEffect Struct Reference

Describes the NxParameterized::Interface for 'JetFieldSamplerEffect' : A jet field sampler effect. More...

#include <params.h>

List of all members.

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.
Ref	JetFieldSampler
	'JetFieldSampler' : Jet FS Asset

---

Detailed Description

Describes the NxParameterized::Interface for 'JetFieldSamplerEffect' : A jet field sampler effect.

JetFieldSamplerEffect contains 14 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 : Ref     JetFieldSampler                       

---

Member Data Documentation

F32 JetFieldSamplerEffect::EffectProperties.Duration

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

Bool JetFieldSamplerEffect::EffectProperties.Enable

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

F32 JetFieldSamplerEffect::EffectProperties.InitialDelayTime

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

F32 JetFieldSamplerEffect::EffectProperties.Orientation.RotateX

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

F32 JetFieldSamplerEffect::EffectProperties.Orientation.RotateY

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

F32 JetFieldSamplerEffect::EffectProperties.Orientation.RotateZ

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

F32 JetFieldSamplerEffect::EffectProperties.Position.TranslateX

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

F32 JetFieldSamplerEffect::EffectProperties.Position.TranslateY

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

F32 JetFieldSamplerEffect::EffectProperties.Position.TranslateZ

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

F32 JetFieldSamplerEffect::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 JetFieldSamplerEffect::EffectProperties.RepeatCount

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

F32 JetFieldSamplerEffect::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 JetFieldSamplerEffect::EffectProperties.UserString

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

Ref JetFieldSamplerEffect::JetFieldSampler

'JetFieldSampler' : Jet FS Asset

---

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

• params.h