WoW:API CalendarGetDayEvent: Difference between revisions
Jump to navigation
Jump to search
m (The description of the argument "day" referred to it as an offset from the current day, when it is the actual day of the month.) |
(added changes from 3.2 (information needed)) |
||
| Line 2: | Line 2: | ||
Retrieve information about the specified event. | Retrieve information about the specified event. | ||
title, hour, minute, calendarType, sequenceType, eventType, texture, modStatus, inviteStatus = CalendarGetDayEvent(monthOffset, day, eventIndex) | title, hour, minute, calendarType, sequenceType, eventType, texture, modStatus, inviteStatus, invitedBy, difficulty, inviteType, sequenceIndex, numSequenceDayss = CalendarGetDayEvent(monthOffset, day, eventIndex) | ||
== Arguments == | == Arguments == | ||
| Line 25: | Line 24: | ||
:;modStatus : String - One of "MODERATOR", "CREATOR", "" | :;modStatus : String - One of "MODERATOR", "CREATOR", "" | ||
:;inviteStatus : Number - See table below | :;inviteStatus : Number - See table below | ||
:;invitedBy : | |||
:;difficulty : | |||
:;inviteType : | |||
:;sequenceIndex : | |||
:;numSequenceDays : | |||
== Details == | == Details == | ||
API update. New: '''invitedBy''', '''difficulty''', '''inviteType''', '''sequenceIndex''', '''numSequenceDays''' was added in Patch 3.2(August,2009 | |||
These tables have been extacted from the Beta UI code to give details on the above return values: | These tables have been extacted from the Beta UI code to give details on the above return values: | ||
Revision as of 08:22, 13 August 2009
← WoW API < CalendarGetDayEvent
Retrieve information about the specified event.
title, hour, minute, calendarType, sequenceType, eventType, texture, modStatus, inviteStatus, invitedBy, difficulty, inviteType, sequenceIndex, numSequenceDayss = CalendarGetDayEvent(monthOffset, day, eventIndex)
Arguments
- (monthOffset, day, eventIndex)
- monthOffset
- Number - The number of months to offset from today
- day
- Number - The desired day of the month the event exists on
- eventIndex
- Number - The index of the desired event, From 1 through CalendarGetNumDayEvents(monthOffset, day)
Returns
- title, hour, minute, calendarType, sequenceType, eventType, texture, modStatus, inviteStatus
- title
- String - The title of the event
- hour
- Number - The hour the event begins (0-23)
- minute
- Number - The minute the event begins (0-59)
- calendarType
- String - One of "PLAYER", "GUILD", "ARENA", "HOLIDAY"
- sequenceType
- String - One of "ONGOING", "START", "END", ""
- eventType
- Number - See table below
- texture
- String - The name of the event's texture (does not include the path)
- modStatus
- String - One of "MODERATOR", "CREATOR", ""
- inviteStatus
- Number - See table below
- invitedBy
- difficulty
- inviteType
- sequenceIndex
- numSequenceDays
Details
API update. New: invitedBy, difficulty, inviteType, sequenceIndex, numSequenceDays was added in Patch 3.2(August,2009
These tables have been extacted from the Beta UI code to give details on the above return values:
eventType
CALENDAR_EVENTTYPE_RAID = 1 CALENDAR_EVENTTYPE_DUNGEON = 2 CALENDAR_EVENTTYPE_PVP = 3 CALENDAR_EVENTTYPE_MEETING = 4 CALENDAR_EVENTTYPE_OTHER = 5
inviteStatus
CALENDAR_INVITESTATUS_INVITED = 1 CALENDAR_INVITESTATUS_ACCEPTED = 2 CALENDAR_INVITESTATUS_DECLINED = 3 CALENDAR_INVITESTATUS_CONFIRMED = 4 CALENDAR_INVITESTATUS_OUT = 5 CALENDAR_INVITESTATUS_STANDBY = 6