ServerObject
ThaumielMapEditor.API.Blocks
Overview
Properties
| Name | Type | Access | Description |
|---|---|---|---|
IsStatic | bool | get set | Gets or Sets whether or not the ServerObject is static |
MovementSmoothing | byte | get set | The ticks between the server sending a update to the client about this object's position. 0 means no delay, 1 means the server will send an update every tick, 2 means every other tick, and so on. |
Name | string | get set | No description |
NetId | UInt32 | get | The NetId of the spawned ServerObject. |
Object | GameObject | get | Gets or sets the associated game object instance. |
ObjectId | int | get | Gets the object id from the ThaumielMapEditor.API.Serialization.SerializableObject this ThaumielMapEditor.API.Blocks.ServerObject instance was generated from. |
ObjectType | ObjectType | get set | Gets or sets the type of the object represented by this instance. |
ParentId | int | get | Gets the parent id from the ThaumielMapEditor.API.Serialization.SerializableObject this ThaumielMapEditor.API.Blocks.ServerObject instance was generated from. |
Position | Vector3 | get set | Gets or sets the Position of the ServerObject |
Rotation | Quaternion | get set | Gets or sets the Rotation of the ServerObject |
Scale | Vector3 | get set | Gets or sets the Scale of the ServerObject |
SpawnedObjects | List<ServerObject> | get set | No description |
Tools | IEnumerable<ToolBase> | get | Gets the ThaumielMapEditor.API.Components.Tools.ToolBase tools that are added to this ThaumielMapEditor.API.Blocks.ServerObject. |
Methods
| Signature | Returns | Description |
|---|---|---|
DestroyObject(SchematicData) | void | Destroys the associated networked object and removes it from the specified schem… |
GetValue(SerializableObject, string) | T | Gets a value from `ThaumielMapEditor.API.Serialization.SerializableObject.Values… |
HideForPlayer(Player) | void | Hides the ThaumielMapEditor.API.Blocks.ServerObject on the client. |
SetWorldTransform(SchematicData) | void | Applies the specified schematic's transformation to the current object's world p… |
ShowForPlayer(Player) | void | Shows the ThaumielMapEditor.API.Blocks.ServerObject on the client. |
SpawnObject(SchematicData, SerializableObject) | void | Spawns the specified ThaumielMapEditor.API.Blocks.ServerObject into the server… |
UpdateObject(SchematicData, bool) | void | Updates the object's world transform and network state based on the specified sc… |
Properties
IsStatic
Type: bool Access: get set
Gets or Sets whether or not the ServerObject is static
MovementSmoothing
Type: byte Access: get set
The ticks between the server sending a update to the client about this object's position. 0 means no delay, 1 means the server will send an update every tick, 2 means every other tick, and so on.
Name
Type: string Access: get set
NetId
Type: UInt32 Access: get
The NetId of the spawned ServerObject.
Object
Type: GameObject Access: get
Gets or sets the associated game object instance.
ObjectId
Type: int Access: get
Gets the object id from the ThaumielMapEditor.API.Serialization.SerializableObject this ThaumielMapEditor.API.Blocks.ServerObject instance was generated from.
ObjectType
Type: ObjectType Access: get set
Gets or sets the type of the object represented by this instance.
ParentId
Type: int Access: get
Gets the parent id from the ThaumielMapEditor.API.Serialization.SerializableObject this ThaumielMapEditor.API.Blocks.ServerObject instance was generated from.
Position
Type: Vector3 Access: get set
Gets or sets the Position of the ServerObject
Rotation
Type: Quaternion Access: get set
Gets or sets the Rotation of the ServerObject
Scale
Type: Vector3 Access: get set
Gets or sets the Scale of the ServerObject
SpawnedObjects
Type: List<ServerObject> Access: get set
Tools
Type: IEnumerable<ToolBase> Access: get
Gets the ThaumielMapEditor.API.Components.Tools.ToolBase tools that are added to this ThaumielMapEditor.API.Blocks.ServerObject.
Methods
DestroyObject
public void DestroyObject(SchematicData schematic)
Destroys the associated networked object and removes it from the specified schematic's collection of spawned server objects.
Parameters
| Name | Type | Description |
|---|---|---|
schematic | SchematicData | The schematic data instance from which the object will be removed. |
GetValue
public T GetValue(
SerializableObject serializable,
string key
)
Gets a value from ThaumielMapEditor.API.Serialization.SerializableObject.Values and converts it to the specified type.
Parameters
| Name | Type | Description |
|---|---|---|
serializable | SerializableObject | The ThaumielMapEditor.API.Serialization.SerializableObject instance. |
key | string | The string key to lookup. |
Returns
T
HideForPlayer
public void HideForPlayer(Player player)
Hides the ThaumielMapEditor.API.Blocks.ServerObject on the client.
Parameters
| Name | Type | Description |
|---|---|---|
player | Player |
SetWorldTransform
public void SetWorldTransform(SchematicData schematic)
Applies the specified schematic's transformation to the current object's world position, rotation, and scale.
Parameters
| Name | Type | Description |
|---|---|---|
schematic | SchematicData | The schematic data containing the position, rotation, and scale to apply to the current object. |
ShowForPlayer
public void ShowForPlayer(Player player)
Shows the ThaumielMapEditor.API.Blocks.ServerObject on the client.
Parameters
| Name | Type | Description |
|---|---|---|
player | Player |
SpawnObject
public void SpawnObject(
SchematicData schematic,
SerializableObject serializable
)
Spawns the specified ThaumielMapEditor.API.Blocks.ServerObject into the server and adds it to the provided ThaumielMapEditor.API.Data.SchematicData's ThaumielMapEditor.API.Data.SchematicData.SpawnedServerObjects list.
Parameters
| Name | Type | Description |
|---|---|---|
schematic | SchematicData | |
serializable | SerializableObject |
UpdateObject
public void UpdateObject(
SchematicData schematic,
bool respawn
)
Updates the object's world transform and network state based on the specified schematic data, optionally respawning the object on the network.
If the object is not currently spawned, this method will not perform any update. The method also updates the object's network synchronization component if present.
Parameters
| Name | Type | Description |
|---|---|---|
schematic | SchematicData | The schematic data used to update the object's position and rotation. |
respawn | bool | If true, the object is respawned on the network after updating. If false, the object is not respawned. |