LuaWML/Units - Revision history

Vasya: Fix formatting /* wesnoth.unit_movement_cost */

2021-06-05T20:53:20Z

Fix formatting ‎wesnoth.unit_movement_cost

2021-02-12T13:31:19Z

Add move notice

2020-11-22T18:16:22Z

‎wesnoth.put_unit: update for PR #5159 / 1.15.8

2020-07-24T17:42:47Z

‎wesnoth.put_unit: Add deprecation and removal notice

2020-06-21T06:31:24Z

TOC styling

2020-04-24T01:29:41Z

typo

2019-02-09T00:11:41Z

‎wesnoth.put_unit: warn about #3890

2019-01-08T20:19:14Z

‎wesnoth.effects

2019-01-07T21:24:59Z

‎wesnoth.add_modification

2018-12-29T22:00:50Z

‎wesnoth.get_unit: ID, not underlying ID

@@ Line 289: / Line 289: @@
 <syntaxhighlight lang='lua'>
 local move_cost = wesnoth.unit_movement_cost(u, "Gt")
-<syntaxhighlight>
+</syntaxhighlight>
 ==== wesnoth.unit_vision_cost ====

← Older revision		Revision as of 18:16, 22 November 2020
Line 127:		Line 127:

	If x,y is a village, this function does not capture it (as of 1.14). Use [[LuaWML:Sides#wesnoth.set_village_owner\|wesnoth.set_village_owner(x, y, unit.side)]] if that's what you want.		If x,y is a village, this function does not capture it (as of 1.14). Use [[LuaWML:Sides#wesnoth.set_village_owner\|wesnoth.set_village_owner(x, y, unit.side)]] if that's what you want.
		+
		+	'''Caution:''' Using this function will trigger unit placed events. While this may be correct in most cases, there are some cases where it shouldn't, especially if the code is inside the definition of a custom WML tag — it would be an unexpected side-effect from the users point. To work around this, ''false'' can be passed additionally as the last argument. This is what is used internally for some tags such as [move_unit], [harm_unit], [unpetrify] or the feeding ability and is not officially part of the API.

	==== wesnoth.erase_unit ====		==== wesnoth.erase_unit ====

@@ Line 106: / Line 106: @@
 * '''wesnoth.put_unit(''unit'')'''
-* '''wesnoth.put_unit(''x'', ''y'', ''unit'')'''
+* '''wesnoth.put_unit(''x'', ''y'', ''unit'')''' -- Deprecated in {{DevFeature1.13|2}}, removed in {{DevFeature1.15|0}}
-* '''wesnoth.put_unit(''x'', ''y'')'''
+* '''wesnoth.put_unit(''x'', ''y'')''' -- Deprecated in {{DevFeature1.13|2}}, removed in {{DevFeature1.15|0}}
-* {{DevFeature1.13|2}} '''wesnoth.put_unit(''unit'', ''x'', ''y'')''' -- The above two forms are also deprecated.
+* {{DevFeature1.13|2}} '''wesnoth.put_unit(''unit'', ''x'', ''y'')'''
 * {{DevFeature1.13|2}} '''''unit'':to_map([''x'', ''y''])

@@ Line 1: / Line 1: @@
 This page describes the [[LuaWML]] functions for handling units.
@@ Line 61: / Line 63: @@
 The term "proxy", here in particular "proxy unit", means that the variable retrieved in the lua code (with get_units for example) is an accessor (reference) to the C++ object which represents that unit. This is very different from unit variables obtained by [store_unit] in wml. The fields marked as "writable" above can be modified without the need to use put_unit afterwards. This same reason explains that modifications to the unit from outside the lua code (like [kill] invalidating the proxy unit) have immediate effect on the lua code's proxy unit variable (with the exception of private proxy units).
 ==== wesnoth.get_units ====

← Older revision		Revision as of 01:29, 24 April 2020
Line 484:		Line 484:
	</syntaxhighlight>		</syntaxhighlight>

−	Note that in order work properly effects must be registered before any units are created. This means it must be places into toplevel or ~~scenaro~~/era/modification level [lua] tag and in particular must not be done from within a preload event.	+	Note that in order work properly effects must be registered before any units are created. This means it must be places into toplevel or scenario/era/modification level [lua] tag and in particular must not be done from within a preload event.

@@ Line 124: / Line 124: @@
 wesnoth.put_unit(1, 1, wesnoth.get_units({ canrecruit = true })[1])
 </syntaxhighlight>
 ==== wesnoth.erase_unit ====

@@ Line 482: / Line 482: @@
 </syntaxhighlight>
-Note that because currently all Lua code is executed after [unit]s in [side] are created, it is currently not possible to use these effects in [unit]s in [side]
+Note that in order work properly effects must be registered before any units are created. This means it must be places into toplevel or scenaro/era/modification level [lua] tag and in particular must not be done from within a preload event.
 {{DevFeature1.13|5}}

@@ Line 221: / Line 221: @@
 <syntaxhighlight lang='lua'>
-local T = wml.tags
+local T = wml.tag
 local u = wesnoth.get_units { canrecruit = true }[1]
 local effects = {

@@ Line 81: / Line 81: @@
 * '''wesnoth.get_unit(''id'')'''
-Returns the unit at the given location or with the given underlying ID.
+Returns the unit at the given location or with the given ID.
 <syntaxhighlight lang='lua'>