update Open Source Docs from Roblox internal teams

rbx-open-source-docs[bot] · rbx-open-source-docs[bot] · commit 4bede561bb31 · 2025-03-05T23:10:51.000Z
diff --git a/content/common/navigation/engine/reference.yaml b/content/common/navigation/engine/reference.yaml
@@ -265,11 +265,6 @@ navigation:
         type: engineapi
         source: /reference/engine/classes/AudioSearchParams.yaml
         ignoreTranslation: true
-      - title: AudioTextToSpeech
-        path: /reference/engine/classes/AudioTextToSpeech
-        type: engineapi
-        source: /reference/engine/classes/AudioTextToSpeech.yaml
-        ignoreTranslation: true
       - title: AvatarCreationService
         path: /reference/engine/classes/AvatarCreationService
         type: engineapi
diff --git a/content/en-us/cloud/guides/data-store-api-handling.md b/content/en-us/cloud/guides/data-store-api-handling.md
@@ -7,7 +7,7 @@ Before sending requests to Open Cloud APIs for [standard data stores](../../refe
 
 ## Authorization
 
-Like all Open Cloud APIs, data store endpoints require all requests to include the `x-api-key` header, which contains an API key with enough permissions for the request. This requires you to apply the key to the experience and the data store, and the endpoint operation is permitted. If the key is invalid, `403 Unauthorized` is returned. For more information on API keys, see [Manage API keys](api-keys.md).
+Like all Open Cloud APIs, data store endpoints require all requests to include the `x-api-key` header, which contains an API key with enough permissions for the request. This requires you to apply the key to the experience and the data store, and the endpoint operation is permitted. If the key is invalid, `403 Unauthorized` is returned. For more information on API keys, see [Manage API keys](../auth/api-keys.md).
 
 ## Throttling
 
diff --git a/content/en-us/cloud/guides/usage-data-stores.md b/content/en-us/cloud/guides/usage-data-stores.md
@@ -35,7 +35,7 @@ Although Open Cloud APIs are similar to `Class.DataStoreService`, there are a fe
 
 Data stores often store sensitive information, such as user profiles and virtual currency. To maintain security, each Open Cloud API has corresponding required permissions that you must add to your API key, such as the `List Keys` permission for the listing API. If you don't add the required permissions, your API call returns an error. For the specific permissions that are required for each operation, see the API reference of [standard](../../reference/cloud/datastores-api/v1.json) and [ordered data stores](../../reference/cloud/datastores-api/ordered-v1.json).
 
-When [configuring your API keys](./api-keys.md#create-an-api-key), you can set granular permissions, such as read, write, and list entry, for each data store within a specific experience, or you can give a key to read or write all data stores within an experience. You can also limit access to a subset of data stores needed for your tool instead of exposing all data stores. This mitigates the impact in case your key gets leaked.
+When [configuring your API keys](../auth/api-keys.md#create-an-api-key), you can set granular permissions, such as read, write, and list entry, for each data store within a specific experience, or you can give a key to read or write all data stores within an experience. You can also limit access to a subset of data stores needed for your tool instead of exposing all data stores. This mitigates the impact in case your key gets leaked.
 
 ## Build tools
 
@@ -57,7 +57,7 @@ From a high level, you can build your Python app by adding API key permissions a
 
 #### Add API key permissions for data stores
 
-When [creating an API Key](./api-keys.md) for this example, make sure you perform the following settings:
+When [creating an API Key](../auth/api-keys.md) for this example, make sure you perform the following settings:
 
 1. From the **Select API System** menu in the **Access Permissions** section, select **universe-datastores**.
 
@@ -74,7 +74,7 @@ When [creating an API Key](./api-keys.md) for this example, make sure you perfor
       You don't need the `create entries` API key permission since the app doesn't create new user inventories.
       </Alert>
 
-1. In the **Security** section, explicitly set IP access to the key using [CIDR notation](./api-keys.md#cidr-format), and set an explicit expiration date so your key automatically stops working after that date. For this example, if you plan to do local testing first, you can remove the IP restriction by setting it to **0.0.0.0/0** and let it expire in **30 days**.
+1. In the **Security** section, explicitly set IP access to the key using [CIDR notation](../auth/api-keys.md#cidr-format), and set an explicit expiration date so your key automatically stops working after that date. For this example, if you plan to do local testing first, you can remove the IP restriction by setting it to **0.0.0.0/0** and let it expire in **30 days**.
 
 #### Add scripts for the user inventory support portal
 
@@ -300,7 +300,7 @@ The example app requires four methods to achieve its functionalities: [`List`](.
 - **Read** for the `list` method.
 - **Write** for `Create`, `Update`, and `Increment` methods.
 
-When [creating an API Key](./api-keys.md) for this example, make sure you perform the following operations:
+When [creating an API Key](../auth/api-keys.md) for this example, make sure you perform the following operations:
 
 1. From the **Select API System** menu in the **Access Permissions** section, select **Ordered Data Stores**.
 
@@ -309,7 +309,7 @@ When [creating an API Key](./api-keys.md) for this example, make sure you perfor
    1. Click the **Select Experience to Add** dropdown and select the target experience.
    2. In the **Experience Operations**, expand the dropdown to select **Read** and **Write** operations.
 
-1. In the **Security** section, explicitly set IP access to the key using [CIDR notation](./api-keys.md#cidr-format), and set an explicit expiration date so your key automatically stops working after that date. For this example, if you plan to do local testing first, you can remove the IP restriction by setting it to **0.0.0.0/0** and let it expire in **30 days**.
+1. In the **Security** section, explicitly set IP access to the key using [CIDR notation](../auth/api-keys.md#cidr-format), and set an explicit expiration date so your key automatically stops working after that date. For this example, if you plan to do local testing first, you can remove the IP restriction by setting it to **0.0.0.0/0** and let it expire in **30 days**.
 
 #### Add scripts for the leaderboard
 
diff --git a/content/en-us/cloud/guides/usage-place-publishing.md b/content/en-us/cloud/guides/usage-place-publishing.md
@@ -20,7 +20,7 @@ Before you can update an existing place of an experience, you need the place's *
 
 To publish an existing place of an experience with [Place Publishing API](../../reference/cloud/universes-api/v1.json):
 
-1. [Create an API key](./api-keys.md#create-an-API-key) on the **Creator Dashboard**. Make sure you perform the following settings:
+1. [Create an API key](../auth/api-keys.md#create-api-keys) on the **Creator Dashboard**. Make sure you perform the following settings:
 
    1. Add **universe-places** to **Access Permissions**.
    1. Add **Write** operation to your selected experience.
diff --git a/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml b/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml
diff --git a/content/en-us/reference/engine/classes/AvatarCreationService.yaml b/content/en-us/reference/engine/classes/AvatarCreationService.yaml
@@ -269,6 +269,25 @@ methods:
     thread_safety: Unsafe
     capabilities: []
     writeCapabilities: []
+  - name: AvatarCreationService:PrepareAvatarForPreviewAsync
+    summary: ''
+    description: ''
+    code_samples: []
+    parameters:
+      - name: humanoidModel
+        type: Model
+        default:
+        summary: ''
+    returns:
+      - type: void
+        summary: ''
+    tags:
+      - Yields
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities: []
+    writeCapabilities: []
   - name: AvatarCreationService:PromptCreateAvatarAsync
     summary: |
       Prompts a `Class.Player` to purchase and create an avatar from a
@@ -494,5 +513,24 @@ methods:
     thread_safety: Unsafe
     capabilities: []
     writeCapabilities: []
-events: []
+events:
+  - name: AvatarCreationService.AvatarModerationCompleted
+    summary: ''
+    description: ''
+    code_samples: []
+    parameters:
+      - name: outfitId
+        type: int64
+        default:
+        summary: ''
+      - name: moderationStatus
+        type: ModerationStatus
+        default:
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities: []
+    writeCapabilities: []
 callbacks: []
diff --git a/content/en-us/reference/engine/classes/GuiObject.yaml b/content/en-us/reference/engine/classes/GuiObject.yaml
@@ -784,6 +784,27 @@ properties:
     capabilities:
       - UI
     writeCapabilities: []
+  - name: GuiObject.SelectionRect2D
+    summary: ''
+    description: ''
+    code_samples: []
+    type: Rect
+    tags:
+      - Hidden
+      - ReadOnly
+      - NotReplicated
+    deprecation_message: ''
+    security:
+      read: RobloxScriptSecurity
+      write: RobloxScriptSecurity
+    thread_safety: Unsafe
+    category: Data
+    serialization:
+      can_load: false
+      can_save: false
+    capabilities:
+      - UI
+    writeCapabilities: []
   - name: GuiObject.Size
     summary: |
       Determines the pixel and scalar size of the `Class.GuiObject`.
diff --git a/content/en-us/reference/engine/classes/InputAction.yaml b/content/en-us/reference/engine/classes/InputAction.yaml
@@ -22,7 +22,7 @@ properties:
       read: None
       write: None
     thread_safety: ReadSafe
-    category: Data
+    category: Behavior
     serialization:
       can_load: true
       can_save: true
@@ -39,7 +39,7 @@ properties:
       read: None
       write: None
     thread_safety: ReadSafe
-    category: Data
+    category: Behavior
     serialization:
       can_load: true
       can_save: true
diff --git a/content/en-us/reference/engine/classes/InputBinding.yaml b/content/en-us/reference/engine/classes/InputBinding.yaml
@@ -22,7 +22,7 @@ properties:
       read: None
       write: None
     thread_safety: ReadSafe
-    category: Data
+    category: Behavior
     serialization:
       can_load: true
       can_save: true
@@ -39,7 +39,7 @@ properties:
       read: None
       write: None
     thread_safety: ReadSafe
-    category: Data
+    category: Behavior
     serialization:
       can_load: true
       can_save: true
diff --git a/content/en-us/reference/engine/classes/InputContext.yaml b/content/en-us/reference/engine/classes/InputContext.yaml
@@ -22,7 +22,7 @@ properties:
       read: None
       write: None
     thread_safety: ReadSafe
-    category: Data
+    category: Behavior
     serialization:
       can_load: true
       can_save: true
@@ -39,7 +39,7 @@ properties:
       read: None
       write: None
     thread_safety: ReadSafe
-    category: Data
+    category: Behavior
     serialization:
       can_load: true
       can_save: true
@@ -56,7 +56,7 @@ properties:
       read: None
       write: None
     thread_safety: ReadSafe
-    category: Data
+    category: Behavior
     serialization:
       can_load: true
       can_save: true
diff --git a/content/en-us/reference/engine/classes/Instance.yaml b/content/en-us/reference/engine/classes/Instance.yaml
@@ -8,7 +8,7 @@ summary: |
 description: |
   `Instance` is the base class for all classes in the Roblox class hierarchy
   which can be part of the `Class.DataModel` tree.
-  
+
   It is not possible to directly create root `Instance` objects, but the special
   `Datatype.Instance.new()` constructor creates objects via code, taking the
   name of the class as a parameter and returning the created object.
@@ -65,8 +65,9 @@ properties:
       instance. For the capabilities to take effect, `Class.Instance.Sandboxed`
       property must be enabled.
 
-      This property is used by an experimental feature. See [script
-      capabilities](../../../scripting/capabilities.md) for further details.
+      This property is used by an experimental feature. See
+      [script capabilities](../../../scripting/capabilities.md) for further
+      details.
     code_samples: []
     type: SecurityCapabilities
     tags: []
@@ -140,13 +141,13 @@ properties:
       about how this property is set:
 
       - An object is a **child** of, or is **parented to**, another object when
-      its `Parent` is set to that object.
+        its `Parent` is set to that object.
 
       - The **descendants** of an `Class.Instance` are the children of that
-      object, plus the descendants of the children as well.
+        object, plus the descendants of the children as well.
 
       - The **ancestors** of an `Class.Instance` are all the objects that the
-      instance is a descendant of.
+        instance is a descendant of.
 
       It is from the `Parent` property that many other API members get their
       name, such as `Class.Instance:GetChildren()|GetChildren()` and
@@ -169,9 +170,9 @@ properties:
 
       An object created by the server will not replicate to clients until it is
       parented to some object that is replicated. When creating an object and
-      setting many properties, it's recommended to set the `Parent` property **last**. This
-      ensures the object replicates once, instead of replicating many property
-      changes.
+      setting many properties, it's recommended to set the `Parent` property
+      **last**. This ensures the object replicates once, instead of replicating
+      many property changes.
 
       ```lua
       local Workspace = game:GetService("Workspace")
@@ -229,8 +230,9 @@ properties:
     description: |
       Turns the instance to be a **sandboxed container**, an experimental
       feature which limits the actions that scripts inside a particular
-      container can perform. See [script
-      capabilities](../../../scripting/capabilities.md) for further details.
+      container can perform. See
+      [script capabilities](../../../scripting/capabilities.md) for further
+      details.
     code_samples: []
     type: bool
     tags:
@@ -856,8 +858,7 @@ methods:
       attribute name return the same event.
 
       The following code example returns a signal that fires the function
-      `attributeChanged()` when the part's `InitialPosition` attribute
-      changes:
+      `attributeChanged()` when the part's `InitialPosition` attribute changes:
 
       ```lua
       local Workspace = game:GetService("Workspace")
@@ -982,7 +983,8 @@ methods:
     summary: |
       Returns a coded string of the debug ID used internally by Roblox.
     description: |
-      Returns a coded string of the debug ID used internally by Roblox. Note that:
+      Returns a coded string of the debug ID used internally by Roblox. Note
+      that:
 
       - This item is protected. Attempting to use it in a `Class.Script` or
         `Class.LocalScript` will cause an error.
@@ -1212,7 +1214,8 @@ methods:
     writeCapabilities: []
   - name: Instance:IsPropertyModified
     summary: |
-      Returns `true` if the value stored in the specified property is non-default.
+      Returns `true` if the value stored in the specified property is
+      non-default.
     description: |
       Returns `true` if the value stored in the specified property is
       non‑default. For example, if outputting the
@@ -1242,8 +1245,8 @@ methods:
       Sets the object's `Parent` to `nil`, and does the same for all its
       descendants.
     description: |
-      This function sets the object's `Class.Instance.Parent` to `nil`, and
-      does the same for all its descendants.
+      This function sets the object's `Class.Instance.Parent` to `nil`, and does
+      the same for all its descendants.
 
       If the object is referenced before being removed, it is possible to
       retrieve the object at a later point.
@@ -1297,7 +1300,8 @@ methods:
     description: |
       Resets a property to its default value. For example, calling
       `ResetPropertyToDefault("Rotation")` on a `Class.TextLabel` is equivalent
-      to setting its `Class.TextLabel.Rotation|Rotation` to `0` (the property's default value).
+      to setting its `Class.TextLabel.Rotation|Rotation` to `0` (the property's
+      default value).
     code_samples: []
     parameters:
       - name: name
@@ -1712,8 +1716,7 @@ events:
     summary: |
       Fires after a descendant is added to the `Class.Instance`.
     description: |
-      This event fires after a descendant is added to the
-      `Class.Instance`.
+      This event fires after a descendant is added to the `Class.Instance`.
 
       As it fires for every descendant, parenting an object to the
       `Class.Instance` will fire the event for this object and all of its
diff --git a/content/en-us/reference/engine/classes/Player.yaml b/content/en-us/reference/engine/classes/Player.yaml
diff --git a/content/en-us/reference/engine/classes/Plugin.yaml b/content/en-us/reference/engine/classes/Plugin.yaml
diff --git a/content/en-us/reference/engine/classes/RunService.yaml b/content/en-us/reference/engine/classes/RunService.yaml
diff --git a/content/en-us/reference/engine/classes/VirtualInputManager.yaml b/content/en-us/reference/engine/classes/VirtualInputManager.yaml
