ReplayWML - Revision history

Dwarftough: fix replace_map name and adding a link to it

2025-05-04T21:12:55Z

fix replace_map name and adding a link to it

← Older revision		Revision as of 21:12, 4 May 2025
Line 55:		Line 55:
	* {{anchor\|global_variable\|'''[global_variable]'''}}: a WML code used with [get_global_variable]		* {{anchor\|global_variable\|'''[global_variable]'''}}: a WML code used with [get_global_variable]
	* {{anchor\|random_seed\|'''[random_seed]'''}}: a user's actions use the rng and thus a new random seed is needed.		* {{anchor\|random_seed\|'''[random_seed]'''}}: a user's actions use the rng and thus a new random seed is needed.
	* {{anchor\|map_data\|'''[map_data]'''}}: contains the map data read from the file when '''[~~replaced_map~~]''' with the '''map_file=''' argument was invoked.		* {{anchor\|map_data\|'''[map_data]'''}}: contains the map data read from the file when [[DirectActionsWML#.5Breplace_map.5D\|'''[replace_map]''']] with the '''map_file=''' argument was invoked.

	== See Also ==		== See Also ==

Dwarftough: Add info about [map_data] tag in replays

2025-05-02T14:30:58Z

Add info about [map_data] tag in replays

← Older revision		Revision as of 14:30, 2 May 2025
Line 54:		Line 54:
	* {{anchor\|input\|'''[input]'''}}: if a lua code used [[LuaWML:Misc#wesnoth.synchronize_choice]] this tag contains the returned table.		* {{anchor\|input\|'''[input]'''}}: if a lua code used [[LuaWML:Misc#wesnoth.synchronize_choice]] this tag contains the returned table.
	* {{anchor\|global_variable\|'''[global_variable]'''}}: a WML code used with [get_global_variable]		* {{anchor\|global_variable\|'''[global_variable]'''}}: a WML code used with [get_global_variable]
	* {{anchor\|random_seed\|'''[random_seed]'''}}: A user actions ~~uses~~ the rng and thus new random seed is needed.		* {{anchor\|random_seed\|'''[random_seed]'''}}: a user's actions use the rng and thus a new random seed is needed.
			* {{anchor\|map_data\|'''[map_data]'''}}: contains the map data read from the file when '''[replaced_map]''' with the '''map_file=''' argument was invoked.

	== See Also ==		== See Also ==

Celtic Minstrel: /* The [command] tag */ Add another anchor

2024-02-27T05:41:41Z

The [command] tag: Add another anchor

← Older revision		Revision as of 05:41, 27 February 2024
Line 9:		Line 9:
	The following tags are recognized for dependent=no(default):		The following tags are recognized for dependent=no(default):
	* {{anchor\|start\|'''[start]'''}}: is used to initialize the replay so that generated random numbers can be saved.		* {{anchor\|start\|'''[start]'''}}: is used to initialize the replay so that generated random numbers can be saved.
	* '''[move]''': the player moved a unit.		* {{anchor\|move\|'''[move]'''}}: the player moved a unit.
	** '''x,y''': the path the unit walks.		** '''x,y''': the path the unit walks.
	** '''skip_sighted''': whether the unit doesn't stop when discovering another unit, possible values are 'only_ally', 'all' or no, (default no).		** '''skip_sighted''': whether the unit doesn't stop when discovering another unit, possible values are 'only_ally', 'all' or no, (default no).

Celtic Minstrel: /* The [command] tag */ fix template

2024-02-25T01:34:10Z

The [command] tag: fix template

← Older revision		Revision as of 01:34, 25 February 2024
Line 23:		Line 23:
	** '''[source]''': the location of the attacking unit.		** '''[source]''': the location of the attacking unit.
	** '''[destination]''': the location of the defending unit.		** '''[destination]''': the location of the defending unit.
	* {[anchor\|disband\|'''[disband]'''}}: the player removes a unit from his recall list.		* {{anchor\|disband\|'''[disband]'''}}: the player removes a unit from his recall list.
	** '''value''' the id of the removed unit.		** '''value''' the id of the removed unit.
	* {{anchor\|end_turn\|'''[end_turn]'''}}: the player ended his turn.		* {{anchor\|end_turn\|'''[end_turn]'''}}: the player ended his turn.

Celtic Minstrel: /* The [command] tag */ Add anchors that other pages can link to

2024-02-25T01:25:13Z

The [command] tag: Add anchors that other pages can link to

Toranks: Doesn't support standard location filter, only x,y position. I got confused with [find_path]

2023-01-31T15:05:26Z

Doesn't support standard location filter, only x,y position. I got confused with [find_path]

← Older revision		Revision as of 15:05, 31 January 2023
Line 21:		Line 21:
	** '''weapon''': the index number of the weapon. Weapons are indexed by the unit designer.		** '''weapon''': the index number of the weapon. Weapons are indexed by the unit designer.
	** '''defender_weapon''': the index number of the defenders weapon. Weapons are indexed by the unit designer, '-1' to choose the best weapon locally. The '-1' option is deprecated because it can cause OOS.		** '''defender_weapon''': the index number of the defenders weapon. Weapons are indexed by the unit designer, '-1' to choose the best weapon locally. The '-1' option is deprecated because it can cause OOS.
	** '''[source]''': the location of the attacking unit~~. Use a [[StandardLocationFilter]]~~.		** '''[source]''': the location of the attacking unit.
	** '''[destination]''': the location of the defending unit~~. Use a [[StandardLocationFilter]]~~.		** '''[destination]''': the location of the defending unit.
	* '''[disband]''': the player removes a unit from his recall list.		* '''[disband]''': the player removes a unit from his recall list.
	** '''value''' the id of the removed unit.		** '''value''' the id of the removed unit.
Line 29:		Line 29:
	* '''[fire_event]''': a specific event was raised. This is mainly used for right-click menu items. ([set_menu_item])		* '''[fire_event]''': a specific event was raised. This is mainly used for right-click menu items. ([set_menu_item])
	** '''raise''': the name of the event		** '''raise''': the name of the event
	** '''[source]''': the location of the event~~. Use a [[StandardLocationFilter]].~~		** '''[source]''': the location of the event
	** '''[set_variable]''' (deprecated): set WML variable(s) before firing.		** '''[set_variable]''' (deprecated): set WML variable(s) before firing.
	*** '''name''': the name of the variable		*** '''name''': the name of the variable

Toranks: Specifies that it supports StandardLocationFilter with all its capabilities, although normally only x,y is used

2023-01-31T14:41:37Z

Specifies that it supports StandardLocationFilter with all its capabilities, although normally only x,y is used

← Older revision		Revision as of 14:41, 31 January 2023
Line 21:		Line 21:
	** '''weapon''': the index number of the weapon. Weapons are indexed by the unit designer.		** '''weapon''': the index number of the weapon. Weapons are indexed by the unit designer.
	** '''defender_weapon''': the index number of the defenders weapon. Weapons are indexed by the unit designer, '-1' to choose the best weapon locally. The '-1' option is deprecated because it can cause OOS.		** '''defender_weapon''': the index number of the defenders weapon. Weapons are indexed by the unit designer, '-1' to choose the best weapon locally. The '-1' option is deprecated because it can cause OOS.
	** '''[source]''': the location of the attacking unit.		** '''[source]''': the location of the attacking unit. Use a [[StandardLocationFilter]].
	** '''[destination]''': the location of the defending unit.		** '''[destination]''': the location of the defending unit. Use a [[StandardLocationFilter]].
	* '''[disband]''': the player removes a unit from his recall list.		* '''[disband]''': the player removes a unit from his recall list.
	** '''value''' the id of the removed unit.		** '''value''' the id of the removed unit.
Line 29:		Line 29:
	* '''[fire_event]''': a specific event was raised. This is mainly used for right-click menu items. ([set_menu_item])		* '''[fire_event]''': a specific event was raised. This is mainly used for right-click menu items. ([set_menu_item])
	** '''raise''': the name of the event		** '''raise''': the name of the event
	** '''[source]''': the location of the event		** '''[source]''': the location of the event. Use a [[StandardLocationFilter]].
	** '''[set_variable]''' (deprecated): set WML variable(s) before firing.		** '''[set_variable]''' (deprecated): set WML variable(s) before firing.
	*** '''name''': the name of the variable		*** '''name''': the name of the variable

Celtic Minstrel: /* The [command] tag */ Document [custom_command]

2018-04-13T04:13:46Z

The [command] tag: Document [custom_command]

← Older revision		Revision as of 04:13, 13 April 2018
Line 33:		Line 33:
	*** '''name''': the name of the variable		*** '''name''': the name of the variable
	*** '''value''': a string value (literal)		*** '''value''': a string value (literal)
	* '''[lua_ai]'''		* '''[lua_ai]''' {{DevFeature1.13\|12}} This has been removed.
	** '''code''' the lua code that is executed.		** '''code''' the lua code that is executed.
			* '''[custom_command]''' {{DevFeature1.13\|12}} Executes a custom command registered by Lua code
			** '''name''': The name of the custom command to run.
			** '''[data]''': Arbitrary data to be passed to the custom command.
	* '''[auto_shroud]''' a player toggled delayed shroud update		* '''[auto_shroud]''' a player toggled delayed shroud update
	** '''active''' whether automatic shroud updates will be active.		** '''active''' whether automatic shroud updates will be active.

Gfgtdf: /* The [command] tag */

2015-06-12T23:20:26Z

The [command] tag

Jmichael: /* The [command] tag */

2015-06-11T02:20:24Z

The [command] tag

← Older revision		Revision as of 02:20, 11 June 2015
Line 35:		Line 35:
	* '''[lua_ai]'''		* '''[lua_ai]'''
	** '''code''' the lua code that is executed.		** '''code''' the lua code that is executed.
	* '''[auto_shroud]''' a player toggled delayed shroud ~~updated~~		* '''[auto_shroud]''' a player toggled delayed shroud update
	** '''active''' whether automatic ~~should~~ updates will be active.		** '''active''' whether automatic shroud updates will be active.
	* '''[update_shroud]''' a player manually updated ~~should~~.		* '''[update_shroud]''' a player manually updated shroud.

	Non dependent commands can have a [checkup] tag which is used to check whether the data generated in the replay matches the data generated during the original game, The [checkup] tag can contain different [result] tags whose content is different for the different actions.		Non dependent commands can have a [checkup] tag which is used to check whether the data generated in the replay matches the data generated during the original game, The [checkup] tag can contain different [result] tags whose content is different for the different actions.

← Older revision		Revision as of 14:30, 2 May 2025
Line 54:		Line 54:
	* {{anchor\|input\|'''[input]'''}}: if a lua code used [[LuaWML:Misc#wesnoth.synchronize_choice]] this tag contains the returned table.		* {{anchor\|input\|'''[input]'''}}: if a lua code used [[LuaWML:Misc#wesnoth.synchronize_choice]] this tag contains the returned table.
	* {{anchor\|global_variable\|'''[global_variable]'''}}: a WML code used with [get_global_variable]		* {{anchor\|global_variable\|'''[global_variable]'''}}: a WML code used with [get_global_variable]
	* {{anchor\|random_seed\|'''[random_seed]'''}}: A user actions ~~uses~~ the rng and thus new random seed is needed.		* {{anchor\|random_seed\|'''[random_seed]'''}}: a user's actions use the rng and thus a new random seed is needed.
			* {{anchor\|map_data\|'''[map_data]'''}}: contains the map data read from the file when '''[replaced_map]''' with the '''map_file=''' argument was invoked.

	== See Also ==		== See Also ==

← Older revision		Revision as of 01:25, 25 February 2024
Line 8:		Line 8:
	* '''sent''' used internally in networked mp, to know which commands were already sent to the other clients.		* '''sent''' used internally in networked mp, to know which commands were already sent to the other clients.
	The following tags are recognized for dependent=no(default):		The following tags are recognized for dependent=no(default):
	* '''[start]''': is used to initialize the replay so that generated random numbers can be saved.		* {{anchor\|start\|'''[start]'''}}: is used to initialize the replay so that generated random numbers can be saved.
	* '''[move]''': the player moved a unit.		* '''[move]''': the player moved a unit.
	** '''x,y''': the path the unit walks.		** '''x,y''': the path the unit walks.
	** '''skip_sighted''': whether the unit doesn't stop when discovering another unit, possible values are 'only_ally', 'all' or no, (default no).		** '''skip_sighted''': whether the unit doesn't stop when discovering another unit, possible values are 'only_ally', 'all' or no, (default no).
	* '''[recruit]''': the player recruited a unit.		* {{anchor\|recruit\|'''[recruit]'''}}: the player recruited a unit.
	** '''type''': the id of the type of unit recruited.		** '''type''': the id of the type of unit recruited.
	** '''x''' and '''y''': the castle tile the unit is recruited on.		** '''x''' and '''y''': the castle tile the unit is recruited on.
	** '''[from]'''		** '''[from]'''
	*** '''x''' and '''y''': the keep tile the unit is recruited from.		*** '''x''' and '''y''': the keep tile the unit is recruited from.
	* '''[recall]''': the player recalled a unit. Same keys as [recruit], except that '''value''' is the id of the unit being recalled.		* {{anchor\|recall\|'''[recall]'''}}: the player recalled a unit. Same keys as [recruit], except that '''value''' is the id of the unit being recalled.
	* '''[attack]''': the player attacked.		* {{anchor\|attack\|'''[attack]'''}}: the player attacked.
	** '''weapon''': the index number of the weapon. Weapons are indexed by the unit designer.		** '''weapon''': the index number of the weapon. Weapons are indexed by the unit designer.
	** '''defender_weapon''': the index number of the defenders weapon. Weapons are indexed by the unit designer, '-1' to choose the best weapon locally. The '-1' option is deprecated because it can cause OOS.		** '''defender_weapon''': the index number of the defenders weapon. Weapons are indexed by the unit designer, '-1' to choose the best weapon locally. The '-1' option is deprecated because it can cause OOS.
	** '''[source]''': the location of the attacking unit.		** '''[source]''': the location of the attacking unit.
	** '''[destination]''': the location of the defending unit.		** '''[destination]''': the location of the defending unit.
	* '''[disband]''': the player removes a unit from his recall list.		* {[anchor\|disband\|'''[disband]'''}}: the player removes a unit from his recall list.
	** '''value''' the id of the removed unit.		** '''value''' the id of the removed unit.
	* '''[end_turn]''': the player ended his turn.		* {{anchor\|end_turn\|'''[end_turn]'''}}: the player ended his turn.
	* '''[init_side]''': new turn is starting for a side. This fires begin of turn events.		* {{anchor\|init_side\|'''[init_side]'''}}: new turn is starting for a side. This fires begin of turn events.
	* '''[fire_event]''': a specific event was raised. This is mainly used for right-click menu items. ([set_menu_item])		* {{anchor\|fire_event\|'''[fire_event]'''}}: a specific event was raised. This is mainly used for right-click menu items. ([set_menu_item])
	** '''raise''': the name of the event		** '''raise''': the name of the event
	** '''[source]''': the location of the event		** '''[source]''': the location of the event
Line 33:		Line 33:
	*** '''name''': the name of the variable		*** '''name''': the name of the variable
	*** '''value''': a string value (literal)		*** '''value''': a string value (literal)
	* '''[lua_ai]''' {{DevFeature1.13\|12}} This has been removed.		* {{anchor\|lua_ai\|'''[lua_ai]'''}}: {{DevFeature1.13\|12}} This has been removed.
	** '''code''' the lua code that is executed.		** '''code''' the lua code that is executed.
	* '''[custom_command]''' {{DevFeature1.13\|12}} Executes a custom command registered by Lua code		* {{anchor\|custom_command\|'''[custom_command]'''}}: {{DevFeature1.13\|12}} Executes a custom command registered by Lua code
	** '''name''': The name of the custom command to run.		** '''name''': The name of the custom command to run.
	** '''[data]''': Arbitrary data to be passed to the custom command.		** '''[data]''': Arbitrary data to be passed to the custom command.
	* '''[auto_shroud]''' a player toggled delayed shroud update		* {{anchor\|auto_shroud\|'''[auto_shroud]'''}}: a player toggled delayed shroud update
	** '''active''' whether automatic shroud updates will be active.		** '''active''' whether automatic shroud updates will be active.
	* '''[update_shroud]''' a player manually updated shroud.		* {{anchor\|update_shroud\|'''[update_shroud]'''}}: a player manually updated shroud.

	Non dependent commands can have a [checkup] tag which is used to check whether the data generated in the replay matches the data generated during the original game, The [checkup] tag can contain different [result] tags whose content is different for the different actions.		Non dependent commands can have a [checkup] tag which is used to check whether the data generated in the replay matches the data generated during the original game, The [checkup] tag can contain different [result] tags whose content is different for the different actions.
Line 47:		Line 47:
	** '''damage''': the amount of damage that the attack would do if it hits.		** '''damage''': the amount of damage that the attack would do if it hits.
	** '''hits''': whether the attack hits.		** '''hits''': whether the attack hits.
	Or
	** '''dies''': whether the defender dies from the hit.		** '''dies''': whether the defender dies from the hit.

	The following tags are recognized for dependent=true:		The following tags are recognized for dependent=true:
	* '''[choose]''': the player was given an option by the scenario or for an advancement path.		* {{anchor\|choose\|'''[choose]'''}}: the player was given an option by the scenario or for an advancement path.
	** '''value''': the index number of the option chosen. Index numbers are given by the scenario designer.		** '''value''': the index number of the option chosen. Index numbers are given by the scenario designer.
	* '''[input]''': if a lua code used [[LuaWML:Misc#wesnoth.synchronize_choice]] this tag contains the returned table.		* {{anchor\|input\|'''[input]'''}}: if a lua code used [[LuaWML:Misc#wesnoth.synchronize_choice]] this tag contains the returned table.
	* '''[global_variable]''' a WML code used with [get_global_variable]		* {{anchor\|global_variable\|'''[global_variable]'''}}: a WML code used with [get_global_variable]
	* '''[random_seed]''' A user actions uses the rng and thus new random seed is needed.		* {{anchor\|random_seed\|'''[random_seed]'''}}: A user actions uses the rng and thus new random seed is needed.

	== See Also ==		== See Also ==

← Older revision		Revision as of 23:20, 12 June 2015
Line 20:		Line 20:
	* '''[attack]''': the player attacked.		* '''[attack]''': the player attacked.
	** '''weapon''': the index number of the weapon. Weapons are indexed by the unit designer.		** '''weapon''': the index number of the weapon. Weapons are indexed by the unit designer.
	** '''defender_weapon''': the index number of the defenders weapon. Weapons are indexed by the unit designer, '-1' to choose the best weapon locally.		** '''defender_weapon''': the index number of the defenders weapon. Weapons are indexed by the unit designer, '-1' to choose the best weapon locally. The '-1' option is deprecated because it can cause OOS.
	** '''[source]''': the location of the attacking unit.		** '''[source]''': the location of the attacking unit.
	** '''[destination]''': the location of the defending unit.		** '''[destination]''': the location of the defending unit.
Line 27:		Line 27:
	* '''[end_turn]''': the player ended his turn.		* '''[end_turn]''': the player ended his turn.
	* '''[init_side]''': new turn is starting for a side. This fires begin of turn events.		* '''[init_side]''': new turn is starting for a side. This fires begin of turn events.
	* '''[fire_event]''': a specific event was raised		* '''[fire_event]''': a specific event was raised. This is mainly used for right-click menu items. ([set_menu_item])
	** '''raise''': the name of the event		** '''raise''': the name of the event
	** '''[source]''': the location of the event		** '''[source]''': the location of the event
	** '''[set_variable]''': set WML variable(s) before firing		** '''[set_variable]''' (deprecated): set WML variable(s) before firing.
	*** '''name''': the name of the variable		*** '''name''': the name of the variable
	*** '''value''': a string value (literal)		*** '''value''': a string value (literal)