Skip to main content

AnimatedHighlightModel

Functions​

new​

</>
AnimatedHighlightModel.new() → AnimatedHighlightModel

Constructs a new data model for an animated highlight. Probably retrieve via an AnimatedHighlightStack or more likely an AnimatedHighlightGroup or even the HighlightServiceClient.Highlight.

isAnimatedHighlightModel​

</>
AnimatedHighlightModel.isAnimatedHighlightModel(value: any) → boolean

Returns true if it's an animated highlight model

SetHighlightDepthMode​

</>
AnimatedHighlightModel:SetHighlightDepthMode(depthMode: HighlightDepthMode) → ()

SetTransparencySpeed​

</>
AnimatedHighlightModel:SetTransparencySpeed(speed: number | nil) → ()

Sets the transparency speed

SetColorSpeed​

</>
AnimatedHighlightModel:SetColorSpeed(speed: number | nil) → ()

Sets the color speed

SetSpeed​

</>
AnimatedHighlightModel:SetSpeed(speed: number | nil) → ()

Sets the visiblity speed speed

SetFillColor​

</>
AnimatedHighlightModel:SetFillColor(
color: Color3 | nil,
doNotAnimate: boolean | nil
) → ()

Sets fill color

GetFillColor​

</>
AnimatedHighlightModel:GetFillColor() → Color3 | nil

Gets the fill color

SetOutlineColor​

</>
AnimatedHighlightModel:SetOutlineColor(
color: Color3 | nil,
doNotAnimate: boolean | nil
) → ()

Sets the outline color

GetOutlineColor​

</>
AnimatedHighlightModel:GetOutlineColor() → Color3 | nil

Gets the outline color

SetOutlineTransparency​

</>
AnimatedHighlightModel:SetOutlineTransparency(
outlineTransparency: number,
doNotAnimate: boolean | nil
) → ()

Sets the outline transparency

SetFillTransparency​

</>
AnimatedHighlightModel:SetFillTransparency(
fillTransparency: number,
doNotAnimate: boolean | nil
) → ()

Sets the fill transparency

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new data model for an animated highlight. Probably retrieve via an\n[AnimatedHighlightStack] or more likely an [AnimatedHighlightGroup] or even the\n[HighlightServiceClient.Highlight].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimatedHighlightModel"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        },
        {
            "name": "isAnimatedHighlightModel",
            "desc": "Returns true if it's an animated highlight model",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 52,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        },
        {
            "name": "SetHighlightDepthMode",
            "desc": "",
            "params": [
                {
                    "name": "depthMode",
                    "desc": "",
                    "lua_type": "HighlightDepthMode"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 59,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        },
        {
            "name": "SetTransparencySpeed",
            "desc": "Sets the transparency speed",
            "params": [
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 70,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        },
        {
            "name": "SetColorSpeed",
            "desc": "Sets the color speed",
            "params": [
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 81,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        },
        {
            "name": "SetSpeed",
            "desc": "Sets the visiblity speed speed",
            "params": [
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 93,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        },
        {
            "name": "SetFillColor",
            "desc": "Sets fill color",
            "params": [
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3 | nil"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 105,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        },
        {
            "name": "GetFillColor",
            "desc": "Gets the fill color",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Color3 | nil"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 116,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        },
        {
            "name": "SetOutlineColor",
            "desc": "Sets the outline color",
            "params": [
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3 | nil"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 126,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        },
        {
            "name": "GetOutlineColor",
            "desc": "Gets the outline color",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Color3 | nil"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 137,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        },
        {
            "name": "SetOutlineTransparency",
            "desc": "Sets the outline transparency",
            "params": [
                {
                    "name": "outlineTransparency",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 147,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        },
        {
            "name": "SetFillTransparency",
            "desc": "Sets the fill transparency",
            "params": [
                {
                    "name": "fillTransparency",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 159,
                "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AnimatedHighlightModel",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/highlight/src/Client/Stack/AnimatedHighlightModel.lua"
    }
}