Skip to main content

HighlightServiceClient

This item only works when running on the client. Client

Centralized group

Functions​

Init​

</>
HighlightServiceClient:Init(serviceBag: ServiceBag) → ()

Initializes the service. Should be done via the ServiceBag.

GetAnimatedHighlightGroup​

</>
HighlightServiceClient:GetAnimatedHighlightGroup() → AnimatedHighlightGroup

Retrieves a global AnimatedHighlightGroup to share and coordinate highlights with.

Highlight​

</>
HighlightServiceClient:Highlight(
adornee: Instance,
observeScore: Observable<number> | number | nil
) → AnimatedHighlightModel

Highlights an instance at the given priority

Destroy​

</>
HighlightServiceClient:Destroy() → ()

Cleans up the service.

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the service. Should be done via the [ServiceBag].",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 20,
                "path": "src/highlight/src/Client/HighlightServiceClient.lua"
            }
        },
        {
            "name": "GetAnimatedHighlightGroup",
            "desc": "Retrieves a global [AnimatedHighlightGroup] to share and coordinate\nhighlights with.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimatedHighlightGroup"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 34,
                "path": "src/highlight/src/Client/HighlightServiceClient.lua"
            }
        },
        {
            "name": "Highlight",
            "desc": "Highlights an instance at the given priority",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "observeScore",
                    "desc": "",
                    "lua_type": "Observable<number> | number | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimatedHighlightModel"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 45,
                "path": "src/highlight/src/Client/HighlightServiceClient.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Cleans up the service.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 54,
                "path": "src/highlight/src/Client/HighlightServiceClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HighlightServiceClient",
    "desc": "Centralized group",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 6,
        "path": "src/highlight/src/Client/HighlightServiceClient.lua"
    }
}