Skip to content

Commit 8d61564

Browse files
update Open Source Docs from Roblox internal teams
1 parent 66ca586 commit 8d61564

21 files changed

+294
-56
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3448,11 +3448,6 @@ navigation:
34483448
type: engineapi
34493449
source: /reference/engine/enums/AvatarItemType.yaml
34503450
ignoreTranslation: true
3451-
- title: AvatarJointUpgrade
3452-
path: /reference/engine/enums/AvatarJointUpgrade
3453-
type: engineapi
3454-
source: /reference/engine/enums/AvatarJointUpgrade.yaml
3455-
ignoreTranslation: true
34563451
- title: AvatarPromptResult
34573452
path: /reference/engine/enums/AvatarPromptResult
34583453
type: engineapi
@@ -3868,6 +3863,11 @@ navigation:
38683863
type: engineapi
38693864
source: /reference/engine/enums/DraggerMovementMode.yaml
38703865
ignoreTranslation: true
3866+
- title: DraggingScrollBar
3867+
path: /reference/engine/enums/DraggingScrollBar
3868+
type: engineapi
3869+
source: /reference/engine/enums/DraggingScrollBar.yaml
3870+
ignoreTranslation: true
38713871
- title: EasingDirection
38723872
path: /reference/engine/enums/EasingDirection
38733873
type: engineapi
@@ -5013,6 +5013,11 @@ navigation:
50135013
type: engineapi
50145014
source: /reference/engine/enums/TableMajorAxis.yaml
50155015
ignoreTranslation: true
5016+
- title: TeamCreateErrorState
5017+
path: /reference/engine/enums/TeamCreateErrorState
5018+
type: engineapi
5019+
source: /reference/engine/enums/TeamCreateErrorState.yaml
5020+
ignoreTranslation: true
50165021
- title: Technology
50175022
path: /reference/engine/enums/Technology
50185023
type: engineapi

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ methods:
2222
Creates a new `Class.EditableImage`.
2323
description: |
2424
Creates a new `Class.EditableImage`. By default, the resolution is set at
25-
512×512, but you can specify a different size using the method's
25+
512×512, but you can specify a different size using the method's
2626
option table.
2727
2828
If the device‑specific editable memory budget is exhausted, creation fails
@@ -146,9 +146,9 @@ methods:
146146
Options table containing controls for the method:
147147
148148
- `FixedSize` – A `bool`. Default value is `true`, and the returned
149-
`Class.EditableMesh` will not allow you to add or remove vertices,
150-
only modify their values. Set to `false` if the ability to change the
151-
mesh topology is required, at the expense of using more memory.
149+
`Class.EditableMesh` will not allow you to add or remove vertices,
150+
only modify their values. Set to `false` if the ability to change
151+
the mesh topology is required, at the expense of using more memory.
152152
returns:
153153
- type: Object
154154
summary: |

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,24 @@ properties:
9898
capabilities:
9999
- Audio
100100
writeCapabilities: []
101+
- name: AudioEcho.RampTime
102+
summary: ''
103+
description: ''
104+
code_samples: []
105+
type: float
106+
tags: []
107+
deprecation_message: ''
108+
security:
109+
read: None
110+
write: None
111+
thread_safety: ReadSafe
112+
category: State
113+
serialization:
114+
can_load: true
115+
can_save: true
116+
capabilities:
117+
- Audio
118+
writeCapabilities: []
101119
- name: AudioEcho.WetLevel
102120
summary: |
103121
Gain level determining how loud the echoed stream will be.

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ properties:
2020
summary: |
2121
Actual screen position of the channel tab bar, in pixels.
2222
description: |
23-
Read-only property that provides the screen position of the channel tab bar in pixels. Behaves similarly to `Class.GuiBase2d.AbsolutePosition`.
23+
Read-only property that provides the screen position of the channel tab
24+
bar in pixels. Behaves similarly to `Class.GuiBase2d.AbsolutePosition`.
2425
code_samples: []
2526
type: Vector2
2627
tags:
@@ -42,7 +43,8 @@ properties:
4243
summary: |
4344
Actual screen size of the channel tab bar, in pixels.
4445
description: |
45-
Read-only property that provides the screen size of the channel tab bar in pixels. Behaves similarly to `Class.GuiBase2d.AbsoluteSize`.
46+
Read-only property that provides the screen size of the channel tab bar in
47+
pixels. Behaves similarly to `Class.GuiBase2d.AbsoluteSize`.
4648
code_samples: []
4749
type: Vector2
4850
tags:
@@ -132,7 +134,8 @@ properties:
132134
summary: |
133135
Font used to render text in the channel tabs.
134136
description: |
135-
Font used to render text in the channel tabs. Default is `Enum.Font.BuilderSansBold`.
137+
Font used to render text in the channel tabs. Default is
138+
`Enum.Font.BuilderSansBold`.
136139
code_samples: []
137140
type: Font
138141
tags: []

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,8 @@ properties:
151151
summary: |
152152
Font used to render text in the default chat input bar.
153153
description: |
154-
Font used to render text in the default chat input bar. Default is `Enum.Font.BuilderSansMedium`.
154+
Font used to render text in the default chat input bar. Default is
155+
`Enum.Font.BuilderSansMedium`.
155156
code_samples: []
156157
type: Font
157158
tags: []

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,8 @@ properties:
132132
summary: |
133133
Font used to render text in the default chat window.
134134
description: |
135-
Font used to render text in the default chat window. Default is `Enum.Font.BuilderSansMedium`.
135+
Font used to render text in the default chat window. Default is
136+
`Enum.Font.BuilderSansMedium`.
136137
code_samples: []
137138
type: Font
138139
tags: []

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

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ properties:
1515
summary: |
1616
Font used to render text in the chat window.
1717
description: |
18-
Determines the font used to render text in the chat window. Default is `Enum.Font.BuilderSansMedium`.
18+
Determines the font used to render text in the chat window. Default is
19+
`Enum.Font.BuilderSansMedium`.
1920
code_samples: []
2021
type: Font
2122
tags: []
@@ -33,9 +34,11 @@ properties:
3334
writeCapabilities: []
3435
- name: ChatWindowMessageProperties.PrefixTextProperties
3536
summary: |
36-
Determines the properties of the `Class.TextChatMessage.PrefixText|PrefixText` preceding the chat message.
37+
Determines the properties of the
38+
`Class.TextChatMessage.PrefixText|PrefixText` preceding the chat message.
3739
description: |
38-
Determines the properties of the `Class.TextChatMessage.PrefixText` preceding the chat message.
40+
Determines the properties of the `Class.TextChatMessage.PrefixText`
41+
preceding the chat message.
3942
code_samples: []
4043
type: ChatWindowMessageProperties
4144
tags: []
@@ -55,7 +58,8 @@ properties:
5558
summary: |
5659
Color of the text in the chat window.
5760
description: |
58-
Determines the color of the text in the chat window. Default value is `Datatype.Color3.new(255, 255, 255)` (white).
61+
Determines the color of the text in the chat window. Default value is
62+
`Datatype.Color3.new(255, 255, 255)` (white).
5963
code_samples: []
6064
type: Color3
6165
tags: []
@@ -95,7 +99,8 @@ properties:
9599
summary: |
96100
Stroke color applied to text in the chat window.
97101
description: |
98-
Determines the stroke color applied to text in the chat window. Default value is `Datatype.Color3.new(0, 0, 0)` (black).
102+
Determines the stroke color applied to text in the chat window. Default
103+
value is `Datatype.Color3.new(0, 0, 0)` (black).
99104
code_samples: []
100105
type: Color3
101106
tags: []
@@ -115,7 +120,8 @@ properties:
115120
summary: |
116121
Transparency of the stroke applied to text in the chat window.
117122
description: |
118-
Determines the transparency of the stroke applied to text in the chat window. Default value is `0.5`.
123+
Determines the transparency of the stroke applied to text in the chat
124+
window. Default value is `0.5`.
119125
code_samples: []
120126
type: double
121127
tags: []

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

Lines changed: 60 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,66 @@ methods:
162162
thread_safety: Unsafe
163163
capabilities: []
164164
writeCapabilities: []
165+
- name: EditableImage:DrawImageProjected
166+
summary: ''
167+
description: ''
168+
code_samples: []
169+
parameters:
170+
- name: mesh
171+
type: Object
172+
default:
173+
summary: ''
174+
- name: projection
175+
type: Dictionary
176+
default:
177+
summary: ''
178+
- name: brushConfig
179+
type: Dictionary
180+
default:
181+
summary: ''
182+
returns:
183+
- type: void
184+
summary: ''
185+
tags: []
186+
deprecation_message: ''
187+
security: None
188+
thread_safety: Unsafe
189+
capabilities: []
190+
writeCapabilities: []
191+
- name: EditableImage:DrawImageTransformed
192+
summary: ''
193+
description: ''
194+
code_samples: []
195+
parameters:
196+
- name: position
197+
type: Vector2
198+
default:
199+
summary: ''
200+
- name: scale
201+
type: Vector2
202+
default:
203+
summary: ''
204+
- name: rotation
205+
type: float
206+
default:
207+
summary: ''
208+
- name: image
209+
type: Object
210+
default:
211+
summary: ''
212+
- name: options
213+
type: Dictionary?
214+
default:
215+
summary: ''
216+
returns:
217+
- type: void
218+
summary: ''
219+
tags: []
220+
deprecation_message: ''
221+
security: None
222+
thread_safety: Unsafe
223+
capabilities: []
224+
writeCapabilities: []
165225
- name: EditableImage:DrawLine
166226
summary: |
167227
Draws a line between two provided points.
@@ -205,32 +265,6 @@ methods:
205265
thread_safety: Unsafe
206266
capabilities: []
207267
writeCapabilities: []
208-
- name: EditableImage:DrawProjectionImage
209-
summary: ''
210-
description: ''
211-
code_samples: []
212-
parameters:
213-
- name: mesh
214-
type: Object
215-
default:
216-
summary: ''
217-
- name: projection
218-
type: Dictionary
219-
default:
220-
summary: ''
221-
- name: brushConfig
222-
type: Dictionary
223-
default:
224-
summary: ''
225-
returns:
226-
- type: void
227-
summary: ''
228-
tags: []
229-
deprecation_message: ''
230-
security: None
231-
thread_safety: Unsafe
232-
capabilities: []
233-
writeCapabilities: []
234268
- name: EditableImage:DrawRectangle
235269
summary: |
236270
Draws a rectangle of the given size at the given top-left position.

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,20 @@ methods:
423423
thread_safety: Unsafe
424424
capabilities: []
425425
writeCapabilities: []
426+
- name: EditableMesh:GetCenter
427+
summary: ''
428+
description: ''
429+
code_samples: []
430+
parameters: []
431+
returns:
432+
- type: Vector3
433+
summary: ''
434+
tags: []
435+
deprecation_message: ''
436+
security: None
437+
thread_safety: Unsafe
438+
capabilities: []
439+
writeCapabilities: []
426440
- name: EditableMesh:GetColor
427441
summary: |
428442
Returns the color for the given color ID.
@@ -675,6 +689,20 @@ methods:
675689
thread_safety: Unsafe
676690
capabilities: []
677691
writeCapabilities: []
692+
- name: EditableMesh:GetSize
693+
summary: ''
694+
description: ''
695+
code_samples: []
696+
parameters: []
697+
returns:
698+
- type: Vector3
699+
summary: ''
700+
tags: []
701+
deprecation_message: ''
702+
security: None
703+
thread_safety: Unsafe
704+
capabilities: []
705+
writeCapabilities: []
678706
- name: EditableMesh:GetUV
679707
summary: |
680708
Returns UV coordinates at the given UV ID.

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

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -675,6 +675,46 @@ methods:
675675
thread_safety: Unsafe
676676
capabilities: []
677677
writeCapabilities: []
678+
- name: GuiService:OnNotificationDisplayed
679+
summary: ''
680+
description: ''
681+
code_samples: []
682+
parameters:
683+
- name: notificationId
684+
type: string
685+
default:
686+
summary: ''
687+
returns:
688+
- type: void
689+
summary: ''
690+
tags: []
691+
deprecation_message: ''
692+
security: RobloxScriptSecurity
693+
thread_safety: Unsafe
694+
capabilities: []
695+
writeCapabilities: []
696+
- name: GuiService:OnNotificationInteraction
697+
summary: ''
698+
description: ''
699+
code_samples: []
700+
parameters:
701+
- name: notificationId
702+
type: string
703+
default:
704+
summary: ''
705+
- name: buttonIndex
706+
type: int
707+
default:
708+
summary: ''
709+
returns:
710+
- type: void
711+
summary: ''
712+
tags: []
713+
deprecation_message: ''
714+
security: RobloxScriptSecurity
715+
thread_safety: Unsafe
716+
capabilities: []
717+
writeCapabilities: []
678718
- name: GuiService:RemoveSelectionGroup
679719
summary: |
680720
Removes a group that was created with

0 commit comments

Comments
 (0)