diff --git a/code/modules/tooltip/tooltip.dm b/code/modules/tooltip/tooltip.dm new file mode 100644 index 00000000000..e17d91092d1 --- /dev/null +++ b/code/modules/tooltip/tooltip.dm @@ -0,0 +1,110 @@ +/* +Tooltips v1.0 - 19/10/15 +Developed by Wire (#goonstation on irc.synirc.net) +- Initial release + +Configuration: +- Set control to the correct skin element (remember to actually place the skin element) +- Set file to the correct path for the .html file (remember to actually place the html file) +- Attach the datum to the user client on login, e.g. + /client/New() + src.tooltips = new /datum/tooltip(src) + +Usage: +- Define mouse event procs on your (probably HUD) object and simply call the show and hide procs respectively: + /obj/screen/hud + MouseEntered(location, control, params) + usr.client.tooltip.show(params, title = src.name, content = src.desc) + + MouseExited() + usr.client.tooltip.hide() + +Customization: +- Theming can be done by passing the theme var to show() and using css in the html file to change the look +- For your convenience some pre-made themes are included + +Notes: +- You may have noticed 90% of the work is done via javascript on the client. Gotta save those cycles man. +- This is entirely untested in any other codebase besides goonstation so I have no idea if it will port nicely. Good luck! +*/ + + +/datum/tooltip + var + client/owner + control = "mainwindow.tooltip" + file = 'code/modules/tooltip/tooltip.html' + showing = 0 + queueHide = 0 + + + New(client/C) + if (C) + src.owner = C + src.owner << browse(src.file, "window=[src.control]") + + ..() + + + proc/show(params = null, title = null, content = null, theme = "default") + if (!params || (!title && !content) || !src.owner) return 0 + src.showing = 1 + + //Format contents + if (title && content) + title = "

[title]

" + content = "

[content]

" + else if (title && !content) + title = "

[title]

" + else if (!title && content) + content = "

[content]

" + + //Send stuff to the tooltip + src.owner << output(list2params(list(src.control, params, src.owner.view, "[title][content]", theme)), "[src.control]:tooltip.update") + + //DEBUG + world << "SHOW() DEBUG" + world << "Tooltip Owner View: [src.owner.view]" + world << "Params: [params]" + + + //If a hide() was hit while we were showing, run hide() again to avoid stuck tooltips + src.showing = 0 + if (src.queueHide) + src.hide() + + return 1 + + + proc/hide() + if (src.queueHide) + spawn(1) + winshow(src.owner, src.control, 0) + else + winshow(src.owner, src.control, 0) + + src.queueHide = src.showing ? 1 : 0 + + return 1 + + + +/client/var/datum/tooltip/tooltip +/client/New() + ..() + tooltip = new /datum/tooltip(src) + + +/obj/screen/movable/action_button/MouseEntered(location,control,params) + usr.client.tooltip.show(params,title = name, content = desc) + + +/obj/screen/movable/action_button/MouseExited() + usr.client.tooltip.hide() + + +/mob/MouseEntered(location,control,params) + usr.client.tooltip.show(params,title = name, content = desc) + +/mob/MouseExited() + usr.client.tooltip.hide() \ No newline at end of file diff --git a/code/modules/tooltip/tooltip.html b/code/modules/tooltip/tooltip.html new file mode 100644 index 00000000000..c43193a21e9 --- /dev/null +++ b/code/modules/tooltip/tooltip.html @@ -0,0 +1,148 @@ + + + + Tooltip + + + + + +
+
+
+ + + + \ No newline at end of file diff --git a/interface/skin.dmf b/interface/skin.dmf index c69c03a293e..7fc9d8959bf 100644 --- a/interface/skin.dmf +++ b/interface/skin.dmf @@ -1694,6 +1694,32 @@ window "mainwindow" is-checked = false group = "" button-type = pushbox + elem "tooltip" + type = BROWSER + pos = 0,0 + size = 999x999 + anchor1 = none + anchor2 = none + font-family = "" + font-size = 0 + font-style = "" + text-color = #ffffff + background-color = #000000 + is-visible = false + is-disabled = false + is-transparent = false + is-default = false + border = none + drop-zone = false + right-click = false + saved-params = "" + on-size = "" + show-history = false + show-url = false + auto-format = false + use-title = false + on-show = "" + on-hide = "" window "mapwindow" elem "mapwindow" diff --git a/tgstation.dme b/tgstation.dme index f4272161a16..1390a87b835 100644 --- a/tgstation.dme +++ b/tgstation.dme @@ -1532,6 +1532,7 @@ #include "code\modules\telesci\gps.dm" #include "code\modules\telesci\telepad.dm" #include "code\modules\telesci\telesci_computer.dm" +#include "code\modules\tooltip\tooltip.dm" #include "code\orphaned procs\AStar.dm" #include "code\orphaned procs\dbcore.dm" #include "code\orphaned procs\priority_announce.dm"