StaticTip

StaticTip

class

Encyclopedia entry shown to the player

  • load-only Usable only while mods load. The game seals these members once loading finishes, so a call or a write from a running world raises an error.

Fields

NameTypeDescription
label Loc Localized title
description_parts Loc[] Localized body paragraphs
image string Illustration path relative to the owning mod folder
context AutosizeInventory Inventory of items shown next to the text

Functions

StaticTip:add_context(item)

Add an item to the context inventory shown next to the text

item StaticItem Item to show

StaticTip:clear_context()

Remove every item from the context inventory

Standard members (5)

Every class of this kind carries these.

StaticTip.cast(object) Trying to cast Object into StaticTip
StaticTip.get_class() Return StaticTip class object
StaticTip.find(name) Looks StaticTip up in db, nil when there is none
StaticTip.get(name) Takes StaticTip from db, reports a miss to the log
StaticTip.reg(name) load-only Register a new StaticTip static object
Inherited from Prototype (2)
Inherited from Object (1)