Class AdminToy
A wrapper class for AdminToys.AdminToyBase.
Inherited Members
Namespace: Exiled.API.Features.Toys
Assembly: Exiled.API.dll
Syntax
public abstract class AdminToy : IWorldSpace, IPosition, IRotation
Properties
| Improve this Doc View SourceAdminToyBase
Gets the original AdminToys.AdminToyBase.
Declaration
public AdminToyBase AdminToyBase { get; }
Property Value
| Type | Description |
|---|---|
| AdminToys.AdminToyBase |
Footprint
Gets or sets the Footprint of the player who spawned the AdminToy.
Declaration
public Footprint Footprint { get; set; }
Property Value
| Type | Description |
|---|---|
| Footprinting.Footprint |
IsStatic
Gets or sets a value indicating whether IsStatic.
Declaration
public bool IsStatic { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
MovementSmoothing
Gets or sets the movement smoothing value of the toy.
Higher values reflect smoother movements.
- 60 is an ideal value.
Declaration
public byte MovementSmoothing { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
Player
Gets or sets who spawn the Primitive AdminToy.
Declaration
public Player Player { get; set; }
Property Value
| Type | Description |
|---|---|
| Player |
Position
Gets or sets the position of the toy.
Declaration
public Vector3 Position { get; set; }
Property Value
| Type | Description |
|---|---|
| UnityEngine.Vector3 |
Rotation
Gets or sets the rotation of the toy.
Declaration
public Quaternion Rotation { get; set; }
Property Value
| Type | Description |
|---|---|
| UnityEngine.Quaternion |
Scale
Gets or sets the scale of the toy.
Declaration
public Vector3 Scale { get; set; }
Property Value
| Type | Description |
|---|---|
| UnityEngine.Vector3 |
ToyType
Gets the AdminToyType.
Declaration
public AdminToyType ToyType { get; }
Property Value
| Type | Description |
|---|---|
| AdminToyType |
Methods
| Improve this Doc View SourceDestroy()
Destroys the toy.
Declaration
public void Destroy()
Get(AdminToyBase)
Gets the AdminToy belonging to the AdminToys.AdminToyBase.
Declaration
public static AdminToy Get(AdminToyBase adminToyBase)
Parameters
| Type | Name | Description |
|---|---|---|
| AdminToys.AdminToyBase | adminToyBase | The AdminToys.AdminToyBase instance. |
Returns
| Type | Description |
|---|---|
| AdminToy | The corresponding AdminToy instance. |
Spawn()
Spawns the toy into the game. Use UnSpawn() to remove it.
Declaration
public void Spawn()
UnSpawn()
Removes the toy from the game. Use Spawn() to bring it back.
Declaration
public void UnSpawn()