Behavior element behavior adding foot steps support to actors.

Uses a list of events to play random foot steps according to an elapsing time value. The elapsed time is updated with the elapsed game time while the actor is walking. If auto-update is true (which is the default) update() is called automatically by the behavior on thinking. Otherwise the actor has to call update(float) to advance the elapsed time. Independent of auto-updating the actor has to call reset() when standing still to ensure the events fire at the right time.

Events define for an elapsed time the sound to play. This is using a WeightedRandomList allowing to pick a random sound with support to favor certain sounds. The sound is then played at an offset relative to the behavior element with individual sound parameters. The sound parameters and offset are defined for each individual sound allowing special configurations like a pirate walking with a wooden leg.

It is common for actors to switch between different gaits (walking, running, robbing or sneaking). To make this process simple multiple configurations can be stored. The actor can then switch between configurations. Depending on how the animations are set up for the actor changing configuration has to reset the elapsed time or not. The actor is responsible to call reset() if required after switching configurations.

If you want to support different foot step sounds for different materials you should not use multiple configurations since switching them can reset the event timing. Use instead events with empty sound list and use the behavior listener to be notified when sound has to be played. See other behaviors for adding material foot step support as well as other special effects like triggering particle emitters.

This behavior can be used only once on an element.

Element class properties have the prefix footSteps. .

This behavior has these events:

Foot step triggered.

Configuration changed.

This behavior adds these behavior tree actions if behavior tree is present.

Set one or more foot steps parameters.

This is an example of using this action:

<action name='footSteps.set'>
  <parameter name='configuration'>walk</parameter>
</action>

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

This is an example of using this action:

<sequence>
  <action name='footSteps.check'>
    <parameter name='configuration'>walk</parameter>
  </action>
  <!-- actions here run only if configuration named "walk" is active -->
</sequence>

This behavior adds these behavior tree conditions if behavior tree is present.

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

This is an example of using this condition:

<action name='myAction' id='doing something'>
  <parameter name='footSteps.enabled'>true</parameter>
  <condition>footSteps.check</condition>
</action>

Same as Behavior Tree Actions.

Same as Behavior Tree Conditions.

This behavior sends these state machine events.

Foot steps configuration changed.

Foot step triggered.

This behavior requires no other behaviors.

• 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).

ECBehaviorFootSteps.

Since DragonScript Module Version 1.0

• Play foot step sounds for actor when moving.

This example defines an element which has support for playing footsteps.

class MyElement extends BehaviorElementClass
  public var ECBehaviorFootSteps footSteps
  func new()
    footSteps = ECBehaviorFootSteps.new(this, "color1", "Color 1", Color.blue)
  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='ECBehaviorFootSteps'>
    <!-- optional: use actor animated with id instead of empty string -->
    <string name='actorAnimated'>second</string>
 
    <!-- set if update() is automatically called on postThink(). default is 'true' -->
    <boolean name='autoUpdate'>false</boolean>
 
    <!-- optional: use state machine with id instead of empty string -->
    <string name='stateMachine'>second</string>
 
    <!-- set if update() is automatically called on postThink(). default is 'true' -->
    <boolean name='autoUpdate'>false</boolean>
 
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.name'>value</string>
  </behavior>
</elementClass>

• DEExamples Repository