Drawing

getrenderproperty

Reads a property from a drawing object through the generic render property API.

Syntax

getrenderproperty(object: DrawingObject, property: string): any

Arguments

NameTypeDescription
objectDrawingObjectObject, table, or drawing value to inspect or change.
propertystringProperty name to read or change.

Returns

NameTypeDescription
propertyValueanyCurrent property value.

Description

Reads a property from a drawing object through the generic render property API.

Call it with 2 parameter(s): object, property. The argument table explains which values are required and which ones only refine the behavior.

It returns propertyValue (any). Use the returns table to separate successful values from nil results and recoverable errors.

Example

Example call with placeholder values.

local result = getrenderproperty(nil, "example")
print(result)