LuaAPI/location set - Revision history

Laela at 17:56, 18 April 2024

2024-04-18T17:56:37Z

Celtic Minstrel: /* location_set.clear */ Missed devtag

2022-06-14T04:59:43Z

‎location_set.clear: Missed devtag

Celtic Minstrel: /* location_set.clear */ formatting fixup

2022-06-14T04:58:05Z

‎location_set.clear: formatting fixup

Celtic Minstrel: /* location_set.invert */ Document invert

2022-06-14T04:57:19Z

‎location_set.invert: Document invert

Celtic Minstrel: /* location_set.clear */ Document clear

2022-06-14T04:51:30Z

‎location_set.clear: Document clear

Celtic Minstrel: /* location_set.insert */ Clarify

2022-06-14T04:50:33Z

‎location_set.insert: Clarify

Celtic Minstrel: /* location_set.stable_iter */ Document stable_iter

2022-06-14T04:49:12Z

‎location_set.stable_iter: Document stable_iter

Celtic Minstrel: /* location_set.to_map */ Document to_map

2022-06-14T04:47:47Z

‎location_set.to_map: Document to_map

Celtic Minstrel: /* location_set.to_stable_pairs */ formatting fixup

2022-06-14T03:25:17Z

‎location_set.to_stable_pairs: formatting fixup

Celtic Minstrel: /* location_set.to_stable_pairs */ Document to_stable_pairs

2022-06-14T03:25:00Z

‎location_set.to_stable_pairs: Document to_stable_pairs

← Older revision		Revision as of 17:56, 18 April 2024
Line 1:		Line 1:
	The <tt>location_set</tt> module provides an interface for working with sets of locations, optionally with custom data associated to each location (so, it can be used either as a set or a map). It can be loaded via <syntaxhighlight lang=lua inline>local location_set = wesnoth.require "location_set"</syntaxhighlight>.		The <tt>location_set</tt> module provides an interface for working with sets of locations, optionally with custom data associated to each location (so, it can be used either as a set or a map). It can be loaded via <syntaxhighlight lang=lua inline>local location_set = wesnoth.require "location_set"</syntaxhighlight>.
		+
		+	== Functions ==

	=== location_set.create ===		=== location_set.create ===

← Older revision		Revision as of 04:59, 14 June 2022
Line 129:		Line 129:

	=== location_set.clear ===		=== location_set.clear ===
		+
		+	{{DevFeature1.17\|?}}

	* ''location_set'':'''clear'''()		* ''location_set'':'''clear'''()

@@ Line 130: / Line 130: @@
 === location_set.clear ===
-* ''location_set'':clear''()
+* ''location_set'':'''clear'''()
 Removes all locations from the set, leaving it empty.

← Older revision		Revision as of 04:57, 14 June 2022
Line 215:		Line 215:

	Computes the symmetric difference of two location sets. The functional form removes from the left-hand set any locations that are present in both sets, while the operator form creates a new location set with only those locations that are not in both sets. In both cases, values are preserved. Note that if the value is a table, the table is not copied even with the operator form.		Computes the symmetric difference of two location sets. The functional form removes from the left-hand set any locations that are present in both sets, while the operator form creates a new location set with only those locations that are not in both sets. In both cases, values are preserved. Note that if the value is a table, the table is not copied even with the operator form.
		+
		+	=== location_set.invert ===
		+
		+	{{DevFeature1.17\|?}}
		+
		+	* ''location_set'':'''invert'''(''width'', ''height'', ''border_size'') → ''new set''
		+	* ''location_set'':'''invert'''(''map'') → ''new set''
		+	* {{LuaGameOnly}} ~ ''location_set'' → ''new set''
		+
		+	Computes the inverse of a location set, resulting in a new set that contains all locations that are ''not'' in the input set. This requires knowledge of the map size to function, so you can pass either the dimensions or the map itself as an argument. The operator form, only available in game contexts, automatically uses '''wesnoth.current.map''' as the map.
		+
		+	The output set does not have objects associated with any of the locations.

	=== location_set.random ===		=== location_set.random ===

← Older revision		Revision as of 04:51, 14 June 2022
Line 127:		Line 127:

	Deletes a location from the location set. In the second form, the location must be specified either as a pair <syntaxhighlight lang=lua inline>{3, 4}</syntaxhighlight> or as a coordinate table <syntaxhighlight lang=lua inline>{x = 3, y = 4}</syntaxhighlight>		Deletes a location from the location set. In the second form, the location must be specified either as a pair <syntaxhighlight lang=lua inline>{3, 4}</syntaxhighlight> or as a coordinate table <syntaxhighlight lang=lua inline>{x = 3, y = 4}</syntaxhighlight>
		+
		+	=== location_set.clear ===
		+
		+	* ''location_set'':clear''()
		+
		+	Removes all locations from the set, leaving it empty.

	=== location_set.size ===		=== location_set.size ===

@@ Line 119: / Line 119: @@
 * {{DevFeature1.15|3}} ''location_set''[''location''] = ''value''
-Sets the value associated with a given location. If the value is not specified, '''true''' is used. Specifying '''nil''' will ''not'' erase the value &ndash; instead it will set it to '''true'''. In the second form, the location must be specified either as a pair <syntaxhighlight lang=lua inline>{3, 4}</syntaxhighlight> or as a coordinate table <syntaxhighlight lang=lua inline>{x = 3, y = 4}</syntaxhighlight>
+Sets the value associated with a given location. If the value is not specified, '''true''' is used. Specifying '''nil''' in the first form will ''not'' erase the value &ndash; instead it will set it to '''true'''. In the second form, the location must be specified either as a pair <syntaxhighlight lang=lua inline>{3, 4}</syntaxhighlight> or as a coordinate table <syntaxhighlight lang=lua inline>{x = 3, y = 4}</syntaxhighlight>
 === location_set.remove ===

@@ Line 152: / Line 152: @@
 end
 </syntaxhighlight>
 === location_set.filter ===

← Older revision		Revision as of 04:47, 14 June 2022
Line 79:		Line 79:

	Converts a location set to triples of the contained locations and their associated data.		Converts a location set to triples of the contained locations and their associated data.
		+
		+	=== location_set.to_map ===
		+
		+	{{DevFeature1.17\|?}}
		+
		+	* ''location_set'':'''to_map'''() → ''associative table''
		+
		+	Converts a location set to an associative table. Note that this does not mean you can simply look up data by location, as the indices are tables which have a unique address; it can be iterated over, however. This is mainly provided so that there is an inverse for '''of_map'''.

	=== location_set.to_wml_var ===		=== location_set.to_wml_var ===

@@ Line 70: / Line 70: @@
 === location_set.to_stable_pairs ===
-* ''location_set'':'''to_stable_pairs''() &rarr; ''array of pairs''
+* ''location_set'':'''to_stable_pairs'''() &rarr; ''array of pairs''
 Like '''to_pairs''', but the locations are sorted lexicographically.

← Older revision		Revision as of 03:25, 14 June 2022
Line 67:		Line 67:

	Converts a location set to pairs of the contained locations. The order of the locations is not guaranteed.		Converts a location set to pairs of the contained locations. The order of the locations is not guaranteed.
		+
		+	=== location_set.to_stable_pairs ===
		+
		+	* ''location_set'':'''to_stable_pairs''() → ''array of pairs''
		+
		+	Like '''to_pairs''', but the locations are sorted lexicographically.

	=== location_set.to_triples ===		=== location_set.to_triples ===