Skip to main content

AnimatedHighlightStack

Functions​

isAnimatedHighlightStack​

</>
AnimatedHighlightStack.isAnimatedHighlightStack(value: any) → boolean

Returns true if the value is an animated highlight stack

SetPropertiesFrom​

</>
AnimatedHighlightStack:SetPropertiesFrom(source: AnimatedHighlightStack) → ()

Sets the stacks initial properties to mirror the given stacks

ObserveHasEntries​

</>
AnimatedHighlightStack:ObserveHasEntries() → Observable<boolean>

GetHandle​

</>
AnimatedHighlightStack:GetHandle(observeScore: Observable<number>) → AnimatedHighlightModel

Gets a new handle for the stack

Show raw api
{
    "functions": [
        {
            "name": "isAnimatedHighlightStack",
            "desc": "Returns true if the value is an animated highlight stack",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 82,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightStack.lua"
            }
        },
        {
            "name": "SetPropertiesFrom",
            "desc": "Sets the stacks initial properties to mirror the given stacks",
            "params": [
                {
                    "name": "source",
                    "desc": "",
                    "lua_type": "AnimatedHighlightStack"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 91,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightStack.lua"
            }
        },
        {
            "name": "ObserveHasEntries",
            "desc": "",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 100,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightStack.lua"
            }
        },
        {
            "name": "GetHandle",
            "desc": "Gets a new handle for the stack",
            "params": [
                {
                    "name": "observeScore",
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimatedHighlightModel"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 206,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightStack.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AnimatedHighlightStack",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/highlight/src/Client/Stack/AnimatedHighlightStack.lua"
    }
}