Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:51Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Guild}}
Returns the events (appointments) in the guild calendar.

<pre>
appointments = GetGuildAppointmentData()
</pre>

== Arguments ==
None.

== Returns ==
;appointments : <code>table</code> – Array of appointment tables, indexed from 1. Empty if there are none.

Each appointment table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>appointmentID</code> || <code>number</code> || Appointment id, 0–255.
|-
| <code>guildID</code> || <code>number</code> || Id of the guild that owns the appointment.
|-
| <code>creatorID</code> || <code>number</code> || Character id of the member who created it.
|-
| <code>bIsPlayersEvent</code> || <code>boolean</code> || <code>true</code> if <code>creatorID</code> is the player's own character.
|-
| <code>startTime</code> || <code>number</code> || Start as a raw time value.
|-
| <code>startMonth</code> || <code>number</code> || Start month, 1–12.
|-
| <code>startDay</code> || <code>number</code> || Start day of the month.
|-
| <code>startYear</code> || <code>number</code> || Start year.
|-
| <code>startHour</code> || <code>number</code> || Start hour, 0–23.
|-
| <code>startMinute</code> || <code>number</code> || Start minute.
|-
| <code>endTime</code>, <code>endMonth</code>, <code>endDay</code>, <code>endYear</code>, <code>endHour</code>, <code>endMinute</code> || <code>number</code> || The same for the end of the appointment.
|-
| <code>summary</code> || <code>wstring</code> || Event name. The stock UI stores it as <code>subject</code>.
|-
| <code>details</code> || <code>wstring</code> || Event description.
|-
| <code>locked</code> || <code>boolean</code> || <code>true</code> if sign-ups are locked.
|-
| <code>shared</code> || <code>boolean</code> || <code>true</code> if the event is shared with the alliance.
|-
| <code>localPlayerSignedUp</code> || <code>number</code> || Only present when the player is on the sign-up list; holds the player's sign-up status value.
|}

== Details ==
* The calendar fields are computed from the raw times in the computer's local time zone.
* <code>summary</code> and <code>details</code> are passed through the profanity filter when it is enabled.
* If there is no player object, or the Lua state is not available, the function returns nothing.
* Use [[API:GetGuildSignupData|GetGuildSignupData]] for the members signed up to one appointment.

== Errors ==
None.

== Example ==
From <code>default/ea_guildwindow/source/guildwindowtabcalendar.lua</code>:
<pre>
local guildAppointmentData = GetGuildAppointmentData()

if( guildAppointmentData == nil ) then
DEBUG(L"guildAppointmentData == nil")
return
end

for key, value in ipairs( guildAppointmentData ) do
...
GuildWindowTabCalendar.appointmentListData[key].appointmentID = value.appointmentID
GuildWindowTabCalendar.appointmentListData[key].guildID = value.guildID
...
GuildWindowTabCalendar.appointmentListData[key].subject = value.summary
GuildWindowTabCalendar.appointmentListData[key].details = value.details
</pre>

== See also ==
* [[API:GetGuildSignupData|GetGuildSignupData]]
* [[API:SendGuildAppointmentData|SendGuildAppointmentData]]

API:GetGuildAppointmentData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)