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

Behavior element behavior showing message to player if triggered. More...

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

Classes

class  Instance
 Behavior instance. More...
 

Public Member Functions

Console getConsole ()
 Console. More...
 
ECPString getMessage ()
 Message to show. More...
 
ECBehaviorTriggered getTriggered ()
 Trigger to show message. More...
 
TSTriggerTable getTriggerTable ()
 Trigger table or null if not used. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorShowMessage new (BehaviorElementClass eclass)
 Create behavior element class. More...
 
ECBehaviorShowMessage new (BehaviorElementClass eclass, String id)
 Create default composeable behavior. More...
 
ECBehaviorShowMessage new (BehaviorElementClass eclass, TSTriggerTable triggerTable, Console console)
 
ECBehaviorShowMessage new (BehaviorElementClass eclass, TSTriggerTable triggerTable, Console console, String id)
 
ECBehaviorShowMessage new (BehaviorElementClass eclass, TSTriggerTable triggerTable, Console console, String id, String prefix)
 
void setConsole (Console console)
 Set console. More...
 
- 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 ECBehaviorShowMessage getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 

Protected Member Functions

void setTriggerTable (TSTriggerTable triggerTable)
 Set trigger table or null if not used. More...
 
- 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 showing message to player if triggered.

By default message is printed on console. Typically a shout panel is used to show the latest console messages for a short time. Optionally you can also use subtitle instead.

Element class properties have the prefix "showMessage{(id)}.".

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

Member Function Documentation

◆ getBehaviorIn()

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

◆ getConsole()

Console Dragengine.Scenery.ECBehaviorShowMessage.getConsole ( )

Console.

◆ getMessage()

ECPString Dragengine.Scenery.ECBehaviorShowMessage.getMessage ( )

Message to show.

◆ getTriggered()

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorShowMessage.getTriggered ( )

Trigger to show message.

◆ getTriggerTable()

TSTriggerTable Dragengine.Scenery.ECBehaviorShowMessage.getTriggerTable ( )

Trigger table or null if not used.

◆ instance()

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

Get instance in element from owner element class.

◆ new() [1/5]

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

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [2/5]

ECBehaviorShowMessage Dragengine.Scenery.ECBehaviorShowMessage.new ( BehaviorElementClass  eclass,
String  id 
)

Create default composeable behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [3/5]

ECBehaviorShowMessage Dragengine.Scenery.ECBehaviorShowMessage.new ( BehaviorElementClass  eclass,
TSTriggerTable  triggerTable,
Console  console 
)

◆ new() [4/5]

ECBehaviorShowMessage Dragengine.Scenery.ECBehaviorShowMessage.new ( BehaviorElementClass  eclass,
TSTriggerTable  triggerTable,
Console  console,
String  id 
)

◆ new() [5/5]

ECBehaviorShowMessage Dragengine.Scenery.ECBehaviorShowMessage.new ( BehaviorElementClass  eclass,
TSTriggerTable  triggerTable,
Console  console,
String  id,
String  prefix 
)

◆ setConsole()

void Dragengine.Scenery.ECBehaviorShowMessage.setConsole ( Console  console)

Set console.

◆ setTriggerTable()

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

Set trigger table or null if not used.


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