Class Lift

Namespace

Exiled.API.Features

Assembly

Exiled.API.dll

The in-game lift.

public class Lift : IWrapper<ElevatorChamber>, IWorldSpace, IPosition, IRotation

Inheritance

object

Lift

Implements

IWrapper<ElevatorChamber>

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

AnimationTime

Gets or sets the AnimationTime.

public float AnimationTime { get; set; }

Property Value

float

Base

Gets the base Interactables.Interobjects.ElevatorChamber.

public ElevatorChamber Base { get; }

Property Value

ElevatorChamber

Bounds

Gets the UnityEngine.Bounds representing the space inside the lift.

public Bounds Bounds { get; }

Property Value

Bounds

CurrentDestination

Gets the CurrentDestination.

public ElevatorDoor CurrentDestination { get; }

Property Value

ElevatorDoor

CurrentLevel

Gets the CurrentLevel.

public int CurrentLevel { get; }

Property Value

int

DoorCloseTime

Gets the DoorCloseTime.

public float DoorCloseTime { get; }

Property Value

float

DoorOpenTime

Gets the DoorOpenTime.

public float DoorOpenTime { get; }

Property Value

float

Doors

Gets a value of the internal doors list.

public IReadOnlyCollection<ElevatorDoor> Doors { get; }

Property Value

IReadOnlyCollection<ElevatorDoor>

GameObject

Gets the UnityEngine.GameObject of the lift.

public GameObject GameObject { get; }

Property Value

GameObject

Group

Gets the Interactables.Interobjects.ElevatorGroup.

public ElevatorGroup Group { get; }

Property Value

ElevatorGroup

IsLocked

Gets a value indicating whether the lift is locked.

public bool IsLocked { get; }

Property Value

bool

IsMoving

Gets a value indicating whether the lift is currently moving.

public bool IsMoving { get; }

Property Value

bool

IsOperative

Gets a value indicating whether the lift is operative.

public bool IsOperative { get; }

Property Value

bool

List

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

public static IReadOnlyCollection<Lift> List { get; }

Property Value

IReadOnlyCollection<Lift>

MoveTime

Gets the total MoveTime.

public float MoveTime { get; }

Property Value

float

Name

Gets the lift's name.

public string Name { get; }

Property Value

string

Players

Gets a IEnumerable<T> of Player in the Room.

public IEnumerable<Player> Players { get; }

Property Value

IEnumerable<Player>

Position

Gets or sets the lift's position.

public Vector3 Position { get; set; }

Property Value

Vector3

Random

Gets a random Lift.

public static Lift Random { get; }

Property Value

Lift

Lift object.

Rotation

Gets or sets the lift's rotation.

public Quaternion Rotation { get; set; }

Property Value

Quaternion

RotationTime

Gets the RotationTime.

public float RotationTime { get; }

Property Value

float

Status

Gets or sets the lift's Interactables.Interobjects.ElevatorChamber status.

public ElevatorChamber.ElevatorSequence Status { get; set; }

Property Value

ElevatorChamber.ElevatorSequence

Transform

Gets the lift's UnityEngine.Transform.

public Transform Transform { get; }

Property Value

Transform

Type

Gets the lift's ElevatorType.

public ElevatorType Type { get; }

Property Value

ElevatorType

Methods

ChangeLock(DoorLockReason)

Changes lock of the lift.

public void ChangeLock(DoorLockReason lockReason)

Parameters

lockReason DoorLockReason

Type of lift lockdown.

~Lift()

Finalizes an instance of the Lift class.

protected ~Lift()

Get(ElevatorType)

Gets the Lift corresponding to the specified ElevatorType, if any.

public static Lift Get(ElevatorType type)

Parameters

type ElevatorType

The ElevatorType.

Returns

Lift

A Lift or null if not found.

Get(ElevatorChamber)

Gets the Lift belonging to the Interactables.Interobjects.ElevatorChamber, if any.

public static Lift Get(ElevatorChamber elevator)

Parameters

elevator ElevatorChamber

The Interactables.Interobjects.ElevatorChamber instance.

Returns

Lift

A Lift or null if not found.

Get(ElevatorSequence)

Gets a IEnumerable<T> of Lift which contains all the Lift instances from the specified Status.

public static IEnumerable<Lift> Get(ElevatorChamber.ElevatorSequence status)

Parameters

status ElevatorChamber.ElevatorSequence

The specified Interactables.Interobjects.ElevatorChamber.

Returns

IEnumerable<Lift>

A Lift or null if not found.

Get(ElevatorGroup)

Gets the Lift corresponding to the specified Interactables.Interobjects.ElevatorGroup, if any.

public static Lift Get(ElevatorGroup type)

Parameters

type ElevatorGroup

The Interactables.Interobjects.ElevatorGroup.

Returns

Lift

A Lift or null if not found.

Get(Func<Lift, bool>)

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

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

Parameters

predicate Func<Lift, bool>

The condition to satify.

Returns

IEnumerable<Lift>

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

Get(string)

Gets the Lift corresponding to the specified name, if any.

public static Lift Get(string name)

Parameters

name string

The lift's name.

Returns

Lift

A Lift or null if not found.

Get(GameObject)

Gets the Lift belonging to the UnityEngine.GameObject, if any.

public static Lift Get(GameObject gameObject)

Parameters

gameObject GameObject

The UnityEngine.GameObject.

Returns

Lift

A Lift or null if not found.

Get(Vector3)

Gets the Lift belonging to the UnityEngine.Vector3, if any.

public static Lift Get(Vector3 position)

Parameters

position Vector3

The UnityEngine.Vector3.

Returns

Lift

A Lift or null if not found.

IsInElevator(Vector3)

Returns whether the provided position is inside the lift.

public bool IsInElevator(Vector3 point)

Parameters

point Vector3

The position.

Returns

bool

true if the point is inside the elevator. Otherwise, false.

ToString()

Returns the Lift in a human-readable format.

public override string ToString()

Returns

string

A string containing Lift-related data.

TryMeltPlayer(Player)

Tries to melt a Player.

public static bool TryMeltPlayer(Player player)

Parameters

player Player

The Player to melt.

Returns

bool

true if the player was melted successfully; otherwise, false.

See Also

EnableEffect(EffectType, float, bool)

TryStart(int, bool)

Tries to start the lift.

public void TryStart(int level, bool allowQueueing = false)

Parameters

level int

The destination level.

allowQueueing bool

Allowing queing.