afxPhraseEffectData
A datablock that specifies a Phrase Effect, a grouping of other effects.
Public Attributes
A field macro which adds an effect wrapper datablock to a list of effects associated with the phrase-effect's single phrase. Unlike other fields, addEffect follows an unusual syntax. Order is important since the effects will resolve in the order they are added to each list.
float
Specifies a duration for the phrase-effect. If set to infinity, the phrase-effect needs to have a phraseType of continuous. Set infinite duration using $AFX::INFINITE_TIME.
bool
When true, trigger-bits on the choreographer will be ignored.
bool
When true, animation triggers from dts-based constraint source objects will be ignored.
bool
When true, Player-specific triggers from Player-derived constraint source objects will be ignored.
Selects which bit-state(s) of bits in the triggerMask to consider when comparing to the current trigger-state. Possible values: on, off, or both.
Selects what combination of bits in triggerMask lead to a trigger. When set to 'any', any bit in triggerMask matching the current trigger-state will cause a trigger. If set to 'all', every bit in triggerMask must match the trigger-state. Possible values: any or all.
int
Specifies the number of times the phrase-effect should loop. If set to infinity, the phrase-effect needs to have a phraseType of continuous. Set infinite looping using $AFX::INFINITE_REPEATS.
string
Like a field substitution statement without the leading '$$' token, this eval statement will be executed when a trigger occurs. Any '%' and '##' tokens will be substituted.
Selects between triggered and continuous types of phrases. When set to 'triggered', the phrase-effect is triggered when the relevant trigger-bits change state. When set to 'continuous', the phrase-effect will stay active as long as the trigger-bits remain in a matching state. Possible values: triggered or continuous.
int
Sets which bits to consider in the current trigger-state which consists of 32 trigger-bits combined from (possibly overlapping) player trigger bits, constraint trigger bits, and choreographer trigger bits.
Public Functions
void
pushEffect(afxEffectBaseData effectData)
Add a child effect to a phrase effect datablock. Argument can be an afxEffectWrappperData or an afxEffectGroupData.
Detailed Description
A datablock that specifies a Phrase Effect, a grouping of other effects.
A Phrase Effect is a grouping or phrase of effects that do nothing until certain trigger events occur. It's like having a whole Effectron organized as an individual effect.
Phrase effects can respond to a number of different kinds of triggers: – Player triggers such as footsteps, jumps, landings, and idle triggers. – Arbitrary animation triggers on dts-based scene objects. – Arbitrary trigger bits assigned to active choreographer objects.
Public Attributes
afxEffectBaseData addEffect
A field macro which adds an effect wrapper datablock to a list of effects associated with the phrase-effect's single phrase. Unlike other fields, addEffect follows an unusual syntax. Order is important since the effects will resolve in the order they are added to each list.
float Duration
Specifies a duration for the phrase-effect. If set to infinity, the phrase-effect needs to have a phraseType of continuous. Set infinite duration using $AFX::INFINITE_TIME.
bool ignoreChoreographerTriggers
When true, trigger-bits on the choreographer will be ignored.
bool ignoreConstraintTriggers
When true, animation triggers from dts-based constraint source objects will be ignored.
bool ignorePlayerTriggers
When true, Player-specific triggers from Player-derived constraint source objects will be ignored.
afxPhraseEffect_StateType matchState
Selects which bit-state(s) of bits in the triggerMask to consider when comparing to the current trigger-state. Possible values: on, off, or both.
afxPhraseEffect_MatchType matchType
Selects what combination of bits in triggerMask lead to a trigger. When set to 'any', any bit in triggerMask matching the current trigger-state will cause a trigger. If set to 'all', every bit in triggerMask must match the trigger-state. Possible values: any or all.
int numLoops
Specifies the number of times the phrase-effect should loop. If set to infinity, the phrase-effect needs to have a phraseType of continuous. Set infinite looping using $AFX::INFINITE_REPEATS.
string onTriggerCommand
Like a field substitution statement without the leading '$$' token, this eval statement will be executed when a trigger occurs. Any '%' and '##' tokens will be substituted.
afxPhraseEffect_PhraseType phraseType
Selects between triggered and continuous types of phrases. When set to 'triggered', the phrase-effect is triggered when the relevant trigger-bits change state. When set to 'continuous', the phrase-effect will stay active as long as the trigger-bits remain in a matching state. Possible values: triggered or continuous.
int triggerMask
Sets which bits to consider in the current trigger-state which consists of 32 trigger-bits combined from (possibly overlapping) player trigger bits, constraint trigger bits, and choreographer trigger bits.
Public Functions
pushEffect(afxEffectBaseData effectData)
Add a child effect to a phrase effect datablock. Argument can be an afxEffectWrappperData or an afxEffectGroupData.