Skip to main content

TieDefinition

Functions​

GetImplementations​

</>
TieDefinition:GetImplementations(adornee: Instance) → {TieInterface}

Gets all valid interfaces for this adornee

ObserveChildrenBrio​

</>
TieDefinition:ObserveChildrenBrio(adornee: Instance) → Observable<Brio<TieInterface>>

Observes all the children implementations for this adornee

Promise​

</>
TieDefinition:Promise(adornee: Adornee) → Promise<TieInterface>

Promises the implementation

GetChildren​

</>
TieDefinition:GetChildren(adornee: Instance) → {TieInterface}

Gets all valid interfaces for this adornee's children

Find​

</>
TieDefinition:Find(adornee: Adornee) → TieInterface | nil

Finds the implementation on the adornee. Alais for [FindFirstImplementation]

ObserveAllTaggedBrio​

</>
TieDefinition:ObserveAllTaggedBrio(tagName: string) → TieInterface | nil

Observes all implementations that are tagged with the given tag name

FindFirstImplementation​

</>
TieDefinition:FindFirstImplementation(adornee: Instance) → TieInterface

Finds the first valid interfaces for this adornee

HasImplementation​

</>
TieDefinition:HasImplementation(adornee: Instance) → boolean

Returns true if the adornee implements the interface, and false otherwise.

ObserveIsImplemented​

</>
TieDefinition:ObserveIsImplemented(adornee: Instance) → Observable<boolean>>

Observes whether the adornee implements the interface.

ObserveIsImplementation​

</>
TieDefinition:ObserveIsImplementation(folder: Instance) → Observable<boolean>>

Observes whether the folder is a valid implementation

ObserveIsImplementedOn​

</>
TieDefinition:ObserveIsImplementedOn(
folder: Instance,
adornee: Instance
) → Observable<boolean>>

Observes whether the folder is a valid implementation on the given adornee

ObserveLastImplementationBrio​

</>
TieDefinition:ObserveLastImplementationBrio(adornee: Instance) → Observable<Brio<TieImplementation<T>>>

Observes a valid implementation wrapped in a brio if it exists.

ObserveLastImplementation​

</>
TieDefinition:ObserveLastImplementation(adornee: Instance) → Observable<TieImplementation<T> | nil>>

Observes a valid implementation if it exists, or nil

ObserveImplementationsBrio​

</>
TieDefinition:ObserveImplementationsBrio(adornee: Instance) → Observable<Brio<TieImplementation<T>>>

Observes valid implementations wrapped in a brio if it exists.

Implement​

</>
TieDefinition:Implement(
adornee: Instance,--

Adornee to implement interface on

implementer: table?--

Table with all interface values or nil

) → TieImplementation<T>

Ensures implementation of the object, binding table values and Lua OOP objects to Roblox objects that can be invoked generally.

Get​

</>
TieDefinition:Get(
adornee: Instance--

Adornee to get interface on

) → TieInterface<T>

Gets an interface to the tie definition. Not this can be done on any Roblox instance. If the instance does not implement the interface, invoking interface methods, or querying the interface will result in errors.

GetName​

</>
TieDefinition:GetName() → string

Gets the name of the definition

IsImplementation​

</>
TieDefinition:IsImplementation(folder: Folder) → boolean

Returns true if the folder is an implementation

Show raw api
{
    "functions": [
        {
            "name": "GetImplementations",
            "desc": "Gets all valid interfaces for this adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ TieInterface }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 86,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "ObserveChildrenBrio",
            "desc": "Observes all the children implementations for this adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<TieInterface>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 109,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "Promise",
            "desc": "Promises the implementation",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Adornee"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<TieInterface>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 123,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "GetChildren",
            "desc": "Gets all valid interfaces for this adornee's children",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ TieInterface }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 141,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "Find",
            "desc": "Finds the implementation on the adornee. Alais for [FindFirstImplementation]",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Adornee"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TieInterface | nil"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 162,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "ObserveAllTaggedBrio",
            "desc": "Observes all implementations that are tagged with the given tag name",
            "params": [
                {
                    "name": "tagName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TieInterface | nil"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 172,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "FindFirstImplementation",
            "desc": "Finds the first valid interfaces for this adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TieInterface"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 187,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "HasImplementation",
            "desc": "Returns true if the adornee implements the interface, and false otherwise.",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 207,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "ObserveIsImplemented",
            "desc": "Observes whether the adornee implements the interface.",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 223,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "ObserveIsImplementation",
            "desc": "Observes whether the folder is a valid implementation",
            "params": [
                {
                    "name": "folder",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 242,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "ObserveIsImplementedOn",
            "desc": "Observes whether the folder is a valid implementation on the given adornee",
            "params": [
                {
                    "name": "folder",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 260,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "ObserveLastImplementationBrio",
            "desc": "Observes a valid implementation wrapped in a brio if it exists.",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<TieImplementation<T>>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 284,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "ObserveLastImplementation",
            "desc": "Observes a valid implementation if it exists, or nil",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<TieImplementation<T> | nil>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 306,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "ObserveImplementationsBrio",
            "desc": "Observes valid implementations wrapped in a brio if it exists.",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<TieImplementation<T>>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 323,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "Implement",
            "desc": "Ensures implementation of the object, binding table values and Lua OOP objects\nto Roblox objects that can be invoked generally.\n\n```lua\n\n```",
            "params": [
                {
                    "name": "adornee",
                    "desc": "Adornee to implement interface on",
                    "lua_type": "Instance"
                },
                {
                    "name": "implementer",
                    "desc": "Table with all interface values or nil",
                    "lua_type": "table?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TieImplementation<T>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 408,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "Get",
            "desc": "Gets an interface to the tie definition. Not this can be done\non any Roblox instance. If the instance does not implement the interface,\ninvoking interface methods, or querying the interface will result\nin errors.",
            "params": [
                {
                    "name": "adornee",
                    "desc": "Adornee to get interface on",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TieInterface<T>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 424,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "GetName",
            "desc": "Gets the name of the definition",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 434,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        },
        {
            "name": "IsImplementation",
            "desc": "Returns true if the folder is an implementation",
            "params": [
                {
                    "name": "folder",
                    "desc": "",
                    "lua_type": "Folder"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 460,
                "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TieDefinition",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/tie/src/Shared/Definition/TieDefinition.lua"
    }
}