Drag[en]gine Script Module DragonScript 1.32.1
Loading...
Searching...
No Matches
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  Factory
 Behavior factory. 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.
 
void addListenerFactory (ListenerFactory factory)
 Add listener factory.
 
void createListeners (Instance instance)
 Create listeners from factories adding them to behavior instance.
 
void dispose ()
 Dispose of behavior.
 
void forEachListenerFactory (Block ablock)
 Visit listener factories with block with argument ListenerFactory.
 
ECComposeBTSM getBTSMs ()
 Compose behavior trees and state machines.
 
ECPUnicodeString getDescription ()
 Description to display.
 
ECPImage getImage ()
 Image to display.
 
ECPUnicodeString getName ()
 Name to display.
 
String getPrefix ()
 Prefix.
 
ECPVideo getVideo ()
 Video to display.
 
ECBehaviorStashable new (BehaviorElementClass eclass)
 Create behavior element class.
 
ECBehaviorStashable new (BehaviorElementClass eclass, String prefix)
 Create behavior element class.
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void assignInstanceIndex (int instanceIndex)
 Assign instance index.
 
String getBehaviorID ()
 Unique identifier of behavior.
 
String getID ()
 Identifier.
 
int getInstanceIndex ()
 Instance index.
 
void loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance)
 Load instance data of another behavior.
 
bool supportsBehaviorID (String identifier)
 Behavior supports loading instance data of another behavior.
 
- Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance.
 

Static Public Member Functions

static ECBehaviorStashable getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent.
 

Public Attributes

ECComposeBTSM pBTSMs
 
ECPUnicodeString pDescription
 
ECPImage pImage
 
Array pListenerFactories
 
ECPUnicodeString pName
 
String pPrefix
 
ECPVideo pVideo
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void setBehaviorID (String identifier)
 Set behavior identifier.
 
void useClassNameAsBehaviorID ()
 Set behavior identifier to "<class-name>:<identifier>".
 
void useFullyQualifiedClassNameAsBehaviorID ()
 Set behavior identifier to "<fully-qualified-class-name>:<identifier>".
 

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).

See also
https://developer.dragondreams.ch/wiki/doku.php/dragengine:modules:dragonscript:behavior_stashable

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.

◆ createListeners()

void Dragengine.Scenery.ECBehaviorStashable.createListeners ( Instance  instance)

Create listeners from factories adding them to behavior instance.

◆ 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.

◆ getBTSMs()

ECComposeBTSM Dragengine.Scenery.ECBehaviorStashable.getBTSMs ( )

Compose behavior trees and state machines.

Version
1.26

◆ getDescription()

ECPUnicodeString Dragengine.Scenery.ECBehaviorStashable.getDescription ( )

Description to display.

◆ getImage()

ECPImage Dragengine.Scenery.ECBehaviorStashable.getImage ( )

Image to display.

◆ getName()

ECPUnicodeString Dragengine.Scenery.ECBehaviorStashable.getName ( )

Name to display.

◆ getPrefix()

String Dragengine.Scenery.ECBehaviorStashable.getPrefix ( )

Prefix.

Version
1.26

◆ getVideo()

ECPVideo Dragengine.Scenery.ECBehaviorStashable.getVideo ( )

Video to display.

◆ 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.

Member Data Documentation

◆ pBTSMs

ECComposeBTSM Dragengine.Scenery.ECBehaviorStashable.pBTSMs

◆ pDescription

ECPUnicodeString Dragengine.Scenery.ECBehaviorStashable.pDescription

◆ pImage

ECPImage Dragengine.Scenery.ECBehaviorStashable.pImage

◆ pListenerFactories

Array Dragengine.Scenery.ECBehaviorStashable.pListenerFactories

◆ pName

ECPUnicodeString Dragengine.Scenery.ECBehaviorStashable.pName

◆ pPrefix

String Dragengine.Scenery.ECBehaviorStashable.pPrefix

◆ pVideo

ECPVideo Dragengine.Scenery.ECBehaviorStashable.pVideo

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