Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:55Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Guild}}
Returns the guild members signed up to a guild calendar appointment.

<pre>
signups = GetGuildSignupData(appointmentID)
</pre>

== Arguments ==
;appointmentID : <code>number</code> – Appointment id, as in the <code>appointmentID</code> field of [[API:GetGuildAppointmentData|GetGuildAppointmentData]].

== Returns ==
;signups : <code>table</code> – Array of sign-up tables, indexed from 1. Empty if the appointment is not found.

Each sign-up table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>memberID</code> || <code>number</code> || Character id of the member.
|-
| <code>name</code> || <code>wstring</code> || Name of the member, taken from the guild roster.
|-
| <code>accepted</code> || <code>number</code> || Sign-up status value.
|}

== Details ==
* Only appointments of the player's own guild are searched.
* Sign-ups whose member is not found in the guild roster are left out.
* The stock UI also copies a <code>rank</code> field from each entry; the client does not set it, so it is always <code>nil</code>.
* The argument check reports errors under the name <code>SendGuildAppointmentData</code>: if the argument is missing or not a number, the ''Invalid Parameters'' message names that function.
* If there is no player object, or the Lua state is not available, the function returns nothing.

== Errors ==
None besides the generic ''Invalid Parameters'' message (see Details).

== Example ==
From <code>default/ea_guildwindow/source/guildwindowtabcalendar.lua</code>:
<pre>
local signupData = GetGuildSignupData(GuildWindowTabCalendar.appointmentListData[GuildWindowTabCalendar.SelectedAppointmentIndex].appointmentID)
...
for key, value in ipairs( signupData ) do
GuildWindowTabCalendar.signupListData[key] = {}
GuildWindowTabCalendar.signupListData[key].name = value.name
GuildWindowTabCalendar.signupListData[key].rank = value.rank
GuildWindowTabCalendar.signupListData[key].accepted = value.accepted
GuildWindowTabCalendar.signupListData[key].memberID = value.memberID
end
</pre>

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

API:GetGuildSignupData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)