Dragengine.Scenery.ECBehaviorOccupier.Instance Class Reference

Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorOccupier.Instance:

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

Public Attributes
ECComposeBTSM.Instance	pBTSMs
ECBehaviorOccupier	pECBehavior
ElementResolver	pElementResolver
ECBehaviorInteractionSpot.Instance	pInteractionSpot
Array	pListeners
Public Attributes inherited from Dragengine.Scenery.DefaultECBehaviorInstance
BehaviorElement	pElement
int	pInstanceIndex
bool	pRequiresEnterFrame
bool	pRequiresThink

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

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

EInvalidParam	spot is null.
EInvalidParam	Already occupying an interaction spot.
EInvalidParam	spot 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.

Member Data Documentation

pBTSMs

ECComposeBTSM.Instance Dragengine.Scenery.ECBehaviorOccupier.Instance.pBTSMs

pECBehavior

ECBehaviorOccupier Dragengine.Scenery.ECBehaviorOccupier.Instance.pECBehavior

pElementResolver

ElementResolver Dragengine.Scenery.ECBehaviorOccupier.Instance.pElementResolver

pInteractionSpot

ECBehaviorInteractionSpot.Instance Dragengine.Scenery.ECBehaviorOccupier.Instance.pInteractionSpot

pListeners

Array Dragengine.Scenery.ECBehaviorOccupier.Instance.pListeners

---

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

• ECBehaviorOccupier.ds