This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
dragengine:modules:dragonscript:behavior_clearpath [2024/03/14 16:54] – dragonlord | dragengine:modules:dragonscript:behavior_clearpath [2025/03/13 17:09] (current) – dragonlord | ||
---|---|---|---|
Line 1: | Line 1: | ||
{{tag> | {{tag> | ||
<WRAP youarehere> | <WRAP youarehere> | ||
- | [[: | + | [[: |
</ | </ | ||
Line 8: | Line 8: | ||
====== ECBehaviorClearPath ====== | ====== ECBehaviorClearPath ====== | ||
+ | |||
+ | <WRAP center 100%> | ||
+ | <WRAP center box 450px> | ||
+ | {{youtube> | ||
+ | <WRAP centeralign> | ||
+ | </ | ||
+ | </ | ||
Behavior adding support to actors to make other actors get out of the way. | Behavior adding support to actors to make other actors get out of the way. | ||
Line 19: | Line 26: | ||
To use this behavior add it to the element class and make sure to call setShapeSphere() to set up the collision test shapes. The best time to do this is either in BehaviorElement.init() or inside BaseActorAction if you need to change them per action. | To use this behavior add it to the element class and make sure to call setShapeSphere() to set up the collision test shapes. The best time to do this is either in BehaviorElement.init() or inside BaseActorAction if you need to change them per action. | ||
- | **Configurations** | + | //Configurations// |
There are usually two possible configurations used for this behavior. | There are usually two possible configurations used for this behavior. | ||
Line 29: | Line 36: | ||
For most situations the first configuration is the one to choose since it prevents the actor-actor stuck problems while exhibiting the least side effects. The second configuration though can be insteresting to switch to if actors need a clear path for example while running away. For this reason the first configuration is used as default. | For most situations the first configuration is the one to choose since it prevents the actor-actor stuck problems while exhibiting the least side effects. The second configuration though can be insteresting to switch to if actors need a clear path for example while running away. For this reason the first configuration is used as default. | ||
- | <WRAP center 100%> | ||
- | <WRAP center box 450px> | ||
- | {{youtube> | ||
- | <WRAP centeralign> | ||
- | </ | ||
- | </ | ||
====== Instance Counts ====== | ====== Instance Counts ====== | ||
This behavior can be used only once on an element. The behavior always has identifier empty string. | This behavior can be used only once on an element. The behavior always has identifier empty string. | ||
====== Element Class Properties ====== | ====== Element Class Properties ====== | ||
- | Element class properties have the prefix | + | Element class properties have the prefix |
===== enabled ===== | ===== enabled ===== | ||
Determines if the behavior is initially enabled. | Determines if the behavior is initially enabled. | ||
- | * Full name: "clearPath.enabled" | + | * Full name: '' |
* Type: boolean | * Type: boolean | ||
- | * Default Value: true | + | * Default Value: |
* Example (*.deeclass) <code xml>< | * Example (*.deeclass) <code xml>< | ||
===== checkInterval ===== | ===== checkInterval ===== | ||
Check interval in seconds. | Check interval in seconds. | ||
- | * Full name: "clearPath.checkInterval" | + | * Full name: '' |
* Type: floating point | * Type: floating point | ||
- | * Minimum Value: 0 | ||
* Default value: 1 | * Default value: 1 | ||
+ | * Restriction: | ||
* Example (*.deeclass) <code xml>< | * Example (*.deeclass) <code xml>< | ||
Line 60: | Line 61: | ||
* Full name: " | * Full name: " | ||
* Type: floating point | * Type: floating point | ||
- | * Minimum Value: 0 | ||
* Default value: 0.05 | * Default value: 0.05 | ||
+ | * Restriction: | ||
* Example (*.deeclass) <code xml>< | * Example (*.deeclass) <code xml>< | ||
Line 71: | Line 72: | ||
====== Persistency ====== | ====== Persistency ====== | ||
- | This behavior does support element class to be persistable (setPersistable). Saves enabled, check interval, clear path time and the elapsed check interval time. | + | This behavior does support element class to be persistable (setPersistable). |
====== API Documentation ====== | ====== API Documentation ====== | ||
# | # | ||
- | Since DragonScript Module Version | + | Since DragonScript Module Version |
====== Use Cases ====== | ====== Use Cases ====== | ||
Line 94: | Line 95: | ||
| | ||
- | // create required behaviors | ||
| | ||
| | ||
| | ||
| | ||
- | |||
- | // create clear path behavior. the default settings cause the element | ||
- | // to clear path up to a few centimeters ahead. | ||
| | ||
end | end | ||
end | end | ||
</ | </ | ||
+ | |||
+ | ====== Behavior Factory ====== | ||
+ | |||
+ | Using element class supporting adding behaviors the behavior can be added like this: | ||
+ | <code xml> | ||
+ | <?xml version=' | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | | ||
+ | < | ||
+ | <!-- set element properties. omit property prefix if used inside behavior tag --> | ||
+ | <float name=' | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ====== Live Examples ====== | ||
+ | |||
+ | * [[https:// | ||
+ |