Class Lift

The in-game lift.

Inheritance

System.Object

Lift

Implements

IWrapper<Interactables.Interobjects.ElevatorChamber>

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 Lift : IWrapper<ElevatorChamber>, IWorldSpace, IPosition, IRotation

Properties

| Improve this Doc View Source

AnimationTime

Gets or sets the AnimationTime.

Declaration

public float AnimationTime { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

Base

Gets the base Interactables.Interobjects.ElevatorChamber.

Declaration

public ElevatorChamber Base { get; }

Property Value

Type	Description
Interactables.Interobjects.ElevatorChamber

| Improve this Doc View Source

Bounds

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

Declaration

public Bounds Bounds { get; }

Property Value

Type	Description
UnityEngine.Bounds

| Improve this Doc View Source

CurrentDestination

Gets the CurrentDestination.

Declaration

public ElevatorDoor CurrentDestination { get; }

Property Value

Type	Description
ElevatorDoor

| Improve this Doc View Source

CurrentLevel

Gets the CurrentLevel.

Declaration

public int CurrentLevel { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

DoorCloseTime

Gets the DoorCloseTime.

Declaration

public float DoorCloseTime { get; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

DoorOpenTime

Gets the DoorOpenTime.

Declaration

public float DoorOpenTime { get; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

Doors

Gets a value of the internal doors list.

Declaration

public IReadOnlyCollection<ElevatorDoor> Doors { get; }

Property Value

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

| Improve this Doc View Source

GameObject

Gets the UnityEngine.GameObject of the lift.

Declaration

public GameObject GameObject { get; }

Property Value

Type	Description
UnityEngine.GameObject

| Improve this Doc View Source

Group

Gets the Interactables.Interobjects.ElevatorManager.ElevatorGroup.

Declaration

public ElevatorManager.ElevatorGroup Group { get; }

Property Value

Type	Description
Interactables.Interobjects.ElevatorManager.ElevatorGroup

| Improve this Doc View Source

IsLocked

Gets a value indicating whether the lift is locked.

Declaration

public bool IsLocked { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsMoving

Gets a value indicating whether the lift is currently moving.

Declaration

public bool IsMoving { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsOperative

Gets a value indicating whether the lift is operative.

Declaration

public bool IsOperative { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

List

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

Declaration

public static IReadOnlyCollection<Lift> List { get; }

Property Value

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

| Improve this Doc View Source

MoveTime

Gets the total MoveTime.

Declaration

public float MoveTime { get; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

Name

Gets the lift's name.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Players

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

Declaration

public IEnumerable<Player> Players { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Player>

| Improve this Doc View Source

Position

Gets or sets the lift's position.

Declaration

public Vector3 Position { get; set; }

Property Value

Type	Description
UnityEngine.Vector3

| Improve this Doc View Source

Random

Gets a random Lift.

Declaration

public static Lift Random { get; }

Property Value

Type	Description
Lift	Lift object.

| Improve this Doc View Source

Rotation

Gets or sets the lift's rotation.

Declaration

public Quaternion Rotation { get; set; }

Property Value

Type	Description
UnityEngine.Quaternion

| Improve this Doc View Source

RotationTime

Gets the RotationTime.

Declaration

public float RotationTime { get; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

Status

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

Declaration

public ElevatorChamber.ElevatorSequence Status { get; set; }

Property Value

Type	Description
Interactables.Interobjects.ElevatorChamber.ElevatorSequence

| Improve this Doc View Source

Transform

Gets the lift's UnityEngine.Transform.

Declaration

public Transform Transform { get; }

Property Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

Type

Gets the lift's ElevatorType.

Declaration

public ElevatorType Type { get; }

Property Value

Type	Description
ElevatorType

Methods

| Improve this Doc View Source

ChangeLock(DoorLockReason)

Changes lock of the lift.

Declaration

public void ChangeLock(DoorLockReason lockReason)

Parameters

Type	Name	Description
Interactables.Interobjects.DoorUtils.DoorLockReason	lockReason	Type of lift lockdown.

| Improve this Doc View Source

Finalize()

Finalizes an instance of the Lift class.

Declaration

protected void Finalize()

| Improve this Doc View Source

Get(ElevatorType)

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

Declaration

public static Lift Get(ElevatorType type)

Parameters

Type	Name	Description
ElevatorType	type	The ElevatorType.

Returns

Type	Description
Lift	A Lift or null if not found.

| Improve this Doc View Source

Get(ElevatorChamber)

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

Declaration

public static Lift Get(ElevatorChamber elevator)

Parameters

Type	Name	Description
Interactables.Interobjects.ElevatorChamber	elevator	The Interactables.Interobjects.ElevatorChamber instance.

Returns

Type	Description
Lift	A Lift or null if not found.

| Improve this Doc View Source

Get(ElevatorChamber.ElevatorSequence)

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

Declaration

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

Parameters

Type	Name	Description
Interactables.Interobjects.ElevatorChamber.ElevatorSequence	status	The specified Interactables.Interobjects.ElevatorChamber.

Returns

Type	Description
System.Collections.Generic.IEnumerable<Lift>	A Lift or null if not found.

| Improve this Doc View Source

Get(Func<Lift, Boolean>)

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

Declaration

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

Parameters

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

Returns

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

| Improve this Doc View Source

Get(String)

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

Declaration

public static Lift Get(string name)

Parameters

Type	Name	Description
System.String	name	The lift's name.

Returns

Type	Description
Lift	A Lift or null if not found.

| Improve this Doc View Source

Get(GameObject)

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

Declaration

public static Lift Get(GameObject gameObject)

Parameters

Type	Name	Description
UnityEngine.GameObject	gameObject	The UnityEngine.GameObject.

Returns

Type	Description
Lift	A Lift or null if not found.

| Improve this Doc View Source

Get(Vector3)

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

Declaration

public static Lift Get(Vector3 position)

Parameters

Type	Name	Description
UnityEngine.Vector3	position	The UnityEngine.Vector3.

Returns

Type	Description
Lift	A Lift or null if not found.

| Improve this Doc View Source

IsInElevator(Vector3)

Returns whether or not the provided UnityEngine.Vector3 is inside the lift.

Declaration

public bool IsInElevator(Vector3 point)

Parameters

Type	Name	Description
UnityEngine.Vector3	point	The position.

Returns

Type	Description
System.Boolean	true if the point is inside the elevator. Otherwise, false.

| Improve this Doc View Source

ToString()

Returns the Lift in a human-readable format.

Declaration

public override string ToString()

Returns

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

Overrides

System.Object.ToString()

| Improve this Doc View Source

TryMeltPlayer(Player)

Tries to melt a Player.

Declaration

public static bool TryMeltPlayer(Player player)

Parameters

Type	Name	Description
Player	player	The Player to melt.

Returns

Type	Description
System.Boolean	true if the player was melted successfully; otherwise, false.

TryStart(Int32, Boolean)

Tries to start the lift.

Declaration

public bool TryStart(int level, bool isForced = false)

Parameters

Type	Name	Description
System.Int32	level	The destination level.
System.Boolean	isForced	Indicates whether the start will be forced or not.

Returns

Type	Description
System.Boolean	true if the lift was started successfully; otherwise, false.

Implements

IWrapper<T>

IWorldSpace

IPosition

IRotation

Extension Methods

ReflectionExtensions.CopyProperties(Object, Object)