Area()

Representation of an in game area See the Area guide for documentation on how to actually build areas.

new Area()
Area.js, line 24

Properties:
Name Type Description
bundle string

Bundle this area comes from
name string
title string
script string

A custom script for this item
map Map

a Map object keyed by the floor z-index, each floor is an array with [x][y] indexes for coordinates.
rooms Map.<string, Room>

Map of room id to Room
npcs Set.<Npc>

Active NPCs that originate from this area. Note: this is NPCs that originate from this area. An NPC may not actually be in this area at any given moment.
info Object

Area configuration
lastRespawnTick Number

milliseconds since last respawn tick. See Area#update

Extends

Members

areaPath
Area.js, line 46

Get ranvier-root-relative path to this area

floors
Area.js, line 54

Get an ordered list of floors in this area's map

Methods

addNpc(npc)
Area.js, line 133

Parameters:
Name Type Description
npc Npc

addRoom(room)
Area.js, line 71

Parameters:
Name Type Description
room Room
Fires:

addRoomToMap(room)
Area.js, line 103

Parameters:
Name Type Description
room Room
Throws:

Error

getBroadcastTargets() → {Array.<Broadcastable>}
Area.js, line 193

Get all possible broadcast targets within an area. This includes all npcs, players, rooms, and the area itself

Returns:
Array.<Broadcastable>

getRoomAtCoordinates(x, y, z) → {Room|boolean}
Area.js, line 125

find a room at the given coordinates for this area

Parameters:
Name Type Description
x number
y number
z number
Returns:
Room | boolean

getRoomById(id) → {Room|undefined}
Area.js, line 63

Parameters:
Name Type Description
id string

Room id
Returns:
Room | undefined

removeNpc(npc)
Area.js, line 141

Removes an NPC from the area. NOTE: This must manually remove the NPC from its room as well

Parameters:
Name Type Description
npc Npc

removeRoom(room)
Area.js, line 89

Parameters:
Name Type Description
room Room
Fires:

update(state)
Area.js, line 154

This method is automatically called every N milliseconds where N is defined in the setInterval call to GameState.AreaMAnager.tickAll in the ranvier executable. It, in turn, will fire the updateTick event on all its rooms and npcs

Parameters:
Name Type Description
state GameState
Fires:

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:

roomAdded
Area.js, line 78

Parameters:
Name Type Description
room Room

roomRemoved
Area.js, line 92

Parameters:
Name Type Description
room Room

updateTick
AreaManager.js, line 55

See: