/tg/ Station 13 - Modules - TypesDefine Details

code/__DEFINES/tgui.dm

UI_INTERACTIVEGreen eye; fully interactive
UI_UPDATEOrange eye; updates but is not interactive
UI_DISABLEDRed eye; disabled, does not update
UI_CLOSEUI Should close
TGUI_WINDOW_SOFT_LIMITMaximum number of windows that can be suspended/reused
TGUI_WINDOW_HARD_LIMITMaximum number of open windows
TGUI_WINDOW_UNLIMITED_LIMITMaximum number of open windows when user has prefs set to unlimited, basically infinite. You dont need 200 windows; you'll run out of memory by then
TGUI_PING_TIMEOUTMaximum ping timeout allowed to detect zombie windows
TGUI_REFRESH_FULL_UPDATE_COOLDOWNUsed for rate-limiting to prevent DoS by excessively refreshing a TGUI window
TGUI_WINDOW_CLOSEDWindow does not exist
TGUI_WINDOW_LOADINGWindow was just opened, but is still not ready to be sent data
TGUI_WINDOW_READYWindow is free and ready to receive data
TGUI_MANAGED_BYONDUI_LIMITThough not the maximum renderable ByondUis within tgui, this is the maximum that the server will manage per-UI
TGUI_WINDOW_IDGet a window id based on the provided pool index
TGUI_WINDOW_INDEXGet a pool index of the provided window id
TGUI_CREATE_MESSAGECreates a message packet for sending via output()
TGUI_PANEL_FOCUS_MESSAGEPre-encoded TGUI message for verbs/focus with null payload, used in the Tab macro. This is TGUI_CREATE_MESSAGE("verbs/focus", null), unit tested in tgui_panel_focus_message.
TGUI_PANEL_CLEAR_MESSAGEPre-encoded TGUI message for verbs/clear with null payload, used in the Backspace macro. This is TGUI_CREATE_MESSAGE("verbs/clear", null), unit tested in tgui_panel_clear_message.
ADMIN_STATEGets a ui_state that checks to see if the user has specific admin permissions.

Define Details

ADMIN_STATE

Gets a ui_state that checks to see if the user has specific admin permissions.

Arguments:

TGUI_CREATE_MESSAGE

Creates a message packet for sending via output()

TGUI_MANAGED_BYONDUI_LIMIT

Though not the maximum renderable ByondUis within tgui, this is the maximum that the server will manage per-UI

TGUI_PANEL_CLEAR_MESSAGE

Pre-encoded TGUI message for verbs/clear with null payload, used in the Backspace macro. This is TGUI_CREATE_MESSAGE("verbs/clear", null), unit tested in tgui_panel_clear_message.

TGUI_PANEL_FOCUS_MESSAGE

Pre-encoded TGUI message for verbs/focus with null payload, used in the Tab macro. This is TGUI_CREATE_MESSAGE("verbs/focus", null), unit tested in tgui_panel_focus_message.

TGUI_PING_TIMEOUT

Maximum ping timeout allowed to detect zombie windows

TGUI_REFRESH_FULL_UPDATE_COOLDOWN

Used for rate-limiting to prevent DoS by excessively refreshing a TGUI window

TGUI_WINDOW_CLOSED

Window does not exist

TGUI_WINDOW_HARD_LIMIT

Maximum number of open windows

TGUI_WINDOW_ID

Get a window id based on the provided pool index

TGUI_WINDOW_INDEX

Get a pool index of the provided window id

TGUI_WINDOW_LOADING

Window was just opened, but is still not ready to be sent data

TGUI_WINDOW_READY

Window is free and ready to receive data

TGUI_WINDOW_SOFT_LIMIT

Maximum number of windows that can be suspended/reused

TGUI_WINDOW_UNLIMITED_LIMIT

Maximum number of open windows when user has prefs set to unlimited, basically infinite. You dont need 200 windows; you'll run out of memory by then

UI_CLOSE

UI Should close

UI_DISABLED

Red eye; disabled, does not update

UI_INTERACTIVE

Green eye; fully interactive

UI_UPDATE

Orange eye; updates but is not interactive