Represents a door in the environment and exposes its state and control methods. More...

Public Member Functions
	BBPDoor (object? raw)
	Initializes a new instance of the BBPDoor class wrapping a raw object.
void	Block (bool block)
	Sets whether the door blocks passage.
object?	CellOnOtherSide (object room)
	Gets the cell object on the other side of the door relative to the given room.
void	Initialize ()
	Initializes the door by invoking the underlying Initialize method.
void	Lock (bool cancelTimer=true)
	Locks the door.
void	LockTimed (float time)
	Locks the door for a timed duration.
void	Open (bool cancelTimer=true, bool makeNoise=true)
	Opens the door, optionally canceling any open timer and producing noise.
void	OpenSilent (bool cancelTimer=true)
	Opens the door silently by not producing noise.
void	OpenTimed (float time, bool makeNoise=true)
	Opens the door for a timed duration.
object?	OtherSideDirectedIntVector2 (object room)
	Returns a directed integer vector describing the tile coordinates on the other side of the door.
void	Shut ()
	Shuts the door immediately.
void	Toggle (bool cancelTimer=true, bool makeNoise=true)
	Toggles the door's open/closed state.
void	UnInitialize ()
	Uninitializes the door by invoking the underlying UnInitialize method.
void	Unlock ()
	Unlocks the door.

Properties
bool	CloseBlocks `[get, set]`
	Gets or sets whether closing the door blocks passage.
bool	Exists `[get]`
	Determines whether the underlying raw object exists.
bool	IsOpen `[get]`
	Gets whether the door is currently open according to the underlying property.
bool	LockBlocks `[get, set]`
	Gets or sets whether locking the door blocks passage.
bool	Locked `[get, set]`
	Gets or sets whether the door is locked.
bool	MakesNoise `[get, set]`
	Gets or sets whether the door makes noise when operated.
int	NoiseValue `[get, set]`
	Gets or sets the noise value produced by the door when operated.
bool	OpenState `[get, set]`
	Gets or sets the raw open state flag for the door.
Vector3	Position `[get]`
	Gets the world position of the door.
object?	Raw `[get]`
	The raw underlying door object wrapped by this API class, or null if none.

Detailed Description

Represents a door in the environment and exposes its state and control methods.

Constructor & Destructor Documentation

◆ BBPDoor()

BBPGlue.API.BBPDoor.BBPDoor ( object? raw )

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

Parameters

raw	The raw underlying object instance or null.

Member Function Documentation

◆ Block()

void BBPGlue.API.BBPDoor.Block ( bool block )

Sets whether the door blocks passage.

Parameters

block True to block; false to unblock.

◆ CellOnOtherSide()

object? BBPGlue.API.BBPDoor.CellOnOtherSide ( object room )

Gets the cell object on the other side of the door relative to the given room.

Parameters

room	The room to consider as the reference side.

Returns: The cell object on the other side or null.

◆ Initialize()

void BBPGlue.API.BBPDoor.Initialize ( )

Initializes the door by invoking the underlying Initialize method.

◆ Lock()

void BBPGlue.API.BBPDoor.Lock ( bool cancelTimer = true )

Locks the door.

Parameters

cancelTimer Whether to cancel any existing timer when locking.

◆ LockTimed()

void BBPGlue.API.BBPDoor.LockTimed ( float time )

Locks the door for a timed duration.

Parameters

time	Duration in seconds to lock the door.

◆ Open()

void BBPGlue.API.BBPDoor.Open	(	bool	cancelTimer = true,
		bool	makeNoise = true )

Opens the door, optionally canceling any open timer and producing noise.

Parameters

cancelTimer	Whether to cancel the open timer.
makeNoise	Whether opening should make noise.

◆ OpenSilent()

void BBPGlue.API.BBPDoor.OpenSilent ( bool cancelTimer = true )

Opens the door silently by not producing noise.

Parameters

cancelTimer Whether to cancel the open timer.

◆ OpenTimed()

void BBPGlue.API.BBPDoor.OpenTimed	(	float	time,
		bool	makeNoise = true )

Opens the door for a timed duration.

Parameters

time	Duration in seconds to keep the door open.
makeNoise	Whether opening should make noise.

◆ OtherSideDirectedIntVector2()

object? BBPGlue.API.BBPDoor.OtherSideDirectedIntVector2 ( object room )

Returns a directed integer vector describing the tile coordinates on the other side of the door.

Parameters

room	The room to consider as the reference side.

Returns: An object representing integer vector coordinates or null.

◆ Shut()

void BBPGlue.API.BBPDoor.Shut ( )

Shuts the door immediately.

◆ Toggle()

void BBPGlue.API.BBPDoor.Toggle	(	bool	cancelTimer = true,
		bool	makeNoise = true )

Toggles the door's open/closed state.

Parameters

cancelTimer	Whether to cancel any existing timer.
makeNoise	Whether the action should make noise.

◆ UnInitialize()

void BBPGlue.API.BBPDoor.UnInitialize ( )

Uninitializes the door by invoking the underlying UnInitialize method.

◆ Unlock()

void BBPGlue.API.BBPDoor.Unlock ( )

Unlocks the door.

Property Documentation

◆ CloseBlocks

bool BBPGlue.API.BBPDoor.CloseBlocks

getset

Gets or sets whether closing the door blocks passage.

Returns: True if closing blocks passage; otherwise false.

◆ Exists

bool BBPGlue.API.BBPDoor.Exists

get

Determines whether the underlying raw object exists.

◆ IsOpen

bool BBPGlue.API.BBPDoor.IsOpen

get

Gets whether the door is currently open according to the underlying property.

Returns: True if open; otherwise false.

◆ LockBlocks

bool BBPGlue.API.BBPDoor.LockBlocks

getset

Gets or sets whether locking the door blocks passage.

Returns: True if locking blocks passage; otherwise false.

◆ Locked

bool BBPGlue.API.BBPDoor.Locked

getset

Gets or sets whether the door is locked.

Returns: True if locked; otherwise false.

◆ MakesNoise

bool BBPGlue.API.BBPDoor.MakesNoise

getset

Gets or sets whether the door makes noise when operated.

Returns: True if it makes noise; otherwise false.

◆ NoiseValue

int BBPGlue.API.BBPDoor.NoiseValue

getset

Gets or sets the noise value produced by the door when operated.

Returns: The noise value as an integer.

◆ OpenState

bool BBPGlue.API.BBPDoor.OpenState

getset

Gets or sets the raw open state flag for the door.

Returns: True if open; otherwise false.

◆ Position

Vector3 BBPGlue.API.BBPDoor.Position

get

Gets the world position of the door.

Returns: The position as a Vector3.

◆ Raw

object? BBPGlue.API.BBPDoor.Raw

get

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

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

BBPDoor.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ BBPDoor()

Member Function Documentation

◆ Block()

◆ CellOnOtherSide()

◆ Initialize()

◆ Lock()

◆ LockTimed()

◆ Open()

◆ OpenSilent()

◆ OpenTimed()

◆ OtherSideDirectedIntVector2()

◆ Shut()

◆ Toggle()

◆ UnInitialize()

◆ Unlock()

Property Documentation

◆ CloseBlocks

◆ Exists

◆ IsOpen

◆ LockBlocks

◆ Locked

◆ MakesNoise

◆ NoiseValue

◆ OpenState

◆ Position

◆ Raw