mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2026-01-10 08:54:15 +00:00
e932d4d39a
* Allows TGUI input datums to accept a ui_state as an argument (#75029) ## About The Pull Request Title. Adds a new argument to the factory proc, the New(), adds a variable, and changes ui_state() to return that variable. The variable is always_state by default. ## Why It's Good For The Game It allows custom behavior to be injected into the ui_state logic of the basic input datums. This is good because there are circumstances where always_state isn't acceptable. Ex. you open tgui_input_list(mob/user), and the mob dies or is deleted. The list stays open, the contents can be picked, despite this not being what the author wants. With this PR, you can make sure the list closes and inputs are invalid in circumstances of your choosing without having to completely re-make the input procs via copypasting. ## Changelog 🆑 code: TGUI input datums can now accept custom ui_states /🆑 * Allows TGUI input datums to accept a ui_state as an argument --------- Co-authored-by: nikothedude <59709059+nikothedude@users.noreply.github.com>
138 lines
4.5 KiB
Plaintext
138 lines
4.5 KiB
Plaintext
/**
|
|
* Creates a TGUI alert window and returns the user's response.
|
|
*
|
|
* This proc should be used to create alerts that the caller will wait for a response from.
|
|
* Arguments:
|
|
* * user - The user to show the alert to.
|
|
* * message - The content of the alert, shown in the body of the TGUI window.
|
|
* * title - The of the alert modal, shown on the top of the TGUI window.
|
|
* * buttons - The options that can be chosen by the user, each string is assigned a button on the UI.
|
|
* * timeout - The timeout of the alert, after which the modal will close and qdel itself. Set to zero for no timeout.
|
|
* * autofocus - The bool that controls if this alert should grab window focus.
|
|
*/
|
|
/proc/tgui_alert(mob/user, message = "", title, list/buttons = list("Ok"), timeout = 0, autofocus = TRUE, ui_state = GLOB.always_state)
|
|
if (!user)
|
|
user = usr
|
|
if (!istype(user))
|
|
if (istype(user, /client))
|
|
var/client/client = user
|
|
user = client.mob
|
|
else
|
|
return
|
|
// A gentle nudge - you should not be using TGUI alert for anything other than a simple message.
|
|
if(length(buttons) > 3)
|
|
log_tgui(user, "Error: TGUI Alert initiated with too many buttons. Use a list.", "TguiAlert")
|
|
return tgui_input_list(user, message, title, buttons, timeout, autofocus)
|
|
// Client does NOT have tgui_input on: Returns regular input
|
|
if(!user.client.prefs.read_preference(/datum/preference/toggle/tgui_input))
|
|
if(length(buttons) == 2)
|
|
return alert(user, message, title, buttons[1], buttons[2])
|
|
if(length(buttons) == 3)
|
|
return alert(user, message, title, buttons[1], buttons[2], buttons[3])
|
|
var/datum/tgui_alert/alert = new(user, message, title, buttons, timeout, autofocus, ui_state)
|
|
alert.ui_interact(user)
|
|
alert.wait()
|
|
if (alert)
|
|
. = alert.choice
|
|
qdel(alert)
|
|
|
|
/**
|
|
* # tgui_alert
|
|
*
|
|
* Datum used for instantiating and using a TGUI-controlled modal that prompts the user with
|
|
* a message and has buttons for responses.
|
|
*/
|
|
/datum/tgui_alert
|
|
/// The title of the TGUI window
|
|
var/title
|
|
/// The textual body of the TGUI window
|
|
var/message
|
|
/// The list of buttons (responses) provided on the TGUI window
|
|
var/list/buttons
|
|
/// The button that the user has pressed, null if no selection has been made
|
|
var/choice
|
|
/// The time at which the tgui_alert was created, for displaying timeout progress.
|
|
var/start_time
|
|
/// The lifespan of the tgui_alert, after which the window will close and delete itself.
|
|
var/timeout
|
|
/// The bool that controls if this modal should grab window focus
|
|
var/autofocus
|
|
/// Boolean field describing if the tgui_alert was closed by the user.
|
|
var/closed
|
|
/// The TGUI UI state that will be returned in ui_state(). Default: always_state
|
|
var/datum/ui_state/state
|
|
|
|
/datum/tgui_alert/New(mob/user, message, title, list/buttons, timeout, autofocus, ui_state)
|
|
src.autofocus = autofocus
|
|
src.buttons = buttons.Copy()
|
|
src.message = message
|
|
src.title = title
|
|
src.state = ui_state
|
|
if (timeout)
|
|
src.timeout = timeout
|
|
start_time = world.time
|
|
QDEL_IN(src, timeout)
|
|
|
|
/datum/tgui_alert/Destroy(force, ...)
|
|
SStgui.close_uis(src)
|
|
state = null
|
|
QDEL_NULL(buttons)
|
|
return ..()
|
|
|
|
/**
|
|
* Waits for a user's response to the tgui_alert's prompt before returning. Returns early if
|
|
* the window was closed by the user.
|
|
*/
|
|
/datum/tgui_alert/proc/wait()
|
|
while (!choice && !closed && !QDELETED(src))
|
|
stoplag(1)
|
|
|
|
/datum/tgui_alert/ui_interact(mob/user, datum/tgui/ui)
|
|
ui = SStgui.try_update_ui(user, src, ui)
|
|
if(!ui)
|
|
ui = new(user, src, "AlertModal")
|
|
ui.open()
|
|
|
|
/datum/tgui_alert/ui_close(mob/user)
|
|
. = ..()
|
|
closed = TRUE
|
|
|
|
/datum/tgui_alert/ui_state(mob/user)
|
|
return state
|
|
|
|
/datum/tgui_alert/ui_static_data(mob/user)
|
|
var/list/data = list()
|
|
data["autofocus"] = autofocus
|
|
data["buttons"] = buttons
|
|
data["message"] = message
|
|
data["large_buttons"] = user.client.prefs.read_preference(/datum/preference/toggle/tgui_input_large)
|
|
data["swapped_buttons"] = user.client.prefs.read_preference(/datum/preference/toggle/tgui_input_swapped)
|
|
data["title"] = title
|
|
return data
|
|
|
|
/datum/tgui_alert/ui_data(mob/user)
|
|
var/list/data = list()
|
|
if(timeout)
|
|
data["timeout"] = CLAMP01((timeout - (world.time - start_time) - 1 SECONDS) / (timeout - 1 SECONDS))
|
|
return data
|
|
|
|
/datum/tgui_alert/ui_act(action, list/params)
|
|
. = ..()
|
|
if (.)
|
|
return
|
|
switch(action)
|
|
if("choose")
|
|
if (!(params["choice"] in buttons))
|
|
CRASH("[usr] entered a non-existent button choice: [params["choice"]]")
|
|
set_choice(params["choice"])
|
|
closed = TRUE
|
|
SStgui.close_uis(src)
|
|
return TRUE
|
|
if("cancel")
|
|
closed = TRUE
|
|
SStgui.close_uis(src)
|
|
return TRUE
|
|
|
|
/datum/tgui_alert/proc/set_choice(choice)
|
|
src.choice = choice
|