LuaAPI/wesnoth - Revision history

Laela: /* wesnoth.current */ user_is_replaying

2025-06-22T09:24:16Z

‎wesnoth.current: user_is_replaying

2025-03-23T17:26:08Z

‎wesnoth.terrain_types

2025-03-14T03:30:17Z

‎wesnoth.terrain_types: Add new subtables added #9979

2024-11-28T13:51:01Z

‎wesnoth.scenario: typo

2024-11-25T00:28:54Z

‎wesnoth.scenario: era limitation

2024-11-06T23:38:20Z

‎wesnoth.simulate_combat: - Document weapon evaluation table values

2024-09-21T17:53:18Z

‎wesnoth.game_config: Document game_config.palettes and game_config.xx_scale[_text]

2024-09-19T00:57:51Z

‎wesnoth.name_generator: Link to the other name generator location

2024-07-27T18:09:37Z

‎wesnoth.deprecated_message

2024-07-14T20:32:37Z

‎wesnoth.simulate_combat: Let's not call it an array. It isn't really an array even though it looks similar

← Older revision		Revision as of 09:24, 22 June 2025
Line 525:		Line 525:

	Indicates whether the player is currently able to take actions in the game.		Indicates whether the player is currently able to take actions in the game.
		+
		+	* {{LuaGameOnly}} '''wesnoth.current.user_is_replaying''' → ''boolean'' {{DevFeature1.19\|7}}
		+
		+	Indicates whether the player is currently in replay mode.

	* {{LuaGameOnly}} '''wesnoth.current.map''' → ''map userdata''		* {{LuaGameOnly}} '''wesnoth.current.map''' → ''map userdata''

@@ Line 747: / Line 747: @@
 * '''keep'''
 * '''healing'''
-* '''mvt_alias''' {{DevFeature1.19|9}}
+* '''mvt_alias''' {{DevFeature1.19|10}}
-* '''def_alias''' {{DevFeature1.19|9}}
+* '''def_alias''' {{DevFeature1.19|10}}
 === wesnoth.unit_types ===

@@ Line 747: / Line 747: @@
 * '''keep'''
 * '''healing'''
 === wesnoth.unit_types ===

@@ Line 683: / Line 683: @@
 * {{LuaGameOnly}} '''wesnoth.scenario.era''' &rarr; ''era tag''
-The [era] tag active in this scenario. Accessing this will throw an error in single-player games. This exists only for players which have the era installed, so for an era with ''require_era=yes'' it is save to use.
+The [era] tag active in this scenario. Accessing this will throw an error in single-player games. This exists only for players which have the era installed, so for an era with ''require_era=yes'' it is safe to use.
 * {{LuaGameOnly}} '''wesnoth.scenario.campaign''' &rarr; ''campaign tag''

@@ Line 683: / Line 683: @@
 * {{LuaGameOnly}} '''wesnoth.scenario.era''' &rarr; ''era tag''
-The [era] tag active in this scenario. Accessing this will throw an error in single-player games.
+The [era] tag active in this scenario. Accessing this will throw an error in single-player games. This exists only for players which have the era installed, so for an era with ''require_era=yes'' it is save to use.
 * {{LuaGameOnly}} '''wesnoth.scenario.campaign''' &rarr; ''campaign tag''

@@ Line 90: / Line 90: @@
 The weapon evaluation tables contain the following keys:
-num_blows, damage, chance_to_hit, poisons, slows, petrifies, plagues, plague_type, backstabs, rounds, firststrike, drains, drain_constant, drain_percent, attack_num, name
+{| class="wikitable"
 <syntaxhighlight lang='lua'>

← Older revision		Revision as of 17:53, 21 September 2024
Line 555:		Line 555:

	Whether strict Lua mode is enabled. Strict Lua mode is activated by the --strict-lua command-line parameter and causes all deprecated Lua APIs to be completely removed from the engine.		Whether strict Lua mode is enabled. Strict Lua mode is activated by the --strict-lua command-line parameter and causes all deprecated Lua APIs to be completely removed from the engine.
		+
		+	* {{DevFeature1.19\|4}} '''wesnoth.game_config.palettes'''.''palette'' → ''list of colors''
		+
		+	Returns the color palette with the given name, as defined by a '''[color_palette]''' tag in the [[GameConfigWML#Color_Palettes\|game config]].
		+
		+	* {{DevFeature1.19\|4}} '''wesnoth.game_config.red_green_scale''' → ''list of colors''
		+
		+	Returns the gradient used for health bars.
		+
		+	* {{DevFeature1.19\|4}} '''wesnoth.game_config.red_green_scale_text''' → ''list of colors''
		+
		+	Returns the gradient used for health numbers.
		+
		+	* {{DevFeature1.19\|4}} '''wesnoth.game_config.blue_white_scale''' → ''list of colors''
		+
		+	Returns the gradient used for experience bars.
		+
		+	* {{DevFeature1.19\|4}} '''wesnoth.game_config.blue_white_scale_text''' → ''list of colors''
		+
		+	Returns the gradient used for experience numbers.

	=== wesnoth.races ===		=== wesnoth.races ===

@@ Line 133: / Line 133: @@
 print(cfg_names(), cfg_names(), cfg_names())
 </syntaxhighlight>
 === wesnoth.compile_formula ===

@@ Line 209: / Line 209: @@
 * '''wesnoth.deprecated_message'''(''element_name'', ''level'', ''version'', ''detail_message'')
-Displays a deprecation warning in the Lua console. The level is an integer from 1 to 4 inclusive, and the version can be left nil for levels 1 and 4. Otherwise it must be a version ''string'' (not a version object from [[#wesnoth.version|wesnoth.version]]).
+Displays a deprecation warning in the Lua console. The level is an integer from 1 to 4 inclusive (see [[CompatibilityStandards#Deprecation_levels_-_When_to_remove_deprecated_features|deprecation levels]]), and the version can be left nil for levels 1 and 4. Otherwise it must be a version ''string'' (not a version object from [[#wesnoth.version|wesnoth.version]]).
 === wesnoth.deprecate_api ===

@@ Line 84: / Line 84: @@
 The expected value of the unit's hitpoints after the fight.
-* ''stats''.'''hp_chance''' &rarr; ''array of probabilities''
+* ''stats''.'''hp_chance''' &rarr; ''mapping of hp to probability''
-The probability that the unit's hitpoints will be at a specific value after the fight. Unlike normal arrays in Lua, this one begins at index 0, which represents the chance that the unit will die.
+The probability that the unit's hitpoints will be at a specific value after the fight. Though it looks almost like an array, it begins at index 0 unlike a typical Lua array. Thus, it's better understood as an associated mapping from the resulting hitpoints value to the probability of ending the combat with that value. Therefore, the value at index 0 represents the chance that the unit will die.
 The weapon evaluation tables contain the following keys: