Skip to content

Return of Reckoning

Wiki

RoR Wiki

API:GetGuildSignupData

From RoR Wiki

UI Lua API · Guild functions
Version: WAR 1.4.8

Returns the guild members signed up to a guild calendar appointment.

signups = GetGuildSignupData(appointmentID)

Arguments

appointmentID
number – Appointment id, as in the appointmentID field of GetGuildAppointmentData.

Returns

signups
table – Array of sign-up tables, indexed from 1. Empty if the appointment is not found.

Each sign-up table has these fields:

Key Type Meaning
memberID number Character id of the member.
name wstring Name of the member, taken from the guild roster.
accepted number 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 rank field from each entry; the client does not set it, so it is always nil.
  • The argument check reports errors under the name SendGuildAppointmentData: 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 default/ea_guildwindow/source/guildwindowtabcalendar.lua:

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

See also