GeezerVison is showing github.com — Yogstation/code/modules/tooltip/tooltip.dm at master · yogstation13/Yogstation

This repository was archived by the owner on May 22, 2025. It is now read-only.

Expand file tree

tooltip.dm

Copy path

More file actions

Latest commit

History

126 lines (95 loc) · 3.84 KB

tooltip.dm

Copy path

File metadata and controls

126 lines (95 loc) · 3.84 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

Tooltips v1.1 - 22/10/15

Developed by Wire (#goonstation on irc.synirc.net)

- Added support for screen_loc pixel offsets. Should work. Maybe.

- Added init function to more efficiently send base vars

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:

/atom/movable/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!

- After testing and discussion (Wire, Remie, MrPerson, AnturK) ToolTips are ok and work for /tg/station13

/datum/tooltip

var/client/owner

var/control = "mainwindow.tooltip"

var/showing = 0

var/queueHide = 0

var/init = 0

/datum/tooltip/New(client/C)

if (C)

owner = C

var/datum/asset/stuff = get_asset_datum(/datum/asset/simple/jquery)

stuff.send(owner)

owner << browse(file2text('code/modules/tooltip/tooltip.html'), "window=[control]")

..()

/datum/tooltip/proc/show(atom/movable/thing, params = null, title = null, content = null, theme = "default", special = "none")

if (!thing || !params || (!title && !content) || !owner || !isnum(world.icon_size))

return 0

if (!init)

//Initialize some vars

init = 1

owner << output(list2params(list(world.icon_size, control)), "[control]:tooltip.init")

showing = 1

if (title && content)

title = "<h1>[title]</h1>"

content = "<p>[content]</p>"

else if (title && !content)

title = "<p>[title]</p>"

else if (!title && content)

content = "<p>[content]</p>"

// Strip macros from item names

title = replacetext(title, "\proper", "")

title = replacetext(title, "\improper", "")

//Make our dumb param object

params = {"{ "cursor": "[params]", "screenLoc": "[thing.screen_loc]" }"}

//Send stuff to the tooltip

var/view_size = getviewsize(owner.view)

owner << output(list2params(list(params, view_size[1] , view_size[2], "[title][content]", theme, special)), "[control]:tooltip.update")

//If a hide() was hit while we were showing, run hide() again to avoid stuck tooltips

showing = 0

if (queueHide)

hide()

return 1

/datum/tooltip/proc/hide()

queueHide = showing ? TRUE : FALSE

if (queueHide)

addtimer(CALLBACK(src, PROC_REF(do_hide)), 1)

else

do_hide()

return TRUE

/datum/tooltip/proc/do_hide()

winshow(owner, control, FALSE)

/* TG SPECIFIC CODE */

//Open a tooltip for user, at a location based on params

//Theme is a CSS class in tooltip.html, by default this wrapper chooses a CSS class based on the user's UI_style (Midnight, Plasmafire, Retro, etc)

//Includes sanity.checks

/proc/openToolTip(mob/user = null, atom/movable/tip_src = null, params = null,title = "",content = "",theme = "")

if(istype(user))

if(user.client && user.client.tooltips)

var/ui_style = user.client?.prefs?.read_preference(/datum/preference/choiced/ui_style)

if(!theme && ui_style)

theme = lowertext(ui_style)

if(!theme)

theme = "default"

user.client.tooltips.show(tip_src, params,title,content,theme)

//Arbitrarily close a user's tooltip

//Includes sanity checks.

/proc/closeToolTip(mob/user)

if(istype(user))

if(user.client && user.client.tooltips)

user.client.tooltips.hide()