Search Results for

    Show / Hide Table of Contents

    Class AdminToy

    A wrapper class for AdminToys.AdminToyBase.

    Inheritance
    System.Object
    AdminToy
    Light
    Primitive
    ShootingTargetToy
    Implements
    IWorldSpace
    IPosition
    IRotation
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Exiled.API.Features.Toys
    Assembly: Exiled.API.dll
    Syntax
    public abstract class AdminToy : IWorldSpace, IPosition, IRotation

    Properties

    | Improve this Doc View Source

    AdminToyBase

    Gets the original AdminToys.AdminToyBase.

    Declaration
    public AdminToyBase AdminToyBase { get; }
    Property Value
    Type Description
    AdminToys.AdminToyBase
    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    IsStatic

    Gets or sets a value indicating whether IsStatic.

    Declaration
    public bool IsStatic { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    Player

    Gets or sets who spawn the Primitive AdminToy.

    Declaration
    public Player Player { get; set; }
    Property Value
    Type Description
    Player
    | Improve this Doc View Source

    Position

    Gets or sets the position of the toy.

    Declaration
    public Vector3 Position { get; set; }
    Property Value
    Type Description
    UnityEngine.Vector3
    | Improve this Doc View Source

    Rotation

    Gets or sets the rotation of the toy.

    Declaration
    public Quaternion Rotation { get; set; }
    Property Value
    Type Description
    UnityEngine.Quaternion
    | Improve this Doc View Source

    Scale

    Gets or sets the scale of the toy.

    Declaration
    public Vector3 Scale { get; set; }
    Property Value
    Type Description
    UnityEngine.Vector3
    | Improve this Doc View Source

    ToyType

    Gets the AdminToyType.

    Declaration
    public AdminToyType ToyType { get; }
    Property Value
    Type Description
    AdminToyType

    Methods

    | Improve this Doc View Source

    Destroy()

    Destroys the toy.

    Declaration
    public void Destroy()
    | Improve this Doc View Source

    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.

    | Improve this Doc View Source

    Spawn()

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

    Declaration
    public void Spawn()
    | Improve this Doc View Source

    UnSpawn()

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

    Declaration
    public void UnSpawn()

    Implements

    IWorldSpace
    IPosition
    IRotation

    Extension Methods

    ReflectionExtensions.CopyProperties(Object, Object)
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX