LuaAPI/UpdatingFrom14 - Revision history

Shiki: /* helper module */ mention 1:1 replacement too

2024-06-15T15:08:08Z

‎helper module: mention 1:1 replacement too

2024-06-15T14:43:40Z

‎helper module: Add helper.adjacent_tiles

2024-06-15T14:37:17Z

‎Map API: add wesnoth.map.get_adjacent_tiles -> hexes

2024-06-13T21:31:28Z

Hint to use wesnoth.units.defense_on

2022-11-23T14:00:54Z

Add wml.fire to the list

2022-07-02T05:06:36Z

‎Functions in wesnoth namespace: update about '''wesnoth.units.to_map'''

2022-06-24T05:43:09Z

‎Map API: Fix formatting

2022-01-06T05:55:56Z

‎Functions in wesnoth namespace: typo

2021-11-25T00:08:58Z

typo

2021-11-21T02:38:05Z

fix typo

@@ Line 312: / Line 312: @@
 The helper module is being phased out, so quite a lot of things have been moved out of it. This section is written under the assumption that you loaded it with <syntaxhighlight lang=lua inline>local helper = wesnoth.require "helper"</syntaxhighlight> or the like, but many people call it '''H''' instead of '''helper''', so keep that in mind.
-* '''helper.adjacent_tiles''' replaced by '''wesnoth.map.iter_adjacent'''
+* '''helper.adjacent_tiles''' replaced by '''wesnoth.map.iter_adjacent''', can be renamed to '''wesnoth.current.map:iter_adjacent'''
 * '''helper.child_array''' renamed to '''wml.child_array'''
 * '''helper.child_count''' renamed to '''wml.child_count'''

@@ Line 312: / Line 312: @@
 The helper module is being phased out, so quite a lot of things have been moved out of it. This section is written under the assumption that you loaded it with <syntaxhighlight lang=lua inline>local helper = wesnoth.require "helper"</syntaxhighlight> or the like, but many people call it '''H''' instead of '''helper''', so keep that in mind.
 * '''helper.child_array''' renamed to '''wml.child_array'''
 * '''helper.child_count''' renamed to '''wml.child_count'''

@@ Line 274: / Line 274: @@
 </syntaxhighlight>
 * '''wesnoth.label''' renamed to '''wesnoth.map.add_label'''
 * '''wesnoth.match_location''' renamed to '''wesnoth.map.matches'''
 * '''wesnoth.remove_time_area''' renamed to '''wesnoth.map.remove_area'''

@@ Line 147: / Line 147: @@
 * '''wesnoth.transform_unit''' renamed to '''wesnoth.units.transform'''
 * '''wesnoth.unit_ability''' renamed to '''wesnoth.units.ability'''
-* '''wesnoth.unit_defense''' renamed to '''wesnoth.units.chance_to_be_hit'''
+* '''wesnoth.unit_defense''' renamed to '''wesnoth.units.chance_to_be_hit''' - can use wesnoth.units.defense_on if you want the defense instead
 * '''wesnoth.unit_jamming_cost''' renamed to '''wesnoth.units.jamming_on'''
 * '''wesnoth.unit_movement_cost''' renamed to '''wesnoth.units.movement_on'''

@@ Line 54: / Line 54: @@
 * '''wesnoth.find_vacant_tile''' renamed to '''wesnoth.paths.find_vacant_hex'''
 * '''wesnoth.find_vision_range''' renamed to '''wesnoth.paths.find_vision_range'''
 * '''wesnoth.float_label''' renamed to '''wesnoth.interface.float_label'''
 * '''wesnoth.format_conjunct_list''' renamed to '''stringx.format_conjunct_list'''
@@ Line 333: / Line 334: @@
 </syntaxhighlight>
 * '''helper.set_wml_var_metatable''' replaced with '''wml.variable.proxy''', which is a table that works exactly the same as what this function would return
 * '''helper.shallow_literal''' renamed to '''wml.shallow_literal'''
 * '''helper.shallow_parsed''' renamed to '''wml.shallow_parsed'''

@@ Line 115: / Line 115: @@
 * '''wesnoth.play_sound''' renamed to '''wesnoth.audio.play'''
 * '''wesnoth.put_recall_unit''' renamed to '''wesnoth.units.to_recall'''
-* '''wesnoth.put_unit''' renamed to '''wesnoth.units.to_map'''
+* '''wesnoth.put_unit''' replaced with '''wesnoth.units.to_map''', which reordered the arguments, so that the unit info has now moved from the 3rd position to the first
 * '''wesnoth.random''' renamed to '''mathx.random'''
 * '''wesnoth.read_file''' renamed to '''filesystem.read_file'''

@@ Line 252: / Line 252: @@
 -- local width_with_border, height_with_border = width + border_size * 2, height + border_size * 2
 local width_with_border, height_with_border = wesnoth.current.map.width and wesnoth.current.map.height
-</syntaxhighlight
+</syntaxhighlight>
 * '''wesnoth.get_terrain_info''' replaced with '''wesnoth.terrain_types'''
 **<syntaxhighlight lang=lua>

@@ Line 8: / Line 8: @@
 === Functions in wesnoth namespace ===
-* '''weesnoth.remove_fog''' renamed to '''wesnoth.sides.remove_fog'''
+* '''wesnoth.remove_fog''' renamed to '''wesnoth.sides.remove_fog'''
 * '''wesnoth.add_ai_component''' renamed to '''wesnoth.sides.add_ai_component'''
 * '''wesnoth.add_fog''' renamed to '''wesnoth.sides.place_fog'''

@@ Line 94: / Line 94: @@
 ** <syntaxhighlight lang=lua>
 -- local old_value = wesnoth.get_variable('my_array[2].value')
-local old_value = wesnoth.variables['my_array[2].value']
+local old_value = wml.variables['my_array[2].value']
 local new_value = old_value * 2
 -- wesnoth.set_variable('my_array[2].value', new_value)
-wesnoth.variables['my_array[2].value'] = new_value
+wml.variables['my_array[2].value'] = new_value
 </syntaxhighlight>
 * '''wesnoth.have_file''' renamed to '''filesystem.have_file'''

@@ Line 284: / Line 284: @@
 wesnoth.current.map[{x,y}] = wesnoth.map.replace_base 'Gg'
 -- wesnoth.set_terrain(x, y, '^Vh', 'overlay')
-wesnoth.current.map[{x,y}] = wesnoth.map.relace_overlay '^Vh'
+wesnoth.current.map[{x,y}] = wesnoth.map.replace_overlay '^Vh'
 -- wesnoth.set_terrain(x, y, 'Gg^Vh', 'overlay', true)
 wesnoth.current.map[{x,y}] = wesnoth.map.replace_if_failed('Gg^Vh', 'overlay')