Skip to main content

TransparencyService

Service that orchistrates transparency setting from multiple colliding sources and handle the transparency appropriately. This means that 2 systems can work with transparency without knowing about each other.

Functions​

Init​

</>
TransparencyService:Init() → ()

Initializes the transparency service

Destroy​

</>
TransparencyService:Destroy() → ()

Uninitializes the transparency service, restoring transparency to original values.

SetTransparency​

</>
TransparencyService:SetTransparency(
key: any,
part: Instance,
transparency: number
) → ()

Sets the transparency of the part

SetLocalTransparencyModifier​

</>
TransparencyService:SetLocalTransparencyModifier(
key: any,
part: Instance,
transparency: number
) → ()

Sets the local transparency modifier of the part

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the transparency service",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 19,
                "path": "src/transparencyservice/src/Client/TransparencyService.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Uninitializes the transparency service, restoring transparency to original values.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 35,
                "path": "src/transparencyservice/src/Client/TransparencyService.lua"
            }
        },
        {
            "name": "SetTransparency",
            "desc": "Sets the transparency of the part",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "part",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "transparency",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 52,
                "path": "src/transparencyservice/src/Client/TransparencyService.lua"
            }
        },
        {
            "name": "SetLocalTransparencyModifier",
            "desc": "Sets the local transparency modifier of the part",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "part",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "transparency",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 65,
                "path": "src/transparencyservice/src/Client/TransparencyService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TransparencyService",
    "desc": "Service that orchistrates transparency setting from multiple colliding sources\nand handle the transparency appropriately. This means that 2 systems can work with\ntransparency without knowing about each other.",
    "source": {
        "line": 8,
        "path": "src/transparencyservice/src/Client/TransparencyService.lua"
    }
}