Dragengine.LoadSave.LoadWorld Class Reference

Load world from world XML file. More...

Inheritance diagram for Dragengine.LoadSave.LoadWorld:

Public Member Functions
void	dispose ()
	Dispose of loader.
void	loadFromFile (StubGameWorld stubWorld, String filename, bool ignorePersistable)
	Load world file.
void	loadFromFile (StubGameWorld stubWorld, String filename, bool ignorePersistable, bool enableNetworking)
StubGameWorld	loadSharedFromFile (String filename)
	Load shared world from file.
LoadWorld	new (Console console, LoadHeightTerrain loadHeightTerrainSector)
	Create loader.
LoadWorld	new (Console console, String name, LoadHeightTerrain loadHeightTerrainSector)
	Create loader.
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.
void	logIncompatibleAttributes (EasyXMLElement tag, String attributeNames)
void	logInvalidAttribute (String filename, EasyXMLElement tag, String attribute)
	Log attribute not allowed.
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.
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.
void	logParsingFailed (String errorLog)
void	logSavingFailed (String filename)
	Log saving to file failed with error log.
void	logSavingFromFile (String filename)
	Log filename on the application console.
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.
void	printOnConsole (String filename, String message)
	Print message on console.
void	printOnConsole (String message)
BorderSize	readBorderSize (EasyXMLElement root)
	Read border size area.
int	readCDataHex (EasyXMLElement tag)
Color	readColor (EasyXMLElement root)
Color	readColor (EasyXMLElement root, Color defaultColor)
ColorMatrix	readColorMatrix (EasyXMLElement root)
	Read color matrix.
CurveBezier	readCurveBezier (EasyXMLElement root)
CurveBezier3D	readCurveBezier3D (EasyXMLElement root)
	Read 3D curve tag.
DVector	readDVector (EasyXMLElement root)
FloatRectArea	readFloatRectArea (EasyXMLElement root)
	Read floating point rectangular area.
Font	readFont (EasyXMLElement root)
	Parse font tag.
Font	readFont (EasyXMLElement root, String basePath)
	Parse font tag.
String	readMultilineString (EasyXMLElement root)
	Multi-line string or an empty string if absent.
Point	readPoint (EasyXMLElement root)
Point3	readPoint3 (EasyXMLElement root)
RectArea	readRectArea (EasyXMLElement root)
	Read rectangular area.
Vector	readVector (EasyXMLElement root)
Vector2	readVector2 (EasyXMLElement root)
Vector2	readVector2UV (EasyXMLElement root)
Quaternion	readVectorAsQuaternion (EasyXMLElement root)
	Read vector tag as quaternion.
void	writeBorderSize (EasyXMLElement root, String name, BorderSize size)
	Write borderSize tag.
void	writeBorderSize (EasyXMLElement tag, BorderSize size)
	Write borderSize tag.
void	writeColor3 (EasyXMLElement root, String name, Color color)
	Write 3-component color tag using rgb attributes.
void	writeColor3 (EasyXMLElement tag, Color color)
	Write 3-component color tag using rgb attributes.
void	writeColor4 (EasyXMLElement root, String name, Color color)
	Write 4-component color tag using rgba attributes.
void	writeColor4 (EasyXMLElement tag, Color color)
	Write 4-component color tag using rgba attributes.
void	writeCurveBezier (EasyXMLElement root, String name, CurveBezier curve)
	Write bezier curve tag.
void	writeCurveBezier (EasyXMLElement tag, CurveBezier curve)
	Write bezier curve tag.
void	writeCurveBezier3D (EasyXMLElement root, String name, CurveBezier3D curve)
	Write 3D bezier curve tag.
void	writeCurveBezier3D (EasyXMLElement tag, CurveBezier3D curve)
	Write 3D bezier curve tag.
void	writeCurveBezier3DPoint (EasyXMLElement root, String name, CurveBezier3D curve, int point)
	Write 3D bezier curve point tag.
void	writeCurveBezier3DPoint (EasyXMLElement tag, CurveBezier3D curve, int point)
	Write 3D bezier curve point tag.
void	writeCurveBezierPoint (EasyXMLElement root, String name, CurveBezier curve, int point)
	Write bezier curve point tag.
void	writeCurveBezierPoint (EasyXMLElement tag, CurveBezier curve, int point)
	Write bezier curve point tag.
void	writeDVector (EasyXMLElement root, String name, DVector vector)
	Write vector tag.
void	writeDVector (EasyXMLElement tag, DVector vector)
	Write vector tag.
void	writeFloatRectArea (EasyXMLElement root, String name, FloatRectArea rectArea)
	Write floatRectRea tag.
void	writeFloatRectArea (EasyXMLElement tag, FloatRectArea rectArea)
	Write floatRectRea tag.
void	writePoint (EasyXMLElement root, String name, Point point)
	Write point tag.
void	writePoint (EasyXMLElement tag, Point point)
	Write point tag.
void	writePoint3 (EasyXMLElement root, String name, Point3 point)
	Write point3 tag.
void	writePoint3 (EasyXMLElement tag, Point3 point)
	Write point3 tag.
void	writeRectArea (EasyXMLElement root, String name, RectArea rectArea)
	Write rectArea tag.
void	writeRectArea (EasyXMLElement tag, RectArea rectArea)
	Write rectArea tag.
void	writeVector (EasyXMLElement root, String name, Vector vector)
	Write vector tag.
void	writeVector (EasyXMLElement tag, Vector vector)
	Write vector tag.
void	writeVector2 (EasyXMLElement root, String name, Vector2 vector)
	Write vector2 tag.
void	writeVector2 (EasyXMLElement tag, Vector2 vector)
	Write vector2 tag.

Public Attributes
ElementClassList	pElementClassList
LoadHeightTerrain	pLoadHeightTerrain
Dictionary	pWorlds
Public Attributes inherited from Dragengine.LoadSave.BaseXmlLoader
Console	pConsole
String	pLogFilename
String	pName

Additional Inherited Members
Protected Member Functions inherited from Dragengine.LoadSave.BaseXmlLoader
Object	loadAndParseRootTag (String filename, bool stripComments, bool cleanCharData, String rootTagName, Block parseBlock)
	Load file safely.
Object	loadAndParseRootTag (String filename, String rootTagName, Block parseBlock)
	Load file safely.

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

dispose()

void Dragengine.LoadSave.LoadWorld.dispose

(

)

Dispose of loader.

Version

1.26

loadFromFile() [1/2]

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

Load world file.

loadFromFile() [2/2]

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

loadSharedFromFile()

StubGameWorld Dragengine.LoadSave.LoadWorld.loadSharedFromFile

(

String

filename

)

Load shared world from file.

Version

1.26

Loads the world the first time filename is used and stores the resulting StubGameWorld. For all subsequent calls with the same filename the same stored StubGameWorld is returned. Hence since the returned stub is shared do not modify it. Instead create a new StubGameWorld with a new instance of GameWorld with copies of content if required.

This call includes all world content without filtering.

Stub does not contain a GameWorld instance since stub must not be created directly.

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.

Member Data Documentation

pElementClassList

ElementClassList Dragengine.LoadSave.LoadWorld.pElementClassList

pLoadHeightTerrain

LoadHeightTerrain Dragengine.LoadSave.LoadWorld.pLoadHeightTerrain

pWorlds

Dictionary Dragengine.LoadSave.LoadWorld.pWorlds

---

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

• LoadWorld.ds