mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2026-01-04 14:01:22 +00:00
* Nullchecks Client on `tgui_alert()` and siblings (#79322) ## About The Pull Request Fixes #79321 ```dm /datum/tgui/proc/open() if(!user.client) return FALSE ``` The TGUI window won't even `open()` and do any work if we don't have a client, so let's just explicitly get the hell out of dodge if we don't have a client associated with a mob in these procs. Adding a `?` to handle the runtime in the linked issue only obfuscates the deeper issue because of the aforementioned code snippet. ## Why It's Good For The Game Clientless monkeys will still somehow be able to interact with stuff through their random behavior, and this is still plausible enough to show up on live servers every so often, so let's just patch it out early. These alerts are meant for player user input, so if we don't have a player, let's bounce. ## Changelog A player would never ever notice this. * Nullchecks Client on `tgui_alert()` and siblings --------- Co-authored-by: san7890 <the@san7890.com>
142 lines
4.6 KiB
Plaintext
142 lines
4.6 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 null
|
|
|
|
if(isnull(user.client))
|
|
return null
|
|
|
|
// 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
|