LuaWML/Tiles - Revision history

Vasya: /* wesnoth.map.get_adjacent_tiles */

2021-02-18T20:50:28Z

‎wesnoth.map.get_adjacent_tiles

2021-02-12T13:29:57Z

Add move notice

2021-01-02T14:44:36Z

fixed the function name

2018-08-23T10:15:23Z

‎wesnoth.map.distance_between

2018-04-12T04:56:44Z

Document reference unit argument for location filters

2018-04-12T04:39:48Z

Add wesnoth.special_locations

2018-04-12T04:35:32Z

Syntax highlighting

2018-01-15T10:53:11Z

‎wesnoth.label

2017-12-13T18:52:13Z

2017-12-13T18:47:51Z

‎wesnoth.label()

← Older revision		Revision as of 20:50, 18 February 2021
Line 195:		Line 195:

	Return all hexes adjacent to the specified hex, as six separate return values.		Return all hexes adjacent to the specified hex, as six separate return values.
		+
		+	<syntaxhighlight lang=lua>
		+	local a, b, c, d, e, f = wesnoth.map.get_adjacent_tiles({3, 3})
		+	local a_x = a[1]
		+	local a_y = a[2]
		+	</syntaxhighlight>
		+
		+	See also [[LuaWML:Pathfinder#helper.adjacent_tiles\|helper.adjacent_tiles]] if you want to iterate over the hexes.

	==== wesnoth.map.tiles_adjacent ====		==== wesnoth.map.tiles_adjacent ====

← Older revision		Revision as of 13:29, 12 February 2021
Line 1:		Line 1:
		+	{{Template:LuaMove}}
		+
	This page describes the [[LuaWML]] functions for handling terrains and tiles. The ''items'' library can be loaded by		This page describes the [[LuaWML]] functions for handling terrains and tiles. The ''items'' library can be loaded by

@@ Line 43: / Line 43: @@
 ==== wesnoth.get_terrain_info ====
-* '''wesnoth.get_info(''terrain_code'')'''
+* '''wesnoth.get_terrain_info(''terrain_code'')'''
 Returns the terrain details for the given terrain code.

← Older revision		Revision as of 10:15, 23 August 2018
Line 207:		Line 207:

	Calculates the distance between two hexes.		Calculates the distance between two hexes.
		+
		+	<syntaxhighlight lang=lua>
		+	local my_distance = wesnoth.map.distance_between({10, 10}, {20, 20})
		+	</syntaxhighlight>

	==== wesnoth.label====		==== wesnoth.label====

@@ Line 76: / Line 76: @@
 * '''wesnoth.get_locations(''filter'')'''
-Returns a table containing all the locations matching the given filter. Locations are stored as pairs: tables of two elements. See [[StandardLocationFilter]] for details about location filters.
+Returns a table containing all the locations matching the given filter. Locations are stored as pairs: tables of two elements. See [[StandardLocationFilter]] for details about location filters. If a unit is passed, it can be referenced from the filter via the $teleport_unit variable, as well as in WFL formulas used in the filter.
 <syntaxhighlight lang=lua>
@@ Line 100: / Line 101: @@
 * '''wesnoth.match_location(''x'', ''y'', ''filter'')'''
-Returns true if the given location passes the filter.
+Returns true if the given location passes the filter. If a unit is passed, it can be referenced from the filter via the $teleport_unit variable, as well as in WFL formulas used in the filter.
 <syntaxhighlight lang=lua>

@@ Line 215: / Line 215: @@
 <syntaxhighlight lang=lua>
 wesnoth.label {x=10,y=10,text="a",color={255,255,255,255}}
 </syntaxhighlight>

@@ Line 184: / Line 184: @@
 * '''wesnoth.label(''cfg'')'''
-  wesnoth.label({x=10,y=10,text="a",color={255,255,255,255}})
+  wesnoth.label {x=10,y=10,text="a",color={255,255,255,255}}
 Sets label of cfg.x, cfg.y to cfg.text. More supported keys https://wiki.wesnoth.org/InterfaceActionsWML#.5Blabel.5D

@@ Line 180: / Line 180: @@
 Calculates the distance between two hexes.
-==== wesnoth.label()====
+==== wesnoth.label====
 {{DevFeature1.13|0}}