From 83b419decbee82c2cce7d5ea025a09fb8253ccd6 Mon Sep 17 00:00:00 2001 From: "Mark Aherne (Faerdan)" Date: Wed, 11 Sep 2013 22:18:11 +0100 Subject: [PATCH] Added documentation for the ui_interact proc. Moved the client nanoclose verb into nanoexternal.dm. Removed debug comments. --- code/game/machinery/cryo.dm | 16 ++++++--- code/modules/nano/nanoexternal.dm | 38 +++++++++++++++++++- code/modules/nano/nanoui.dm | 30 ++-------------- code/modules/reagents/Chemistry-Machinery.dm | 17 ++++++--- 4 files changed, 63 insertions(+), 38 deletions(-) diff --git a/code/game/machinery/cryo.dm b/code/game/machinery/cryo.dm index a4d7257e233..07d4d072e26 100644 --- a/code/game/machinery/cryo.dm +++ b/code/game/machinery/cryo.dm @@ -64,14 +64,23 @@ ui_interact(user) + /** + * The ui_interact proc is used to open and update Nano UIs + * If ui_interact is not used then the UI will not update correctly + * ui_interact is currently defined for /atom/movable + * + * @param user /mob The mob who is interacting with this ui + * @param ui_key string A string key to use for this ui. Allows for multiple unique uis on one obj/mob (defaut value "main") + * + * @return nothing + */ /obj/machinery/atmospherics/unary/cryo_cell/ui_interact(mob/user, ui_key = "main") - if(user == occupant || user.stat) return + // this is the data which will be sent to the ui var/data[0] data["isOperating"] = on - data["hasOccupant"] = occupant ? 1 : 0 var/occupantData[0] @@ -113,10 +122,9 @@ beakerContents.Add(list(list("name" = R.name, "volume" = R.volume))) // list in a list because Byond merges the first list... data["beakerContents"] = beakerContents - //user << list2json(data) - var/datum/nanoui/ui = nanomanager.get_open_ui(user, src, ui_key) if (!ui) + // the ui does not exist, so we'll create a new one ui = new(user, src, ui_key, "cryo.tmpl", "Cryo Cell Control System", 520, 410) // When the UI is first opened this is the data it will use ui.set_initial_data(data) diff --git a/code/modules/nano/nanoexternal.dm b/code/modules/nano/nanoexternal.dm index 7efe4dd4771..609bb604dcb 100644 --- a/code/modules/nano/nanoexternal.dm +++ b/code/modules/nano/nanoexternal.dm @@ -1,4 +1,40 @@ -// All movable things can have a Nano UI, always use ui_interact to open/interact with a Nano UI + // This file contains all Nano procs/definitions for external classes/objects + + /** + * Called when a Nano UI window is closed + * This is how Nano handles closed windows + * It must be a verb so that it can be called using winset + * + * @return nothing + */ +/client/verb/nanoclose(var/uiref as text) + set hidden = 1 // hide this verb from the user's panel + set name = "nanoclose" + + var/datum/nanoui/ui = locate(uiref) + + if (ui) + ui.close() + + if(ui.ref) + var/href = "close=1" + src.Topic(href, params2list(href), ui.ref) // this will direct to the atom's Topic() proc via client.Topic() + else if (ui.on_close_logic) + // no atomref specified (or not found) + // so just reset the user mob's machine var + if(src && src.mob) + src.mob.unset_machine() + + /** + * The ui_interact proc is used to open and update Nano UIs + * If ui_interact is not used then the UI will not update correctly + * ui_interact is currently defined for /atom/movable + * + * @param user /mob The mob who is interacting with this ui + * @param ui_key string A string key to use for this ui. Allows for multiple unique uis on one obj/mob (defaut value "main") + * + * @return nothing + */ /atom/movable/proc/ui_interact(mob/user, ui_key = "main") return diff --git a/code/modules/nano/nanoui.dm b/code/modules/nano/nanoui.dm index ca8e7f115bc..e1ac8556f2b 100644 --- a/code/modules/nano/nanoui.dm +++ b/code/modules/nano/nanoui.dm @@ -28,7 +28,7 @@ nanoui is used to open and update nano browser uis var/height = 0 // whether to use extra logic when window closes var/on_close_logic = 1 - // the ref to use when the window is closed (if on_close_logic is 1), usually null + // an extra ref to use when the window is closed, usually null var/atom/ref = null // options for modifying window behaviour var/window_options = "focus=0;can_close=1;can_minimize=1;can_maximize=0;can_resize=1;titlebar=1;" // window option is set using window_id @@ -240,7 +240,7 @@ nanoui is used to open and update nano browser uis content = ncontent /** - * Set whether or not to use the "old" on close logic (custom refs and unset_machine()) + * Set whether or not to use the "old" on close logic (mainly unset_machine()) * * @param state int (bool) Set on_close_logic to 1 or 0 (true/false) * @@ -376,32 +376,6 @@ nanoui is used to open and update nano browser uis winset(user, window_id, "on-close=\"nanoclose [params]\"") - /** - * Called when a Nano UI window is closed - * This is how Nano handles closed windows - * - * @return nothing - */ -/client/verb/nanoclose(var/uiref as text) - set hidden = 1 // hide this verb from the user's panel - set name = "nanoclose" // no autocomplete on cmd line - - var/datum/nanoui/ui = locate(uiref) - - if (ui) - ui.close() - - if (ui.on_close_logic) - if(ui.ref) - var/href = "close=1" - src.Topic(href, params2list(href), ui.ref) // this will direct to the atom's - // Topic() proc via client.Topic() - else - // no atomref specified (or not found) - // so just reset the user mob's machine var - if(src && src.mob) - src.mob.unset_machine() - /** * Push data to an already open UI window * diff --git a/code/modules/reagents/Chemistry-Machinery.dm b/code/modules/reagents/Chemistry-Machinery.dm index a351e2ca779..30156038d18 100644 --- a/code/modules/reagents/Chemistry-Machinery.dm +++ b/code/modules/reagents/Chemistry-Machinery.dm @@ -67,19 +67,27 @@ del(src) return + /** + * The ui_interact proc is used to open and update Nano UIs + * If ui_interact is not used then the UI will not update correctly + * ui_interact is currently defined for /atom/movable + * + * @param user /mob The mob who is interacting with this ui + * @param ui_key string A string key to use for this ui. Allows for multiple unique uis on one obj/mob (defaut value "main") + * + * @return nothing + */ /obj/machinery/chem_dispenser/ui_interact(mob/user, ui_key = "main") if(stat & (BROKEN|NOPOWER)) return if(user.stat || user.restrained()) return + // this is the data which will be sent to the ui var/data[0] - data["amount"] = amount data["energy"] = energy data["maxEnergy"] = max_energy - data["isBeakerLoaded"] = beaker ? 1 : 0 - var beakerContents[0] var beakerCurrentVolume = 0 if(beaker && beaker:reagents && beaker:reagents.reagent_list.len) @@ -102,10 +110,9 @@ chemicals.Add(list(list("title" = temp.name, "id" = temp.id, "commands" = list("dispense" = temp.id)))) // list in a list because Byond merges the first list... data["chemicals"] = chemicals - //user << list2json(data) - var/datum/nanoui/ui = nanomanager.get_open_ui(user, src, ui_key) if (!ui) + // the ui does not exist, so we'll create a new one ui = new(user, src, ui_key, "chem_dispenser.tmpl", "Chem Dispenser 5000", 370, 585) // When the UI is first opened this is the data it will use ui.set_initial_data(data)