Room()

new Room()
Room.js, line 23

Properties:
Name Type Attributes Description
area Area

Area room is in
coordinates Object <optional>

Defined in yml with array [x, y, z]. Retrieved with coordinates.x, coordinates.y, ...
defaultItems Array.<number>

Default list of item ids that should load in this room
defaultNpcs Array.<number>

Default list of npc ids that should load in this room
description string

Room description seen on 'look'
exits Array.<object>

Exits out of this room { id: number, direction: string }
id number

Area-relative id (vnum)
items Set

Items currently in the room
npcs Set

Npcs currently in the room
players Set

Players currently in the room
script string

Name of custom script attached to this room
title string

Title shown on look/scan
doors object

Doors restricting access to this room. See documentation for format

Extends

Members

spawnedNpcs
Room.js, line 63

spawnedNpcs keeps track of NPCs even when they leave the room for the purposes of respawn. So if we spawn NPC A into the room and it walks away we don't want to respawn the NPC until it's killed or otherwise removed from the area

Methods

addItem(item)
Room.js, line 128

Parameters:
Name Type Description
item Item

addNpc(npc)
Room.js, line 107

Parameters:
Name Type Description
npc Npc

addPlayer(player)
Room.js, line 93

Parameters:
Name Type Description
player Player

closeDoor(fromRoom)
Room.js, line 269

Parameters:
Name Type Description
fromRoom Room

emit(eventName, …args) → {void}
Room.js, line 72

Emits event on self and proxies certain events to other entities in the room.

Parameters:
Name Type Attributes Description
eventName string
args * <repeatable>
Returns:
void

findExit(exitName) → {false|Object}
Room.js, line 191

Get the exit definition of a room's exit by searching the exit name

Parameters:
Name Type Description
exitName string

exit name search
Returns:
false | Object

getBroadcastTargets() → {Array.<Character>}
Room.js, line 384

Used by Broadcaster

Returns:
Array.<Character>

getDoor(fromRoom) → {Object}
Room.js, line 233

Parameters:
Name Type Description
fromRoom Room
Returns:
Object

getExits() → {Array.<{id: string, direction: string, inferred: boolean, room: Room=}>}
Room.js, line 147

Get exits for a room. Both inferred from coordinates and defined in the 'exits' property.

Returns:
Array.<{id: string, direction: string, inferred: boolean, room: Room=}>

getExitToRoom(nextRoom) → {false|Object}
Room.js, line 208

Get the exit definition of a room's exit to a given room

Parameters:
Name Type Description
nextRoom Room
Returns:
false | Object

hasDoor(fromRoom) → {boolean}
Room.js, line 225

Check to see if this room has a door preventing movement from fromRoom to here

Parameters:
Name Type Description
fromRoom Room
Returns:
boolean

isDoorLocked(fromRoom) → {boolean}
Room.js, line 245

Check to see of the door for fromRoom is locked

Parameters:
Name Type Description
fromRoom Room
Returns:
boolean

lockDoor(fromRoom)
Room.js, line 293

Parameters:
Name Type Description
fromRoom Room

openDoor(fromRoom)
Room.js, line 257

Parameters:
Name Type Description
fromRoom Room

removeItem(item)
Room.js, line 136

Parameters:
Name Type Description
item Item

removeNpc(npc, removeSpawn)
Room.js, line 117

Parameters:
Name Type Default Description
npc Npc
removeSpawn boolean false

removePlayer(player)
Room.js, line 100

Parameters:
Name Type Description
player Player

spawnItem(state, entityRef) → {Item}
Room.js, line 308

Parameters:
Name Type Description
state GameState
entityRef string
Returns:
Item -

The newly created item

spawnNpc(state, entityRef) → {Npc}
Room.js, line 328

Parameters:
Name Type Description
state GameState
entityRef string
Fires:
Returns:
Npc

unlockDoor(fromRoom)
Room.js, line 281

Parameters:
Name Type Description
fromRoom Room

Events

channelReceive
Channel.js, line 92

Docs limit this to be for GameEntity (Area/Room/Item) but also applies to NPC and Player

Parameters:
Name Type Description
channel Channel
sender Character
rawMessage string
Inherited From:

npcEnter
Npc.js, line 69

Parameters:
Name Type Description
npc Npc
prevRoom Room

npcLeave
Npc.js, line 55

Parameters:
Name Type Description
npc Npc
nextRoom Room

playerEnter
Player.js, line 152

Parameters:
Name Type Description
player Player
prevRoom Room

playerLeave
Player.js, line 138

Parameters:
Name Type Description
player Player
nextRoom Room

ready
Area.js, line 180

Fires after the room is hydrated and added to its area

spawn
Room.js, line 346

Fires when the room is created but before it has hydrated its default contents. Use the ready event if you need default items to be there.

updateTick
Area.js, line 156

See: