Skip to main content

AnimatedHighlightGroup

This item only works when running on the client. Client

Functions​

SetDefaultHighlightDepthMode​

</>
AnimatedHighlightGroup:SetDefaultHighlightDepthMode(depthMode: Enum.HighlightDepthMode) → ()

Sets the depth mode. Either can be:

  • Enum.HighlightDepthMode.AlwaysOnTop
  • Enum.HighlightDepthMode.Occluded

Highlight​

</>
AnimatedHighlightGroup:Highlight(
adornee: Instance,
observeScore: number
) → AnimatedHighlightModel

Returns an AnimatedHighlightModel which can be used to adjust the values

Show raw api
{
    "functions": [
        {
            "name": "SetDefaultHighlightDepthMode",
            "desc": "Sets the depth mode. Either can be:\n\n* Enum.HighlightDepthMode.AlwaysOnTop\n* Enum.HighlightDepthMode.Occluded",
            "params": [
                {
                    "name": "depthMode",
                    "desc": "",
                    "lua_type": "Enum.HighlightDepthMode"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 45,
                "path": "src/highlight/src/Client/AnimatedHighlightGroup.lua"
            }
        },
        {
            "name": "Highlight",
            "desc": "Returns an AnimatedHighlightModel which can be used to adjust the values",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "observeScore",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimatedHighlightModel"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 102,
                "path": "src/highlight/src/Client/AnimatedHighlightGroup.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AnimatedHighlightGroup",
    "desc": "",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 5,
        "path": "src/highlight/src/Client/AnimatedHighlightGroup.lua"
    }
}