LuaAPI/wesnoth/sides - Revision history

Laela: /* wesnoth.sides.set_id */

2024-10-24T13:22:16Z

wesnoth.sides.set_id

← Older revision		Revision as of 13:22, 24 October 2024
Line 34:		Line 34:
	* {{LuaGameOnly}} ''side'':'''set_id('''''flag'', ''color'')		* {{LuaGameOnly}} ''side'':'''set_id('''''flag'', ''color'')

	Changes the visual identification of a side. Pass an empty string if you only want to change one of these two attributes. Both attributes can also be changed through the side proxy attributes, but changing both at the same time is slightly more efficient.		Changes the visual identification of a side. Pass an empty string if you only want to change one of these two attributes. Both attributes can also be changed through the [[LuaAPI/types/side\|side proxy]] attributes, but changing both at the same time is slightly more efficient.

	=== wesnoth.sides.place_fog ===		=== wesnoth.sides.place_fog ===

2024-10-24T13:21:35Z

← Older revision		Revision as of 13:21, 24 October 2024
Line 3:		Line 3:
	The sides module is only available in the game. It is not available to plugins or map generators.		The sides module is only available in the game. It is not available to plugins or map generators.

	All functions taking a side on this page (except '''get''') will accept either the integer index of the side or the side proxy userdata (as returned by '''get''' or '''find''').		All functions taking a side on this page (except '''get''') will accept either the integer index of the side or the [[LuaAPI/types/side\|side proxy userdata]] (as returned by '''get''' or '''find''').

	== Functions ==		== Functions ==

2024-10-24T13:21:01Z

wesnoth.sides.get

← Older revision		Revision as of 13:21, 24 October 2024
Line 128:		Line 128:
	=== wesnoth.sides.get ===		=== wesnoth.sides.get ===

	* {{LuaGameOnly}} '''wesnoth.sides.get'''(''id'') → ''side proxy''		* {{LuaGameOnly}} '''wesnoth.sides.get'''(''id'') → ''[[LuaAPI/types/side\|side proxy]]''
	* {{LuaGameOnly}} '''wesnoth.sides'''[''id''] → ''side proxy''		* {{LuaGameOnly}} '''wesnoth.sides'''[''id''] → ''[[LuaAPI/types/side\|side proxy]]''
	* {{LuaGameOnly}} #'''wesnoth.sides''' → ''number of sides''		* {{LuaGameOnly}} #'''wesnoth.sides''' → ''number of sides''

2024-10-24T13:20:01Z

← Older revision		Revision as of 13:20, 24 October 2024
Line 132:		Line 132:
	* {{LuaGameOnly}} #'''wesnoth.sides''' → ''number of sides''		* {{LuaGameOnly}} #'''wesnoth.sides''' → ''number of sides''

	Returns the specified side, which must be a valid integer side ID.		Returns the specified [[LuaAPI/types/side\|side]], which must be a valid integer side ID.

	=== wesnoth.sides.find ===		=== wesnoth.sides.find ===

	* {{LuaGameOnly}} '''wesnoth.sides.find'''(''filter'') → ''array of sides''		* {{LuaGameOnly}} '''wesnoth.sides.find'''(''filter'') → ''array of [[LuaAPI/types/side\|sides]]''

	Returns a table array containing proxy tables for these sides matching the passed [[StandardSideFilter]].		Returns a table array containing proxy tables for these sides matching the passed [[StandardSideFilter]].
Line 152:		Line 152:
	{{DevFeature1.17\|?}}		{{DevFeature1.17\|?}}

	* {{LuaGameOnly}} '''wesnoth.sides.iter'''(''filter?'') → ''iterator'' ⇒ ''side''		* {{LuaGameOnly}} '''wesnoth.sides.iter'''(''filter?'') → ''iterator'' ⇒ ''[[LuaAPI/types/side\|side]]''

	Iterate over all sides, or sides that match a filter.		Iterate over all sides, or sides that match a filter.

2024-04-18T17:53:04Z

← Older revision		Revision as of 17:53, 18 April 2024
Line 4:		Line 4:

	All functions taking a side on this page (except '''get''') will accept either the integer index of the side or the side proxy userdata (as returned by '''get''' or '''find''').		All functions taking a side on this page (except '''get''') will accept either the integer index of the side or the side proxy userdata (as returned by '''get''' or '''find''').

			== Functions ==

	=== wesnoth.sides.is_enemy ===		=== wesnoth.sides.is_enemy ===

2022-07-02T15:14:21Z

wesnoth.sides.iter

← Older revision		Revision as of 15:14, 2 July 2022
Line 145:		Line 145:
	end		end
	</syntaxhighlight>		</syntaxhighlight>

			=== wesnoth.sides.iter ===

			{{DevFeature1.17\|?}}

			* {{LuaGameOnly}} '''wesnoth.sides.iter'''(''filter?'') → ''iterator'' ⇒ ''side''

			Iterate over all sides, or sides that match a filter.

	=== wesnoth.sides.create ===		=== wesnoth.sides.create ===

2021-07-26T06:13:30Z

wesnoth.sides.is_fogged: Fix formatting

← Older revision		Revision as of 06:13, 26 July 2021
Line 56:		Line 56:
	=== wesnoth.sides.is_fogged ===		=== wesnoth.sides.is_fogged ===

	* {{LuaGameOnly}} '''wesnoth.sides.is_fogged(''side'', ''location'') → ''boolean''		* {{LuaGameOnly}} '''wesnoth.sides.is_fogged'''(''side'', ''location'') → ''boolean''
	* {{LuaGameOnly}} ''side'':'''is_fogged'''(''side'') → ''boolean''		* {{LuaGameOnly}} ''side'':'''is_fogged'''(''side'') → ''boolean''

2021-07-26T03:19:40Z

wesnoth.sides.override_shroud: Fix incorrect documentation

← Older revision		Revision as of 03:19, 26 July 2021
Line 73:		Line 73:
	* {{LuaGameOnly}} ''side'':'''override_shroud'''(''locations'')		* {{LuaGameOnly}} ''side'':'''override_shroud'''(''locations'')

	~~Places~~ shroud on the specified hexes for the chosen side. This replaces any existing shroud on the map – after calling `override_shroud`, the locations passed will be the ''only'' ~~shrouded~~ locations.		Clears shroud on the specified hexes for the chosen side. This replaces any existing shroud data on the map – after calling `override_shroud`, the locations passed will be the ''only'' unshrouded locations.

	=== wesnoth.sides.remove_shroud ===		=== wesnoth.sides.remove_shroud ===

2021-07-04T23:37:07Z

Add context specifiers to each entry; it's redundant but it's useful redundancy

2021-07-02T06:18:39Z

Document wesnoth.sides.create

← Older revision		Revision as of 06:18, 2 July 2021
Line 145:		Line 145:
	end		end
	</syntaxhighlight>		</syntaxhighlight>

			=== wesnoth.sides.create ===

			* '''wesnoth.sides.create'''() → ''new side number''

			Adds a new blank side to the end of the scenario sides list and returns its number.

	=== wesnoth.sides.debug_ai ===		=== wesnoth.sides.debug_ai ===