Tutorial:Script interfaces - Revision history

Bilka: Used category template because page can be translated

2026-03-03T09:16:38Z

Used category template because page can be translated

← Older revision		Revision as of 09:16, 3 March 2026
Line 95:		Line 95:
	* selected_prototype :: [https://lua-api.factorio.com/latest/concepts/SelectedPrototypeData.html SelectedPrototypeData] (optional): Provided if [https://lua-api.factorio.com/latest/prototypes/CustomInputPrototype.html#include_selected_prototype include_selected_prototype] is true.		* selected_prototype :: [https://lua-api.factorio.com/latest/concepts/SelectedPrototypeData.html SelectedPrototypeData] (optional): Provided if [https://lua-api.factorio.com/latest/prototypes/CustomInputPrototype.html#include_selected_prototype include_selected_prototype] is true.

	~~[[Category:~~Modding]]		{{C\|Modding}}

Xorimuth: building -> entity

2025-02-27T13:56:32Z

building -> entity

← Older revision		Revision as of 13:56, 27 February 2025
Line 91:		Line 91:
	* input_name :: [https://lua-api.factorio.com/latest/types/string.html string]: The name of the custom input.		* input_name :: [https://lua-api.factorio.com/latest/types/string.html string]: The name of the custom input.
	* cursor_position :: [https://lua-api.factorio.com/latest/concepts/MapPosition.html MapPosition]: The mouse cursor position when the input was activated.		* cursor_position :: [https://lua-api.factorio.com/latest/concepts/MapPosition.html MapPosition]: The mouse cursor position when the input was activated.
	* cursor_direction :: [https://lua-api.factorio.com/latest/defines.html#defines.direction defines.direction] (optional): The mouse cursor direction, for when the cursor contains a rotatable ~~building~~.		* cursor_direction :: [https://lua-api.factorio.com/latest/defines.html#defines.direction defines.direction] (optional): The mouse cursor direction, for when the cursor contains a rotatable entity.
	* cursor_display_location :: [https://lua-api.factorio.com/latest/concepts/GuiLocation.html GuiLocation]: The mouse cursor display location when the custom input was activated.		* cursor_display_location :: [https://lua-api.factorio.com/latest/concepts/GuiLocation.html GuiLocation]: The mouse cursor display location when the custom input was activated.
	* selected_prototype :: [https://lua-api.factorio.com/latest/concepts/SelectedPrototypeData.html SelectedPrototypeData] (optional): Provided if [https://lua-api.factorio.com/latest/prototypes/CustomInputPrototype.html#include_selected_prototype include_selected_prototype] is true.		* selected_prototype :: [https://lua-api.factorio.com/latest/concepts/SelectedPrototypeData.html SelectedPrototypeData] (optional): Provided if [https://lua-api.factorio.com/latest/prototypes/CustomInputPrototype.html#include_selected_prototype include_selected_prototype] is true.

	[[Category:Modding]]		[[Category:Modding]]

Xorimuth: Fix broken link, add new CustomInputEvent value

2025-02-27T13:56:05Z

Fix broken link, add new CustomInputEvent value

← Older revision		Revision as of 13:56, 27 February 2025
Line 2:		Line 2:
	== Script interfaces (LuaRemote) ==		== Script interfaces (LuaRemote) ==

	Script interfaces allow direct communication between simultaneously running scripts. This is done in form of defining a public interface with given functions. All the code regarding the interfaces communication is in the <code>remote</code> namespace. More info can be found in the offical api documentation, in this case [~~http~~://lua-api.factorio.com/latest/LuaRemote.html LuaRemote].		Script interfaces allow direct communication between simultaneously running scripts. This is done in form of defining a public interface with given functions. All the code regarding the interfaces communication is in the <code>remote</code> namespace. More info can be found in the offical api documentation, in this case [https://lua-api.factorio.com/latest/classes/LuaRemote.html LuaRemote].

	=== Defining interfaces ===		=== Defining interfaces ===
Line 85:		Line 85:
	end)</syntaxhighlight>		end)</syntaxhighlight>

	The [https://lua-api.factorio.com/latest/events.html#CustomInputEvent event] contains the following:		The [https://lua-api.factorio.com/latest/events.html#CustomInputEvent event ] contains the following:

	* player_index :: [https://lua-api.factorio.com/latest/concepts/uint.html uint]		* player_index :: [https://lua-api.factorio.com/latest/concepts/uint.html uint]
Line 91:		Line 91:
	* input_name :: [https://lua-api.factorio.com/latest/types/string.html string]: The name of the custom input.		* input_name :: [https://lua-api.factorio.com/latest/types/string.html string]: The name of the custom input.
	* cursor_position :: [https://lua-api.factorio.com/latest/concepts/MapPosition.html MapPosition]: The mouse cursor position when the input was activated.		* cursor_position :: [https://lua-api.factorio.com/latest/concepts/MapPosition.html MapPosition]: The mouse cursor position when the input was activated.
			* cursor_direction :: [https://lua-api.factorio.com/latest/defines.html#defines.direction defines.direction] (optional): The mouse cursor direction, for when the cursor contains a rotatable building.
	* cursor_display_location :: [https://lua-api.factorio.com/latest/concepts/GuiLocation.html GuiLocation]: The mouse cursor display location when the custom input was activated.		* cursor_display_location :: [https://lua-api.factorio.com/latest/concepts/GuiLocation.html GuiLocation]: The mouse cursor display location when the custom input was activated.
	* selected_prototype :: [https://lua-api.factorio.com/latest/concepts/SelectedPrototypeData.html SelectedPrototypeData] (optional): Provided if [https://lua-api.factorio.com/latest/prototypes/CustomInputPrototype.html#include_selected_prototype include_selected_prototype] is true.		* selected_prototype :: [https://lua-api.factorio.com/latest/concepts/SelectedPrototypeData.html SelectedPrototypeData] (optional): Provided if [https://lua-api.factorio.com/latest/prototypes/CustomInputPrototype.html#include_selected_prototype include_selected_prototype] is true.

	[[Category:Modding]]		[[Category:Modding]]

Bilka: Updated links to migrated prototype docs

2024-10-25T14:12:25Z

Updated links to migrated prototype docs

← Older revision		Revision as of 14:12, 25 October 2024
Line 51:		Line 51:
	== Custom input ==		== Custom input ==

	Keybindings can also be created. First the keybinding has to be defined in the data stage, see [~~[Prototype~~/~~CustomInput]~~]:		Keybindings can also be created. First the keybinding has to be defined in the data stage, see [https://lua-api.factorio.com/latest/prototypes/CustomInputPrototype.html CustomInputPrototype]:

	<syntaxhighlight lang="lua">local button={		<syntaxhighlight lang="lua">local button={
Line 65:		Line 65:
	* game-only: Blocks game inputs using the same key sequence but lets other custom inputs using the same key sequence fire.		* game-only: Blocks game inputs using the same key sequence but lets other custom inputs using the same key sequence fire.

	:''See also [~~[Types~~/ConsumingType]]''		:''See also [https://lua-api.factorio.com/latest/types/ConsumingType.html ConsumingType]''

	Locale definition:		Locale definition:
Line 87:		Line 87:
	The [https://lua-api.factorio.com/latest/events.html#CustomInputEvent event] contains the following:		The [https://lua-api.factorio.com/latest/events.html#CustomInputEvent event] contains the following:

	* player_index :: [~~[Types~~/~~uint32]~~]		* player_index :: [https://lua-api.factorio.com/latest/concepts/uint.html uint]
	* tick :: [~~[Types~~/~~uint32]~~]		* tick :: [https://lua-api.factorio.com/latest/concepts/uint.html uint]
	* input_name :: [~~[Types~~/string]]: The name of the custom input.		* input_name :: [https://lua-api.factorio.com/latest/types/string.html string]: The name of the custom input.
	* cursor_position :: [~~[Types~~/~~Position]~~]: The mouse cursor position when the input was activated.		* cursor_position :: [https://lua-api.factorio.com/latest/concepts/MapPosition.html MapPosition]: The mouse cursor position when the input was activated.
	* cursor_display_location :: [https://lua-api.factorio.com/latest/~~Concepts~~.html~~#GuiLocation~~ GuiLocation]: The mouse cursor display location when the custom input was activated.		* cursor_display_location :: [https://lua-api.factorio.com/latest/concepts/GuiLocation.html GuiLocation]: The mouse cursor display location when the custom input was activated.
	* selected_prototype :: [~~[Types~~/~~table]~~] (optional): Provided if [~~[Prototype~~/~~CustomInput~~#include_selected_prototype\|include_selected_prototype]] is true~~. This table has the following members:~~		* selected_prototype :: [https://lua-api.factorio.com/latest/concepts/SelectedPrototypeData.html SelectedPrototypeData] (optional): Provided if [https://lua-api.factorio.com/latest/prototypes/CustomInputPrototype.html#include_selected_prototype include_selected_prototype] is true.
	** base_type :: [[Types/string]]: E.g. "entity".
	** derived_type :: [[Types/string]]: E.g. "tree".
	** name :: [[Types/string]]: E.g. "tree-05".

	[[Category:Modding]]		[[Category:Modding]]

Bilka: Translations of the modding tutorials are allowed

2023-11-13T20:44:02Z

Translations of the modding tutorials are allowed

← Older revision		Revision as of 20:44, 13 November 2023
Line 1:		Line 1:
			{{Languages}}
	== Script interfaces (LuaRemote) ==		== Script interfaces (LuaRemote) ==

Ickputzdirwech: Removed {{Languages}}. added category modding

2023-11-12T09:38:00Z

Removed {{Languages}}. added category modding

← Older revision		Revision as of 09:38, 12 November 2023
Line 1:		Line 1:
	~~{{Languages}}~~
	== Script interfaces (LuaRemote) ==		== Script interfaces (LuaRemote) ==

Line 96:		Line 95:
	** derived_type :: [[Types/string]]: E.g. "tree".		** derived_type :: [[Types/string]]: E.g. "tree".
	** name :: [[Types/string]]: E.g. "tree-05".		** name :: [[Types/string]]: E.g. "tree-05".

			[[Category:Modding]]

Bilka: 1.1.83: cursor_display_location added to CustomInputEvent

2023-06-23T14:20:16Z

1.1.83: cursor_display_location added to CustomInputEvent

← Older revision		Revision as of 14:20, 23 June 2023
Line 91:		Line 91:
	* input_name :: [[Types/string]]: The name of the custom input.		* input_name :: [[Types/string]]: The name of the custom input.
	* cursor_position :: [[Types/Position]]: The mouse cursor position when the input was activated.		* cursor_position :: [[Types/Position]]: The mouse cursor position when the input was activated.
			* cursor_display_location :: [https://lua-api.factorio.com/latest/Concepts.html#GuiLocation GuiLocation]: The mouse cursor display location when the custom input was activated.
	* selected_prototype :: [[Types/table]] (optional): Provided if [[Prototype/CustomInput#include_selected_prototype\|include_selected_prototype]] is true. This table has the following members:		* selected_prototype :: [[Types/table]] (optional): Provided if [[Prototype/CustomInput#include_selected_prototype\|include_selected_prototype]] is true. This table has the following members:
	** base_type :: [[Types/string]]: E.g. "entity".		** base_type :: [[Types/string]]: E.g. "entity".
	** derived_type :: [[Types/string]]: E.g. "tree".		** derived_type :: [[Types/string]]: E.g. "tree".
	** name :: [[Types/string]]: E.g. "tree-05".		** name :: [[Types/string]]: E.g. "tree-05".

Honktown: /* Calling interface functions */ note on remote call limitations - particularly trying to "share" a table

2022-09-19T10:01:49Z

Calling interface functions: note on remote call limitations - particularly trying to "share" a table

← Older revision		Revision as of 10:01, 19 September 2022
Line 29:		Line 29:
	=== Calling interface functions ===		=== Calling interface functions ===

	The interface can be used for calling functions from a different script.		The interface can be used for calling functions from a different script. '''Limitations''': A table with a metatable will not retain that metatable when received by the remote mod (however, game objects passed will remain intact). A received table is a '''copy''' of the original. It is '''not possible''' for two mods to "share" the same table across a remote call.

	Example (in the different script than the one above):		Example (in the different script than the one above):

Bilka: /* Custom input */ link fix

2022-01-17T16:23:07Z

Custom input: link fix

← Older revision		Revision as of 16:23, 17 January 2022
Line 85:		Line 85:
	end)</syntaxhighlight>		end)</syntaxhighlight>

	The [https://lua-api.factorio.com/latest/events.html#~~Custom%20Input%20Events~~ event] contains the following:		The [https://lua-api.factorio.com/latest/events.html#CustomInputEvent event] contains the following:

	* player_index :: [[Types/uint32]]		* player_index :: [[Types/uint32]]

Bilka: /* Custom input */ word

2021-03-03T16:35:05Z

Custom input: word

← Older revision		Revision as of 16:35, 3 March 2021
Line 91:		Line 91:
	* input_name :: [[Types/string]]: The name of the custom input.		* input_name :: [[Types/string]]: The name of the custom input.
	* cursor_position :: [[Types/Position]]: The mouse cursor position when the input was activated.		* cursor_position :: [[Types/Position]]: The mouse cursor position when the input was activated.
	* selected_prototype :: [[Types/table]] (optional): Provided if [[Prototype/CustomInput#include_selected_prototype\|include_selected_prototype]] is true. This ~~the~~ table has the following members:		* selected_prototype :: [[Types/table]] (optional): Provided if [[Prototype/CustomInput#include_selected_prototype\|include_selected_prototype]] is true. This table has the following members:
	** base_type :: [[Types/string]]: E.g. "entity".		** base_type :: [[Types/string]]: E.g. "entity".
	** derived_type :: [[Types/string]]: E.g. "tree".		** derived_type :: [[Types/string]]: E.g. "tree".
	** name :: [[Types/string]]: E.g. "tree-05".		** name :: [[Types/string]]: E.g. "tree-05".