ClientSideObjectBase
ThaumielMapEditor.API.Blocks.ClientSide
Overview
Properties
| Name | Type | Access | Description |
|---|---|---|---|
AssetId | UInt32 | get set | Gets or sets the asset id of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance. |
IsStatic | bool | get set | Gets or sets |
MovementSmoothing | byte | get set | Gets or sets the sync interval of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase. |
NetId | UInt32 | get set | Gets or sets the netid of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance. |
ObjectId | int | get | Gets the object id from the ThaumielMapEditor.API.Serialization.SerializableObject this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance was generated from. |
ObjectType | ObjectType | get set | Gets or sets the object type of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance. |
Parent | GameObject | get | Gets or sets the UnityEngine.GameObject the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase is parented to on the client. |
ParentId | int | get | Gets the parent id from the ThaumielMapEditor.API.Serialization.SerializableObject this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance was generated from. |
ParentNetId | UInt32 | get | Gets or sets the netId of the UnityEngine.GameObject this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase is parented to. |
Position | Vector3 | get set | Gets or sets the position of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance. |
Rotation | Quaternion | get set | Gets or sets the rotation of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance. |
Scale | Vector3 | get set | Gets or sets the scale of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance. |
ServerColliders | Collider[] | get set | Gets or sets the colliders of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance. |
Spawned | bool | get | Gets a value indicating whether this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase has been spawned for any players. |
SpawnedPlayers | HashSet<Player> | get | All the LabApi.Features.Wrappers.Players that this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance has been spawned for. |
WorldPosition | Vector3 | get set | Gets or sets the world position of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance. |
WorldRotation | Quaternion | get set | Gets or sets the world rotation of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance. |
Methods
| Signature | Returns | Description |
|---|---|---|
DespawnForAllPlayers() | UInt32 | Destroys this object for all ready players. |
DespawnForPlayer(Player) | void | Destroys this object for the specified player. |
DestroyForAllPlayers() | void | Destroys this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase ins… |
DestroyForPlayer(Player) | void | Destroys this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase ins… |
FlushSync() | void | Syncs all the pending bits in `ThaumielMapEditor.API.Blocks.ClientSide.ClientSid… |
GetValue(SerializableObject, string) | T | Gets a value from a ThaumielMapEditor.API.Serialization.SerializableObject by… |
HideForPlayer(Player) | void | Hides this object for the specified player. |
SetParent(Player, UInt32) | void | Sets the parent of the |
ShowForPlayer(Player) | void | Shows this object for the specified player. |
SpawnForPlayer(Player) | void | Spawns the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instan… |
SpawnForPlayer(GameObject, Player) | bool | Spawns a UnityEngine.GameObject to the specified `LabApi.Features.Wrappers.Pla… |
SyncToPlayers(UInt64, Action<NetworkWriter>) | void | Syncs the specified bits to all LabApi.Features.Wrappers.Players this `Thaumie… |
Properties
AssetId
Type: UInt32 Access: get set
Gets or sets the asset id of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance.
IsStatic
Type: bool Access: get set
Gets or sets
MovementSmoothing
Type: byte Access: get set
Gets or sets the sync interval of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase.
NetId
Type: UInt32 Access: get set
Gets or sets the netid of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance.
ObjectId
Type: int Access: get
Gets the object id from the ThaumielMapEditor.API.Serialization.SerializableObject this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance was generated from.
ObjectType
Type: ObjectType Access: get set
Gets or sets the object type of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance.
Parent
Type: GameObject Access: get
Gets or sets the UnityEngine.GameObject the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase is parented to on the client.
ParentId
Type: int Access: get
Gets the parent id from the ThaumielMapEditor.API.Serialization.SerializableObject this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance was generated from.
ParentNetId
Type: UInt32 Access: get
Gets or sets the netId of the UnityEngine.GameObject this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase is parented to.
Position
Type: Vector3 Access: get set
Gets or sets the position of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance.
This will be automatically synced to players.
Rotation
Type: Quaternion Access: get set
Gets or sets the rotation of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance.
This will be automatically synced to players.
Scale
Type: Vector3 Access: get set
Gets or sets the scale of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance.
This will be automatically synced to players.
ServerColliders
Type: Collider[] Access: get set
Gets or sets the colliders of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance.
Spawned
Type: bool Access: get
Gets a value indicating whether this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase has been spawned for any players.
SpawnedPlayers
Type: HashSet<Player> Access: get
All the LabApi.Features.Wrappers.Players that this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance has been spawned for.
WorldPosition
Type: Vector3 Access: get set
Gets or sets the world position of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance.
WorldRotation
Type: Quaternion Access: get set
Gets or sets the world rotation of the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance.
Methods
DespawnForAllPlayers
public UInt32 DespawnForAllPlayers()
Destroys this object for all ready players.
Returns
UInt32 — The number of players this object was despawned for.
DespawnForPlayer
public void DespawnForPlayer(Player player)
Destroys this object for the specified player.
Parameters
| Name | Type | Description |
|---|---|---|
player | Player | The player to despawn this object for. |
DestroyForAllPlayers
public void DestroyForAllPlayers()
Destroys this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance for all LabApi.Features.Wrappers.Players
DestroyForPlayer
public void DestroyForPlayer(Player player)
Destroys this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance for the specified LabApi.Features.Wrappers.Player
Parameters
| Name | Type | Description |
|---|---|---|
player | Player | The LabApi.Features.Wrappers.Player to destroy this object on. |
FlushSync
public void FlushSync()
Syncs all the pending bits in ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase._pendingWrites and ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase._pendingDirtyBits.
GetValue
public T GetValue(
SerializableObject serializable,
string key
)
Gets a value from a ThaumielMapEditor.API.Serialization.SerializableObject by key, converting it to the specified type.
Parameters
| Name | Type | Description |
|---|---|---|
serializable | SerializableObject | The serializable object to retrieve the value from. |
key | string | The key of the value to retrieve. |
Returns
T — The value associated with the key, converted to T.
HideForPlayer
public void HideForPlayer(Player player)
Hides this object for the specified player.
Parameters
| Name | Type | Description |
|---|---|---|
player | Player | The player to hide this object for. |
SetParent
public void SetParent(
Player player,
UInt32 parentId
)
Sets the parent of the
Parameters
| Name | Type | Description |
|---|---|---|
player | Player | The LabApi.Features.Wrappers.Player that will recive the parent message= |
parentId | UInt32 | The Mirror.NetworkBehaviour.netId of the parent |
ShowForPlayer
public void ShowForPlayer(Player player)
Shows this object for the specified player.
Parameters
| Name | Type | Description |
|---|---|---|
player | Player | The player to show this object for. |
SpawnForPlayer
public void SpawnForPlayer(Player player)
Spawns the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance for the specified player.
Parameters
| Name | Type | Description |
|---|---|---|
player | Player | The player to spawn the ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase instance to. |
SpawnForPlayer
public bool SpawnForPlayer(
GameObject obj,
Player player
)
Spawns a UnityEngine.GameObject to the specified LabApi.Features.Wrappers.Player.
Parameters
| Name | Type | Description |
|---|---|---|
obj | GameObject | The UnityEngine.GameObject to be spawned. |
player | Player | The LabApi.Features.Wrappers.Player to be spawned for. |
Returns
bool — true if it is successfully spawned otherwise returns false
SyncToPlayers
public void SyncToPlayers(
UInt64 dirtyBits,
Action<NetworkWriter> writeValues
)
Syncs the specified bits to all LabApi.Features.Wrappers.Players this ThaumielMapEditor.API.Blocks.ClientSide.ClientSideObjectBase is spawned for
Parameters
| Name | Type | Description |
|---|---|---|
dirtyBits | UInt64 | The bits to sync. |
writeValues | Action<NetworkWriter> | The writer to use. |