Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ReflectionMetadataItem

Acts as abstract properties for generic information about Classes, Members, Enums, and EnumItems.

This class is not creatable. Instances of this class cannot be created with Instance.new.
Tags: [NotCreatable]

Member index 16

HistoryMember
731Browsable: bool
731ClassCategory: string
731ClientOnly: bool
731Constraint: string
731Deprecated: bool
731EditingDisabled: bool
731EditorType: string
731FFlag: string
731IsBackend: bool
731PropertyOrder: int
731ScriptContext: string
731ServerOnly: bool
731SliderScaling: string
731UIMaximum: double
731UIMinimum: double
731UINumTicks: double
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Removed member index 2

HistoryMember
79Preliminary: bool
486summary: string

Description

Acts as abstract properties for generic information about Classes, Members, Enums, and EnumItems.

History 102

Members 16

Browsable

TypeDefault
bool

When this value is true, it means that this property/class can be seen in Studio, e.g. in the explorer.

History 6

ClassCategory

TypeDefault
string

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.

History 8

ClientOnly

TypeDefault
bool

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.

History 6

Constraint

TypeDefault
string

Describes a constraint for a single-argument function whose argument type is a Object.ClassName. Currently there are two constraints available:

ConstraintDescription
isScriptCreatableThe specified class must be creatable with Instance.new
isServiceThe specified class must be a service.

History 6

Deprecated

TypeDefault
bool

When an object is deprecated, it should not be used anymore for new scripts.

History 6

EditingDisabled

TypeDefault
bool

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.

History 6

EditorType

TypeDefault
string

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.

History 4

FFlag

TypeDefault
string

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.

History 5

IsBackend

TypeDefault
bool

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.

History 8

PropertyOrder

TypeDefault
int

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.

History 5

ScriptContext

TypeDefault
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.

History 6

ServerOnly

TypeDefault
bool

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.

History 6

SliderScaling

TypeDefault
string

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.

History 4

UIMaximum

TypeDefault
double

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.

History 6

UIMinimum

TypeDefault
double

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.

History 6

UINumTicks

TypeDefault
double

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.

History 6

Removed members 2

Preliminary

TypeDefault
bool

History 4

summary

TypeDefault
string

History 3

Settings