Class AdminToy

Namespace

Exiled.API.Features.Toys

Assembly

Exiled.API.dll

A wrapper class for AdminToys.AdminToyBase.

public abstract class AdminToy : IWorldSpace, IPosition, IRotation

Inheritance

object

AdminToy

Implements

IWorldSpace

IPosition

IRotation

Derived

Light

Primitive

ShootingTargetToy

Speaker

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

AdminToyBase

Gets the original AdminToys.AdminToyBase.

public AdminToyBase AdminToyBase { get; }

Property Value

AdminToyBase

Footprint

Gets or sets the Footprint of the player who spawned the AdminToy.

public Footprint Footprint { get; set; }

Property Value

Footprint

GameObject

Gets the UnityEngine.GameObject of the toy.

public GameObject GameObject { get; }

Property Value

GameObject

IsStatic

Gets or sets a value indicating whether IsStatic.

public bool IsStatic { get; set; }

Property Value

bool

List

Gets a list of all AdminToy's on the server.

public static IReadOnlyCollection<AdminToy> List { get; }

Property Value

IReadOnlyCollection<AdminToy>

MovementSmoothing

Gets or sets the movement smoothing value of the toy.

Higher values reflect smoother movements.
- 60 is an ideal value.

public byte MovementSmoothing { get; set; }

Property Value

byte

Player

Gets or sets who spawn the Primitive AdminToy.

public Player Player { get; set; }

Property Value

Player

Position

Gets or sets the position of the toy.

public Vector3 Position { get; set; }

Property Value

Vector3

Rotation

Gets or sets the rotation of the toy.

public Quaternion Rotation { get; set; }

Property Value

Quaternion

Scale

Gets or sets the scale of the toy.

public Vector3 Scale { get; set; }

Property Value

Vector3

ToyType

Gets the AdminToyType.

public AdminToyType ToyType { get; }

Property Value

AdminToyType

Transform

Gets the UnityEngine.Transform of the toy.

public Transform Transform { get; }

Property Value

Transform

Methods

Destroy()

Destroys the toy.

public void Destroy()

Get(AdminToyBase)

Gets the AdminToy belonging to the AdminToys.AdminToyBase.

public static AdminToy Get(AdminToyBase adminToyBase)

Parameters

adminToyBase AdminToyBase

The AdminToys.AdminToyBase instance.

Returns

AdminToy

The corresponding AdminToy instance.

Get<T>(AdminToyBase)

Gets the AdminToy by AdminToys.AdminToyBase.

public static T Get<T>(AdminToyBase adminToyBase) where T : AdminToy

Parameters

adminToyBase AdminToyBase

The AdminToys.AdminToyBase to convert into an admintoy.

Returns

T

The admintoy wrapper for the given AdminToys.AdminToyBase.

Type Parameters

T

The specified AdminToy type.

Spawn()

Spawns the toy into the game. Use UnSpawn() to remove it.

public void Spawn()

UnSpawn()

Removes the toy from the game. Use Spawn() to bring it back.

public void UnSpawn()