LuaAPI/wesnoth/interface - Revision history

Soliton: /* wesnoth.interface.float_label */

2025-07-03T16:13:29Z

‎wesnoth.interface.float_label

2024-11-04T13:50:08Z

‎wesnoth.interface.delay: - update deprecated example

2024-10-30T15:27:53Z

‎wesnoth.interface.remove_hex_overlay

2024-10-30T15:27:25Z

‎wesnoth.interface.add_hex_overlay

2024-10-29T14:09:34Z

‎wesnoth.interface.add_item_image

2024-10-29T14:08:54Z

‎wesnoth.interface.add_item_halo

2024-04-18T17:42:00Z

disable search support

2024-04-18T17:29:04Z

enable searching by function name

2024-03-11T17:08:52Z

‎report_countdown

2022-07-09T13:48:16Z

‎wesnoth.interface.add_overlay_text: add wesnoth.interface.handle_user_interact

@@ Line 51: / Line 51: @@
 * {{LuaGameOnly}} '''wesnoth.interface.float_label'''(''x'', ''y'', ''text'')
-Pops some text above a map tile.
+Adds a floating label above a map tile. The text will float upwards at 100 pixels per second.
 <syntaxhighlight lang=lua>
-wesnoth.float_label(unit.x, unit.y, "<span color='#ff0000'>Ouch</span>")
+wesnoth.interface.float_label(unit.x, unit.y, "<span color='#ff0000'>Ouch</span>")
 </syntaxhighlight>

@@ Line 14: / Line 14: @@
 <syntaxhighlight lang=lua>
-wesnoth.delay(500)
+wesnoth.interface.delay(500)
 </syntaxhighlight>

@@ Line 231: / Line 231: @@
 === wesnoth.interface.remove_hex_overlay ===
-* {{LuaGameOnly}} '''wesnoth.remove_hex_overlay'''(''location'', [''filename''])
+* {{LuaGameOnly}} '''wesnoth.interface.remove_hex_overlay'''(''location'', [''filename''])
 Removes all the overlays at the given location, including any added by '''wesnoth.interface.add_item_halo''' or '''wesnoth.interface.add_item_image''' (however, such a removal will not be kept over save/load cycles). If a filename is passed as a third argument, only this overlay (either image or halo) is removed.

@@ Line 221: / Line 221: @@
 === wesnoth.interface.add_hex_overlay ===
-* {{LuaGameOnly}} '''wesnoth.add_hex_overlay'''(''location'', ''item_wml'')
+* {{LuaGameOnly}} '''wesnoth.interface.add_hex_overlay'''(''location'', ''item_wml'')
 Places a hex overlay (either an image or a halo) on the given location. The overlay is described by a table supporting the same fields as [[InterfaceActionsWML|[item]]]. This is a lower-level version of the item functions above. Note that the overlay is not kept over save/load cycles.

@@ Line 189: / Line 189: @@
 === wesnoth.interface.add_item_image ===
-* {{LuaGameOnly}} '''wesnoth.interface.place_item_image'''(''location'', ''filename'')
+* {{LuaGameOnly}} '''wesnoth.interface.add_item_image'''(''location'', ''filename'')
 Places an image at a given location and registers it as a WML ''[item]'' would do, so that it can be restored after save/load. Note that the location must be passed as separate x and y coordinates, as in the example.
 <syntaxhighlight lang=lua>
-wesnoth.interface.place_item_image(17, 42, "items/orcish-flag.png")
+wesnoth.interface.add_item_image(17, 42, "items/orcish-flag.png")
 </syntaxhighlight>

@@ Line 199: / Line 199: @@
 === wesnoth.interface.add_item_halo ===
-* {{LuaGameOnly}} '''wesnoth.interface.place_item_halo'''(''location'', ''filename'')
+* {{LuaGameOnly}} '''wesnoth.interface.add_item_halo'''(''location'', ''filename'')
 Behaves the same as [[#wesnoth.interface.add_item_image]] but for halos.

@@ Line 555: / Line 555: @@
 </syntaxhighlight>
-Depending on the turn limit, it may also be colored using Pango markup.
+Depending on the time limit, the text may also be colored using [[Pango formatting|Pango markup]].
 [[Category:Lua Reference]]

← Older revision		Revision as of 13:48, 9 July 2022
Line 296:		Line 296:

	Replaces the text with new text. Options are the same as in ''add_overlay_text'', and the returned handle is the same one.		Replaces the text with new text. Options are the same as in ''add_overlay_text'', and the returned handle is the same one.
		+
		+	=== wesnoth.interface.handle_user_interact ===
		+
		+	{{DevFeature1.17\|6}}
		+
		+	* {{LuaGameOnly}} '''wesnoth.interface.handle_user_interact'''()
		+
		+	Handle user interaction with the game interface. This can be inserted into Lua code that takes a long time to execute in order to prevent the user interface from freezing.

	== wesnoth.interface.game_display ==		== wesnoth.interface.game_display ==