Skip to main content

AdorneeDataEntry

Declaration for the adornee data value

Functions​

new​

</>
AdorneeDataEntry.new(
interface: string | (value: any) → (
boolean,
string?
),
createValueObject: (adornee: Instance) → ValueObject<T>,
defaultValue: T?
) → AdorneeDataEntry<T>

Creates a new adornee data entry

optionalAttribute​

</>
AdorneeDataEntry.optionalAttribute(
interface: string | ValueInterface,
name: string
) → AdorneeDataEntry<T>

Sets up an optional attribute which can be nil to begin with.

isAdorneeDataEntry​

</>
AdorneeDataEntry.isAdorneeDataEntry(data: any) → boolean

Returns true if the implementation is an AdorneeDataEntry

Create​

</>
AdorneeDataEntry.Create(
self: AdorneeDataEntry<T>,
adornee: Instance
) → ValueObject<T>

Creates a value object for the given adornee

Observe​

</>
AdorneeDataEntry.Observe(
self: AdorneeDataEntry<T>,
adornee: Instance
) → Observable<T>

Observes the current value for the adornee

Get​

</>
AdorneeDataEntry.Get(
self: AdorneeDataEntry<T>,
adornee: Instance
) → T

Gets the value for the adornee

Set​

</>
AdorneeDataEntry.Set(
self: AdorneeDataEntry<T>,
adornee: Instance,
value: T
) → ()

Sets the value for the adornee

GetDefaultValue​

</>
AdorneeDataEntry.GetDefaultValue(self: AdorneeDataEntry<T>) → T?

Gets the default value

GetStrictInterface​

</>
AdorneeDataEntry.GetStrictInterface(self: AdorneeDataEntry<T>) → (value: any) → (
boolean,
string?
)

Gets the estrict interface for the entry

IsValid​

</>
AdorneeDataEntry.IsValid(
self: AdorneeDataEntry<T>,
value: any
) → (
boolean,
string?
)

Returns true if the item is valid.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new adornee data entry",
            "params": [
                {
                    "name": "interface",
                    "desc": "",
                    "lua_type": "string | (value: any) -> (boolean, string?)"
                },
                {
                    "name": "createValueObject",
                    "desc": "",
                    "lua_type": "(adornee: Instance) -> ValueObject<T>"
                },
                {
                    "name": "defaultValue",
                    "desc": "",
                    "lua_type": "T?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AdorneeDataEntry<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 40,
                "path": "src/adorneedata/src/Shared/AdorneeDataEntry.lua"
            }
        },
        {
            "name": "optionalAttribute",
            "desc": "Sets up an optional attribute which can be nil to begin with.",
            "params": [
                {
                    "name": "interface",
                    "desc": "",
                    "lua_type": "string | ValueInterface"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AdorneeDataEntry<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 72,
                "path": "src/adorneedata/src/Shared/AdorneeDataEntry.lua"
            }
        },
        {
            "name": "isAdorneeDataEntry",
            "desc": "Returns true if the implementation is an AdorneeDataEntry",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 90,
                "path": "src/adorneedata/src/Shared/AdorneeDataEntry.lua"
            }
        },
        {
            "name": "Create",
            "desc": "Creates a value object for the given adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeDataEntry<T>"
                },
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ValueObject<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 100,
                "path": "src/adorneedata/src/Shared/AdorneeDataEntry.lua"
            }
        },
        {
            "name": "Observe",
            "desc": "Observes the current value for the adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeDataEntry<T>"
                },
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 112,
                "path": "src/adorneedata/src/Shared/AdorneeDataEntry.lua"
            }
        },
        {
            "name": "Get",
            "desc": "Gets the value for the adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeDataEntry<T>"
                },
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 125,
                "path": "src/adorneedata/src/Shared/AdorneeDataEntry.lua"
            }
        },
        {
            "name": "Set",
            "desc": "Sets the value for the adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeDataEntry<T>"
                },
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 139,
                "path": "src/adorneedata/src/Shared/AdorneeDataEntry.lua"
            }
        },
        {
            "name": "GetDefaultValue",
            "desc": "Gets the default value",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeDataEntry<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 152,
                "path": "src/adorneedata/src/Shared/AdorneeDataEntry.lua"
            }
        },
        {
            "name": "GetStrictInterface",
            "desc": "Gets the estrict interface for the entry",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeDataEntry<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(value: any) -> (boolean, string?)"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 161,
                "path": "src/adorneedata/src/Shared/AdorneeDataEntry.lua"
            }
        },
        {
            "name": "IsValid",
            "desc": "Returns true if the item is valid.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeDataEntry<T>"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(boolean, string?)"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 171,
                "path": "src/adorneedata/src/Shared/AdorneeDataEntry.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AdorneeDataEntry",
    "desc": "Declaration for the adornee data value",
    "source": {
        "line": 7,
        "path": "src/adorneedata/src/Shared/AdorneeDataEntry.lua"
    }
}