Behavior element behavior adding two state animation support.

Plays back animations for behavior elements in two different states with transition between them. Animators are required to have controllers name the right way to work with this behavior. Controllers not matching the require name are ignored. It is not necessary to have all controller names covered. Actually this behavior optimizes at runtime if not all controllers are used.

The controller names can be changed using the setControllerName*() methods.

Activate Trigger

When changing to true the element is switched to the activated state. When changing to false the element is switched to the deactivated state. If the switch happens during transition time the transition is finished before switching.

See also:

• Animators and Animations
• IGDE Animator Editor
• Blender3D Export Scripts

Multiple ECBehaviorTwoStateAnimated can be added targeting different ECBehaviorComponent using their identifier. It is also possible to add multiple ECBehaviorTwoStateAnimated manipulating the same ECBehaviorComponent as long as the animators used are properly crafted. This can be used for example to add overlayed animations.

Element class properties have the prefix twoStateAnimated. or twoStateAnimated({id}). if id is not empty.

Set path to animator to use.

• Full name: twoStateAnimated.animator or twoStateAnimated({id}).animator
• Type: string
• Default Value: empty string
• Expected File Pattern: *.deanimator
• Example (*.deeclass)

  <string name='twoStateAnimated.animator'>default.deanimator</string>

Set path to animation to use. If used replaces animation defined in assigned animators.

• Full name: twoStateAnimated.animation or twoStateAnimated({id}).animation
• Type: string
• Default Value: empty string
• Expected File Pattern: *.deanim (all supported animation type modules)
• Example (*.deeclass)

  <string name='twoStateAnimated.animation'>default.deanim</string>

Set playback speed. Value of 1 plays back at normal speed. Values larger than 1 play back faster. Values less then 1 play back slower.

• Full name: twoStateAnimated.playSpeed or twoStateAnimated({id}).playSpeed
• Type: float
• Default Value: 1
• Restrictions: At least 0.001
• Example (*.deeclass)

  <float name='twoStateAnimated.playSpeed'>0.5</float>

Set trigger. If trigger evaluates to true transitions to active state. If trigger evaluates to false transitions to deactivated state.

• Full name: twoStateAnimated.trigger or twoStateAnimated({id}).trigger
• Type: string
• Default Value: empty string
• Example (*.deeclass)

  <string name='twoStateAnimated.trigger'>@switchOnVent & @powerEnabled</string>

Set activated target. Fires target if state becomes activated. Resets target if state leaves activated.

• Full name: twoStateAnimated.targetActivated or twoStateAnimated({id}).targetActivated
• Type: string
• Default Value: empty string
• Example (*.deeclass)

  <string name='twoStateAnimated.targetActivated'>turnedOn</string>

Set activating target. Fires target while state transitions from deactivated to activated state. Resets target if state becomes activated.

• Full name: twoStateAnimated.targetActivating or twoStateAnimated({id}).targetActivating
• Type: string
• Default Value: empty string
• Example (*.deeclass)

  <string name='twoStateAnimated.targetActivating'>turningOn</string>

Set deactivating target. Fires target while state transitions from activated to deactivated state. Resets target if state becomes deactivated.

• Full name: twoStateAnimated.targetDeactivating or twoStateAnimated({id}).targetDeactivating
• Type: string
• Default Value: empty string
• Example (*.deeclass)

  <string name='twoStateAnimated.targetDeactivating'>turningOff</string>

This behavior has these events:

Start transition from deactivated state to activated state.

Finished transition from deactivated state to activated state.

Start transition from activated state to deactivated state.

Finished transition from activated state to deactivated state.

Update controllers if required.

Animation has been applied.

This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace twoStateAnimated with twoStateAnimated(id).

Set one or more two-state animated parameters.

This is an example of using this action:

<action name='twoStateAnimated.set'>
  <parameter name='activate'/>
</action>

Check one or more two-state animated. Action succeeds if all parameter value matches their respective twoStateAnimated parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a twoStateAnimated parameter matches (or not).

This is an example of using this action:

<sequence>
  <action name='twoStateAnimated.check'>
    <parameter name='activating'>true</parameter>
    <parameter name='progress.activate.less'>0.5</parameter>
  </action>
  <!-- actions here run only if behavior is activating with less than 50% done -->
</sequence>

This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace twoStateAnimated with twoStateAnimated(id).

Check one or more two-state animated. Conditions returns true if all parameter value match their respective twoStateAnimated parameter. This condition is typically used to run an action or sequence of actions as long as twoStateAnimated conditions are true.

This is an example of using this condition:

<action name='myAction' id='doing something'>
  <parameter name='twoStateAnimated.activating'>true</parameter>
  <parameter name='twoStateAnimated.progress.activate.less'>0.5</parameter>
  <condition>twoStateAnimated.check</condition>
</action>

• ECBehaviorComponent

This behavior does not support optional behaviors.

This behavior does support element class to be persistable (setPersistable).

ECBehaviorTwoStateAnimated.

Since DragonScript Module Version 1.0

• Animate object which can switch between activated and deactivated state with transition animations.

This example defines an element which suports two-state animation.

class MyElement extends BehaviorElementClass
  public var ECBehaviorComponent component
  public var ECBehaviorCollider collider
  func new()
    component = ECBehaviorComponent.new(this, null)
    collider = ECBehaviorCollider.new(this, component)
    ECBehaviorTwoStateAnimated.new(this, "color1", "Color 1", Color.blue)
    ECBehaviorTwoStateAnimated.new(this, "color2", "Color 2", Color.red)
  end
end

Using element class supporting adding behaviors the behavior can be added like this:

<?xml version='1.0' encoding='UTF-8'?>
<elementClass name='MyClass' class='GenericBehaviorElement'>
  <behavior type='ECBehaviorComponent'/>
 
  <behavior type='ECBehaviorTwoStateAnimated'>
    <!-- optional: use component with id instead of empty string -->
    <string name='component'>second</string>
 
    <!-- optional: use BaseGameApp trigger table. game can add more supported values. default is 'default' -->
    <string name='triggerTable'>default</string>
 
    <!-- optional: identifier of ECBehaviorTriggered to synchronize with or empty
                   string to not synchronize. default is empty string. -->
    <string name='trigger.synchronize'>other</string>
 
    <!-- optional: name of deactivated controller. default is 'deactivated' -->
    <string name='controllerNameDeactivated'>deactivated</string>
 
    <!-- optional: name of activated controller. default is 'activated' -->
    <string name='controllerNameActivated'>activated</string>
 
    <!-- optional: name of activating controller. default is 'activating' -->
    <string name='controllerNameActivating'>activating</string>
 
    <!-- optional: name of deactivating controller. default is 'deactivating' -->
    <string name='controllerNameDeactivating'>deactivating</string>
 
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.animator'>flap.deanimator</string>
  </behavior>
 
  <!-- for adding multiple behaviors use unique identifiers -->
  <behavior type='ECBehaviorTwoStateAnimated' id='second'/>
</elementClass>

• DEExamples Repository