Drag[en]gine Wiki

User Tools

Site Tools

Trace:
dragengine:modules:dragonscript:behavior_skinswitcher

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_skinswitcher [2025/03/12 19:34] – dragonlorddragengine:modules:dragonscript:behavior_skinswitcher [2025/05/11 13:24] (current) – [skinSwitcher.set] 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]] >> **ECBehaviorSkinSwitcher**+[[: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]] >> **ECBehaviorSkinSwitcher**
 </WRAP> </WRAP>
  
Line 60: Line 60:
   * Default Value: ''0''   * Default Value: ''0''
   * Example (*.deeclass): <code xml><integer name='skinSwitcher.activeSkin'>1</integer></code>   * Example (*.deeclass): <code xml><integer name='skinSwitcher.activeSkin'>1</integer></code>
 +
 +====== Behavior Tree Actions ======
 +
 +This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''skinSwitcher'' with ''skinSwitcher(id)''.
 +
 +===== skinSwitcher.update =====
 +
 +Update skin switcher.
 +
 +^Parameter^Value^Description^
 +|active|''next'', ''previous'', ''first'', ''last'', integer|Set active skin to next, previous, first, last or index|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='skinSwitcher.update'>
 +  <parameter name='active'>next</parameter>
 +</action>
 +</code>
 +
 +===== skinSwitcher.check =====
 +
 +Check one or more skin switcher parameters. Action succeeds if all parameter value matches their respective skin switcher parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a skin switcher parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|active|''first'', ''last'', integer|Active skin is the first, last or matches index|
 +|active.not|''first'', ''last'', integer|Active skin is not the first, last or matches index|
 +|active.less|integer|Index of active skin is less than value|
 +|active.greater|integer|Index of active skin is greater than value|
 +|count|integer|Skin count matches value|
 +|count.less|integer|Skin count is less than value|
 +|count.greater|integer|Skin count 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>
 +<sequence>
 +  <action name='skinSwitcher.check'>
 +    <parameter name='active'>last</parameter>
 +  </action>
 +  <!-- actions here run only if skin switcher is enabled -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''skinSwitcher'' with ''skinSwitcher(id)''.
 +
 +===== skinSwitcher.check =====
 +
 +Check one or more skin switcher parameters. Conditions returns true if all parameter value match their respective skin switcher parameter. This condition is typically used to run an action or sequence of actions as long as skin switcher conditions are true.
 +
 +^Parameter^Value^Description^
 +|skinSwitcher.active|''first'', ''last'', integer|Active skin is the first, last or matches index|
 +|skinSwitcher.active.not|''first'', ''last'', integer|Active skin is not the first, last or matches index|
 +|skinSwitcher.active.less|integer|Index of active skin is less than value|
 +|skinSwitcher.active.greater|integer|Index of active skin is greater than value|
 +|skinSwitcher.count|integer|Skin count matches value|
 +|skinSwitcher.count.less|integer|Skin count is less than value|
 +|skinSwitcher.count.greater|integer|Skin count is greater than value|
 +
 +This is an example of using this condition:
 +<code xml>
 +<action name='myAction' id='doing something'>
 +  <parameter name='skinSwitcher.active'>last</parameter>
 +  <condition>skinSwitcher.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 ''skinSwitcher'' with ''skinSwitcher(id)''.
 +
 +===== skinSwitcher.changed =====
 +
 +Active skin changed.
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
Line 67: Line 150:
 ====== Optional Behaviors ====== ====== Optional Behaviors ======
  
-This behavior does not support optional behaviors.+  * [[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 139: Line 223:
     <!-- optional: use component with id instead of empty string -->     <!-- optional: use component with id instead of empty string -->
     <string name='component'>second</string>     <string name='component'>second</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_skinswitcher.1741808071.txt.gz · Last modified: 2025/03/12 19:34 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