Skip to main content

AdorneeData

Bridges attributes and serializable data table. It's typical to need to define data in 3 ways.

  1. Attributes on an instance for replication
  2. Tables for Lua configuration
  3. Within AttributeValues for writing regular code

Providing all 3

Functions​

new​

</>
AdorneeData.new(prototype: any) → AdorneeData<T>

Attribute data specification

IsStrictData​

</>
AdorneeData:IsStrictData(data: any) → (
boolean,
string--

Error message

)

Returns true if the data is valid data, otherwise returns false and an error.

CreateStrictData​

</>
AdorneeData:CreateStrictData(data: TStrict) → TStrict

Validates and creates a new data table for the data that is readonly and frozen

CreateFullData​

</>
AdorneeData:CreateFullData(data: T) → T

Validates and creates a new data table that is readonly. This table will have all values or the defaults

CreateData​

</>
AdorneeData:CreateData(data: TPartial) → TPartial

Validates and creates a new data table that is readonly and frozen, but for partial data.

The data can just be part of the attributes.

Observe​

</>
AdorneeData:Observe(adornee: Instance) → Observable<TStrict>

Observes the attribute table for adornee

CreateValue​

</>
AdorneeData:CreateValue(adornee: Instance) → AdorneeDataValue

Gets attribute table for the data

CreateAdorneeDataValue​

</>
AdorneeData:CreateAdorneeDataValue(adornee: Instance) → AdorneeDataValue

Gets attribute table for the data

GetAttributes​

</>
AdorneeData:GetAttributes(adornee: Instance) → TStrict

Gets the attributes for the adornee

SetAttributes​

</>
AdorneeData:SetAttributes(
adornee: Instance,
data: T
) → ()

Sets the attributes for the adornee

SetStrictAttributes​

</>
AdorneeData:SetStrictAttributes(
adornee: Instance,
data: TStrict
) → ()

Sets the attributes for the adornee

InitAttributes​

</>
AdorneeData:InitAttributes(
adornee: Instance,
data: T | nil
) → ()

Initializes the attributes for the adornee

GetStrictTInterface​

</>
AdorneeData:GetStrictTInterface() → function

Gets a strict interface which will return true if the value is a partial interface and false otherwise.

GetTInterface​

</>
AdorneeData:GetTInterface() → function

Gets a [t] interface which will return true if the value is a partial interface, and false otherwise.

IsData​

</>
AdorneeData:IsData(data: any) → (
boolean,
string--

Error message

)

Returns true if the data is valid partial data, otherwise returns false and an error.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Attribute data specification",
            "params": [
                {
                    "name": "prototype",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AdorneeData<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 30,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "IsStrictData",
            "desc": "Returns true if the data is valid data, otherwise returns false and an error.",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                },
                {
                    "desc": "Error message",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 59,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "CreateStrictData",
            "desc": "Validates and creates a new data table for the data that is readonly and frozen",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "TStrict"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TStrict"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 69,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "CreateFullData",
            "desc": "Validates and creates a new data table that is readonly. This table will have all values or\nthe defaults",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 82,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "CreateData",
            "desc": "Validates and creates a new data table that is readonly and frozen, but for partial\ndata.\n\nThe  data can just be part of the attributes.",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "TPartial"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TPartial"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 103,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "Observe",
            "desc": "Observes the attribute table for adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<TStrict>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 115,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "CreateValue",
            "desc": "Gets attribute table for the data",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AdorneeDataValue"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 128,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "CreateAdorneeDataValue",
            "desc": "Gets attribute table for the data",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AdorneeDataValue"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 142,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "GetAttributes",
            "desc": "Gets the attributes for the adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TStrict"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 154,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "SetAttributes",
            "desc": "Sets the attributes for the adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 180,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "SetStrictAttributes",
            "desc": "Sets the attributes for the adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "TStrict"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 196,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "InitAttributes",
            "desc": "Initializes the attributes for the adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "T | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 216,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "GetStrictTInterface",
            "desc": "Gets a strict interface which will return true if the value is a partial interface and\nfalse otherwise.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 248,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "GetTInterface",
            "desc": "Gets a [t] interface which will return true if the value is a partial interface, and\nfalse otherwise.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 263,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        },
        {
            "name": "IsData",
            "desc": "Returns true if the data is valid partial data, otherwise returns false and an error.",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                },
                {
                    "desc": "Error message",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 284,
                "path": "src/adorneedata/src/Shared/AdorneeData.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AdorneeData",
    "desc": "Bridges attributes and serializable data table. It's typical to need to define data in 3 ways.\n\n1. Attributes on an instance for replication\n2. Tables for Lua configuration\n3. Within AttributeValues for writing regular code\n\nProviding all 3",
    "source": {
        "line": 12,
        "path": "src/adorneedata/src/Shared/AdorneeData.lua"
    }
}