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

Behavior instance. More...

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

Public Member Functions

void addListener (Listener listener)
 Add listener. More...
 
void addToInventory (ECBehaviorInventory.Instance inventory)
 Add to inventory. More...
 
void dispose ()
 Dispose of inventory. More...
 
UnicodeString getDescription ()
 Description to display. More...
 
ECBehaviorStashable getECBehavior ()
 Behavior. More...
 
Image getImage ()
 Image to display. More...
 
ECBehaviorInventory.Instance getInventory ()
 Inventory this element is part of or null. More...
 
UnicodeString getName ()
 Name to display. More...
 
Video getVideo ()
 Video to display. More...
 
void init (StubElement stub)
 Initialize element from stub. More...
 
bool isStashed ()
 Element is part of an inventory. More...
 
void moveToInventory (ECBehaviorInventory.Instance inventory)
 Safely moves to a different inventory. More...
 
Instance new (ECBehaviorStashable ecbehavior, BehaviorElement element)
 Create element. More...
 
void removeFromInventory ()
 Remove from inventory if part of one. More...
 
void removeFromInventoryAndDispose ()
 Remove from inventory if part of one and safely disposes of the element. More...
 
void removeListener (Listener listener)
 Remove listener. More...
 
void setInventory (ECBehaviorInventory.Instance inventory)
 Set inventory. 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 enterFrame ()
 Frame update started. 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 readFromFile (PersistencyEnvironment env, FileReader reader)
 Read behavior instance from file. 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.ECBehaviorStashable.Instance.addListener ( Listener  listener)

Add listener.

◆ addToInventory()

void Dragengine.Scenery.ECBehaviorStashable.Instance.addToInventory ( ECBehaviorInventory.Instance  inventory)

Add to inventory.

Exceptions
EInvalidParaminventory is null.
EInvalidParamAlready part of an inventory.

◆ dispose()

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

Dispose of inventory.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ getDescription()

UnicodeString Dragengine.Scenery.ECBehaviorStashable.Instance.getDescription ( )

Description to display.

◆ getECBehavior()

ECBehaviorStashable Dragengine.Scenery.ECBehaviorStashable.Instance.getECBehavior ( )

Behavior.

◆ getImage()

Image Dragengine.Scenery.ECBehaviorStashable.Instance.getImage ( )

Image to display.

◆ getInventory()

ECBehaviorInventory.Instance Dragengine.Scenery.ECBehaviorStashable.Instance.getInventory ( )

Inventory this element is part of or null.

◆ getName()

UnicodeString Dragengine.Scenery.ECBehaviorStashable.Instance.getName ( )

Name to display.

◆ getVideo()

Video Dragengine.Scenery.ECBehaviorStashable.Instance.getVideo ( )

Video to display.

◆ init()

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

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ isStashed()

bool Dragengine.Scenery.ECBehaviorStashable.Instance.isStashed ( )

Element is part of an inventory.

◆ moveToInventory()

void Dragengine.Scenery.ECBehaviorStashable.Instance.moveToInventory ( ECBehaviorInventory.Instance  inventory)

Safely moves to a different inventory.

Convenience method for calling removeFromInventory() then addToInventory() or doing nothing if the inventory is the same.

◆ new()

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

Create element.

◆ removeFromInventory()

void Dragengine.Scenery.ECBehaviorStashable.Instance.removeFromInventory ( )

Remove from inventory if part of one.

◆ removeFromInventoryAndDispose()

void Dragengine.Scenery.ECBehaviorStashable.Instance.removeFromInventoryAndDispose ( )

Remove from inventory if part of one and safely disposes of the element.

◆ removeListener()

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

Remove listener.

◆ setInventory()

void Dragengine.Scenery.ECBehaviorStashable.Instance.setInventory ( ECBehaviorInventory.Instance  inventory)

Set inventory.

Warning
For use by ECBehaviorInventory only.

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