Differences

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

--- dragengine:modules:dragonscript:behavior_vrcontroldesktop [2025/05/13 23:05] – old revision restored (2025/03/13 17:17) dragonlord
+++ dragengine:modules:dragonscript:behavior_vrcontroldesktop [2025/05/14 01:12] (current) – dragonlord
@@ Line 24: / Line 24: @@
 This behavior has no events.
+====== Behavior Tree Actions ======
+This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''vrControlDesktop'' with ''vrControlDesktop(id)''.
+===== vrControlDesktop.set =====
+Set one or more control desktop parameters.
+^Parameter^Value^Description^
+|interact|string|Interact with desktop. 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''.|
+|interactElement.assign|string|Assign desktop to [[behavior_interactelement|ECBehaviorInteractElement]] with identifier matching value string. Action fails if no element is looked at or interact element behavior is absent|
+This is an example of using this action:
+<code xml>
+<action name='vrControlDesktop.set'>
+  <parameter name='interactElement.assign'/>
+</action>
+</code>
+===== vrControlDesktop.check =====
+Check one or more control desktop parameters. Action succeeds if all parameter value matches their respective control desktop parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a control desktop parameter matches (or not).
+^Parameter^Value^Description^
+|desktop|''true'', ''false''|Desktop is controlled|
+|interact.name|string|Name of interaction|
+|interact.has|''true'', ''false''|Has desktop and interaction with name ''interaction.name'' is present|
+|interact.query|''true'', ''false''|Interact with desktop and test result. Condition is true if desktop 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='vrControlDesktop.check'>
+    <parameter name='desktop'>true</parameter>
+  </action>
+  <!-- actions here run only if player is controlling a desktop -->
+</sequence>
+</code>
+====== Behavior Tree Conditions ======
+This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''vrControlDesktop'' with ''vrControlDesktop(id)''.
+===== vrControlDesktop.check =====
+Check one or more control desktop parameters. Conditions returns true if all parameter value match their respective control desktop parameter. This condition is typically used to run an action or sequence of actions as long as control desktop conditions are true.
+^Parameter^Value^Description^
+|desktop|''true'', ''false''|Desktop is controlled|
+|vrControlDesktop.interact.name|string|Name of interaction|
+|vrControlDesktop.interact.has|''true'', ''false''|Has desktop and interaction with name ''interaction.name'' is present|
+|vrControlDesktop.interact.query|''true'', ''false''|Interact with desktop and test result. Condition is true if desktop 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).|
+|vrControlDesktop.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='vrControlDesktop.enabled'>true</parameter>
+  <condition>vrControlDesktop.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 no state machine events.
 ====== Required Behaviors ======
@@ Line 31: / Line 108: @@
 ====== 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 ======
@@ Line 173: / Line 251: @@
     <!-- required: use vr hand point at with id -->
     <string name='vrHandPointAt'>right</string>
+    <!-- optional: add behavior trees. default adds all behavior trees. -->
+    <list name='behaviorTrees'>
+      <string/> <!-- add behavior with empty identifier -->
+      <string>default</string> <!-- add behavior with 'default' identifier -->
+    </list>
+    <!-- optional: add state machines. default adds all state machines. -->
+    <list name='stateMachines'>
+      <string/> <!-- add behavior with empty identifier -->
+      <string>default</string> <!-- add behavior with 'default' identifier -->
+    </list>
     <!-- set element properties. omit property prefix if used inside behavior tag -->

Drag[en]gine Wiki

User Tools

Site Tools

Differences

Page Tools