Drag[en]gine Script Module DragonScript  1.21
Dragengine.Scenery.ECBehaviorInteractionSpot Class Reference

Behavior element behavior adding support to define interaction spot for actors. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorInteractionSpot:
Dragengine.Scenery.DefaultECBehavior Dragengine.Scenery.ECBehavior Dragengine.Scenery.BehaviorCompatiblePersistency

Classes

class  BlockListenerFactory
 Factory creating listeners using block. More...
 
class  DefaultListener
 Default implementation of behavior instance listener. More...
 
class  Instance
 Behavior instance. More...
 
interface  Listener
 Listener for behavior instance events. More...
 
interface  ListenerFactory
 Factory creating listeners. More...
 

Public Member Functions

void addListenerFactory (Block blockFactory)
 Add listener factory using block. More...
 
void addListenerFactory (ListenerFactory factory)
 Add listener factory. More...
 
void createListeners (Instance instance)
 Create listeners from factories adding them to behavior instance. More...
 
void dispose ()
 Dispose of behavior. More...
 
void forEachListenerFactory (Block ablock)
 Visit listener factories with block with argument ListenerFactory. More...
 
ECPVector getLookAt ()
 Look-at position for element to use while approaching. More...
 
ECPVector getOrientation ()
 Interaction orientation. More...
 
ECPVector getPosition ()
 Interaction position. More...
 
ECBehaviorInteractionSpot new (BehaviorElementClass eclass)
 Create behavior element class. More...
 
ECBehaviorInteractionSpot new (BehaviorElementClass eclass, String id)
 Create default composeable behavior. More...
 
ECBehaviorInteractionSpot new (BehaviorElementClass eclass, String id, String prefix)
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void assignInstanceIndex (int instanceIndex)
 Assign instance index. More...
 
String getBehaviorID ()
 Unique identifier of behavior. More...
 
String getID ()
 Identifier. More...
 
int getInstanceIndex ()
 Instance index. More...
 
void loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance)
 Load instance data of another behavior. More...
 
bool supportsBehaviorID (String identifier)
 Behavior supports loading instance data of another behavior. More...
 
- Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 

Static Public Member Functions

static ECBehaviorInteractionSpot getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void setBehaviorID (String identifier)
 Set behavior identifier. More...
 
void useClassNameAsBehaviorID ()
 Set behavior identifier to "<class-name>:<identifier>". More...
 
void useFullyQualifiedClassNameAsBehaviorID ()
 Set behavior identifier to "<fully-qualified-class-name>:<identifier>". More...
 

Detailed Description

Behavior element behavior adding support to define interaction spot for actors.

Defines position and orientation actors or the player have to assume to properly interact with the owner element. This is typically required to line up animations of the actor and the element. Furthermore this allows to track if an actor is occupying the interaction spot. Hence at most one actor can occpuy an interaction spot at each time.

Optionally a look-at position can be defined. If the occupier is using ECBehaviorConversationActor it can use the look-at position to make actors train their view on a specific point relative to the interaction spot owner element.

Elements able to occpuy an interaction spot have to use the ECBehaviorOccupier behavior. Both the interaction spot and the occupier have to persist the other behavior. During restoring no notifications are triggered this way.

Element class properties have the prefix "interactionSpot{(id)}.".

This behavior uses no other behaviors.

This behavior does require the element class to be persistable (setPersistable).

Member Function Documentation

◆ addListenerFactory() [1/2]

void Dragengine.Scenery.ECBehaviorInteractionSpot.addListenerFactory ( Block  blockFactory)

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

◆ addListenerFactory() [2/2]

void Dragengine.Scenery.ECBehaviorInteractionSpot.addListenerFactory ( ListenerFactory  factory)

Add listener factory.

◆ createListeners()

void Dragengine.Scenery.ECBehaviorInteractionSpot.createListeners ( Instance  instance)

Create listeners from factories adding them to behavior instance.

◆ dispose()

void Dragengine.Scenery.ECBehaviorInteractionSpot.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ forEachListenerFactory()

void Dragengine.Scenery.ECBehaviorInteractionSpot.forEachListenerFactory ( Block  ablock)

Visit listener factories with block with argument ListenerFactory.

◆ getBehaviorIn()

static ECBehaviorInteractionSpot Dragengine.Scenery.ECBehaviorInteractionSpot.getBehaviorIn ( BehaviorElementClass  eclass)
static

Get behavior in element class or null if absent.

Use this method to check if a particular BehaviorElementClass contains a behavior of type ECBehaviorComponent.

◆ getLookAt()

ECPVector Dragengine.Scenery.ECBehaviorInteractionSpot.getLookAt ( )

Look-at position for element to use while approaching.

◆ getOrientation()

ECPVector Dragengine.Scenery.ECBehaviorInteractionSpot.getOrientation ( )

Interaction orientation.

◆ getPosition()

ECPVector Dragengine.Scenery.ECBehaviorInteractionSpot.getPosition ( )

Interaction position.

◆ new() [1/3]

ECBehaviorInteractionSpot Dragengine.Scenery.ECBehaviorInteractionSpot.new ( BehaviorElementClass  eclass)

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [2/3]

ECBehaviorInteractionSpot Dragengine.Scenery.ECBehaviorInteractionSpot.new ( BehaviorElementClass  eclass,
String  id 
)

Create default composeable behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [3/3]

ECBehaviorInteractionSpot Dragengine.Scenery.ECBehaviorInteractionSpot.new ( BehaviorElementClass  eclass,
String  id,
String  prefix 
)

The documentation for this class was generated from the following file: