LuaAPI/wesnoth/map - Revision history

White haired uncle: /* wesnoth.map.get_cubic */ minor typo

2024-11-23T18:31:45Z

‎wesnoth.map.get_cubic: minor typo

2024-09-21T18:09:34Z

Document get_hexes_at_radius, hex_vector_(sum|diff|negation), get_cubic, and from_cubic

2024-06-14T17:20:48Z

‎wesnoth.map.iter_adjacent: typo

2024-06-14T17:20:37Z

‎wesnoth.map.iter_adjacent: Missing bracket

2024-06-14T14:37:27Z

Document wesnoth.map.iter_adjacent

2024-04-18T17:53:37Z

2021-12-26T05:05:00Z

‎wesnoth.map.iter: place_label doesn't exist, that's at least a working snippet (I hope)

2021-07-27T00:09:36Z

‎wesnoth.map.distance_between: Fix return type and clarify what "distance" actually means

2021-07-26T23:58:34Z

‎wesnoth.map.get_relative_dir: Add a missing comma

2021-07-04T23:28:00Z

Update context specifiers and add a bunch of missing ones

@@ Line 368: / Line 368: @@
 {{DevFeature1.19|4}}
-* '''wesnoth.map.get_cubic'''(''loc'') &rarr; ''cubic loc'')
+* '''wesnoth.map.get_cubic'''(''loc'') &rarr; ''cubic loc''
 Converts hex grid coordinates to [https://www.redblobgames.com/grids/hexagons/#coordinates-cube cubic hex coordinates]. This may make some algorithms easier.

@@ Line 315: / Line 315: @@
 Return all hexes within the given radius, as an array of pairs. This doesn't check whether the hexes are on the map.
 === wesnoth.map.are_hexes_adjacent ===
@@ Line 331: / Line 339: @@
 local my_distance = wesnoth.map.distance_between({10, 10}, {20, 20})
 </syntaxhighlight>
 [[Category:Lua Reference]]

@@ Line 97: / Line 97: @@
 * {{LuaGameOnly}}{{LuaMapOnly}} ''map'':'''iter_adjacent'''(''location'', [''include border?'']) &rarr; ''iterator'' &rArr; ''x'', ''y''
-Iterate over the hexes adjacent to the location, excluding border tiles (unless explicitely enabled).
+Iterate over the hexes adjacent to the location, excluding border tiles (unless explicitly enabled).
 === wesnoth.map.read_location ===

@@ Line 95: / Line 95: @@
 * {{LuaGameOnly}}{{LuaMapOnly}} '''wesnoth.map.iter_adjacent'''(''map'', ''location'', [''include border?'']) &rarr; ''iterator'' &rArr; ''x'', ''y''
-* {{LuaGameOnly}}{{LuaMapOnly}} ''map'':'''iter_adjacent'''(''location'', [''include border?'') &rarr; ''iterator'' &rArr; ''x'', ''y''
+* {{LuaGameOnly}}{{LuaMapOnly}} ''map'':'''iter_adjacent'''(''location'', [''include border?'']) &rarr; ''iterator'' &rArr; ''x'', ''y''
 Iterate over the hexes adjacent to the location, excluding border tiles (unless explicitely enabled).

@@ Line 91: / Line 91: @@
 end
 </syntaxhighlight>
 === wesnoth.map.read_location ===

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

	This module contains functions for working with the game map. Some of the functions can be called as methods of the map itself. In 1.15.11, there exists only one map in the game context, which can be accessed as [[LuaAPI/types/map\|'''wesnoth.current.map''']], while in the map generation context, a map can be created with [[#wesnoth.map.create]] or [[#wesnoth.map.generate]]. In future, it may become possible to create maps on the fly or read them from disk.		This module contains functions for working with the game map. Some of the functions can be called as methods of the map itself. In 1.15.11, there exists only one map in the game context, which can be accessed as [[LuaAPI/types/map\|'''wesnoth.current.map''']], while in the map generation context, a map can be created with [[#wesnoth.map.create]] or [[#wesnoth.map.generate]]. In future, it may become possible to create maps on the fly or read them from disk.
		+
		+	== Functions ==

	=== wesnoth.map.find ===		=== wesnoth.map.find ===

@@ Line 86: / Line 86: @@
 <syntaxhighlight lang=lua>
 for x, y in wesnoth.current.map:iter() do
-     wesnoth.map.place_label(x, y, string.format("%d,%d", x, y))
+     wesnoth.map.add_label{x=x, y=y, text=string.format("%d,%d", x, y)}
 end
 </syntaxhighlight>

@@ Line 315: / Line 315: @@
 === wesnoth.map.distance_between ===
-* '''wesnoth.map.distance_between'''(''loc1'', ''loc2'') &rarr; ''boolean''
+* '''wesnoth.map.distance_between'''(''loc1'', ''loc2'') &rarr; ''integer''
-Calculates the distance between two hexes.
+Calculates the distance between two hexes. The distance is the number of hexes you would need to travel across to get from the start point to the end point.
 <syntaxhighlight lang=lua>

@@ Line 281: / Line 281: @@
 * '''wesnoth.map.get_relative_dir'''(''from'', ''to'') &rarr; ''direction''
-Calculates the direction from one hex to another. Possible returns are strings "n", "ne", "nw", "s", "se", "sw" or "". The empty string means no direction which happens if ''from'' and ''to'' are same.
+Calculates the direction from one hex to another. Possible returns are strings "n", "ne", "nw", "s", "se", "sw" or "". The empty string means no direction, which happens if ''from'' and ''to'' are same.
 === wesnoth.map.rotate_right_around_center ===