User Tools

Site Tools


dragengine:modules:dragonscript:behavior_customcolor

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_customcolor [2025/03/10 20:54] dragonlorddragengine:modules:dragonscript:behavior_customcolor [2025/05/04 13:39] (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]] >> **ECBehaviorCustomColor**+[[: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]] >> **ECBehaviorCustomColor**
 </WRAP> </WRAP>
  
Line 71: Line 71:
   * Example (*.deeclass) <code xml><null name='customColor(body).color'/><!-- force no color set --></code>   * Example (*.deeclass) <code xml><null name='customColor(body).color'/><!-- force no color set --></code>
  
-===== Events =====+====== Events ======
  
 Since this behavior provides no support to apply the chosen color listening is used. Behaviors knowing how to apply the color add a listener and are notified if the color changes. These events can be received: Since this behavior provides no support to apply the chosen color listening is used. Behaviors knowing how to apply the color add a listener and are notified if the color changes. These events can be received:
  
-==== colorChanged ====+===== colorChanged =====
  
 Selected color changed. Use behavior to get the newly set color. Selected color changed. Use behavior to get the newly set color.
 +
 +====== Behavior Tree Actions ======
 +
 +This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''customColor'' with ''customColor(id)''.
 +
 +===== customColor.set =====
 +
 +Set one or more force field parameters.
 +
 +^Parameter^Value^Description^
 +|color|''default'', string|Set color. If value is ''default'' uses default color. Otherwise string value is required to have the form ''red green blue'' where each color component is in the range from 0 to 1|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='customColor.set'>
 +  <parameter name='color'>1 0.5 0.2</parameter>
 +</action>
 +</code>
 +
 +===== customColor.check =====
 +
 +Check one or more force field parameters. Action succeeds if all parameter value matches their respective force field parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a force field parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|color.red.less|float|Red color component is less than float value|
 +|color.red.greater|float|Red color component is greater than float value|
 +|color.green.less|float|Green color component is less than float value|
 +|color.green.greater|float|Green color component is greater than float value|
 +|color.blue.less|float|Blue color component is less than float value|
 +|color.blue.greater|float|Blue color component is greater than float 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>
 +<sequence>
 +  <action name='customColor.check'>
 +    <parameter name='color.red.less'>0.5</parameter>
 +    <parameter name='color.green.less'>0.5</parameter>
 +    <parameter name='color.blue.less'>0.5</parameter>
 +  </action>
 +  <!-- actions here run only if all color components are less than 0.5 -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''customColor'' with ''customColor(id)''.
 +
 +===== customColor.check =====
 +
 +Check one or more force field parameters. Conditions returns true if all parameter value match their respective force field parameter. This condition is typically used to run an action or sequence of actions as long as force field conditions are true.
 +
 +^Parameter^Value^Description^
 +|customColor.color.red.less|float|Red color component is less than float value|
 +|customColor.color.red.greater|float|Red color component is greater than float value|
 +|customColor.color.green.less|float|Green color component is less than float value|
 +|customColor.color.green.greater|float|Green color component is greater than float value|
 +|customColor.color.blue.less|float|Blue color component is less than float value|
 +|customColor.color.blue.greater|float|Blue color component is greater than float value|
 +
 +This is an example of using this condition:
 +<code xml>
 +<action name='myAction' id='doing something'>
 +  <parameter name='customColor.color.red.less'>0.5</parameter>
 +  <parameter name='customColor.color.green.less'>0.5</parameter>
 +  <parameter name='customColor.color.blue.less'>0.5</parameter>
 +  <condition>customColor.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 ''customColor'' with ''customColor(id)''.
 +
 +===== customColor.color =====
 +
 +Color changed.
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
dragengine/modules/dragonscript/behavior_customcolor.1741640078.txt.gz · Last modified: 2025/03/10 20:54 by dragonlord