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

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

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

Public Member Functions

void copyValue (ElementClass elementClass, ElementClassProperty property)
 Copy value from another element class property of the same type. More...
 
Conversation getConversation ()
 Conversation or null if not present. More...
 
Conversation getConversation (StubWithProperties stub, ElementClass eclass)
 Conversation modified by stub property if present. More...
 
bool getHasPreloaded ()
 Property has been preloaded. More...
 
LoadConversation getLoader ()
 Conversation loader. More...
 
String getPath ()
 Path to conversation. More...
 
bool logPreloadProblems (ElementClass elementClass, Console console)
 Log preloading problems. More...
 
ECPConversation new (String name, LoadConversation loader)
 Create property. More...
 
ECPConversation new (String name, LoadConversation loader, String path)
 Create property with initial path. More...
 
void preloadResources (ElementClass elementClass, PreloadCounter counter)
 Preload resources if supported. More...
 
void setConversation (Conversation conversation)
 Set conversation or null if not present. More...
 
void setPath (String path)
 Set path to conversation. 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

Conversation element class property for use with XML loading.

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

Member Function Documentation

◆ copyValue()

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

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

Version
1.17

◆ getConversation() [1/2]

Conversation Dragengine.Scenery.ECPConversation.getConversation ( )

Conversation or null if not present.

◆ getConversation() [2/2]

Conversation Dragengine.Scenery.ECPConversation.getConversation ( StubWithProperties  stub,
ElementClass  eclass 
)

Conversation modified by stub property if present.

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

◆ getHasPreloaded()

bool Dragengine.Scenery.ECPConversation.getHasPreloaded ( )

Property has been preloaded.

◆ getLoader()

LoadConversation Dragengine.Scenery.ECPConversation.getLoader ( )

Conversation loader.

◆ getPath()

String Dragengine.Scenery.ECPConversation.getPath ( )

Path to conversation.

◆ logPreloadProblems()

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

Log preloading problems.

Returns
True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ new() [1/2]

ECPConversation Dragengine.Scenery.ECPConversation.new ( String  name,
LoadConversation  loader 
)

Create property.

◆ new() [2/2]

ECPConversation Dragengine.Scenery.ECPConversation.new ( String  name,
LoadConversation  loader,
String  path 
)

Create property with initial path.

◆ preloadResources()

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

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ setConversation()

void Dragengine.Scenery.ECPConversation.setConversation ( Conversation  conversation)

Set conversation or null if not present.

◆ setPath()

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

Set path to conversation.

◆ setValue()

void Dragengine.Scenery.ECPConversation.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: