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

Behavior element behavior show/hide element if triggered. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorShowElement:
Dragengine.Scenery.DefaultECBehavior Dragengine.Scenery.ECBehavior Dragengine.Scenery.BehaviorCompatiblePersistency

Classes

class  Instance
 Behavior instance. More...
 

Public Member Functions

ECBehaviorTriggered getTriggered ()
 Trigger to show element. More...
 
TSTriggerTable getTriggerTable ()
 Trigger table or null if not used. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorShowElement new (BehaviorElementClass eclass)
 Create behavior element class. More...
 
ECBehaviorShowElement new (BehaviorElementClass eclass, TSTriggerTable triggerTable)
 
ECBehaviorShowElement new (BehaviorElementClass eclass, TSTriggerTable triggerTable, String prefix)
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void assignInstanceIndex (int instanceIndex)
 Assign instance index. More...
 
void dispose ()
 Dispose of behavior. 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...
 
- Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 

Static Public Member Functions

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

Public Attributes

ECBehaviorTriggered pTriggered
 
TSTriggerTable pTriggerTable
 

Protected Member Functions

void setTriggerTable (TSTriggerTable triggerTable)
 Set trigger table or null if not used. More...
 
- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
DefaultECBehavior new (BehaviorElementClass eclass, String id)
 Create default composeable behavior. More...
 
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 show/hide element if triggered.

Version
1.19

If trigger evaluates to true the element is set visible and touchable others not.

Element class properties have the prefix "showElement.". Behavior can be added only once.

This behavior supports persistable element class (setPersistable).

Member Function Documentation

◆ getBehaviorIn()

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

◆ getTriggered()

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorShowElement.getTriggered ( )

Trigger to show element.

◆ getTriggerTable()

TSTriggerTable Dragengine.Scenery.ECBehaviorShowElement.getTriggerTable ( )

Trigger table or null if not used.

◆ instance()

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

Get instance in element from owner element class.

◆ new() [1/3]

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

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [2/3]

ECBehaviorShowElement Dragengine.Scenery.ECBehaviorShowElement.new ( BehaviorElementClass  eclass,
TSTriggerTable  triggerTable 
)

◆ new() [3/3]

ECBehaviorShowElement Dragengine.Scenery.ECBehaviorShowElement.new ( BehaviorElementClass  eclass,
TSTriggerTable  triggerTable,
String  prefix 
)

◆ setTriggerTable()

void Dragengine.Scenery.ECBehaviorShowElement.setTriggerTable ( TSTriggerTable  triggerTable)
protected

Set trigger table or null if not used.

Member Data Documentation

◆ pTriggered

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorShowElement.pTriggered

◆ pTriggerTable

TSTriggerTable Dragengine.Scenery.ECBehaviorShowElement.pTriggerTable

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