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

200 lines
4.5 KiB
Lua

local SimpleScriptRegionResizingAPI =
{
Name = "SimpleScriptRegionResizingAPI",
Type = "ScriptObject",
Environment = "All",
Functions =
{
{
Name = "AdjustPointsOffset",
Type = "Function",
IsProtectedFunction = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "x", Type = "uiUnit", Nilable = false },
{ Name = "y", Type = "uiUnit", Nilable = false },
},
},
{
Name = "ClearAllPoints",
Type = "Function",
IsProtectedFunction = true,
Documentation = { "Clears all points and immediately invalidates the rect. (Prior to 11.2.0, this would only invalidate rect immediately for AnchoringRestricted regions.)" },
Arguments =
{
},
},
{
Name = "ClearPoint",
Type = "Function",
IsProtectedFunction = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "point", Type = "FramePoint", Nilable = false },
},
},
{
Name = "ClearPointsOffset",
Type = "Function",
IsProtectedFunction = true,
Arguments =
{
},
},
{
Name = "GetNumPoints",
Type = "Function",
Arguments =
{
},
Returns =
{
{ Name = "numPoints", Type = "number", Nilable = false },
},
},
{
Name = "GetPoint",
Type = "Function",
MayReturnNothing = true,
SecretWhenAnchoringSecret = true,
ConstSecretAccessor = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "anchorIndex", Type = "luaIndex", Nilable = false, Default = 0 },
{ Name = "resolveCollapsed", Type = "bool", Nilable = false, Default = false },
},
Returns =
{
{ Name = "point", Type = "FramePoint", Nilable = false },
{ Name = "relativeTo", Type = "ScriptRegion", Nilable = false },
{ Name = "relativePoint", Type = "FramePoint", Nilable = false },
{ Name = "offsetX", Type = "uiUnit", Nilable = false },
{ Name = "offsetY", Type = "uiUnit", Nilable = false },
},
},
{
Name = "GetPointByName",
Type = "Function",
MayReturnNothing = true,
SecretWhenAnchoringSecret = true,
ConstSecretAccessor = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "point", Type = "FramePoint", Nilable = false },
{ Name = "resolveCollapsed", Type = "bool", Nilable = false, Default = false },
},
Returns =
{
{ Name = "point", Type = "FramePoint", Nilable = false },
{ Name = "relativeTo", Type = "ScriptRegion", Nilable = false },
{ Name = "relativePoint", Type = "FramePoint", Nilable = false },
{ Name = "offsetX", Type = "uiUnit", Nilable = false },
{ Name = "offsetY", Type = "uiUnit", Nilable = false },
},
},
{
Name = "SetAllPoints",
Type = "Function",
IsProtectedFunction = true,
CheckAllowInheritForbiddenLayoutAspects = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "relativeTo", Type = "ScriptRegion", Nilable = false },
{ Name = "doResize", Type = "bool", Nilable = false, Default = true },
},
},
{
Name = "SetHeight",
Type = "Function",
IsProtectedFunction = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "height", Type = "uiUnit", Nilable = false },
},
},
{
Name = "SetPoint",
Type = "Function",
IsProtectedFunction = true,
CheckAllowInheritForbiddenLayoutAspects = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "point", Type = "FramePoint", Nilable = false },
{ Name = "relativeTo", Type = "ScriptRegion", Nilable = false },
{ Name = "relativePoint", Type = "FramePoint", Nilable = false },
{ Name = "offsetX", Type = "uiUnit", Nilable = false },
{ Name = "offsetY", Type = "uiUnit", Nilable = false },
},
},
{
Name = "SetPointsOffset",
Type = "Function",
IsProtectedFunction = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "x", Type = "uiUnit", Nilable = false },
{ Name = "y", Type = "uiUnit", Nilable = false },
},
},
{
Name = "SetSize",
Type = "Function",
IsProtectedFunction = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "x", Type = "uiUnit", Nilable = false },
{ Name = "y", Type = "uiUnit", Nilable = false },
},
},
{
Name = "SetWidth",
Type = "Function",
IsProtectedFunction = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "width", Type = "uiUnit", Nilable = false },
},
},
},
Events =
{
},
Tables =
{
},
Predicates =
{
},
};
APIDocumentation:AddDocumentationTable(SimpleScriptRegionResizingAPI);