Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Configuration

The Configuration object is a container object that is designed to hold value objects to make values used in Tools or any model using Scripts more accessible.

Memory categoryInstances

Member index 0

HistoryMember
No members defined by Configuration.
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
647isA(className: string): bool
647Changed(property: string)

Description

The Configuration object is a container object that is designed to hold value objects to make values used in Tools or any model using Scripts more accessible.

How does the Configuration object work?

The Configuration object is just a container, and does not automatically offer any additional functionality to a Folder.

Configurations should hold value objects (BrickColorValue, NumberValue, IntValue, ObjectValue etc). These value objects should be read by the Script or LocalScript associated with the configuration to determine constants such as damage, speed or color.

For example,

local damage = 10

Becomes:

local configuration = tool:FindFirstChildWhichIsA("Configuration", true)
damage = configuration:FindFirstChild("Damage").Value -- A NumberValue

The Configuration object is intended to be placed inside a BasePart in a Model or Tool. It was originally intended to be used with a tool that provided a GUI interface to edit these properties. However it is more common now for developers to edit these values directly in the Roblox Studio properties window.

Why should I use the Configuration object?

Use of Configurations is optional, but a number of developers chose to use them for the following reasons.

  • Variables held in a Configuration can be found quickly and are in a single place
  • When sharing your work, others can make changes without needing to modify your code
  • Provides a single location for variables read by multiple scripts in more complex games

History 2

Settings