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

Behavior element behavior adding support for elements to be placed in ECBehaviorInventory. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorStashable:
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...
 
ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 
void dispose ()
 Dispose of behavior. More...
 
void forEachListenerFactory (Block ablock)
 Visit listener factories with block with argument ListenerFactory. More...
 
ECPUnicodeString getDescription ()
 Description to display. More...
 
ECPImage getImage ()
 Image to display. More...
 
ECPUnicodeString getName ()
 Name to display. More...
 
ECPVideo getVideo ()
 Video to display. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorStashable new (BehaviorElementClass eclass)
 Create behavior element class. More...
 
ECBehaviorStashable new (BehaviorElementClass eclass, String prefix)
 Create behavior element class. More...
 
- 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...
 

Static Public Member Functions

static ECBehaviorStashable getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 
static Instance getInstanceIn (BehaviorElement element)
 Get instance in element 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 for elements to be placed in ECBehaviorInventory.

Element class properties have the prefix "stashable.".

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

Member Function Documentation

◆ addListenerFactory() [1/2]

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

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

◆ addListenerFactory() [2/2]

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

Add listener factory.

◆ createInstance()

ECBehaviorInstance Dragengine.Scenery.ECBehaviorStashable.createInstance ( BehaviorElement  element)

Create Behavior instance.

Implements Dragengine.Scenery.ECBehavior.

◆ dispose()

void Dragengine.Scenery.ECBehaviorStashable.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ forEachListenerFactory()

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

Visit listener factories with block with argument ListenerFactory.

◆ getBehaviorIn()

static ECBehaviorStashable Dragengine.Scenery.ECBehaviorStashable.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.

◆ getDescription()

ECPUnicodeString Dragengine.Scenery.ECBehaviorStashable.getDescription ( )

Description to display.

◆ getImage()

ECPImage Dragengine.Scenery.ECBehaviorStashable.getImage ( )

Image to display.

◆ getInstanceIn()

static Instance Dragengine.Scenery.ECBehaviorStashable.getInstanceIn ( BehaviorElement  element)
static

Get instance in element or null if absent.

Use this method to check if a particular BehaviorElement contains a behavior instance of type ECBehaviorStashable.Instance . If more than one instance is present returns the first instance.

◆ getName()

ECPUnicodeString Dragengine.Scenery.ECBehaviorStashable.getName ( )

Name to display.

◆ getVideo()

ECPVideo Dragengine.Scenery.ECBehaviorStashable.getVideo ( )

Video to display.

◆ instance()

Instance Dragengine.Scenery.ECBehaviorStashable.instance ( BehaviorElement  element)

Get instance in element from owner element class.

◆ new() [1/2]

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

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [2/2]

ECBehaviorStashable Dragengine.Scenery.ECBehaviorStashable.new ( BehaviorElementClass  eclass,
String  prefix 
)

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.


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