Differences

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

--- dragengine:modules:dragonscript:behavior_interactionspot [2020/11/23 15:57] – created dragonlord
+++ dragengine:modules:dragonscript:behavior_interactionspot [2025/05/04 13:47] (current) – [interactionSpot.check] dragonlord
@@ Line 1: / Line 1: @@
 {{tag>dragonscript behavior}}
 <WRAP youarehere>
-[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[abstractions#behavior_elementsquick_and_easy_development|Behavior Elements: Quick and Easy Development]] >> **ECBehaviorInteractionSpot**
+[[: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]] >> **ECBehaviorInteractionSpot**
 </WRAP>
@@ Line 8: / Line 8: @@
 ====== ECBehaviorInteractionSpot ======
+<WRAP center 100%>
+<WRAP center box 450px>
+{{youtube>BbP-lMrr0tQ?medium}}
+<WRAP centeralign>Behavior in action (starting at timestamp 1:28)</WRAP>
+</WRAP>
+</WRAP>
 Behavior element behavior adding support to define interaction spot for actors.
@@ Line 23: / Line 30: @@
 ====== Element Class Properties ======
-Element class properties have the prefix **interactionSpot.** or **interactionSpot(id)**. if id is not empty.
+Element class properties have the prefix ''interactionSpot.'' or ''interactionSpot(id)''. if id is not empty.
 ===== position =====
 Position relative to owner element the actor or player has to be placed at to interact with the owner element.
   * Full name: “interactionSpot.position” or “interactionSpot(id).position”
-  * Type: 3-component vector. Format used with object properties (string): "x y z"
+  * Type: 3-component vector
-  * Default Value: (0, 0, 0)
+  * Default Value: ''(0, 0, 0)''
   * Example (*.deeclass) <code xml><vector name='interactionSpot.position' x='0' y='-1' z='0.5'/></code>
@@ Line 35: / Line 42: @@
 Orientation in euler angles relative to owner element the actor or player has to be placed at to interact with the owner element.
   * Full name: “interactionSpot.orientation” or “interactionSpot(id).orientation”
-  * Type: 3-component vector. Format used with object properties (string): "x y z"
+  * Type: 3-component vector
-  * Default Value: (0, 0, 0)
+  * Default Value: ''(0, 0, 0)''
   * Example (*.deeclass) <code xml><vector name='interactionSpot.orientation' x='0' y='180' z='0'/></code>
@@ Line 42: / Line 49: @@
 Position to look at while actor or player is approaching the target position. Typically used together with [[behavior_conversationactor|ECBehaviorConversationActor]] to set the Head Look-At playback. Can be null (or empty string with object properties) to not use a look-at.
   * Full name: “interactionSpot.lookAt” or “interactionSpot(id).lookAt”
-  * Type: 3-component vector. Format used with object properties (string): "x y z"
+  * Type: 3-component vector
-  * Default Value: null
+  * Default Value: ''null''
-  * Example (*.deeclass) <code xml><vector name='interactionSpot.position' x='0' y='0.2' z='0.5'/></code>
+  * Example (*.deeclass) <code xml><vector name='interactionSpot.lookAt' x='0' y='0.2' z='0.5'/></code>
+====== Events ======
+===== spotClaimed =====
+Occupier has claimed spot.
+===== spotReleased =====
+Occupier has release spot.
+====== Behavior Tree Actions ======
+This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''interactionSpot'' with ''interactionSpot(id)''.
+===== interactionSpot.release =====
+Release occupied if one interaction spot is not empty.
+This is an example of using this action:
+<code xml>
+<action name='interactionSpot.release'/>
+</code>
+===== interactionSpot.check =====
+Check one or more interaction spot parameters. Action succeeds if all parameter value matches their respective interaction spot parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a interaction spot parameter matches (or not).
+^Parameter^Value^Description^
+|empty|''true'', ''false''|Interaction spot is empty, hence not occupied by an occupier|
+|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='interactionSpot.check'>
+    <parameter name='empty'>true</parameter>
+  </action>
+  <!-- actions here run only if interaction spot is empty, hence not occupied by an occupier -->
+</sequence>
+</code>
+====== Behavior Tree Conditions ======
+This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''interactionSpot'' with ''interactionSpot(id)''.
+===== interactionSpot.check =====
+Check one or more interaction spot parameters. Conditions returns true if all parameter value match their respective interaction spot parameter. This condition is typically used to run an action or sequence of actions as long as interaction spot conditions are true.
+^Parameter^Value^Description^
+|interactionSpot.empty|''true'', ''false''|Interaction spot is empty, hence not occupied by an occupier|
+This is an example of using this condition:
+<code xml>
+<action name='myAction' id='doing something'>
+  <parameter name='interactionSpot.empty'>true</parameter>
+  <condition>interactionSpot.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 ''interactionSpot'' with ''interactionSpot(id)''.
+===== interactionSpot.claimed =====
+Occupier has claimed spot.
+===== interactionSpot.released =====
+Occupier has release spot.
 ====== Required Behaviors ======
 This behavior does not required other behaviors to be present.
 ====== 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 ======
-This behavior does support element class to be persistable (setPersistable). Saves [[behavior_occupier|ECBehaviorOccupier]] if present.
+This behavior does support element class to be persistable (setPersistable).
 ====== API Documentation ======
-[[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorInteractionSpot.html|ECBehaviorStepAside]].
-Since DragonScript Module Version **1.4**
+#@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorInteractionSpot.html,ECBehaviorInteractionSpot~@#.
+Since DragonScript Module Version ''1.4''
 ====== Use Cases ======
   * Ensure actor/player is at a specific position and orientation relative to an interactive element to ensure animation of actor/player and interactive element properly line up.
   * Ensure only one actor/player uses an interactive element at each time.
@@ Line 73: / Line 166: @@
    public func new() super("ExampleElement")
-     // Create component and collider to give element a look and feeling
+      // Create component and collider to give element a look and feeling
-     component = ECBehaviorComponent.new(this)
+      component = ECBehaviorComponent.new(this)
-     collider = ECBehaviorCollider.new(this, component)
+      collider = ECBehaviorCollider.new(this, component)
-     // Create interaction spot in front of the element. Typically actors need
+      // Create interaction spot in front of the element. Typically actors need
-     // to be rotated by 180 degrees to interact with elements since then the
+      // to be rotated by 180 degrees to interact with elements since then the
-     // actor is looking at the front side of the element.
+      // actor is looking at the front side of the element.
-     //
+      //
-     // This behavior is named "use". It is not required to use a name but
+      // This behavior is named "use". It is not required to use a name but
-     // it allows to add multiple interaction spots. This can be because the
+      // it allows to add multiple interaction spots. This can be because the
-     // element has more than one possible interaction or different spots the
+      // element has more than one possible interaction or different spots the
-     // same type of interaction can be used. Think of a bench having 3 seats
+      // same type of interaction can be used. Think of a bench having 3 seats
-     // to sit down. This allows three actors to use the bench but with each
+      // to sit down. This allows three actors to use the bench but with each
-     // seat occupied by only one actor
+      // seat occupied by only one actor
-     interactionSpot = ECBehaviorInteractionSpot.new(this, "use")
+      interactionSpot = ECBehaviorInteractionSpot.new(this, "use")
-     interactionSpot.getPosition().setVector(Vector.new(0, 0, 0.8))
+      interactionSpot.getPosition().setVector(Vector.new(0, 0, 0.8))
-     interactionSpot.getOrientation().setVector(Vector.new(0, 180, 0))
+      interactionSpot.getOrientation().setVector(Vector.new(0, 180, 0))
-     interactionSpot.getLookAt().setVector(Vector.new(0, 1.2, 0.2))
+      interactionSpot.getLookAt().setVector(Vector.new(0, 1.2, 0.2))
    end
 end
 </code>
+====== Behavior Factory ======
+Using element class supporting adding behaviors the behavior can be added like this:
+<code xml>
+<?xml version='1.0' encoding='UTF-8'?>
+<elementClass name='MyClass' class='GenericBehaviorElement'>
+  <behavior type='ECBehaviorComponent'/>
+  <behavior type='ECBehaviorCollider'/>
+  <behavior type='ECBehaviorInteractionSpot'>
+    <!-- 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 -->
+    <vector name='.lookAt' x='0' y='0.2' z='0.5'/>
+  </behavior>
+  <!-- for adding multiple behaviors use unique identifiers -->
+  <behavior type='ECBehaviorInteractionSpot' id='second'/>
+</elementClass>
+</code>
+====== Live Examples ======
+In the [[https://github.com/LordOfDragons/deexamples|ExampleApp]] you can find a complete example of using this behavior:
+  * [[https://github.com/LordOfDragons/deexamples/blob/master/exampleApp/data/scripts/InteractionSpotExampleClass.ds|InteractionSpotExampleClass.ds]]: Element class providing an interaction spot the player can use
+  * [[https://github.com/LordOfDragons/deexamples/blob/master/exampleApp/data/scripts/BehaviorInteractToggle.ds|BehaviorInteractToggle.ds]]: Interaction behavior allowing player to toggle the animated state of an element. This behavior stores the interaction spot the player has to claim.
+  * [[https://github.com/LordOfDragons/deexamples/blob/master/exampleApp/data/scripts/PlayerActorClass.ds|PlayerActorClass.ds]]: Player actor class. Uses occupier behavior to safely do interactions.
+  * [[https://github.com/LordOfDragons/deexamples/blob/master/exampleApp/data/scripts/PlayerActionInteractToggle.ds|PlayerActionInteractToggle.ds]]: Player action interacting with BehaviorInteractToggle. Tries to claim the assigned interaction spot and if successful moves to the spot and uses the element. Once finished releases the interaction spot.

Drag[en]gine Wiki

User Tools

Site Tools

Differences

Page Tools