Skip to content

Commit a60fe47

Browse files
update Open Source Docs from Roblox internal teams
1 parent d7b0a95 commit a60fe47

25 files changed

+562
-278
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,11 @@ navigation:
258258
type: engineapi
259259
source: /reference/engine/classes/AudioPlayer.yaml
260260
ignoreTranslation: true
261+
- title: AudioRecorder
262+
path: /reference/engine/classes/AudioRecorder
263+
type: engineapi
264+
source: /reference/engine/classes/AudioRecorder.yaml
265+
ignoreTranslation: true
261266
- title: AudioReverb
262267
path: /reference/engine/classes/AudioReverb
263268
type: engineapi
@@ -273,6 +278,11 @@ navigation:
273278
type: engineapi
274279
source: /reference/engine/classes/AudioTextToSpeech.yaml
275280
ignoreTranslation: true
281+
- title: AuroraScriptObject
282+
path: /reference/engine/classes/AuroraScriptObject
283+
type: engineapi
284+
source: /reference/engine/classes/AuroraScriptObject.yaml
285+
ignoreTranslation: true
276286
- title: AvatarCreationService
277287
path: /reference/engine/classes/AvatarCreationService
278288
type: engineapi

content/common/navigation/platform.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ navigation:
1515
path: /creator-hub
1616
- heading: Community
1717
- title: Learn on YouTube
18-
path: https://www.youtube.com/@RobloxLearnOfficial
18+
path: https://www.youtube.com/@RobloxLearn
1919
- title: Get help on the forum
2020
path: https://devforum.roblox.com/c/help-and-feedback/54
2121
- title: Read product announcements

content/en-us/chat/chat-window.md

Lines changed: 10 additions & 153 deletions
Original file line numberDiff line numberDiff line change
@@ -61,19 +61,19 @@ When `Class.ChannelTabsConfiguration` is enabled, each default `Class.TextChanne
6161
</thead>
6262
<tbody>
6363
<tr>
64-
<td>**RBXGeneral**</td>
64+
<td>`RBXGeneral`</td>
6565
<td>**General**</td>
6666
</tr>
6767
<tr>
68-
<td>**RBXSystem**</td>
69-
<td>**General** (combined into a single tab with **RBXGeneral**)</td>
68+
<td>`RBXSystem`</td>
69+
<td>**General** (combined into a single tab with `RBXGeneral`)</td>
7070
</tr>
7171
<tr>
72-
<td>**RBXTeam**</td>
72+
<td>`RBXTeam`</td>
7373
<td>**Team**</td>
7474
</tr>
7575
<tr>
76-
<td>**RBXWhisper**</td>
76+
<td>`RBXWhisper`</td>
7777
<td>User name of the other player</td>
7878
</tr>
7979
</tbody>
@@ -388,13 +388,15 @@ TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
388388
end
389389
```
390390

391-
## Send messages from non‑player sources
391+
## Messages from non‑player sources
392392

393-
Sometimes, you might want to show non‑player dialogue in the chat window, such as "speech" from a public address system or a non‑player character.
393+
When `Class.TextChatService.CreateDefaultTextChannels` is `true`, one of the default text channels is the `RBXSystem` channel. The default chat scripts automatically display system messages in this channel. You can customize the appearance of these messages using the `Class.TextChannel.OnIncomingMessage` callback.
394+
395+
You might want to customize or alter the system messages that are automatically emitted by the chat system. Since the default system messages are localized for users, you should reference them by `Class.TextChatMessage.Metadata` in your [text chat callbacks](../chat/in-experience-text-chat.md#text-chat-hooks-and-callbacks) if you wish to customize their appearance. For example, you could use `Class.TextChatMessage.Metadata|Metadata` to identify system messages, error messages, or messages from specific systems in your experience.
394396

395397
### System
396398

397-
To deliver a system message to the local player, call `Class.TextChannel:DisplaySystemMessage()|DisplaySystemMessage()` from the default **RBXGeneral** channel with a prefix before the player's display name.
399+
To deliver a system message to the local player, such as "speech" from a public address system, call `Class.TextChannel:DisplaySystemMessage()|DisplaySystemMessage()` from the default `RBXGeneral` channel with a prefix before the player's display name.
398400

399401
```lua title="Client Script"
400402
local Players = game:GetService("Players")
@@ -411,151 +413,6 @@ generalChannel:DisplaySystemMessage(PREFIX .. player.DisplayName)
411413

412414
<img src="../assets/players/in-experience-text-chat/Chat-System.jpg" width="800" alt="Image showing a basic system message in the chat window." />
413415

414-
For a more detailed guide on how to customize the appearance of system messages, see [Customizing system messages](./examples/custom-system-messages.md).
415-
416-
#### Default system messages
417-
418-
When `Class.TextChatService.CreateDefaultTextChannels` is `true`, one of the default text channels is the `RBXSystem` channel. The default chat scripts automatically display system messages in this channel. You can customize the appearance of these messages using the `Class.TextChannel.OnIncomingMessage` callback.
419-
420-
You might want to customize or alter the system messages that are automatically emitted by the chat system. Since the default system messages are localized for users, you should reference them by `TextChatMessage.Metadata` in your [text chat callbacks](../chat/in-experience-text-chat.md#text-chat-hooks-and-callbacks) if you wish to customize their appearance.
421-
422-
Below is a reference of the default system messages that are emitted by the chat system:
423-
424-
<table>
425-
<thead>
426-
<tr>
427-
<th>Metadata</th>
428-
<th>Description</th>
429-
</tr>
430-
</thead>
431-
<tbody>
432-
<tr>
433-
<td><b>Roblox.ChatTranslation.ChatWindow.SystemMessage</b></td>
434-
<td>Indicates that the system may translate chat messages for the Player</td>
435-
</tr>
436-
<tr>
437-
<td><b>Roblox.Notification.Friend.Joined</b></td>
438-
<td>Displayed when one of the Player's friends join the experience</td>
439-
</tr>
440-
<tr>
441-
<td><b>Roblox.MessageStatus.Warning.Floodchecked</b></td>
442-
<td>Displayed when the Player's sent TextChatMessage was rate limited by the Server</td>
443-
</tr>
444-
<tr>
445-
<td><b>Roblox.MessageStatus.Warning.TextFilterFailed</b></td>
446-
<td>Displayed when the Player's sent TextChatMessage could not be displayed due to a Text Filter issue</td>
447-
</tr>
448-
<tr>
449-
<td><b>Roblox.MessageStatus.Warning.InvalidPrivacySettings</b></td>
450-
<td>Displayed when the Player's privacy settings prevent them from sending a TextChatMessage</td>
451-
</tr>
452-
<tr>
453-
<td><b>Roblox.MessageStatus.Warning.MessageTooLong</b></td>
454-
<td>Displayed when the Player sends a TextChatMessage with content that is too long</td>
455-
</tr>
456-
<tr>
457-
<td><b>Roblox.MessageStatus.Warning.Unknown</b></td>
458-
<td>Displays when the system fails to send the Player's TextChatMessage for an unknown reason</td>
459-
</tr>
460-
<tr>
461-
<td><b>Roblox.Help.Info</b></td>
462-
<td>Displays the response from the RBXHelpCommand TextChatCommand</td>
463-
</tr>
464-
<tr>
465-
<td><b>Roblox.Version.Info</b></td>
466-
<td>Displays the response from the RBXVersionCommand TextChatCommand</td>
467-
</tr>
468-
<tr>
469-
<td><b>Roblox.Team.Success.NowInTeam</b></td>
470-
<td>Displayed when the Player's team changes</td>
471-
</tr>
472-
<tr>
473-
<td><b>Roblox.Team.Error.CannotTeamChatIfNotInTeam</b></td>
474-
<td>Displayed when the Player triggers the RBXTeamCommand TextChatCommand without being on a `Class.Team`</td>
475-
</tr>
476-
<tr>
477-
<td><b>Roblox.Whisper.Info.Success</b></td>
478-
<td>Displayed when the Player successfully starts a Whisper conversation</td>
479-
</tr>
480-
<tr>
481-
<td><b>Roblox.Whisper.Welcome.Sent</b></td>
482-
<td>Displayed when entering a Whisper TextChannel</td>
483-
</tr>
484-
<tr>
485-
<td><b>Roblox.Whisper.Error.CannotWhisperToSelf</b></td>
486-
<td>An error response from the RBXWhisperCommand TextChatCommand</td>
487-
</tr>
488-
<tr>
489-
<td><b>Roblox.Whisper.Error.TargetDoesNotExist</b></td>
490-
<td>An error response from the RBXWhisperCommand TextChatCommand</td>
491-
</tr>
492-
<tr>
493-
<td><b>Roblox.Whisper.Error.TooManyMatches</b></td>
494-
<td>An error response from the RBXWhisperCommand TextChatCommand</td>
495-
</tr>
496-
<tr>
497-
<td><b>Roblox.Whisper.Error.Unknown</b></td>
498-
<td>An error response from the RBXWhisperCommand TextChatCommand</td>
499-
</tr>
500-
<tr>
501-
<td><b>Roblox.Emote.Error.DoesNotExist</b></td>
502-
<td>An error response from the RBXEmoteCommand TextChatCommand</td>
503-
</tr>
504-
<tr>
505-
<td><b>Roblox.Emote.Error.UserEmotesNotEnabled</b></td>
506-
<td>An error response from the RBXEmoteCommand TextChatCommand</td>
507-
</tr>
508-
<tr>
509-
<td><b>Roblox.Emote.Error.TemporarilyUnavailable</b></td>
510-
<td>An error response from the RBXEmoteCommand TextChatCommand</td>
511-
</tr>
512-
<tr>
513-
<td><b>Roblox.Emote.Error.NotSupported</b></td>
514-
<td>An error response from the RBXEmoteCommand TextChatCommand</td>
515-
</tr>
516-
<tr>
517-
<td><b>Roblox.Emote.Error.SwitchToR15</b></td>
518-
<td>An error response from the RBXEmoteCommand TextChatCommand</td>
519-
</tr>
520-
<tr>
521-
<td><b>Roblox.Emote.Error.AnimationPlaying</b></td>
522-
<td>An error response from the RBXEmoteCommand TextChatCommand</td>
523-
</tr>
524-
<tr>
525-
<td><b>Roblox.Mute.Error.PlayerNotFound</b></td>
526-
<td>An error response from the RBXMuteCommand TextChatCommand</td>
527-
</tr>
528-
<tr>
529-
<td><b>Roblox.Mute.Error.MultipleMatches</b></td>
530-
<td>An error response from the RBXMuteCommand TextChatCommand</td>
531-
</tr>
532-
<tr>
533-
<td><b>Roblox.Mute.Error.CannotMuteSelf</b></td>
534-
<td>An error response from the RBXMuteCommand TextChatCommand</td>
535-
</tr>
536-
<tr>
537-
<td><b>Roblox.Mute.Info.Success</b></td>
538-
<td>An success response from the RBXMuteCommand TextChatCommand</td>
539-
</tr>
540-
<tr>
541-
<td><b>Roblox.Unmute.Error.PlayerNotFound</b></td>
542-
<td>An error response from the RBXUnmuteCommand TextChatCommand</td>
543-
</tr>
544-
<tr>
545-
<td><b>Roblox.Unmute.Error.MultipleMatches</b></td>
546-
<td>An error response from the RBXUnmuteCommand TextChatCommand</td>
547-
</tr>
548-
<tr>
549-
<td><b>Roblox.Unmute.Error.CannotMuteSelf</b></td>
550-
<td>An error response from the RBXUnmuteCommand TextChatCommand</td>
551-
</tr>
552-
<tr>
553-
<td><b>Roblox.Unmute.Info.Success</b></td>
554-
<td>An success response from the RBXUnmuteCommand TextChatCommand</td>
555-
</tr>
556-
</tbody>
557-
</table>
558-
559416
### NPC/object
560417

561418
You can also stylize non-player dialogue and add [chat bubbles](../chat/bubble-chat.md) to make it appear like messages are coming from an NPC or object within the 3D world.

content/en-us/chat/examples/custom-system-messages.md

Lines changed: 0 additions & 74 deletions
This file was deleted.

content/en-us/chat/in-experience-text-chat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The `Class.TextChannel.ShouldDeliverCallback` callback should be defined on the
8989

9090
### Customize message display
9191

92-
The default `Class.TextChatService` UI relies on [rich text](../ui/rich-text.md) to format and customize how messages are displayed. You can use the following callbacks to format messages before they are displayed to users, for example to add colors or [chat tags](../chat/chat-window.md#add-chat-tags) to user names or format message content.
92+
The default `Class.TextChatService` UI relies on [rich text](../ui/rich-text.md) to format and customize how messages are displayed. You can use the following callbacks to format messages before they are displayed to users, for example to add colors or [chat tags](../chat/examples/group-chat-tags.md) to user names or format message content.
9393

9494
The following callbacks are called on every `Class.TextChatMessage` that is about to be displayed, which lets you customize chat window appearance based on the `Class.TextChannel`, `Class.TextSource`, or `Class.TextChatMessage` content. When a client sends a message, these callbacks are called once when the message is sent to the server and the `Class.TextChatMessage.Status` value will be `Enum.TextChatMessageStatus.Sending`. Once the message is received by the server and is being delivered to other users, the sender client receives the message again with an updated `Enum.TextChatMessageStatus` value.
9595

content/en-us/creator-programs/inspire.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Inspire is an annual global online event where creators come togeth
55

66
Inspire is an annual global online event where creators come together to exchange ideas, learn from workshops led by top creators, and collaborate to boost connections within the community. By participating, you can share your knowledge and host workshops for the broader creator community.
77

8-
See [Roblox Learn](https://www.youtube.com/@RobloxLearnOfficial) for content from Inspire 2024.
8+
See [Roblox Learn](https://www.youtube.com/@RobloxLearn) for content from Inspire 2024.
99

1010
<figure>
1111
<Chip

content/en-us/experiences.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ Learn, share, and interact with the Roblox community in the following places.
202202
<img src="/assets/landing/get-started/video-interviews.jpg" style={{position: "absolute", top: 0, left: 0, width: "100%", height: "100%"}}/>
203203
</div>
204204
<Typography variant='h4'>On social video channels</Typography>
205-
<a href="https://www.youtube.com/@RobloxLearnOfficial"><Typography variant='buttonLarge' style={{marginBottom: 12}}> YouTube channel</Typography></a>
205+
<a href="https://www.youtube.com/@RobloxLearn"><Typography variant='buttonLarge' style={{marginBottom: 12}}> YouTube channel</Typography></a>
206206
<a href="https://events.roblox.com"><Typography variant='buttonLarge' style={{marginBottom: 12}}>Content and events platform</Typography></a>
207207
</Grid>
208208
</Grid>

content/en-us/platform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ export const sections = [
148148
},
149149
{
150150
title: "Extensive scale and monetization",
151-
description: "Reach a massive, global audience of hundreds of millions of users across 190 countries with efficient discovery and user acquisition.",
151+
description: "Reach a massive, global audience of hundreds of millions of users across 180 countries with efficient discovery and user acquisition.",
152152
buttons: [
153153
{ text: "Learn how to scale", href: "./scale" },
154154
{ text: "Learn how to monetize", href: "./monetize" }

content/en-us/production/earn-on-roblox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This page provides information about different ways to earn on Roblox and how to
2222

2323
## Economy powered by creators
2424

25-
We are building one of the world's largest immersive platforms with 85.3M global daily active users (DAUs) in 16 languages across 190 countries, available across platforms including mobile, desktop, consoles, and VR headsets. In 2024, approximately 60% of our daily active users were 13 and over, and users aged 17 and over accounted for 44% of our daily active users. In 2024, our community visited over 14 million experiences, and in the fourth quarter of 2024 alone, users spent 18.7 billion hours on our platform.
25+
We are building one of the world's largest immersive platforms with 85.3M global daily active users (DAUs) in 17 languages across 180 countries, available across platforms including mobile, desktop, consoles, and VR headsets. In 2024, approximately 60% of our daily active users were 13 and over, and users aged 17 and over accounted for 44% of our daily active users. In 2024, our community visited over 14 million experiences, and in the fourth quarter of 2024 alone, users spent 18.7 billion hours on our platform.
2626

2727
<GridContainer numColumns="2">
2828
<figure>

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -487,12 +487,14 @@ methods:
487487
type: string
488488
default: ''
489489
summary: |
490-
The name of the `Class.KeyframeMarker` the signal is being created for. Not to be confused with the name of the `Class.Keyframe`.
490+
The name of the `Class.KeyframeMarker` the signal is being created
491+
for. Not to be confused with the name of the `Class.Keyframe`.
491492
returns:
492493
- type: RBXScriptSignal
493494
summary: |
494495
The signal created and fired when the animation reaches the created
495-
`KeyframeMarker`. Not to be confused with the name of the `Class.Keyframe`.
496+
`KeyframeMarker`. Not to be confused with the name of the
497+
`Class.Keyframe`.
496498
tags: []
497499
deprecation_message: ''
498500
security: None

0 commit comments

Comments
 (0)