User Tools

Site Tools


dragengine:modules:dragonscript:behavior_occupier

ECBehaviorOccupier

Behavior element behavior adding support to uccipy an CBehaviorInteractionSpot.

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 in action (starting at timestamp 1:28)

Instance Counts

Usually an element has one instance of ECBehaviorOccupier but it is possible to use multiple instance for example to track different interacions. Think of a chair the actor can sit down upon. The actor can use one occupier to track sitting on the chair while using another occupier to track interacting with something while being seated.

Element Class Properties

Element class properties have the prefix occupier. or occupier(id). if id is not empty.

This behavior does not define element properties (reserved for future expansion).

Required Behaviors

This behavior does not required other behaviors to be present.

Optional Behaviors

This behavior does not support optional behaviors.

Persistency

This behavior does support element class to be persistable (setPersistable). Saves CBehaviorInteractionSpot if present.

API Documentation

ECBehaviorOccupier.

Since DragonScript Module Version 1.4

Use Cases

  • Ensure actor/player is at a specific position and orientation relative to an interactive element to ensure animation of actor/player and interactive element properly line up.
  • Ensure only one actor/player uses an interactive element at each time.

Element Class Example

class PlayerActor extends BaseActor
   public var ECBehaviorOccupier.Instance occupier
   
   public func new(PlayerActorClass eclass) super(eclass)
      // Store occupier instance. This way you can access it in player
      // actions without needing to look it up.
      occupier = eclass.occupier.instance(this)
   end
end

class PlayerActorClass extends BaseActorClass
   public var ECBehaviorOccupier occupier
   
   public func new() super("PlayerActor")
      // Create occupier. Game code can then use the occupier instance
      // to claim encountered ECBehaviorInteractionSpot instances
      occupier = ECBehaviorOccupier.new(this)
      
      // If you want to track more than one interaction spot you can
      // add multiple occupier instances each with an own ID.
      //occupierSeated = ECBehaviorOccupier.new(this, "seated")
   end
   
   public func Element createElement()
      // Create instance of player actor. If you do not want to store  the
      // occupier instance aside you can drop the createElement() function.
      // The base class then creates an instance of BaseActor
      return PlayerActor.new(this)
   end
end

In the ExampleApp you can find a complete example of using this behavior:

  • InteractionSpotExampleClass.ds: Element class providing an interaction spot the player can use
  • BehaviorInteractToggle.ds: Interaction behavior allowing player to toggle the animated state of an element. This behavior stores the interaction spot the player has to claim.
  • PlayerActorClass.ds: Player actor class. Uses occupier behavior to safely do interactions.
  • PlayerActionInteractToggle.ds: Player action interacting with BehaviorInteractToggle. Tries to claim the assigned interaction spot and if successful moves to the spot and uses the element. Once finished releases the interaction spot.
You could leave a comment if you were logged in.
dragengine/modules/dragonscript/behavior_occupier.txt · Last modified: 2020/11/24 10:01 by dragonlord