ToolBase
ThaumielMapEditor.API.Components.Tools
Overview​
Properties​
| Name | Type | Access | Description |
|---|---|---|---|
Object | ServerObject | get | Gets the ThaumielMapEditor.API.Blocks.ServerObject for this ThaumielMapEditor.API.Components.Tools.ToolBase instance. Null until ThaumielMapEditor.API.Components.Tools.ToolBase.Init(ThaumielMapEditor.API.Blocks.ServerObject,ThaumielMapEditor.API.Data.SchematicData,System.Collections.Generic.Dictionary{System.String,System.Object}) is called. |
Schematic | SchematicData | get | Gets the ThaumielMapEditor.API.Blocks.ServerObject for this ThaumielMapEditor.API.Components.Tools.ToolBase instance. Null until ThaumielMapEditor.API.Components.Tools.ToolBase.Init(ThaumielMapEditor.API.Blocks.ServerObject,ThaumielMapEditor.API.Data.SchematicData,System.Collections.Generic.Dictionary{System.String,System.Object}) is called. |
Type | ToolType | get | The ThaumielMapEditor.API.Enums.ToolType this ThaumielMapEditor.API.Components.Tools.ToolBase instance uses. |
Methods​
| Signature | Returns | Description |
|---|---|---|
Init(ServerObject, SchematicData, Dictionary<string, object>) | void | Initializes the component. |
IsLocalFile(string) | bool | No description |
MapToObject(object) | T | No description |
Properties​
Object​
Type: ServerObject Access: get
Gets the ThaumielMapEditor.API.Blocks.ServerObject for this ThaumielMapEditor.API.Components.Tools.ToolBase instance. Null until ThaumielMapEditor.API.Components.Tools.ToolBase.Init(ThaumielMapEditor.API.Blocks.ServerObject,ThaumielMapEditor.API.Data.SchematicData,System.Collections.Generic.Dictionary{System.String,System.Object}) is called.
Schematic​
Type: SchematicData Access: get
Gets the ThaumielMapEditor.API.Blocks.ServerObject for this ThaumielMapEditor.API.Components.Tools.ToolBase instance. Null until ThaumielMapEditor.API.Components.Tools.ToolBase.Init(ThaumielMapEditor.API.Blocks.ServerObject,ThaumielMapEditor.API.Data.SchematicData,System.Collections.Generic.Dictionary{System.String,System.Object}) is called.
Type​
Type: ToolType Access: get
The ThaumielMapEditor.API.Enums.ToolType this ThaumielMapEditor.API.Components.Tools.ToolBase instance uses.
Methods​
Init​
public void Init(
ServerObject obj,
SchematicData schem,
Dictionary<string, object> properties
)
Initializes the component.
Parameters​
| Name | Type | Description |
|---|---|---|
obj | ServerObject | The ThaumielMapEditor.API.Blocks.ServerObject instance this was added to. |
schem | SchematicData | The ThaumielMapEditor.API.Data.SchematicData that the ThaumielMapEditor.API.Blocks.ServerObject was spawned from. |
properties | Dictionary<string, object> | The serialized properties. |
IsLocalFile​
public bool IsLocalFile(string path)
Parameters​
| Name | Type | Description |
|---|---|---|
path | string |
Returns​
bool
MapToObject​
public T MapToObject(object data)
Parameters​
| Name | Type | Description |
|---|---|---|
data | object |
Returns​
T