Start Page » DragonScript Scripting Language » Abstraction Layers: How you want to build your Game » Behavior Elements » ECBehaviorRidable
Behavior adding support to elements to be ridden by actors.
Actors will attach using relative mode if ECBehaviorProjectToGround hits this element.
This behavior can be used only once on an element.
Element class properties have the prefix ridable.
.
Ride on instance begins riding.
Ride on instance stops riding.
This behavior adds these behavior tree actions if behavior tree is present.
Check one or more ridable parameters. Action succeeds if all parameter value matches their respective ridable parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a ridable parameter matches (or not).
Parameter | Value | Description |
---|---|---|
count | integer | Count of riding ride on instances equals integer value |
count.not | integer | Count of riding ride on instances does not equal integer value |
count.less | integer | Count of riding ride on instances is less than integer value |
count.greater | integer | Count of riding ride on instances is greater than integer value |
player | true , false | Player is riding |
wait | If present action returns BTResult.running instead of BTResult.failed to wait until the checks are all fulfilled |
This is an example of using this action:
<sequence> <action name='ridable.check'> <parameter name='player'>true</parameter> </action> <!-- actions here run only if player is riding --> </sequence>
This behavior adds these behavior tree conditions if behavior tree is present.
Check one or more ridable parameters. Conditions returns true if all parameter value match their respective ridable parameter. This condition is typically used to run an action or sequence of actions as long as ridable conditions are true.
Parameter | Value | Description |
---|---|---|
ridable.count | integer | Count of riding ride on instances equals integer value |
ridable.count.not | integer | Count of riding ride on instances does not equal integer value |
ridable.count.less | integer | Count of riding ride on instances is less than integer value |
ridable.count.greater | integer | Count of riding ride on instances is greater than integer value |
ridable.player | true , false | Player is riding |
This is an example of using this condition:
<action name='myAction' id='doing something'> <parameter name='ridable.player'>true</parameter> <condition>ridable.check</condition> </action>
Same as Behavior Tree Actions.
Same as Behavior Tree Conditions.
Ride on instance begins riding.
Ride on instance stops riding.
This behavior does support element class to be persistable (setPersistable). Saves selected color.
Since DragonScript Module Version 1.0
This example defines an element which can be rode by the player.
class MyElement extends BehaviorElementClass public var ECBehaviorComponent component public var ECBehaviorCollider collider public var ECBehaviorRidable ridable func new() component = ECBehaviorComponent.new(this, null) collider = ECBehaviorCollider.new(this, component) ridable = ECBehaviorRidable.new(this, collider) 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'/> <behavior type='ECBehaviorRidable'> <!-- 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> <!-- set element properties. omit property prefix if used inside behavior tag --> <string name='.name'>value</string> </behavior> </elementClass>