Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:22Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Time}}
Returns a month and year written the way the computer's regional settings write them, for example as a calendar title.

<pre>
text = GetYearMonthName(year, month)
</pre>

== Arguments ==
;year : <code>number</code> – The year, 1900 or later. Fractions are dropped.
;month : <code>number</code> – The month, 1 to 12. Fractions are dropped.

== Returns ==
;text : <code>wstring</code> – The formatted year and month.

== Details ==
* The text is produced by Windows' date formatting with the "year and month" format of the current thread locale, for the first day of the given month.
* A <code>year</code> below 1900 or a <code>month</code> outside 1–12 logs the matching error and returns nothing.
* If Windows cannot format the date, the third error is logged and an empty string is returned.
* The argument check is shared with [[API:GetMonthName|GetMonthName]]: if an argument is missing or not a number, the ''Invalid Parameters'' message names that function.
* The function needs at least two arguments and only reads the last two.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'GetYearMonthName': The year index[%u] is invalid. Year index should be greater than 1900!</code>
* <code>Error in function call 'GetYearMonthName': The month index[%u] is invalid. Month index should be between 1 and 12!</code>
* <code>Error in function call 'GetYearMonthName': Could not get valid year month name string for year[%u] month[%u]!</code>

== Example ==
From <code>ea_guildwindow/source/calendar.lua</code>:
<pre>
LabelSetText( "CalendarYearMonthLabel", GetYearMonthName( Calendar.year, Calendar.month ) )
</pre>

== See also ==
* [[API:GetMonthName|GetMonthName]]
* [[API:GetTodaysDate|GetTodaysDate]]

API:GetYearMonthName - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)