Difference between revisions of "LuaWML/Tiles"

From The Battle for Wesnoth Wiki
(Moved village handling to the "sides" page)
(Added location matching)
Line 44: Line 44:
 
  -- Function chg_unit can be used in command mode to modify unit attributes on the fly:
 
  -- Function chg_unit can be used in command mode to modify unit attributes on the fly:
 
  --  :lua chg_unit("status.poisoned", true)
 
  --  :lua chg_unit("status.poisoned", true)
 +
 +
==== wesnoth.get_locations ====
 +
 +
{{DevFeature1.9}}
 +
 +
Returns a table containing all the locations matching the given filter. Locations are stored as pairs: tables of two elements.
 +
 +
-- replace all grass terrains by roads
 +
for i,loc in ipairs(wesnoth.get_locations { terrain = "Gg" }) do
 +
    wesnoth.set_terrain(loc[1], loc[2], "Rr")
 +
end
 +
 +
==== wesnoth.match_location ====
 +
 +
{{DevFeature1.9}}
 +
 +
Returns true if the given location passes the filter.
 +
 +
bool b = wesnoth.match_location(x, y, { terrain = "Ww", { "filter_adjacent_location", terrain = "Ds,*^Bw*" } })

Revision as of 19:22, 3 August 2010

This page describes the LuaWML functions for handling terrains and tiles.

wesnoth.get_map_size

Returns the width, the height, and the border size of the map.

local w,h,b = wesnoth.get_map_size()

wesnoth.get_terrain

Returns the terrain code for the given location.

local is_grassland = wesnoth.get_terrain(12, 15) == "Gg"

wesnoth.set_terrain

Modifies the terrain at the given location.

function create_village(x, y)
    wesnoth.set_terrain(x, y, "Gg^Vh")
end

wesnoth.get_terrain_info

Returns the terrain details for the given terrain code.

local is_keep = wesnoth.get_terrain_info(wesnoth.get_terrain(12, 15)).keep

Terrain info is a plain table with the following fields:

  • id: string
  • name, description: translatable strings
  • castle, keep, village: booleans
  • healing: integer

wesnoth.get_selected_tile

Returns the two coordinates of the currently selected tile. This is mostly useful for defining command-mode helpers.

function chg_unit(attr, val)
   local x, y = wesnoth.get_selected_tile()
   if not x then wesnoth.message("Error", "No unit selected."); return end
   helper.modify_unit({ x = x, y = y }, { [attr] = val })
end
-- Function chg_unit can be used in command mode to modify unit attributes on the fly:
--   :lua chg_unit("status.poisoned", true)

wesnoth.get_locations

Template:DevFeature1.9

Returns a table containing all the locations matching the given filter. Locations are stored as pairs: tables of two elements.

-- replace all grass terrains by roads
for i,loc in ipairs(wesnoth.get_locations { terrain = "Gg" }) do
    wesnoth.set_terrain(loc[1], loc[2], "Rr")
end

wesnoth.match_location

Template:DevFeature1.9

Returns true if the given location passes the filter.

bool b = wesnoth.match_location(x, y, { terrain = "Ww", { "filter_adjacent_location", terrain = "Ds,*^Bw*" } })