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/13 17:14] – dragonlorddragengine:modules:dragonscript:behavior_occupier [2025/06/19 12:44] (current) – [ECBehaviorOccupier] dragonlord
Line 16: Line 16:
 </WRAP> </WRAP>
  
-Behavior element behavior adding support to uccipy an [[behavior_interactionspot|CBehaviorInteractionSpot]].+Behavior element behavior adding support to occupy an [[behavior_interactionspot|ECBehaviorInteractionSpot]].
  
-[[behavior_interactionspot|CBehaviorInteractionSpot]] defines position and orientation actors or the player have to assume to interact properly with this element. The ECBehaviorOccupier behavior provides support to claim such interaction spots.+[[behavior_interactionspot|ECBehaviorInteractionSpot]] defines position and orientation actors or the player have to assume to interact properly with this element. The ECBehaviorOccupier behavior provides support to claim such interaction spots.
  
 ====== Instance Counts ====== ====== Instance Counts ======
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.update ===== 
 + 
 +Set one or more occupier parameters. 
 + 
 +^Parameter^Value^Description^ 
 +|release| |Release interaction slot if one is occupied.| 
 +|interactElement.assign|string|Assign interaction slot element to [[behavior_interactionelement|ECBehaviorInteractionElement]] with identifier matching value string. Action fails if no interaction spot is occupied or interact element behavior is absent| 
 +|claim|string|Claim interaction zone present in the [[behavior_interactionelement|ECBehaviorInteractionElement]] with identifier matching value string| 
 +|claim.id|string|Identifier of interaction spot to claim| 
 +|move| |Move to occupied interaction spot. Uses [[behavior_actormover|ECBehaviorActorMover]] to move to world position defined by interaction spot| 
 +|move.distance|float|Distance in meters to approach interaction spot world position before finish moving| 
 +|align| |Align with occupied interaction spot. Uses [[behavior_alignactor|ECBehaviorAlignActor]] to align actor with world position and orientation defined by interaction spot. If interaction spot defines a look-at position the [[behavior_conversationactor|ECBehaviorConversationActor]] is used to make the actor look at this position while aligning. After aligning the [[behavior_conversationactor|ECBehaviorConversationActor]] keeps the look-at. You have to clear it using action ''conversationActor.update'' and parameter ''headLookAt.clear''. Doing this while no look-at is in place is fine and thus should be always done| 
 +|interact|string|Interact with grab spot. If element is absent action fails. Runs interaction with name value. If interaction with name value is absent fails action. If interaction returns false fails action. Otherwise action succeeds.| 
 +|interact.parameters|string|Optional parameters to use with ''interaction''.| 
 + 
 +This is an example of using this action: 
 +<code xml> 
 +<action name='occupier.update'> 
 +  <parameter name='release'/> 
 +</action> 
 +</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| 
 +|interact.name|string|Name of interaction| 
 +|interact.has|''true'', ''false''|Has grab spot and interaction with name ''interaction.name'' is present| 
 +|interact.query|''true'', ''false''|Interact with grab spot and test result. Condition is true if grab spot is present, interaction with name ''interaction.name'' is present and interaction returns true. It is recommended to use here only interactions without side effects (hence query interactions).| 
 +|interact.parameters|string|Optional parameters to use with ''interaction.query''.| 
 +|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| 
 +|occupier.interact.name|string|Name of interaction| 
 +|occupier.interact.has|''true'', ''false''|Has grab spot and interaction with name ''interaction.name'' is present| 
 +|occupier.interact.query|''true'', ''false''|Interact with grab spot and test result. Condition is true if grab spot is present, interaction with name ''interaction.name'' is present and interaction returns true. It is recommended to use here only interactions without side effects (hence query interactions).| 
 +|occupier.interact.parameters|string|Optional parameters to use with ''interaction.query''.| 
 + 
 +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 135:
 ====== 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 143:
  
 ====== 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 194:
 <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.1741886047.txt.gz · Last modified: 2025/03/13 17:14 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