BBPGlue.API.BBPElevator Class Reference

Represents an elevator in the level, exposing state, doors, and control methods. More...

Public Member Functions
	BBPElevator (object? raw)
	Initializes a new instance of the BBPElevator class wrapping a raw object.
void	ButtonPressed ()
	Triggers the elevator's button pressed behavior.
void	CloseGate ()
	Closes the elevator gate.
void	OpenDoor (bool open)
	Opens or closes the elevator door.
void	OpenGate ()
	Opens the elevator gate.
void	PrepareForExit ()
	Prepares the elevator for an exit sequence.
void	PrepareToClose ()
	Prepares the elevator to close its doors.
void	SetState (object state)
	Sets the elevator's state in its state machine.
void	StateUpdate ()
	Performs a state update on the elevator's state machine.

Properties
object?	ColliderGroup [get]
	Gets the collider group object associated with this elevator.
object?	CurrentState [get]
	Gets the current state object of the elevator state machine.
BBPDoor	Door [get]
	Gets the door object attached to the elevator.
bool	Exists [get]
	Determines whether the underlying raw object exists.
bool	GateIsOpen [get]
	Gets whether the elevator gate is currently open.
bool	IsSpawn [get, set]
	Gets or sets whether this elevator is a spawn point.
bool	LobbyBlocksNpcs [get]
	Gets whether the elevator lobby blocks NPC movement.
Vector3	Position [get]
	Gets the world position of the elevator.
bool	Powered [get]
	Gets whether the elevator is currently powered.
object?	Raw [get]
	The raw underlying elevator object wrapped by this API class, or null if none.

Detailed Description

Represents an elevator in the level, exposing state, doors, and control methods.

Constructor & Destructor Documentation

BBPElevator()

BBPGlue.API.BBPElevator.BBPElevator

(

object?

raw

)

Initializes a new instance of the BBPElevator class wrapping a raw object.

Parameters

raw	The raw underlying object instance or null.

Member Function Documentation

ButtonPressed()

void BBPGlue.API.BBPElevator.ButtonPressed

(

)

Triggers the elevator's button pressed behavior.

CloseGate()

void BBPGlue.API.BBPElevator.CloseGate

(

)

Closes the elevator gate.

OpenDoor()

void BBPGlue.API.BBPElevator.OpenDoor

(

bool

open

)

Opens or closes the elevator door.

Parameters

open	True to open the door; false to close.

OpenGate()

void BBPGlue.API.BBPElevator.OpenGate

(

)

Opens the elevator gate.

PrepareForExit()

void BBPGlue.API.BBPElevator.PrepareForExit

(

)

Prepares the elevator for an exit sequence.

PrepareToClose()

void BBPGlue.API.BBPElevator.PrepareToClose

(

)

Prepares the elevator to close its doors.

SetState()

void BBPGlue.API.BBPElevator.SetState

(

object

state

)

Sets the elevator's state in its state machine.

Parameters

state

The state object to set.

StateUpdate()

void BBPGlue.API.BBPElevator.StateUpdate

(

)

Performs a state update on the elevator's state machine.

Property Documentation

ColliderGroup

object? BBPGlue.API.BBPElevator.ColliderGroup

get

Gets the collider group object associated with this elevator.

Returns

The collider group object or null.

CurrentState

object? BBPGlue.API.BBPElevator.CurrentState

get

Gets the current state object of the elevator state machine.

Returns

The current state object or null.

Door

BBPDoor BBPGlue.API.BBPElevator.Door

get

Gets the door object attached to the elevator.

Returns

A BBPDoor instance.

Exists

bool BBPGlue.API.BBPElevator.Exists

get

Determines whether the underlying raw object exists.

GateIsOpen

bool BBPGlue.API.BBPElevator.GateIsOpen

get

Gets whether the elevator gate is currently open.

Returns

True if the gate is open; otherwise false.

IsSpawn

bool BBPGlue.API.BBPElevator.IsSpawn

getset

Gets or sets whether this elevator is a spawn point.

Returns

True if it is a spawn; otherwise false.

LobbyBlocksNpcs

bool BBPGlue.API.BBPElevator.LobbyBlocksNpcs

get

Gets whether the elevator lobby blocks NPC movement.

Returns

True if the lobby blocks NPCs; otherwise false.

Position

Vector3 BBPGlue.API.BBPElevator.Position

get

Gets the world position of the elevator.

Returns

The position as a Vector3.

Powered

bool BBPGlue.API.BBPElevator.Powered

get

Gets whether the elevator is currently powered.

Returns

True if powered; otherwise false.

Raw

object? BBPGlue.API.BBPElevator.Raw

get

The raw underlying elevator object wrapped by this API class, or null if none.

---

The documentation for this class was generated from the following file:

• BBPElevator.cs