LuaWML/Time - Revision history

Elvish Hunter: /* wesnoth.get_time_of_day */ Added sound and mask fields to returned table

2021-06-17T21:05:37Z

‎wesnoth.get_time_of_day: Added sound and mask fields to returned table

Celtic Minstrel: Add move notice

2021-02-12T13:30:46Z

Add move notice

Elvish Hunter at 15:07, 16 June 2020

2020-06-16T15:07:50Z

Vultraz: Vultraz moved page LuaWML:Time to LuaWML/Time

2016-03-11T03:42:12Z

Vultraz moved page LuaWML:Time to LuaWML/Time

Shadowm: Document wesnoth.add_time_area, wesnoth.remove_time_area

2015-11-27T02:51:49Z

Document wesnoth.add_time_area, wesnoth.remove_time_area

Shadowm: Add category

2015-11-27T02:44:39Z

Add category

Shadowm: Move wesnoth.get_time_of_day to a dedicated ToD functions page

2015-11-27T02:44:16Z

Move wesnoth.get_time_of_day to a dedicated ToD functions page

New page

[[LuaWML]] functions revolving around Time of Day schedule functionality, including time areas.

==== wesnoth.get_time_of_day ====

* '''wesnoth.get_time_of_day([''for_turn''], [ {''x'', ''y'', [''consider_illuminates'']} ])'''

Returns schedule information. First parameter (optional) is the turn number for which to return the information, if unspecified: the current turn ($turn_number). Second argument is an optional table. If present, first and second fields must be valid on-map coordinates and all current time_areas in the scenario are taken into account (if a time area happens to contain the passed hex). If the table isn't present, the scenario main schedule is returned. The table has an optional third parameter (boolean). If true (default: false), time of day modifying units and terrain (such as Mages of Light or lava) are taken into account (if the passed hex happens to be affected). The units' placement being considered is always the current one.

wesnoth.get_time_of_day(2, { 37, 3, true })

The function returns a table with these named fields:
* '''id''': string (as in [time])
* '''lawful_bonus''': integer (as in [time])
* '''bonus_modified''': integer (bonus change by units)
* '''image''': string (tod image in sidebar)
* '''name''': translatable string
* '''red, green, blue''': integers (color adjustment for this time)

← Older revision		Revision as of 13:30, 12 February 2021
Line 1:		Line 1:
		+	{{Template:LuaMove}}
		+
	[[LuaWML]] functions revolving around Time of Day schedule functionality, including time areas.		[[LuaWML]] functions revolving around Time of Day schedule functionality, including time areas.

@@ Line 40: / Line 40: @@
       wesnoth.remove_time_area(id)
   end
 [[Category: Lua Reference]]

← Older revision		Revision as of 02:44, 27 November 2015
Line 16:		Line 16:
	* '''name''': translatable string		* '''name''': translatable string
	* '''red, green, blue''': integers (color adjustment for this time)		* '''red, green, blue''': integers (color adjustment for this time)
		+
		+	[[Category: Lua Reference]]

@@ Line 18: / Line 18: @@
 * '''name''': translatable string
 * '''red, green, blue''': integers (color adjustment for this time)
 ==== wesnoth.add_time_area ====

← Older revision	Revision as of 03:42, 11 March 2016
(No difference)