​

World Maps

​

Members

• configure
• getAdjacentMaps
• getAllMaps
• getLocalPosition
• getMapByWorldCoordinates
• getMapInfo
• getWorldPosition
• removeMap

​

configure

• Source: packages/common/src/rooms/WorldMaps.ts
• Kind: method
• Defined in: WorldMapsManager

​

Signature

configure(configs: WorldMapConfig[])

​

Parameters

• configs: WorldMapConfig[]

​

Examples

const worldMaps = new WorldMapsManager();
worldMaps.configure([
  { id: "town", worldX: 0, worldY: 0, width: 1024, height: 768 },
  { id: "forest", worldX: 1024, worldY: 0, width: 1024, height: 768 }
]);

​

getAdjacentMaps

• PositionBox: collect maps intersecting the given box
• Direction: collect maps adjacent in the given direction
• Point: collect the map containing the given world point

• Source: packages/common/src/rooms/WorldMaps.ts
• Kind: method
• Defined in: WorldMapsManager

​

Signature

getAdjacentMaps(map: WorldMapSource, search: | { minX: number; minY: number; maxX: number; maxY: number }
      | { x: number; y: number }
      | number): WorldMapInfo[]

​

Parameters

• map: WorldMapSource
• search: | { minX: number; minY: number; maxX: number; maxY: number } | { x: number; y: number } | number

​

Returns

​

Examples

// Point
world.getAdjacentMaps(currentMap, { x: 1024, y: 0 });

// Direction
world.getAdjacentMaps(currentMap, Direction.Up);

// Box
world.getAdjacentMaps(currentMap, { minX: 0, minY: 0, maxX: 2048, maxY: 1024 });

​

getAllMaps

• Source: packages/common/src/rooms/WorldMaps.ts
• Kind: method
• Defined in: WorldMapsManager

​

Signature

getAllMaps(): WorldMapInfo[]

​

Returns

​

getLocalPosition

• Source: packages/common/src/rooms/WorldMaps.ts
• Kind: method
• Defined in: WorldMapsManager

​

Signature

getLocalPosition(worldX: number, worldY: number, targetMap: WorldMapInfo): {x: number, y: number}

​

Parameters

• worldX: number
• worldY: number
• targetMap: WorldMapInfo

​

Returns

​

getMapByWorldCoordinates

• Source: packages/common/src/rooms/WorldMaps.ts
• Kind: method
• Defined in: WorldMapsManager

​

Signature

getMapByWorldCoordinates(worldX: number, worldY: number): WorldMapInfo | null

​

Parameters

• worldX: number
• worldY: number

​

Returns

​

getMapInfo

• Source: packages/common/src/rooms/WorldMaps.ts
• Kind: method
• Defined in: WorldMapsManager

​

Signature

getMapInfo(mapId: string): WorldMapInfo | null

​

Parameters

• mapId: string

​

Returns

​

Examples

const mapInfo = worldMaps.getMapInfo("forest");

​

getWorldPosition

• Source: packages/common/src/rooms/WorldMaps.ts
• Kind: method
• Defined in: WorldMapsManager

​

Signature

getWorldPosition(map: WorldMapInfo, localX: number, localY: number): {x: number, y: number}

​

Parameters

• map: WorldMapInfo
• localX: number
• localY: number

​

Returns

​

removeMap

• Source: packages/common/src/rooms/WorldMaps.ts
• Kind: method
• Defined in: WorldMapsManager

​

Signature

removeMap(mapId: string): boolean

​

Parameters

• mapId: string

​

Returns

​

Examples

const removed = world.removeMap("forest");