Drag[en]gine Wiki

User Tools

Site Tools

Trace:
dragengine:modules:dragonscript:behavior_actoraiaction

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
dragengine:modules:dragonscript:behavior_actoraiaction [2025/03/12 19:37] – [Optional Behaviors] dragonlorddragengine:modules:dragonscript:behavior_actoraiaction [2026/09/26 21:47] (current) – [Element Class Properties] dragonlord
Line 1: Line 1:
 {{tag>dragonscript behavior}} {{tag>dragonscript behavior}}
 <WRAP youarehere> <WRAP youarehere>
-[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[abstractions#behavior_elementsquick_and_easy_development|Behavior Elements: Quick and Easy Development]] >> **ECBehaviorActorAIAction**+[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[dragengine:modules:dragonscript:abstractions|Abstraction Layers: How you want to build your Game]] >> [[dragengine:modules:dragonscript:behavior_elements|Behavior Elements]] >> **ECBehaviorActorAIAction**
 </WRAP> </WRAP>
  
Line 22: Line 22:
 ====== Element Class Properties ====== ====== Element Class Properties ======
 Element class properties have the prefix ''aiAction.''. Element class properties have the prefix ''aiAction.''.
 +
 +===== action =====
 +
 +Name of action factory to use to create action instance. Name is looked up using BaseGameApp.getLoader().getPersistency().getFactoryNamed(). The factory must inherit from ECBehaviorActorAIAction.ActionFactory. The following factories are added by BaseGameApp:
 +
 +  * BaseActorAction: Empty action doing nothing.
 +  * BAAFirstPerson: First person actor action.
 +  * BAAFirstPersonVR: First person actor action for VR use.
 +  * BAAVehicle: Vehicle actor action.
 +  * BAAStateMachine: Actor action using state machine defined by [[behavior_statemachine|ECBehaviorStateMachine]].
 +
 +To use custom factories add using Persistency.addFactory() using the name you like to use. Names are not required to match the class name but doing so makes it easier to find the responsible class
 +
 +  * Full name: ''aiAction.action''
 +  * Type: string
 +  * Default Value: ''BAAFirstPerson''
 +  * Example (*.deeclass) <code xml><string name='aiAction.action'>BAAStateMachine</string></code>
 +
 +===== ai =====
 +
 +Name of AI factory to use to create action instance. Name is looked up using BaseGameApp.getLoader().getPersistency().getFactoryNamed(). The factory must inherit from ECBehaviorActorAIAction.AIFactory. The following factories are added by BaseGameApp:
 +
 +  * BaseActorAI: Empty AI doing nothing.
 +  * BAAIBehaviorTree: Actor AI using behavior tree defined by [[behavior_behaviortree|ECBehaviorBehaviorTree]].
 +
 +To use custom factories add using Persistency.addFactory() using the name you like to use. Names are not required to match the class name but doing so makes it easier to find the responsible class
 +
 +  * Full name: ''aiAction.ai''
 +  * Type: string
 +  * Default Value: ''BAAIBehaviorTree''
 +  * Example (*.deeclass) <code xml><string name='aiAction.action'>BaseActorAI</string></code>
  
 ====== Events ====== ====== Events ======
  
 Since this behavior provides no support to apply the chosen color listening is used. Behaviors knowing how to apply the color add a listener and are notified if the color changes. These events can be received: Since this behavior provides no support to apply the chosen color listening is used. Behaviors knowing how to apply the color add a listener and are notified if the color changes. These events can be received:
 +
 +====== Behavior Tree Actions ======
 +
 +This behavior adds these behavior tree actions if behavior tree is present.
 +
 +===== aiAction.set =====
 +
 +Set one or more actor ai/action parameters.
 +
 +^Parameter^Value^Description^
 +|ai.behaviorTree|string|Set AI using BAAIBehaviorTree with behavior tree loaded from value path. Path can be relative to behavior tree file containing this action|
 +|action.stateMachine|string|Set Action using BAAStateMachine with state machine loaded from value path. Path can be relative to behavior tree or state machine file containing this action|
 +|action.conversationWait|''true'', ''false''|Set if conversation waits due to active action|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='aiAction.set'>
 +  <parameter name='ai.behaviorTree'>/content/ai/patrol.debt</parameter>
 +  <parameter name='action.stateMachine'>/content/action/human.desm</parameter>
 +</action>
 +</code>
 +
 +===== aiAction.update =====
 +
 +Update AI/Action.
 +
 +^Parameter^Value^Description^
 +|ai.actionFinished|''success'', ''failure''|If actor is not player controlled calls actionFinished() or actionFailed() on the active AI if present|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='aiAction.update'>
 +  <parameter name='ai.actionFinished'>success</parameter>
 +</action>
 +</code>
 +
 +===== aiAction.check =====
 +
 +Check one or more behavior parameters. Action succeeds if all parameter value matches their respective player input crouch parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a player input crouch parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|action.conversationWait|''true'', ''false''|Conversation waits due to active action|
 +
 +This is an example of using this action:
 +<code xml>
 +<sequence>
 +  <action name='aiAction.check'>
 +    <parameter name='action.conversationWait'>true</parameter>
 +  </action>
 +  <!-- actions here run only if conversation wait is enabled -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present.
 +
 +===== aiAction.check =====
 +
 +Check one or more behavior parameters. Conditions returns true if all parameter value match their respective player input crouch parameter. This condition is typically used to run an action or sequence of actions as long as player input crouch conditions are true.
 +
 +^Parameter^Value^Description^
 +|aiAction.action.conversationWait|''true'', ''false''|Conversation waits due to active action|
 +
 +This is an example of using this condition:
 +<code xml>
 +<action name='myAction' id='doing something'>
 +  <parameter name='aiAction.action.conversationWait'>true</parameter>
 +  <condition>aiAction.check</condition>
 +</action>
 +</code>
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
Line 36: Line 138:
   * [[behavior_conversationactor|ECBehaviorConversationActor]]: Add conversation commands and conditions.   * [[behavior_conversationactor|ECBehaviorConversationActor]]: Add conversation commands and conditions.
   * [[behavior_playercontrollable|ECBehaviorPlayerControllable]]: Listen to events processing them with actions.   * [[behavior_playercontrollable|ECBehaviorPlayerControllable]]: Listen to events processing them with actions.
 +  * [[behavior_behaviortree|ECBehaviorBehaviorTree]]: Add actions and conditions for behavior trees to use.
  
 ====== Persistency ====== ====== Persistency ======
Line 89: Line 192:
   <behavior type='ECBehaviorActorAIAction'>   <behavior type='ECBehaviorActorAIAction'>
     <!-- behavior factory automatically assigns all optional behaviors if present -->     <!-- behavior factory automatically assigns all optional behaviors if present -->
 +    
 +    <!-- optional: use behavior tree with id instead of empty string -->
 +    <string name='behaviorTree'>second</string>
          
     <!-- set element properties. omit property prefix if used inside behavior tag -->     <!-- set element properties. omit property prefix if used inside behavior tag -->
dragengine/modules/dragonscript/behavior_actoraiaction.1741808258.txt.gz · Last modified: by dragonlord

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
CC Attribution-Noncommercial-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki