WoW API: CalendarGetEventInfo

Revision as of 19:44, 27 February 2009 by WoWWiki>Mundocani (Correct numerous parameter list errors)

WoW API < CalendarGetEventInfo

API CalendarGetEventInfo retrieves the details of an event.

title, description, creator, eventType, repeatOption, maxSize, textureIndex, weekday, month, day, year, hour, minute, lockoutWeekday, lockoutMonth, lockoutDay, lockoutYear, lockoutHour, lockoutMinute, locked, autoApprove = CalendarGetEventInfo( );

Returns

title, description, creator, eventType, repeatOption, maxSize, textureIndex, weekday, month, day, year, hour, minute, lockoutWeekday, lockoutMonth, lockoutDay, lockoutYear, lockoutHour, lockoutMinute, locked, autoApprove
title
String - The title of the event
description
String - The event description
creator
String - The name of the character who created the event
eventType
Number - The type of event (1-5) as specified by CalendarSetType()
repeatOption
Number - The repeat setting (appears unimplemented as of patch 3.0.8)
maxSize
Number - Unknown
textureIndex
Number - The index of the event's texture in the list returned by CalendarEventGetTextures
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
lockoutWeekday
Number - Unknown (contains 1)
lockoutMonth
Number - Unknown (contains 1)
lockoutDay
Number - Unknown (contains 1)
lockoutYear
Number - Unknown (contains 2000)
lockoutHour
Number - Unknown (contains 0)
lockoutMinute
Number - Unknown (contains 0)
lockedFlag
Number - Set to 1 if the event is locked, nil otherwise
autoApprove
Unknown