Factorio » Classes » LuaControlFactorio 0.14.21

LuaControl

class LuaControl
get_inventory(inventory) → LuaInventory Get an inventory belonging to this entity.
get_quickbar() → LuaInventory Get the quickbar belonging to this entity if any.
can_insert(items) → boolean Can at least some items be inserted?
insert(items) → uint Insert items into this entity.
set_gui_arrow{type=…} Create an arrow which points at this entity.
clear_gui_arrow() Removes the arrow created by set_gui_arrow.
get_item_count(item) → uint Get the number of all or some items in this entity.
has_items_inside() → boolean Does this entity have any item inside it?
can_reach_entity(entity) → boolean Can a given entity be opened or accessed?
clear_items_inside() Remove all items from this entity.
remove_item(items) → uint Remove items from this entity.
teleport(position, surface) → boolean Teleport the entity to a given position, possibly on another surface.
update_selected_entity(position) Select an entity, as if by hovering the mouse above it.
clear_selected_entity() Unselect any selected entity.
disable_flashlight() Disable the flashlight.
enable_flashlight() Enable the flashlight.
get_craftable_count(recipe) → uint Gets the count of the given recipe that can be crafted.
begin_crafting{count=…, recipe=…, silent=…} → uint Begins crafting the given count of the given recipe
cancel_crafting(options) Cancels crafting the given count of the given crafting queue index
surface :: LuaSurface [R] The surface this entity is currently on.
position :: Position [R] Current position of the entity.
vehicle :: LuaEntity [R] The vehicle the player is currently sitting in; nil if none.
force :: LuaForce [R] The force of this entity.
selected :: LuaEntity [R] The currently selected entity; nil if none.
opened :: LuaEntity [R] The entity whose GUI the player currently has open; nil if none.
crafting_queue_size :: uint [R] Size of the crafting queue.
walking_state [R] Current walking state.
riding_state [R] Current riding state of this car or the vehicle this player is riding in.
mining_state [R] Current mining state.
cursor_stack :: LuaItemStack [R] The player's cursor stack.
driving :: boolean [R] true if the player is in a vehicle.
crafting_queue :: array of CraftingQueueItem [R] Gets the current crafting queue items.
cheat_mode :: boolean [R] When true hand crafting is free and instant
character_crafting_speed_modifier :: double [R]
character_mining_speed_modifier :: double [R]
character_running_speed_modifier :: double [R]
character_build_distance_bonus :: uint [R]
character_item_drop_distance_bonus :: uint [R]
character_reach_distance_bonus :: uint [R]
character_resource_reach_distance_bonus :: uint [R]
character_item_pickup_distance_bonus :: uint [R]
character_loot_pickup_distance_bonus :: uint [R]
quickbar_count_bonus :: uint [R]
character_inventory_slots_bonus :: uint [R]
character_logistic_slot_count_bonus :: uint [R]
character_trash_slot_count_bonus :: uint [R]
character_maximum_following_robot_count_bonus :: uint [R]
character_health_bonus :: float [R]
auto_trash_filters :: dictionary string → uint [R] The auto-trash filters.

This is an abstract base class containing the common functionality between LuaPlayer and character entities (see LuaEntity). When accessing these members through a LuaEntity, it must refer to a character entity.

get_inventory(inventory) → LuaInventory

Get an inventory belonging to this entity. This can be either the "main" inventory or some auxiliary one, like the module slots or logistic trash slots.

Parameters
inventory :: defines.inventory
Return value
or nil if this entity doesn't have an inventory with the given index.
get_quickbar() → LuaInventory

Get the quickbar belonging to this entity if any. This works for both the character entity (the little guy running around) and the god controller (sandbox, character-less players).

Return value
or nil if this entity doesn't have a quickbar.
can_insert(items) → boolean

Can at least some items be inserted?

Parameters
items :: SimpleItemStack: Items that would be inserted.
Return value
true if at least a part of the given items could be inserted into this inventory.
insert(items) → uint

Insert items into this entity. This works the same way as inserters or shift-clicking: the "best" inventory is chosen automatically.

Parameters
items :: SimpleItemStack: Items to insert.
Return value
Number of items actually inserted.
set_gui_arrow{type=…}

Create an arrow which points at this entity. This is used in the tutorial. For examples, see control.lua in the campaign missions.

Parameters
Table with the following fields:
  • type :: string: Where to point to. This field determines what other fields are mandatory. May be "nowhere", "goal", "entity_info", "active_window", "entity", "position", "crafting_queue", or "item_stack".
  • Additional type-specific parameters
    • entity
    • position
    • crafting_queue
      • crafting_queueindex :: uint
    • item_stack
      • inventory_index :: uint
      • item_stack_index :: uint
      • source :: string: May be either "player" or "target".
clear_gui_arrow()

Removes the arrow created by set_gui_arrow.

get_item_count(item) → uint

Get the number of all or some items in this entity.

Parameters
item :: string (optional): Prototype name of the item to count. If not specified, count all items.
has_items_inside() → boolean

Does this entity have any item inside it?

can_reach_entity(entity) → boolean

Can a given entity be opened or accessed?

Parameters
entity :: LuaEntity
clear_items_inside()

Remove all items from this entity.

remove_item(items) → uint

Remove items from this entity.

Parameters
items :: SimpleItemStack: Items to remove.
Return value
Number of items actually removed.
teleport(position, surface) → boolean

Teleport the entity to a given position, possibly on another surface.

Parameters
position :: Position: Where to teleport to.
surface :: SurfaceSpecification (optional): Surface to teleport to. If not given, will teleport to the entity's current surface.
Return value
true when the entity was successfully teleported.
Note: Some entities may not be teleported. For instance, walls, rail signals or entities with fluid boxes won't allow teleportation and this method will always return false when used on any such entity.
update_selected_entity(position)

Select an entity, as if by hovering the mouse above it.

Parameters
position :: Position: Position of the entity to select
clear_selected_entity()

Unselect any selected entity.

disable_flashlight()

Disable the flashlight.

enable_flashlight()

Enable the flashlight.

get_craftable_count(recipe) → uint

Gets the count of the given recipe that can be crafted.

Parameters
recipe :: string or LuaRecipe: The recipe.
Return value
The count that can be crafted.
begin_crafting{count=…, recipe=…, silent=…} → uint

Begins crafting the given count of the given recipe

Parameters
  • count :: uint: The count to craft.
  • recipe :: string or LuaRecipe: The recipe to craft.
  • silent :: boolean (optional): If false and the recipe can't be crafted the requested number of times printing the failure is skipped.
Return value
The count that was actually started crafting.
cancel_crafting(options)

Cancels crafting the given count of the given crafting queue index

Parameters
options: :
  • index :: uint: The crafting queue index.
  • count :: uint: The count to cancel crafting.
surface :: LuaSurface [Read-only]

The surface this entity is currently on.

position :: Position [Read-only]

Current position of the entity.

vehicle :: LuaEntity [Read-only]

The vehicle the player is currently sitting in; nil if none.

force :: LuaForce [Read-only]

The force of this entity.

selected :: LuaEntity [Read-only]

The currently selected entity; nil if none.

opened :: LuaEntity [Read-only]

The entity whose GUI the player currently has open; nil if none.

crafting_queue_size :: uint [Read-only]

Size of the crafting queue.

walking_state [Read-only]

Current walking state.

It is a table with two fields:

  • walking :: boolean: If false, the player is currently not walking; otherwise it's going somewhere
  • direction :: defines.direction: Direction where the player is walking

Example
Make the player go north. Note that a one-shot action like this will only make the player walk for one tick.
game.player.walking_state = {walking = true, direction = defines.direction.north}
riding_state [Read-only]

Current riding state of this car or the vehicle this player is riding in.

It is a table with two fields:

mining_state [Read-only]

Current mining state.

It is a table with two fields:

  • mining :: boolean: Whether the player is mining at all
  • position :: Position (optional): What the player is mining; not necessary when mining is false.

cursor_stack :: LuaItemStack [Read-only]

The player's cursor stack.

driving :: boolean [Read-only]

true if the player is in a vehicle. Writing to this attribute puts the player in or out of a vehicle.

crafting_queue :: array of CraftingQueueItem [Read-only]

Gets the current crafting queue items.

Each CraftingQueueItem is a table:

  • index :: uint: The crafting queue index
  • recipe :: string: The recipe.
  • count :: uint: The count being crafted.

cheat_mode :: boolean [Read-only]

When true hand crafting is free and instant

character_crafting_speed_modifier :: double [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_mining_speed_modifier :: double [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_running_speed_modifier :: double [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_build_distance_bonus :: uint [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_item_drop_distance_bonus :: uint [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_reach_distance_bonus :: uint [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_resource_reach_distance_bonus :: uint [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_item_pickup_distance_bonus :: uint [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_loot_pickup_distance_bonus :: uint [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
quickbar_count_bonus :: uint [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_inventory_slots_bonus :: uint [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_logistic_slot_count_bonus :: uint [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_trash_slot_count_bonus :: uint [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_maximum_following_robot_count_bonus :: uint [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
character_health_bonus :: float [Read-only]

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
auto_trash_filters :: dictionary string → uint [Read-only]

The auto-trash filters. The keys are item prototype names, the values are the slot values.

Note: When called on a LuaPlayer, it must be associated with a character (see LuaPlayer::character).
Example
This will set the auto-trash slots to keep only at most 20 iron plates and 42 copper wires in the player's inventory.
game.player.auto_trash_filters = {["iron-plate"] = 20, ["copper-cable"] = 42}