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

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

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

Public Member Functions

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

Public Attributes

Exception pException
 
bool pHasPreloaded
 
LoadSimpleConversation pLoader
 
String pPath
 
SimpleConversation pSimpleConversation
 

Detailed Description

SimpleConversation element class property for use with XML loading.

Version
1.25

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

Member Function Documentation

◆ copyValue()

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

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

◆ getHasPreloaded()

bool Dragengine.Scenery.ECPSimpleConversation.getHasPreloaded ( )

Property has been preloaded.

◆ getLoader()

LoadSimpleConversation Dragengine.Scenery.ECPSimpleConversation.getLoader ( )

SimpleConversation loader.

◆ getPath()

String Dragengine.Scenery.ECPSimpleConversation.getPath ( )

Path to SimpleConversation.

◆ getSimpleConversation() [1/2]

SimpleConversation Dragengine.Scenery.ECPSimpleConversation.getSimpleConversation ( )

SimpleConversation or null if not present.

◆ getSimpleConversation() [2/2]

SimpleConversation Dragengine.Scenery.ECPSimpleConversation.getSimpleConversation ( StubWithProperties  stub,
ElementClass  eclass 
)

SimpleConversation modified by stub property if present.

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

References Dragengine.Scenery.logPreloadProblems().

◆ logPreloadProblems()

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

Log preloading problems.

Returns
True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ new() [1/2]

ECPSimpleConversation Dragengine.Scenery.ECPSimpleConversation.new ( String  name,
LoadSimpleConversation  loader 
)

Create property.

◆ new() [2/2]

ECPSimpleConversation Dragengine.Scenery.ECPSimpleConversation.new ( String  name,
LoadSimpleConversation  loader,
String  path 
)

Create property with initial path.

◆ preloadResources()

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

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ setPath()

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

Set path to SimpleConversation.

◆ setSimpleConversation()

void Dragengine.Scenery.ECPSimpleConversation.setSimpleConversation ( SimpleConversation  SimpleConversation)

Set SimpleConversation or null if not present.

◆ setValue()

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

Set value of property from XML decoded value.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

Member Data Documentation

◆ pException

Exception Dragengine.Scenery.ECPSimpleConversation.pException

◆ pHasPreloaded

bool Dragengine.Scenery.ECPSimpleConversation.pHasPreloaded

◆ pLoader

LoadSimpleConversation Dragengine.Scenery.ECPSimpleConversation.pLoader

◆ pPath

String Dragengine.Scenery.ECPSimpleConversation.pPath

◆ pSimpleConversation

SimpleConversation Dragengine.Scenery.ECPSimpleConversation.pSimpleConversation

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