Reflection

gethiddenproperty

Reads a hidden property and reports whether the property was hidden.

Syntax

gethiddenproperty(instance: userdata, property: string): any | boolean

Arguments

NameTypeDescription
instanceuserdataRoblox instance to inspect or update.
propertystringProperty name to read or change.

Returns

NameTypeDescription
propertyValueanyCurrent property value.
wasHiddenbooleanPrevious or detected hidden-property state.

Description

Reads a hidden property and reports whether the property was hidden.

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

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

Example

Example call with placeholder values.

local result = gethiddenproperty(game, "example")
print(result)