byond - Modules - TypesVar Details - Proc Details

minimap

Action that gives the owner access to the minimap pool

Vars

default_overwatch_levelSets a fixed z level to be tracked by this minimap action instead of being influenced by the owner's / locator override's z level.
locatorMinimap "You are here" indicator for when it's up
locator_overrideOverrides what the locator tracks aswell what z the map displays as opposed to always tracking the minimap's owner. Default behavior when null.
mapMinimap object we'll be displaying
marker_flagsmarker flags this will give the target, mostly used for marine minimaps
minimap_displayedboolean as to whether the minimap is currently shown
minimap_flagsFlags to allow the owner to see others of this type
z_downbutton granted when you're on a multiz level that lets you check above and below you
z_indicatorbutton granted when you're on a multiz level that lets you check above and below you
z_upbutton granted when you're on a multiz level that lets you check above and below you

Procs

change_z_shownchanges the currently to be displayed z. takes the new z as an arg
clear_locator_overrideCLears the locator override in case the override target is deleted
on_exit_checkchecks if we should clear override if the owner exits this atom
on_owner_z_changeUpdates the map when the owner changes zlevel
override_locatorOverrides the minimap locator to a given atom
toggle_minimapToggles the minimap, has a variable to force on or off (most likely only going to be used to close it)

Var Details

default_overwatch_level

Sets a fixed z level to be tracked by this minimap action instead of being influenced by the owner's / locator override's z level.

locator

Minimap "You are here" indicator for when it's up

locator_override

Overrides what the locator tracks aswell what z the map displays as opposed to always tracking the minimap's owner. Default behavior when null.

map

Minimap object we'll be displaying

marker_flags

marker flags this will give the target, mostly used for marine minimaps

minimap_displayed

boolean as to whether the minimap is currently shown

minimap_flags

Flags to allow the owner to see others of this type

z_down

button granted when you're on a multiz level that lets you check above and below you

z_indicator

button granted when you're on a multiz level that lets you check above and below you

z_up

button granted when you're on a multiz level that lets you check above and below you

Proc Details

change_z_shown

changes the currently to be displayed z. takes the new z as an arg

clear_locator_override

CLears the locator override in case the override target is deleted

on_exit_check

checks if we should clear override if the owner exits this atom

on_owner_z_change

Updates the map when the owner changes zlevel

override_locator

Overrides the minimap locator to a given atom

toggle_minimap

Toggles the minimap, has a variable to force on or off (most likely only going to be used to close it)