User Tools

Site Tools


dragengine:modules:dragonscript:behavior_playerlookatinteractprompt

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_playerlookatinteractprompt [2025/03/13 17:15] dragonlorddragengine:modules:dragonscript:behavior_playerlookatinteractprompt [2025/05/07 14:30] (current) dragonlord
Line 94: Line 94:
  
 This behavior has no events. This behavior has no events.
 +
 +====== Behavior Tree Actions ======
 +
 +This behavior adds these behavior tree actions if behavior tree is present.
 +
 +===== playerLookAtInteractPrompt.set =====
 +
 +Set one or more player look at interact prompt parameters.
 +
 +^Parameter^Value^Description^
 +|enabled|''true'', ''false''|Enable player look at interact prompt|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='playerLookAtInteractPrompt.set'>
 +  <parameter name='enabled'>true</parameter>
 +</action>
 +</code>
 +
 +===== playerLookAtInteractPrompt.check =====
 +
 +Check one or more player look at interact prompt parameters. Action succeeds if all parameter value matches their respective player look at interact prompt parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a player look at interact prompt parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|enabled|''true'', ''false''|Player look at interact prompt is enabled or not|
 +|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='playerLookAtInteractPrompt.check'>
 +    <parameter name='enabled'>true</parameter>
 +  </action>
 +  <!-- actions here run only if player look at interact prompt is enabled -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present.
 +
 +===== playerLookAtInteractPrompt.check =====
 +
 +Check one or more player look at interact prompt parameters. Conditions returns true if all parameter value match their respective player look at interact prompt parameter. This condition is typically used to run an action or sequence of actions as long as player look at interact prompt conditions are true.
 +
 +^Parameter^Value^Description^
 +|playerLookAtInteractPrompt.enabled|''true'', ''false''|Player look at interact prompt is enabled or not|
 +
 +This is an example of using this condition:
 +<code xml>
 +<action name='myAction' id='doing something'>
 +  <parameter name='playerLookAtInteractPrompt.enabled'>true</parameter>
 +  <condition>playerLookAtInteractPrompt.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 send no events to state machine.
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
Line 102: Line 169:
 ====== 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 224: Line 292:
                    default is 'default' -->                    default is 'default' -->
     <string name='bindingManager'>default</string>     <string name='bindingManager'>default</string>
 +    
 +    <!-- 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 -->
dragengine/modules/dragonscript/behavior_playerlookatinteractprompt.1741886137.txt.gz · Last modified: 2025/03/13 17:15 by dragonlord