StaticItem

StaticItem

class

Item prototype

  • read-only Assigning to the field raises an error.
  • 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
image Texture2D Item image in UI
image_path string Icon path relative to the owning mod folder
stack_size integer Size of item stack
tier integer Item unlock tier
type read-only string What the item is: "solid", "fluid" or "abstract"
unit_mul number multiplier for UI
mesh StaticMesh Mesh for item rendering in world
block StaticBlock Buildable object pointer for this item
custom_data boolean Is item instance contains CustomData
logic Class Class for item while in hand
lua table? Lua prototype table
tags string Space separated search tags
category string In-game database category
equipment_slot string Equipment slot this item fits (Jetpack, Light)
label Loc Localized item name
description_parts Loc[] Localized description paragraphs
Standard members (5)

Every class of this kind carries these.

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

Subclasses

Used by