Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WorldPattern

Patterns added to a World, which are used to automatically match maps. See the Using Pattern Matching section in the manual for more information.

since

1.11

Hierarchy

  • WorldPattern

Index

Constructors

constructor

Properties

mapSize

mapSize: size

The size of the map in pixels.

Used to support showing only directly neighboring maps when a world is loaded. For more information, see the Showing Only Direct Neighbors section in the manual.

multiplierX

multiplierX: number

Multiplied by the first number (x) in the regular expression to determine the map's position in the world.

multiplierY

multiplierY: number

Multiplied by the second number (y) in the regular expression to determine the map's position in the world.

offset

offset: point

After calculating the map's position in the world using x and y in its regular expression and the associated multipliers, this offset is added to determine the final position.

regExp

regExp: RegExp

The regular expression pattern used to match maps in the world.

Generated using TypeDoc