dragengine:modules:dragonscript:behavior_vrhandlaserpointer
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| dragengine:modules:dragonscript:behavior_vrhandlaserpointer [2024/03/14 16:51] – dragonlord | dragengine:modules:dragonscript:behavior_vrhandlaserpointer [2025/05/14 10:44] (current) – dragonlord | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| {{tag> | {{tag> | ||
| <WRAP youarehere> | <WRAP youarehere> | ||
| - | [[: | + | [[: |
| </ | </ | ||
| Line 22: | Line 22: | ||
| * blue: Blue color component of beam. | * blue: Blue color component of beam. | ||
| - | Additional named controllers can be added if required. The default particle emitter used is /// | + | Additional named controllers can be added if required. The default particle emitter used is '' |
| * length: Between 0m to 10m. | * length: Between 0m to 10m. | ||
| * intensity: Between 0 to 1. The beam skin uses camera adapted intensity hence 1 represents full bright intensits compared to camera upper intensity. | * intensity: Between 0 to 1. The beam skin uses camera adapted intensity hence 1 represents full bright intensits compared to camera upper intensity. | ||
| Line 37: | Line 37: | ||
| ====== Element Class Properties ====== | ====== Element Class Properties ====== | ||
| - | Element class properties have the prefix | + | Element class properties have the prefix |
| ===== particleEmitter.* ===== | ===== particleEmitter.* ===== | ||
| - | This behavior adds a child [[behavior_particleemitter|ECBehaviorParticleEmitter]] to the element class to show the laser pointer in the game world. The child behavior has the identifier | + | This behavior adds a child [[behavior_particleemitter|ECBehaviorParticleEmitter]] to the element class to show the laser pointer in the game world. The child behavior has the identifier |
| - | Hence to set for example the particle emitter of the right hand use the element class property | + | Hence to set for example the particle emitter of the right hand use the element class property |
| ===== controllerLength ===== | ===== controllerLength ===== | ||
| Name of particle emitter controller to update with laserpointer length or empty string if not used. | Name of particle emitter controller to update with laserpointer length or empty string if not used. | ||
| - | * Full name: "vrHandLaserPointer.controllerLength" | + | * Full name: '' |
| * Type: string | * Type: string | ||
| - | * Default Value: | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== controllerIntensity ===== | ===== controllerIntensity ===== | ||
| Name of particle emitter controller to update with laserpointer intensity or empty string if not used. | Name of particle emitter controller to update with laserpointer intensity or empty string if not used. | ||
| - | * Full name: "vrHandLaserPointer.controllerIntensity" | + | * Full name: '' |
| * Type: string | * Type: string | ||
| - | * Default Value: | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== controllerRed ===== | ===== controllerRed ===== | ||
| Name of particle emitter controller to update with laserpointer red color component or empty string if not used. | Name of particle emitter controller to update with laserpointer red color component or empty string if not used. | ||
| - | * Full name: "vrHandLaserPointer.controllerRed" | + | * Full name: '' |
| * Type: string | * Type: string | ||
| - | * Default Value: | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== controllerGreen ===== | ===== controllerGreen ===== | ||
| Name of particle emitter controller to update with laserpointer green color component or empty string if not used. | Name of particle emitter controller to update with laserpointer green color component or empty string if not used. | ||
| - | * Full name: "vrHandLaserPointer.controllerGreen" | + | * Full name: '' |
| * Type: string | * Type: string | ||
| - | * Default Value: | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== controllerBlue ===== | ===== controllerBlue ===== | ||
| Name of particle emitter controller to update with laserpointer blue color component or empty string if not used. | Name of particle emitter controller to update with laserpointer blue color component or empty string if not used. | ||
| - | * Full name: "vrHandLaserPointer.controllerBlue" | + | * Full name: '' |
| * Type: string | * Type: string | ||
| - | * Default Value: | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== length ===== | ===== length ===== | ||
| Length in meters of laser pointer. | Length in meters of laser pointer. | ||
| - | * Full name: "vrHandLaserPointer.length" | + | * Full name: '' |
| * Type: float | * Type: float | ||
| - | * Restrictions: | + | * Restrictions: |
| - | * Default Value: 10 | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== intensity ===== | ===== intensity ===== | ||
| Intensity of laser pointer. The actual intensity used depends on the particle emitter. Usually particle emitters use camera adapted intensity which maps an intensity of 1 to the camera upper intensity. | Intensity of laser pointer. The actual intensity used depends on the particle emitter. Usually particle emitters use camera adapted intensity which maps an intensity of 1 to the camera upper intensity. | ||
| - | * Full name: "vrHandLaserPointer.intensity" | + | * Full name: '' |
| * Type: float | * Type: float | ||
| - | * Restrictions: | + | * Restrictions: |
| - | * Default Value: 0.4 | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== color ===== | ===== color ===== | ||
| Color of laser pointer. | Color of laser pointer. | ||
| - | * Full name: "vrHandLaserPointer.color" | + | * Full name: '' |
| - | * Type: color | + | * Type: 3-component |
| - | * Default Value: | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| + | |||
| + | ====== Events ====== | ||
| + | |||
| + | 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 '' | ||
| + | |||
| + | ===== vrHandLaserPointer.set ===== | ||
| + | |||
| + | Set one or more VR hand laser pointer parameters. | ||
| + | |||
| + | ^Parameter^Value^Description^ | ||
| + | |length|float|Length of beam in meters| | ||
| + | |intensity|float|Intensity of beam| | ||
| + | |color|color|Color of beam| | ||
| + | |||
| + | This is an example of using this action: | ||
| + | <code xml> | ||
| + | <action name=' | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ===== vrHandLaserPointer.check ===== | ||
| + | |||
| + | Check one or more VR hand laser pointer parameters. Action succeeds if all parameter value matches their respective VR hand laser pointer parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a VR hand laser pointer parameter matches (or not). | ||
| + | |||
| + | ^Parameter^Value^Description^ | ||
| + | |length.less|float|Length of beam is less than value meters| | ||
| + | |length.greater|float|Length of beam is greater than value meters| | ||
| + | |intensity.less|float|Intensity of beam is less than value meters| | ||
| + | |intensity.greater|float|Intensity of beam is greater than value meters| | ||
| + | |color.red.less|float|Red color of beam is less than value| | ||
| + | |color.red.greater|float|Red color of beam is greater than value| | ||
| + | |color.green.less|float|Green color of beam is less than value| | ||
| + | |color.green.greater|float|Green color of beam is greater than value| | ||
| + | |color.blue.less|float|Blue color of beam is less than value| | ||
| + | |color.blue.greater|float|Blue color of beam is greater than value| | ||
| + | |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 intensity of beam is less than 50% --> | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ====== Behavior Tree Conditions ====== | ||
| + | |||
| + | This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace '' | ||
| + | |||
| + | ===== vrHandLaserPointer.check ===== | ||
| + | |||
| + | Check one or more VR hand laser pointer parameters. Conditions returns true if all parameter value match their respective VR hand laser pointer parameter. This condition is typically used to run an action or sequence of actions as long as VR hand laser pointer conditions are true. | ||
| + | |||
| + | ^Parameter^Value^Description^ | ||
| + | |vrHandLaserPointer.length.less|float|Length of beam is less than value meters| | ||
| + | |vrHandLaserPointer.length.greater|float|Length of beam is greater than value meters| | ||
| + | |vrHandLaserPointer.intensity.less|float|Intensity of beam is less than value meters| | ||
| + | |vrHandLaserPointer.intensity.greater|float|Intensity of beam is greater than value meters| | ||
| + | |vrHandLaserPointer.color.red.less|float|Red color of beam is less than value| | ||
| + | |vrHandLaserPointer.color.red.greater|float|Red color of beam is greater than value| | ||
| + | |vrHandLaserPointer.color.green.less|float|Green color of beam is less than value| | ||
| + | |vrHandLaserPointer.color.green.greater|float|Green color of beam is greater than value| | ||
| + | |vrHandLaserPointer.color.blue.less|float|Blue color of beam is less than value| | ||
| + | |vrHandLaserPointer.color.blue.greater|float|Blue color of beam is greater than value| | ||
| + | |||
| + | 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 no state machine events. | ||
| ====== Required Behaviors ====== | ====== Required Behaviors ====== | ||
| Line 108: | Line 199: | ||
| ====== Optional Behaviors ====== | ====== Optional Behaviors ====== | ||
| - | This behavior | + | * [[behavior_behaviortree|ECBehaviorBehaviorTree]]: |
| + | * [[behavior_statemachine|ECBehaviorStateMachine]]: | ||
| ====== Persistency ====== | ====== Persistency ====== | ||
| - | Saves these parameters: | + | This behavior does support element class to be persistable (setPersistable). |
| - | * Length | + | |
| - | * Intensity | + | |
| - | * Color | + | |
| ====== API Documentation ====== | ====== API Documentation ====== | ||
| Line 121: | Line 210: | ||
| # | # | ||
| - | Since DragonScript Module Version | + | Since DragonScript Module Version |
| ====== Use Cases ====== | ====== Use Cases ====== | ||
| Line 173: | Line 262: | ||
| The # | The # | ||
| + | |||
| + | ====== Behavior Factory ====== | ||
| + | |||
| + | Using element class supporting adding behaviors the behavior can be added like this: | ||
| + | <code xml> | ||
| + | <?xml version=' | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | <string name=' | ||
| + | </ | ||
| + | < | ||
| + | <string name=' | ||
| + | | ||
| + | <!-- optional: add behavior trees. default adds all behavior trees. --> | ||
| + | <list name=' | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | | ||
| + | <!-- optional: add state machines. default adds all state machines. --> | ||
| + | <list name=' | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | < | ||
| + | <!-- required: use vr hand point at with id --> | ||
| + | <string name=' | ||
| + | |||
| + | <!-- set element properties. omit property prefix if used inside behavior tag --> | ||
| + | <string name=' | ||
| + | </ | ||
| + | |||
| + | < | ||
| + | <string name=' | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| ====== Live Examples ====== | ====== Live Examples ====== | ||
| * [[https:// | * [[https:// | ||
dragengine/modules/dragonscript/behavior_vrhandlaserpointer.1710435088.txt.gz · Last modified: 2024/03/14 16:51 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
