Class
ReflectionMetadataItem
NotCreatable
Acts as abstract properties for generic information about Classes, Members, Enums, and EnumItems.
Acts as abstract properties for generic information about Classes, Members, Enums, and EnumItems.
Properties 16#
Browsableboolean | Whether or not this can be seen in studio.ReadSafe |
ClassCategorystring | Describes the category of this class.ReadSafe |
ClientOnlyboolean | Whether this item is only meaningful on the client.ReadSafe |
Constraintstring | Describes a constraint for a single-argument function whose argument type
is a Object.ClassName.ReadSafe |
Deprecatedboolean | Whether or not this item is deprecated.ReadSafe |
EditingDisabledboolean | Toggles whether this property can be edited from the Properties window.ReadSafe |
EditorTypestring | Names the editor used for this property in the Properties window.ReadSafe |
FFlagstring | Names a setting that controls whether this item is browsable.ReadSafe |
IsBackendboolean | Vague value for showing if this depends on backend stuff.ReadSafe |
PropertyOrderint | The sort position of this property within its category in the Properties window.ReadSafe |
ScriptContextstring | 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.ReadSafe |
ServerOnlyboolean | Whether this item is only meaningful on the server.ReadSafe |
SliderScalingstring | The scaling mode for this property's slider bar in the Properties window.ReadSafe |
UIMaximumdouble | The maximum value of this property. Used with
ReflectionMetadataItem.UIMinimum to control the slider bar of this
property in the Properties window.ReadSafe |
UIMinimumdouble | The minimum value of this property. Used with
ReflectionMetadataItem.UIMaximum to control the slider bar of this
property in the Properties window.ReadSafe |
UINumTicksdouble | The number of potential values the property's slider bar can be set to,
ReflectionMetadataItem.UIMinimum and
ReflectionMetadataItem.UIMaximum.ReadSafe |
Browsable: boolean#
ReadSafe
When this value is true, it means that this property/class can be seen in Studio, e.g. in the explorer.
ClassCategory: string#
ReadSafe
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.
ClientOnly: boolean#
ReadSafe
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.
Constraint: string#
ReadSafe
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. |
Deprecated: boolean#
ReadSafe
When an object is deprecated, it should not be used anymore for new scripts.
EditingDisabled: boolean#
ReadSafe
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.
EditorType: string#
ReadSafe
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.
FFlag: string#
ReadSafe
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.
IsBackend: boolean#
ReadSafe
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.
PropertyOrder: int#
ReadSafe
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.
ScriptContext: string#
ReadSafe
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.
ServerOnly: boolean#
ReadSafe
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.
SliderScaling: string#
ReadSafe
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.
UIMaximum: double#
ReadSafe
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.
UIMinimum: double#
ReadSafe
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.
UINumTicks: double#
ReadSafe
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.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild
Subclasses 4#
ReflectionMetadataClass, ReflectionMetadataEnum, ReflectionMetadataEnumItem, ReflectionMetadataMember