Drag[en]gine Wiki

User Tools

Site Tools

Trace:
dragengine:modules:dragonscript:behavior_occupier

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_occupier [2025/03/12 21:29] – dragonlorddragengine:modules:dragonscript:behavior_occupier [2025/05/04 13:47] (current) – [occupier.check] 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]] >> **ECBehaviorOccupier**+[[: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]] >> **ECBehaviorOccupier**
 </WRAP> </WRAP>
  
Line 34: Line 34:
 Occupier claimed interaction spot. Occupier claimed interaction spot.
  
-===== spotReleased (Instance instance, ECBehaviorInteractionSpot.Instance interactionSpot)+===== spotReleased ===== 
 + 
 +Occupier released interaction spot. 
 + 
 +====== Behavior Tree Actions ====== 
 + 
 +This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''occupier'' with ''occupier(id)''. 
 + 
 +===== occupier.release ===== 
 + 
 +Release interaction slot if one is occupied. 
 + 
 +This is an example of using this action: 
 +<code xml> 
 +<action name='occupier.release'/> 
 +</code> 
 + 
 +===== occupier.check ===== 
 + 
 +Check one or more occupier parameters. Action succeeds if all parameter value matches their respective occupier parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a occupier parameter matches (or not). 
 + 
 +^Parameter^Value^Description^ 
 +|occupying|''true'', ''false''|Occupier is occupying an interaction spot| 
 +|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: 
 +<code xml> 
 +<sequence> 
 +  <action name='occupier.check'> 
 +    <parameter name='occupying'>true</parameter> 
 +  </action> 
 +  <!-- actions here run only if occupier is occupying an interaction spot --> 
 +</sequence> 
 +</code> 
 + 
 +====== Behavior Tree Conditions ====== 
 + 
 +This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''occupier'' with ''occupier(id)''. 
 + 
 +===== occupier.check ===== 
 + 
 +Check one or more occupier parameters. Conditions returns true if all parameter value match their respective occupier parameter. This condition is typically used to run an action or sequence of actions as long as occupier conditions are true. 
 + 
 +^Parameter^Value^Description^ 
 +|occupier.occupying|''true'', ''false''|Occupier is occupying an interaction spot| 
 + 
 +This is an example of using this condition: 
 +<code xml> 
 +<action name='myAction' id='doing something'> 
 +  <parameter name='occupier.occupying'>true</parameter> 
 +  <condition>occupier.check</condition> 
 +</action> 
 +</code> 
 + 
 +====== State Machine Actions ====== 
 + 
 +Same as [[#behavior_tree_actions|Behavior Tree Actions]]. 
 + 
 +====== State Machine Conditions ====== 
 + 
 +Same as [[#behavior_tree_conditions|Behavior Tree Conditions]]. 
 + 
 +====== State Machine Events ====== 
 + 
 +This behavior sends these state machine events. If behavior has non-empty identifier replace ''occupier'' with ''occupier(id)''. 
 + 
 +===== occupier.claimed ===== 
 + 
 +Occupier claimed interaction spot. 
 + 
 +===== occupier.released =====
  
 Occupier released interaction spot. Occupier released interaction spot.
Line 44: Line 114:
 ====== Optional Behaviors ====== ====== Optional Behaviors ======
  
-This behavior does not support optional behaviors.+  * [[behavior_behaviortree|ECBehaviorBehaviorTree]]: Add actions and conditions for behavior trees to use. 
 +  * [[behavior_statemachine|ECBehaviorStateMachine]]: Add actions and conditions for state machine to use and events to send to the state machine.
  
 ====== Persistency ====== ====== Persistency ======
Line 51: Line 122:
  
 ====== API Documentation ====== ====== API Documentation ======
 +
 #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorOccupier.html,ECBehaviorOccupier~@#. #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorOccupier.html,ECBehaviorOccupier~@#.
  
Line 101: Line 173:
 <elementClass name='MyClass' class='GenericBehaviorElement'> <elementClass name='MyClass' class='GenericBehaviorElement'>
   <behavior type='ECBehaviorOccupier'>   <behavior type='ECBehaviorOccupier'>
 +    <!-- 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 -->     <!-- set element properties. omit property prefix if used inside behavior tag -->
     <string name='.name'>value</string>     <string name='.name'>value</string>
dragengine/modules/dragonscript/behavior_occupier.1741814944.txt.gz · Last modified: 2025/03/12 21:29 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