Property

Functions for creating script properties that are automatically exposed to the editor.

---

Property.Create

Creates a property that will appear in the editor on any nodes containing this script. This function should be called during the script's Create() method and assigned to a variable on self. The property will automatically be detected and exposed in the editor with the appropriate UI controls.

See DatumType

Basic Usage:

function MyScript:Create()
    self.gravity = Property.Create(DatumType.Float, 200)
    self.name = Property.Create(DatumType.String, "Michael")
    self.myAsset = Property.Create(DatumType.Asset, nil, "my awesome asset")
end

Sig: value = Property.Create(type, defaultValue, displayName) - Arg: DatumType type The data type of the property (see DatumType enum) - Arg: any defaultValue The default value for the property - Arg: string displayName (optional) Custom name to display in the editor. If not provided, the variable name will be used - Ret: any value Returns the default value

---

Property.CreateArray

Creates an array property that will appear in the editor as a list with + and - buttons to add/remove elements. This function should be called during the script's Create() method and assigned to a variable on self. Each element in the array will have the appropriate UI control based on the specified type.

See DatumType

Basic Usage:

function MyScript:Create()
    self.myNumberList = Property.CreateArray(DatumType.Float, {1.0, 2.5, 3.7})
    self.myAssetList = Property.CreateArray(DatumType.Asset, {})
    self.nameList = Property.CreateArray(DatumType.String, {"Player1", "Player2"}, "Player Names")
end

Sig: value = Property.CreateArray(type, arrayValues, displayName) - Arg: DatumType type The data type of each element in the array (see DatumType enum) - Arg: table arrayValues Table containing the initial values for the array - Arg: string displayName (optional) Custom name to display in the editor. If not provided, the variable name will be used - Ret: table value Returns the array of values as a Lua table

Array of Node References:

function MyScript:Create()
    -- Array of Node3D references (e.g., waypoints, targets)
    self.waypoints = Property.CreateArray(DatumType.Node3D, {}, "Waypoints")

    -- Array of any Node type
    self.targets = Property.CreateArray(DatumType.Node, {})
end

function MyScript:Tick(deltaTime)
    -- Access array elements
    for i, waypoint in ipairs(self.waypoints) do
        if waypoint then
            local pos = waypoint:GetWorldPosition()
            -- Do something with waypoint position
        end
    end
end

Array of Asset References:

function MyScript:Create()
    -- Array of textures to cycle through
    self.textures = Property.CreateArray(DatumType.Asset, {}, "Texture List")

    -- Array of sound effects
    self.sounds = Property.CreateArray(DatumType.Asset, {}, "Sound Effects")
end

Using GatherProperties (Table Syntax):

You can also define array properties using the GatherProperties callback with the array = true field:

function MyScript:GatherProperties()
    return {
        { name = "windows", type = DatumType.Widget, array = true },
        { name = "targets", type = DatumType.Node3D, array = true },
        { name = "materials", type = DatumType.Asset, array = true },
        { name = "speeds", type = DatumType.Float, array = true }
    }
end

function MyScript:Create()
    -- Initialize the arrays (optional, can be empty)
    self.windows = {}
    self.targets = {}
    self.materials = {}
    self.speeds = { 1.0, 2.0, 3.0 }
end

Editor UI: - Each element displays an index label (e.g., [0], [1]) - Click the red X button on any element to remove it from the array - Use the + button to add new elements - Use the - button to remove the last element

---

Function Properties (Editor-Only Buttons)

You can expose Lua functions as clickable buttons in the Properties Inspector by using DatumType.Function in GatherProperties. When clicked, the button calls the Lua function with the matching name on the script instance. Function properties are editor-only — they store no data and are not serialized.

Basic Usage:

function MyScript:GatherProperties()
    return {
        { name = "speed", type = DatumType.Float },
        { name = "ResetPosition", type = DatumType.Function },
        { name = "PrintDebugInfo", type = DatumType.Function, display_name = "Print Debug Info" },
    }
end

function MyScript:ResetPosition()
    self:SetWorldPosition(Vec(0, 0, 0))
    Log("Position reset!")
end

function MyScript:PrintDebugInfo()
    Log("Speed: " .. tostring(self.speed))
end

Fields: - name (required) — The name of the Lua function to call when the button is clicked. Must match a function defined on the script. - type (required) — Must be DatumType.Function. - display_name (optional) — Custom label for the button. If not provided, the function name is used.

Notes: - The script must be active for the button to work. If the script is not running, clicking the button has no effect. - Function properties do not appear at runtime — they are only visible in the editor's Properties Inspector. - The display_name field is also supported on all other property types defined via GatherProperties.

---