LuaItemPrototype

Prototype of an item. For example, an item prototype can be obtained from LuaPrototypes::item by its name: prototypes.item["iron-plate"].

Parent

• LuaPrototypeBase

Attributes

place_result

• Read: LuaEntityPrototype
• Write: unknown
• Optional: true

Prototype of the entity that will be created by placing this item, if any.

place_as_equipment_result

• Read: LuaEquipmentPrototype
• Write: unknown
• Optional: true

Prototype of the equipment that will be created by placing this item in an equipment grid, if any.

place_as_tile_result

• Read: PlaceAsTileResult
• Write: unknown
• Optional: true

The place-as-tile result if one is defined, if any.

stackable

• Read: boolean
• Write: unknown
• Optional: false

Is this item allowed to stack at all?

stack_size

• Read: uint32
• Write: unknown
• Optional: false

Maximum stack size of the item specified by this prototype.

fuel_category

• Read: string
• Write: unknown
• Optional: true

The fuel category, if any.

burnt_result

• Read: LuaItemPrototype
• Write: unknown
• Optional: true

The result of burning this item as fuel, if any.

fuel_value

• Read: float
• Write: unknown
• Optional: false

Fuel value when burned.

fuel_acceleration_multiplier

• Read: double
• Write: unknown
• Optional: false

The acceleration multiplier when this item is used as fuel in a vehicle.

fuel_top_speed_multiplier

• Read: double
• Write: unknown
• Optional: false

The fuel top speed multiplier when this item is used as fuel in a vehicle.

fuel_emissions_multiplier

• Read: double
• Write: unknown
• Optional: false

The emissions multiplier if this is used as fuel.

fuel_acceleration_multiplier_quality_bonus

• Read: double
• Write: unknown
• Optional: false

Additional fuel acceleration multiplier per quality level.

fuel_top_speed_multiplier_quality_bonus

• Read: double
• Write: unknown
• Optional: false

Additional fuel top speed multiplier per quality level.

flags

• Read: ItemPrototypeFlags
• Write: unknown
• Optional: false

The flags for this item prototype.

rocket_launch_products

• Read: Array<Product>
• Write: unknown
• Optional: false

The results of launching this item in a rocket.

send_to_orbit_mode

• Read: "not-sendable" | "manual" | "automated"
• Write: unknown
• Optional: false

How this item interacts when being sent to orbit.

can_be_mod_opened

• Read: boolean
• Write: unknown
• Optional: false

If this item can be mod-opened.

spoil_result

• Read: LuaItemPrototype
• Write: unknown
• Optional: true

The spoil result of this item, if any

plant_result

• Read: LuaEntityPrototype
• Write: unknown
• Optional: true

The result entity when planting this item as a seed.

spoil_to_trigger_result

• Read: SpoilToTriggerResult
• Write: unknown
• Optional: true

destroyed_by_dropping_trigger

• Read: Array<TriggerItem>
• Write: unknown
• Optional: true

weight

• Read: Weight
• Write: unknown
• Optional: false

Weight of this item. More information on how item weight is determined can be found on its auxiliary page.

ingredient_to_weight_coefficient

• Read: double
• Write: unknown
• Optional: false

fuel_glow_color

• Read: Color
• Write: unknown
• Optional: true

default_import_location

• Read: LuaSpaceLocationPrototype
• Write: unknown
• Optional: false

factoriopedia_alternative

• Read: LuaItemPrototype
• Write: unknown
• Optional: true

An alternative prototype that will be used to display info about this prototype in Factoriopedia.

moved_to_hub_when_building

• Read: boolean
• Write: unknown
• Optional: false

ammo_category

• Read: LuaAmmoCategoryPrototype
• Write: unknown
• Optional: true

magazine_size

• Read: float
• Write: unknown
• Optional: true

Size of full magazine.

reload_time

• Read: float
• Write: unknown
• Optional: true

Amount of extra time (in ticks) it takes to reload the weapon after depleting the magazine.

equipment_grid

• Read: LuaEquipmentGridPrototype
• Write: unknown
• Optional: true

The prototype of this armor's equipment grid, if any.

resistances

• Read: Dict<string, Resistance>
• Write: unknown
• Optional: true

Resistances of this armor item, if any, indexed by damage type name.

collision_box

• Read: BoundingBox
• Write: unknown
• Optional: true

The collision box used by character entities when wearing this armor.

drawing_box

• Read: BoundingBox
• Write: unknown
• Optional: true

The drawing box used by character entities when wearing this armor.

provides_flight

• Read: boolean
• Write: unknown
• Optional: true

If this armor provides flight to character entities when worm.

capsule_action

• Read: CapsuleAction
• Write: unknown
• Optional: true

The capsule action for this capsule item prototype.

radius_color

• Read: Color
• Write: unknown
• Optional: true

attack_parameters

• Read: AttackParameters
• Write: unknown
• Optional: true

The gun attack parameters.

inventory_size

• Read: uint32
• Write: unknown
• Optional: true

The main inventory size for item-with-inventory-prototype.

item_filters

• Read: Array<LuaItemPrototype>
• Write: unknown
• Optional: true

item_group_filters

• Read: Array<LuaGroup>
• Write: unknown
• Optional: true

item_subgroup_filters

• Read: Array<LuaGroup>
• Write: unknown
• Optional: true

filter_mode

• Read: PrototypeFilterMode
• Write: unknown
• Optional: true

The filter mode used by this item with inventory.

localised_filter_message

• Read: LocalisedString
• Write: unknown
• Optional: true

The localised string used when the player attempts to put items into this item with inventory that aren't allowed.

default_label_color

• Read: Color
• Write: unknown
• Optional: true

The default label color used for this item with label, if any.

draw_label_for_cursor_render

• Read: boolean
• Write: unknown
• Optional: true

If true, and this item with label has a label it is drawn in place of the normal number when held in the cursor.

speed

• Read: float
• Write: unknown
• Optional: true

The repairing speed if this is a repairing tool.

module_effects

• Read: ModuleEffects
• Write: unknown
• Optional: true

Effects of this module.

category

• Read: string
• Write: unknown
• Optional: true

The name of a LuaModuleCategoryPrototype. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules of the same category with higher tier modules.

tier

• Read: uint32
• Write: unknown
• Optional: true

Tier of the module inside its category. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules with higher tier modules if they have the same category.

requires_beacon_alt_mode

• Read: boolean
• Write: unknown
• Optional: true

beacon_tint

• Read: Array<Color>
• Write: unknown
• Optional: true

rails

• Read: Array<LuaEntityPrototype>
• Write: unknown
• Optional: true

Prototypes of all rails possible to be used by this rail planner prototype.

support

• Read: LuaEntityPrototype
• Write: unknown
• Optional: true

The rail support used by this rail planner.

manual_length_limit

• Read: double
• Write: unknown
• Optional: true

always_include_tiles

• Read: boolean
• Write: unknown
• Optional: true

If tiles area always included when doing selection with this selection tool prototype.

skip_fog_of_war

• Read: boolean
• Write: unknown
• Optional: true

If this selection tool skips things covered by fog of war.

entity_filter_slots

• Read: uint32
• Write: unknown
• Optional: true

The number of entity filters this deconstruction item has.

tile_filter_slots

• Read: uint32
• Write: unknown
• Optional: true

The number of tile filters this deconstruction item has.

durability_description_key

• Read: string
• Write: unknown
• Optional: true

The durability message key used when displaying the durability of this tool.

factoriopedia_durability_description_key

• Read: string
• Write: unknown
• Optional: true

The durability message key used when displaying the durability of this tool in Factoriopedia.

durability_description_value

• Read: string
• Write: unknown
• Optional: true

The durability message value used when displaying the durability of this tool.

infinite

• Read: boolean
• Write: unknown
• Optional: true

If this tool item has infinite durability.

trigger

• Read: TriggerItem
• Write: unknown
• Optional: true

surface

• Read: LuaSurfacePrototype
• Write: unknown
• Optional: true

create_electric_network

• Read: boolean
• Write: unknown
• Optional: true

tiles

• Read: Array<SpacePlatformTileDefinition>
• Write: unknown
• Optional: true

initial_items

• Read: Array<ItemProduct>
• Write: unknown
• Optional: true

valid

• Read: boolean
• Write: unknown
• Optional: false

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

object_name

• Read: string
• Write: unknown
• Optional: false

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Methods

has_flag

LuaItemPrototype.has_flag(flag: ItemPrototypeFlag) -> boolean

Call As

itemPrototype.has_flag(flag)

Call Convention

• takes_table: false
• table_optional: false

Test whether this item prototype has a certain flag set.

Parameters

• flag: ItemPrototypeFlag — The flag to test.

Returns

• boolean

get_spoil_ticks

LuaItemPrototype.get_spoil_ticks(quality?: QualityID) -> uint32

Call As

itemPrototype.get_spoil_ticks()

Call Convention

• takes_table: false
• table_optional: false

The number of ticks before this item spoils, or 0 if it does not spoil.

Parameters

• quality?: QualityID

Returns

• uint32

get_ammo_type

LuaItemPrototype.get_ammo_type(ammo_source_type?: "default" | "player" | "turret" | "vehicle") -> AmmoType?

Call As

itemPrototype.get_ammo_type()

Call Convention

• takes_table: false
• table_optional: false

The type of this ammo prototype.

Parameters

• ammo_source_type?: "default" | "player" | "turret" | "vehicle" — Defaults to "default".

Returns

• AmmoType?

get_inventory_size_bonus

LuaItemPrototype.get_inventory_size_bonus(quality?: QualityID) -> uint32?

Call As

itemPrototype.get_inventory_size_bonus()

Call Convention

• takes_table: false
• table_optional: false

The inventory size bonus for this armor prototype.

Parameters

• quality?: QualityID

Returns

• uint32?

get_module_effects

LuaItemPrototype.get_module_effects(quality?: QualityID) -> ModuleEffects?

Call As

itemPrototype.get_module_effects()

Call Convention

• takes_table: false
• table_optional: false

Effects of this module at the specified quality.

Parameters

• quality?: QualityID

Returns

• ModuleEffects?

get_selection_border_color

LuaItemPrototype.get_selection_border_color(selection_mode: defines.selection_mode) -> Color?

Call As

itemPrototype.get_selection_border_color(selection_mode)

Call Convention

• takes_table: false
• table_optional: false

The color used when doing normal selection with this selection tool prototype.

Parameters

• selection_mode: defines.selection_mode

Returns

• Color?

get_selection_mode_flags

LuaItemPrototype.get_selection_mode_flags(selection_mode: defines.selection_mode) -> SelectionModeFlags?

Call As

itemPrototype.get_selection_mode_flags(selection_mode)

Call Convention

• takes_table: false
• table_optional: false

Flags that affect which entities will be selected.

Parameters

• selection_mode: defines.selection_mode

Returns

• SelectionModeFlags?

get_cursor_box_type

LuaItemPrototype.get_cursor_box_type(selection_mode: defines.selection_mode) -> CursorBoxRenderType?

Call As

itemPrototype.get_cursor_box_type(selection_mode)

Call Convention

• takes_table: false
• table_optional: false

Parameters

• selection_mode: defines.selection_mode

Returns

• CursorBoxRenderType?

get_entity_filter_mode

LuaItemPrototype.get_entity_filter_mode(selection_mode: defines.selection_mode) -> PrototypeFilterMode?

Call As

itemPrototype.get_entity_filter_mode(selection_mode)

Call Convention

• takes_table: false
• table_optional: false

The entity filter mode used by this selection tool.

Parameters

• selection_mode: defines.selection_mode

Returns

• PrototypeFilterMode?

get_tile_filter_mode

LuaItemPrototype.get_tile_filter_mode(selection_mode: defines.selection_mode) -> PrototypeFilterMode?

Call As

itemPrototype.get_tile_filter_mode(selection_mode)

Call Convention

• takes_table: false
• table_optional: false

The tile filter mode used by this selection tool.

Parameters

• selection_mode: defines.selection_mode

Returns

• PrototypeFilterMode?

get_entity_filters

LuaItemPrototype.get_entity_filters(selection_mode: defines.selection_mode) -> Array<LuaEntityPrototype>?

Call As

itemPrototype.get_entity_filters(selection_mode)

Call Convention

• takes_table: false
• table_optional: false

The entity filters used by this selection tool.

Parameters

• selection_mode: defines.selection_mode

Returns

• Array<LuaEntityPrototype>?

get_entity_type_filters

LuaItemPrototype.get_entity_type_filters(selection_mode: defines.selection_mode) -> Dict<string, true>?

Call As

itemPrototype.get_entity_type_filters(selection_mode)

Call Convention

• takes_table: false
• table_optional: false

The entity type filters used by this selection tool indexed by entity type.

The boolean value is meaningless and is used to allow easy lookup if a type exists in the dictionary.

Parameters

• selection_mode: defines.selection_mode

Returns

• Dict<string, true>?

get_tile_filters

LuaItemPrototype.get_tile_filters(selection_mode: defines.selection_mode) -> Array<LuaTilePrototype>?

Call As

itemPrototype.get_tile_filters(selection_mode)

Call Convention

• takes_table: false
• table_optional: false

The tile filters used by this selection tool.

Parameters

• selection_mode: defines.selection_mode

Returns

• Array<LuaTilePrototype>?

get_durability

LuaItemPrototype.get_durability(quality?: QualityID) -> double?

Call As

itemPrototype.get_durability()

Call Convention

• takes_table: false
• table_optional: false

The durability of this tool item prototype.

Parameters

• quality?: QualityID

Returns

• double?