Class Camera

Namespace

Exiled.API.Features

Assembly

Exiled.API.dll

The in-game Scp079Camera.

public class Camera : IWrapper<Scp079Camera>, IWorldSpace, IPosition, IRotation

Inheritance

object

Camera

Implements

IWrapper<Scp079Camera>

IWorldSpace

IPosition

IRotation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

Base

Gets the base PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera.

public Scp079Camera Base { get; }

Property Value

Scp079Camera

GameObject

Gets the camera's UnityEngine.GameObject.

public GameObject GameObject { get; }

Property Value

GameObject

Id

Gets the camera's id.

public ushort Id { get; }

Property Value

ushort

IsBeingUsed

Gets or sets a value indicating whether this camera is being used by SCP-079.

public bool IsBeingUsed { get; set; }

Property Value

bool

List

Gets a IEnumerable<T> of Camera which contains all the Camera instances.

public static IReadOnlyCollection<Camera> List { get; }

Property Value

IReadOnlyCollection<Camera>

Name

Gets the camera's name.

public string Name { get; }

Property Value

string

Position

Gets the camera's position.

public Vector3 Position { get; }

Property Value

Vector3

Random

Gets a random Camera.

public static Camera Random { get; }

Property Value

Camera

Camera object.

Room

Gets the generator's Room.

public Room Room { get; }

Property Value

Room

Rotation

Gets or sets the camera's rotation.

public Quaternion Rotation { get; set; }

Property Value

Quaternion

Transform

Gets the camera's UnityEngine.Transform.

public Transform Transform { get; }

Property Value

Transform

Type

Gets the camera's CameraType.

public CameraType Type { get; }

Property Value

CameraType

Zone

Gets the camera's ZoneType.

public ZoneType Zone { get; }

Property Value

ZoneType

Zoom

Gets the value of the Camera zoom.

public float Zoom { get; }

Property Value

float

Methods

Get(CameraType)

Gets a Camera given the specified cameraType.

public static Camera Get(CameraType cameraType)

Parameters

cameraType CameraType

The CameraType to search for.

Returns

Camera

The Camera with the given CameraType or null if not found.

Get(Scp079Camera)

Gets the Camera belonging to the PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera, if any.

public static Camera Get(Scp079Camera camera079)

Parameters

camera079 Scp079Camera

The base PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera.

Returns

Camera

A Camera or null if not found.

Get(IEnumerable<Scp079Camera>)

Gets a IEnumerable<T> of Camera which contains all the Camera instances given a IEnumerable<T> of PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera.

public static IEnumerable<Camera> Get(IEnumerable<Scp079Camera> cameras)

Parameters

cameras IEnumerable<Scp079Camera>

The IEnumerable<T> of PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera.

Returns

IEnumerable<Camera>

A IEnumerable<T> of Camera.

Get(Func<Camera, bool>)

Gets a IEnumerable<T> of Camera filtered based on a predicate.

public static IEnumerable<Camera> Get(Func<Camera, bool> predicate)

Parameters

predicate Func<Camera, bool>

The condition to satify.

Returns

IEnumerable<Camera>

A IEnumerable<T> of Camera which contains elements that satify the condition.

Get(string)

Gets a Camera given the specified cameraName.

public static Camera Get(string cameraName)

Parameters

cameraName string

The name of the camera.

Returns

Camera

The Camera or null if not found.

Get(uint)

Gets a Camera given the specified cameraId.

public static Camera Get(uint cameraId)

Parameters

cameraId uint

The camera id to be searched for.

Returns

Camera

The Camera with the given id or null if not found.

ToString()

Returns the Camera in a human-readable format.

public override string ToString()

Returns

string

A string containing Camera-related data.

TryGet(CameraType, out Camera)

Gets a Camera given the specified cameraType.

public static bool TryGet(CameraType cameraType, out Camera result)

Parameters

cameraType CameraType

The CameraType to search for.

result Camera

The Camera with the given CameraType.

Returns

bool

true if Camera is not null, or false if Camera is null.

TryGet(Scp079Camera, out Camera)

Gets the Camera belonging to the PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera, if any.

public static bool TryGet(Scp079Camera camera, out Camera result)

Parameters

camera Scp079Camera

The base PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera.

result Camera

The instance of Camera which PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera base.

Returns

bool

true if Camera is not null, or false if Camera is null.

TryGet(IEnumerable<Scp079Camera>, out IEnumerable<Camera>)

Get a IEnumerable<T> of Camera which contains all the Camera instance given a IEnumerable<T> of PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera.

public static bool TryGet(IEnumerable<Scp079Camera> cameras, out IEnumerable<Camera> result)

Parameters

cameras IEnumerable<Scp079Camera>

the IEnumerable<T> of PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera.

result IEnumerable<Camera>

return a IEnumerable<T> of Camera, it's can be valid, or null, depending if PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera it's null or not.

Returns

bool

a bool result if return sequence contain valid element.

TryGet(Func<Camera, bool>, out IEnumerable<Camera>)

Gets a IEnumerable<T> of Camera filtered based on a predicate.

public static bool TryGet(Func<Camera, bool> predicate, out IEnumerable<Camera> result)

Parameters

predicate Func<Camera, bool>

The condition to satify.

result IEnumerable<Camera>

A IEnumerable<T> of Camera which contains elements that satify the condition.

Returns

bool

true if Camera is not null, or false if Camera is null.

TryGet(string, out Camera)

Gets a Camera given the specified cameraName.

public static bool TryGet(string cameraName, out Camera result)

Parameters

cameraName string

The name of the camera.

result Camera

The Camera, if cameraName is valid.

Returns

bool

true if Camera is not null, or false if Camera is null.

TryGet(uint, out Camera)

Gets a Camera given the specified cameraId.

public static bool TryGet(uint cameraId, out Camera result)

Parameters

cameraId uint

The id camera to be shearch.

result Camera

the result of Camera, if cameraId is valid.

Returns

bool

true if Camera is not null, or false if Camera is null.