LuaAPI/wesnoth/units - Revision history

Soliton: /* wesnoth.units.find */

2026-09-25T11:15:22Z

wesnoth.units.find

← Older revision		Revision as of 11:15, 25 September 2026
Line 328:		Line 328:
	* {{LuaGameOnly}} '''wesnoth.units.find'''(''filter'') → ''array of units''		* {{LuaGameOnly}} '''wesnoth.units.find'''(''filter'') → ''array of units''

	Returns a list of all units matching the WML filter, both those on the map and those on the recall lists. It is a shorthand for calling both '''find_on_map''' and '''find_on_recall''' and combining the resulting arrays.		Returns a list of all [[LuaAPI/types/unit\|units]] matching the WML filter, both those on the map and those on the recall lists. It is a shorthand for calling both '''find_on_map''' and '''find_on_recall''' and combining the resulting arrays.

	=== wesnoth.units.get ===		=== wesnoth.units.get ===

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

← Older revision		Revision as of 19:04, 23 December 2024
Line 280:		Line 280:
	* ''animator'':'''add(''unit'', ''flag'', ''hits'', ''params'')'''		* ''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.		* '''facing''': A location. The animation will be played with the unit facing that location.

ZombieKnight: /* wesnoth.units.to_map */

2024-11-01T17:59:19Z

wesnoth.units.to_map

← Older revision		Revision as of 17:59, 1 November 2024
Line 81:		Line 81:
	=== wesnoth.units.to_map ===		=== 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.		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.

Celtic Minstrel: Document wesnoth.units.rebuild

2024-09-21T17:56:29Z

Document wesnoth.units.rebuild

← 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 ===

ZombieKnight at 18:00, 7 August 2024

2024-08-07T18:00:42Z

← Older revision		Revision as of 18:00, 7 August 2024
Line 173:		Line 173:
	</syntaxhighlight>		</syntaxhighlight>

	=== wesnoth.~~unit~~.resistance_against ===		=== wesnoth.units.resistance_against ===

	* {{LuaGameOnly}} '''wesnoth.units.resistance_against'''(''unit'', ''damage_type'', [''as_attacker''], [''x'', ''y'']) → ''resistance value''		* {{LuaGameOnly}} '''wesnoth.units.resistance_against'''(''unit'', ''damage_type'', [''as_attacker''], [''x'', ''y'']) → ''resistance value''

Soliton: /* wesnoth.units.create_animator */

2024-07-31T14:46:10Z

wesnoth.units.create_animator

← Older revision		Revision as of 14:46, 31 July 2024
Line 271:		Line 271:
	* ''animator'':'''add(''unit'', ''flag'', ''hits'', ''params'')'''		* ''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.		* '''facing''': A location. The animation will be played with the unit facing that location.

White haired uncle: /* wesnoth.units.create_animator */

2024-06-25T15:04:42Z

wesnoth.units.create_animator

← Older revision		Revision as of 15:04, 25 June 2024
Line 274:		Line 274:

	* '''facing''': A location. The animation will be played with the unit facing that location.		* '''facing''': A location. The animation will be played with the unit facing that location.

			facing is currently not implemented/working. See https://github.com/wesnoth/wesnoth/issues/9032

	* '''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.		* '''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.		* '''with_bars''': Whether to show HP bars and such while the animation plays.

Laela at 17:52, 18 April 2024

2024-04-18T17:52:21Z

← 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 ===

Celtic Minstrel: /* wesnoth.units.create_animator */ typo

2023-02-01T14:55:22Z

wesnoth.units.create_animator: typo

← Older revision		Revision as of 14:55, 1 February 2023
Line 269:		Line 269:
	* ''animator'':'''add(''unit'', ''flag'', ''hits'', ''params'')'''		* ''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. ~~Possibly~~ keys in ''params'' are:		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:

	* '''facing''': A location. The animation will be played with the unit facing that location.		* '''facing''': A location. The animation will be played with the unit facing that location.

Celtic Minstrel: /* wesnoth.unit_resistance_against */ Fix header typo

2021-07-22T23:49:29Z

wesnoth.unit_resistance_against: Fix header typo

← Older revision		Revision as of 23:49, 22 July 2021
Line 171:		Line 171:
	</syntaxhighlight>		</syntaxhighlight>

	=== wesnoth.~~unit_resistance_against~~ ===		=== wesnoth.unit.resistance_against ===

	* {{LuaGameOnly}} '''wesnoth.units.resistance_against'''(''unit'', ''damage_type'', [''as_attacker''], [''x'', ''y'']) → ''resistance value''		* {{LuaGameOnly}} '''wesnoth.units.resistance_against'''(''unit'', ''damage_type'', [''as_attacker''], [''x'', ''y'']) → ''resistance value''