Class Camera

The in-game Scp079Camera.

Inheritance

System.Object

Camera

Implements

IWrapper<PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera>

IWorldSpace

IPosition

IRotation

Inherited Members

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

Assembly: Exiled.API.dll

Syntax

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

Properties

| Improve this Doc View Source

Base

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

Declaration

public Scp079Camera Base { get; }

Property Value

Type	Description
PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera

| Improve this Doc View Source

GameObject

Gets the camera's UnityEngine.GameObject.

Declaration

public GameObject GameObject { get; }

Property Value

Type	Description
UnityEngine.GameObject

| Improve this Doc View Source

Id

Gets the camera's id.

Declaration

public ushort Id { get; }

Property Value

Type	Description
System.UInt16

| Improve this Doc View Source

IsBeingUsed

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

Declaration

public bool IsBeingUsed { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

List

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

Declaration

public static IReadOnlyCollection<Camera> List { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyCollection<Camera>

| Improve this Doc View Source

Name

Gets the camera's name.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Position

Gets the camera's position.

Declaration

public Vector3 Position { get; }

Property Value

Type	Description
UnityEngine.Vector3

| Improve this Doc View Source

Random

Gets a random Camera.

Declaration

public static Camera Random { get; }

Property Value

Type	Description
Camera	Camera object.

| Improve this Doc View Source

Room

Gets the generator's Room.

Declaration

public Room Room { get; }

Property Value

Type	Description
Room

| Improve this Doc View Source

Rotation

Gets or sets the camera's rotation.

Declaration

public Quaternion Rotation { get; set; }

Property Value

Type	Description
UnityEngine.Quaternion

| Improve this Doc View Source

Transform

Gets the camera's UnityEngine.Transform.

Declaration

public Transform Transform { get; }

Property Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

Type

Gets the camera's CameraType.

Declaration

public CameraType Type { get; }

Property Value

Type	Description
CameraType

| Improve this Doc View Source

Zone

Gets the camera's ZoneType.

Declaration

public ZoneType Zone { get; }

Property Value

Type	Description
ZoneType

| Improve this Doc View Source

Zoom

Gets the value of the Camera zoom.

Declaration

public float Zoom { get; }

Property Value

Type	Description
System.Single

Methods

| Improve this Doc View Source

Get(CameraType)

Gets a Camera given the specified cameraType.

Declaration

public static Camera Get(CameraType cameraType)

Parameters

Type	Name	Description
CameraType	cameraType	The CameraType to search for.

Returns

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

| Improve this Doc View Source

Get(Scp079Camera)

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

Declaration

public static Camera Get(Scp079Camera camera079)

Parameters

Type	Name	Description
PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera	camera079	The base PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera.

Returns

Type	Description
Camera	A Camera or null if not found.

| Improve this Doc View Source

Get(IEnumerable<Scp079Camera>)

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

Declaration

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

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera>	cameras	The System.Collections.Generic.IEnumerable<T> of PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera.

Returns

Type	Description
System.Collections.Generic.IEnumerable<Camera>	A System.Collections.Generic.IEnumerable<T> of Camera.

| Improve this Doc View Source

Get(Func<Camera, Boolean>)

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

Declaration

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

Parameters

Type	Name	Description
System.Func<Camera, System.Boolean>	predicate	The condition to satify.

Returns

Type	Description
System.Collections.Generic.IEnumerable<Camera>	A System.Collections.Generic.IEnumerable<T> of Camera which contains elements that satify the condition.

| Improve this Doc View Source

Get(String)

Gets a Camera given the specified cameraName.

Declaration

public static Camera Get(string cameraName)

Parameters

Type	Name	Description
System.String	cameraName	The name of the camera.

Returns

Type	Description
Camera	The Camera or null if not found.

| Improve this Doc View Source

Get(UInt32)

Gets a Camera given the specified cameraId.

Declaration

public static Camera Get(uint cameraId)

Parameters

Type	Name	Description
System.UInt32	cameraId	The camera id to be searched for.

Returns

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

| Improve this Doc View Source

ToString()

Returns the Camera in a human-readable format.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string containing Camera-related data.

Overrides

System.Object.ToString()

| Improve this Doc View Source

TryGet(CameraType, out Camera)

Gets a Camera given the specified cameraType.

Declaration

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

Parameters

Type	Name	Description
CameraType	cameraType	The CameraType to search for.
Camera	result	The Camera with the given CameraType.

Returns

Type	Description
System.Boolean	true if Camera is not null, or false if Camera is null.

| Improve this Doc View Source

TryGet(Scp079Camera, out Camera)

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

Declaration

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

Parameters

Type	Name	Description
PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera	camera	The base PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera.
Camera	result	The instance of Camera which PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera base.

Returns

Type	Description
System.Boolean	true if Camera is not null, or false if Camera is null.

| Improve this Doc View Source

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

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

Declaration

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

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera>	cameras	the System.Collections.Generic.IEnumerable<T> of PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera.
System.Collections.Generic.IEnumerable<Camera>	result	return a System.Collections.Generic.IEnumerable<T> of Camera, it's can be valid, or null, depending if PlayerRoles.PlayableScps.Scp079.Cameras.Scp079Camera it's null or not.

Returns

Type	Description
System.Boolean	a bool result if return sequence contain valid element.

| Improve this Doc View Source

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

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

Declaration

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

Parameters

Type	Name	Description
System.Func<Camera, System.Boolean>	predicate	The condition to satify.
System.Collections.Generic.IEnumerable<Camera>	result	A System.Collections.Generic.IEnumerable<T> of Camera which contains elements that satify the condition.

Returns

Type	Description
System.Boolean	true if Camera is not null, or false if Camera is null.

| Improve this Doc View Source

TryGet(String, out Camera)

Gets a Camera given the specified cameraName.

Declaration

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

Parameters

Type	Name	Description
System.String	cameraName	The name of the camera.
Camera	result	The Camera, if `cameraName` is valid.

Returns

Type	Description
System.Boolean	true if Camera is not null, or false if Camera is null.

| Improve this Doc View Source

TryGet(UInt32, out Camera)

Gets a Camera given the specified cameraId.

Declaration

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

Parameters

Type	Name	Description
System.UInt32	cameraId	The id camera to be shearch.
Camera	result	the result of Camera, if `cameraId` is valid.

Returns

Type	Description
System.Boolean	true if Camera is not null, or false if Camera is null.

Implements

IWrapper<T>

IWorldSpace

IPosition

IRotation

Extension Methods

ReflectionExtensions.CopyProperties(Object, Object)