Drag[en]gine Wiki

User Tools

Site Tools

Trace:
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 [2020/12/20 23:17] – 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 8: Line 8:
  
 ====== ECBehaviorCustomColor ====== ====== ECBehaviorCustomColor ======
- 
-Behavior element behavior adding custom color support. 
- 
-Custom colors are typically used to allow players to customize the look of their player actor by altering the color of individual body parts. This behavior allows to define custom color slots the player or artist can manipulate. This behavior does not define how custom colors are applied. This is left for other behaviors or game scripts to do. 
- 
-Custom colors compose of a display name and the currently assigned color. This color can be null to use the assigned default color. An optional list of colors can be used to restrict the colors the player can select. If the list is empty the player can choose the color unrestricted. In addition a display description can be added in case the game developer would like to communicate additional information about the custom color. 
  
 <WRAP center 100%> <WRAP center 100%>
 <WRAP center box 450px> <WRAP center box 450px>
-{{youtube>BbP-lMrr0tQ?medium}}+{{youtube>Gte74Jte8A0?medium}}
 <WRAP centeralign>Behavior in action</WRAP> <WRAP centeralign>Behavior in action</WRAP>
 </WRAP> </WRAP>
 </WRAP> </WRAP>
 +
 +Behavior element behavior adding custom color support.
 +
 +Custom colors are typically used to allow players to customize the look of their player actor by altering the color of individual body parts. This behavior allows to define custom color slots the player or artist can manipulate. This behavior does not define how custom colors are applied. This is left for other behaviors or game scripts to do.
 +
 +Custom colors compose of a display name and the currently assigned color. This color can be null to use the assigned default color. An optional list of colors can be used to restrict the colors the player can select. If the list is empty the player can choose the color unrestricted. In addition a display description can be added in case the game developer would like to communicate additional information about the custom color.
  
 ====== Instance Counts ====== ====== Instance Counts ======
Line 43: Line 43:
  
 ===== allowedColors ===== ===== allowedColors =====
-Optional list of allowed colors. If this list is not empty the player is only allowed to select one of the colors from this list. If the list is empty all colors are allowed. Typically this means the UI shows a list or combo box instead of a set of sliders for each color component. In XML Element Class files this is defined as a list-tag containing color-tag entries. In Stub Properties this is encoded in the form "r1,g1,b1 r2,g2,b3 ..." with rX,gX,bX defining the Xth color (you can use also newline instead of spaces).+Optional list of allowed colors. If this list is not empty the player is only allowed to select one of the colors from this list. If the list is empty all colors are allowed. Typically this means the UI shows a list or combo box instead of a set of sliders for each color component. In XML Element Class files this is defined as a list-tag containing color-tag entries. 
   * Full name: "customColor.allowedColors" or "customColor({id}).allowedColors"   * Full name: "customColor.allowedColors" or "customColor({id}).allowedColors"
-  * Type: list of color (3-component)+  * Type: list of color (3-component) or string
   * Default Value: empty list   * Default Value: empty list
   * Example (*.deeclass) <code xml><list name='customColor(body).allowedColors'>   * Example (*.deeclass) <code xml><list name='customColor(body).allowedColors'>
Line 52: Line 53:
   <color r='0' g='0' b='1'/>   <color r='0' g='0' b='1'/>
 </list></code> </list></code>
 +  * Example (*.deeclass) <code xml><string name='customColor(body).allowedColors'>"1 0 0" "0 1 0" "0 0 1"</string></code>
  
 +In stub properties the coding is of the form "color1 color2 ..." where color is encoded as "r g b". Since both uses space to separate tokens colors have to be wrapped in double quotes. This looks like the second example above. For easier reading and editing the first version (list version) is recommended to be used in XML Element Class files. The second form can be used to directly copy/paste stub property strings between XML/stub without needing to change the formatting.
 ===== defaultColor ===== ===== defaultColor =====
 Sets the default color for the custom color. If the user selects no color (null value) then the default color is used. This can also be used to reset the color to the default color. Sets the default color for the custom color. If the user selects no color (null value) then the default color is used. This can also be used to reset the color to the default color.
Line 68: 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 ======
Line 90: Line 178:
 ====== API Documentation ====== ====== API Documentation ======
  
-[[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorCustomColor.html|ECBehaviorCustomcolor]].+#@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorCustomColor.html,ECBehaviorCustomcolor~@#.
  
 Since DragonScript Module Version **1.5** Since DragonScript Module Version **1.5**
Line 110: Line 198:
   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='ECBehaviorCustomColor'>
 +    <!-- 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='ECBehaviorCustomColor' id='second'/>
 +</elementClass>
 </code> </code>
  
dragengine/modules/dragonscript/behavior_customcolor.1608506238.txt.gz · Last modified: 2020/12/20 23:17 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