Drag[en]gine Script Module DragonScript 1.32.1
Loading...
Searching...
No Matches
Dragengine.Scenery.ECBehaviorShowMessage.Factory Class Reference

Behavior factory. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorShowMessage.Factory:
Dragengine.Scenery.DefaultBehaviorFactory Dragengine.Scenery.BehaviorFactory

Public Member Functions

ECBehavior addBehavior (BehaviorElementClass eclass, String id, Dictionary parameters)
 Add behavior to element class.
 
Console getConsoleFor (String value)
 Console matching value.
 
Factory new ()
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultBehaviorFactory
void assertIdEmpty (String id)
 Assert id is empty string.
 
String factoryId ()
 Unique identifier of factory.
 
BindingManager getBindingManagerFor (String value)
 Binding manager matching value.
 
CommandManager getCommandManagerFor (String value)
 Command manager matching value.
 
BehaviorFactoryHelper getHelper ()
 Helper to use.
 
ECBehaviorPlayerControllable.Tracker getPlayerControllableActorFor (String value)
 Player controllable actor matching value.
 
ECBehaviorPlayerControllable.Tracker getPlayerControlledActorFor (String value)
 Trigger table matching value.
 
SimpleConversationConverter getSimpleConversationConverterFor (String value)
 Simple conversation converter matching value.
 
ConversationPlaybackSubTitle getSubTitleFor (String value)
 Conversation playback subtitle matching value.
 
GuiTheme getSubtitleThemeFor (String value)
 Subtitle gui theme matching value.
 
TranslationManager getTranslationManagerFor (String value)
 Translation manager matching value.
 
TSTriggerTable getTriggerTableFor (String value)
 Trigger table matching value.
 
DefaultBehaviorFactory new (String id)
 
void setHelper (BehaviorFactoryHelper helper)
 Set helper to use.
 

Additional Inherited Members

- Public Attributes inherited from Dragengine.Scenery.DefaultBehaviorFactory
String pFactoryId
 
BehaviorFactoryHelper pHelper
 

Detailed Description

Behavior factory.

Version
1.25

Example XML element class:

<behavior type='ECBehaviorShowMessage'>
<!-- optional: use BaseGameApp trigger table. game can add more supported values. default is 'default' -->
<string name='triggerTable'>default</string>
<!-- optional: identifier of ECBehaviorTriggered to synchronize with or empty
string to not synchronize. default is empty string. -->
<string name='trigger.synchronize'>other</string>
<!-- optional: use BaseGameApp console. game can add more supported values. default is 'default' -->
<string name='console'>default</string>
</behavior>
<!-- for adding multiple behaviors use unique identifiers -->
<behavior type='ECBehaviorShowMessage' id='second'/>

Element class properties added by the behavior can also be set directly inside the tag be removing the property name prefix and starting with a "." (for example ".propertyName").

Member Function Documentation

◆ addBehavior()

ECBehavior Dragengine.Scenery.ECBehaviorShowMessage.Factory.addBehavior ( BehaviorElementClass  eclass,
String  id,
Dictionary  parameters 
)

Add behavior to element class.

Some behaviors support parameters. Parameters are provided as a Dictionary with parameter name as String key and parameter value as Object value. The type and format of value depends on the parameter name. Usually parameters indicate a dependency behavior to use. In this case the parameter name indicates the target behavior slot to assign the behavior to and the value is a String with the identifier of the behavior to assign. The target slot defines what what existing behaviors are matched against this identifier. Value can be also null to assign the null behavior.

Parameters
eclassElement class to add behavior to.
idIdentifier to use. Has to be unique amongst same type behaviors.
parametersParameters as Dictionary with String name and Object value.

Implements Dragengine.Scenery.BehaviorFactory.

◆ getConsoleFor()

Console Dragengine.Scenery.ECBehaviorShowMessage.Factory.getConsoleFor ( String  value)

Console matching value.

Default implementation returns BaseGameApp::getConsole() for value 'default' and null for all other values. Overwrite to accept other values.

◆ new()

Factory Dragengine.Scenery.ECBehaviorShowMessage.Factory.new ( )

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