Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:21Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Time}}
Returns the name of a day of the week in the language of the computer's regional settings.

<pre>
name = GetWeekDayName(dayIndex, abbreviated)
</pre>

== Arguments ==
;dayIndex : <code>number</code> – Day of the week, 1 to 7: 1 is Monday, 7 is Sunday. Fractions are dropped.
;abbreviated : <code>boolean</code> – <code>true</code> for the short form of the name, <code>false</code> for the full name.

== Returns ==
;name : <code>wstring</code> – The day name.

== Details ==
* The name comes from Windows' locale data for the current thread locale, not from the game's string tables. The full names are the locale's day names, the short ones its abbreviated day names.
* The day numbering matches [[API:GetFirstDayOfWeek|GetFirstDayOfWeek]].
* If Windows cannot supply the name, an empty string is returned.
* With a <code>dayIndex</code> outside 1–7 the client logs the ''Invalid day index'' error and returns nothing.
* <code>abbreviated</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.
* The function needs at least two arguments and only reads the last two.

== Errors ==
This is written to the UI log; the call returns normally.
* <code>Error in function call 'GetWeekDayName': Invalid day index.</code>

== Example ==
Filling the weekday header of the guild calendar with the first letter of each short name, from <code>ea_guildwindow/source/calendar.lua</code>:
<pre>
local dayIndex = GetFirstDayOfWeek()
for labelIndex = 1, 7
do
LabelSetText( "GuildWindowCalendarDOTW"..labelIndex, wstring.sub( GetWeekDayName( dayIndex, true ), 0, 1 ) )
dayIndex = dayIndex + 1
if ( dayIndex > 7 )
then
dayIndex = dayIndex - 7
end
end
</pre>

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

API:GetWeekDayName - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)