LuaEquipmentGrid

An equipment grid is for example the inside of a power armor.

Attributes

prototype

• Read: LuaEquipmentGridPrototype
• Write: unknown
• Optional: false

width

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

Width of the equipment grid.

height

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

Height of the equipment grid.

equipment

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

All the equipment in this grid.

max_solar_energy

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

Maximum energy per tick that can be created by all solar panels in the equipment grid on the current surface. Actual generated energy varies depending on the daylight levels.

available_in_batteries

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

The total energy stored in all batteries in the equipment grid.

battery_capacity

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

Total energy storage capacity of all batteries in the equipment grid.

shield

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

The amount of shield hitpoints this equipment grid currently has across all shield equipment.

max_shield

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

The maximum amount of shield hitpoints this equipment grid has across all shield equipment.

inventory_bonus

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

The total amount of inventory bonus this equipment grid gives.

movement_bonus

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

The total amount of movement bonus this equipment grid gives.

Returns 0 if LuaEquipmentGrid::inhibit_movement_bonus is true.

inhibit_movement_bonus

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

Whether this grid's equipment movement bonus is active.

unique_id

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

Unique identifier of this equipment grid.

entity_owner

• Read: LuaEntity
• Write: unknown
• Optional: true

The entity that this equipment grid is owned by (in some inventory or item stack.)

If the owning entity is a character owned by some player and the player is disconnected this will return nil.

player_owner

• Read: LuaPlayer
• Write: unknown
• Optional: true

The player that this equipment grid is owned by (in some inventory or item stack.)

itemstack_owner

• Read: LuaItemStack
• Write: unknown
• Optional: true

The item stack that this equipment grid is owned by.

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

take

LuaEquipmentGrid.take{ position?: EquipmentPosition, equipment?: LuaEquipment, by_player?: PlayerIdentification } -> ItemWithQualityCount?

Call As

equipmentGrid.take{ position=position }

Call Convention

• takes_table: true
• table_optional: false

Remove an equipment from the grid.

Parameters

• position?: EquipmentPosition — Take the equipment that contains this position in the grid.
• equipment?: LuaEquipment — Take this exact equipment.
• by_player?: PlayerIdentification — If provided the action is done 'as' this player and on_player_removed_equipment is triggered.

Returns

• ItemWithQualityCount? — The removed equipment, or nil if no equipment was removed.

take_all

LuaEquipmentGrid.take_all(by_player?: PlayerIdentification) -> ItemWithQualityCounts

Call As

equipmentGrid.take_all()

Call Convention

• takes_table: false
• table_optional: false

Remove all equipment from the grid.

Parameters

• by_player?: PlayerIdentification — If provided, the action is done 'as' this player and on_player_removed_equipment is triggered.

Returns

• ItemWithQualityCounts — List of the equipment that has been removed.

clear

LuaEquipmentGrid.clear(by_player?: PlayerIdentification)

Call As

equipmentGrid.clear()

Call Convention

• takes_table: false
• table_optional: false

Clear all equipment from the grid, removing it without actually returning it.

Parameters

• by_player?: PlayerIdentification — If provided, the action is done 'as' this player and on_player_removed_equipment is triggered.

put

LuaEquipmentGrid.put{ name: EquipmentID, quality?: QualityID, position?: EquipmentPosition, by_player?: PlayerIdentification, ghost?: boolean } -> LuaEquipment?

Call As

equipmentGrid.put{ name="name" }

Call Convention

• takes_table: true
• table_optional: false

Insert an equipment into the grid.

Parameters

• name: EquipmentID — Equipment prototype name
• quality?: QualityID — The quality, nil for any or if not provided normal is used.
• position?: EquipmentPosition — Grid position to put the equipment in.
• by_player?: PlayerIdentification — If provided the action is done 'as' this player and on_player_placed_equipment is triggered.
• ghost?: boolean — If true, place the equipment as a ghost.

Returns

• LuaEquipment? — The newly-added equipment, or nil if the equipment could not be added.

can_move

LuaEquipmentGrid.can_move{ equipment: LuaEquipment, position: EquipmentPosition } -> boolean

Call As

equipmentGrid.can_move{ equipment=equipment, position=position }

Call Convention

• takes_table: true
• table_optional: false

Check whether moving an equipment would succeed.

Parameters

• equipment: LuaEquipment — The equipment to move
• position: EquipmentPosition — Where to put it

Returns

• boolean

move

LuaEquipmentGrid.move{ equipment: LuaEquipment, position: EquipmentPosition } -> boolean

Call As

equipmentGrid.move{ equipment=equipment, position=position }

Call Convention

• takes_table: true
• table_optional: false

Move an equipment within this grid.

Parameters

• equipment: LuaEquipment — The equipment to move
• position: EquipmentPosition — Where to put it

Returns

• boolean — true if the equipment was successfully moved.

get

LuaEquipmentGrid.get(position: EquipmentPosition) -> LuaEquipment?

Call As

equipmentGrid.get(position)

Call Convention

• takes_table: false
• table_optional: false

Find equipment in the Equipment Grid colliding with this position.

Parameters

• position: EquipmentPosition — The position

Returns

• LuaEquipment? — The found equipment, or nil if equipment occupying the given position could not be found.

get_contents

LuaEquipmentGrid.get_contents() -> Array<EquipmentWithQualityCounts>

Call As

equipmentGrid.get_contents()

Call Convention

• takes_table: false
• table_optional: false

Get counts of all equipment in this grid.

Returns

• Array<EquipmentWithQualityCounts> — List of all equipment in the grid.

get_generator_energy

LuaEquipmentGrid.get_generator_energy(quality?: QualityID) -> double

Call As

equipmentGrid.get_generator_energy()

Call Convention

• takes_table: false
• table_optional: false

Total energy per tick generated by the equipment inside this grid.

Parameters

• quality?: QualityID — Defaults to "normal".

Returns

• double

find

LuaEquipmentGrid.find(equipment: EquipmentWithQualityID, search_ghosts?: boolean) -> LuaEquipment?

Call As

equipmentGrid.find(equipment, true)

Call Convention

• takes_table: false
• table_optional: false

Find equipment by name.

Parameters

• equipment: EquipmentWithQualityID — Prototype of the equipment to find.
• search_ghosts?: boolean — If ghosts inner equipment should be searched. Defaults to false

Returns

• LuaEquipment? — The first found equipment, or nil if equipment could not be found.

count

LuaEquipmentGrid.count(equipment?: EquipmentWithQualityID) -> uint32

Call As

equipmentGrid.count()

Call Convention

• takes_table: false
• table_optional: false

Get the number of all or some equipment in this grid.

Parameters

• equipment?: EquipmentWithQualityID — The equipment to count. If not specified, count all equipment.

Returns

• uint32

revive

LuaEquipmentGrid.revive(equipment: LuaEquipment) -> LuaEquipment

Call As

equipmentGrid.revive(equipment)

Call Convention

• takes_table: false
• table_optional: false

Revives the given equipment ghost if possible.

Parameters

• equipment: LuaEquipment — The equipment ghost to revive.

Returns

• LuaEquipment

order_removal

LuaEquipmentGrid.order_removal(equipment: LuaEquipment) -> boolean

Call As

equipmentGrid.order_removal(equipment)

Call Convention

• takes_table: false
• table_optional: false

Marks the given equipment for removal. If the given equipment is a ghost it is removed.

Parameters

• equipment: LuaEquipment

Returns

• boolean — If the equipment was successfully marked for removal (or in the case of a ghost; removed.)

cancel_removal

LuaEquipmentGrid.cancel_removal(equipment: LuaEquipment) -> boolean

Call As

equipmentGrid.cancel_removal(equipment)

Call Convention

• takes_table: false
• table_optional: false

Cancels removal for the given equipment.

Parameters

• equipment: LuaEquipment

Returns

• boolean — If the equipment removal was successfully cancelled.