Wrld.map.indoors

function onEnter(event) {
    console.log("Entered indoor map: " + event.indoorMap.getIndoorMapName());
}

function onExit(event) {
    console.log("Exited indoor map");
}
map.indoors.on("indoormapenter", onEnter);
map.indoors.on("indoormapexit", onExit)

Methods

map.indoors.isIndoors()

Returns a boolean indicating whether an indoor map is currently being viewed.

map.indoors.enter(indoorMap, config)

Move the camera into an indoor map.

Config

map.indoors.exit()

When viewing an indoor map, exits back to the exterior view.

map.indoors.getActiveIndoorMap()

Returns the IndoorMap currently being viewed, or null if not viewing an indoor map at all.

map.indoors.getFloor()

Returns an IndoorMapFloor representing the current floor of the active indoor map, or null if not viewing an indoor map.

map.indoors.setFloor(floor)

Sets the current floor to display within the active indoor map. Returns a boolean indicating whether the floor was successfully set.

map.indoors.moveUp(numberOfFloors)

View a floor some number of floors above than the current floor.

map.indoors.moveDown(numberOfFloors)

View a floor some number of floors below than the current floor.

map.indoors.expand()

Transition to an expanded view of the indoor map, showing all floors.

map.indoors.collapse()

When expanded, transition back to the normal, collapsed view of an indoor map.

map.indoors.setFloorInterpolation(value)

When expanded, can be used to smoothly interpolate between the floors in view. A value of 0 will put the bottom floor in focus, while a value of 1 will put the top floor in focus.

map.indoors.getFloorInterpolation()

Returns the current floor interpolation value.

map.indoors.setFloorFromInterpolation(interpolationValue)

Sets the current floor based on some interpolation value by rounding to the nearest floor. Returns a boolean indicating success, as in setFloor().

map.indoors.setEntityHighlights(ids, color)

Highlights one or more indoor entities with the specified color and border thickness. Note: Border thickness only applies to area highlights.

map.indoors.clearEntityHighlights(ids)

Clears the highlights from one or more indoor entities. If no ids are specified then all highlighted entities will be cleared.

map.indoors.tryGetReadableName(indoorMapId)

Returns the human-readable display name of an indoor map, or null if the value was unable to be obtained. Null may be returned if the specified indoor map is not currently loaded by the map streaming system.

map.indoors.tryGetFloorReadableName(indoorMapId, indoorMapFloorId)

Returns the human-readable display name of an indoor map floor, or null if the value was unable to be obtained. Null may be returned if the specified indoor map is not currently loaded by the map streaming system, or if the specified floor id does not exist on that indoor map.

map.indoors.tryGetFloorShortName(indoorMapId, indoorMapFloorId)

Returns the abbreviated human-readable display name of an indoor map floor, or null if the value was unable to be obtained. Null may be returned if the specified indoor map is not currently loaded by the map streaming system, or if the specified floor id does not exist on that indoor map.

map.indoors.setBackgroundColor(backgroundColor)

Sets the color of the background overlay when displaying an indoor map.

Events

You can subscribe to events relating to indoor maps by using [events methods] on this object.

For example:

map.indoors.on("indoormapenter", function(e) {
    console.log("Entered an indoor map");
});

The following events are supported.