name
name: string?The name the plugin list shows. <col=RRGGBB> (six hex digits) colours the text after it and </col> ends the colour, as in game text; emoji draw in colour. Search, sorting and tooltips use the name without the tags.
A value shape that methods take or return.
| Field | Type | Description |
|---|---|---|
name | string? | The name the plugin list shows. <col=RRGGBB> (six hex digits) colours the text after it and </col> ends the colour, as in game text; em… |
description | string? | The description the plugin list shows. |
tags | {string}? | What the plugin list's search matches. |
conflicts | {string}? | Names of plugins this one cannot run beside. |
enabledByDefault | boolean? | Whether it is enabled until the user chooses; true when absent. |
developerPlugin | boolean? | Loaded in developer mode only. |
icon | (BufferedImage | string)? | The side-panel icon, a BufferedImage (ImageUtil.loadImageResource(...)) or PNG bytes (Asset.bytes(...)). |
dependencies | {string}? | The plugins this one needs, by plugin id: Plugin.new{ dependencies = { "x" } }. The registry registers a dependency before what needs it… |
namename: string?The name the plugin list shows. <col=RRGGBB> (six hex digits) colours the text after it and </col> ends the colour, as in game text; emoji draw in colour. Search, sorting and tooltips use the name without the tags.
dependenciesdependencies: {string}?The plugins this one needs, by plugin id: Plugin.new{ dependencies = { "x" } }. The registry registers a dependency before what needs it and refuses a plugin whose dependency it does not have ("Unmet dependency for ..."). Four always-installed services are always met, named by class or package: XpTrackerPlugin/xptracker (xpTrackerService), SlayerPlugin/slayer (slayerPluginService), ItemStatPlugin/itemstats (itemStatChangesService), BankTagsPlugin/banktags (tagManager). The host's own service globals need no entry.