-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Ported over from https://gitlab.com/cmdevs/colonial-warfare/-/merge_requests/613 which provides an input box to select an option from a list. Has a search bar to allow filtering for results and an onKeyDown event to replicate default behaviour from the default list input boxes that BYOND provides (where you are able to type the first letter of an element in the list and it'll jump to the first element that matches and then the next and so on) Right now, it is only applied to the holopad and "Drop Bomb" verb for administrators. Credits to bobbahbrown for the Loader element from AlertModal.js which allows for a timed input (was needed on the CM codebase for timed inputs) and for the majority of the DM code. Co-authored-by: Watermelon914 <3052169-Watermelon914@users.noreply.gitlab.com> Co-authored-by: Aleksej Komarov <stylemistake@gmail.com>
- Loading branch information
1 parent
26e4ae3
commit 7c42efe
Showing
11 changed files
with
433 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,184 @@ | ||
/** | ||
* Creates a TGUI input list 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 input box to. | ||
* * message - The content of the input box, shown in the body of the TGUI window. | ||
* * title - The title of the input box, 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 input box, after which the input box will close and qdel itself. Set to zero for no timeout. | ||
*/ | ||
/proc/tgui_input_list(mob/user, message, title, list/buttons, timeout = 0) | ||
if (!user) | ||
user = usr | ||
if(!length(buttons)) | ||
return | ||
if (!istype(user)) | ||
if (istype(user, /client)) | ||
var/client/client = user | ||
user = client.mob | ||
else | ||
return | ||
var/datum/tgui_list_input/input = new(user, message, title, buttons, timeout) | ||
input.ui_interact(user) | ||
input.wait() | ||
if (input) | ||
. = input.choice | ||
qdel(input) | ||
|
||
/** | ||
* Creates an asynchronous TGUI input list window with an associated callback. | ||
* | ||
* This proc should be used to create inputs that invoke a callback with the user's chosen option. | ||
* Arguments: | ||
* * user - The user to show the input box to. | ||
* * message - The content of the input box, shown in the body of the TGUI window. | ||
* * title - The title of the input box, 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. | ||
* * callback - The callback to be invoked when a choice is made. | ||
* * timeout - The timeout of the input box, after which the menu will close and qdel itself. Set to zero for no timeout. | ||
*/ | ||
/proc/tgui_input_list_async(mob/user, message, title, list/buttons, datum/callback/callback, timeout = 60 SECONDS) | ||
if (!user) | ||
user = usr | ||
if(!length(buttons)) | ||
return | ||
if (!istype(user)) | ||
if (istype(user, /client)) | ||
var/client/client = user | ||
user = client.mob | ||
else | ||
return | ||
var/datum/tgui_list_input/async/input = new(user, message, title, buttons, callback, timeout) | ||
input.ui_interact(user) | ||
|
||
/** | ||
* # tgui_list_input | ||
* | ||
* Datum used for instantiating and using a TGUI-controlled list input that prompts the user with | ||
* a message and shows a list of selectable options | ||
*/ | ||
/datum/tgui_list_input | ||
/// 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 | ||
/// Buttons (strings specifically) mapped to the actual value (e.g. a mob or a verb) | ||
var/list/buttons_map | ||
/// The button that the user has pressed, null if no selection has been made | ||
var/choice | ||
/// The time at which the tgui_list_input was created, for displaying timeout progress. | ||
var/start_time | ||
/// The lifespan of the tgui_list_input, after which the window will close and delete itself. | ||
var/timeout | ||
/// Boolean field describing if the tgui_list_input was closed by the user. | ||
var/closed | ||
|
||
/datum/tgui_list_input/New(mob/user, message, title, list/buttons, timeout) | ||
src.title = title | ||
src.message = message | ||
src.buttons = list() | ||
src.buttons_map = list() | ||
|
||
// Gets rid of illegal characters | ||
var/static/regex/whitelistedWords = regex(@{"([^\u0020-\u8000]+)"}) | ||
|
||
for(var/i in buttons) | ||
var/string_key = whitelistedWords.Replace("[i]", "") | ||
|
||
src.buttons += string_key | ||
src.buttons_map[string_key] = i | ||
|
||
|
||
if (timeout) | ||
src.timeout = timeout | ||
start_time = world.time | ||
QDEL_IN(src, timeout) | ||
|
||
/datum/tgui_list_input/Destroy(force, ...) | ||
SStgui.close_uis(src) | ||
QDEL_NULL(buttons) | ||
. = ..() | ||
|
||
/** | ||
* Waits for a user's response to the tgui_list_input's prompt before returning. Returns early if | ||
* the window was closed by the user. | ||
*/ | ||
/datum/tgui_list_input/proc/wait() | ||
while (!choice && !closed) | ||
stoplag(1) | ||
|
||
/datum/tgui_list_input/ui_interact(mob/user, datum/tgui/ui) | ||
ui = SStgui.try_update_ui(user, src, ui) | ||
if(!ui) | ||
ui = new(user, src, "ListInput") | ||
ui.open() | ||
|
||
/datum/tgui_list_input/ui_close(mob/user) | ||
. = ..() | ||
closed = TRUE | ||
|
||
/datum/tgui_list_input/ui_state(mob/user) | ||
return GLOB.always_state | ||
|
||
/datum/tgui_list_input/ui_static_data(mob/user) | ||
. = list( | ||
"title" = title, | ||
"message" = message, | ||
"buttons" = buttons | ||
) | ||
|
||
/datum/tgui_list_input/ui_data(mob/user) | ||
. = list() | ||
if(timeout) | ||
.["timeout"] = clamp((timeout - (world.time - start_time) - 1 SECONDS) / (timeout - 1 SECONDS), 0, 1) | ||
|
||
/datum/tgui_list_input/ui_act(action, list/params) | ||
. = ..() | ||
if (.) | ||
return | ||
switch(action) | ||
if("choose") | ||
if (!(params["choice"] in buttons)) | ||
return | ||
choice = buttons_map[params["choice"]] | ||
SStgui.close_uis(src) | ||
return TRUE | ||
if("cancel") | ||
SStgui.close_uis(src) | ||
closed = TRUE | ||
return TRUE | ||
|
||
/** | ||
* # async tgui_list_input | ||
* | ||
* An asynchronous version of tgui_list_input to be used with callbacks instead of waiting on user responses. | ||
*/ | ||
/datum/tgui_list_input/async | ||
/// The callback to be invoked by the tgui_list_input upon having a choice made. | ||
var/datum/callback/callback | ||
|
||
/datum/tgui_list_input/async/New(mob/user, message, title, list/buttons, callback, timeout) | ||
..(user, title, message, buttons, timeout) | ||
src.callback = callback | ||
|
||
/datum/tgui_list_input/async/Destroy(force, ...) | ||
QDEL_NULL(callback) | ||
. = ..() | ||
|
||
/datum/tgui_list_input/async/ui_close(mob/user) | ||
. = ..() | ||
qdel(src) | ||
|
||
/datum/tgui_list_input/async/ui_act(action, list/params) | ||
. = ..() | ||
if (!. || choice == null) | ||
return | ||
callback.InvokeAsync(choice) | ||
qdel(src) | ||
|
||
/datum/tgui_list_input/async/wait() | ||
return |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.