Behavior element behavior adding locomotion support for actors.

Adds Locomotion. Actors use Locomotion to move their AI colliders across the game world. Locomotion also provides values for AnimatorController to provide animation to actors matching their movement.

Uses collider of ECBehaviorColliderAI or ECBehaviorCollider depending which one is present. If both are present ECBehaviorColliderAI is preferred.

By default creates instance of Locomotion. This class provides all the basic behavior to do locomotion for different type of actors. Supports organic locomotion of 2-legged and 4-legged characters with natural and FPS type movement patterns as well as mechanical locomotion like vehicles.

Locomotion parameters have to be set on runtime. The behavior itself does not support initializing locomotion parameters. This is the case since locomotion parameters change a lot depending on what game situation an actor is located in. Use ECBehaviorActorAIAction, ECBehaviorStateMachine or ECBehaviorBehaviorTree for this task.

The ECBehaviorLocomotion provides access to the locomotion class to modify at runtime.

See also:

• Locomotion

This behavior can be used only once on an element.

Element class properties have the prefix locomotion. .

This behavior has no events.

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

Set one or more locomotion parameters.

This is an example of using this action:

<action name='locomotion.set'>
  <parameter name='preset'>human</parameter>
</action>

Update locomotion.

This is an example of using this action:

<sequence>
  <action name='locomotion.check'>
    <parameter name='enabled'>true</parameter>
  </action>
  <!-- actions here run only if locomotion is enabled -->
</sequence>

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

This is an example of using this action:

<sequence>
  <action name='locomotion.check'>
    <parameter name='enabled'>true</parameter>
  </action>
  <!-- actions here run only if locomotion is enabled -->
</sequence>

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

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

This is an example of using this condition:

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

Same as Behavior Tree Actions.

Same as Behavior Tree Conditions.

This behavior sends no state machine events.

• ECBehaviorColliderAI or ECBehaviorCollider

• 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). Saves locomotion state.

ECBehaviorLocomotion.

Since DragonScript Module Version 1.0

• Add support for FPS/natural type locomotion to human/creature actors.
• Add support for vehicle type locomotion to vehicles.

This example defines an element which supports locomotion for actors. For vehicles omit ECBehaviorColliderAI and use ECBehaviorCollider instead.

class MyElement extends BehaviorElementClass
  public var ECBehaviorComponent component
  public var ECBehaviorCollider collider
  public var ECBehaviorColliderAI colliderAI
  public var ECBehaviorLocomotion locomotion
  func new()
    component = ECBehaviorComponent.new(this, null)
    collider = ECBehaviorCollider.new(this, component)
    colliderAI = ECBehaviorColliderAI.new(this, collider)
    locomotion = ECBehaviorLocomotion.new(this, colliderAI)
  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='ECBehaviorCollider'/>
 
  <!-- for vehicles omit this line to use ECBehaviorCollider instead -->
  <behavior type='ECBehaviorColliderAI'/>
 
  <behavior type='ECBehaviorLocomotion'>
    <!-- optional: add behavior trees. default adds all behavior trees. -->
    <list name='behaviorTrees'>
      <string/> <!-- add behavior with empty identifier -->
      <string>default</string> <!-- add behavior with 'default' identifier -->
    </list>
 
    <!-- optional: add state machines. default adds all state machines. -->
    <list name='stateMachines'>
      <string/> <!-- add behavior with empty identifier -->
      <string>default</string> <!-- add behavior with 'default' identifier -->
    </list>
 
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.name'>value</string>
  </behavior>
</elementClass>

• DEExamples Repository