WoW:API CalendarGetEventInfo: Difference between revisions
Jump to navigation
Jump to search
m (WW:MOS) |
mNo edit summary |
||
| Line 4: | Line 4: | ||
'''API CalendarGetEventInfo''' retrieves the details of an event. | '''API CalendarGetEventInfo''' retrieves the details of an event. | ||
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | <!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | ||
title, description, creator, type, instanceID, ownerFlag, field6, weekday, month, day, year, hour, minute, field14, field15, field16, field17, field18, field19, lockedFlag, field21, | title, description, creator, type, instanceID, ownerFlag, field6, weekday, month, day, year, hour, minute, field14, field15, field16, field17, field18, field19, lockedFlag, field21, unreadFlag, myStatus = CalendarGetEventInfo( ); | ||
== Returns == | == Returns == | ||
<!-- List each return value, together with its type --> | <!-- List each return value, together with its type --> | ||
:title, description, creator, type, instanceID, ownerFlag, field6, weekday, month, day, year, hour, minute, field14, field15, field16, field17, field18, field19, lockedFlag, field21, | :title, description, creator, type, instanceID, ownerFlag, field6, weekday, month, day, year, hour, minute, field14, field15, field16, field17, field18, field19, lockedFlag, field21, unreadFlag, myStatus | ||
:;title : String - The title of the event | :;title : String - The title of the event | ||
| Line 31: | Line 31: | ||
:;lockedFlag : Number - Set to 1 if the event is locked, nil otherwise | :;lockedFlag : Number - Set to 1 if the event is locked, nil otherwise | ||
:;field21 : Number - Unknown (nil) | :;field21 : Number - Unknown (nil) | ||
:; | :;unreadFlag : Number - Set to 1 if you've been invited to an event but have not yet responded, nil otherwise | ||
:;myStatus : Number - Status of the current character relative to the event (0=open event, 1=invited, 2=accepted, 3=declined, 4=confirmed, 5=out, 6=on standby) | :;myStatus : Number - Status of the current character relative to the event (0=open event, 1=invited, 2=accepted, 3=declined, 4=confirmed, 5=out, 6=on standby) | ||
Revision as of 21:02, 1 November 2008
← WoW API < CalendarGetEventInfo
API CalendarGetEventInfo retrieves the details of an event.
title, description, creator, type, instanceID, ownerFlag, field6, weekday, month, day, year, hour, minute, field14, field15, field16, field17, field18, field19, lockedFlag, field21, unreadFlag, myStatus = CalendarGetEventInfo( );
Returns
- title, description, creator, type, instanceID, ownerFlag, field6, weekday, month, day, year, hour, minute, field14, field15, field16, field17, field18, field19, lockedFlag, field21, unreadFlag, myStatus
- title
- String - The title of the event
- description
- String - The event description
- creator
- String - The name of the character who created the event
- type
- Number - The type of event (1-5) as specified by CalendarSetType()
- instanceID
- Number - An ID indicating which instance is related to the event (Raid and Dungeon events only)
- ownerFlag
- Number - Contains 256 if you created the event, 1 if you did not
- field6
- Number - Unknown (contains 100)
- weekday
- Number - Day of the week on which the event falls (1=Sunday, 2=Monday, etc)
- month
- Number - Month of the year in which the event occurs (1=January, 2=February, etc)
- day
- Number - Day of the month on which the event takes place
- year
- Number - Year of the event
- hour
- Number - Hour of the event in 24-hour format (ie 18=6pm)
- minute
- Number - Minute of the hour at which the event occurs
- field14
- Number - Unknown (contains 1)
- field15
- Number - Unknown (contains 1)
- field16
- Number - Unknown (contains 1)
- field17
- Number - Unknown (contains 2000)
- field18
- Number - Unknown (contains 0)
- field19
- Number - Unknown (contains 0)
- lockedFlag
- Number - Set to 1 if the event is locked, nil otherwise
- field21
- Number - Unknown (nil)
- unreadFlag
- Number - Set to 1 if you've been invited to an event but have not yet responded, nil otherwise
- myStatus
- Number - Status of the current character relative to the event (0=open event, 1=invited, 2=accepted, 3=declined, 4=confirmed, 5=out, 6=on standby)