Dragengine.Scenery.ECBehaviorShowMessage Class Reference

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

Inheritance diagram for Dragengine.Scenery.ECBehaviorShowMessage:

Classes
class	Factory
	Behavior factory. More...
class	Instance
	Behavior instance. More...

Public Member Functions
Console	getConsole ()
	Console.
ECPString	getMessage ()
	Message to show.
ECBehaviorTriggered	getTriggered ()
	Trigger to show message.
TSTriggerTable	getTriggerTable ()
	Trigger table or null if not used.
Instance	instance (BehaviorElement element)
	Get instance in element from owner element class.
ECBehaviorShowMessage	new (BehaviorElementClass eclass)
	Create behavior element class.
ECBehaviorShowMessage	new (BehaviorElementClass eclass, String id)
	Create default composeable behavior.
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.
void	setTriggerTable (TSTriggerTable triggerTable)
	Set trigger table or null if not used.
Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void	assignInstanceIndex (int instanceIndex)
	Assign instance index.
void	dispose ()
	Dispose of behavior.
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 ECBehaviorShowMessage	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent.

Public Attributes
Console	pConsole
ECPString	pMessage
ECBehaviorTriggered	pTriggered
TSTriggerTable	pTriggerTable

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

See also

https://developer.dragondreams.ch/wiki/doku.php/dragengine:modules:dragonscript:behavior_showmessage

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

)

Set trigger table or null if not used.

Member Data Documentation

pConsole

Console Dragengine.Scenery.ECBehaviorShowMessage.pConsole

pMessage

ECPString Dragengine.Scenery.ECBehaviorShowMessage.pMessage

pTriggered

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorShowMessage.pTriggered

pTriggerTable

TSTriggerTable Dragengine.Scenery.ECBehaviorShowMessage.pTriggerTable

---

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

• ECBehaviorShowMessage.ds