773 lines
15 KiB
Lua
773 lines
15 KiB
Lua
local SimpleScriptRegionAPI =
|
|
{
|
|
Name = "SimpleScriptRegionAPI",
|
|
Type = "ScriptObject",
|
|
Environment = "All",
|
|
|
|
Functions =
|
|
{
|
|
{
|
|
Name = "CanChangeProtectedState",
|
|
Type = "Function",
|
|
SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecurity },
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "canChange", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "CanPropagateMouseClicks",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "canPropagate", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "CanPropagateMouseMotion",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "canPropagate", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "ClearScripts",
|
|
Type = "Function",
|
|
ChecksForbiddenAspects = { { Argument = "self", Aspect = Enum.ForbiddenAspect.ScriptBindings } },
|
|
Documentation = { "Remove all script handlers set through Scripts in XML or SetScript in Lua" },
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
},
|
|
{
|
|
Name = "CollapsesLayout",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "collapsesLayout", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "EnableMouse",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
SecretArguments = "NotAllowed",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "enable", Type = "bool", Nilable = false, Default = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "EnableMouseMotion",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
SecretArguments = "NotAllowed",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "enable", Type = "bool", Nilable = false, Default = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "EnableMouseWheel",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
SecretArguments = "NotAllowed",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "enable", Type = "bool", Nilable = false, Default = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "FocusEnter",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
SecretArguments = "NotAllowed",
|
|
ChecksForbiddenAspects = { { Argument = "self", Aspect = Enum.ForbiddenAspect.ScriptedInput } },
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "fromMouseMotion", Type = "bool", Nilable = false, Default = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "FocusExit",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
SecretArguments = "NotAllowed",
|
|
ChecksForbiddenAspects = { { Argument = "self", Aspect = Enum.ForbiddenAspect.ScriptedInput } },
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "fromMouseMotion", Type = "bool", Nilable = false, Default = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetBottom",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretWhenAnchoringSecret = true,
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "bottom", Type = "uiUnit", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetCenter",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretWhenAnchoringSecret = true,
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "x", Type = "uiUnit", Nilable = false },
|
|
{ Name = "y", Type = "uiUnit", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetHeight",
|
|
Type = "Function",
|
|
SecretWhenAnchoringSecret = true,
|
|
ConstSecretAccessor = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "ignoreRect", Type = "bool", Nilable = false, Default = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "height", Type = "uiUnit", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetLeft",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretWhenAnchoringSecret = true,
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "left", Type = "uiUnit", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetRect",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretWhenAnchoringSecret = true,
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "left", Type = "uiUnit", Nilable = false },
|
|
{ Name = "bottom", Type = "uiUnit", Nilable = false },
|
|
{ Name = "width", Type = "uiUnit", Nilable = false },
|
|
{ Name = "height", Type = "uiUnit", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetRight",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretWhenAnchoringSecret = true,
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "right", Type = "uiUnit", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetRoundLayoutToNearestPixel",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "enabled", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetScaledRect",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretWhenAnchoringSecret = true,
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "left", Type = "uiUnit", Nilable = false },
|
|
{ Name = "bottom", Type = "uiUnit", Nilable = false },
|
|
{ Name = "width", Type = "uiUnit", Nilable = false },
|
|
{ Name = "height", Type = "uiUnit", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetScript",
|
|
Type = "Function",
|
|
RequiresSupportedScript = true,
|
|
ConstSecretAccessor = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
ChecksForbiddenAspects = { { Argument = "self", Aspect = Enum.ForbiddenAspect.ScriptBindings } },
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "scriptTypeName", Type = "ScriptTypeName", Nilable = false },
|
|
{ Name = "bindingType", Type = "ScriptBindingType", Nilable = false, Default = "Extrinsic" },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "script", Type = "LuaFunctionReference", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetSize",
|
|
Type = "Function",
|
|
SecretWhenAnchoringSecret = true,
|
|
ConstSecretAccessor = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "ignoreRect", Type = "bool", Nilable = false, Default = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "width", Type = "uiUnit", Nilable = false },
|
|
{ Name = "height", Type = "uiUnit", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetSourceLocation",
|
|
Type = "Function",
|
|
SecretReturnsForAspect = { Enum.SecretAspect.ObjectDebug },
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "location", Type = "string", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetTop",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretWhenAnchoringSecret = true,
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "top", Type = "uiUnit", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetWidth",
|
|
Type = "Function",
|
|
SecretWhenAnchoringSecret = true,
|
|
ConstSecretAccessor = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "ignoreRect", Type = "bool", Nilable = false, Default = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "width", Type = "uiUnit", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "HasScript",
|
|
Type = "Function",
|
|
SecretReturnsForAspect = { Enum.SecretAspect.ObjectType },
|
|
ConstSecretAccessor = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "scriptName", Type = "cstring", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "hasScript", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "Hide",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
},
|
|
{
|
|
Name = "HookScript",
|
|
Type = "Function",
|
|
RequiresAssignableScript = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
ChecksForbiddenAspects = { { Argument = "self", Aspect = Enum.ForbiddenAspect.ScriptBindings } },
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "scriptTypeName", Type = "ScriptTypeName", Nilable = false },
|
|
{ Name = "script", Type = "LuaFunctionReference", Nilable = false },
|
|
{ Name = "bindingType", Type = "ScriptBindingType", Nilable = false, Default = "Extrinsic" },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "success", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "Intersects",
|
|
Type = "Function",
|
|
SecretWhenAnchoringSecret = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "region", Type = "ScriptRegion", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "intersects", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsAnchoringRestricted",
|
|
Type = "Function",
|
|
SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecurity },
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isRestricted", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsAnchoringSecret",
|
|
Type = "Function",
|
|
SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecrets },
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isSecret", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsCollapsed",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isCollapsed", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsDragging",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isDragging", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsMouseClickEnabled",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "enabled", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsMouseEnabled",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "enabled", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsMouseMotionEnabled",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "enabled", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsMouseMotionFocus",
|
|
Type = "Function",
|
|
ChecksForbiddenAspects = { { Argument = "self", Aspect = Enum.ForbiddenAspect.QueryFocus } },
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isMouseMotionFocus", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsMouseOver",
|
|
Type = "Function",
|
|
SecretWhenAnchoringSecret = true,
|
|
ConstSecretAccessor = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "offsetTop", Type = "uiUnit", Nilable = false, Default = 0 },
|
|
{ Name = "offsetBottom", Type = "uiUnit", Nilable = false, Default = 0 },
|
|
{ Name = "offsetLeft", Type = "uiUnit", Nilable = false, Default = 0 },
|
|
{ Name = "offsetRight", Type = "uiUnit", Nilable = false, Default = 0 },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isMouseOver", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsMouseWheelEnabled",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "enabled", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsProtected",
|
|
Type = "Function",
|
|
SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecurity },
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isProtected", Type = "bool", Nilable = false },
|
|
{ Name = "isProtectedExplicitly", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsRectValid",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isValid", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsShown",
|
|
Type = "Function",
|
|
SecretReturnsForAspect = { Enum.SecretAspect.Shown },
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isShown", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsVisible",
|
|
Type = "Function",
|
|
SecretReturnsForAspect = { Enum.SecretAspect.Shown },
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isVisible", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "MouseDown",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
SecretArguments = "NotAllowed",
|
|
ChecksForbiddenAspects = { { Argument = "self", Aspect = Enum.ForbiddenAspect.ScriptedInput } },
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "button", Type = "cstring", Nilable = false, Default = "LeftButton" },
|
|
},
|
|
},
|
|
{
|
|
Name = "MouseUp",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
SecretArguments = "NotAllowed",
|
|
ChecksForbiddenAspects = { { Argument = "self", Aspect = Enum.ForbiddenAspect.ScriptedInput } },
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "button", Type = "cstring", Nilable = false, Default = "LeftButton" },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetCollapsesLayout",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
SecretArguments = "NotAllowed",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "collapsesLayout", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetMouseClickEnabled",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
SecretArguments = "NotAllowed",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "enabled", Type = "bool", Nilable = false, Default = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetMouseMotionEnabled",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
SecretArguments = "NotAllowed",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "enabled", Type = "bool", Nilable = false, Default = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetParent",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
CheckAllowChangeParent = true,
|
|
SecretArguments = "NotAllowed",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "parent", Type = "SimpleFrame", Nilable = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetPassThroughButtons",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
HasRestrictions = true,
|
|
SecretArguments = "NotAllowed",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "buttons", Type = "MouseButton", Nilable = false, StrideIndex = 1 },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetPropagateMouseClicks",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
HasRestrictions = true,
|
|
SecretArguments = "NotAllowed",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "propagate", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetPropagateMouseMotion",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
HasRestrictions = true,
|
|
SecretArguments = "NotAllowed",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "propagate", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetRoundLayoutToNearestPixel",
|
|
Type = "Function",
|
|
IsProtectedFunction = true,
|
|
SecretArguments = "NotAllowed",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "enabled", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetScript",
|
|
Type = "Function",
|
|
RequiresAssignableScript = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
ChecksForbiddenAspects = { { Argument = "self", Aspect = Enum.ForbiddenAspect.ScriptBindings } },
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "scriptTypeName", Type = "ScriptTypeName", Nilable = false },
|
|
{ Name = "script", Type = "LuaFunctionReference", Nilable = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetShown",
|
|
Type = "Function",
|
|
SecretArgumentsAddAspect = { Enum.SecretAspect.Shown },
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "show", Type = "bool", Nilable = false, Default = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "ShouldButtonPassThrough",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "button", Type = "MouseButton", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "shouldPassThrough", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "Show",
|
|
Type = "Function",
|
|
|
|
Arguments =
|
|
{
|
|
},
|
|
},
|
|
},
|
|
|
|
Events =
|
|
{
|
|
},
|
|
|
|
Tables =
|
|
{
|
|
},
|
|
|
|
Predicates =
|
|
{
|
|
},
|
|
};
|
|
|
|
APIDocumentation:AddDocumentationTable(SimpleScriptRegionAPI); |