/
githubmirror
/
vgstation13
Обзор
Документация
Войти
/
githubmirror
/
vgstation13
Код
Запросы
0
Пакеты
0
Релизы
0
Аналитика
Безопасность
Bleeding-Edge
code/modules/tgui/tgui.dm
400 строк
11 KB
Anthony "Shifty Rail
Fixes the TGUI black squares the proper way (#37700)
09 июн 2025, 15:50
Не верифицирован
09 июн 2025, 15:50
ec0de52
Код
Авторство
О чём код?
/*! * Copyright (c) 2020 Aleksej Komarov * SPDX-License-Identifier: MIT */ /** * tgui datum (represents a UI). */ /datum/tgui /// The mob who opened/is using the UI. var/mob/user /// The object which owns the UI. var/datum/src_object /// The title of the UI. var/title /// The window_id for browse() and onclose(). var/datum/tgui_window/window /// Key that is used for remembering the window geometry. var/window_key /// Deprecated: Window size. var/window_size /// The interface (template) to be used for this UI. var/interface /// Update the UI every MC tick. var/autoupdate = TRUE /// If the UI has been initialized yet. var/initialized = FALSE /// Time of opening the window. var/opened_at /// Stops further updates when close() was called. var/closing = FALSE /// The status/visibility of the UI. var/status = UI_INTERACTIVE /// Timed refreshing state var/refreshing = FALSE /// Topic state used to determine status/interactability. var/datum/ui_state/state = null /// Rate limit client refreshes to prevent DoS. var/refresh_cooldown = 0 /// The id of any ByondUi elements that we have opened var/list/open_byondui_elements /** * 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. */ /datum/tgui/New(mob/user, datum/src_object, interface, title, ui_x, ui_y) log_tgui(user, "new [interface] fancy [user?.client?.prefs.get_pref(/datum/preference_setting/toggle/tgui_fancy)]", src_object = src_object) src.user = user src.src_object = src_object src.window_key = "\ref[src_object]-main" src.interface = interface if(title) src.title = title src.state = src_object.ui_state(user) // Deprecated if(ui_x && ui_y) src.window_size = list(ui_x, ui_y) /datum/tgui/Destroy() user = null src_object = null return ..() /** * 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. */ /datum/tgui/proc/open() if(!user.client) return FALSE if(window) return FALSE process_status() if(status < UI_UPDATE) return FALSE window = SStgui.request_pooled_window(user) if(!window) return FALSE opened_at = world.time window.acquire_lock(src) if(!window.is_ready()) window.initialize( strict_mode = TRUE, fancy = user.client.prefs.get_pref(/datum/preference_setting/toggle/tgui_fancy), assets = list( get_tg_asset_datum(/datum/tg_asset/simple/tgui), )) else window.send_message("ping") send_assets() window.send_message("update", get_payload( with_data = TRUE, with_static_data = TRUE)) SStgui.on_open(src) return TRUE /datum/tgui/proc/send_assets() var/flush_queue = window.send_asset(get_tg_asset_datum( /datum/tg_asset/simple/fontawesome)) flush_queue |= window.send_asset(get_tg_asset_datum( /datum/tg_asset/simple/tgfont)) flush_queue |= window.send_asset(get_tg_asset_datum( /datum/tg_asset/json/icon_ref_map)) for(var/datum/tg_asset/asset in src_object.ui_assets(user)) flush_queue |= window.send_asset(asset) // -- Legacy code for /vg/ style spritesheet datums -- // TOFIX!!! One thing at the time.. for(var/asset_type in src_object.ui_assets(user)) window.sent_assets |= list(asset_type) var/datum/asset/instance = get_asset_datum(asset_type) instance.send(window.client) if(istype(instance, /datum/asset/spritesheet)) var/datum/asset/spritesheet/spritesheet = instance window.send_message("asset/stylesheet", spritesheet.css_filename()) window.send_raw_message(TGUI_CREATE_MESSAGE("asset/mappings", instance.get_url_mappings())) // -- END legacy code for /vg/ style spritesheet datums -- if (flush_queue) user.client.tg_browse_queue_flush() /** * public * * Close the UI. * * optional can_be_suspended bool */ /datum/tgui/proc/close(can_be_suspended = TRUE) if(closing) return closing = TRUE // If we don't have window_id, open proc did not have the opportunity // to finish, therefore it's safe to skip this whole block. if(window) // Windows you want to keep are usually blue screens of death // and we want to keep them around, to allow user to read // the error message properly. window.release_lock() window.close(can_be_suspended) src_object.ui_close(user) SStgui.on_close(src) if(user.client) terminate_byondui_elements() state = null qdel(src) /** * public * * Closes all ByondUI elements, left dangling by a forceful TGUI exit, * such as via Alt+F4, closing in non-fancy mode, or terminating the process * */ /datum/tgui/proc/terminate_byondui_elements() set waitfor = FALSE for(var/byondui_element in open_byondui_elements) winset(user.client, byondui_element, list("parent" = "")) /** * public * * Enable/disable auto-updating of the UI. * * required value bool Enable/disable auto-updating. */ /datum/tgui/proc/set_autoupdate(autoupdate) src.autoupdate = autoupdate /** * public * * Replace current ui.state with a new one. * * required state datum/ui_state/state Next state */ /datum/tgui/proc/set_state(datum/ui_state/state) src.state = state /** * public * * Makes an asset available to use in tgui. * * required asset datum/asset * * return bool - true if an asset was actually sent */ /datum/tgui/proc/send_asset(datum/asset/asset) if(!window) CRASH("send_asset() was called either without calling open() first or when open() did not return TRUE.") return window.send_asset(asset) /** * 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. */ /datum/tgui/proc/send_full_update(custom_data, force) if(!user.client || !initialized || closing) return if(!COOLDOWN_FINISHED(src, refresh_cooldown)) refreshing = TRUE add_timer(new /callback(src, PROC_REF(send_full_update), custom_data, force), COOLDOWN_TIMELEFT(src, refresh_cooldown), TIMER_UNIQUE) return refreshing = FALSE var/should_update_data = force || status >= UI_UPDATE window.send_message("update", get_payload( custom_data, with_data = should_update_data, with_static_data = TRUE)) COOLDOWN_START(src, refresh_cooldown, TGUI_REFRESH_FULL_UPDATE_COOLDOWN) /** * 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. */ /datum/tgui/proc/send_update(custom_data, force) if(!user.client || !initialized || closing) return var/should_update_data = force || status >= UI_UPDATE window.send_message("update", get_payload( custom_data, with_data = should_update_data)) /** * private * * Package the data to send to the UI, as JSON. * * return list */ /datum/tgui/proc/get_payload(custom_data, with_data, with_static_data) var/list/json_data = list() json_data["config"] = list( "title" = title, "status" = status, "interface" = list( "name" = interface, "layout" = 0, // user.client.prefs.get_pref(/datum/preference_setting/toggle/layout_prefs_used), // not implemented yet! ), "refreshing" = refreshing, "window" = list( "key" = window_key, "size" = window_size, "fancy" = user.client.prefs.get_pref(/datum/preference_setting/toggle/tgui_fancy), "locked" = 0, // user.client.prefs.get_pref(/datum/preference_setting/toggle/tgui_lock), //not implemented yet! "scale" = 0, // user.client.prefs.get_pref(/datum/preference_setting/toggle/tgui_scale), ), "client" = list( "ckey" = user.client.ckey, "address" = user.client.address, "computer_id" = user.client.computer_id, ), "user" = list( "name" = "[user]", "observer" = isobserver(user), ), ) var/data = custom_data || with_data && src_object.ui_data(user) if(data) json_data["data"] = data var/static_data = with_static_data && src_object.ui_static_data(user) if(static_data) json_data["static_data"] = static_data if(src_object.tgui_shared_states) json_data["shared"] = src_object.tgui_shared_states return json_data /** * private * * Run an update cycle for this UI. Called internally by SStgui * every second or so. */ /datum/tgui/proc/process(seconds_per_tick, force = FALSE) if(closing) return var/datum/host = src_object.ui_host(user) // If the object or user died (or something else), abort. if(QDELETED(src_object) || QDELETED(host) || QDELETED(user) || QDELETED(window)) close(can_be_suspended = FALSE) return // Validate ping if(!initialized && world.time - opened_at > TGUI_PING_TIMEOUT) log_tgui(user, "Error: Zombie window detected, closing.", window = window, src_object = src_object) close(can_be_suspended = FALSE) return // Update through a normal call to tgui_interact if(status != UI_DISABLED && (autoupdate || force)) src_object.tgui_interact(user, src) return // Update status only var/needs_update = process_status() if(status <= UI_CLOSE) close() return if(needs_update) window.send_message("update", get_payload()) /** * private * * Updates the status, and returns TRUE if status has changed. */ /datum/tgui/proc/process_status() var/prev_status = status status = src_object.ui_status(user, state) return prev_status != status /** * private * * Callback for handling incoming tgui messages. */ /datum/tgui/proc/on_message(type, list/payload, list/href_list) // Pass act type messages to ui_act if(type && copytext(type, 1, 5) == "act/") var/act_type = copytext(type, 5) log_tgui(user, "Action: [act_type] [href_list["payload"]]", window = window, src_object = src_object) process_status() if(src_object.ui_act(act_type, payload, src, state)) SStgui.update_uis(src_object) return FALSE switch(type) if("ready") // Send a full update when the user manually refreshes the UI if(initialized) send_full_update() initialized = TRUE if("ping/reply") initialized = TRUE if("suspend") close(can_be_suspended = TRUE) if("close") close(can_be_suspended = FALSE) if("log") if(href_list["fatal"]) close(can_be_suspended = FALSE) if("setSharedState") if(status != UI_INTERACTIVE) return LAZYINITLIST(src_object.tgui_shared_states) src_object.tgui_shared_states[href_list["key"]] = href_list["value"] SStgui.update_uis(src_object) // Handles clearing out byondUI elements, which may cause black squares to appear if(TGUI_MANAGED_BYONDUI_TYPE_RENDER) var/byond_ui_id = payload[TGUI_MANAGED_BYONDUI_PAYLOAD_ID] if(!byond_ui_id || open_byondui_elements?.len > TGUI_MANAGED_BYONDUI_LIMIT) return append_ui_element(byond_ui_id) if(TGUI_MANAGED_BYONDUI_TYPE_UNMOUNT) var/byond_ui_id = payload[TGUI_MANAGED_BYONDUI_PAYLOAD_ID] if(!byond_ui_id) return append_ui_element(byond_ui_id) /datum/tgui/proc/append_ui_element(var/ui_element_id) if (!open_byondui_elements) open_byondui_elements = list() open_byondui_elements |= ui_element_id /// Wrapper for behavior to potentially wait until the next tick if the server is overloaded /datum/tgui/proc/on_act_message(act_type, payload, state) if(QDELETED(src) || QDELETED(src_object)) return if(src_object.ui_act(act_type, payload, src, state)) SStgui.update_uis(src_object)