Class CameraToy

Namespace

Exiled.API.Features.Toys

Assembly

Exiled.API.dll

A wrapper class for AdminToys.AdminToyBase.

public class CameraToy : AdminToy, IWorldSpace, IPosition, IRotation, IWrapper<Scp079CameraToy>

Inheritance

object

AdminToy

CameraToy

Implements

IWorldSpace

IPosition

IRotation

IWrapper<Scp079CameraToy>

Inherited Members

AdminToy.List

AdminToy.AdminToyBase

AdminToy.ToyType

AdminToy.Player

AdminToy.Footprint

AdminToy.Position

AdminToy.Rotation

AdminToy.Scale

AdminToy.GameObject

AdminToy.Transform

AdminToy.MovementSmoothing

AdminToy.IsStatic

AdminToy.Get(AdminToyBase)

AdminToy.Get<T>(AdminToyBase)

AdminToy.Spawn()

AdminToy.UnSpawn()

AdminToy.Destroy()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

object.ReferenceEquals(object, object)

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

Base

Gets the base AdminToys.Scp079CameraToy.

public Scp079CameraToy Base { get; }

Property Value

Scp079CameraToy

EzArmCameraPrefab

Gets the prefab for EzArm Camera prefab.

public static Scp079CameraToy EzArmCameraPrefab { get; }

Property Value

Scp079CameraToy

EzCameraPrefab

Gets the prefab for Ez Camera prefab.

public static Scp079CameraToy EzCameraPrefab { get; }

Property Value

Scp079CameraToy

HczCameraPrefab

Gets the prefab for Hcz Camera prefab.

public static Scp079CameraToy HczCameraPrefab { get; }

Property Value

Scp079CameraToy

HorizontalConstraint

Gets or sets the Horizontal restriction.

public Vector2 HorizontalConstraint { get; set; }

Property Value

Vector2

LczCameraPrefab

Gets the prefab for Lcz Camera prefab.

public static Scp079CameraToy LczCameraPrefab { get; }

Property Value

Scp079CameraToy

Name

Gets or sets the Name of the Camera.

public string Name { get; set; }

Property Value

string

Room

Gets or sets the Room where the Camera is associated with.

public Room Room { get; set; }

Property Value

Room

SzCameraPrefab

Gets the prefab for Sz Camera prefab.

public static Scp079CameraToy SzCameraPrefab { get; }

Property Value

Scp079CameraToy

VerticalConstraint

Gets or sets the Vertical Restriction.

public Vector2 VerticalConstraint { get; set; }

Property Value

Vector2

ZoomConstraint

Gets or sets the Zoom restriction.

public Vector2 ZoomConstraint { get; set; }

Property Value

Vector2

Methods

Create(CameraType, Vector3)

Creates a new CameraToy with a specified type.

public static CameraToy Create(CameraType type, Vector3 position)

Parameters

type CameraType

The CameraType of the camera.

position Vector3

The local position of the camera.

Returns

CameraToy

The new CameraToy.

Create(CameraType, Vector3, string)

Creates a new CameraToy with a specified type and name.

public static CameraToy Create(CameraType type, Vector3 position, string name)

Parameters

type CameraType

The CameraType of the camera.

position Vector3

The local position of the camera.

name string

The name (label) of the camera.

Returns

CameraToy

The new CameraToy.

Create(Transform, CameraType, Vector3?, Quaternion?, Vector3?, string, Room, Vector2?, Vector2?, Vector2?, bool)

Creates a new CameraToy.

public static CameraToy Create(Transform parent = null, CameraType type = CameraType.EzArmCameraToy, Vector3? position = null, Quaternion? rotation = null, Vector3? scale = null, string name = "New Camera", Room room = null, Vector2? verticalConstraint = null, Vector2? horizontalConstraint = null, Vector2? zoomConstraint = null, bool spawn = true)

Parameters

parent Transform

The transform to create this CameraToy on.

type CameraType

The CameraType of the camera.

position Vector3?

The local position of the camera.

rotation Quaternion?

The local rotation of the camera.

scale Vector3?

The local scale of the camera.

name string

The name (label) of the camera.

room Room

The room associated with this camera.

verticalConstraint Vector2?

The vertical limits. Leave null to use prefab default.

horizontalConstraint Vector2?

The horizontal limits. Leave null to use prefab default.

zoomConstraint Vector2?

The zoom limits. Leave null to use prefab default.

spawn bool

Whether the camera should be initially spawned.

Returns

CameraToy

The new CameraToy.