Behavior element behavior adding animation support to ECBehaviorLight

This behavior modifies the light parameters of ECBehaviorLight instances present in the element using move keyframes stored in an Animation or ECBehaviorComponent state. Animation playback starts when the light becomes activated and stops (and resets) if reactivated.

To use this behavior add first an ECBehaviorLight. Adding ECBehaviorLightAnimation will then register itself as listener to the ECBehaviorLight and also set it to use custom light handling.

Using Animation keyframes from a move is used to animate the light parameters.

Using ECBehaviorComponent the animated state is used to animate the light parameters. In this case the play time is 0 since the component state is typically driven by an animator or manually.

The input values obtained either from animation keyframes or component state is remapped before applying to the light parameter. This linearly maps the lower remap value (default 0) to 0 output value and the upper remap value (default 1) to 1 output value. Values outside the remap range are extrapolated.

Remapping is applied before scaling.

Multiple ECBehaviorLightAnimation instances can be added to affect individual ECBehaviorLight instances like this example below.

class MyElement extends BehaviorElementClass
    func new()
        var ECBehaviorLight light1 = ECBehaviorLight.new(this)
        ECBehaviorLightAnimation.new(this, light1)
 
        var ECBehaviorLight light2 = ECBehaviorLight.new(this, "subLight")
        ECBehaviorLightAnimation.new(this, light2)
    end
end

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

Set path to animation to use. Animation move based animation is used only if animation is set.

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

  <string name='lightAnimation.animation'>light.deanim</string>

Set move name to use. Animation move based animation is used only if move is set.

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

  <string name='lightAnimation.move'>flicker</string>

Set if animation playback is enabled.

• Full name: lightAnimation.enabled or lightAnimation({id}).enabled
• Type: boolean
• Default Value: true
• Example (*.deeclass)

  <boolean name='lightAnimation.enabled'>false</boolean>

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: lightAnimation.playSpeed or lightAnimation({id}).playSpeed
• Type: float
• Default Value: 1
• Example (*.deeclass)

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

Set enabled trigger. If no trigger is set the state of enabled property is used.

• Full name: lightAnimation.trigger or lightAnimation({id}).trigger
• Type: string
• Default Value: state of enabled
• Example (*.deeclass)

  <string name='lightAnimation.trigger'>@switchOnLight & @powerEnabled</string>

For each light parameter a set of properties can be defined. Replace <parameter> with one of the values from the following list:

Set target to obtain value from. If <parameter>.parameter is weight target is the name of the vertex position set to use. Otherwise target is the name of the bone to use.

• Full name: lightAnimation.<parameter>.target or lightAnimation({id}).<parameter>.target
• Type: string
• Default Value: empty string
• Example (*.deeclass)

  <string name='lightAnimation.colorRed.target'>color red</string>

Set which value to use of <parameter>.target.

• Full name: lightAnimation.<parameter>.parameter or lightAnimation({id}).<parameter>.parameter
• Type: enumeration

• Allowed Values:

  Value	Description
  positionX	Bone local position X coordinate.
  positionY	Bone local position Y coordinate.
  positionZ	Bone local position Z coordinate.
  rotationX	Bone local rotation X coordinate in degrees.
  rotationY	Bone local rotation Y coordinate in degrees.
  rotationZ	Bone local rotation Z coordinate in degrees.
  scaleX	Bone local scale X coordinate.
  scaleY	Bone local scale Y coordinate.
  scaleZ	Bone local scale Z coordinate.
  weight	Vertex position set weight.

• Default Value: positionZ
• Example (*.deeclass)

  <string name='lightAnimation.colorRed.parameter'>positionZ</string>

Set lower remap value. Input values obtained from target is remapped before applying to the light parameter. This linearly maps the lower remap value (default 0) to 0 output value and the upper remap value (default 1) to 1 output value. Values outside the remap range are extrapolated.

• Full name: lightAnimation.<parameter>.remapLower or lightAnimation({id}).<parameter>.remapLower
• Type: float
• Default Value: 0
• Example (*.deeclass)

  <float name='lightAnimation.colorRed.remapLower'>0.5</float>

Set upper remap value. Input values obtained from target is remapped before applying to the light parameter. This linearly maps the lower remap value (default 0) to 0 output value and the upper remap value (default 1) to 1 output value. Values outside the remap range are extrapolated.

• Full name: lightAnimation.<parameter>.remapUpper or lightAnimation({id}).<parameter>.remapUpper
• Type: float
• Default Value: 1
• Example (*.deeclass)

  <float name='lightAnimation.colorRed.remapUpper'>1.5</float>

This behavior provides no events:

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

Set one or more light parameters.

This is an example of using this action:

<action name='lightAnimation.set'>
  <parameter name='enabled'>true</parameter>
</action>

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

This is an example of using this action:

<sequence>
  <action name='lightAnimation.check'>
    <parameter name='enabled'>true</parameter>
    <parameter name='time.less'>3</parameter>
  </action>
  <!-- actions here run only if animation is enabled and playback time is less than 3 seconds -->
</sequence>

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

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

This is an example of using this condition:

<action name='myAction' id='doing something'>
  <parameter name='lightAnimation.enabled'>true</parameter>
  <parameter name='lightAnimation.time.less'>3</parameter>
  <condition>lightAnimation.check</condition>
</action>

Same as Behavior Tree Actions.

Same as Behavior Tree Conditions.

This behavior sends no state machine events.

• ECBehaviorLight. Light to animate.

• ECBehaviorComponent. Use component state if no animation and move is set.
• ECBehaviorBehaviorTree: Add actions and conditions for behavior trees to use.
• ECBehaviorStateMachine: Add actions and conditions for state machine to use and events to send to the state machine.

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

ECBehaviorLightAnimation.

Since DragonScript Module Version 1.28

• Animate light parameters for example to create a flickering light bulb.
• Animate light parameters depending on the animation state of a component for example a robot arm location.

This example defines an element which contains a light which is animated.

class MyElement extends BehaviorElementClass
  public var ECBehaviorLight light
  public var ECBehaviorLightAnimation lightAnimation
  func new()
    light = ECBehaviorLight.new(this, null)
    light.getLight().getColor().setColor(Color.white)
    light.getLight().getIntensity().setValue(10)
    
    lightAnimation = ECBehaviorLightAnimation.new(this, light)
    lightAnimation.getAnimation().setPath("/content/light/bulb.deanim")
    lightAnimation.getMove().setValue("flicker")
    lightAnimation.getLightParameter(ECBehaviorLightAnimation.LightParameter.intensity).getTarget().setValue("light.intensity")
  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='ECBehaviorLight'>
    <color name='.color' r='1' g='1' b='1'/>
    <float name='.intensity'>10</float>
  </behavior>
 
  <behavior type='ECBehaviorLightAnimation'>
    <!-- optional: use BaseGameApp trigger table. game can add more supported values.
                  default value 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: use behavior tree with id instead of empty string -->
    <string name='behaviorTree'>second</string>
 
    <!-- optional: use state machine with id instead of empty string -->
    <string name='stateMachine'>second</string>
 
    <!-- optional: light behavior to use instead of default one -->
    <string name='light'>other</string>
 
    <!-- optional: component behavior to use instead of default one if present -->
    <string name='component'>second</string>
 
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.animation'>/content/light/bulb.deanim</string>
    <string name='.move'>flicker</string>
    <string name='.intensity.target'>intensity</string>
  </behavior>
 
  <!-- for adding multiple behaviors use unique identifiers -->
  <behavior type='ECBehaviorLightAnimation' id='second'/>
</elementClass>

• DEExamples Repository