Skip to main content

ModelAppearance

Allows the appearance of a model to be overridden. Most commonly used when placing down an object in a building game.

Functions​

DisableInteractions​

</>
ModelAppearance.DisableInteractions(self: ModelAppearance) → ()

Disables all interactions with the model. This includes click detectors and seats

TIP

Destructive, cannot be reverted

SetCanCollide​

</>
ModelAppearance.SetCanCollide(
canCollide: boolean
) → ()

Sets the models collision state

ResetCanCollide​

</>
ModelAppearance.ResetCanCollide(self: ModelAppearance) → ()

Resets the can collide state to the original state

SetTransparency​

</>
ModelAppearance.SetTransparency(
transparency: number
) → ()

Sets the transparency of the model

ResetTransparency​

</>
ModelAppearance.ResetTransparency(self: ModelAppearance) → ()

Resets the transparency to the original state

SetColor​

</>
ModelAppearance.SetColor(
color: Color3
) → ()

Sets the color of the model

ResetColor​

</>
ModelAppearance.ResetColor(self: ModelAppearance) → ()

Resets the color to the original state

ResetMaterial​

</>
ModelAppearance.ResetMaterial(self: ModelAppearance) → ()

Resets the material to the original state

SetMaterial​

</>
ModelAppearance.SetMaterial(
material: Enum.Material
) → ()

Sets the material of the model

Show raw api
{
    "functions": [
        {
            "name": "DisableInteractions",
            "desc": "Disables all interactions with the model. This includes click detectors and seats\n\n:::tip\nDestructive, cannot be reverted\n:::",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ModelAppearance"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 76,
                "path": "src/modelappearance/src/Shared/ModelAppearance.lua"
            }
        },
        {
            "name": "SetCanCollide",
            "desc": "Sets the models collision state",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ModelAppearance"
                },
                {
                    "name": "canCollide",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 91,
                "path": "src/modelappearance/src/Shared/ModelAppearance.lua"
            }
        },
        {
            "name": "ResetCanCollide",
            "desc": "Resets the can collide state to the original state",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ModelAppearance"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 107,
                "path": "src/modelappearance/src/Shared/ModelAppearance.lua"
            }
        },
        {
            "name": "SetTransparency",
            "desc": "Sets the transparency of the model",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ModelAppearance"
                },
                {
                    "name": "transparency",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 116,
                "path": "src/modelappearance/src/Shared/ModelAppearance.lua"
            }
        },
        {
            "name": "ResetTransparency",
            "desc": "Resets the transparency to the original state",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ModelAppearance"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 130,
                "path": "src/modelappearance/src/Shared/ModelAppearance.lua"
            }
        },
        {
            "name": "SetColor",
            "desc": "Sets the color of the model",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ModelAppearance"
                },
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 146,
                "path": "src/modelappearance/src/Shared/ModelAppearance.lua"
            }
        },
        {
            "name": "ResetColor",
            "desc": "Resets the color to the original state",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ModelAppearance"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 166,
                "path": "src/modelappearance/src/Shared/ModelAppearance.lua"
            }
        },
        {
            "name": "ResetMaterial",
            "desc": "Resets the material to the original state",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ModelAppearance"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 184,
                "path": "src/modelappearance/src/Shared/ModelAppearance.lua"
            }
        },
        {
            "name": "SetMaterial",
            "desc": "Sets the material of the model",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ModelAppearance"
                },
                {
                    "name": "material",
                    "desc": "",
                    "lua_type": "Enum.Material"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 200,
                "path": "src/modelappearance/src/Shared/ModelAppearance.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ModelAppearance",
    "desc": "Allows the appearance of a model to be overridden. Most commonly used when\nplacing down an object in a building game.",
    "source": {
        "line": 8,
        "path": "src/modelappearance/src/Shared/ModelAppearance.lua"
    }
}