# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72

name: Configuration
type: class
memory_category: Instances
summary: |
  The Configuration object is a container object that is designed to hold value
  objects to make values used in `Class.Tool|Tools` or any model using
  `Class.Script|Scripts` more accessible.
description: |
  The Configuration object is a container object that is designed to hold value
  objects to make values used in `Class.Tool|Tools` or any model using
  `Class.Script|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 `Class.Folder`.

  Configurations should hold value objects (`Class.BrickColorValue`,
  `Class.NumberValue`, `Class.IntValue`, `Class.ObjectValue` etc). These value
  objects should be read by the `Class.Script` or `Class.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 `Class.BasePart` in
  a `Class.Model` or `Class.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
code_samples: []
inherits:
  - Instance
descendants: []
tags: []
deprecation_message: ''
properties: []
methods: []
events: []
callbacks: []