Skip to main content

TieInterface

Tie interfaces can be retrieved from an implementation and allow access to a specific call into the interface

Functions​

IsImplemented​

</>
TieInterface.IsImplemented(self: TieInterface<T>) → boolean

Returns whether this version of the definition is implemented to standard or not.

GetTieAdornee​

</>
TieInterface.GetTieAdornee(self: TieInterface<T>) → Instance?

Gets the adornee the tie interface is on if it can be found.

ObserveIsImplemented​

</>
TieInterface.ObserveIsImplemented(self: TieInterface<T>) → Observable<boolean>

Observes if the interface is implemented

Show raw api
{
    "functions": [
        {
            "name": "IsImplemented",
            "desc": "Returns whether this version of the definition is implemented to standard or not.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TieInterface<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 57,
                "path": "src/tie/src/Shared/TieInterface.lua"
            }
        },
        {
            "name": "GetTieAdornee",
            "desc": "Gets the adornee the tie interface is on if it can be found.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TieInterface<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 85,
                "path": "src/tie/src/Shared/TieInterface.lua"
            }
        },
        {
            "name": "ObserveIsImplemented",
            "desc": "Observes if the interface is implemented",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TieInterface<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 104,
                "path": "src/tie/src/Shared/TieInterface.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TieInterface",
    "desc": "Tie interfaces can be retrieved from an implementation and allow access to a specific call into the interface",
    "source": {
        "line": 7,
        "path": "src/tie/src/Shared/TieInterface.lua"
    }
}