Skip to content

Commit 735e301

Browse files
update Open Source Docs from Roblox internal teams
1 parent 2c679df commit 735e301

20 files changed

+574
-32
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2985,6 +2985,16 @@ navigation:
29852985
type: engineapi
29862986
source: /reference/engine/classes/VRStatusService.yaml
29872987
ignoreTranslation: true
2988+
- title: WebSocketClient
2989+
path: /reference/engine/classes/WebSocketClient
2990+
type: engineapi
2991+
source: /reference/engine/classes/WebSocketClient.yaml
2992+
ignoreTranslation: true
2993+
- title: WebSocketService
2994+
path: /reference/engine/classes/WebSocketService
2995+
type: engineapi
2996+
source: /reference/engine/classes/WebSocketService.yaml
2997+
ignoreTranslation: true
29882998
- title: WedgePart
29892999
path: /reference/engine/classes/WedgePart
29903000
type: engineapi
@@ -3628,11 +3638,6 @@ navigation:
36283638
type: engineapi
36293639
source: /reference/engine/enums/CameraType.yaml
36303640
ignoreTranslation: true
3631-
- title: CaptureUIHideMode
3632-
path: /reference/engine/enums/CaptureUIHideMode
3633-
type: engineapi
3634-
source: /reference/engine/enums/CaptureUIHideMode.yaml
3635-
ignoreTranslation: true
36363641
- title: CatalogCategoryFilter
36373642
path: /reference/engine/enums/CatalogCategoryFilter
36383643
type: engineapi
@@ -5023,6 +5028,11 @@ navigation:
50235028
type: engineapi
50245029
source: /reference/engine/enums/StartCorner.yaml
50255030
ignoreTranslation: true
5031+
- title: StateObjectFieldType
5032+
path: /reference/engine/enums/StateObjectFieldType
5033+
type: engineapi
5034+
source: /reference/engine/enums/StateObjectFieldType.yaml
5035+
ignoreTranslation: true
50265036
- title: Status
50275037
path: /reference/engine/enums/Status
50285038
type: engineapi
@@ -5313,6 +5323,11 @@ navigation:
53135323
type: engineapi
53145324
source: /reference/engine/enums/TweenStatus.yaml
53155325
ignoreTranslation: true
5326+
- title: UICaptureMode
5327+
path: /reference/engine/enums/UICaptureMode
5328+
type: engineapi
5329+
source: /reference/engine/enums/UICaptureMode.yaml
5330+
ignoreTranslation: true
53165331
- title: UIDragDetectorBoundingBehavior
53175332
path: /reference/engine/enums/UIDragDetectorBoundingBehavior
53185333
type: engineapi
@@ -5498,6 +5513,11 @@ navigation:
54985513
type: engineapi
54995514
source: /reference/engine/enums/WaterForce.yaml
55005515
ignoreTranslation: true
5516+
- title: WebSocketState
5517+
path: /reference/engine/enums/WebSocketState
5518+
type: engineapi
5519+
source: /reference/engine/enums/WebSocketState.yaml
5520+
ignoreTranslation: true
55015521
- title: WeldConstraintPreserve
55025522
path: /reference/engine/enums/WeldConstraintPreserve
55035523
type: engineapi
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
version https://git-lfs.github.com/spec/v1
2-
oid sha256:63c0817bbb11ad2e596c768b38b492dbe82eec8b7355405ddc6fcb1ee2f17657
3-
size 394684
2+
oid sha256:9e3b54928a64b11375a1af5df3f32abe03797754b383551dffeee334ee1f0036
3+
size 395196
Lines changed: 3 additions & 0 deletions
Loading

content/en-us/assistant/guide.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@ title: Assistant
33
description: How to use Assistant to help build, grow, and monetize your creations.
44
---
55

6+
import BetaAlert from '../includes/beta-features/beta-alert.md'
7+
68
**Assistant** is an AI helper that accelerates content creation by helping you get started, supplementing your skills, and assisting with ongoing development. It can do the following and much more:
79

810
- Answer how to do things on Roblox
911
- Add and edit objects and scripts directly in your place's data model
1012
- Insert objects from the Creator Store
1113
- "Explain this code" by selecting parts of a script in the Script Editor
1214
- Create materials to restyle your objects
15+
- Generate 3D objects to populate your scene
1316

1417
<Alert severity="info">
1518
[Built with Meta Llama 3](https://llama.meta.com/llama3/license/)
@@ -55,6 +58,17 @@ When given a request to generate a material, Assistant in Studio can quickly sty
5558

5659
<img src="../assets/assistant/Studio-Quick-Styling-Material.png" width="360" alt="Material variations shown in Assistant for quick styling." />
5760

61+
### Generate 3D models
62+
63+
<BetaAlert betaName="Assistant Mesh Generation" leadIn="This feature is currently in beta. Enable it through " leadOut="." components={props.components} />
64+
65+
The `/generate` command enables [mesh generation](https://corp.roblox.com/newsroom/2025/03/introducing-roblox-cube), powered by Roblox's Cube 3D model.
66+
67+
1. In the Assistant chat window, type a command such as `/generate a red buggy with knobby tires`.
68+
1. Assistant generates the corresponding object and adds it directly to your workspace for further customization.
69+
70+
<img src="../assets/assistant/Studio-Generated-Green-Dragon.jpg" width="360" alt="A generated green dragon provided by Assistant in Studio." />
71+
5872
## Access Assistant
5973

6074
Assistant is available in two locations: Studio and the documentation.

content/en-us/production/localization/auto-translate-dynamic-content.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Automatically translate dynamic content
33
description: Explain how to generate translations in real time for dynamic content.
44
---
55

6+
<Alert severity = 'warning'>
7+
The following feature is currently in early development and is subject to change. For the latest updates and changes, see the [announcement](https://devforum.roblox.com/t/introducing-the-real-time-translation-api/3550206).
8+
</Alert>
9+
610
The standard translation workflow detects strings in your experience based on how frequently they're viewed by players and adds them to your localization table for translation. It might miss uncommon strings and/or strings generated during gameplay, such as dynamically generated text or text created by players. You can use the translate text API to generate translations for these strings in real-time, ensuring that your experience is fully localized.
711

812
## Translate text into a player's language

content/en-us/reference/engine/classes/AnimationTrack.yaml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,38 @@ methods:
509509
thread_safety: Unsafe
510510
capabilities: []
511511
writeCapabilities: []
512+
- name: AnimationTrack:GetTargetInstance
513+
summary: ''
514+
description: ''
515+
code_samples: []
516+
parameters:
517+
- name: name
518+
type: string
519+
default:
520+
summary: ''
521+
returns:
522+
- type: Instance
523+
summary: ''
524+
tags: []
525+
deprecation_message: ''
526+
security: None
527+
thread_safety: Unsafe
528+
capabilities: []
529+
writeCapabilities: []
530+
- name: AnimationTrack:GetTargetNames
531+
summary: ''
532+
description: ''
533+
code_samples: []
534+
parameters: []
535+
returns:
536+
- type: Array
537+
summary: ''
538+
tags: []
539+
deprecation_message: ''
540+
security: None
541+
thread_safety: Unsafe
542+
capabilities: []
543+
writeCapabilities: []
512544
- name: AnimationTrack:GetTimeOfKeyframe
513545
summary: |
514546
Returns the time position of the first `Class.Keyframe` of the given name
@@ -599,6 +631,28 @@ methods:
599631
thread_safety: Unsafe
600632
capabilities: []
601633
writeCapabilities: []
634+
- name: AnimationTrack:SetTargetInstance
635+
summary: ''
636+
description: ''
637+
code_samples: []
638+
parameters:
639+
- name: name
640+
type: string
641+
default:
642+
summary: ''
643+
- name: target
644+
type: Instance
645+
default:
646+
summary: ''
647+
returns:
648+
- type: void
649+
summary: ''
650+
tags: []
651+
deprecation_message: ''
652+
security: None
653+
thread_safety: Unsafe
654+
capabilities: []
655+
writeCapabilities: []
602656
- name: AnimationTrack:Stop
603657
summary: |
604658
Stops the `Class.AnimationTrack`.

content/en-us/reference/engine/classes/AudioTextToSpeech.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ description: ''
77
code_samples: []
88
inherits:
99
- Instance
10-
tags: []
10+
tags:
11+
- NotBrowsable
1112
deprecation_message: ''
1213
properties:
1314
- name: AudioTextToSpeech.IsLoaded

content/en-us/reference/engine/classes/GenerationService.yaml

Lines changed: 74 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@ name: GenerationService
22
type: class
33
category:
44
memory_category: Instances
5-
summary: ''
6-
description: ''
7-
code_samples: []
5+
summary: |
6+
Generate 3D objects from text prompts using Roblox's
7+
[Cube 3D foundation model](https://corp.roblox.com/newsroom/2025/03/introducing-roblox-cube).
8+
description: |
9+
`GenerationService` lets you generate 3D objects from text prompts using
10+
Roblox's [Cube 3D foundation model](https://corp.roblox.com/newsroom/2025/03/introducing-roblox-cube).
11+
code_samples:
12+
- GenerationService-ServerSideMeshGeneration
13+
- GenerationService-ClientSideMeshGeneration
814
inherits:
915
- Instance
1016
tags:
@@ -14,29 +20,61 @@ deprecation_message: ''
1420
properties: []
1521
methods:
1622
- name: GenerationService:GenerateMeshAsync
17-
summary: ''
18-
description: ''
19-
code_samples: []
23+
summary: |
24+
Generates a new mesh from a text prompt and returns unique IDs to track
25+
and retrieve the result.
26+
description: |
27+
Generates a new mesh from a text prompt and returns unique IDs to track
28+
and retrieve the result. Mesh generation happens in two stages, with an
29+
initial non-textured mesh being generated first and the texture generated
30+
in the second stage. To retrieve more intermediate results, use the
31+
optional callback to retrieve the initial generated mesh before the
32+
texture has been created and applied.
33+
34+
For a more detailed example, see
35+
[this demo experience](https://www.roblox.com/games/86571743597273/Mesh-Generation-Template).
36+
Click the **&ctdot;** button and **Edit in Studio**.
37+
38+
- The `GenerateMeshAsync()` method triggers the mesh generation and returns
39+
the generation ID which can then be loaded with the
40+
`LoadGeneratedMeshAsync()` method after the generation process
41+
completes.
42+
- The `GenerateMeshAsync()` method can only be called on the server.
43+
- Requests are limited to 5 per minute, per experience.
44+
45+
code_samples:
46+
- GenerationService-GenerateMeshAsync-BasicUsage
47+
- GenerationService-GenerateMeshAsync-WithIntermediateResultsCallback
48+
- GenerationService-GenerateMeshAsync-ServerSideGenerationWithErrorHandling
2049
parameters:
2150
- name: inputs
2251
type: Dictionary
2352
default:
24-
summary: ''
53+
summary: |
54+
Mesh generation inputs. Must include a `Prompt` key with a string
55+
value describing the object to generate.
2556
- name: player
2657
type: Player
2758
default:
28-
summary: ''
59+
summary: |
60+
The player requesting the generation.
2961
- name: options
3062
type: Dictionary
3163
default:
32-
summary: ''
64+
summary: |
65+
Mesh generation options (none currently available).
3366
- name: intermediateResultCallback
3467
type: Function?
3568
default:
36-
summary: ''
69+
summary: |
70+
Optional function that receives intermediate generations. The callback
71+
receives three parameters: `intermediateType` (an enum indicating the
72+
type of intermediate result), `generationId` (string), and `contextId`
73+
(string).
3774
returns:
3875
- type: Tuple
39-
summary: ''
76+
summary: |
77+
A tuple of generation ID and context ID.
4078
tags:
4179
- Yields
4280
deprecation_message: ''
@@ -45,17 +83,37 @@ methods:
4583
capabilities: []
4684
writeCapabilities: []
4785
- name: GenerationService:LoadGeneratedMeshAsync
48-
summary: ''
49-
description: ''
50-
code_samples: []
86+
summary: |
87+
Loads a generated mesh from RCC using the generation ID. The generated
88+
mesh is an `Class.MeshPart`.
89+
description: |
90+
Loads the mesh generated by `Class.GenerationService:GenerateMeshAsync()|GenerateMeshAsync()`
91+
using the `generationId` and returns a `Class.MeshPart` with the editable
92+
content. The resulting generation is then subject to `Class.EditableMesh`
93+
characteristics.
94+
95+
For a more detailed example, see
96+
[this demo experience](https://www.roblox.com/games/86571743597273/Mesh-Generation-Template).
97+
Click the **&ctdot;** button and **Edit in Studio**.
98+
99+
Currently, the `LoadGeneratedMeshAsync()` method can only be called on
100+
the client due to the restrictions on replicating editable meshes. This
101+
means that only one player will be able to see the generated mesh, as this
102+
function can only be called once per `generationId`.'
103+
104+
code_samples:
105+
- GenerationService-LoadGeneratedMeshAsync-LoadAGeneratedMesh
51106
parameters:
52107
- name: generationId
53108
type: string
54109
default:
55-
summary: ''
110+
summary: |
111+
The generation ID returned by
112+
`Class.GenerationService:GenerateMeshAsync()|GenerateMeshAsync()`.
56113
returns:
57114
- type: MeshPart
58-
summary: ''
115+
summary: |
116+
The generated `Class.MeshPart`.
59117
tags:
60118
- Yields
61119
deprecation_message: ''

content/en-us/reference/engine/classes/GuiButton.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,24 @@ properties:
6464
capabilities:
6565
- UI
6666
writeCapabilities: []
67+
- name: GuiButton.HoverHapticEffect
68+
summary: ''
69+
description: ''
70+
code_samples: []
71+
type: HapticEffect
72+
tags: []
73+
deprecation_message: ''
74+
security:
75+
read: None
76+
write: None
77+
thread_safety: ReadSafe
78+
category: Haptic
79+
serialization:
80+
can_load: true
81+
can_save: true
82+
capabilities:
83+
- UI
84+
writeCapabilities: []
6785
- name: GuiButton.Modal
6886
summary: |
6987
If `true` while the GUI element is visible, the mouse will not be locked
@@ -86,6 +104,24 @@ properties:
86104
capabilities:
87105
- UI
88106
writeCapabilities: []
107+
- name: GuiButton.PressHapticEffect
108+
summary: ''
109+
description: ''
110+
code_samples: []
111+
type: HapticEffect
112+
tags: []
113+
deprecation_message: ''
114+
security:
115+
read: None
116+
write: None
117+
thread_safety: ReadSafe
118+
category: Haptic
119+
serialization:
120+
can_load: true
121+
can_save: true
122+
capabilities:
123+
- UI
124+
writeCapabilities: []
89125
- name: GuiButton.Selected
90126
summary: |
91127
A boolean property which indicates whether the object has been selected.

0 commit comments

Comments
 (0)