Load bindings from xml file. More...

Inheritance diagram for Dragengine.LoadSave.LoadBindings:

Public Member Functions
void	loadFromFile (String filename, BindingManager bindingManager, CommandManager commandManager)
	Load binding from file. More...

LoadBindings	new (Console console)
	Create binding loader. More...

LoadBindings	new (Console console, String name)
	Create bindings loader. More...

void	readBindings (EasyXMLElement root, BindingManager bindingManager, CommandManager commandManager)
	Read bindings tag. More...

void	saveToFile (String filename, BindingManager bindingManager)
	Save bindings to file. More...

void	writeBindings (EasyXMLElement root, BindingManager bindingManager)
	Write bindings tag. More...

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)

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	writePoint (EasyXMLElement root, String name, Point point)
	Write point tag. More...

void	writePoint3 (EasyXMLElement root, String name, Point3 point)
	Write point3 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...

Protected Member Functions
void	writeAxisBinding (EasyXMLElement root, Binding binding)
	Write axis binding tag. More...

void	writeButtonBinding (EasyXMLElement root, Binding binding)
	Write button binding tag. More...

Protected Member Functions inherited from Dragengine.LoadSave.BaseXmlLoader
Object	loadAndParseRootTag (String filename, String rootTagName, Block parseBlock)
	Load file safely. More...

Additional Inherited Members
Public Attributes inherited from Dragengine.LoadSave.BaseXmlLoader
Console	pConsole

String	pLogFilename

String	pName

Detailed Description

Load bindings from xml file.

Supports saving bindings.

Member Function Documentation

◆ loadFromFile()

void Dragengine.LoadSave.LoadBindings.loadFromFile	(	String	filename,
		BindingManager	bindingManager,
		CommandManager	commandManager
	)

Load binding from file.

Adds bindings to bindingManager. Existing bindings are replaced. Allows to load multiple binding files replacing previous definitions if required. Clear the binding manager before loading the first file.

Bindings with not found commands are ignored but logged to the console. This avoids failing reading bindings if the game is modified for example by modifications or patches.

In general reading bindings files only throws exceptions if the file is XML incorrect. Invalid tags, attributes or values are only logged but no exceptions thrown.

◆ new() [1/2]

LoadBindings Dragengine.LoadSave.LoadBindings.new ( Console console )

Create binding loader.

◆ new() [2/2]

LoadBindings Dragengine.LoadSave.LoadBindings.new	(	Console	console,
		String	name
	)

Create bindings loader.

Reimplemented from Dragengine.LoadSave.BaseXmlLoader.

◆ readBindings()

void Dragengine.LoadSave.LoadBindings.readBindings	(	EasyXMLElement	root,
		BindingManager	bindingManager,
		CommandManager	commandManager
	)

Read bindings tag.

Can be used by other classes to read a bindings tag from any XML outside bindings XML.

◆ saveToFile()

void Dragengine.LoadSave.LoadBindings.saveToFile	(	String	filename,
		BindingManager	bindingManager
	)

Save bindings to file.

Saves all bindings in bindingManager.

◆ writeAxisBinding()

void Dragengine.LoadSave.LoadBindings.writeAxisBinding	(	EasyXMLElement	root,
		Binding	binding
	)

protected

Write axis binding tag.

◆ writeBindings()

void Dragengine.LoadSave.LoadBindings.writeBindings	(	EasyXMLElement	root,
		BindingManager	bindingManager
	)

Write bindings tag.

Can be used by other classes to write a bindings tag to any XML outside bindings XML.

◆ writeButtonBinding()

void Dragengine.LoadSave.LoadBindings.writeButtonBinding	(	EasyXMLElement	root,
		Binding	binding
	)

protected

Write button binding tag.

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

LoadBindings.ds

Public Member Functions

Protected Member Functions

Additional Inherited Members