Skip to main content

HandleHighlightModel

Functions​

SetHandle​

</>
HandleHighlightModel:SetHandle(handle: Instance) → ()

Sets the handle for the highlight model.

ObservePercentPressed​

</>
HandleHighlightModel:ObservePercentPressed() → Observable<number>

Observes how pressed down the button is

ObservePercentHighlighted​

</>
HandleHighlightModel:ObservePercentHighlighted() → Observable<number>

Observes how highlighted the button is

ObservePercentHighlightedTarget​

</>
HandleHighlightModel:ObservePercentHighlightedTarget() → Observable<number>

Observes target for how highlighted the button is

Show raw api
{
    "functions": [
        {
            "name": "SetHandle",
            "desc": "Sets the handle for the highlight model.",
            "params": [
                {
                    "name": "handle",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 48,
                "path": "src/buttonhighlightmodel/src/Client/HandleHighlightModel.lua"
            }
        },
        {
            "name": "ObservePercentPressed",
            "desc": "Observes how pressed down the button is",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 82,
                "path": "src/buttonhighlightmodel/src/Client/HandleHighlightModel.lua"
            }
        },
        {
            "name": "ObservePercentHighlighted",
            "desc": "Observes how highlighted the button is",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 95,
                "path": "src/buttonhighlightmodel/src/Client/HandleHighlightModel.lua"
            }
        },
        {
            "name": "ObservePercentHighlightedTarget",
            "desc": "Observes target for how highlighted the button is",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 103,
                "path": "src/buttonhighlightmodel/src/Client/HandleHighlightModel.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HandleHighlightModel",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/buttonhighlightmodel/src/Client/HandleHighlightModel.lua"
    }
}