Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.ECBehaviorGrabSpot.Instance Class Reference

Behavior instance. More...

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

Public Member Functions

void addListener (Listener listener)
 Add listener. More...
 
void addToGameWorld ()
 Element has been added to game world. Start tracking device. More...
 
bool canGrab (ECBehaviorGrabber.Instance grabber)
 Grabber can grab spot. More...
 
void dispose ()
 Dispose of behavior instance. More...
 
void enterFrame ()
 Frame update started. More...
 
ECBehaviorCollider.Instance getCollider ()
 Collider behavior instance or null. More...
 
ECBehaviorGrabSpot getECBehavior ()
 Behavior. More...
 
ElementResolver getElementResolver ()
 Element resolver used during loading or null if not set. More...
 
bool getEnabled ()
 Enable grab spot. More...
 
void grab (ECBehaviorGrabber.Instance grabber)
 Grab spot. More...
 
void init (StubElement stub)
 Initialize element from stub. More...
 
bool isGrabbed ()
 Spot is grabbed. More...
 
bool isGrabbing (BehaviorElement element)
 Element is grabbing spot. More...
 
bool isNotGrabbed ()
 Spot is not grabbed. More...
 
bool isNotGrabbing (BehaviorElement element)
 Element is not grabbing spot. More...
 
Instance new (ECBehaviorGrabSpot ecbehavior, BehaviorElement element)
 Create element. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read element from file. More...
 
void removeFromGameWorld ()
 Element has been removed from game world. Stop tracking device. More...
 
void removeListener (Listener listener)
 Remove listener. More...
 
void setEnabled (bool enabled)
 Enable/disable grab spot. More...
 
void stateChanged ()
 Element state changed like visible. More...
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
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...
 
bool requiresEnterFrame ()
 Behavior instance requires enterFrame() to be called. More...
 
bool requiresThink ()
 Behavior instance requires think() to be called. 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...
 

Protected Member Functions

void attachTouchCollider (StubElement stub, ECBehaviorCollider.Instance collider)
 Attach touch collider to element collider. More...
 
Collider createTouchCollider (StubElement stub)
 Create collider. More...
 
void updateTouchColliderEnabled ()
 Update collider enabled state. More...
 
- 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.ECBehaviorGrabSpot.Instance.addListener ( Listener  listener)

Add listener.

◆ addToGameWorld()

void Dragengine.Scenery.ECBehaviorGrabSpot.Instance.addToGameWorld ( )

Element has been added to game world. Start tracking device.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ attachTouchCollider()

void Dragengine.Scenery.ECBehaviorGrabSpot.Instance.attachTouchCollider ( StubElement  stub,
ECBehaviorCollider.Instance  collider 
)
protected

Attach touch collider to element collider.

Default implementation calls ECComposeAttachResource.attach().

◆ canGrab()

bool Dragengine.Scenery.ECBehaviorGrabSpot.Instance.canGrab ( ECBehaviorGrabber.Instance  grabber)

Grabber can grab spot.

Return values
falseSpot is not grabbed.
falseGrabber is already grabbing another spot.
trueGrabbing is possible

◆ createTouchCollider()

Collider Dragengine.Scenery.ECBehaviorGrabSpot.Instance.createTouchCollider ( StubElement  stub)
protected

Create collider.

◆ dispose()

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

Dispose of behavior instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ enterFrame()

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

Frame update started.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ getCollider()

ECBehaviorCollider.Instance Dragengine.Scenery.ECBehaviorGrabSpot.Instance.getCollider ( )

Collider behavior instance or null.

◆ getECBehavior()

ECBehaviorGrabSpot Dragengine.Scenery.ECBehaviorGrabSpot.Instance.getECBehavior ( )

Behavior.

◆ getElementResolver()

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

Element resolver used during loading or null if not set.

◆ getEnabled()

bool Dragengine.Scenery.ECBehaviorGrabSpot.Instance.getEnabled ( )

Enable grab spot.

◆ grab()

void Dragengine.Scenery.ECBehaviorGrabSpot.Instance.grab ( ECBehaviorGrabber.Instance  grabber)

Grab spot.

Exceptions
EInvalidParamgrabber is null.
EInvalidParamSpot is grabbed.
EInvalidParamgrabber is already grabbing another spot.

◆ init()

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

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ isGrabbed()

bool Dragengine.Scenery.ECBehaviorGrabSpot.Instance.isGrabbed ( )

Spot is grabbed.

◆ isGrabbing()

bool Dragengine.Scenery.ECBehaviorGrabSpot.Instance.isGrabbing ( BehaviorElement  element)

Element is grabbing spot.

◆ isNotGrabbed()

bool Dragengine.Scenery.ECBehaviorGrabSpot.Instance.isNotGrabbed ( )

Spot is not grabbed.

◆ isNotGrabbing()

bool Dragengine.Scenery.ECBehaviorGrabSpot.Instance.isNotGrabbing ( BehaviorElement  element)

Element is not grabbing spot.

◆ new()

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

Create element.

◆ readFromFile()

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

Read element from file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ removeFromGameWorld()

void Dragengine.Scenery.ECBehaviorGrabSpot.Instance.removeFromGameWorld ( )

Element has been removed from game world. Stop tracking device.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ removeListener()

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

Remove listener.

◆ setEnabled()

void Dragengine.Scenery.ECBehaviorGrabSpot.Instance.setEnabled ( bool  enabled)

Enable/disable grab spot.

◆ stateChanged()

void Dragengine.Scenery.ECBehaviorGrabSpot.Instance.stateChanged ( )

Element state changed like visible.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ updateTouchColliderEnabled()

void Dragengine.Scenery.ECBehaviorGrabSpot.Instance.updateTouchColliderEnabled ( )
protected

Update collider enabled state.


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