This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
dragengine:modules:dragonscript:behavior_occupier [2025/05/02 21:51] – [Optional Behaviors] dragonlord | dragengine:modules:dragonscript:behavior_occupier [2025/06/19 12:44] (current) – [ECBehaviorOccupier] dragonlord | ||
---|---|---|---|
Line 16: | Line 16: | ||
</ | </ | ||
- | Behavior element behavior adding support to uccipy | + | Behavior element behavior adding support to occupy |
- | [[behavior_interactionspot|CBehaviorInteractionSpot]] defines position and orientation actors or the player have to assume to interact properly with this element. The ECBehaviorOccupier behavior provides support to claim such interaction spots. | + | [[behavior_interactionspot|ECBehaviorInteractionSpot]] defines position and orientation actors or the player have to assume to interact properly with this element. The ECBehaviorOccupier behavior provides support to claim such interaction spots. |
====== Instance Counts ====== | ====== Instance Counts ====== | ||
Line 34: | Line 34: | ||
Occupier claimed interaction spot. | Occupier claimed interaction spot. | ||
- | ===== spotReleased | + | ===== spotReleased |
Occupier released interaction spot. | Occupier released interaction spot. | ||
Line 42: | Line 42: | ||
This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace '' | This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace '' | ||
- | ===== occupier.release | + | ===== occupier.update |
- | Release interaction slot if one is occupied. | + | Set one or more occupier parameters. |
+ | |||
+ | ^Parameter^Value^Description^ | ||
+ | |release| |Release interaction slot if one is occupied.| | ||
+ | |interactElement.assign|string|Assign interaction slot element to [[behavior_interactionelement|ECBehaviorInteractionElement]] with identifier matching value string. Action fails if no interaction spot is occupied or interact element behavior is absent| | ||
+ | |claim|string|Claim interaction zone present in the [[behavior_interactionelement|ECBehaviorInteractionElement]] with identifier matching value string| | ||
+ | |claim.id|string|Identifier of interaction spot to claim| | ||
+ | |move| |Move to occupied interaction spot. Uses [[behavior_actormover|ECBehaviorActorMover]] to move to world position defined by interaction spot| | ||
+ | |move.distance|float|Distance in meters to approach interaction spot world position before finish moving| | ||
+ | |align| |Align with occupied interaction spot. Uses [[behavior_alignactor|ECBehaviorAlignActor]] to align actor with world position and orientation defined by interaction spot. If interaction spot defines a look-at position the [[behavior_conversationactor|ECBehaviorConversationActor]] is used to make the actor look at this position while aligning. After aligning the [[behavior_conversationactor|ECBehaviorConversationActor]] keeps the look-at. You have to clear it using action '' | ||
+ | |interact|string|Interact with grab spot. If element is absent action fails. Runs interaction with name value. If interaction with name value is absent fails action. If interaction returns false fails action. Otherwise action succeeds.| | ||
+ | |interact.parameters|string|Optional parameters to use with '' | ||
This is an example of using this action: | This is an example of using this action: | ||
<code xml> | <code xml> | ||
- | <action name=' | + | <action name=' |
+ | < | ||
+ | </action> | ||
</ | </ | ||
Line 57: | Line 70: | ||
^Parameter^Value^Description^ | ^Parameter^Value^Description^ | ||
|occupying|'' | |occupying|'' | ||
+ | |interact.name|string|Name of interaction| | ||
+ | |interact.has|'' | ||
+ | |interact.query|'' | ||
+ | |interact.parameters|string|Optional parameters to use with '' | ||
+ | |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: | This is an example of using this action: | ||
Line 78: | Line 96: | ||
^Parameter^Value^Description^ | ^Parameter^Value^Description^ | ||
|occupier.occupying|'' | |occupier.occupying|'' | ||
+ | |occupier.interact.name|string|Name of interaction| | ||
+ | |occupier.interact.has|'' | ||
+ | |occupier.interact.query|'' | ||
+ | |occupier.interact.parameters|string|Optional parameters to use with '' | ||
This is an example of using this condition: | This is an example of using this condition: | ||
Line 86: | Line 108: | ||
</ | </ | ||
</ | </ | ||
+ | |||
+ | ====== 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 '' | ||
+ | |||
+ | ===== occupier.claimed ===== | ||
+ | |||
+ | Occupier claimed interaction spot. | ||
+ | |||
+ | ===== occupier.released ===== | ||
+ | |||
+ | Occupier released interaction spot. | ||
====== Required Behaviors ====== | ====== Required Behaviors ====== | ||
Line 101: | Line 143: | ||
====== API Documentation ====== | ====== API Documentation ====== | ||
+ | |||
# | # | ||