LuaAPI/wesnoth/sides - Revision history

Laela: /* wesnoth.sides.set_id */

2024-10-24T13:22:16Z

‎wesnoth.sides.set_id

2024-10-24T13:21:35Z

2024-10-24T13:21:01Z

‎wesnoth.sides.get

2024-10-24T13:20:01Z

2024-04-18T17:53:04Z

2022-07-02T15:14:21Z

‎wesnoth.sides.iter

2021-07-26T06:13:30Z

‎wesnoth.sides.is_fogged: Fix formatting

2021-07-26T03:19:40Z

‎wesnoth.sides.override_shroud: Fix incorrect documentation

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

@@ Line 34: / Line 34: @@
 * {{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 ===

@@ Line 3: / Line 3: @@
 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 ==

@@ Line 128: / Line 128: @@
 === wesnoth.sides.get ===
-* {{LuaGameOnly}} '''wesnoth.sides.get'''(''id'') &rarr; ''side proxy''
+* {{LuaGameOnly}} '''wesnoth.sides.get'''(''id'') &rarr; ''[[LuaAPI/types/side|side proxy]]''
-* {{LuaGameOnly}} '''wesnoth.sides'''[''id''] &rarr; ''side proxy''
+* {{LuaGameOnly}} '''wesnoth.sides'''[''id''] &rarr; ''[[LuaAPI/types/side|side proxy]]''
 * {{LuaGameOnly}} #'''wesnoth.sides''' &rarr; ''number of sides''

@@ Line 132: / Line 132: @@
 * {{LuaGameOnly}} #'''wesnoth.sides''' &rarr; ''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 ===
-* {{LuaGameOnly}} '''wesnoth.sides.find'''(''filter'') &rarr; ''array of sides''
+* {{LuaGameOnly}} '''wesnoth.sides.find'''(''filter'') &rarr; ''array of [[LuaAPI/types/side|sides]]''
 Returns a table array containing proxy tables for these sides matching the passed [[StandardSideFilter]].
@@ Line 152: / Line 152: @@
 {{DevFeature1.17|?}}
-* {{LuaGameOnly}} '''wesnoth.sides.iter'''(''filter?'') &rarr; ''iterator'' &rArr; ''side''
+* {{LuaGameOnly}} '''wesnoth.sides.iter'''(''filter?'') &rarr; ''iterator'' &rArr; ''[[LuaAPI/types/side|side]]''
 Iterate over all sides, or sides that match a filter.

← 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 ===

@@ Line 145: / Line 145: @@
 end
 </syntaxhighlight>
 === wesnoth.sides.create ===

@@ Line 56: / Line 56: @@
 === wesnoth.sides.is_fogged ===
-* {{LuaGameOnly}} '''wesnoth.sides.is_fogged(''side'', ''location'') &rarr; ''boolean''
+* {{LuaGameOnly}} '''wesnoth.sides.is_fogged'''(''side'', ''location'') &rarr; ''boolean''
 * {{LuaGameOnly}} ''side'':'''is_fogged'''(''side'') &rarr; ''boolean''

@@ Line 73: / Line 73: @@
 * {{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 ===