minimap_ui_handler

Minimap UI handles are responsible for all TGUI logic pertaining to minimaps and minimap controllers. This typically involves setting up the ByondUI to display the minimap and passing other parameters to the UI.

Vars
handler	The screen handler which the minimap object is placed into.
minimap	The "minimap" object which will be displayed onto the client's screen. Not explicitly defined, as it may also be of type `obj/minimap_controller`.
minimap_id	The current unique ID of the minimap, used for rendering it in a ByondUI component.
tgui_theme	The theme that the tgui window should use. For a list of all themes, see `tgui/packages/tgui/styles/themes`.
tgui_title	The title that the tgui window should display.
viewers	All clients who currently have the minimap ui open.
Procs
add_client	Adds a subscribed client.
remove_client	Removes a subscribed client.

Var Details

var
handler
– /atom/movable/screen

The screen handler which the minimap object is placed into.

var
minimap
– /obj

The "minimap" object which will be displayed onto the client's screen. Not explicitly defined, as it may also be of type obj/minimap_controller.

var
minimap_id
–

The current unique ID of the minimap, used for rendering it in a ByondUI component.

var
tgui_theme
–

The theme that the tgui window should use. For a list of all themes, see tgui/packages/tgui/styles/themes.

var
tgui_title
–

The title that the tgui window should display.

var
viewers
– /list/client

All clients who currently have the minimap ui open.

Proc Details

proc
add_client
(/client/viewer)

Adds a subscribed client.

proc
remove_client
(/client/viewer)

Removes a subscribed client.

/atom/movable/minimap_ui_handler

Vars

Procs

Var Details

var handler – /atom/movable/screen

var minimap – /obj

var minimap_id –

var tgui_theme –

var tgui_title –

var viewers – /list/client