ReflectionMetadataItem
Acts as abstract properties for generic information about Classes, Members, Enums, and EnumItems.
| Memory category | Instances |
|---|
Member index 16
Removed member index 2
| History | Member | |
|---|---|---|
| 79 | Preliminary: bool | |
| 486 | summary: string |
Description
Acts as abstract properties for generic information about Classes, Members, Enums, and EnumItems.
History 102
- 731 Change Default of UINumTicks from to
- 731 Change Default of UIMinimum from to
- 731 Change Default of UIMaximum from to
- 731 Change Default of SliderScaling from to
- 731 Change Default of ServerOnly from to
- 731 Change Default of ScriptContext from to
- 731 Change Default of PropertyOrder from to
- 731 Change Default of IsBackend from to
- 731 Change Default of FFlag from to
- 731 Change Default of EditorType from to
- 731 Change Default of EditingDisabled from to
- 731 Change Default of Deprecated from to
- 731 Change Default of Constraint from to
- 731 Change Default of ClientOnly from to
- 731 Change Default of ClassCategory from to
- 731 Change Default of Browsable from to
- 726 Change Default of UINumTicks from to
- 726 Change Default of UIMinimum from to
- 726 Change Default of UIMaximum from to
- 726 Change Default of SliderScaling from to
- 726 Change Default of ServerOnly from to
- 726 Change Default of ScriptContext from to
- 726 Change Default of PropertyOrder from to
- 726 Change Default of IsBackend from to
- 726 Change Default of FFlag from to
- 726 Change Default of EditorType from to
- 726 Change Default of EditingDisabled from to
- 726 Change Default of Deprecated from to
- 726 Change Default of Constraint from to
- 726 Change Default of ClientOnly from to
- 726 Change Default of ClassCategory from to
- 726 Change Default of Browsable from to
- 553 Change Default of UINumTicks from to
- 553 Change Default of UIMinimum from to
- 553 Change Default of UIMaximum from to
- 553 Change Default of SliderScaling from to
- 553 Change Default of ServerOnly from to
- 553 Change Default of ScriptContext from to
- 553 Change Default of PropertyOrder from to
- 553 Change Default of IsBackend from to
- 553 Change Default of FFlag from to
- 553 Change Default of EditorType from to
- 553 Change Default of EditingDisabled from to
- 553 Change Default of Deprecated from to
- 553 Change Default of Constraint from to
- 553 Change Default of ClientOnly from to
- 553 Change Default of ClassCategory from to
- 553 Change Default of Browsable from to
- 525 Add SliderScaling
- 487 Add EditorType
- 486 Remove summary
- 486 Change ThreadSafety of UINumTicks from ReadOnly to ReadSafe
- 486 Change ThreadSafety of UIMinimum from ReadOnly to ReadSafe
- 486 Change ThreadSafety of UIMaximum from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ServerOnly from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ScriptContext from ReadOnly to ReadSafe
- 486 Change ThreadSafety of PropertyOrder from ReadOnly to ReadSafe
- 486 Change ThreadSafety of IsBackend from ReadOnly to ReadSafe
- 486 Change ThreadSafety of FFlag from ReadOnly to ReadSafe
- 486 Change ThreadSafety of EditingDisabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Deprecated from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Constraint from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ClientOnly from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ClassCategory from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Browsable from ReadOnly to ReadSafe
- 483 Add FFlag
- 464 Add PropertyOrder
- 462 Change ThreadSafety of summary from to ReadOnly
- 462 Change ThreadSafety of UINumTicks from to ReadOnly
- 462 Change ThreadSafety of UIMinimum from to ReadOnly
- 462 Change ThreadSafety of UIMaximum from to ReadOnly
- 462 Change ThreadSafety of ServerOnly from to ReadOnly
- 462 Change ThreadSafety of ScriptContext from to ReadOnly
- 462 Change ThreadSafety of IsBackend from to ReadOnly
- 462 Change ThreadSafety of EditingDisabled from to ReadOnly
- 462 Change ThreadSafety of Deprecated from to ReadOnly
- 462 Change ThreadSafety of Constraint from to ReadOnly
- 462 Change ThreadSafety of ClientOnly from to ReadOnly
- 462 Change ThreadSafety of ClassCategory from to ReadOnly
- 462 Change ThreadSafety of Browsable from to ReadOnly
- 366 Add ServerOnly
- 366 Add ClientOnly
- 324 Add ScriptContext
- 320 Add Constraint
- 268 Add EditingDisabled
- 265 Add ClassCategory
- 264 Remove ClassCategory
- 265 Add ClassCategory
- 253 Add UINumTicks
- 218 Add UIMinimum
- 218 Add UIMaximum
- 79 Remove Preliminary
- 79 Add IsBackend
- 78 Add Preliminary
- 78 Remove IsBackend
- 79 Remove Preliminary
- 79 Add IsBackend
- 47 Add summary
- 47 Add Preliminary
- 47 Add Deprecated
- 47 Add Browsable
- 47 Add ReflectionMetadataItem
Members 16
Browsable
| Type | Default | |
|---|---|---|
| bool | ||
When this value is true, it means that this property/class can be seen in Studio, e.g. in the explorer.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
ClassCategory
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
History 8
- 731 Change Default of ClassCategory from to
- 726 Change Default of ClassCategory from to
- 553 Change Default of ClassCategory from to
- 486 Change ThreadSafety of ClassCategory from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ClassCategory from to ReadOnly
- 265 Add ClassCategory
- 264 Remove ClassCategory
- 265 Add ClassCategory
ClientOnly
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
History 6
- 731 Change Default of ClientOnly from to
- 726 Change Default of ClientOnly from to
- 553 Change Default of ClientOnly from to
- 486 Change ThreadSafety of ClientOnly from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ClientOnly from to ReadOnly
- 366 Add ClientOnly
Constraint
| Type | Default | |
|---|---|---|
| string | ||
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. |
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
History 6
- 731 Change Default of Constraint from to
- 726 Change Default of Constraint from to
- 553 Change Default of Constraint from to
- 486 Change ThreadSafety of Constraint from ReadOnly to ReadSafe
- 462 Change ThreadSafety of Constraint from to ReadOnly
- 320 Add Constraint
Deprecated
| Type | Default | |
|---|---|---|
| bool | ||
When an object is deprecated, it should not be used anymore for new scripts.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
History 6
- 731 Change Default of Deprecated from to
- 726 Change Default of Deprecated from to
- 553 Change Default of Deprecated from to
- 486 Change ThreadSafety of Deprecated from ReadOnly to ReadSafe
- 462 Change ThreadSafety of Deprecated from to ReadOnly
- 47 Add Deprecated
EditingDisabled
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
History 6
- 731 Change Default of EditingDisabled from to
- 726 Change Default of EditingDisabled from to
- 553 Change Default of EditingDisabled from to
- 486 Change ThreadSafety of EditingDisabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of EditingDisabled from to ReadOnly
- 268 Add EditingDisabled
EditorType
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
History 4
- 731 Change Default of EditorType from to
- 726 Change Default of EditorType from to
- 553 Change Default of EditorType from to
- 487 Add EditorType
FFlag
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
IsBackend
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
PropertyOrder
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
History 5
- 731 Change Default of PropertyOrder from to
- 726 Change Default of PropertyOrder from to
- 553 Change Default of PropertyOrder from to
- 486 Change ThreadSafety of PropertyOrder from ReadOnly to ReadSafe
- 464 Add PropertyOrder
ScriptContext
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
History 6
- 731 Change Default of ScriptContext from to
- 726 Change Default of ScriptContext from to
- 553 Change Default of ScriptContext from to
- 486 Change ThreadSafety of ScriptContext from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ScriptContext from to ReadOnly
- 324 Add ScriptContext
ServerOnly
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
History 6
- 731 Change Default of ServerOnly from to
- 726 Change Default of ServerOnly from to
- 553 Change Default of ServerOnly from to
- 486 Change ThreadSafety of ServerOnly from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ServerOnly from to ReadOnly
- 366 Add ServerOnly
SliderScaling
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
History 4
- 731 Change Default of SliderScaling from to
- 726 Change Default of SliderScaling from to
- 553 Change Default of SliderScaling from to
- 525 Add SliderScaling
UIMaximum
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
UIMinimum
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
UINumTicks
| Type | Default | |
|---|---|---|
| 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.
| Thread safety | ReadSafe |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |
History 6
- 731 Change Default of UINumTicks from to
- 726 Change Default of UINumTicks from to
- 553 Change Default of UINumTicks from to
- 486 Change ThreadSafety of UINumTicks from ReadOnly to ReadSafe
- 462 Change ThreadSafety of UINumTicks from to ReadOnly
- 253 Add UINumTicks
Removed members 2
Preliminary
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 4
- 79 Remove Preliminary
- 78 Add Preliminary
- 79 Remove Preliminary
- 47 Add Preliminary
summary
| Type | Default | |
|---|---|---|
| string | ||
| Thread safety | ReadOnly |
|---|---|
| Category | Reflection |
| Loaded/Saved | true |