Skip to content

Mod Variables

Jump to bottom
AgentCucco edited this page Jan 27, 2021 · 3 revisions

This mod has some useful functions and variables you can (and should) access at all times.

Mod Variables.

Encyclopedia.ItemPools
  • 'table'. Contains the mod's custom itempool system. It uses custom itempools in order to allow better compatibility with modded pools.
  • The table syntax is the same as the ItemPoolType table, but every pool is 1 value higher, to handle table indexes better.
  • [EX]:
    • ItemPoolType.POOL_SHOP = 1.
    • Encyclopedia.ItemPools.POOL_SHOP = 2.

General Item Variables.

Each item stored in the mod has several variables attached to them by default.

  • Spr: 'sprite'. The sprite attached to the item.
  • Name: 'string'. The name attached to the item. (can be nil)
  • Desc: 'string'. The description attached to the item. (can be nil)
  • WikiDesc: 'table'. The Wiki Description table attached to the item. (can be nil)
  • Pools: 'table'. The table of item pools attached to the item. (can be nil)
  • Title: 'string'. The name of the mod which registered this item. (can be nil)
  • ItemId: 'number'. The ID of the item registered.
  • typeString: 'string'. The type of item registered. (Ex. "items", "trinkets", "cards")
  • Class: 'string'. The class at which the item was assigned. (Defaults to "general mods")
  • Index: 'number'. The index of the item in the [typeString][Class] table. (can be nil)
  • AllIndex: 'number'. The index of the item in the [typeString] table. (can be nil)
  • AllIntIndex: 'number'. The index of the item in the [typeString] internal table.
    • Internal tables contain all items, regardless of whether they were hidden or not. Used to handle the Status submenu.
  • StatusFunc: 'function'. The status display function attached to the item. (can be nil)
  • CloseFunc: 'function'. The status close function attached to the item. (can be nil)

Clone this wiki locally