dragengine:modules:dragonscript:behavior_grabspot
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| dragengine:modules:dragonscript:behavior_grabspot [2022/02/05 19:02] – created dragonlord | dragengine:modules:dragonscript:behavior_grabspot [2025/05/13 14:06] (current) – dragonlord | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| {{tag> | {{tag> | ||
| <WRAP youarehere> | <WRAP youarehere> | ||
| - | [[: | + | [[: |
| </ | </ | ||
| Line 21: | Line 21: | ||
| ====== Element Class Properties ====== | ====== Element Class Properties ====== | ||
| - | Element class properties have the prefix | + | Element class properties have the prefix |
| ===== touchCollider.physicsType ===== | ===== touchCollider.physicsType ===== | ||
| Physics type of touch collider used to detect touching grabbers. | Physics type of touch collider used to detect touching grabbers. | ||
| - | * Full name: "grabSpot.touchCollider.physicsType" | + | * Full name: '' |
| - | * Type: string of values "none", " | + | * Type: enumeration |
| - | * Default Value: | + | * < |
| + | ^Value^Description^ | ||
| + | |'' | ||
| + | |'' | ||
| + | |'' | ||
| + | </ | ||
| + | * Default Value: | ||
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== touchCollider.localGravity ===== | ===== touchCollider.localGravity ===== | ||
| Local gravity of touch collider if not affected by world gravity. | Local gravity of touch collider if not affected by world gravity. | ||
| - | * Full name: "grabber.touchCollider.localGravity" | + | * Full name: '' |
| * Type: 3-component vector | * Type: 3-component vector | ||
| - | * Default Value: (0, 0, 0) | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== touchCollider.weight ===== | ===== touchCollider.weight ===== | ||
| Weight (mass) of touch collider if dynamic. | Weight (mass) of touch collider if dynamic. | ||
| - | * Full name: "grabber.touchCollider.weight" | + | * Full name: '' |
| * Type: float | * Type: float | ||
| - | * Default Value: 1 | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== touchCollider.enabled ===== | ===== touchCollider.enabled ===== | ||
| Initial enabled state of touch collider. | Initial enabled state of touch collider. | ||
| - | * Full name: "grabber.touchCollider.enabled" | + | * Full name: '' |
| * Type: boolean | * Type: boolean | ||
| - | * Default Value: true | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== touchCollider.shape ===== | ===== touchCollider.shape ===== | ||
| Shape of touch collider used to detect grabbers. | Shape of touch collider used to detect grabbers. | ||
| - | * Full name: "grabSpot.touchCollider.shape" | + | * Full name: '' |
| - | * Type: string (shape | + | * Type: string (shape |
| * Default Value: empty string | * Default Value: empty string | ||
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| Line 60: | Line 66: | ||
| ===== touchCollider.rig ===== | ===== touchCollider.rig ===== | ||
| Rig resource to use for touch collider. | Rig resource to use for touch collider. | ||
| - | * Full name: "grabSpot.touchCollider.rig" | + | * Full name: '' |
| - | * Type: string | + | * Type: string |
| + | * File Pattern: '' | ||
| * Default Value: empty path | * Default Value: empty path | ||
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| - | ===== attach.position ===== | + | ===== position ===== |
| Touch collider attach position relative to parent element or bone. | Touch collider attach position relative to parent element or bone. | ||
| - | * Full name: "grabSpot.attach.position" | + | * Full name: '' |
| * Type: 3-component vector | * Type: 3-component vector | ||
| - | * Default Value: (0, 0, 0) | + | * Default Value: |
| - | * Example (*.deeclass): | + | * Example (*.deeclass): |
| - | ===== attach.rotation ===== | + | ===== rotation ===== |
| Touch collider attach orientation in euler degrees relative to parent element or bone. | Touch collider attach orientation in euler degrees relative to parent element or bone. | ||
| - | * Full name: "grabSpot.attach.rotation" | + | * Full name: '' |
| * Type: 3-component vector | * Type: 3-component vector | ||
| - | * Default Value: (0, 0, 0) | + | * Default Value: |
| - | * Example (*.deeclass): | + | * Example (*.deeclass): |
| - | ===== attach.bone ===== | + | ===== bone ===== |
| Name of bone to attach touch collider to or empty string to attach to the parent element. | Name of bone to attach touch collider to or empty string to attach to the parent element. | ||
| - | * Full name: "grabSpot.attach.bone" | + | * Full name: '' |
| * Type: string | * Type: string | ||
| * Default Value: empty string | * Default Value: empty string | ||
| - | * Example (*.deeclass): | + | * Example (*.deeclass): |
| + | |||
| + | ====== Events ====== | ||
| + | |||
| + | ===== spotGrabbed ===== | ||
| + | |||
| + | Grabber has grabbed spot. | ||
| + | |||
| + | ===== spotReleased ===== | ||
| + | |||
| + | Grabber has release spot. | ||
| + | |||
| + | ===== enabledChanged ===== | ||
| + | |||
| + | Grab spot enabled changed. | ||
| + | |||
| + | ====== Behavior Tree Actions ====== | ||
| + | |||
| + | This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace '' | ||
| + | |||
| + | ===== grabSpot.set ===== | ||
| + | |||
| + | Set one or more grab spot parameters. | ||
| + | |||
| + | ^Parameter^Value^Description^ | ||
| + | |enabled|'' | ||
| + | |||
| + | This is an example of using this action: | ||
| + | <code xml> | ||
| + | <action name=' | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ===== grabSpot.update ===== | ||
| + | |||
| + | Update grab spot. | ||
| + | |||
| + | ^Parameter^Value^Description^ | ||
| + | |release| |Release grabber if one is grabbing the grab spot.| | ||
| + | |interactElement.assign|string|Assign grabber element to [[behavior_interactelement|ECBehaviorInteractElement]] with identifier matching value string. Action fails if no element is grabbing or interact element behavior is absent| | ||
| + | |interact|string|Interact with grabber. 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 '' | ||
| + | |||
| + | This is an example of using this action: | ||
| + | <code xml> | ||
| + | <action name=' | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ===== grabSpot.check ===== | ||
| + | |||
| + | Check one or more grab spot parameters. Action succeeds if all parameter value matches their respective grab spot parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a grab spot parameter matches (or not). | ||
| + | |||
| + | ^Parameter^Value^Description^ | ||
| + | |enabled|'' | ||
| + | |grabbed|'' | ||
| + | |interact.name|string|Name of interaction| | ||
| + | |interact.has|'' | ||
| + | |interact.query|'' | ||
| + | |interact.parameters|string|Optional parameters to use with '' | ||
| + | |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> | ||
| + | < | ||
| + | <action name=' | ||
| + | < | ||
| + | </ | ||
| + | <!-- actions here run only if grab spot is grabbed by a grabber --> | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ====== Behavior Tree Conditions ====== | ||
| + | |||
| + | This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace '' | ||
| + | |||
| + | ===== grabSpot.check ===== | ||
| + | |||
| + | Check one or more grab spot parameters. Conditions returns true if all parameter value match their respective grab spot parameter. This condition is typically used to run an action or sequence of actions as long as grab spot conditions are true. | ||
| + | |||
| + | ^Parameter^Value^Description^ | ||
| + | |grabSpot.enabled|'' | ||
| + | |grabSpot.grabbed|'' | ||
| + | |grabSpot.interact.name|string|Name of interaction| | ||
| + | |grabSpot.interact.has|'' | ||
| + | |grabSpot.interact.query|'' | ||
| + | |grabSpot.interact.parameters|string|Optional parameters to use with '' | ||
| + | |||
| + | This is an example of using this condition: | ||
| + | <code xml> | ||
| + | <action name=' | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ====== State Machine Actions ====== | ||
| + | |||
| + | Same as [[# | ||
| + | |||
| + | ====== State Machine Conditions ====== | ||
| + | |||
| + | Same as [[# | ||
| + | |||
| + | ====== State Machine Events ====== | ||
| + | |||
| + | This behavior sends these state machine events. If behavior has non-empty identifier replace '' | ||
| + | |||
| + | ===== grabSpot.enabled ===== | ||
| + | |||
| + | Grab spot has been enabled. | ||
| + | |||
| + | ===== grabSpot.disabled ===== | ||
| + | |||
| + | Grab spot has been disabled. | ||
| + | |||
| + | ===== grabSpot.grabbed ===== | ||
| + | |||
| + | Grabber grabbed grab spot. | ||
| + | |||
| + | ===== grabSpot.released ===== | ||
| + | |||
| + | Grabber released grab spot. | ||
| ====== Required Behaviors ====== | ====== Required Behaviors ====== | ||
| - | This behavior does not required other behaviors to be present. | + | |
| + | This behavior does not required other behaviors to be present. | ||
| ====== Optional Behaviors ====== | ====== Optional Behaviors ====== | ||
| * [[behavior_collider|ECBehaviorCollider]]: | * [[behavior_collider|ECBehaviorCollider]]: | ||
| + | * [[behavior_behaviortree|ECBehaviorBehaviorTree]]: | ||
| + | * [[behavior_statemachine|ECBehaviorStateMachine]]: | ||
| + | |||
| ====== Persistency ====== | ====== Persistency ====== | ||
| - | Saves these parameters: | + | This behavior does support element class to be persistable (setPersistable). |
| - | + | ||
| - | * Enabled | + | |
| - | * [[behavior_grabber|ECBehaviorGrabber]] | + | |
| ====== API Documentation ====== | ====== API Documentation ====== | ||
| - | [[https:// | + | # |
| - | Since DragonScript Module Version | + | Since DragonScript Module Version |
| ====== Use Cases ====== | ====== Use Cases ====== | ||
| + | |||
| * Allow player to grab objects in VR with his hands. | * Allow player to grab objects in VR with his hands. | ||
| * Add different grab spots on an object in VR to alter the interactions the player can do. | * Add different grab spots on an object in VR to alter the interactions the player can do. | ||
| Line 127: | Line 260: | ||
| end | end | ||
| end | end | ||
| + | </ | ||
| + | |||
| + | ====== Behavior Factory ====== | ||
| + | |||
| + | Using element class supporting adding behaviors the behavior can be added like this: | ||
| + | <code xml> | ||
| + | <?xml version=' | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | | ||
| + | < | ||
| + | <!-- optional: set collision filter. default value ' | ||
| + | | ||
| + | | ||
| + | | ||
| + | are a list of bits to set. --> | ||
| + | <string name=' | ||
| + | | ||
| + | <!-- optional: use behavior tree with id instead of empty string --> | ||
| + | <string name=' | ||
| + | | ||
| + | <!-- optional: use state machine with id instead of empty string --> | ||
| + | <string name=' | ||
| + | | ||
| + | <!-- set element properties. omit property prefix if used inside behavior tag --> | ||
| + | <string name=' | ||
| + | </ | ||
| + | | ||
| + | <!-- for adding multiple behaviors use unique identifiers --> | ||
| + | < | ||
| + | </ | ||
| </ | </ | ||
dragengine/modules/dragonscript/behavior_grabspot.1644087751.txt.gz · Last modified: 2022/02/05 19:02 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
