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

Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorOccupier.Instance:
Dragengine.Scenery.DefaultECBehaviorInstance Dragengine.Scenery.ECBehaviorInstance

Public Member Functions

void addListener (Listener listener)
 Add listener. More...
 
void claim (ECBehaviorInteractionSpot.Instance spot)
 Claim interaction spot. More...
 
void claimOther (ECBehaviorInteractionSpot.Instance spot)
 Safely claims a different interaction spot. More...
 
void dispose ()
 Dispose of claim spot. More...
 
void enterFrame ()
 Frame update started. More...
 
ECBehaviorOccupier getECBehavior ()
 Behavior. More...
 
ElementResolver getElementResolver ()
 Element resolver used during loading or null if not set. More...
 
ECBehaviorInteractionSpot.Instance getInteractionSpot ()
 Occupied interaction spot or null. More...
 
void init (StubElement stub)
 Initialize behavior from stub. More...
 
Instance new (ECBehaviorOccupier ecbehavior, BehaviorElement element)
 Create element. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read element from file. More...
 
void release ()
 Release interaction spot if occupying one. More...
 
void removeListener (Listener listener)
 Remove listener. More...
 
void setInteractionSpot (ECBehaviorInteractionSpot.Instance interactionSpot)
 Set occupied interaction spot. More...
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void addToGameWorld ()
 Add element to game world. More...
 
void attachToParent (Element parent)
 Attach element to object set by the mapper in the IGDE World Editor. More...
 
void geometryChanged ()
 Position or orientation changed. More...
 
BehaviorElement getElement ()
 Behavior element to apply behavior to. More...
 
int getInstanceIndex ()
 Behavior instance index. More...
 
DefaultECBehaviorInstance new (BehaviorElement element)
 Create default composeable instance. More...
 
void postThink (float elapsed)
 Post thinking after physics processing is finished. More...
 
void removeFromGameWorld ()
 Remove element from game world. More...
 
bool requiresEnterFrame ()
 Behavior instance requires enterFrame() to be called. More...
 
bool requiresThink ()
 Behavior instance requires think() to be called. More...
 
void stateChanged ()
 State changed (visble, touchable). More...
 
void think (float elapsed)
 Think about what to do for the next frame update. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write behavior instance to file. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void setRequiresEnterFrame (bool required)
 Set if behavior instance requires enterFrame() to be called. More...
 
void setRequiresThink (bool required)
 Set if behavior instance requires think() to be called. More...
 

Detailed Description

Behavior instance.

Member Function Documentation

◆ addListener()

void Dragengine.Scenery.ECBehaviorOccupier.Instance.addListener ( Listener  listener)

Add listener.

◆ claim()

void Dragengine.Scenery.ECBehaviorOccupier.Instance.claim ( ECBehaviorInteractionSpot.Instance  spot)

Claim interaction spot.

Exceptions
EInvalidParamspot is null.
EInvalidParamAlready occupying an interaction spot.
EInvalidParamspot is not empty.

◆ claimOther()

void Dragengine.Scenery.ECBehaviorOccupier.Instance.claimOther ( ECBehaviorInteractionSpot.Instance  spot)

Safely claims a different interaction spot.

Convenience method for calling release() then claim() but checking problems before calling release(). This ensures the occupier keeps occupying the old spot in case something is wrong.

Note
If the current interaction spot is the same as the new spot nothing is done.

◆ dispose()

void Dragengine.Scenery.ECBehaviorOccupier.Instance.dispose ( )

Dispose of claim spot.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ enterFrame()

void Dragengine.Scenery.ECBehaviorOccupier.Instance.enterFrame ( )

Frame update started.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ getECBehavior()

ECBehaviorOccupier Dragengine.Scenery.ECBehaviorOccupier.Instance.getECBehavior ( )

Behavior.

◆ getElementResolver()

ElementResolver Dragengine.Scenery.ECBehaviorOccupier.Instance.getElementResolver ( )

Element resolver used during loading or null if not set.

Version
1.9

◆ getInteractionSpot()

ECBehaviorInteractionSpot.Instance Dragengine.Scenery.ECBehaviorOccupier.Instance.getInteractionSpot ( )

Occupied interaction spot or null.

◆ init()

void Dragengine.Scenery.ECBehaviorOccupier.Instance.init ( StubElement  stub)

Initialize behavior from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ new()

Instance Dragengine.Scenery.ECBehaviorOccupier.Instance.new ( ECBehaviorOccupier  ecbehavior,
BehaviorElement  element 
)

Create element.

◆ readFromFile()

void Dragengine.Scenery.ECBehaviorOccupier.Instance.readFromFile ( PersistencyEnvironment  env,
FileReader  reader 
)

Read element from file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ release()

void Dragengine.Scenery.ECBehaviorOccupier.Instance.release ( )

Release interaction spot if occupying one.

◆ removeListener()

void Dragengine.Scenery.ECBehaviorOccupier.Instance.removeListener ( Listener  listener)

Remove listener.

◆ setInteractionSpot()

void Dragengine.Scenery.ECBehaviorOccupier.Instance.setInteractionSpot ( ECBehaviorInteractionSpot.Instance  interactionSpot)

Set occupied interaction spot.

Warning
For use by ECBehaviorInteractionSpot only.

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