LuaAPI/plugins - Revision history

Pentarctagon at 05:50, 30 September 2022

2022-09-30T05:50:37Z

Pentarctagon: Pentarctagon moved page LuaPluginAPI to LuaAPI/plugins

2022-09-29T18:50:12Z

Pentarctagon moved page LuaPluginAPI to LuaAPI/plugins

← Older revision	Revision as of 18:50, 29 September 2022
(No difference)

Pentarctagon at 18:48, 29 September 2022

2022-09-29T18:48:15Z

← Older revision		Revision as of 18:48, 29 September 2022
Line 254:		Line 254:

	Does nothing. The ''config'' argument should be an empty table.		Does nothing. The ''config'' argument should be an empty table.

	~~==== init ====~~
	~~None are available.~~

	~~=== Info ===~~
	This object contains the '''name''' attribute which identifies which context the game is currently in, as well as various functions to retrieve data (accessors) based on the current context which are listed below.

	~~==== Multiplayer Join ====~~
	~~None are available.~~

	~~==== Multiplayer Staging ====~~
	~~None are available.~~

	~~==== Multiplayer Create ====~~

	~~==== Game ====~~

	~~==== titlescreen ====~~

	~~==== Dialog ====~~
	~~None are available.~~

	==== init ====		==== init ====

Pentarctagon: /* titlescreen */

2022-09-29T18:47:51Z

titlescreen

← Older revision		Revision as of 18:47, 29 September 2022
Line 238:		Line 238:

	Attempts to connect to the multiplayer server.		Attempts to connect to the multiplayer server.

			===== info.command_line =====
			* {{LuaPluginOnly}} '''info.command_line''' → config

			Returns the command line options provided when starting Wesnoth.

	==== Dialog ====		==== Dialog ====

Pentarctagon: /* titlescreen */

2022-09-29T18:47:34Z

titlescreen

← Older revision		Revision as of 18:47, 29 September 2022
Line 267:		Line 267:

	==== titlescreen ====		==== titlescreen ====
	* {{LuaPluginOnly}} '''info.command_line''' → config

	~~Returns the command line options provided when starting Wesnoth.~~

	==== Dialog ====		==== Dialog ====

Pentarctagon: /* Game */

2022-09-29T18:47:20Z

Game

← Older revision		Revision as of 18:47, 29 September 2022
Line 227:		Line 227:

	Leaves the currently joined game. The ''config'' argument provided should be an empty table.		Leaves the currently joined game. The ''config'' argument provided should be an empty table.

			===== info.scenario_name =====
			* {{LuaPluginOnly}} '''info.scenario_name'''()'''.scenario_name''' → string

			Returns the name of the current scenario. This is the translatable scenario name as shown on the UI during game creation.

	==== titlescreen ====		==== titlescreen ====

Pentarctagon: /* Game */

2022-09-29T18:47:11Z

Game

← Older revision		Revision as of 18:47, 29 September 2022
Line 260:		Line 260:

	==== Game ====		==== Game ====
	~~===== info.scenario_name =====~~
	* {{LuaPluginOnly}} '''info.scenario_name'''()'''.scenario_name''' → string

	~~Returns the name of the current scenario. This is the translatable scenario name as shown on the UI during game creation.~~

	==== titlescreen ====		==== titlescreen ====

Pentarctagon: /* Multiplayer Create */

2022-09-29T18:46:56Z

Multiplayer Create

← Older revision		Revision as of 18:46, 29 September 2022
Line 175:		Line 175:

	Toggles whether the modification at the specified index is enabled or disabled.		Toggles whether the modification at the specified index is enabled or disabled.

			===== info.get_selected =====
			* {{LuaPluginOnly}} '''info.get_selected'''(''config'')''' → config

			The config argument provided should be an empty table.

			Returns a config containing the following attributes:
			* '''id''': The ID of what is currently selected.
			* '''name''': The user visible, translatable name of what is currently selected.
			* '''icon''': The icon of what is selected. Only populated when it's a campaign.
			* '''description''': The user visible, translatable description of what is selected.
			* '''allow_era_choice''': Whether selecting an era is allowed or not.
			* '''type''': The type of content that is currently selected. Possible values are scenario, user_map, user_scenario, random_map, campaign, sp_campaign.

			===== info.find_level =====
			* {{LuaPluginOnly}} '''info.find_level'''(''config'')''' → config

			The config argument provided must contain the '''id''' attribute.

			Returns a config containing the following attributes:
			* '''index''': The index of the content with the provided ID. If not found, this will be -1.
			* '''type''': The type of content that is currently selected. Possible values are scenario, user_map, user_scenario, random_map, campaign, sp_campaign.

			===== info.find_era =====
			* {{LuaPluginOnly}} '''info.find_era'''(''config'')''' → number

			The config argument provided must contain the '''id''' attribute.

			Returns the index of the era with the provided ID. If not found, this will be -1.

			===== info.find_mod =====
			* {{LuaPluginOnly}} '''info.find_mod'''(''config'')''' → number

			The config argument provided must contain the '''id''' attribute.

			Returns the index of the modification with the provided ID. If not found, this will be -1.

	==== Game ====		==== Game ====

Pentarctagon: /* Multiplayer Create */

2022-09-29T18:46:43Z

Multiplayer Create

← Older revision		Revision as of 18:46, 29 September 2022
Line 222:		Line 222:

	==== Multiplayer Create ====		==== Multiplayer Create ====
	~~===== info.get_selected =====~~
	* {{LuaPluginOnly}} '''info.get_selected'''(''config'')''' → config

	~~The config argument provided should be an empty table.~~

	~~Returns a config containing the following attributes:~~
	* '''id''': The ID of what is currently selected.
	* '''name''': The user visible, translatable name of what is currently selected.
	* '''icon''': The icon of what is selected. Only populated when it's a campaign.
	* '''description''': The user visible, translatable description of what is selected.
	* '''allow_era_choice''': Whether selecting an era is allowed or not.
	* '''type''': The type of content that is currently selected. Possible values are scenario, user_map, user_scenario, random_map, campaign, sp_campaign.

	~~===== info.find_level =====~~
	* {{LuaPluginOnly}} '''info.find_level'''(''config'')''' → config

	~~The config argument provided must contain the '''id''' attribute.~~

	~~Returns a config containing the following attributes:~~
	* '''index''': The index of the content with the provided ID. If not found, this will be -1.
	* '''type''': The type of content that is currently selected. Possible values are scenario, user_map, user_scenario, random_map, campaign, sp_campaign.

	~~===== info.find_era =====~~
	* {{LuaPluginOnly}} '''info.find_era'''(''config'')''' → number

	~~The config argument provided must contain the '''id''' attribute.~~

	~~Returns the index of the era with the provided ID. If not found, this will be -1.~~

	~~===== info.find_mod =====~~
	* {{LuaPluginOnly}} '''info.find_mod'''(''config'')''' → number

	~~The config argument provided must contain the '''id''' attribute.~~

	~~Returns the index of the modification with the provided ID. If not found, this will be -1.~~

	==== Game ====		==== Game ====

Pentarctagon at 18:46, 29 September 2022

2022-09-29T18:46:12Z

← Older revision		Revision as of 18:46, 29 September 2022
Line 16:		Line 16:
	* '''whisper''' - Boolean. Whether the message was sent as a whisper or as a general chat message.		* '''whisper''' - Boolean. Whether the message was sent as a whisper or as a general chat message.

	=== Context ===		=== Context & Info ===
	~~This~~ object contains various functions which can be called to change or set data (mutators). The different contexts ~~available~~ are listed below.		The '''context''' object contains various functions which can be called to change or set data (mutators).

			The '''info''' object contains the '''name''' attribute which identifies which context the game is currently in, as well as various functions to retrieve data (accessors) based on the current context.

			The different contexts and their associated mutator and accessor functions are listed below.

	==== Multiplayer Lobby ====		==== Multiplayer Lobby ====
Line 49:		Line 53:

	Selects a current game. Must be called before trying to join or observe a game. The ''config'' argument must have either the attribute ''id'' which which is the ID of the game to select, or the attribute ''index'' which is the index of the game to select in the list of games displayed in the lobby (filtering is ignored).		Selects a current game. Must be called before trying to join or observe a game. The ''config'' argument must have either the attribute ''id'' which which is the ID of the game to select, or the attribute ''index'' which is the index of the game to select in the list of games displayed in the lobby (filtering is ignored).

			===== info.game_list =====
			* {{LuaPluginOnly}} '''info.game_list'''() → config

			Returns a config containing the list of games in the lobby and their associated information. This list ignores any filtering.

	==== Multiplayer Join ====		==== Multiplayer Join ====
Line 205:		Line 214:
	=== Info ===		=== Info ===
	This object contains the '''name''' attribute which identifies which context the game is currently in, as well as various functions to retrieve data (accessors) based on the current context which are listed below.		This object contains the '''name''' attribute which identifies which context the game is currently in, as well as various functions to retrieve data (accessors) based on the current context which are listed below.

	~~==== Multiplayer Lobby ====~~
	~~===== info.game_list =====~~
	* {{LuaPluginOnly}} '''info.game_list'''() → config

	~~Returns a config containing the list of games in the lobby and their associated information. This list ignores any filtering.~~

	==== Multiplayer Join ====		==== Multiplayer Join ====