/datum/tgui

tgui datum (represents a UI).

Vars
autoupdate	Update the UI every MC tick.
closing	Stops further updates when close() was called.
initialized	If the UI has been initialized yet.
interface	The interface (template) to be used for this UI.
mouse_hooked	Are byond mouse events beyond the window passed in to the ui
opened_at	Time of opening the window.
refresh_cooldown	Rate limit client refreshes to prevent DoS.
refreshing	Timed refreshing state
src_object	The object which owns the UI.
state	Topic state used to determine status/interactability.
status	The status/visibility of the UI.
title	The title of te UI.
user	The mob who opened/is using the UI.
window	The window_id for browse() and onclose().
window_key	Key that is used for remembering the window geometry.
window_size	Deprecated: Window size.
Procs
New	public
close	public
get_payload	private
on_act_message	Wrapper for behavior to potentially wait until the next tick if the server is overloaded
on_message	private
open	public
process	private
process_status	private
send_asset	public
send_full_update	public
send_update	public
set_autoupdate	public
set_mouse_hook	public
set_state	public

Var Details

var
autoupdate
–

Update the UI every MC tick.

var
closing
–

Stops further updates when close() was called.

var
initialized
–

If the UI has been initialized yet.

var
interface
–

The interface (template) to be used for this UI.

var
mouse_hooked
–

Are byond mouse events beyond the window passed in to the ui

var
opened_at
–

Time of opening the window.

var
refresh_cooldown
–

Rate limit client refreshes to prevent DoS.

var
refreshing
–

Timed refreshing state

var
src_object
– /datum

The object which owns the UI.

var
state
– /datum/ui_state

Topic state used to determine status/interactability.

var
status
–

The status/visibility of the UI.

var
title
–

The title of te UI.

var
user
– /mob

The mob who opened/is using the UI.

var
window
– /datum/tgui_window

The window_id for browse() and onclose().

var
window_key
–

Key that is used for remembering the window geometry.

var
window_size
–

Deprecated: Window size.

Proc Details

New
(/mob/user, /datum/src_object, interface, title, ui_x, ui_y)

public

Create a new UI.

required user mob The mob who opened/is using the UI. required src_object datum The object or datum which owns the UI. required interface string The interface used to render the UI. optional title string The title of the UI. optional ui_x int Deprecated: Window width. optional ui_y int Deprecated: Window height.

return datum/tgui The requested UI.

proc
close
(can_be_suspended)

public

Close the UI.

optional can_be_suspended bool

proc
get_payload
(custom_data, with_data, with_static_data)

private

Package the data to send to the UI, as JSON.

return list

proc
on_act_message
(act_type, payload, state)

Wrapper for behavior to potentially wait until the next tick if the server is overloaded

proc
on_message
(type, /list/payload, /list/href_list)

private

Callback for handling incoming tgui messages.

proc
open
()

public

Open this UI (and initialize it with data).

return bool - TRUE if a new pooled window is opened, FALSE in all other situations including if a new pooled window didn't open because one already exists.

↑
process
(delta_time, force)

private

Run an update cycle for this UI. Called internally by SStgui every second or so.

proc
process_status
()

private

Updates the status, and returns TRUE if status has changed.

proc
send_asset
(/datum/asset/asset)

public

Makes an asset available to use in tgui.

required asset datum/asset

return bool - true if an asset was actually sent

proc
send_full_update
(custom_data, force)

public

Send a full update to the client (includes static data).

optional custom_data list Custom data to send instead of ui_data. optional force bool Send an update even if UI is not interactive.

proc
send_update
(custom_data, force)

public

Send a partial update to the client (excludes static data).

optional custom_data list Custom data to send instead of ui_data. optional force bool Send an update even if UI is not interactive.

proc
set_autoupdate
(autoupdate)

public

Enable/disable auto-updating of the UI.

required value bool Enable/disable auto-updating.

proc
set_mouse_hook
(value)

public

Enable/disable passing through byond mouse events to the window

required value bool Enable/disable hooking.

proc
set_state
(/datum/ui_state/state)

public

Replace current ui.state with a new one.

required state datum/ui_state/state Next state

/datum/tgui

Vars

Procs

Var Details

var autoupdate –

var closing –

var initialized –

var interface –

var mouse_hooked –

var opened_at –

var refresh_cooldown –

var refreshing –

var src_object – /datum

var state – /datum/ui_state

var status –

var title –

var user – /mob

var window – /datum/tgui_window

var window_key –

var window_size –

Proc Details

New(/mob/user, /datum/src_object, interface, title, ui_x, ui_y)

proc close(can_be_suspended)

proc get_payload(custom_data, with_data, with_static_data)

proc on_act_message(act_type, payload, state)

proc on_message(type, /list/payload, /list/href_list)

proc open()

↑process(delta_time, force)

proc process_status()

proc send_asset(/datum/asset/asset)

proc send_full_update(custom_data, force)

proc send_update(custom_data, force)

proc set_autoupdate(autoupdate)

proc set_mouse_hook(value)

proc set_state(/datum/ui_state/state)

var
autoupdate
–

var
closing
–

var
initialized
–

var
interface
–

var
mouse_hooked
–

var
opened_at
–

var
refresh_cooldown
–

var
refreshing
–

var
src_object
– /datum

var
state
– /datum/ui_state

var
status
–

var
title
–

var
user
– /mob

var
window
– /datum/tgui_window

var
window_key
–

var
window_size
–

New
(/mob/user, /datum/src_object, interface, title, ui_x, ui_y)

proc
close
(can_be_suspended)

proc
get_payload
(custom_data, with_data, with_static_data)

proc
on_act_message
(act_type, payload, state)

proc
on_message
(type, /list/payload, /list/href_list)

proc
open
()

↑
process
(delta_time, force)

proc
process_status
()

proc
send_asset
(/datum/asset/asset)

proc
send_full_update
(custom_data, force)

proc
send_update
(custom_data, force)

proc
set_autoupdate
(autoupdate)

proc
set_mouse_hook
(value)

proc
set_state
(/datum/ui_state/state)