Door

const Door: object

Defined in: server/api.d.ts:1818

Controls native world doors (building, shop and apartment doors) by door id: their synchronized open and lock state, and whether players can interact with them. A door id is the door’s baked frame hash as a “0x”-prefixed hex string; getCatalog lists every base-game door with its id, and the doorInteract event reports it whenever a player uses a door. Door state is kept per virtual world: a player only sees and changes the doors of their own world, so one interior can serve several worlds. The server-wide interaction default applies to every world.

Type Declaration

getCatalog()

getCatalog(): DoorInfo[]

Lists every door of the base game: building, shop and apartment doors, gates, and also cabinets, fridges and windows, which the game builds the same way.

Returns

DoorInfo[]

Every catalogued door.

getDefaultInteractionEnabled()

getDefaultInteractionEnabled(): boolean | null

Returns the server-wide door interaction default.

Returns

boolean | null

True or false when forced, null when doors are left as the game sets them up.

getInteractionEnabled()

getInteractionEnabled(doorId, virtualWorld?): boolean | null

Returns a door’s own interaction override in a virtual world.

Parameters

doorId

string

Door id, a “0x”-prefixed hex string as reported by doorInteract.

virtualWorld?

number

Virtual world whose door state to use; 0 when omitted.

Returns

boolean | null

True or false when the door is overridden, null when it follows the server-wide default.

getState()

getState(doorId, virtualWorld?): DoorState

Returns the synchronized state of a door in a virtual world. A door whose state the server does not force follows the game’s own state (some doors stay locked in freeride) and reads closed and unlocked.

Parameters

doorId

string

Door id, a “0x”-prefixed hex string as reported by doorInteract.

virtualWorld?

number

Virtual world whose door state to use; 0 when omitted.

Returns

DoorState

The door’s synchronized state.

reset()

reset(doorId, virtualWorld?): void

Drops every override on a door in a virtual world: the door returns to the game’s own state, and its interaction follows the server-wide default again.

Parameters

doorId

string

Door id, a “0x”-prefixed hex string as reported by doorInteract.

virtualWorld?

number

Virtual world whose door state to use; 0 when omitted.

Returns

void

setDefaultInteractionEnabled()

setDefaultInteractionEnabled(enabled): void

Sets the server-wide interaction default for every door without its own override, in every virtual world.

Parameters

enabled

boolean | null

True to enable every door, false to disable every door, null to leave each door as the game sets it up.

Returns

void

setInteractionEnabled()

setInteractionEnabled(doorId, enabled, virtualWorld?): boolean

Overrides whether players in a virtual world can open, kick, lock or lockpick a door. A door with interaction disabled still follows setState.

Parameters

doorId

string

Door id, a “0x”-prefixed hex string as reported by doorInteract.

enabled

boolean | null

True to let players use the door, including doors the game’s own scripts keep disabled; false to remove its prompt; null to follow the server-wide default.

virtualWorld?

number

Virtual world whose door state to use; 0 when omitted.

Returns

boolean

False when the world’s door registry is full.

setState()

setState(doorId, open, locked?, virtualWorld?): boolean

Forces a door open or closed, locked or unlocked, for every player in the virtual world, including players who stream it in or enter the world later. The forced state holds until reset, including over doors the game keeps locked.

Parameters

doorId

string

Door id, a “0x”-prefixed hex string as reported by doorInteract.

open

boolean

True to swing the door open, false to close it.

locked?

boolean

Lock state; keeps the current lock state when omitted.

virtualWorld?

number

Virtual world whose door state to use; 0 when omitted.

Returns

boolean

False when the world’s door registry is full (256 doors that differ from their default).