dragengine:modules:dragonscript:behavior_skinswitcher
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| dragengine:modules:dragonscript:behavior_skinswitcher [2024/03/14 16:51] – dragonlord | dragengine:modules:dragonscript:behavior_skinswitcher [2025/05/11 13:24] (current) – [skinSwitcher.set] dragonlord | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| {{tag> | {{tag> | ||
| <WRAP youarehere> | <WRAP youarehere> | ||
| - | [[: | + | [[: |
| </ | </ | ||
| Line 23: | Line 23: | ||
| ====== Instance Counts ====== | ====== Instance Counts ====== | ||
| - | Multiple instances of **ECBehaviorSkinSwitcher** can be used for example to switch skins of multiple component textures. | + | Multiple instances of '' |
| - | < | + | |
| - | class MyElement extends BehaviorElementClass | + | |
| - | | + | |
| - | | + | |
| - | | + | |
| - | | + | |
| - | | + | |
| - | + | ||
| - | | + | |
| - | component = ECBehaviorComponent.new(this) | + | |
| - | collider = ECBehaviorCollider.new(this, | + | |
| - | animated = ECBehaviorTwoStateAnimated.new(this, | + | |
| - | + | ||
| - | skinSwitcher = ECBehaviorSkinSwitcher.new(this, | + | |
| - | skinSwitcher.getTexture().setValue(" | + | |
| - | skinSwitcher.getSkins().add("/ | + | |
| - | skinSwitcher.getSkins().add("/ | + | |
| - | skinSwitcher.listen(animated) | + | |
| - | + | ||
| - | // Add a second skin switcher affecting a different texture. This example attaches | + | |
| - | // to the same animated | + | |
| - | subSkinSwitcher = ECBehaviorSkinSwitcher.new(this, | + | |
| - | subSkinSwitcher.getTexture().setValue(" | + | |
| - | subSkinSwitcher.getSkins().add("/ | + | |
| - | subSkinSwitcher.getSkins().add("/ | + | |
| - | subSkinSwitcher.listen(animated) | + | |
| - | end | + | |
| - | end | + | |
| - | </ | + | |
| ====== Element Class Properties ====== | ====== Element Class Properties ====== | ||
| - | Element class properties have the prefix | + | Element class properties have the prefix |
| ===== texture ===== | ===== texture ===== | ||
| Name of texture in component to switch skin. If empty string switch skin of component itself. | Name of texture in component to switch skin. If empty string switch skin of component itself. | ||
| - | * Full name: "skinSwitcher.texture" | + | * Full name: '' |
| * Type: string | * Type: string | ||
| - | * Default Value: | + | * Default Value: empty string |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== skins ===== | ===== skins ===== | ||
| - | List of skins (for example *.deskin) | + | List of skins to cycle through. At least one skin is required to be defined for this property to be valid. |
| - | * Full name: "skinSwitcher.skins" | + | * Full name: '' |
| * Type: List of string | * Type: List of string | ||
| * Default value: empty list | * Default value: empty list | ||
| - | * Example (*.deeclass): | + | |
| + | | ||
| < | < | ||
| < | < | ||
| Line 77: | Line 49: | ||
| ===== clamp ===== | ===== clamp ===== | ||
| If the skin index reaches either end of the list it wraps around to the other end (from last to first and vice versa). If clamp is true wrapping around is disabled keeping the index at the last respectively first index. | If the skin index reaches either end of the list it wraps around to the other end (from last to first and vice versa). If clamp is true wrapping around is disabled keeping the index at the last respectively first index. | ||
| - | * Full name: "skinSwitcher.clamp" | + | * Full name: '' |
| * Type: boolean | * Type: boolean | ||
| - | * Default value: false | + | * Default value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| ===== activeSkin ===== | ===== activeSkin ===== | ||
| Index of first skin from //skins// property to show. Index has to be in the range from 0 to // | Index of first skin from //skins// property to show. Index has to be in the range from 0 to // | ||
| - | * Full name: "skinSwitcher.activeSkin" | + | * Full name: '' |
| * Type: integer | * Type: integer | ||
| - | * Default Value: 0 | + | * Default Value: |
| * Example (*.deeclass): | * Example (*.deeclass): | ||
| + | |||
| + | ====== Behavior Tree Actions ====== | ||
| + | |||
| + | This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace '' | ||
| + | |||
| + | ===== skinSwitcher.update ===== | ||
| + | |||
| + | Update skin switcher. | ||
| + | |||
| + | ^Parameter^Value^Description^ | ||
| + | |active|'' | ||
| + | |||
| + | This is an example of using this action: | ||
| + | <code xml> | ||
| + | <action name=' | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ===== 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|'' | ||
| + | |active.not|'' | ||
| + | |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> | ||
| + | < | ||
| + | <action name=' | ||
| + | < | ||
| + | </ | ||
| + | <!-- actions here run only if skin switcher is enabled --> | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ====== Behavior Tree Conditions ====== | ||
| + | |||
| + | This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace '' | ||
| + | |||
| + | ===== 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|'' | ||
| + | |skinSwitcher.active.not|'' | ||
| + | |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=' | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ====== State Machine Actions ====== | ||
| + | |||
| + | Same as [[# | ||
| + | |||
| + | ====== State Machine Conditions ====== | ||
| + | |||
| + | Same as [[# | ||
| + | |||
| + | ====== State Machine Events ====== | ||
| + | |||
| + | This behavior sends these state machine events. If behavior has non-empty identifier replace '' | ||
| + | |||
| + | ===== skinSwitcher.changed ===== | ||
| + | |||
| + | Active skin changed. | ||
| ====== Required Behaviors ====== | ====== Required Behaviors ====== | ||
| + | |||
| * [[behavior_component|ECBehaviorComponent]] | * [[behavior_component|ECBehaviorComponent]] | ||
| ====== Optional Behaviors ====== | ====== Optional Behaviors ====== | ||
| - | This behavior | + | * [[behavior_behaviortree|ECBehaviorBehaviorTree]]: |
| + | * [[behavior_statemachine|ECBehaviorStateMachine]]: | ||
| ====== Persistency ====== | ====== Persistency ====== | ||
| - | This behavior does support element class to be persistable (setPersistable). Saves the active skin index. | + | This behavior does support element class to be persistable (setPersistable). |
| ====== API Documentation ====== | ====== API Documentation ====== | ||
| Line 104: | Line 161: | ||
| # | # | ||
| - | Since DragonScript Module Version | + | Since DragonScript Module Version |
| ====== Use Cases ====== | ====== Use Cases ====== | ||
| Line 152: | Line 209: | ||
| end | end | ||
| </ | </ | ||
| + | |||
| + | ====== Behavior Factory ====== | ||
| + | |||
| + | Using element class supporting adding behaviors the behavior can be added like this: | ||
| + | <code xml> | ||
| + | <?xml version=' | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | | ||
| + | < | ||
| + | <!-- optional: use component with id instead of empty string --> | ||
| + | <string name=' | ||
| + | | ||
| + | <!-- optional: use behavior tree with id instead of empty string --> | ||
| + | <string name=' | ||
| + | | ||
| + | <!-- optional: use state machine with id instead of empty string --> | ||
| + | <string name=' | ||
| + | | ||
| + | <!-- set element properties. omit property prefix if used inside behavior tag --> | ||
| + | <string name=' | ||
| + | </ | ||
| + | | ||
| + | <!-- for adding multiple behaviors use unique identifiers --> | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ====== Live Examples ====== | ||
| + | |||
| + | * [[https:// | ||
| + | |||
dragengine/modules/dragonscript/behavior_skinswitcher.1710435075.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
