| is_blueprint_setup() | → boolean | Is this blueprint item setup? [...] |
Is this blueprint item setup? [...] | ||
| get_blueprint_entities() | → array[BlueprintEntity]? | The entities in this blueprint. |
The entities in this blueprint. | ||
| set_blueprint_entities(entities) | Set new entities to be a part of this blueprint. | |
Set new entities to be a part of this blueprint. | ||
| add_ammo(amount) | Add ammo to this ammo item. | |
Add ammo to this ammo item. | ||
| drain_ammo(amount) | Remove ammo from this ammo item. | |
Remove ammo from this ammo item. | ||
| add_durability(amount) | Add durability to this tool item. | |
Add durability to this tool item. | ||
| drain_durability(amount) | Remove durability from this tool item. | |
Remove durability from this tool item. | ||
| use_capsule(entity, target_position) | → array[LuaEntity] | Use the capsule item with the entity as the source, targeting the given position. |
Use the capsule item with the entity as the source, targeting the given position. | ||
| can_set_stack(stack?) | → boolean | Would a call to LuaItemStack::set_stack succeed? |
Would a call to LuaItemStack::set_stack succeed? | ||
| set_stack(stack?) | → boolean | Set this item stack to another item stack. |
Set this item stack to another item stack. | ||
| transfer_stack(stack) | → boolean | Transfers the given item stack into this item stack. |
Transfers the given item stack into this item stack. | ||
| export_stack() | → string | Export a supported item (blueprint, blueprint-book, deconstruction-planner, upgrade-planner, item-with-tags) to a string. |
Export a supported item (blueprint, blueprint-book, deconstruction-planner, upgrade-planner, item-with-tags) to a string. | ||
| import_stack(data) | → int | Import a supported item (blueprint, blueprint-book, deconstruction-planner, upgrade-planner, item-with-tags) from a string. |
Import a supported item (blueprint, blueprint-book, deconstruction-planner, upgrade-planner, item-with-tags) from a string. | ||
| swap_stack(stack) | → boolean | Swaps this item stack with the given item stack if allowed. |
Swaps this item stack with the given item stack if allowed. | ||
| clear() | Clear this item stack. | |
Clear this item stack. | ||
| get_blueprint_tiles() | → array[Tile]? | A list of the tiles in this blueprint. |
A list of the tiles in this blueprint. | ||
| set_blueprint_tiles(tiles) | Set specific tiles in this blueprint. | |
Set specific tiles in this blueprint. | ||
| get_inventory(inventory) | → LuaInventory? | Access the inner inventory of an item. |
Access the inner inventory of an item. | ||
| build_blueprint{surface=…, force=…, position=…, force_build?=…, direction?=…, skip_fog_of_war?=…, by_player?=…, raise_built?=…} | → array[LuaEntity] | Build this blueprint or blueprint book at the given location. [...] |
Build this blueprint or blueprint book at the given location. [...] | ||
| deconstruct_area{surface=…, force=…, area=…, skip_fog_of_war?=…, by_player?=…} | Deconstruct the given area with this deconstruction item. | |
Deconstruct the given area with this deconstruction item. | ||
| cancel_deconstruct_area{surface=…, force=…, area=…, skip_fog_of_war?=…, by_player?=…} | Cancel deconstruct the given area with this deconstruction item. | |
Cancel deconstruct the given area with this deconstruction item. | ||
| create_blueprint{surface=…, force=…, area=…, always_include_tiles?=…, include_entities?=…, include_modules?=…, include_station_names?=…, include_trains?=…, include_fuel?=…} | → dictionary[uint→ LuaEntity] | Sets up this blueprint using the found blueprintable entities/tiles on the surface. |
Sets up this blueprint using the found blueprintable entities/tiles on the surface. | ||
| get_tag(tag_name) | → AnyBasic? | Gets the tag with the given name or returns |
Gets the tag with the given name or returns | ||
| set_tag(tag_name, tag) | Sets the tag with the given name and value. | |
Sets the tag with the given name and value. | ||
| remove_tag(tag) | → boolean | Removes a tag with the given name. |
Removes a tag with the given name. | ||
| clear_blueprint() | Clears this blueprint item. | |
Clears this blueprint item. | ||
| get_entity_filter(index) | → string? | Gets the entity filter at the given index for this deconstruction item. |
Gets the entity filter at the given index for this deconstruction item. | ||
| set_entity_filter(index, filter) | → boolean | Sets the entity filter at the given index for this deconstruction item. |
Sets the entity filter at the given index for this deconstruction item. | ||
| get_tile_filter(index) | → string? | Gets the tile filter at the given index for this deconstruction item. |
Gets the tile filter at the given index for this deconstruction item. | ||
| set_tile_filter(index, filter) | → boolean | Sets the tile filter at the given index for this deconstruction item. |
Sets the tile filter at the given index for this deconstruction item. | ||
| clear_deconstruction_item() | Clears all settings/filters on this deconstruction item resetting it to default values. | |
Clears all settings/filters on this deconstruction item resetting it to default values. | ||
| clear_upgrade_item() | Clears all settings/filters on this upgrade item resetting it to default values. | |
Clears all settings/filters on this upgrade item resetting it to default values. | ||
| get_mapper(index, type) | → UpgradeFilter | Gets the filter at the given index for this upgrade item. |
Gets the filter at the given index for this upgrade item. | ||
| set_mapper(index, type, filter) | Sets the module filter at the given index for this upgrade item. | |
Sets the module filter at the given index for this upgrade item. | ||
| get_blueprint_entity_count() | → uint | Gets the number of entities in this blueprint item. |
Gets the number of entities in this blueprint item. | ||
| get_blueprint_entity_tags(index) | → Tags | Gets the tags for the given blueprint entity index in this blueprint item. |
Gets the tags for the given blueprint entity index in this blueprint item. | ||
| set_blueprint_entity_tags(index, tags) | Sets the tags on the given blueprint entity index in this blueprint item. | |
Sets the tags on the given blueprint entity index in this blueprint item. | ||
| get_blueprint_entity_tag(index, tag) | → AnyBasic? | Gets the given tag on the given blueprint entity index in this blueprint item. |
Gets the given tag on the given blueprint entity index in this blueprint item. | ||
| set_blueprint_entity_tag(index, tag, value) | Sets the given tag on the given blueprint entity index in this blueprint item. | |
Sets the given tag on the given blueprint entity index in this blueprint item. | ||
| create_grid() | → LuaEquipmentGrid | Creates the equipment grid for this item if it doesn't exist and this is an item-with-entity-data that supports equipment grids. |
Creates the equipment grid for this item if it doesn't exist and this is an item-with-entity-data that supports equipment grids. | ||
| help() | → string | All methods and properties that this object supports. |
All methods and properties that this object supports. | ||
| valid_for_read [R] | ::boolean | Is this valid for reading? [...] |
Is this valid for reading? [...] | ||
| prototype [R] | ::LuaItemPrototype | Prototype of the item held in this stack. |
Prototype of the item held in this stack. | ||
| name [R] | ::string | Prototype name of the item held in this stack. |
Prototype name of the item held in this stack. | ||
| type [R] | ::string | Type of the item prototype. |
Type of the item prototype. | ||
| count [RW] | ::uint | Number of items in this stack. |
Number of items in this stack. | ||
| grid [R] | ::LuaEquipmentGrid? | The equipment grid of this item, if any. |
The equipment grid of this item, if any. | ||
| health [RW] | ::float | How much health the item has, as a number in range |
How much health the item has, as a number in range | ||
| durability [RW] | ::double? | Durability of the contained item. [...] |
Durability of the contained item. [...] | ||
| ammo [RW] | ::uint | Number of bullets left in the magazine. |
Number of bullets left in the magazine. | ||
| blueprint_icons [RW] | ::array[BlueprintSignalIcon]? | Icons of this blueprint item, blueprint book, deconstruction item or upgrade planner. [...] |
Icons of this blueprint item, blueprint book, deconstruction item or upgrade planner. [...] | ||
| blueprint_snap_to_grid [RW] | ::TilePosition? | The snapping grid size in this blueprint item. [...] |
The snapping grid size in this blueprint item. [...] | ||
| blueprint_position_relative_to_grid [RW] | ::TilePosition? | The offset from the absolute grid. [...] |
The offset from the absolute grid. [...] | ||
| blueprint_absolute_snapping [RW] | ::boolean | If absolute snapping is enabled on this blueprint item. |
If absolute snapping is enabled on this blueprint item. | ||
| label [RW] | ::string? | The current label for this item, if any. |
The current label for this item, if any. | ||
| label_color [RW] | ::Color? | The current label color for this item, if any. |
The current label color for this item, if any. | ||
| allow_manual_label_change [RW] | ::boolean | Whether the label for this item can be manually changed. [...] |
Whether the label for this item can be manually changed. [...] | ||
| cost_to_build [R] | ::dictionary[string→ uint] | Raw materials required to build this blueprint. [...] |
Raw materials required to build this blueprint. [...] | ||
| extends_inventory [RW] | ::boolean | If this item extends the inventory it resides in (provides its contents for counts, crafting, insertion). [...] |
If this item extends the inventory it resides in (provides its contents for counts, crafting, insertion). [...] | ||
| prioritize_insertion_mode [RW] | ::"default" or "never" or "always" or "when-manually-filtered" | The insertion mode priority this ItemWithInventory uses when items are inserted into an inventory it resides in. [...] |
The insertion mode priority this ItemWithInventory uses when items are inserted into an inventory it resides in. [...] | ||
| default_icons [R] | ::array[BlueprintSignalIcon] | The default icons for a blueprint item. |
The default icons for a blueprint item. | ||
| tags [RW] | ::Tags | |
| custom_description [RW] | ::LocalisedString | The custom description this item-with-tags. [...] |
The custom description this item-with-tags. [...] | ||
| entity_filters [RW] | ::array[string] | The entity filters for this deconstruction item. [...] |
The entity filters for this deconstruction item. [...] | ||
| tile_filters [RW] | ::array[string] | The tile filters for this deconstruction item. [...] |
The tile filters for this deconstruction item. [...] | ||
| entity_filter_mode [RW] | ::defines.deconstruction_item.entity_filter_mode | The blacklist/whitelist entity filter mode for this deconstruction item. |
The blacklist/whitelist entity filter mode for this deconstruction item. | ||
| tile_filter_mode [RW] | ::defines.deconstruction_item.tile_filter_mode | The blacklist/whitelist tile filter mode for this deconstruction item. |
The blacklist/whitelist tile filter mode for this deconstruction item. | ||
| tile_selection_mode [RW] | ::defines.deconstruction_item.tile_selection_mode | The tile selection mode for this deconstruction item. |
The tile selection mode for this deconstruction item. | ||
| trees_and_rocks_only [RW] | ::boolean | If this deconstruction item is set to allow trees and rocks only. |
If this deconstruction item is set to allow trees and rocks only. | ||
| entity_filter_count [R] | ::uint | The number of entity filters this deconstruction item supports. |
The number of entity filters this deconstruction item supports. | ||
| tile_filter_count [R] | ::uint | The number of tile filters this deconstruction item supports. |
The number of tile filters this deconstruction item supports. | ||
| active_index [RW] | ::uint? | The active blueprint index for this blueprint book. [...] |
The active blueprint index for this blueprint book. [...] | ||
| item_number [R] | ::uint? | The unique identifier for this item , if any. [...] |
The unique identifier for this item , if any. [...] | ||
| connected_entity [RW] | ::LuaEntity? | If this item is a spidertron remote that has a spidertron bound to it, it returns the connected spider-vehicle entity. |
If this item is a spidertron remote that has a spidertron bound to it, it returns the connected spider-vehicle entity. | ||
| entity_label [RW] | ::string? | If this is an item with entity data, get the stored entity label. |
If this is an item with entity data, get the stored entity label. | ||
| entity_color [RW] | ::Color? | If this is an item with entity data, get the stored entity color. |
If this is an item with entity data, get the stored entity color. | ||
| is_blueprint [R] | ::boolean | If this is a blueprint item. |
If this is a blueprint item. | ||
| is_blueprint_book [R] | ::boolean | If this is a blueprint book item. |
If this is a blueprint book item. | ||
| is_module [R] | ::boolean | If this is a module item. |
If this is a module item. | ||
| is_ammo [R] | ::boolean | If this is an ammo item. |
If this is an ammo item. | ||
| is_tool [R] | ::boolean | If this is a tool item. |
If this is a tool item. | ||
| is_mining_tool [R] | ::boolean | If this is a mining tool item. |
If this is a mining tool item. | ||
| is_armor [R] | ::boolean | If this is an armor item. |
If this is an armor item. | ||
| is_repair_tool [R] | ::boolean | If this is a repair tool item. |
If this is a repair tool item. | ||
| is_item_with_label [R] | ::boolean | If this is an item with label item. |
If this is an item with label item. | ||
| is_item_with_inventory [R] | ::boolean | If this is an item with inventory item. |
If this is an item with inventory item. | ||
| is_item_with_entity_data [R] | ::boolean | If this is an item with entity data item. |
If this is an item with entity data item. | ||
| is_selection_tool [R] | ::boolean | If this is a selection tool item. |
If this is a selection tool item. | ||
| is_item_with_tags [R] | ::boolean | If this is an item with tags item. |
If this is an item with tags item. | ||
| is_deconstruction_item [R] | ::boolean | If this is a deconstruction tool item. |
If this is a deconstruction tool item. | ||
| is_upgrade_item [R] | ::boolean | If this is a upgrade item. |
If this is a upgrade item. | ||
| valid [R] | ::boolean | Is this object valid? [...] |
Is this object valid? [...] | ||
| object_name [R] | ::string | The class name of this object. [...] |
The class name of this object. [...] | ||
