Skip to main content
Version: Current

Map Types

  • AddMapLayerAction​

    An event that adds a map layer to the map or miniMap portal. This is used to add custom layers to the map, such as heatmaps or other visualizations.

    Members​

    • layer GeoJSONMapLayer​

      The layer that should be added to the portal.

    • playerId? string​

      The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.

    • portal ("map" | "miniMap")​

      The portal that the layer should be added to.

    • taskId (string | number)​

      The ID of the async task.

    • type "add_map_layer"​

      The type of the event. This helps determine how the event should be applied to the state.

    • uncopiable? boolean​

      Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.

  • GeoJSONMapLayer​

    A map layer that contains GeoJSON data.

    Members​

    • Copyright information for the layer.

    • data? object​

      The GeoJSON data for the layer.

    • type "geojson"​

    • url? string​

      The URL that contains the GeoJSON data.

      Can be a blob url, a data url, or a regular URL.

  • MapLayer​

    The kinds of map layers that can be added to the map or miniMapPortal.

  • MapLayerBase​

    Defines a base interface for map layers.

    Members​

    • Copyright information for the layer.

  • RemoveMapLayerAction​

    An event that is used to remove a map layer from the map or miniMapPortal.

    Members​

    • layerId string​

      The ID of the layer that should be removed.

    • playerId? string​

      The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.

    • taskId (string | number)​

      The ID of the async task.

    • type "remove_map_layer"​

      The type of the event. This helps determine how the event should be applied to the state.

    • uncopiable? boolean​

      Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.