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

StateMachine element class property for use with XML loading. More...

Inheritance diagram for Dragengine.Scenery.ECPStateMachine:
Dragengine.Scenery.ElementClassProperty

Public Member Functions

void copyValue (ElementClass elementClass, ElementClassProperty property)
 Copy value from another element class property of the same type. More...
 
bool getHasPreloaded ()
 Property has been preloaded. More...
 
LoadStateMachine getLoader ()
 StateMachine loader. More...
 
String getPath ()
 Path to state machine. More...
 
StateMachine getStateMachine ()
 StateMachine or null if not present. More...
 
StateMachine getStateMachine (StubWithProperties stub, ElementClass eclass)
 StateMachine modified by stub property if present. More...
 
bool logPreloadProblems (ElementClass elementClass, Console console)
 Log preloading problems. More...
 
ECPStateMachine new (String name, LoadStateMachine loader)
 Create property. More...
 
ECPStateMachine new (String name, LoadStateMachine loader, String path)
 Create property with initial path. More...
 
void preloadResources (ElementClass elementClass, PreloadCounter counter)
 Preload resources if supported. More...
 
void setPath (String path)
 Set path to state machine. More...
 
void setStateMachine (StateMachine behaviorTree)
 Set state machine or null if not present. More...
 
void setValue (Object value)
 Set value of property from XML decoded value. More...
 
- Public Member Functions inherited from Dragengine.Scenery.ElementClassProperty
void dispose ()
 Dispose of element class property to break reference loops. More...
 
String getName ()
 Name. More...
 
ElementClassProperty new (String name)
 Create property. More...
 

Detailed Description

StateMachine element class property for use with XML loading.

StateMachine is set from XML using a path. Loads the state machine during preloading. The value of the property is then the loaded resource. If loading fails null state machine is stored.

Member Function Documentation

◆ copyValue()

void Dragengine.Scenery.ECPStateMachine.copyValue ( ElementClass  elementClass,
ElementClassProperty  property 
)

Copy value from another element class property of the same type.

Version
1.17

◆ getHasPreloaded()

bool Dragengine.Scenery.ECPStateMachine.getHasPreloaded ( )

Property has been preloaded.

◆ getLoader()

LoadStateMachine Dragengine.Scenery.ECPStateMachine.getLoader ( )

StateMachine loader.

◆ getPath()

String Dragengine.Scenery.ECPStateMachine.getPath ( )

Path to state machine.

◆ getStateMachine() [1/2]

StateMachine Dragengine.Scenery.ECPStateMachine.getStateMachine ( )

StateMachine or null if not present.

◆ getStateMachine() [2/2]

StateMachine Dragengine.Scenery.ECPStateMachine.getStateMachine ( StubWithProperties  stub,
ElementClass  eclass 
)

StateMachine modified by stub property if present.

If named stub property is not present or empty string the stored state machine is returned. If the named stub property is present it is loaded as state machine resource.

◆ logPreloadProblems()

bool Dragengine.Scenery.ECPStateMachine.logPreloadProblems ( ElementClass  elementClass,
Console  console 
)

Log preloading problems.

Returns
True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ new() [1/2]

ECPStateMachine Dragengine.Scenery.ECPStateMachine.new ( String  name,
LoadStateMachine  loader 
)

Create property.

◆ new() [2/2]

ECPStateMachine Dragengine.Scenery.ECPStateMachine.new ( String  name,
LoadStateMachine  loader,
String  path 
)

Create property with initial path.

◆ preloadResources()

void Dragengine.Scenery.ECPStateMachine.preloadResources ( ElementClass  elementClass,
PreloadCounter  counter 
)

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ setPath()

void Dragengine.Scenery.ECPStateMachine.setPath ( String  path)

Set path to state machine.

◆ setStateMachine()

void Dragengine.Scenery.ECPStateMachine.setStateMachine ( StateMachine  behaviorTree)

Set state machine or null if not present.

◆ setValue()

void Dragengine.Scenery.ECPStateMachine.setValue ( Object  value)

Set value of property from XML decoded value.

Reimplemented from Dragengine.Scenery.ElementClassProperty.


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