Drag[en]gine Script Module DragonScript  1.23
Dragengine.LoadSave.LoadWorld Class Reference

Load world from world XML file. More...

Inheritance diagram for Dragengine.LoadSave.LoadWorld:
Dragengine.LoadSave.BaseXmlLoader

Public Member Functions

ElementClassList getElementClassList ()
 
void loadFromFile (StubGameWorld stubWorld, String filename, bool ignorePersistable)
 Load world file. More...
 
void loadFromFile (StubGameWorld stubWorld, String filename, bool ignorePersistable, bool enableNetworking)
 
LoadWorld new (Console console, LoadHeightTerrain loadHeightTerrainSector)
 Create loader. More...
 
LoadWorld new (Console console, String name, LoadHeightTerrain loadHeightTerrainSector)
 Create loader. More...
 
void setElementClassList (ElementClassList list)
 
- Public Member Functions inherited from Dragengine.LoadSave.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 logSavingFailed (String filename)
 Log saving to file failed with error log. More...
 
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 (EasyXMLElement tag, String errorMessage)
 
void printOnConsole (String filename, EasyXMLElement tag, String message)
 Print message on console. More...
 
void printOnConsole (String filename, String message)
 Print message on console. More...
 
void printOnConsole (String message)
 
BorderSize readBorderSize (EasyXMLElement root)
 Read border size area. More...
 
int readCDataHex (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)
 Parse font tag. More...
 
Font readFont (EasyXMLElement root, String basePath)
 Parse font tag. More...
 
String readMultilineString (EasyXMLElement root)
 Multi-line string or an empty string if absent. More...
 
Point readPoint (EasyXMLElement root)
 
Point3 readPoint3 (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...
 
void writeColor3 (EasyXMLElement root, String name, Color color)
 Write 3-component color tag using rgb attributes. More...
 
void writeColor4 (EasyXMLElement root, String name, Color color)
 Write 4-component color tag using rgba attributes. More...
 
void writeCurveBezier (EasyXMLElement root, String name, CurveBezier curve)
 Write bezier curve tag. More...
 
void writeCurveBezierPoint (EasyXMLElement root, String name, CurveBezier curve, int point)
 Write bezier curve point tag. More...
 
void writeDVector (EasyXMLElement root, String name, DVector vector)
 Write vector tag. More...
 
void writeFloatRectArea (EasyXMLElement root, String name, FloatRectArea rectArea)
 Write floatRectRea tag. More...
 
void writePoint (EasyXMLElement root, String name, Point point)
 Write point tag. More...
 
void writePoint3 (EasyXMLElement root, String name, Point3 point)
 Write point3 tag. More...
 
void writeRectArea (EasyXMLElement root, String name, RectArea rectArea)
 Write rectArea tag. More...
 
void writeVector (EasyXMLElement root, String name, Vector vector)
 Write vector tag. More...
 
void writeVector2 (EasyXMLElement root, String name, Vector2 vector)
 Write vector2 tag. More...
 

Additional Inherited Members

- Public Attributes inherited from Dragengine.LoadSave.BaseXmlLoader
Console pConsole
 
String pLogFilename
 
String pName
 
- Protected Member Functions inherited from Dragengine.LoadSave.BaseXmlLoader
Object loadAndParseRootTag (String filename, bool stripComments, bool cleanCharData, String rootTagName, Block parseBlock)
 Load file safely. More...
 
Object loadAndParseRootTag (String filename, String rootTagName, Block parseBlock)
 Load file safely. More...
 

Detailed Description

Load world from world XML file.

Supports MutableID to generate identifiers for created element stubs. Unique identifiers are required to identify elements loaded from save states or synchronized across networks. Although for simple situations this may not be required using MutableID is mandatory.

Member Function Documentation

◆ getElementClassList()

ElementClassList Dragengine.LoadSave.LoadWorld.getElementClassList ( )

Retrieves the element class manager.

◆ loadFromFile() [1/2]

void Dragengine.LoadSave.LoadWorld.loadFromFile ( StubGameWorld  stubWorld,
String  filename,
bool  ignorePersistable 
)

Load world file.

Unique identifiers for new elements are generated using idGenerator.

◆ loadFromFile() [2/2]

void Dragengine.LoadSave.LoadWorld.loadFromFile ( StubGameWorld  stubWorld,
String  filename,
bool  ignorePersistable,
bool  enableNetworking 
)

◆ new() [1/2]

LoadWorld Dragengine.LoadSave.LoadWorld.new ( Console  console,
LoadHeightTerrain  loadHeightTerrainSector 
)

Create loader.

◆ new() [2/2]

LoadWorld Dragengine.LoadSave.LoadWorld.new ( Console  console,
String  name,
LoadHeightTerrain  loadHeightTerrainSector 
)

Create loader.

◆ setElementClassList()

void Dragengine.LoadSave.LoadWorld.setElementClassList ( ElementClassList  list)

Sets the element class manager.


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