update Open Source Docs from Roblox internal teams

Roblox · Feb 6, 2025 · f69638d · f69638d
1 parent 0410df7
commit f69638d
Show file tree

Hide file tree

Showing 21 changed files with 38 additions and 853 deletions.
diff --git a/content/en-us/reference/cloud/cloud.docs.json b/content/en-us/reference/cloud/cloud.docs.json
@@ -6173,6 +6173,13 @@
           "privateServerDetails": {
             "$ref": "#/components/schemas/InventoryItem_PrivateServerDetails",
             "description": "Populated if this item is a private server."
+          },
+          "addTime": {
+            "readOnly": true,
+            "example": "2023-07-05T12:34:56Z",
+            "type": "string",
+            "description": "The time when the item was added to the user's inventory. For example, the time when the user purchased a private server or was awarded a badge. \n\n This field is currently not populated for passes.",
+            "format": "date-time"
           }
         },
         "description": "Represents an item in a user's inventory.",

diff --git a/content/en-us/reference/engine/classes/AdService.yaml b/content/en-us/reference/engine/classes/AdService.yaml
@@ -37,58 +37,6 @@ methods:
     thread_safety: Unsafe
     capabilities: []
     writeCapabilities: []
-  - name: AdService:HandleWhyThisAdClicked
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters:
-      - name: advertiserName
-        type: string
-        default:
-        summary: ''
-      - name: payerName
-        type: string
-        default:
-        summary: ''
-    returns:
-      - type: void
-        summary: ''
-    tags: []
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
-  - name: AdService:OnDemandVideoCompleteFromUI
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters:
-      - name: result
-        type: ShowAdResult
-        default:
-        summary: ''
-      - name: encryptedAdTrackingData
-        type: string
-        default:
-        summary: ''
-      - name: encryptionMetadata
-        type: string
-        default:
-        summary: ''
-      - name: rewardDetails
-        type: string
-        default:
-        summary: ''
-    returns:
-      - type: void
-        summary: ''
-    tags: []
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
   - name: AdService:ShowVideoAd
     summary: |
       Show mobile video advertisements.
@@ -173,22 +121,4 @@ events:
     thread_safety: Unsafe
     capabilities: []
     writeCapabilities: []
-callbacks:
-  - name: AdService.onDemandVideoPlayInUI
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters:
-      - name: data
-        type: Dictionary
-        default:
-        summary: ''
-    returns:
-      - type: VideoFrame
-        summary: ''
-    tags: []
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
+callbacks: []
diff --git a/content/en-us/reference/engine/classes/AudioEcho.yaml b/content/en-us/reference/engine/classes/AudioEcho.yaml
@@ -160,20 +160,6 @@ methods:
     thread_safety: Unsafe
     capabilities: []
     writeCapabilities: []
-  - name: AudioEcho:Reset
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters: []
-    returns:
-      - type: void
-        summary: ''
-    tags: []
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
 events:
   - name: AudioEcho.WiringChanged
     summary: |

diff --git a/content/en-us/reference/engine/classes/AudioListener.yaml b/content/en-us/reference/engine/classes/AudioListener.yaml
@@ -202,20 +202,6 @@ methods:
     thread_safety: Unsafe
     capabilities: []
     writeCapabilities: []
-  - name: AudioListener:Reset
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters: []
-    returns:
-      - type: void
-        summary: ''
-    tags: []
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
   - name: AudioListener:SetAngleAttenuation
     summary: |
       Sets the angle attenuation curve that the `Class.AudioListener` should

diff --git a/content/en-us/reference/engine/classes/AudioPlayer.yaml b/content/en-us/reference/engine/classes/AudioPlayer.yaml
@@ -14,6 +14,24 @@ inherits:
 tags: []
 deprecation_message: ''
 properties:
+  - name: AudioPlayer.Asset
+    summary: ''
+    description: ''
+    code_samples: []
+    type: ContentId
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Asset
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Audio
+    writeCapabilities: []
   - name: AudioPlayer.AssetId
     summary: |
       The asset to be loaded into the `Class.AudioPlayer`.

diff --git a/content/en-us/reference/engine/classes/AudioReverb.yaml b/content/en-us/reference/engine/classes/AudioReverb.yaml
@@ -317,20 +317,6 @@ methods:
     thread_safety: Unsafe
     capabilities: []
     writeCapabilities: []
-  - name: AudioReverb:Reset
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters: []
-    returns:
-      - type: void
-        summary: ''
-    tags: []
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
 events:
   - name: AudioReverb.WiringChanged
     summary: |

diff --git a/content/en-us/reference/engine/classes/BugReporterService.yaml b/content/en-us/reference/engine/classes/BugReporterService.yaml
diff --git a/content/en-us/reference/engine/classes/Chat.yaml b/content/en-us/reference/engine/classes/Chat.yaml
@@ -50,25 +50,6 @@ properties:
       can_save: true
     capabilities: []
     writeCapabilities: []
-  - name: Chat.IsAutoMigrated
-    summary: ''
-    description: ''
-    code_samples: []
-    type: bool
-    tags:
-      - Hidden
-      - NotReplicated
-    deprecation_message: ''
-    security:
-      read: RobloxScriptSecurity
-      write: RobloxScriptSecurity
-    thread_safety: ReadSafe
-    category: Data
-    serialization:
-      can_load: true
-      can_save: true
-    capabilities: []
-    writeCapabilities: []
   - name: Chat.LoadDefaultChat
     summary: |
       Toggles whether the default chat framework should be automatically loaded

diff --git a/content/en-us/reference/engine/classes/CreatorStoreService.yaml b/content/en-us/reference/engine/classes/CreatorStoreService.yaml
@@ -12,29 +12,6 @@ tags:
   - Service
 deprecation_message: ''
 properties: []
-methods:
-  - name: CreatorStoreService:PerformCreatorStorePurchase
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters:
-      - name: productTargetId
-        type: int64
-        default:
-        summary: ''
-      - name: assetType
-        type: string
-        default:
-        summary: ''
-    returns:
-      - type: Dictionary
-        summary: ''
-    tags:
-      - Yields
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
+methods: []
 events: []
 callbacks: []
diff --git a/...erence/engine/classes/StylingService.yaml → ...ne/classes/FeatureRestrictionManager.yaml b/...erence/engine/classes/StylingService.yaml → ...ne/classes/FeatureRestrictionManager.yaml
@@ -1,7 +1,7 @@
-name: StylingService
+name: FeatureRestrictionManager
 type: class
 category:
-memory_category: Gui
+memory_category: Instances
 summary: ''
 description: ''
 code_samples: []
@@ -10,7 +10,6 @@ inherits:
 tags:
   - NotCreatable
   - Service
-  - NotReplicated
 deprecation_message: ''
 properties: []
 methods: []

diff --git a/content/en-us/reference/engine/classes/GlobalSettings.yaml b/content/en-us/reference/engine/classes/GlobalSettings.yaml
@@ -46,34 +46,6 @@ methods:
     thread_safety: Unsafe
     capabilities: []
     writeCapabilities: []
-  - name: GlobalSettings:GetFFlagOverrides
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters: []
-    returns:
-      - type: string
-        summary: ''
-    tags: []
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
-  - name: GlobalSettings:GetFFlags
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters: []
-    returns:
-      - type: string
-        summary: ''
-    tags: []
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
   - name: GlobalSettings:GetFVariable
     summary: |
       Returns the value of an FVariable, if it exists.
@@ -94,23 +66,5 @@ methods:
     thread_safety: Unsafe
     capabilities: []
     writeCapabilities: []
-  - name: GlobalSettings:SetFFlagOverrides
-    summary: ''
-    description: ''
-    code_samples: []
-    parameters:
-      - name: overrides
-        type: string
-        default:
-        summary: ''
-    returns:
-      - type: bool
-        summary: ''
-    tags: []
-    deprecation_message: ''
-    security: RobloxScriptSecurity
-    thread_safety: Unsafe
-    capabilities: []
-    writeCapabilities: []
 events: []
 callbacks: []