LuaAPI/wesnoth/units - Revision history

Celtic Minstrel: /* wesnoth.units.create_animator */ Adding multiple animations for the same unit is not intended to be supported

2024-12-23T19:04:45Z

‎wesnoth.units.create_animator: Adding multiple animations for the same unit is not intended to be supported

2024-11-01T17:59:19Z

‎wesnoth.units.to_map

2024-09-21T17:56:29Z

Document wesnoth.units.rebuild

2024-08-07T18:00:42Z

2024-07-31T14:46:10Z

‎wesnoth.units.create_animator

2024-06-25T15:04:42Z

‎wesnoth.units.create_animator

2024-04-18T17:52:21Z

2023-02-01T14:55:22Z

‎wesnoth.units.create_animator: typo

2021-07-22T23:49:29Z

‎wesnoth.unit_resistance_against: Fix header typo

2021-07-04T23:35:23Z

Add context specifiers to each entry; it's redundant but it's useful redundancy

@@ Line 280: / Line 280: @@
 * ''animator'':'''add(''unit'', ''flag'', ''hits'', ''params'')'''
-Adds a unit to the animation. The ''flag'' specifies which [[AnimationWML#Common_animation_events_used_by_the_engine|animation]] to play, and the ''hits'' parameter is required for attack animations to specify which variant of the animation to play. Possible keys in ''params'' are:
+Adds a unit to the animation. The unit should be one that wasn't previously added. The ''flag'' specifies which [[AnimationWML#Common_animation_events_used_by_the_engine|animation]] to play, and the ''hits'' parameter is required for attack animations to specify which variant of the animation to play. Possible keys in ''params'' are:
 * '''facing''': A location. The animation will be played with the unit facing that location.

@@ Line 81: / Line 81: @@
 === wesnoth.units.to_map ===
-* {{LuaGameOnly}} '''wesnoth.units.to_map'''(''unit'')
+* {{LuaGameOnly}} '''wesnoth.units.to_map'''(''unit'' [,''fire_event''])
-* {{LuaGameOnly}} '''wesnoth.units.to_map'''(''unit'', ''x'', ''y'')
+* {{LuaGameOnly}} '''wesnoth.units.to_map'''(''unit'', ''x'', ''y'' [,''fire_event''])
-* {{LuaGameOnly}} ''unit'':'''to_map'''([''x'', ''y''])
+* {{LuaGameOnly}} ''unit'':'''to_map'''([''x'', ''y'' [,''fire_event'']])
 Places a unit on the map. This unit is described either by a WML table or by a proxy unit (to use the third form, it must be a proxy). Coordinates can be passed as additional arguments; otherwise the table is expected to have two fields '''x''' and '''y''', which indicate where the unit will be placed.

← Older revision		Revision as of 17:56, 21 September 2024
Line 117:		Line 117:

	When the argument is a proxy unit, no duplicate is created. In particular, if the unit was private or on the map, it no longer is. Note: passing a WML table is just a shortcut for calling [[#wesnoth.units.create]] and then putting the resulting unit on a recall list.		When the argument is a proxy unit, no duplicate is created. In particular, if the unit was private or on the map, it no longer is. Note: passing a WML table is just a shortcut for calling [[#wesnoth.units.create]] and then putting the resulting unit on a recall list.
		+
		+	=== wesnoth.units.rebuild ===
		+
		+	{{DevFeature1.19\|4}}
		+
		+	* {{LuaGameOnly}} '''wesnoth.units.rebuild'''(''unit'')
		+	* {{LuaGameOnly}} ''unit'':'''rebuild'''()
		+
		+	Immediately rebuilds the unit from its unit type and modifications, discarding any alterations to non-transient attributes. Does not reset transient attributes such as the units current hitpoints, moves, or experience.

	=== wesnoth.units.transform ===		=== wesnoth.units.transform ===

@@ Line 173: / Line 173: @@
 </syntaxhighlight>
-=== wesnoth.unit.resistance_against ===
+=== wesnoth.units.resistance_against ===
 * {{LuaGameOnly}} '''wesnoth.units.resistance_against'''(''unit'', ''damage_type'', [''as_attacker''], [''x'', ''y'']) → ''resistance value''

@@ Line 271: / Line 271: @@
 * ''animator'':'''add(''unit'', ''flag'', ''hits'', ''params'')'''
-Adds a unit to the animation. The ''flag'' specifies which animation to play, and the ''hits'' parameter is required for attack animations to specify which variant of the animation to play. Possible keys in ''params'' are:
+Adds a unit to the animation. The ''flag'' specifies which [[AnimationWML#Common_animation_events_used_by_the_engine|animation]] to play, and the ''hits'' parameter is required for attack animations to specify which variant of the animation to play. Possible keys in ''params'' are:
 * '''facing''': A location. The animation will be played with the unit facing that location.

@@ Line 274: / Line 274: @@
 * '''facing''': A location. The animation will be played with the unit facing that location.
 * '''value''': Either a number or a list of two numbers. Use this to pass ''value'' and/or ''value_second'' to default animations that use them.
 * '''with_bars''': Whether to show HP bars and such while the animation plays.

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

	The entire units module is only available in the game. It is not available to plugins or map generators.		The entire units module is only available in the game. It is not available to plugins or map generators.
		+
		+	== Functions ==

	=== wesnoth.units.advance ===		=== wesnoth.units.advance ===