/datum/tooltipOptions

Vars
align	Computed axis alignment
bounds	Parsed target dimensions
content	The main content body to display
extra	Any random extra stuff
hud	Whether the target is a non-map atom
mouse	Parsed coordinate data as provided from MouseEntered etc procs in params
offset	Computed tooltip positioning offsets
pinned	Pinned means the tooltip requires clicking to open and close
size	Computed tooltip size overrides
theme	What theme to apply. See `tooltip.css` for available themes
title	The text to display as a title
transform	The transform matrix applied to the target atom
Procs
pushTiles	Apply an extra positioning offset to the tooltip.
setAlign	Set the position of the tooltip around the target
setBounds	Set the dimensions of the target, required for tooltip positioning. Unlikely you will need to use this directly.
setMouse	Parse and set the mouse target position
setOffset	Set positioning offsets around the target, for example to push the tooltip down further away.
setSize	Override the size of the tooltip. Note that dimensions will still not exceed maximums set in `tooltip.css`, and are still subject to window/dpi scaling.

Var Details

var
align
– /list

Computed axis alignment

var
bounds
– /list

Parsed target dimensions

var
content

The main content body to display

var
extra
– /list

Any random extra stuff

var
hud

Whether the target is a non-map atom

var
mouse
– /list

Parsed coordinate data as provided from MouseEntered etc procs in params

var
offset
– /list

Computed tooltip positioning offsets

var
pinned

Pinned means the tooltip requires clicking to open and close

var
size
– /list

Computed tooltip size overrides

var
theme

What theme to apply. See tooltip.css for available themes

var
title

The text to display as a title

var
transform

The transform matrix applied to the target atom

Proc Details

proc
pushTiles
(direction, amount)

Apply an extra positioning offset to the tooltip.

Arguments:

direction (int) - Which way to push the tooltip, e.g. NORTH
amount (int) - How many tiles to move

proc
setAlign
(flags)

Set the position of the tooltip around the target

Arguments:

flags (int) - Bitmask representing alignment. See _std\defines\tooltips.dm for available flags. Multiple flags can be combined, e.g. TOOLTIP_TOP | TOOLTIP_CENTER

proc
setBounds
(/list/newBounds)

Set the dimensions of the target, required for tooltip positioning. Unlikely you will need to use this directly.

Arguments:

newBounds (list) - Width and height respectively, e.g. list(200, 300)

proc
setMouse
(params)

Parse and set the mouse target position

Arguments:

params (string) - Provided from MouseEntered (and similar) procs

proc
setOffset
(/list/newOffset)

Set positioning offsets around the target, for example to push the tooltip down further away.

Arguments:

newOffset (list) - X and Y pixels respectively, e.g. list(10, 20)

proc
setSize
(/list/newSize)

Override the size of the tooltip. Note that dimensions will still not exceed maximums set in tooltip.css, and are still subject to window/dpi scaling.

Arguments:

newSize (list) - Width and height respectively, e.g. list(200, 300) Use 0 for either to use the automatic size for that axis

/datum/tooltipOptions

Vars

Procs

Var Details

var align – /list

var bounds – /list

var content

var extra – /list

var hud

var mouse – /list

var offset – /list

var pinned

var size – /list

var theme

var title

var transform

Proc Details

proc pushTiles(direction, amount)

proc setAlign(flags)

proc setBounds(/list/newBounds)

proc setMouse(params)

proc setOffset(/list/newOffset)

proc setSize(/list/newSize)

var
align
– /list

var
bounds
– /list

var
content

var
extra
– /list

var
hud

var
mouse
– /list

var
offset
– /list

var
pinned

var
size
– /list

var
theme

var
title

var
transform

proc
pushTiles
(direction, amount)

proc
setAlign
(flags)

proc
setBounds
(/list/newBounds)

proc
setMouse
(params)

proc
setOffset
(/list/newOffset)

proc
setSize
(/list/newSize)