Class default

Hierarchy

  • default

Constructors

constructor

Methods

get getIsland getObfuscation has isCompleted isOfIsland randomize randomizeToIsland set setHost setIsland setObfuscation setObfuscationOf setUnplotted getMapsInContainer

Constructors

constructor

Methods

get

  • If this item is a tattered map or a drawn map, this will return its associated DrawnMap instance.

    Returns undefined | default

  • Parameters

    • clientSide: true

    Returns undefined | default | "unplotted"

getIsland

  • Returns

    the island associated with this map, if it exists

    Returns undefined | default

getObfuscation

  • Returns

    the obfuscation of the linked map, a multiplier that will be applied overtop whatever durability obfuscation there is

    Returns undefined | number

has

  • Returns boolean

isCompleted

  • Returns

    whether this map is completed

    Returns boolean

isOfIsland

  • Returns

    whether the associated map is on the current island

    Parameters

    Returns boolean

randomize

  • Randomises which map is associated with this item.

    Returns

    whether this item is now associated with a map on this island

    Parameters

    • island: default
    • chanceOfGivingCompletedMap: number = DEFAULT_ITEM_MAP_CHANCE_COMPLETED

      By default, 10% chance of becoming associated with an already-completed map.

    • chanceOfGivingMapFromOtherIsland: number = DEFAULT_ITEM_MAP_CHANCE_OTHER_ISLAND

      By default, 50% chance of, rather than becoming associated with an already-completed map, instead becoming associated with a map on another island. Note: If there are no maps on the current island, will always become associated with a map on another island regardless of chance.

    • Optional randomDecimal: number

    Returns boolean

randomizeToIsland

  • Parameters

    • islandId: `${number},${number}`
    • Optional giveCompleted: boolean
    • Optional randomDecimal: number

    Returns void

set

  • Sets the map associated with this item.

    Parameters

    • island: default

      The island containing the associated map.

    • mapId: number

      The index of the map in the island.treasureMaps array.

    Returns boolean

setHost

  • Parameters

    Returns void

setIsland

  • If the associated map is already on the given island, does nothing. If not, associates the map with a map on the given island, chosen by the given properties:

    Parameters

    • islandId: `${number},${number}`
    • completed: boolean

      Whether the associated map should be a completed one

    • randomDecimal: number

      A decimal to use to choose which map on this island to use

    Returns boolean

setObfuscation

  • If this item is linked to a map, sets the obfuscation of this instance to the given amount

    Parameters

    • amount: number

    Returns boolean

setObfuscationOf

  • Parameters

    • map: default
    • multiplier: number = 1

    Returns boolean

setUnplotted

  • Sets this map to an unlinked, unplotted map of a given position on the given island. The map will be JIT-generated, afterwards a linked map.

    Parameters

    • island: `${number},${number}`
    • position: IVector3

    Returns boolean

Static getMapsInContainer

Settings

Member Visibility

Theme

Generated using TypeDoc