update Open Source Docs from Roblox internal teams

Roblox · Mar 5, 2025 · f985bc5 · f985bc5
1 parent 62b098d
commit f985bc5
Show file tree

Hide file tree

Showing 54 changed files with 295 additions and 451 deletions.
diff --git a/content/en-us/assets/engine-api/classes/Camera/DeviceSafeAreaVsFullscreen.png b/content/en-us/assets/engine-api/classes/Camera/DeviceSafeAreaVsFullscreen.png
diff --git a/content/en-us/assets/engine-api/classes/Camera/ViewportPointToRayOrigin.png b/content/en-us/assets/engine-api/classes/Camera/ViewportPointToRayOrigin.png
diff --git a/.../en-us/assets/engine-api/classes/GuiBase2d/AbsolutePositionCoordinateSystem.png b/.../en-us/assets/engine-api/classes/GuiBase2d/AbsolutePositionCoordinateSystem.png
diff --git a/content/en-us/assets/engine-api/classes/ScreenGui/ClipToDeviceSafeArea-False.png b/content/en-us/assets/engine-api/classes/ScreenGui/ClipToDeviceSafeArea-False.png
diff --git a/content/en-us/assets/engine-api/classes/ScreenGui/ClipToDeviceSafeArea-True.png b/content/en-us/assets/engine-api/classes/ScreenGui/ClipToDeviceSafeArea-True.png
diff --git a/content/en-us/assets/engine-api/enums/ScreenInsets/CoreUISafeInsets.png b/content/en-us/assets/engine-api/enums/ScreenInsets/CoreUISafeInsets.png
diff --git a/content/en-us/assets/engine-api/enums/ScreenInsets/DeviceSafeInsets.png b/content/en-us/assets/engine-api/enums/ScreenInsets/DeviceSafeInsets.png
diff --git a/content/en-us/assets/engine-api/enums/ScreenInsets/Inset-Regions-All.png b/content/en-us/assets/engine-api/enums/ScreenInsets/Inset-Regions-All.png
diff --git a/content/en-us/assets/engine-api/enums/ScreenInsets/None.png b/content/en-us/assets/engine-api/enums/ScreenInsets/None.png
diff --git a/content/en-us/assets/engine-api/enums/ScreenInsets/Top-Bar-Cutout.png b/content/en-us/assets/engine-api/enums/ScreenInsets/Top-Bar-Cutout.png
diff --git a/content/en-us/assets/engine-api/enums/ScreenInsets/TopbarSafeInsets.png b/content/en-us/assets/engine-api/enums/ScreenInsets/TopbarSafeInsets.png
diff --git a/content/en-us/assets/players/in-experience-text-chat/Chat-NPC.jpg b/content/en-us/assets/players/in-experience-text-chat/Chat-NPC.jpg
diff --git a/content/en-us/assets/players/in-experience-text-chat/Chat-Rich-Text.png b/content/en-us/assets/players/in-experience-text-chat/Chat-Rich-Text.png
diff --git a/content/en-us/assets/players/in-experience-text-chat/Chat-System.jpg b/content/en-us/assets/players/in-experience-text-chat/Chat-System.jpg
diff --git a/content/en-us/assets/players/in-experience-text-chat/Chat-Tag-VIP.png b/content/en-us/assets/players/in-experience-text-chat/Chat-Tag-VIP.png
diff --git a/content/en-us/assets/players/in-experience-text-chat/Chat-User-Name-Colored.png b/content/en-us/assets/players/in-experience-text-chat/Chat-User-Name-Colored.png
diff --git a/content/en-us/assets/players/in-experience-text-chat/Chat-User-Name-Gradient.png b/content/en-us/assets/players/in-experience-text-chat/Chat-User-Name-Gradient.png
diff --git a/content/en-us/assets/players/in-experience-text-chat/Chat-Window-Components.jpg b/content/en-us/assets/players/in-experience-text-chat/Chat-Window-Components.jpg
diff --git a/content/en-us/assets/studio/debugging/Client-Server-Toggle-3D-Client.jpg b/content/en-us/assets/studio/debugging/Client-Server-Toggle-3D-Client.jpg
diff --git a/...nt/en-us/assets/tutorials/creating-hud-meters/Default-Health-Meter-Disabled.png b/...nt/en-us/assets/tutorials/creating-hud-meters/Default-Health-Meter-Disabled.png
diff --git a/content/en-us/assets/tutorials/creating-hud-meters/Default-Health-Meter.png b/content/en-us/assets/tutorials/creating-hud-meters/Default-Health-Meter.png
diff --git a/content/en-us/assets/tutorials/creating-hud-meters/Intro.png b/content/en-us/assets/tutorials/creating-hud-meters/Intro.png
diff --git a/content/en-us/assets/tutorials/creating-hud-meters/Meter-Change-Damage-Effect.mp4 b/content/en-us/assets/tutorials/creating-hud-meters/Meter-Change-Damage-Effect.mp4
diff --git a/content/en-us/assets/tutorials/creating-hud-meters/Meter-Change-Static.mp4 b/content/en-us/assets/tutorials/creating-hud-meters/Meter-Change-Static.mp4
diff --git a/content/en-us/assets/tutorials/creating-hud-meters/Meter-Change-Tweened.mp4 b/content/en-us/assets/tutorials/creating-hud-meters/Meter-Change-Tweened.mp4
diff --git a/content/en-us/assets/tutorials/creating-hud-meters/Meter-CoreUISafeInsets.png b/content/en-us/assets/tutorials/creating-hud-meters/Meter-CoreUISafeInsets.png
diff --git a/content/en-us/assets/tutorials/creating-hud-meters/Meter-DeviceSafeInsets.png b/content/en-us/assets/tutorials/creating-hud-meters/Meter-DeviceSafeInsets.png
diff --git a/content/en-us/assets/tutorials/interactive-ui/Interactive-UI-Final.mp4 b/content/en-us/assets/tutorials/interactive-ui/Interactive-UI-Final.mp4
diff --git a/content/en-us/assets/tutorials/interactive-ui/Intro.png b/content/en-us/assets/tutorials/interactive-ui/Intro.png
diff --git a/content/en-us/assets/ui/misc/Contextual-Button.png b/content/en-us/assets/ui/misc/Contextual-Button.png
diff --git a/content/en-us/assets/ui/misc/Custom-Buttons-Near-Jump.png b/content/en-us/assets/ui/misc/Custom-Buttons-Near-Jump.png
diff --git a/content/en-us/assets/ui/misc/Roblox-Menu-Button.png b/content/en-us/assets/ui/misc/Roblox-Menu-Button.png
diff --git a/content/en-us/assets/ui/misc/Touch-Reserved-Zones.png b/content/en-us/assets/ui/misc/Touch-Reserved-Zones.png
diff --git a/content/en-us/assets/ui/misc/TouchGui-Elements.png b/content/en-us/assets/ui/misc/TouchGui-Elements.png
diff --git a/content/en-us/assets/ui/ui-objects/Frame-Example.jpg b/content/en-us/assets/ui/ui-objects/Frame-Example.jpg
diff --git a/content/en-us/assets/ui/ui-objects/ScreenGui-Example.jpg b/content/en-us/assets/ui/ui-objects/ScreenGui-Example.jpg
diff --git a/content/en-us/assets/ui/ui-objects/ScrollingFrame-Example.jpg b/content/en-us/assets/ui/ui-objects/ScrollingFrame-Example.jpg
diff --git a/content/en-us/assets/ui/ui-objects/TextBox-Example.jpg b/content/en-us/assets/ui/ui-objects/TextBox-Example.jpg
diff --git a/content/en-us/cloud/index.md b/content/en-us/cloud/index.md
@@ -30,4 +30,4 @@ Roblox also offers [webhooks](./webhooks/webhook-notifications.md), which can no
 
 1. Test API calls using tools like [Postman](https://www.postman.com) with [OpenAPI descriptions](./reference/openapi.md) or the [OAuth 2.0 sample app](./auth/oauth2-sample.md).
 1. Review the [resource guides](./guides/index.md) for end-to-end walkthroughs of using certain APIs.
-1. Explore the left navigation for the full list of Open Cloud v1 and v2 resources, [common API patterns](./reference/patterns.md), [types](./reference/types.md), and [error codes](./reference/errors.md).
+1. Explore the left navigation for the full list of Open Cloud v2 and v1 resources, [common API patterns](./reference/patterns.md), [types](./reference/types.md), and [error codes](./reference/errors.md).
diff --git a/content/en-us/cloud/reference/openapi.md b/content/en-us/cloud/reference/openapi.md
@@ -45,15 +45,16 @@ The OpenAPI descriptions for V1 and V2 resources utilitize distinct specificatio
 
 **V2 resource specification extensions**
 
-| Extension                             	| Location         	| Description                                                                                                   	|
-|---------------------------------------	|------------------	|---------------------------------------------------------------------------------------------------------------	|
-| `x-categories`                        	| OpenAPI Object   	| List of strings. All resource categories.                                                                     	|
-| `x-visibility`                        	| Operation Object 	| Boolean. The visibility of the operation.                                                                     	|
-| `x-roblox-docs`                       	| Operation Object 	| Object. Associates an operation with a category and resource.                                                 	|
-| `x-long-running-operation-parameters` 	| Operation Object 	| Object. References the metadata and response for the operation's long running response.                       	|
-| `x-oneOf`                             	| Schema Object    	| Object. Each field contains a list of properties in the schema. Only one of the properties should be present. 	|
-| `x-resource`                          	| Schema Object    	| Boolean. Whether the schema is a resource.                                                                    	|
-| `x-immutable`                         	| Schema Object    	| Boolean. Whether the schema is immutable.                                                                     	|
+| Extension                             | Location         | Description                                                                                                                                                                                    |
+|---------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `x-categories`                        | OpenAPI Object   | List of strings. All resource categories.                                                                                                                                                      |
+| `x-visibility`                        | Operation Object | Boolean. The visibility of the operation.                                                                                                                                                      |
+| `x-roblox-docs`                       | Operation Object | Object. Associates an operation with a category and resource.                                                                                                                                  |
+| `x-long-running-operation-parameters` | Operation Object | Object. References the metadata and response for the operation's long running response.                                                                                                        |
+| `x-aep-resource`                      | Schema Object    | Object. An extension annotating the resource type. Has close compatibility to [AEP-4](https://aep.dev/4/#annotating-resource-types), one of the [API Enhancement Proposals](https://aep.dev/). |
+| `x-oneOf`                             | Schema Object    | Object. Each field contains a list of properties in the schema. Only one of the properties should be present.                                                                                  |
+| `x-resource`                          | Schema Object    | Boolean. Whether the schema is a resource.                                                                                                                                                     |
+| `x-immutable`                         | Schema Object    | Boolean. Whether the schema is immutable.                                                                                                                                                      |
 
 **V1 resource specification extensions**
 

diff --git a/content/en-us/reference/engine/classes/Annotation.yaml b/content/en-us/reference/engine/classes/Annotation.yaml
@@ -10,20 +10,6 @@ inherits:
 tags: []
 deprecation_message: ''
 properties: []
-methods:
-  - name: Annotation:IsThreadParent
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters: []
-    returns:
-      - type: bool
-        summary: ''
-    tags: []
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
+methods: []
 events: []
 callbacks: []
diff --git a/content/en-us/reference/engine/classes/GenerationService.yaml b/content/en-us/reference/engine/classes/GenerationService.yaml
@@ -44,37 +44,6 @@ methods:
     thread_safety: Unsafe
     capabilities: []
     writeCapabilities: []
-  - name: GenerationService:InternalGenerateMeshAsync
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters:
-      - name: inputs
-        type: Dictionary
-        default:
-        summary: ''
-      - name: userId
-        type: int64
-        default:
-        summary: ''
-      - name: options
-        type: Dictionary
-        default:
-        summary: ''
-      - name: intermediateResultCallback
-        type: Function?
-        default:
-        summary: ''
-    returns:
-      - type: Tuple
-        summary: ''
-    tags:
-      - Yields
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
   - name: GenerationService:LoadGeneratedMeshAsync
     summary: ''
     description: ''