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

Sound resource element class property for use with XML loading. More...

Inheritance diagram for Dragengine.Scenery.ECPSound:
Dragengine.Scenery.ElementClassProperty Dragengine.ResourceListener

Public Member Functions

void copyValue (ElementClass elementClass, ElementClassProperty property)
 Copy value from another element class property of the same type. More...
 
void failedLoading (String filename, ResourceLoaderType resourceType)
 Resource failed loading. More...
 
void finishedLoading (String path, ResourceLoaderType resourceType, Object resource)
 Resource has finished loading. More...
 
bool getHasPreloaded ()
 Property has been preloaded. More...
 
String getPath ()
 Path to sound resource. More...
 
Sound getSound ()
 Sound resource or null if not present. More...
 
Sound getSound (StubWithProperties stub, ElementClass eclass)
 Sound modified by stub property if present. More...
 
bool logPreloadProblems (ElementClass elementClass, Console console)
 Log preloading problems. More...
 
ECPSound new (String name)
 Create property. More...
 
ECPSound new (String name, 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 sound resource. More...
 
void setSound (Sound sound)
 Set sound resource 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...
 
Notification

Detailed Description

Sound resource element class property for use with XML loading.

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

Member Function Documentation

◆ copyValue()

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

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

Version
1.17

◆ failedLoading()

void Dragengine.Scenery.ECPSound.failedLoading ( String  filename,
ResourceLoaderType  resourceType 
)

Resource failed loading.

Implements Dragengine.ResourceListener.

◆ finishedLoading()

void Dragengine.Scenery.ECPSound.finishedLoading ( String  path,
ResourceLoaderType  resourceType,
Object  resource 
)

Resource has finished loading.

Implements Dragengine.ResourceListener.

◆ getHasPreloaded()

bool Dragengine.Scenery.ECPSound.getHasPreloaded ( )

Property has been preloaded.

◆ getPath()

String Dragengine.Scenery.ECPSound.getPath ( )

Path to sound resource.

◆ getSound() [1/2]

Sound Dragengine.Scenery.ECPSound.getSound ( )

Sound resource or null if not present.

◆ getSound() [2/2]

Sound Dragengine.Scenery.ECPSound.getSound ( StubWithProperties  stub,
ElementClass  eclass 
)

Sound modified by stub property if present.

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

◆ logPreloadProblems()

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

Log preloading problems.

Returns
True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ new() [1/2]

ECPSound Dragengine.Scenery.ECPSound.new ( String  name)

Create property.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ new() [2/2]

ECPSound Dragengine.Scenery.ECPSound.new ( String  name,
String  path 
)

Create property with initial path.

◆ preloadResources()

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

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

◆ setPath()

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

Set path to sound resource.

◆ setSound()

void Dragengine.Scenery.ECPSound.setSound ( Sound  sound)

Set sound resource or null if not present.

◆ setValue()

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