Debug verify stub element properties against element classes. More...
Public Member Functions | |
| Console | getConsole () |
| Console to use. More... | |
| Dictionary | getDecalProperties () |
| Dictionary of element properties to verify world decal properties against. More... | |
| Array | getIgnoreClassNames () |
| Array of class names to ignore. More... | |
| Array | getIgnoreKeys () |
| Array of property keys to ignore. More... | |
| String | getLogPrefix () |
| Prefix prepended to logs written. More... | |
| Dictionary | getWorldProperties () |
| List of ElementClassProperty to verify world properties against. More... | |
| void | logProblem (String message) |
| Log problem. More... | |
| DebugVerifyStubProperties | new (Console console) |
| Create debug verifier. More... | |
| void | setConsole (Console console) |
| Set console to use. More... | |
| void | setDecalProperties (Dictionary properties) |
| Dictionary of element properties to verify world decal properties against. More... | |
| void | setLogPrefix (String prefix) |
| Set prefix prepended to logs written. More... | |
| void | setWorldProperties (Dictionary properties) |
| Set dictionary of element properties to verify world properties against. More... | |
| bool | verifyDecal (StubWorldDecal stub, Dictionary properties) |
| Verify stub properties against element class properties. More... | |
| bool | verifyElement (StubElement stub) |
| Verify stub properties against element class properties. More... | |
| bool | verifyProperties (StubWithProperties stub, Dictionary properties, String logPrefix) |
| Verify stub properties using list of ElementClassProperty. More... | |
| bool | verifyWorld (StubGameWorld stub) |
| Verify stub properties. More... | |
Public Attributes | |
| Console | pConsole |
| Dictionary | pDecalProperties |
| Array | pIgnoreClassNames |
| Array | pIgnoreKeys |
| String | pLogPrefix |
| Dictionary | pWorldProperties |
Detailed Description
Debug verify stub element properties against element classes.
Prints problems found to Console. Helps finding problems with stub properties not matching element class properties given stub properties use the same name. It is though recommended to use the same name so artists do not have to use two different naming conventions.
This class only verifies StubElement properties against their ElementClass. If you want to check set up the appropriate parameters in the class with instances of ElementClassProperty containing the required information.
Member Function Documentation
◆ getConsole()
| Console Dragengine.Debugging.DebugVerifyStubProperties.getConsole | ( | ) |
Console to use.
◆ getDecalProperties()
| Dictionary Dragengine.Debugging.DebugVerifyStubProperties.getDecalProperties | ( | ) |
Dictionary of element properties to verify world decal properties against.
By default this is null which disables checking decal properties. Dictionary contains ElementClassProperty values with ElementClassProperty.getName() as key.
◆ getIgnoreClassNames()
| Array Dragengine.Debugging.DebugVerifyStubProperties.getIgnoreClassNames | ( | ) |
Array of class names to ignore.
◆ getIgnoreKeys()
| Array Dragengine.Debugging.DebugVerifyStubProperties.getIgnoreKeys | ( | ) |
Array of property keys to ignore.
◆ getLogPrefix()
| String Dragengine.Debugging.DebugVerifyStubProperties.getLogPrefix | ( | ) |
Prefix prepended to logs written.
◆ getWorldProperties()
| Dictionary Dragengine.Debugging.DebugVerifyStubProperties.getWorldProperties | ( | ) |
List of ElementClassProperty to verify world properties against.
By default this is null which disables checking world properties. Dictionary contains ElementClassProperty values with ElementClassProperty.getName() as key.
◆ logProblem()
| void Dragengine.Debugging.DebugVerifyStubProperties.logProblem | ( | String | message | ) |
Log problem.
◆ new()
| DebugVerifyStubProperties Dragengine.Debugging.DebugVerifyStubProperties.new | ( | Console | console | ) |
Create debug verifier.
◆ setConsole()
| void Dragengine.Debugging.DebugVerifyStubProperties.setConsole | ( | Console | console | ) |
Set console to use.
◆ setDecalProperties()
| void Dragengine.Debugging.DebugVerifyStubProperties.setDecalProperties | ( | Dictionary | properties | ) |
Dictionary of element properties to verify world decal properties against.
By default this is null which disables checking decal properties. Dictionary contains ElementClassProperty values with ElementClassProperty.getName() as key.
◆ setLogPrefix()
| void Dragengine.Debugging.DebugVerifyStubProperties.setLogPrefix | ( | String | prefix | ) |
Set prefix prepended to logs written.
◆ setWorldProperties()
| void Dragengine.Debugging.DebugVerifyStubProperties.setWorldProperties | ( | Dictionary | properties | ) |
Set dictionary of element properties to verify world properties against.
By default this is null which disables checking world properties. Dictionary contains ElementClassProperty values with ElementClassProperty.getName() as key.
◆ verifyDecal()
| bool Dragengine.Debugging.DebugVerifyStubProperties.verifyDecal | ( | StubWorldDecal | stub, |
| Dictionary | properties | ||
| ) |
Verify stub properties against element class properties.
- Returns
- true if no problems are found or false if problems are found.
◆ verifyElement()
| bool Dragengine.Debugging.DebugVerifyStubProperties.verifyElement | ( | StubElement | stub | ) |
Verify stub properties against element class properties.
- Returns
- true if no problems are found or false if problems are found.
◆ verifyProperties()
| bool Dragengine.Debugging.DebugVerifyStubProperties.verifyProperties | ( | StubWithProperties | stub, |
| Dictionary | properties, | ||
| String | logPrefix | ||
| ) |
Verify stub properties using list of ElementClassProperty.
- Returns
- true if no problems are found or false if problems are found.
◆ verifyWorld()
| bool Dragengine.Debugging.DebugVerifyStubProperties.verifyWorld | ( | StubGameWorld | stub | ) |
Verify stub properties.
- Returns
- true if no problems are found or false if problems are found.
Member Data Documentation
◆ pConsole
| Console Dragengine.Debugging.DebugVerifyStubProperties.pConsole |
◆ pDecalProperties
| Dictionary Dragengine.Debugging.DebugVerifyStubProperties.pDecalProperties |
◆ pIgnoreClassNames
| Array Dragengine.Debugging.DebugVerifyStubProperties.pIgnoreClassNames |
◆ pIgnoreKeys
| Array Dragengine.Debugging.DebugVerifyStubProperties.pIgnoreKeys |
◆ pLogPrefix
| String Dragengine.Debugging.DebugVerifyStubProperties.pLogPrefix |
◆ pWorldProperties
| Dictionary Dragengine.Debugging.DebugVerifyStubProperties.pWorldProperties |
The documentation for this class was generated from the following file:
