Merge pull request #3670 from Faerdan/dev

Nano UI Updates
This commit is contained in:
Chinsky
2013-09-12 00:11:39 -07:00
5 changed files with 84 additions and 59 deletions
+15 -6
View File
@@ -1,5 +1,5 @@
/obj/machinery/atmospherics/unary/cryo_cell
name = "Cryo Cell"
name = "cryo cell"
icon = 'icons/obj/cryogenics.dmi'
icon_state = "cell-off"
density = 1
@@ -62,14 +62,24 @@
/obj/machinery/atmospherics/unary/cryo_cell/attack_hand(mob/user)
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
var/data[0]
// 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]
@@ -111,10 +121,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)
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)
+37 -1
View File
@@ -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
+4 -44
View File
@@ -11,7 +11,7 @@ nanoui is used to open and update nano browser uis
#define STATUS_UPDATE 1 // ORANGE Visability
#define STATUS_DISABLED 0 // RED Visability
/datum/nanoui
/datum/nanoui
// the user who opened this ui
var/mob/user
// the object this ui "belongs" to
@@ -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
@@ -180,8 +180,7 @@ nanoui is used to open and update nano browser uis
data["ui"] = list(
"status" = status,
"user" = list("name" = user.name)
)
//user << list2json(data)
)
return data
/**
@@ -241,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)
*
@@ -272,8 +271,6 @@ nanoui is used to open and update nano browser uis
if (initial_data.len > 0)
initial_data_json = list2json(initial_data)
//user << initial_data_json
var/url_parameters_json = list2json(list("src" = "\ref[src]"))
return {"<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
@@ -374,45 +371,11 @@ nanoui is used to open and update nano browser uis
*/
/datum/nanoui/proc/on_close_winset()
if(!user.client)
world << "ERROR: No user.client!?"
return
var/params = "\ref[src]"
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
//world << "world [src] looking for [uiref]"
var/datum/nanoui/ui = locate(uiref)
if (ui)
//world << "[src] UI found [ui.window_id]"
ui.close()
if (ui.on_close_logic)
if(ui.ref)
var/href = "close=1"
//world << "[src] Topic [href] [ui.ref]"
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)
//world << "[src] was [src.mob.machine], setting to null"
src.mob.unset_machine()
else
world << "[src] UI not found"
/**
* Push data to an already open UI window
*
@@ -424,9 +387,7 @@ nanoui is used to open and update nano browser uis
return // Cannot update UI, no visibility
data = add_default_data(data)
//user << list2json(data)
user << output(list2params(list(list2json(data))),"[window_id].browser:receiveUpdateData")
//on_close_winset()
/**
* This Topic() proc is called whenever a user clicks on a link within a Nano UI
@@ -438,7 +399,6 @@ nanoui is used to open and update nano browser uis
/datum/nanoui/Topic(href, href_list)
update_status(0) // update the status
if (status != STATUS_INTERACTIVE || user != usr) // If UI is not interactive or usr calling Topic is not the UI user
//usr << "Not interaction or wrong usr"
return
if (src_object.Topic(href, href_list))
+15 -8
View File
@@ -3,7 +3,7 @@
#define GAS 3
/obj/machinery/chem_dispenser
name = "Chem Dispenser"
name = "chem dispenser"
density = 1
anchored = 1
icon = 'icons/obj/chemical.dmi'
@@ -67,19 +67,27 @@
del(src)
return
/obj/machinery/chem_dispenser/ui_interact(mob/user, ui_key = "main")
/**
* 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)
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, 605)
// When the UI is first opened this is the data it will use
ui.set_initial_data(data)
+13
View File
@@ -0,0 +1,13 @@
--------------------------------
Nano UI Template Guide
--------------------------------
Nano UI uses templates, which are comprised of HTML and a markup syntax. The markup allows you
to easily add conditionals (if statements), loops (for loops) and custom formatting (using helpers).
Templates are stored in the /nano/templates folder and the file extension is .tmpl.
This guide is a work in progress. However the templating system is "JSRender", and documentation for it's
markup syntax can be found here: http://www.jsviews.com/#jsrtags