Drag[en]gine Wiki

User Tools

Site Tools

Trace:
dragengine:modules:dragonscript:behavior_hitscan

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_hitscan [2025/03/11 15:57] – dragonlorddragengine:modules:dragonscript:behavior_hitscan [2025/05/04 13:40] (current) – [hitScan.check] 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]] >> **ECBehaviorHitScan**+[[: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]] >> **ECBehaviorHitScan**
 </WRAP> </WRAP>
  
Line 63: Line 63:
   * Example (*.deeclass) <code xml><string name='hitScan.bone'>value</string></code>   * Example (*.deeclass) <code xml><string name='hitScan.bone'>value</string></code>
  
-===== Events =====+====== Events ======
  
 This behavior has no 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 ''hitScan'' with ''hitScan(id)''.
 +
 +===== hitScan.start =====
 +
 +Start hit scans.
 +
 +^Parameter^Value^Description^
 +|type|''circular'', ''cone'', ''rectangular'', ''rectangular.uniform''|<WRAP>Distribution shape of tests.
 +  * ''circular'': Tests are arranged in a circular pattern. Set angle using ''angle''
 +  * ''cone'': Tests are arranged randomly in a small cone cap. Set count using ''count''. Set angle using ''angle''. Useful for example for weapons with multiple projectiles like buck shots
 +  * ''rectangular'': Tests are arranged randomly across a small sphere segment. Set count using ''count''. Set angle using ''angle.horizontal'' and ''angle.vertical''. Useful for example for weapons with rectangular spreads like a duckbill modification
 +  * ''rectangular.uniform'': Tests are arranged uniformly across a small sphere segment. Set count using ''count.horizontal'' and ''count.vertical''. Set angle using ''angle.horizontal'' and ''angle.vertical''. Useful for example for weapons with rectangular spreads like a duckbill modification
 +</WRAP>|
 +|count|integer|Count of collision tests to start|
 +|count.horizontal|integer|Horizontal count of collision tests to start|
 +|count.vertical|integer|Vertical count of collision tests to start|
 +|angle|float|Opening angle in degrees (angle across diameter)|
 +|angle.horizontal|float|Horizontal opening angle in degrees (angle across width)|
 +|angle.vertical|float|Vertical opening angle in degrees (angle across height)|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='hitScan.start'>
 +  <parameter name='type'>cone</parameter>
 +  <parameter name='count'>10</parameter>
 +  <parameter name='angle'>5</parameter>
 +</action>
 +</code>
 +
 +===== hitScan.stop =====
 +
 +Stop hit scans.
 +
 +^Parameter^Value^Description^
 +|clear| |Clear hit results as if no hit has been done|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='hitScan.stop'>
 +  <parameter name='clear'/>
 +</action>
 +</code>
 +
 +===== hitScan.check =====
 +
 +Check one or more hit scan parameters. Action succeeds if all parameter value matches their respective hit scan parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a hit scan parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|running|''true'', ''false''|Hit scans are running|
 +|hits|integer|Count of hits equals integer value|
 +|hits.not|integer|Count of hits does not equal integer value|
 +|hits.less|integer|Count of hits is less than integer value|
 +|hits.greater|integer|Count of hits is greater than integer value|
 +|hits.percentage.less|integer|Percentage of hits is less than value in the range from 0 to 1|
 +|hits.percentage.greater|integer|Percentage of hits is greater than value in the range from 0 to 1|
 +|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='hitScan.check'>
 +    <parameter name='running'>false</parameter>
 +    <parameter name='hits.percentage.greater'>0.5</parameter>
 +  </action>
 +  <!-- actions here run only if hit scans finished and more than 50% hits have been found -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''hitScan'' with ''hitScan(id)''.
 +
 +===== hitScan.check =====
 +
 +Check one or more hit scan parameters. Conditions returns true if all parameter value match their respective hit scan parameter. This condition is typically used to run an action or sequence of actions as long as hit scan conditions are true.
 +
 +^Parameter^Value^Description^
 +|hitScan.running|''true'', ''false''|Hit scans are running|
 +|hitScan.hits|integer|Count of hits equals integer value|
 +|hitScan.hits.not|integer|Count of hits does not equal integer value|
 +|hitScan.hits.less|integer|Count of hits is less than integer value|
 +|hitScan.hits.greater|integer|Count of hits is greater than integer value|
 +|hitScan.hits.percentage.less|integer|Percentage of hits is less than value in the range from 0 to 1|
 +|hitScan.hits.percentage.greater|integer|Percentage of hits is greater than value in the range from 0 to 1|
 +
 +This is an example of using this condition:
 +<code xml>
 +<action name='myAction' id='doing something'>
 +  <parameter name='hitScan.running'>false</parameter>
 +  <parameter name='hitScan.hits.percentage.greater'>0.5</parameter>
 +  <condition>hitScan.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 ''hitScan'' with ''hitScan(id)''.
 +
 +===== hitScan.done =====
 +
 +Hit scan finished and the results can be examine now.
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
  
-This behavior requires these other behaviors: 
   * [[behavior_collider|ECBehaviorCollider]]: Collider to attach tests to.   * [[behavior_collider|ECBehaviorCollider]]: Collider to attach tests to.
  
 ====== Optional Behaviors ====== ====== Optional Behaviors ======
  
-This behavior does support these optional behaviors: 
   * [[behavior_component|ECBehaviorComponent]]: Required if collision test has to originate from bone.   * [[behavior_component|ECBehaviorComponent]]: Required if collision test has to originate from bone.
 +  * [[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 ====== ====== Persistency ======
Line 131: Line 243:
                    are a list of bits to set. -->                    are a list of bits to set. -->
     <string name='collisionFilter'>1:0 1 2</string>     <string name='collisionFilter'>1:0 1 2</string>
 +    
 +    <!-- 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 -->     <!-- set element properties. omit property prefix if used inside behavior tag -->
dragengine/modules/dragonscript/behavior_hitscan.1741708656.txt.gz · Last modified: 2025/03/11 15:57 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