Drag[en]gine Script Module DragonScript 1.32.1
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Dragengine.LoadSave.LoadBindings Class Reference

Load bindings from xml file. More...

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

Public Member Functions

void loadFromFile (String filename, BindingManager bindingManager, CommandManager commandManager)
 Load binding from file.
 
LoadBindings new (Console console)
 Create binding loader.
 
LoadBindings new (Console console, String name)
 Create bindings loader.
 
void readBindings (EasyXMLElement root, BindingManager bindingManager, CommandManager commandManager)
 Read bindings tag.
 
void saveToFile (String filename, BindingManager bindingManager)
 Save bindings to file.
 
void writeBindings (EasyXMLElement root, BindingManager bindingManager)
 Write bindings tag.
 
- 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)
 
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.
 

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.
 
Object loadAndParseRootTag (String filename, String rootTagName, Block parseBlock)
 Load file safely.
 

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.

◆ 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.

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