Script api.lua

List Items API

Chat Commands

list type [options] [string1] [string2] ... General list chat command.

Functions

listitems.list (player, l_type, switches, params, nocase) listitems base function.


Chat Commands

list type [options] [string1] [string2] ...

General list chat command.

Options:

  • -v (verbose) Display descriptions.
  • -s (shallow) Don't search descriptions.

Parameters:

  • type
  • [options]
  • [string1] [string2] ...

Functions

listitems.list (player, l_type, switches, params, nocase)
listitems base function.

Lists registered items or entities.

Parameters:

  • player string Name of player to receive message output.
  • l_type string Objects to list (e.g. "items", "entities", "ores", etc.).
  • switches string String list of switch options for manipulating output.
  • params string String list of parameters.
  • nocase boolean Case-insensitive matching if true.

Returns:

    boolean
generated by LDoc 1.4.6-antum-2 Last updated 2021-04-14 21:32:49