Skip to content

Commit b1b75b4

Browse files
update Open Source Docs from Roblox internal teams
1 parent dbe85bb commit b1b75b4

37 files changed

+313
-768
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,11 @@ navigation:
215215
type: engineapi
216216
source: /reference/engine/classes/AudioFlanger.yaml
217217
ignoreTranslation: true
218+
- title: AudioLimiter
219+
path: /reference/engine/classes/AudioLimiter
220+
type: engineapi
221+
source: /reference/engine/classes/AudioLimiter.yaml
222+
ignoreTranslation: true
218223
- title: AudioListener
219224
path: /reference/engine/classes/AudioListener
220225
type: engineapi
@@ -860,11 +865,6 @@ navigation:
860865
type: engineapi
861866
source: /reference/engine/classes/EditableMesh.yaml
862867
ignoreTranslation: true
863-
- title: EditableService
864-
path: /reference/engine/classes/EditableService
865-
type: engineapi
866-
source: /reference/engine/classes/EditableService.yaml
867-
ignoreTranslation: true
868868
- title: EmotesPages
869869
path: /reference/engine/classes/EmotesPages
870870
type: engineapi
@@ -2355,11 +2355,6 @@ navigation:
23552355
type: engineapi
23562356
source: /reference/engine/classes/StarterPlayerScripts.yaml
23572357
ignoreTranslation: true
2358-
- title: StartPageService
2359-
path: /reference/engine/classes/StartPageService
2360-
type: engineapi
2361-
source: /reference/engine/classes/StartPageService.yaml
2362-
ignoreTranslation: true
23632358
- title: StartupMessageService
23642359
path: /reference/engine/classes/StartupMessageService
23652360
type: engineapi
@@ -3678,6 +3673,11 @@ navigation:
36783673
type: engineapi
36793674
source: /reference/engine/enums/ConnectionState.yaml
36803675
ignoreTranslation: true
3676+
- title: ContentSourceType
3677+
path: /reference/engine/enums/ContentSourceType
3678+
type: engineapi
3679+
source: /reference/engine/enums/ContentSourceType.yaml
3680+
ignoreTranslation: true
36813681
- title: ContextActionPriority
36823682
path: /reference/engine/enums/ContextActionPriority
36833683
type: engineapi
@@ -4713,6 +4713,11 @@ navigation:
47134713
type: engineapi
47144714
source: /reference/engine/enums/RollOffMode.yaml
47154715
ignoreTranslation: true
4716+
- title: RolloutState
4717+
path: /reference/engine/enums/RolloutState
4718+
type: engineapi
4719+
source: /reference/engine/enums/RolloutState.yaml
4720+
ignoreTranslation: true
47164721
- title: RotationOrder
47174722
path: /reference/engine/enums/RotationOrder
47184723
type: engineapi

content/en-us/art/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ Whether you're just getting started with Roblox or need a quick refresher, use t
5454
<Typography variant='h4'>Creating Avatar Items</Typography>
5555
<Typography variant='body1' >Create accessories, clothing, and bodies that you can sell on the Marketplace.</Typography>
5656
<a href="../avatar/index.md"><Typography variant='h6' style={{marginBottom: 12}}>Overview</Typography></a>
57-
<a href="./marketplace/index.md"><Typography variant='h6' style={{marginBottom: 12}}>Marketplace Overview</Typography></a>
58-
<a href="./marketplace/marketplace-fees-and-commissions.md"><Typography variant='h6' style={{marginBottom: 12}}>Fees and Commissions</Typography></a>
57+
<a href="../marketplace/index.md"><Typography variant='h6' style={{marginBottom: 12}}>Marketplace Overview</Typography></a>
58+
<a href="../marketplace/marketplace-fees-and-commissions.md"><Typography variant='h6' style={{marginBottom: 12}}>Fees and Commissions</Typography></a>
5959

6060
</Grid>
6161
</Grid>
@@ -249,7 +249,7 @@ The following is a list of common 3D art resources ordered by subject, as well a
249249
<a href="../avatar/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Getting Started with Avatar Items</Typography></a>
250250
<a href="../tutorials/first-experience/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Creating Your First Experience</Typography></a>
251251
<a href="../production/creator-store.md"><Typography variant='body1' style={{marginBottom: 12}}>Creator Store Overview</Typography></a>
252-
<a href="./marketplace/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Overview</Typography></a>
252+
<a href="../marketplace/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Overview</Typography></a>
253253
</Grid>
254254
</Grid>
255255

@@ -298,7 +298,7 @@ The following is a list of common 3D art resources ordered by subject, as well a
298298
<a href="./accessories/specifications.md"><Typography variant='body1' style={{marginBottom: 12}}>Accessory Specifications</Typography></a>
299299
<a href="./accessories/clothing-specifications.md"><Typography variant='body1' style={{marginBottom: 12}}>Clothing Specifications</Typography></a>
300300
<a href="./characters/specifications.md"><Typography variant='body1' style={{marginBottom: 12}}>Avatar Character Specifications</Typography></a>
301-
<a href="./marketplace/marketplace-policy.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Policy</Typography></a>
301+
<a href="../marketplace/marketplace-policy.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Policy</Typography></a>
302302

303303
</Grid>
304304
</Grid>
@@ -383,7 +383,7 @@ The following is a list of common 3D art resources ordered by subject, as well a
383383
<a href="./accessories/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Accessories Overview</Typography></a>
384384
<a href="./accessories/layered-clothing.md"><Typography variant='body1' style={{marginBottom: 12}}>Clothing Overview</Typography></a>
385385
<a href="./characters/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Character Bodies Overview</Typography></a>
386-
<a href="./marketplace/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Overview</Typography></a>
386+
<a href="../marketplace/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Overview</Typography></a>
387387

388388
</Grid>
389389
</Grid>
@@ -434,10 +434,10 @@ The following is a list of common 3D art resources ordered by subject, as well a
434434
<Typography variant='h5'>Publishing to Creator Store and Marketplace</Typography>
435435

436436
<a href="../production/creator-store.md"><Typography variant='body1' style={{marginBottom: 12}}>Creator Store Overview</Typography></a>
437-
<a href="./marketplace/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Overview</Typography></a>
438-
<a href="./marketplace/marketplace-policy.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Policy</Typography></a>
439-
<a href="./marketplace/publishing-to-marketplace.md"><Typography variant='body1' style={{marginBottom: 12}}>Publishing Avatar Items to Marketplace</Typography></a>
440-
<a href="./marketplace/marketplace-fees-and-commissions.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Fees and Commissions</Typography></a>
437+
<a href="../marketplace/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Overview</Typography></a>
438+
<a href="../marketplace/marketplace-policy.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Policy</Typography></a>
439+
<a href="../marketplace/publishing-to-marketplace.md"><Typography variant='body1' style={{marginBottom: 12}}>Publishing Avatar Items to Marketplace</Typography></a>
440+
<a href="../marketplace/marketplace-fees-and-commissions.md"><Typography variant='body1' style={{marginBottom: 12}}>Marketplace Fees and Commissions</Typography></a>
441441

442442
</Grid>
443443
</Grid>

content/en-us/art/overview-studio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ You can see a complete list of the many [Roblox-created assets on the Creator St
146146

147147
The **Marketplace** is where all Roblox users can purchase virtual cosmetics, such as accessories and clothing, and various character bodies that they can save to their Roblox account and set as their Roblox avatar character.
148148

149-
To sell assets on the Marketplace, your creation must follow specific avatar specifications and meet certain policies and guidelines. For more information, see [Avatar](../avatar/index.md) and [Marketplace](./marketplace/index.md).
149+
To sell assets on the Marketplace, your creation must follow specific avatar specifications and meet certain policies and guidelines. For more information, see [Avatar](../avatar/index.md) and [Marketplace](../marketplace/index.md).
150150

151151
## 3D Modeling
152152

content/en-us/cloud-services/data-stores/best-practices.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,10 @@ Data stores have similar behavior to tables in databases. When you minimize the
1111

1212
### Use a Single Object for Related Data
1313

14-
To use the maximum [4 MB object size limit](../../cloud-services/data-stores/error-codes-and-limits.md/#throughput-limits) more efficiently, fetch all relevant data in one call. `Class.GlobalDataStore:SetAsync()|SetAsync()` updates all data so that all data for the same user is always in sync.
14+
To use the maximum [4 MB object size limit](../../cloud-services/data-stores/error-codes-and-limits.md#throughput-limits) more efficiently, fetch all relevant data in one call. `Class.GlobalDataStore:SetAsync()|SetAsync()` updates all data so that all data for the same user is always in sync.
1515

1616
The versioning system versions individual objects instead of the entire data store. This means self-contained objects are consistent when you restore data stores to older versions.
1717

1818
### Use Key Prefixes to Organize Your Data
1919

20-
Filter keys with a specific [prefix](./managing-data-stores.md/#listing-and-prefixes) when calling `Class.DataStore:ListKeysAsync()|ListKeysAsync()`. For example, you can save keys with a prefix like `/User_1234/profiles/warrior` and `/User_1234/profiles/mage` in experiences that support users with multiple character profiles. You can then use a prefix search with `/User_1234/profiles` to get a list of all profiles belonging to that user.
21-
22-
../../production/monetization/randomized-virtual-items-policy.md
20+
Filter keys with a specific [prefix](./managing-data-stores.md#listing-and-prefixes) when calling `Class.DataStore:ListKeysAsync()|ListKeysAsync()`. For example, you can save keys with a prefix like `/User_1234/profiles/warrior` and `/User_1234/profiles/mage` in experiences that support users with multiple character profiles. You can then use a prefix search with `/User_1234/profiles` to get a list of all profiles belonging to that user.

content/en-us/cloud-services/data-stores/error-codes-and-limits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ Each server is allowed a certain number of data store requests based on the requ
359359

360360
Data stores limit how much data can be used per entry.
361361

362-
The data store name, key name, and [scope](../../cloud-services/data-stores/managing-data-stores.md/Scopes) must all be under a certain character length. Use `Library.string.len()` to check their length.
362+
The data store name, key name, and [scope](../../cloud-services/data-stores/managing-data-stores.md#scopes) must all be under a certain character length. Use `Library.string.len()` to check their length.
363363

364364
The data (key value) is also stored as a string, regardless of its initial type. You can check the size of the data with the `Class.HttpService:JSONEncode()|JSONEncode()` function, which converts Lua data into a serialized JSON table.
365365

content/en-us/cloud-services/data-stores/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ end
158158
```
159159

160160
<Alert severity="warning">
161-
The values you retrieve using `Class.GlobalDataStore:GetAsync()|GetAsync()` sometimes can be out of sync with the backend due to the [caching](../../cloud-services/data-stores/managing-data-stores.md/#caching) behavior. For more information, see [Disabling Caching](../../cloud-services/data-stores/managing-data-stores.md/#disabling-caching).
161+
The values you retrieve using `Class.GlobalDataStore:GetAsync()|GetAsync()` sometimes can be out of sync with the backend due to the [caching](../../cloud-services/data-stores/managing-data-stores.md#caching) behavior. For more information, see [Disabling Caching](../../cloud-services/data-stores/managing-data-stores.md#disabling-caching).
162162
</Alert>
163163

164164
## Incrementing Data
@@ -198,7 +198,7 @@ end
198198
## Metadata
199199

200200
<Alert severity="info">
201-
Ordered data stores don't support [versioning and metadata](../../cloud-services/data-stores/managing-data-stores.md/#versioning), so `Class.DataStoreKeyInfo|DataStoreKeyInfo` is always `nil` for keys in an `Class.OrderedDataStore|OrderedDataStore`. If you need to support versioning and metadata, use `Class.DataStore|DataStore`.
201+
Ordered data stores don't support [versioning and metadata](../../cloud-services/data-stores/managing-data-stores.md#versioning), so `Class.DataStoreKeyInfo|DataStoreKeyInfo` is always `nil` for keys in an `Class.OrderedDataStore|OrderedDataStore`. If you need to support versioning and metadata, use `Class.DataStore|DataStore`.
202202
</Alert>
203203

204204
There are two types of metadata associated with keys:
@@ -286,7 +286,7 @@ To manage metadata, expand the `Class.GlobalDataStore:SetAsync()|SetAsync()`, `C
286286
When calling `Class.GlobalDataStore:SetAsync()|SetAsync()`, `Class.GlobalDataStore:IncrementAsync()|IncrementAsync()`, and `Class.GlobalDataStore:UpdateAsync()|UpdateAsync()`, you must always update metadata definitions with a value, even when there are no changes to the current value. If you don't, you lose the current value.
287287
</Alert>
288288

289-
For limits when defining metadata, see [Metadata Limits](../../cloud-services/data-stores/error-codes-and-limits.md/#metadata-limits).
289+
For limits when defining metadata, see [Metadata Limits](../../cloud-services/data-stores/error-codes-and-limits.md#metadata-limits).
290290

291291
## Ordered Data Stores
292292

content/en-us/cloud-services/data-stores/managing-data-stores.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ Caching applies to modifications you make to data store keys using:
222222

223223
`Class.DataStore:GetVersionAsync()|GetVersionAsync()`, `Class.DataStore:ListVersionsAsync()|ListVersionsAsync()`, `Class.DataStore:ListKeysAsync()|ListKeysAsync()`, and `Class.DataStoreService:ListDataStoresAsync()|ListDataStoresAsync()` don't implement caching and always fetch the latest data from the service backend.
224224

225-
By default, the engine uses `Class.GlobalDataStore:GetAsync()|GetAsync()` to store values you retrieve from the backend in a local cache for four seconds. Also by default, `Class.GlobalDataStore:GetAsync()|GetAsync()` requests for cached keys return the cached value instead of continuing to the backend. Your `Class.GlobalDataStore:GetAsync()|GetAsync()` requests that return a cached value don't count towards your [server limits](../../cloud-services/data-stores/error-codes-and-limits.md/#server-limits) and [throughput limits](../../cloud-services/data-stores/error-codes-and-limits.md/#throughput-limits).
225+
By default, the engine uses `Class.GlobalDataStore:GetAsync()|GetAsync()` to store values you retrieve from the backend in a local cache for four seconds. Also by default, `Class.GlobalDataStore:GetAsync()|GetAsync()` requests for cached keys return the cached value instead of continuing to the backend. Your `Class.GlobalDataStore:GetAsync()|GetAsync()` requests that return a cached value don't count towards your [server limits](../../cloud-services/data-stores/error-codes-and-limits.md#server-limits) and [throughput limits](../../cloud-services/data-stores/error-codes-and-limits.md#throughput-limits).
226226

227227
All `Class.GlobalDataStore:GetAsync()|GetAsync()` calls that retrieve a value not being cached from the backend update the cache immediately and restart the four second timer.
228228

@@ -234,4 +234,4 @@ All `Class.GlobalDataStore:GetAsync()|GetAsync()` calls that retrieve a value no
234234

235235
To disable caching and opt out of using the cache to retrieve the most up-to-date value from the servers, add the `Class.DataStoreGetOptions` parameter to your `Class.GlobalDataStore:GetAsync()|GetAsync()` call and set the `Class.DataStoreGetOptions.UseCache|UseCache` property to `false` to make your request ignore any keys in the cache.
236236

237-
Disabling caching is useful if you have multiple servers writing to a key with high frequency and need to get the latest value from servers. However, it can cause you to consume more of your [data stores limits and quotas](../../cloud-services/data-stores/error-codes-and-limits.md/#limits), since `Class.GlobalDataStore:GetAsync()|GetAsync()` requests bypassing caching always count towards your throughput and server limits.
237+
Disabling caching is useful if you have multiple servers writing to a key with high frequency and need to get the latest value from servers. However, it can cause you to consume more of your [data stores limits and quotas](../../cloud-services/data-stores/error-codes-and-limits.md#limits), since `Class.GlobalDataStore:GetAsync()|GetAsync()` requests bypassing caching always count towards your throughput and server limits.

content/en-us/cloud/open-cloud/legacy.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ This page summarizes the available operations, but you might find the Swagger do
1212
- [Badges API](https://badges.roblox.com/docs/)
1313
- [Followings API](https://followings.roblox.com/docs/)
1414
- [Game Internationalization API](https://gameinternationalization.roblox.com/docs/)
15+
- [Localization Tables API](https://localizationtables.roblox.com/docs/)
16+
- [Groups API](https://groups.roblox.com/docs/)
1517

1618
## Badges API
1719

@@ -66,3 +68,45 @@ DeleteLocalizedPassNameAndDescription | `DELETE v1/game-passes/{gamePassId}/name
6668
UpdateLocalizedPassNameAndDescription | `PATCH v1/game-passes/{gamePassId}/name-description/language-codes/{languageCode}` | `legacy-game-pass:manage`
6769
UpdateLocalizedPassName | `PATCH v1/game-passes/{gamePassId}/name/language-codes/{languageCode}` | `legacy-game-pass:manage`
6870
UpdateLocalizedPassDescription | `PATCH v1/game-passes/{gamePassId}/description/language-codes/{languageCode}` | `legacy-game-pass:manage`
71+
GetLocalizedGameIcons | `GET v1/game-icon/games/{gameId}` | `legacy-universe:manage`
72+
UpdateLocalizedGameIcon | `POST v1/game-icon/games/{gameId}/language-codes/{languageCode}` | `legacy-universe:manage`
73+
DeleteLocalizedGameIcon | `DELETE v1/game-icon/games/{gameId}/language-codes/{languageCode}` | `legacy-universe:manage`
74+
UpdateLocalizedGameThumbnail | `POST v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/image` | `legacy-universe:manage`
75+
UpdateLocalizedAltTextForGameThumbnail | `POST v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/alt-text` | `legacy-universe:manage`
76+
DeleteLocalizedGameThumbnail | `DELETE v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/images/{imageId}` | `legacy-universe:manage`
77+
OrderLocalizedGameThumbnails | `POST v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/images/order` | `legacy-universe:manage`
78+
UpdateLocalizedGameNameAndDescription | `PATCH v1/name-description/games/{gameId}` | `legacy-universe:manage`
79+
GetLocalizedContentNameAndDescriptionHistory | `POST /v1/name-description/games/translation-history` | `legacy-universe:manage`
80+
81+
## Localization Tables API
82+
83+
- Base URL: `https://apis.roblox.com/legacy-localization-tables`
84+
- Authentication types: OAuth 2.0 and API key
85+
86+
**API** | **Path** | **Scope**
87+
:--- | :--- | :---
88+
GetMetadata | `GET v1/autolocalization/metadata` | `legacy-universe:manage`
89+
GetOrCreateAutolocalizationTableForGame | `POST v1/autolocalization/games/{gameId}/autolocalizationtable` | `legacy-universe:manage`
90+
SetAutolocalizationSettingsForGame | `PATCH v1/autolocalization/games/{gameId}/settings` | `legacy-universe:manage`
91+
GetLimits | `GET v1/localization-table/limits` | `legacy-universe:manage`
92+
GetTableByAssetId | `GET v1/localization-table/tables/{assetId}` | `legacy-universe:manage`
93+
GetTableByTableId | `GET v1/localization-table/tables/{tableId}` | `legacy-universe:manage`
94+
UpdateTableContents | `PATCH v1/localization-table/tables/{tableId}` | `legacy-universe:manage`
95+
GetTableEntriesPaged | `GET v1/localization-table/tables/{tableId}/entries` | `legacy-universe:manage`
96+
GetTableEntryCount | `GET v1/localization-table/tables/{tableId}/entry-count` | `legacy-universe:manage`
97+
GetTableEntriesTranslationHistory | `POST v1/localization-table/tables/{tableId}/entries/translation-history` | `legacy-universe:manage`
98+
99+
## Groups API
100+
101+
- Base URL: `https://apis.roblox.com/legacy-groups`
102+
- Authentication types: OAuth 2.0 and API key
103+
104+
**API** | **Path** | **Scope**
105+
:--- | :--- | :---
106+
GetAuditLog | `GET v1/groups/{groupId}/audit-log` | `legacy-group:manage`
107+
GetGroupPolicies | `POST v1/groups/policies` | `legacy-group:manage`
108+
GetGroupSettings | `GET v1/groups/{groupId}/settings` | `legacy-group:manage`
109+
UpdateGroupSettings | `PATCH v1/groups/{groupId}/settings` | `legacy-group:manage`
110+
UpdateGroupStatus | `PATCH v1/groups/{groupId}/status` | `legacy-group:manage`
111+
UpdateGroupNotificationPreference | `PATCH v1/groups/{groupId}/notification-preference` | `legacy-group:manage`
112+
UpdateGroupDescription | `PATCH v1/groups/{groupId}/description` | `legacy-group:manage`

0 commit comments

Comments
 (0)