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

Load announcer from a dynmusic.xml file. More...

Inheritance diagram for LoadAnnouncer:

Public Member Functions

LoadSynthesizer getSynthesizerLoader ()
 Synthesizer loader. More...
Announcer loadFromFile (String filename)
 Load announcer from file. More...
PreloadAnnouncer loadFromFileAsync (String filename, PreloadCounter parentCounter)
 Asynchronously load announcer from file. More...
LoadAnnouncer new (Console console)
 Create loader. More...
LoadAnnouncer new (Console console, String name)
 Create loader. More...
void setSynthesizerLoader (LoadSynthesizer loader)
 Set synthesizer 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 logInvalidAttribute (String filename, EasyXMLElement tag, String attribute)
 Log attribute not allowed. More...
void logInvalidAttributeValue (EasyXMLElement tag, String attribute, String value)
void logInvalidEmptyString (EasyXMLElement tag)
void logInvalidValue (EasyXMLElement tag, String value)
void logInvalidValue (String filename, 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 logSavingFromFile (String filename)
 Log filename on the application console. More...
void logUnknownTag (EasyXMLElement tag)
void logUnknownTag (String filename, EasyXMLElement tag)
BaseXmlLoader new (Console console, String name)
void printOnConsole (String message)
void printOnConsole (EasyXMLElement tag, String errorMessage)
void printOnConsole (String filename, String message)
 Print message on console. More...
void printOnConsole (String filename, EasyXMLElement tag, String message)
 Print message on console. More...
BorderSize readBorderSize (EasyXMLElement root)
 Read border size area. More...
String readCData (EasyXMLElement tag)
 Read CData as string. More...
bool readCDataBool (EasyXMLElement tag)
 Read a boolean CData. More...
float readCDataFloat (EasyXMLElement tag)
 Read CData as float. More...
int readCDataHex (EasyXMLElement tag)
int readCDataInt (EasyXMLElement tag)
 Read CData as int. More...
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)
 Parse font tag. More...
Font readFont (EasyXMLElement root, String basePath)
 Parse font tag. More...
Point readPoint (EasyXMLElement root)
RectArea readRectArea (EasyXMLElement root)
 Read rectangular area. More...
Vector readVector (EasyXMLElement root)
Vector2 readVector2 (EasyXMLElement root)
Vector2 readVector2UV (EasyXMLElement root)
Quaternion readVectorAsQuaternion (EasyXMLElement root)
 Read vector tag as quaternion. More...

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 announcer from a dynmusic.xml file.

Before first set the synthesizer loader with setSynthesizerLoader. Otherwise loading announcer fails if a modifier synthesizer tag is encountered.

Roland Pl├╝ss

Member Function Documentation

◆ getSynthesizerLoader()

LoadSynthesizer getSynthesizerLoader ( )

Synthesizer loader.

◆ loadFromFile()

Announcer loadFromFile ( String  filename)

Load announcer from file.

◆ loadFromFileAsync()

PreloadAnnouncer loadFromFileAsync ( String  filename,
PreloadCounter  parentCounter 

Asynchronously load announcer from file.

Preloader for loaded announcer. Add listener and call checkFinished().

◆ new() [1/2]

LoadAnnouncer new ( Console  console)

Create loader.

◆ new() [2/2]

LoadAnnouncer new ( Console  console,
String  name 

Create loader.

◆ setSynthesizerLoader()

void setSynthesizerLoader ( LoadSynthesizer  loader)

Set synthesizer loader.

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