Skip to main content

AnimatedHighlight

This item only works when running on the client. Client

Functions​

isAnimatedHighlight​

</>
AnimatedHighlight.isAnimatedHighlight(value: any) → boolean

Returns true if it's an animated highlight

SetHighlightDepthMode​

</>
AnimatedHighlight.SetHighlightDepthMode(
depthMode: Enum.HighlightDepthMode
) → ()

Sets the depth mode. Either can be:

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

SetFillColor​

</>
AnimatedHighlight.SetFillColor(
color: Color3,
doNotAnimate: boolean?
) → ()

Sets the fill color

SetOutlineColor​

</>
AnimatedHighlight.SetOutlineColor(
color: Color3,
doNotAnimate: boolean?
) → ()

Sets the outline color

SetAdornee​

</>
AnimatedHighlight.SetAdornee(
adornee: Instance?
) → ()

Sets the adornee

GetAdornee​

</>
AnimatedHighlight.GetAdornee(self: AnimatedHighlight) → Instance?

Gets the adornee

SetOutlineTransparency​

</>
AnimatedHighlight.SetOutlineTransparency(
outlineTransparency: number,
doNotAnimate: boolean?
) → ()

Sets the outlineTransparency

SetFillTransparency​

</>
AnimatedHighlight.SetFillTransparency(
fillTransparency: number,
doNotAnimate: boolean?
) → ()

Sets the fillTransparency

Show raw api
{
    "functions": [
        {
            "name": "isAnimatedHighlight",
            "desc": "Returns true if it's an animated highlight",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 80,
                "path": "src/highlight/src/Client/AnimatedHighlight.lua"
            }
        },
        {
            "name": "SetHighlightDepthMode",
            "desc": "Sets the depth mode. Either can be:\n\n* Enum.HighlightDepthMode.AlwaysOnTop\n* Enum.HighlightDepthMode.Occluded",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AnimatedHighlight"
                },
                {
                    "name": "depthMode",
                    "desc": "",
                    "lua_type": "Enum.HighlightDepthMode"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 92,
                "path": "src/highlight/src/Client/AnimatedHighlight.lua"
            }
        },
        {
            "name": "SetFillColor",
            "desc": "Sets the fill color",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AnimatedHighlight"
                },
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 181,
                "path": "src/highlight/src/Client/AnimatedHighlight.lua"
            }
        },
        {
            "name": "SetOutlineColor",
            "desc": "Sets the outline color",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AnimatedHighlight"
                },
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 193,
                "path": "src/highlight/src/Client/AnimatedHighlight.lua"
            }
        },
        {
            "name": "SetAdornee",
            "desc": "Sets the adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AnimatedHighlight"
                },
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 202,
                "path": "src/highlight/src/Client/AnimatedHighlight.lua"
            }
        },
        {
            "name": "GetAdornee",
            "desc": "Gets the adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AnimatedHighlight"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 212,
                "path": "src/highlight/src/Client/AnimatedHighlight.lua"
            }
        },
        {
            "name": "SetOutlineTransparency",
            "desc": "Sets the outlineTransparency",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AnimatedHighlight"
                },
                {
                    "name": "outlineTransparency",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 222,
                "path": "src/highlight/src/Client/AnimatedHighlight.lua"
            }
        },
        {
            "name": "SetFillTransparency",
            "desc": "Sets the fillTransparency",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AnimatedHighlight"
                },
                {
                    "name": "fillTransparency",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 242,
                "path": "src/highlight/src/Client/AnimatedHighlight.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AnimatedHighlight",
    "desc": "",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 6,
        "path": "src/highlight/src/Client/AnimatedHighlight.lua"
    }
}