Drag[en]gine Script Module DragonScript Script API  1.0
LoadDynamicMusic Class Reference

Load dynamic music from a dynmusic.xml file. More...

Inheritance diagram for LoadDynamicMusic:
BaseXmlLoader

Public Member Functions

DynamicMusic loadFromFile (String filename)
 Load dynamic music from file. More...
 
PreloadDynamicMusic loadFromFileAsync (String filename)
 Asynchronously load dynamic music from file. More...
 
LoadDynamicMusic new (Console console)
 Create loader. More...
 
LoadDynamicMusic new (Console console, String name)
 Create loader. More...
 
- Public Member Functions inherited from BaseXmlLoader
Console getConsole ()
 
String getName ()
 
int hexToInt (byte hex)
 
void logDeprecated (EasyXMLElement tag, String whatIsDeprecated)
 
void logDeprecated (EasyXMLElement tag, String whatIsDeprecated, String useWhatInstead)
 
void logDeprecatedTag (EasyXMLElement tag)
 
void logDuplicateObject (EasyXMLElement tag, String object, String identifier)
 Output error message duplicate object on the application console. More...
 
void logIncompatibleAttributes (EasyXMLElement tag, String attributeNames)
 
void logInvalidAttributeValue (EasyXMLElement tag, String attribute, String value)
 
void logInvalidEmptyString (EasyXMLElement tag)
 
void logInvalidValue (EasyXMLElement tag, String value)
 
void logLoadFileFailed (EasyXMLElement tag, String filename)
 
void logLoadingFailed (String filename)
 Log loading file failed with error log. More...
 
void logLoadingFromFile (String filename)
 
void logMissingAttribute (EasyXMLElement tag, String attrName)
 
void logMissingCData (EasyXMLElement tag)
 
void logMissingTag (String tagName)
 
void logNotSupported (EasyXMLElement tag, String whatIsNotSupported)
 
void logObjectExists (EasyXMLElement tag, String object, String value)
 Output error message value exists already on the application console. More...
 
void logParsingFailed (String errorLog)
 
void logUnknownTag (EasyXMLElement tag)
 
BaseXmlLoader new (Console console, String name)
 
void printOnConsole (String message)
 
void printOnConsole (EasyXMLElement tag, String errorMessage)
 
BorderSize readBorderSize (EasyXMLElement root)
 Read border size area. More...
 
String readCData (EasyXMLElement tag)
 
bool readCDataBool (EasyXMLElement tag)
 
float readCDataFloat (EasyXMLElement tag)
 
int readCDataHex (EasyXMLElement tag)
 
int readCDataInt (EasyXMLElement tag)
 
Color readColor (EasyXMLElement root)
 
Color readColor (EasyXMLElement root, Color defaultColor)
 
ColorMatrix readColorMatrix (EasyXMLElement root)
 Read color matrix. More...
 
CurveBezier readCurveBezier (EasyXMLElement root)
 
void readCurveBezierPoint (EasyXMLElement root, CurveBezier curve)
 
DVector readDVector (EasyXMLElement root)
 
FloatRectArea readFloatRectArea (EasyXMLElement root)
 Read floating point rectangular area. More...
 
Font readFont (EasyXMLElement root)
 
Point readPoint (EasyXMLElement root)
 
RectArea readRectArea (EasyXMLElement root)
 Read rectangular area. More...
 
Vector readVector (EasyXMLElement root)
 
Vector2 readVector2 (EasyXMLElement root)
 
Vector2 readVector2UV (EasyXMLElement root)
 

Additional Inherited Members

- Public Attributes inherited from BaseXmlLoader
Console pConsole
 Console to print messages to. More...
 
String pName
 Name of the loader object for error reporting. More...
 

Detailed Description

Load dynamic music from a dynmusic.xml file.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ loadFromFile()

DynamicMusic loadFromFile ( String  filename)

Load dynamic music from file.

§ loadFromFileAsync()

PreloadDynamicMusic loadFromFileAsync ( String  filename)

Asynchronously load dynamic music from file.

Returns
Preloader for loaded dynamic music. Add listener and call checkFinished().

§ new() [1/2]

LoadDynamicMusic new ( Console  console)

Create loader.

§ new() [2/2]

LoadDynamicMusic new ( Console  console,
String  name 
)

Create loader.


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