tgui

tgui

/tg/station user interface library

tgui datum (represents a UI).

Vars
_initial_update	Holder for the json string, that is sent during the initial update
autoupdate	Update the UI every MC tick.
children	Children of this UI.
height	The window height
initial_data	The data (and datastructure) used to initialize the UI.
initial_static_data	The static data used to initialize the UI.
initialized	If the UI has been initialized yet.
interface	The interface (template) to be used for this UI.
master_ui	The parent UI.
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.
ui_key	The ui_key of the UI. This allows multiple UIs for one src_object.
user	The mob who opened/is using the UI.
width	The window width.
window_id	The window_id for browse() and onclose().
Procs
New	public
Topic	private
close	public
get_json	private
open	public
process	private
push_data	private
reinitialize	public
set_autoupdate	public
set_status	private
update	private
update_status	private

Var Details

var
_initial_update
–

Holder for the json string, that is sent during the initial update

var
autoupdate
–

Update the UI every MC tick.

var
children
– /list/datum/tgui

Children of this UI.

var
height
–

The window height

var
initial_data
– /list

The data (and datastructure) used to initialize the UI.

var
initial_static_data
– /list

The static data used to initialize the UI.

var
initialized
–

If the UI has been initialized yet.

var
interface
–

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

var
master_ui
– /datum/tgui

The parent UI.

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
ui_key
–

The ui_key of the UI. This allows multiple UIs for one src_object.

var
user
– /mob

The mob who opened/is using the UI.

var
width
–

The window width.

var
window_id
–

The window_id for browse() and onclose().

Proc Details

New
(/mob/user, /datum/src_object, ui_key, interface, title, width, height, /datum/tgui/master_ui, /datum/ui_state/state)

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 ui_key string The ui_key of the UI. required interface string The interface used to render the UI. optional title string The title of the UI. optional width int The window width. optional height int The window height. optional master_ui datum/tgui The parent UI. optional state datum/ui_state The state used to determine status.

return datum/tgui The requested UI.

Topic
(href, href_list)

private

Handle clicks from the UI. Call the src_object's ui_act() if status is UI_INTERACTIVE. If the src_object's ui_act() returns 1, update all UIs attacked to it.

proc
close
()

public

Close the UI, and all its children.

proc
get_json
(/list/data, /list/static_data)

private

Package the data to send to the UI, as JSON. This includes the UI data and config_data.

return string The packaged JSON.

proc
open
()

public

Open this UI (and initialize it with data).

process
(force)

private

Update the UI. Only updates the data if update is true, otherwise only updates the status.

optional force bool If the UI should be forced to update.

proc
push_data
(data, static_data, force)

private

Push data to an already open UI.

required data list The data to send. optional force bool If the update should be sent regardless of state.

proc
reinitialize
(interface, /list/data, /list/static_data)

public

Reinitialize the UI. (Possibly with a new interface and/or data).

optional template string The name of the new interface. optional data list The new initial data.

proc
set_autoupdate
(state)

public

Enable/disable auto-updating of the UI.

required state bool Enable/disable auto-updating.

proc
set_status
(status, push)

private

Set the status/visibility of the UI.

required status int The status to set (UI_CLOSE/UI_DISABLED/UI_UPDATE/UI_INTERACTIVE). optional push bool Push an update to the UI (an update is always sent for UI_DISABLED).

proc
update
(force_open)

private

Updates the UI by interacting with the src_object again, which will hopefully call try_ui_update on it.

optional force_open bool If force_open should be passed to ui_interact.

proc
update_status
(push)

private

Update the status/visibility of the UI for its user.

optional push bool Push an update to the UI (an update is always sent for UI_DISABLED).

tgui /datum/tgui

Vars

Procs

Var Details

var _initial_update –

var autoupdate –

var children – /list/datum/tgui

var height –

var initial_data – /list

var initial_static_data – /list

var initialized –

var interface –

var master_ui – /datum/tgui

var src_object – /datum

var state – /datum/ui_state

var status –

var title –

var ui_key –

var user – /mob

var width –

var window_id –

Proc Details

New(/mob/user, /datum/src_object, ui_key, interface, title, width, height, /datum/tgui/master_ui, /datum/ui_state/state)

Topic(href, href_list)

proc close()

proc get_json(/list/data, /list/static_data)

proc open()

process(force)

proc push_data(data, static_data, force)

proc reinitialize(interface, /list/data, /list/static_data)

proc set_autoupdate(state)

proc set_status(status, push)

proc update(force_open)

proc update_status(push)

tgui
/datum/tgui

var
_initial_update
–

var
autoupdate
–

var
children
– /list/datum/tgui

var
height
–

var
initial_data
– /list

var
initial_static_data
– /list

var
initialized
–

var
interface
–

var
master_ui
– /datum/tgui

var
src_object
– /datum

var
state
– /datum/ui_state

var
status
–

var
title
–

var
ui_key
–

var
user
– /mob

var
width
–

var
window_id
–

New
(/mob/user, /datum/src_object, ui_key, interface, title, width, height, /datum/tgui/master_ui, /datum/ui_state/state)

Topic
(href, href_list)

proc
close
()

proc
get_json
(/list/data, /list/static_data)

proc
open
()

process
(force)

proc
push_data
(data, static_data, force)

proc
reinitialize
(interface, /list/data, /list/static_data)

proc
set_autoupdate
(state)

proc
set_status
(status, push)

proc
update
(force_open)

proc
update_status
(push)