infoBoxManager

Methods
6
Fields
None

Getting one

infoBoxManager

Methods

MethodReturnsDescription
addInfoBox(InfoBox)()Adds the box to its saved group (the default one unless detached), after the boxes of a higher or equal priority and plugin name; scales it…
removeInfoBox(InfoBox?)()Removes the box and the manager's menu entries; nil or a box not added does nothing.
removeIf((InfoBox) -> boolean)()Removes this plugin's boxes filter answers true for (each asked once, then removed).
getInfoBoxes(){InfoBox}This plugin's boxes, group by group in the manager's order.
cull()()Removes this plugin's boxes whose cull() answers true (also done once a game tick).
updateInfoBoxImage(InfoBox)()Scales the box's image to fit the box size (shrinking only), after setImage.

Method details

addInfoBox

addInfoBox: (InfoBoxManager, InfoBox) -> ()

Adds the box to its saved group (the default one unless detached), after the boxes of a higher or equal priority and plugin name; scales its image to the box size. Raises for nil.

removeIf

removeIf: (InfoBoxManager, (InfoBox) -> boolean) -> ()

Removes this plugin's boxes filter answers true for (each asked once, then removed).

cull

cull: (InfoBoxManager) -> ()

Removes this plugin's boxes whose cull() answers true (also done once a game tick).