Skip to main content

RoguePropertyDefinition

Functions​

Get​

</>
RoguePropertyDefinition:Get(
serviceBag: ServiceBag,
adornee: Instance
) → RogueProperty

GetName​

</>
RoguePropertyDefinition:GetName() → string

Gets the name of the rogue property

GetFullName​

</>
RoguePropertyDefinition:GetFullName() → string

Gets the full name of the rogue property

GetDefaultValue​

</>
RoguePropertyDefinition:GetDefaultValue() → TProperty

Gets the default value for the property

Show raw api
{
    "functions": [
        {
            "name": "Get",
            "desc": "",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                },
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RogueProperty"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 44,
                "path": "src/rogue-properties/src/Shared/Definition/RoguePropertyDefinition.lua"
            }
        },
        {
            "name": "GetName",
            "desc": "Gets the name of the rogue property",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 97,
                "path": "src/rogue-properties/src/Shared/Definition/RoguePropertyDefinition.lua"
            }
        },
        {
            "name": "GetFullName",
            "desc": "Gets the full name of the rogue property",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 105,
                "path": "src/rogue-properties/src/Shared/Definition/RoguePropertyDefinition.lua"
            }
        },
        {
            "name": "GetDefaultValue",
            "desc": "Gets the default value for the property",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TProperty"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 117,
                "path": "src/rogue-properties/src/Shared/Definition/RoguePropertyDefinition.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RoguePropertyDefinition",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/rogue-properties/src/Shared/Definition/RoguePropertyDefinition.lua"
    }
}