Script api.lua

Override Mod API

Functions

override.replaceItems (items, target) Unregisters craft items & adds them as aliases.
override.overrideItems (name, def) Unregisters craft items & registers names as aliases for new item.

Tables

override.overrideItems.def Item definition table for override.overrideItems


Functions

override.replaceItems (items, target)
Unregisters craft items & adds them as aliases.

Unregisters items & set names as aliases for another existing item.

Parameters:

  • items List of item names to be overridden (can be string for single item override).
  • target Item name of aliases' target.
override.overrideItems (name, def)
Unregisters craft items & registers names as aliases for new item.

Registers a new craft item & adds overridden item names as aliases.

Parameters:

  • name string Name of new item.
  • def table Item definition.

See also:

Tables

override.overrideItems.def
Item definition table for override.overrideItems

Fields:

  • overrides table Old items to be overridden (can be string for single item override).
  • description string Inventory tooltip.
  • groups table The groups of the craftitem.
  • inventory_image imagestring Texture displayed in inventory.
  • wield_image imagestring Texture displayed when wielded.
  • wield_scale pos Scale of wield_image.
  • stack_max int Maximum amount of items per stack (default: 99).
  • liquids_pointable bool Whether the player can point at liquids while wielding the item or not (default: false).
  • metadata
  • on_place callback Called on rightclick.
  • on_drop callback Called when dropping the item.
  • on_use callback Called on leftclick.

See also:

generated by LDoc 1.4.3 Last updated 2017-08-02 23:27:55