Files
SessionGoldTracker/docs/blizzard-api/Blizzard_APIDocumentationGenerated/DateAndTimeDocumentation.lua
T
2026-10-15 14:27:00 +11:00

182 lines
3.6 KiB
Lua

local DateAndTime =
{
Name = "DateAndTime",
Type = "System",
Namespace = "C_DateAndTime",
Environment = "All",
Functions =
{
{
Name = "AdjustTimeByDays",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "date", Type = "CalendarTime", Nilable = false },
{ Name = "days", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "newDate", Type = "CalendarTime", Nilable = false },
},
},
{
Name = "AdjustTimeByMinutes",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "date", Type = "CalendarTime", Nilable = false },
{ Name = "minutes", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "newDate", Type = "CalendarTime", Nilable = false },
},
},
{
Name = "AdjustTimeByMonths",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "date", Type = "CalendarTime", Nilable = false },
{ Name = "months", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "newDate", Type = "CalendarTime", Nilable = false },
},
},
{
Name = "CompareCalendarTime",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "lhsCalendarTime", Type = "CalendarTime", Nilable = false },
{ Name = "rhsCalendarTime", Type = "CalendarTime", Nilable = false },
},
Returns =
{
{ Name = "comparison", Type = "number", Nilable = false, Documentation = { "-1 if rhsCalendarTime < lhsCalendarTime, 0 if rhsCalendarTime == lhsCalendarTime, 1 if rhsCalendarTime > lhsCalendarTime" } },
},
},
{
Name = "GetCalendarTimeFromEpoch",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "epoch", Type = "BigUInteger", Nilable = false },
},
Returns =
{
{ Name = "date", Type = "CalendarTime", Nilable = false },
},
},
{
Name = "GetCurrentCalendarTime",
Type = "Function",
Returns =
{
{ Name = "date", Type = "CalendarTime", Nilable = false },
},
},
{
Name = "GetSecondsUntilDailyReset",
Type = "Function",
Returns =
{
{ Name = "seconds", Type = "time_t", Nilable = false },
},
},
{
Name = "GetSecondsUntilWeeklyReset",
Type = "Function",
Returns =
{
{ Name = "seconds", Type = "time_t", Nilable = false },
},
},
{
Name = "GetServerTimeLocal",
Type = "Function",
Returns =
{
{ Name = "serverTimeLocal", Type = "time_t", Nilable = false },
},
},
{
Name = "GetWeeklyResetStartTime",
Type = "Function",
Returns =
{
{ Name = "seconds", Type = "time_t", Nilable = false },
},
},
{
Name = "IsDayTime",
Type = "Function",
Returns =
{
{ Name = "isDayTime", Type = "bool", Nilable = false },
},
},
},
Events =
{
{
Name = "DielCycleChanged",
Type = "Event",
LiteralName = "DIEL_CYCLE_CHANGED",
SynchronousEvent = true,
Documentation = { "Signaled when the game time transitions between day and night." },
Payload =
{
{ Name = "isDayTime", Type = "bool", Nilable = false },
},
},
},
Tables =
{
{
Name = "TimeEventFlag",
Type = "Enumeration",
NumValues = 3,
MinValue = 1,
MaxValue = 4,
Fields =
{
{ Name = "GlueScreenShortcut", Type = "TimeEventFlag", EnumValue = 1 },
{ Name = "WeeklyReset", Type = "TimeEventFlag", EnumValue = 2 },
{ Name = "GlobalLaunch", Type = "TimeEventFlag", EnumValue = 4 },
},
},
},
Predicates =
{
},
};
APIDocumentation:AddDocumentationTable(DateAndTime);