ElementPropertiesData — Design-Time Property Editor Reference - RollingQuest Lua Scripting

The ElementPropertiesData class provides typed methods for reading custom properties on level elements at design time. This is the editor-side counterpart to the runtime ElementPropertyPool.

This is the editor/design-time API. For runtime property access during gameplay, use ElementPropertyPool instead.

Getter Methods

--- @param name string
--- @return integer
function ElementPropertiesData:GetIntegerProperty(name)

--- @param name string
--- @return number
function ElementPropertiesData:GetFloatProperty(name)

--- @param name string
--- @return string
function ElementPropertiesData:GetStringProperty(name)

--- @param name string
--- @return boolean
function ElementPropertiesData:GetBooleanProperty(name)

--- @param name string
--- @return string
function ElementPropertiesData:GetEnumProperty(name)

--- @param name string
--- @return integer
function ElementPropertiesData:GetEnumOrdinalProperty(name)

Usage Example

Read custom properties from a block during gameplay:

function OnBallRoll(self, rollIn, side, ball)
    -- self is a Block — use the runtime ElementPropertyPool
    local props = self.properties

    if props:hasProperty("health") then
        local health = props:getPropertyValue("health")
        Logger.info("Block health: " .. tostring(health))
    end
end