getText
getText: (InfoBox) -> string?The caption. Abstract: a subclass defines it.
InfoBox.new(…)| Method | Returns | Description |
|---|---|---|
getText() | string? | The caption. Abstract: a subclass defines it. |
getTextColor() | Color? | The caption's colour (nil: white). Abstract: a subclass defines it. |
render() | boolean | Whether to show the box this frame: true; override it. Anything but true hides it. |
cull() | boolean | Whether to remove the box (asked once a game tick): false; override it. |
getName() | string | The key its detached group is saved under: <plugin>_<class> (see the class doc). Override it to choose another. |
getPlugin() | PluginObject? | The plugin it was made with: the manager orders a priority's boxes by its name. |
getImage() | BufferedImage? | The image. |
setImage(BufferedImage?) | () | Sets the image; once added, infoBoxManager:updateInfoBoxImage(box) rescales it. |
getPriority() | InfoBoxPriority? | The priority (default NONE). |
setPriority(InfoBoxPriority?) | () | The priority: HIGH boxes come first, then MED, NONE, LOW; within one, by plugin name. Read when the box is added. |
getTooltip() | string? | The hover tooltip (<br>, <col=>), or nil. |
setTooltip(string?) | () | The hover tooltip. |
getMenuEntries() | {OverlayMenuEntry} | The live list of the box's shift-right-click entries (the manager adds Detach, Flip and, outside the default group, Delete). |
setMenuEntries({OverlayMenuEntry}) | () | Replaces the list. |
isInstance(any) | boolean | Whether obj is an instance of this class or a subclass of it, as made with class. |
new(BufferedImage?, any?) | InfoBox | The constructor: the image, the plugin, priority NONE. A subclass calls it as X.super.init(self, image, plugin). |
| Method | Returns | Description |
|---|---|---|
InfoBoxClass.new | InfoBox | The constructor: the image, the plugin, priority NONE. A subclass calls it as X.super.init(self, image, plugin). |
InfoBoxManager.getInfoBoxes | {InfoBox} | This plugin's boxes, group by group in the manager's order. |
getTextgetText: (InfoBox) -> string?The caption. Abstract: a subclass defines it.
getTextColorgetTextColor: (InfoBox) -> Color?The caption's colour (nil: white). Abstract: a subclass defines it.
renderrender: (InfoBox) -> booleanWhether to show the box this frame: true; override it. Anything but true hides it.
cullcull: (InfoBox) -> booleanWhether to remove the box (asked once a game tick): false; override it.
getNamegetName: (InfoBox) -> stringThe key its detached group is saved under: <plugin>_<class> (see the class doc). Override it to choose another.
getPlugingetPlugin: (InfoBox) -> PluginObject?The plugin it was made with: the manager orders a priority's boxes by its name.
getImagegetImage: (InfoBox) -> BufferedImage?The image.
setImagesetImage: (InfoBox, BufferedImage?) -> ()Sets the image; once added, infoBoxManager:updateInfoBoxImage(box) rescales it.
getPrioritygetPriority: (InfoBox) -> InfoBoxPriority?The priority (default NONE).
setPrioritysetPriority: (InfoBox, InfoBoxPriority?) -> ()The priority: HIGH boxes come first, then MED, NONE, LOW; within one, by plugin name. Read when the box is added.
getTooltipgetTooltip: (InfoBox) -> string?The hover tooltip (<br>, <col=>), or nil.
setTooltipsetTooltip: (InfoBox, string?) -> ()The hover tooltip.
getMenuEntriesgetMenuEntries: (InfoBox) -> {OverlayMenuEntry}The live list of the box's shift-right-click entries (the manager adds Detach, Flip and, outside the default group, Delete).
setMenuEntriessetMenuEntries: (InfoBox, {OverlayMenuEntry}) -> ()Replaces the list.
isInstanceisInstance: (any) -> booleanWhether obj is an instance of this class or a subclass of it, as made with class.
newnew: (BufferedImage?, any?) -> InfoBoxThe constructor: the image, the plugin, priority NONE. A subclass calls it as X.super.init(self, image, plugin).