Skip to main content

RoguePropertyTableDefinition

This holds the definition for a variety of tables.

Functions​

GetDefinition​

</>
RoguePropertyTableDefinition:GetDefinition(propertyName: string) → RoguePropertyDefinition?

Gets the RoguePropertyDefinition if it exists

Get​

</>
RoguePropertyTableDefinition:Get(
serviceBag: ServiceBag,
adornee: Instance
) → RoguePropertyTable

Gets a new property table for a given object, which can compute the modified value of the adornee. This will initialize the properties on the server.

ObserveContainerBrio​

</>
RoguePropertyTableDefinition:ObserveContainerBrio(
adornee: Instance,
canInitialize: boolean
) → Observable<Brio<Folder>>

Observes the current container while it exists for the given adornee.

GetContainer​

</>
RoguePropertyTableDefinition:GetContainer(
adornee: Instance,
canInitialize: boolean
) → Folder?

Gets the current container for the given adornee.

Show raw api
{
    "functions": [
        {
            "name": "GetDefinition",
            "desc": "Gets the RoguePropertyDefinition if it exists",
            "params": [
                {
                    "name": "propertyName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RoguePropertyDefinition?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 153,
                "path": "src/rogue-properties/src/Shared/Definition/RoguePropertyTableDefinition.lua"
            }
        },
        {
            "name": "Get",
            "desc": "Gets a new property table for a given object, which can compute the modified\nvalue of the adornee. This will initialize the properties on the server.",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                },
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RoguePropertyTable"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 168,
                "path": "src/rogue-properties/src/Shared/Definition/RoguePropertyTableDefinition.lua"
            }
        },
        {
            "name": "ObserveContainerBrio",
            "desc": "Observes the current container while it exists for the given adornee.",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "canInitialize",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<Folder>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 199,
                "path": "src/rogue-properties/src/Shared/Definition/RoguePropertyTableDefinition.lua"
            }
        },
        {
            "name": "GetContainer",
            "desc": "Gets the current container for the given adornee.",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "canInitialize",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Folder?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 225,
                "path": "src/rogue-properties/src/Shared/Definition/RoguePropertyTableDefinition.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RoguePropertyTableDefinition",
    "desc": "This holds the definition for a variety of tables.",
    "source": {
        "line": 5,
        "path": "src/rogue-properties/src/Shared/Definition/RoguePropertyTableDefinition.lua"
    }
}