Drag[en]gine Wiki

User Tools

Site Tools

Trace:
dragengine:modules:dragonscript:behavior_grabspot

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_grabspot [2024/03/14 16:54] – dragonlorddragengine:modules:dragonscript:behavior_grabspot [2025/03/13 17:13] (current) – dragonlord
Line 1: Line 1:
 {{tag>dragonscript behavior}} {{tag>dragonscript behavior}}
 <WRAP youarehere> <WRAP youarehere>
-[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[abstractions#behavior_elementsquick_and_easy_development|Behavior Elements: Quick and Easy Development]] >> **ECBehaviorGrabSpot**+[[: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]] >> **ECBehaviorGrabSpot**
 </WRAP> </WRAP>
  
Line 21: Line 21:
 ====== Element Class Properties ====== ====== Element Class Properties ======
  
-Element class properties have the prefix **grabSpot.** or **grabSpot(id)**. if id is not empty.+Element class properties have the prefix ''grabSpot.'' or ''grabSpot(id)''. if id is not empty.
  
 ===== 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" or "grabSpot(id).touchCollider.physicsType" +  * Full name: ''grabSpot.touchCollider.physicsType'' or ''grabSpot(id).touchCollider.physicsType'' 
-  * Type: string of values "none", "kinematic" and "dynamic" +  * Type: enumeration 
-  * Default Value: "kinematic"+  * <WRAP>Allowed Values: 
 +^Value^Description^ 
 +|''none''|Collider is not moving and will not move by collisions.| 
 +|''dynamic''|Collider reacts to impacts using physical simulation.| 
 +|''kinematic''|Game scripts define the collision response.| 
 +</WRAP> 
 +  * Default Value: ''kinematic''
   * Example (*.deeclass): <code xml><string name='grabSpotright).touchCollider.physicsType>kinematic</string></code>   * Example (*.deeclass): <code xml><string name='grabSpotright).touchCollider.physicsType>kinematic</string></code>
  
 ===== 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" or "grabber(id).touchCollider.localGravity"+  * Full name: ''grabber.touchCollider.localGravity'' or ''grabber(id).touchCollider.localGravity''
   * Type: 3-component vector   * Type: 3-component vector
-  * Default Value: (0, 0, 0)+  * Default Value: ''(0, 0, 0)''
   * Example (*.deeclass): <code xml><vector name='grabSpot(right).touchCollider.localGravity' x='0' y='-0.1' z='0'/></code>   * Example (*.deeclass): <code xml><vector name='grabSpot(right).touchCollider.localGravity' x='0' y='-0.1' z='0'/></code>
  
 ===== touchCollider.weight ===== ===== touchCollider.weight =====
 Weight (mass) of touch collider if dynamic. Weight (mass) of touch collider if dynamic.
-  * Full name: "grabber.touchCollider.weight" or "grabber(id).touchCollider.weight"+  * Full name: ''grabber.touchCollider.weight'' or ''grabber(id).touchCollider.weight''
   * Type: float   * Type: float
-  * Default Value: 1+  * Default Value: ''1''
   * Example (*.deeclass): <code xml><float name='grabSpot(right).touchCollider.weight'>0.2</float></code>   * Example (*.deeclass): <code xml><float name='grabSpot(right).touchCollider.weight'>0.2</float></code>
  
 ===== touchCollider.enabled ===== ===== touchCollider.enabled =====
 Initial enabled state of touch collider. Initial enabled state of touch collider.
-  * Full name: "grabber.touchCollider.enabled" or "grabber(id).touchCollider.enabled"+  * Full name: ''grabber.touchCollider.enabled'' or ''grabber(id).touchCollider.enabled''
   * Type: boolean   * Type: boolean
-  * Default Value: true+  * Default Value: ''true''
   * Example (*.deeclass): <code xml><boolean name='grabSpot(right).touchCollider.enabled'>true</float></code>   * Example (*.deeclass): <code xml><boolean name='grabSpot(right).touchCollider.enabled'>true</float></code>
  
 ===== 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" or "grabSpot(id).touchCollider.shape" +  * Full name: ''grabSpot.touchCollider.shape'' or ''grabSpot(id).touchCollider.shape'' 
-  * Type: string (shape list encoding)+  * Type: string (shape format). See "Shape List Encoding" in CodecPropertyString.
   * Default Value: empty string   * Default Value: empty string
   * Example (*.deeclass): <code xml><string name='grabber(right).touchCollider.shape'>box:extends,0.1,0.1,0.1</string></code>   * Example (*.deeclass): <code xml><string name='grabber(right).touchCollider.shape'>box:extends,0.1,0.1,0.1</string></code>
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" or "grabSpot(id).touchCollider.rig" +  * Full name: ''grabSpot.touchCollider.rig'' or ''grabSpot(id).touchCollider.rig'' 
-  * Type: string (rig resource path, for example *.derig)+  * Type: string 
 +  * File Pattern: ''*.derig'' (all rig modules)
   * Default Value: empty path   * Default Value: empty path
   * Example (*.deeclass): <code xml><string name='grabSpot(right).touchCollider.rig'>grab_spot.derig</string></code>   * Example (*.deeclass): <code xml><string name='grabSpot(right).touchCollider.rig'>grab_spot.derig</string></code>
  
-===== 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" or "grabSpot(id).attach.position"+  * Full name: ''grabSpot.position'' or ''grabSpot(id).position''
   * Type: 3-component vector   * Type: 3-component vector
-  * Default Value: (0, 0, 0) +  * Default Value: ''(0, 0, 0)'' 
-  * Example (*.deeclass): <code xml><vector name='grabSpot(right).attach.position' x='0' y='0' z='0.1'/></code>+  * Example (*.deeclass): <code xml><vector name='grabSpot(right).position' x='0' y='0' z='0.1'/></code>
  
-===== 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" or "grabSpot(id).attach.rotation"+  * Full name: ''grabSpot.rotation'' or ''grabSpot(id).rotation''
   * Type: 3-component vector   * Type: 3-component vector
-  * Default Value: (0, 0, 0) +  * Default Value: ''(0, 0, 0)'' 
-  * Example (*.deeclass): <code xml><vector name='grabSpot(right).attach.rotation' x='-45' y='0' z='0'/></code>+  * Example (*.deeclass): <code xml><vector name='grabSpot(right).rotation' x='-45' y='0' z='0'/></code>
  
-===== 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" or "grabSpot(id).attach.bone"+  * Full name: ''grabSpot.bone'' or ''grabSpot(id).bone''
   * Type: string   * Type: string
   * Default Value: empty string   * Default Value: empty string
-  * Example (*.deeclass): <code xml><string name='grabSpot(right).attach.bone'>attach hand.r</string></code>+  * Example (*.deeclass): <code xml><string name='grabSpot(right).bone'>attach hand.r</string></code> 
 + 
 +====== Events ====== 
 + 
 +===== spotGrabbed ===== 
 + 
 +Grabber has grabbed spot. 
 + 
 +===== spotReleased ===== 
 + 
 +Grabber has release spot. 
 + 
 +===== enabledChanged ===== 
 + 
 +Grab spot enabled changed.
  
 ====== 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 ======
Line 95: Line 117:
 ====== Persistency ====== ====== Persistency ======
  
-Saves these parameters: +This behavior does support element class to be persistable (setPersistable).
- +
-  * Enabled +
-  * [[behavior_grabber|ECBehaviorGrabber]]+
  
 ====== API Documentation ====== ====== API Documentation ======
 #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorGrabSpot.html,ECBehaviorGrabSpot~@#. #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorGrabSpot.html,ECBehaviorGrabSpot~@#.
  
-Since DragonScript Module Version **1.9**+Since DragonScript Module Version ''1.9''
  
 ====== 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 147:
    end    end
 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='ECBehaviorGrabSpot'>
 +    <!-- optional: set collision filter. default value '4:1' which means
 +                   category BaseGameApp.CollisionFilterBit.trigger
 +                   filter BaseGameApp.CollisionFilterBit.dynamic.
 +                   format is '', 'category' or 'category:filter' where category and filter
 +                   are a list of bits to set. -->
 +    <string name='collisionFilter'>4:1 2</string>
 +    
 +    <!-- set element properties. omit property prefix if used inside behavior tag -->
 +    <string name='.name'>Color 1</string>
 +  </behavior>
 +  
 +  <!-- for adding multiple behaviors use unique identifiers -->
 +  <behavior type='ECBehaviorGrabSpot' id='second'/>
 +</elementClass>
 </code> </code>
  
dragengine/modules/dragonscript/behavior_grabspot.1710435287.txt.gz · Last modified: 2024/03/14 16:54 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