SchematicLoader

class ThaumielMapEditor.API.Helpers

Overview

Properties

Name	Type	Access	Description
Deserializer	IDeserializer	get	The YAML deserializer used to parse schematic and map files
MapsById	Dictionary<Guid, MapData>	get set	A dictionary of all spawned ThaumielMapEditor.API.Data.MapData instances, keyed by their System.Guid.
SchematicsById	Dictionary<UInt32, SchematicData>	get set	A dictionary of all spawned ThaumielMapEditor.API.Data.SchematicData instances, keyed by their ID.
Serializer	ISerializer	get	The YAML serializer used to write schematic and map files, configured with Pascal case naming and custom type converters.
SpawnedMaps	IEnumerable<MapData>	get	An enumerable of all currently spawned ThaumielMapEditor.API.Data.MapData instances.
SpawnedSchematics	IEnumerable<SchematicData>	get	An enumerable of all currently spawned ThaumielMapEditor.API.Data.SchematicData instances.

Fields

Name	Type	Description
LoadedMaps	List<SerializableMap>	This list contains all the maps loaded by `ThaumielMapEditor.API.Helpers.Schemat…
LoadedSchematics	Dictionary<string, SerializableSchematic>	This list contains all the schematics loaded by `ThaumielMapEditor.API.Helpers.S…
SchematicLODZones	Dictionary<LODZone, SchematicData>	dodad2
ServerSideTransforms	Dictionary<int, Transform>	No description

Methods

Signature	Returns	Description
Cleanup()	void	No description
DestroyMap(MapData)	void	Destroys a map.
DestroySchematic(SchematicData)	void	Destroys the specified ThaumielMapEditor.API.Data.SchematicData
GetId()	UInt32	Gets a unique id for all ThaumielMapEditor.API.Data.SchematicData
GetSchematicById(UInt32)	SchematicData	Gets the ThaumielMapEditor.API.Data.SchematicData by its id.
Init()	void	Initializes the ThaumielMapEditor.API.Helpers.SchematicLoader
LoadMaps()	void	Loads the maps
LoadSchematics()	void	Loads the schematics
LoadSchematicsFromDirectory(string)	void	Loads all schematics from a custom directory into `ThaumielMapEditor.API.Helpers…
ReloadSchematics()	void	Reloads all loaded schematics
SaveMap(MapData)	SerializableMap	Saves a map
SetupCulling(SerializableObject, ServerObject, SchematicData)	void	No description
SetupCulling(SerializableObject, ClientSideObjectBase, SchematicData)	void	No description
SpawnMap(SerializableMap)	MapData	Spawns a map
SpawnSchematic(SerializableSchematic, Vector3, Quaternion, Vector3)	SchematicData	Spawns a schematic at the specified position, rotation, and scale.
SpawnSchematic(SerializableSchematic, Vector3, Quaternion)	SchematicData	Spawns a schematic at the specified position and rotation with default scale.
SpawnSchematic(SerializableSchematic, Vector3)	SchematicData	Spawns a schematic at the specified position with default rotation and scale.
SpawnSchematic(string, Vector3)	SchematicData	Spawns a loaded schematic by name at the specified position with default rotatio…
SpawnSchematic(string, Vector3, Quaternion)	SchematicData	Spawns a loaded schematic by name at the specified position and rotation with de…
SpawnSchematic(string, Vector3, Quaternion, Vector3)	SchematicData	Spawns a loaded schematic by name at the specified position, rotation, and scale…
SpawnSchematicFromDirectory(string, string, Vector3)	SchematicData	Spawns a schematic by name from a custom directory at the specified position wit…
SpawnSchematicFromDirectory(string, string, Vector3, Quaternion)	SchematicData	Spawns a schematic by name from a custom directory at the specified position and…
SpawnSchematicFromDirectory(string, string, Vector3, Quaternion, Vector3)	SchematicData	Spawns a schematic by name from a custom directory at the specified position, ro…
SpawnSchematicFromPath(string, Vector3)	SchematicData	Spawns a schematic from a file path at the specified position with default rotat…
SpawnSchematicFromPath(string, Vector3, Quaternion)	SchematicData	Spawns a schematic from a file path at the specified position and rotation with…
SpawnSchematicFromPath(string, Vector3, Quaternion, Vector3)	SchematicData	Spawns a schematic from a file path at the specified position, rotation, and sca…
TryGetSchematicById(UInt32, SchematicData&)	bool	Tries to get the ThaumielMapEditor.API.Data.SchematicData by its Id.

Properties

Deserializer

Type: IDeserializer Access: get

The YAML deserializer used to parse schematic and map files

---

MapsById

Type: Dictionary<Guid, MapData> Access: get set

A dictionary of all spawned ThaumielMapEditor.API.Data.MapData instances, keyed by their System.Guid.

---

SchematicsById

Type: Dictionary<UInt32, SchematicData> Access: get set

A dictionary of all spawned ThaumielMapEditor.API.Data.SchematicData instances, keyed by their ID.

---

Serializer

Type: ISerializer Access: get

The YAML serializer used to write schematic and map files, configured with Pascal case naming and custom type converters.

---

SpawnedMaps

Type: IEnumerable<MapData> Access: get

An enumerable of all currently spawned ThaumielMapEditor.API.Data.MapData instances.

---

SpawnedSchematics

Type: IEnumerable<SchematicData> Access: get

An enumerable of all currently spawned ThaumielMapEditor.API.Data.SchematicData instances.

---

Fields

LoadedMaps

Type: List<SerializableMap>

This list contains all the maps loaded by ThaumielMapEditor.API.Helpers.SchematicLoader.LoadMaps Use ThaumielMapEditor.API.Helpers.SchematicLoader.SpawnedMaps to get the spawned maps.

---

LoadedSchematics

Type: Dictionary<string, SerializableSchematic>

This list contains all the schematics loaded by ThaumielMapEditor.API.Helpers.SchematicLoader.LoadSchematics Use ThaumielMapEditor.API.Helpers.SchematicLoader.SpawnedSchematics to get the spawned schematics.

---

SchematicLODZones

Type: Dictionary<LODZone, SchematicData>

dodad2

---

ServerSideTransforms

Type: Dictionary<int, Transform>

---

Methods

Cleanup

Cleanup

public void Cleanup()

---

DestroyMap

DestroyMap

public void DestroyMap(MapData map)

Destroys a map.

Parameters

Name	Type	Description
map	MapData	The ThaumielMapEditor.API.Data.MapData to be destroyed.

---

DestroySchematic

DestroySchematic

public void DestroySchematic(SchematicData data)

Destroys the specified ThaumielMapEditor.API.Data.SchematicData

Parameters

Name	Type	Description
data	SchematicData	The schematic to be destroyed

---

GetId

GetId

public UInt32 GetId()

Gets a unique id for all ThaumielMapEditor.API.Data.SchematicData

Returns

UInt32 — System.UInt32 id

---

GetSchematicById

GetSchematicById

public SchematicData GetSchematicById(UInt32 id)

Gets the ThaumielMapEditor.API.Data.SchematicData by its id.

Parameters

Name	Type	Description
id	UInt32	The id to get

Returns

SchematicData — ThaumielMapEditor.API.Data.SchematicData if found else returns null

---

Init

Init

public void Init()

Initializes the ThaumielMapEditor.API.Helpers.SchematicLoader

---

LoadMaps

LoadMaps

public void LoadMaps()

Loads the maps

---

LoadSchematics

LoadSchematics

public void LoadSchematics()

Loads the schematics

---

LoadSchematicsFromDirectory

LoadSchematicsFromDirectory

public void LoadSchematicsFromDirectory(string directory)

Loads all schematics from a custom directory into ThaumielMapEditor.API.Helpers.SchematicLoader.LoadedSchematics.

Parameters

Name	Type	Description
directory	string	The full path to the directory to load schematics from.

---

ReloadSchematics

ReloadSchematics

public void ReloadSchematics()

Reloads all loaded schematics

Remarks

This does not automatically respawn schematics

---

SaveMap

SaveMap

public SerializableMap SaveMap(MapData data)

Saves a map

Parameters

Name	Type	Description
data	MapData	The ThaumielMapEditor.API.Data.MapData to save

Returns

SerializableMap — ThaumielMapEditor.API.Serialization.SerializableMap

---

SetupCulling

SetupCulling

public void SetupCulling(
    SerializableObject serializable,
    ServerObject obj,
    SchematicData schematic
)

Parameters

Name	Type	Description
serializable	SerializableObject
obj	ServerObject
schematic	SchematicData

---

SetupCulling

SetupCulling

public void SetupCulling(
    SerializableObject serializable,
    ClientSideObjectBase obj,
    SchematicData schematic
)

Parameters

Name	Type	Description
serializable	SerializableObject
obj	ClientSideObjectBase
schematic	SchematicData

---

SpawnMap

SpawnMap

public MapData SpawnMap(SerializableMap map)

Spawns a map

Parameters

Name	Type	Description
map	SerializableMap	The serialized map to spawn

Returns

MapData — ThaumielMapEditor.API.Data.MapData

---

SpawnSchematic

SpawnSchematic

public SchematicData SpawnSchematic(
    SerializableSchematic schematic,
    Vector3 position,
    Quaternion rotation,
    Vector3 scale
)

Spawns a schematic at the specified position, rotation, and scale.

Parameters

Name	Type	Description
schematic	SerializableSchematic	The serialized schematic to spawn.
position	Vector3	The world position at which to place the schematic.
rotation	Quaternion	The rotation to apply to the schematic.
scale	Vector3	The scale to apply to the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic.

---

SpawnSchematic

SpawnSchematic

public SchematicData SpawnSchematic(
    SerializableSchematic schematic,
    Vector3 position,
    Quaternion rotation
)

Spawns a schematic at the specified position and rotation with default scale.

Parameters

Name	Type	Description
schematic	SerializableSchematic	The serialized schematic to spawn.
position	Vector3	The world position at which to place the schematic.
rotation	Quaternion	The rotation to apply to the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic.

---

SpawnSchematic

SpawnSchematic

public SchematicData SpawnSchematic(
    SerializableSchematic schematic,
    Vector3 position
)

Spawns a schematic at the specified position with default rotation and scale.

Parameters

Name	Type	Description
schematic	SerializableSchematic	The serialized schematic to spawn.
position	Vector3	The world position at which to place the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic.

---

SpawnSchematic

SpawnSchematic

public SchematicData SpawnSchematic(
    string schematicname,
    Vector3 position
)

Spawns a loaded schematic by name at the specified position with default rotation and scale.

Parameters

Name	Type	Description
schematicname	string	The file name of the schematic to spawn. Must match a schematic in ThaumielMapEditor.API.Helpers.SchematicLoader.LoadedSchematics.
position	Vector3	The world position at which to place the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic.

---

SpawnSchematic

SpawnSchematic

public SchematicData SpawnSchematic(
    string schematicname,
    Vector3 position,
    Quaternion rotation
)

Spawns a loaded schematic by name at the specified position and rotation with default scale.

Parameters

Name	Type	Description
schematicname	string	The file name of the schematic to spawn. Must match a schematic in ThaumielMapEditor.API.Helpers.SchematicLoader.LoadedSchematics.
position	Vector3	The world position at which to place the schematic.
rotation	Quaternion	The rotation to apply to the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic.

---

SpawnSchematic

SpawnSchematic

public SchematicData SpawnSchematic(
    string schematicname,
    Vector3 position,
    Quaternion rotation,
    Vector3 scale
)

Spawns a loaded schematic by name at the specified position, rotation, and scale.

Parameters

Name	Type	Description
schematicname	string	The file name of the schematic to spawn. Must match a schematic in ThaumielMapEditor.API.Helpers.SchematicLoader.LoadedSchematics.
position	Vector3	The world position at which to place the schematic.
rotation	Quaternion	The rotation to apply to the schematic.
scale	Vector3	The scale to apply to the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic.

---

SpawnSchematicFromDirectory

SpawnSchematicFromDirectory

public SchematicData SpawnSchematicFromDirectory(
    string directory,
    string schematicName,
    Vector3 position
)

Spawns a schematic by name from a custom directory at the specified position with default rotation and scale.

Parameters

Name	Type	Description
directory	string	The full path to the directory containing the schematic.
schematicName	string	The file name of the schematic (without extension).
position	Vector3	The world position at which to place the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic, or null if the schematic could not be loaded.

---

SpawnSchematicFromDirectory

SpawnSchematicFromDirectory

public SchematicData SpawnSchematicFromDirectory(
    string directory,
    string schematicName,
    Vector3 position,
    Quaternion rotation
)

Spawns a schematic by name from a custom directory at the specified position and rotation with default scale.

Parameters

Name	Type	Description
directory	string	The full path to the directory containing the schematic.
schematicName	string	The file name of the schematic (without extension).
position	Vector3	The world position at which to place the schematic.
rotation	Quaternion	The rotation to apply to the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic, or null if the schematic could not be loaded.

---

SpawnSchematicFromDirectory

SpawnSchematicFromDirectory

public SchematicData SpawnSchematicFromDirectory(
    string directory,
    string schematicName,
    Vector3 position,
    Quaternion rotation,
    Vector3 scale
)

Spawns a schematic by name from a custom directory at the specified position, rotation, and scale.

Parameters

Name	Type	Description
directory	string	The full path to the directory containing the schematic.
schematicName	string	The file name of the schematic (without extension).
position	Vector3	The world position at which to place the schematic.
rotation	Quaternion	The rotation to apply to the schematic.
scale	Vector3	The scale to apply to the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic, or null if the schematic could not be loaded.

---

SpawnSchematicFromPath

SpawnSchematicFromPath

public SchematicData SpawnSchematicFromPath(
    string path,
    Vector3 position
)

Spawns a schematic from a file path at the specified position with default rotation and scale.

Parameters

Name	Type	Description
path	string	The full file path to the schematic YAML file.
position	Vector3	The world position at which to place the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic, or null if the file could not be loaded.

---

SpawnSchematicFromPath

SpawnSchematicFromPath

public SchematicData SpawnSchematicFromPath(
    string path,
    Vector3 position,
    Quaternion rotation
)

Spawns a schematic from a file path at the specified position and rotation with default scale.

Parameters

Name	Type	Description
path	string	The full file path to the schematic YAML file.
position	Vector3	The world position at which to place the schematic.
rotation	Quaternion	The rotation to apply to the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic, or null if the file could not be loaded.

---

SpawnSchematicFromPath

SpawnSchematicFromPath

public SchematicData SpawnSchematicFromPath(
    string path,
    Vector3 position,
    Quaternion rotation,
    Vector3 scale
)

Spawns a schematic from a file path at the specified position, rotation, and scale.

Parameters

Name	Type	Description
path	string	The full file path to the schematic YAML file.
position	Vector3	The world position at which to place the schematic.
rotation	Quaternion	The rotation to apply to the schematic.
scale	Vector3	The scale to apply to the schematic.

Returns

SchematicData — A ThaumielMapEditor.API.Data.SchematicData instance representing the spawned schematic, or null if the file could not be loaded.

---

TryGetSchematicById

TryGetSchematicById

public bool TryGetSchematicById(
    UInt32 id,
    SchematicData& schematic
)

Tries to get the ThaumielMapEditor.API.Data.SchematicData by its Id.

Parameters

Name	Type	Description
id	UInt32	The id to get
schematic	SchematicData&	The ThaumielMapEditor.API.Data.SchematicData if found

Returns

bool — true if found else returns false if not

---