Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
ReflectionMetadataItem
Inherits from: Instance → Object
Acts as abstract properties for generic information about Classes, Members, Enums, and EnumItems.
Inherits from: Instance
Descendants: ReflectionMetadataClass, ReflectionMetadataEnum, ReflectionMetadataEnumItem, ReflectionMetadataMember
Memory category: Instances
Tags: NotCreatable
Properties
| Name | Type / Returns | Description |
|---|---|---|
| ReflectionMetadataItem.Browsable | boolean | Whether or not this can be seen in studio. |
| ReflectionMetadataItem.ClassCategory | string | Describes the category of this class. |
| ReflectionMetadataItem.ClientOnly | boolean | Whether this item is only meaningful on the client. |
| ReflectionMetadataItem.Constraint | string | Describes a constraint for a single-argument function whose argument type is a Object.ClassName. |
| ReflectionMetadataItem.Deprecated | boolean | Whether or not this item is deprecated. |
| ReflectionMetadataItem.EditingDisabled | boolean | Toggles whether this property can be edited from the Properties window. |
| ReflectionMetadataItem.EditorType | string | Names the editor used for this property in the Properties window. |
| ReflectionMetadataItem.FFlag | string | Names a setting that controls whether this item is browsable. |
| ReflectionMetadataItem.IsBackend | boolean | Vague value for showing if this depends on backend stuff. |
| ReflectionMetadataItem.PropertyOrder | int | The sort position of this property within its category in the Properties window. |
| ReflectionMetadataItem.ScriptContext | string | Describes the context where this member can be used. If set to "Server", this member will not be available to auto fill when editing a LocalScript. If set to "Client", this member will not be available to auto fill when editing a Script. |
| ReflectionMetadataItem.ServerOnly | boolean | Whether this item is only meaningful on the server. |
| ReflectionMetadataItem.SliderScaling | string | The scaling mode for this property's slider bar in the Properties window. |
| ReflectionMetadataItem.UIMaximum | double | The maximum value of this property. Used with ReflectionMetadataItem.UIMinimum to control the slider bar of this property in the Properties window. |
| ReflectionMetadataItem.UIMinimum | double | The minimum value of this property. Used with ReflectionMetadataItem.UIMaximum to control the slider bar of this property in the Properties window. |
| ReflectionMetadataItem.UINumTicks | double | The number of potential values the property's slider bar can be set to, ReflectionMetadataItem.UIMinimum and ReflectionMetadataItem.UIMaximum. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
ReflectionMetadataItem.Browsable
When this value is true, it means that this property/class can be seen in Studio, e.g. in the explorer.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.ClassCategory
The category name used to group this class in Studio's Insert Object window. When set, the class is listed under a heading matching this category; when left at its default empty string, the class is grouped under "Uncategorized". This applies to class-level reflection metadata and has no effect on individual members.
| Field | Value |
|---|---|
| type | string |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.ClientOnly
When this value is true, this reflection item is only meaningful on the client and shouldn't be read or set on the server. Defaults to false.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.Constraint
Describes a constraint for a single-argument function whose argument type is a Object.ClassName. Currently there are two constraints available:
| Constraint | Description |
|---|---|
| isScriptCreatable | The specified class must be creatable with Instance.new |
| isService | The specified class must be a service. |
| Field | Value |
|---|---|
| type | string |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.Deprecated
When an object is deprecated, it should not be used anymore for new scripts.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.EditingDisabled
When this value is true, the property is shown as read-only in Studio's Properties window: its value is still displayed but cannot be edited there. Defaults to false, in which case the property can be edited normally.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.EditorType
Identifies the specialized editor used to display and edit this property in Studio's Properties window. Defaults to an empty string, in which case the default editor for the property's value type is used.
| Field | Value |
|---|---|
| type | string |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.FFlag
Names a Studio setting whose state controls whether this item is browsable. When set, the item is hidden unless that setting is on; prefixing the name with ! inverts this. Defaults to an empty string, in which case visibility is governed only by ReflectionMetadataItem.Browsable.
| Field | Value |
|---|---|
| type | string |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.IsBackend
This should determine if a method needs to use stuff on the Roblox main servers. This property isn't applied where it should be, though.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.PropertyOrder
Controls where this property appears relative to others in its category in the Properties window; lower values appear higher. Defaults to 5000, which leaves room to order properties before or after those that have no explicit order.
| Field | Value |
|---|---|
| type | int |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.ScriptContext
Describes the context where this member can be used. If set to "Server", this member will not be available to auto fill when editing a LocalScript. If set to "Client", this member will not be available to auto fill when editing a Script.
| Field | Value |
|---|---|
| type | string |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.ServerOnly
When this value is true, this reflection item is only meaningful on game servers and shouldn't be read or set on the client. Defaults to false.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.SliderScaling
Determines how the Properties-window slider maps tick positions to values between ReflectionMetadataItem.UIMinimum and ReflectionMetadataItem.UIMaximum. When set to "Square", the slider uses a quadratic mapping so that ticks near the minimum give finer control; any other value, including the default empty string, uses a linear mapping. The slider only takes effect when its range is configured through ReflectionMetadataItem.UIMinimum, ReflectionMetadataItem.UIMaximum, and ReflectionMetadataItem.UINumTicks, which all default to 0.
| Field | Value |
|---|---|
| type | string |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.UIMaximum
The upper bound of the slider shown for this numeric property in Studio's Properties window, used together with ReflectionMetadataItem.UIMinimum. Both default to 0, and Studio only shows a slider when the minimum and maximum differ; with the default values the property is edited through a plain input field with no slider.
| Field | Value |
|---|---|
| type | double |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.UIMinimum
The lower bound of the slider shown for this numeric property in Studio's Properties window, used together with ReflectionMetadataItem.UIMaximum. Both default to 0, and Studio only shows a slider when the minimum and maximum differ; with the default values the property is edited through a plain input field with no slider.
| Field | Value |
|---|---|
| type | double |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
ReflectionMetadataItem.UINumTicks
The number of discrete tick positions on this property's Properties-window slider, mapping each tick to a value between ReflectionMetadataItem.UIMinimum and ReflectionMetadataItem.UIMaximum. Defaults to 0, in which case Studio substitutes a built-in default number of intervals. It only takes effect when the slider is active, which requires ReflectionMetadataItem.UIMinimum and ReflectionMetadataItem.UIMaximum to be set to different values.
| Field | Value |
|---|---|
| type | double |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Reflection |
| serialization | {"can_load":true,"can_save":true} |
Methods
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
Events
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |