Documentation - v20.0.0-dev
    Preparing search index...

    Settings of MapPlugin: whether the map is shown, how it looks, and the grid of planes its tiles are drawn on.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    icon: "helpers" = 'helpers'

    Drawn by an interface before its title.

    isCategory: boolean = false

    A category of the group holding it: drawn by an interface inside that group (e.g. the post-processing's antialiasing and ambient occlusion), which stays a group of its own even without settings of its own (a group of groups only is drawn in place, e.g. the engine's).

    isSettings: true

    Tells a group of settings from a setting, without instanceof.

    nbOfPlanesPerLine: NumberController = ...

    The number of planes on a side of the grid: the largest map is planeSize times it.

    opacity: NumberController = ...

    The map's opacity, 0 to 1.

    planeSize: NumberController = ...

    The side of a plane of the grid the tiles are drawn on, in metres.

    The map's shape.

    showMap: BooleanController = ...

    Shows the map under the twins loaded.

    size: NumberController = ...

    The map's side (square) or diameter (circle), in metres; 0: the scene's.

    title: "Map" = 'Map'

    Shown by an interface above its settings.

    The source of the map's tiles.

    Methods

    • Sets the settings config gives, each validated (see ValueController.validate): a value refused is skipped with a warning, the others set. The keys that are not settings are ignored (e.g. of a config saved by another version).

      Parameters

      Returns void

    • Disconnects every listener of the settings: they are not used after.

      Returns void

    • Sets the settings saved under key in the local storage (saveToLocalStorage); none saved: unchanged. A value refused (e.g. by a later version) is skipped with a warning, the others set (see applyConfig); saved settings that cannot be read are ignored with a warning.

      Parameters

      • key: string

      Returns void

    • Sets every setting back to its default.

      Returns void

    • Saves the values changed from their default under key in the local storage, the key removed when none is: the others follow the defaults of the next versions.

      Parameters

      • key: string

      Returns void