Skip to content

Commit bed10b3

Browse files
update Open Source Docs from Roblox internal teams
1 parent d2dabfd commit bed10b3

File tree

81 files changed

+1120
-753
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+1120
-753
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2010,6 +2010,11 @@ navigation:
20102010
type: engineapi
20112011
source: /reference/engine/classes/RigidConstraint.yaml
20122012
ignoreTranslation: true
2013+
- title: RobloxSerializableInstance
2014+
path: /reference/engine/classes/RobloxSerializableInstance
2015+
type: engineapi
2016+
source: /reference/engine/classes/RobloxSerializableInstance.yaml
2017+
ignoreTranslation: true
20132018
- title: RocketPropulsion
20142019
path: /reference/engine/classes/RocketPropulsion
20152020
type: engineapi
@@ -2020,6 +2025,11 @@ navigation:
20202025
type: engineapi
20212026
source: /reference/engine/classes/RodConstraint.yaml
20222027
ignoreTranslation: true
2028+
- title: RomarkRbxAnalyticsService
2029+
path: /reference/engine/classes/RomarkRbxAnalyticsService
2030+
type: engineapi
2031+
source: /reference/engine/classes/RomarkRbxAnalyticsService.yaml
2032+
ignoreTranslation: true
20232033
- title: RopeConstraint
20242034
path: /reference/engine/classes/RopeConstraint
20252035
type: engineapi
@@ -2915,6 +2925,11 @@ navigation:
29152925
type: engineapi
29162926
source: /reference/engine/classes/VRStatusService.yaml
29172927
ignoreTranslation: true
2928+
- title: WebViewService
2929+
path: /reference/engine/classes/WebViewService
2930+
type: engineapi
2931+
source: /reference/engine/classes/WebViewService.yaml
2932+
ignoreTranslation: true
29182933
- title: WedgePart
29192934
path: /reference/engine/classes/WedgePart
29202935
type: engineapi
@@ -4753,6 +4768,11 @@ navigation:
47534768
type: engineapi
47544769
source: /reference/engine/enums/SalesTypeFilter.yaml
47554770
ignoreTranslation: true
4771+
- title: SandboxedInstanceMode
4772+
path: /reference/engine/enums/SandboxedInstanceMode
4773+
type: engineapi
4774+
source: /reference/engine/enums/SandboxedInstanceMode.yaml
4775+
ignoreTranslation: true
47564776
- title: SaveAvatarThumbnailCustomizationFailure
47574777
path: /reference/engine/enums/SaveAvatarThumbnailCustomizationFailure
47584778
type: engineapi

content/en-us/production/promotion/referral-system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Player Referral System
3-
description: Generate shareable referral links that allow players to invite friends to join them inside an experience.
3+
description: Use referral links to track and reward players that have successfully invited other players into your experience, and players that have joined your experience using a referral link invitation from another player.
44
---
55

66
<Alert severity="info">

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

Lines changed: 64 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,19 @@ methods:
2121
summary: |
2222
Creates a new `Class.EditableImage`.
2323
description: |
24-
Creates a new `Class.EditableImage`. By default, the resolution
25-
is set at 512&times;512 but it can be specified via the returned object's
24+
Creates a new `Class.EditableImage`. By default, the resolution is set at
25+
512&times;512 but it can be specified via the returned object's
2626
`Class.EditableImage.Size` parameter. If the device‑specific editable
2727
memory budget is exhausted, creation will fail and this method will return
2828
`nil`.
2929
code_samples: []
30-
parameters: []
30+
parameters:
31+
- name: editableImageOptions
32+
type: Dictionary?
33+
default:
34+
summary: ''
3135
returns:
32-
- type: EditableImage
36+
- type: Object
3337
summary: ''
3438
tags: []
3539
deprecation_message: ''
@@ -41,21 +45,44 @@ methods:
4145
summary: |
4246
Creates a new, empty `Class.EditableMesh`.
4347
description: |
44-
Creates a new, empty `Class.EditableMesh`. Vertices,
45-
triangles and their attributes can be added dynamically to it.
46-
If the device‑specific editable memory budget is exhausted,
47-
creation will fail and this method will return `nil`.
48+
Creates a new, empty `Class.EditableMesh`. Vertices, triangles and their
49+
attributes can be added dynamically to it. If the device‑specific editable
50+
memory budget is exhausted, creation will fail and this method will return
51+
`nil`.
4852
code_samples: []
49-
parameters: []
53+
parameters:
54+
- name: editableMeshOptions
55+
type: Dictionary?
56+
default:
57+
summary: ''
5058
returns:
51-
- type: EditableMesh
59+
- type: Object
5260
summary: ''
5361
tags: []
5462
deprecation_message: ''
5563
security: None
5664
thread_safety: Unsafe
5765
capabilities: []
5866
writeCapabilities: []
67+
- name: AssetService:CheckTextureAlphaAsync
68+
summary: ''
69+
description: ''
70+
code_samples: []
71+
parameters:
72+
- name: textureId
73+
type: ContentId
74+
default:
75+
summary: ''
76+
returns:
77+
- type: bool
78+
summary: ''
79+
tags:
80+
- Yields
81+
deprecation_message: ''
82+
security: RobloxScriptSecurity
83+
thread_safety: Unsafe
84+
capabilities: []
85+
writeCapabilities: []
5986
- name: AssetService:CreateEditableImageAsync
6087
summary: |
6188
Creates a new `Class.EditableImage` instance populated with the given
@@ -64,18 +91,21 @@ methods:
6491
Creates a new `Class.EditableImage` instance populated with the given
6592
texture. Non-asset texture IDs such as `rbxthumb://` are supported. If
6693
using an image asset, it must be associated with and/or owned by a creator
67-
of the experience, or it must have been created inside the experience.
68-
If the device-specific editable memory budget is exhausted, creation
69-
will fail and this method will return `nil`.
94+
of the experience, or it must have been created inside the experience. If
95+
the device-specific editable memory budget is exhausted, creation will
96+
fail and this method will return `nil`.
7097
code_samples: []
7198
parameters:
72-
- name: textureId
73-
type: ContentId
99+
- name: content
100+
type: Content
74101
default:
75-
summary: |
76-
Texture ID of the image to populate the `Class.EditableImage`.
102+
summary: ''
103+
- name: editableImageOptions
104+
type: Dictionary?
105+
default:
106+
summary: ''
77107
returns:
78-
- type: EditableImage
108+
- type: Object
79109
summary: |
80110
A new `Class.EditableImage` containing the provided image.
81111
tags:
@@ -91,23 +121,25 @@ methods:
91121
content ID.
92122
description: |
93123
Returns a new `Class.EditableMesh` instance created from an existing mesh
94-
content ID. By default a `Class.EditableMesh` created from this method will
95-
be fixed size such that mesh data can only be modified, not added nor removed.
96-
A fixed size `Class.EditableMesh` consumes less memory and should be preferred
97-
when possible.
98-
99-
If the device-specific editable memory budget is exhausted, creation
100-
will fail and this method will return `nil`.
124+
content ID. By default a `Class.EditableMesh` created from this method
125+
will be fixed size such that mesh data can only be modified, not added nor
126+
removed. A fixed size `Class.EditableMesh` consumes less memory and should
127+
be preferred when possible.
128+
129+
If the device-specific editable memory budget is exhausted, creation will
130+
fail and this method will return `nil`.
101131
code_samples: []
102132
parameters:
103-
- name: meshId
104-
type: ContentId
133+
- name: content
134+
type: Content
105135
default:
106-
summary: |
107-
Content ID of the mesh from which to create an `Class.EditableMesh`
108-
instance.
136+
summary: ''
137+
- name: editableMeshOptions
138+
type: Dictionary?
139+
default:
140+
summary: ''
109141
returns:
110-
- type: EditableMesh
142+
- type: Object
111143
summary: |
112144
The new `Class.EditableMesh` instance.
113145
tags:
@@ -134,7 +166,7 @@ methods:
134166
instance. The part must have a valid `Class.MeshPart.MeshId|MeshId`
135167
for this method to operate.
136168
returns:
137-
- type: EditableMesh
169+
- type: Object
138170
summary: |
139171
The new `Class.EditableMesh` instance.
140172
tags:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ methods:
367367
code_samples: []
368368
parameters: []
369369
returns:
370-
- type: Objects
370+
- type: Instances
371371
summary: ''
372372
tags: []
373373
deprecation_message: ''

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ methods:
102102
default:
103103
summary: ''
104104
returns:
105-
- type: Objects
105+
- type: Instances
106106
summary: ''
107107
tags: []
108108
deprecation_message: ''

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ methods:
120120
default:
121121
summary: ''
122122
returns:
123-
- type: Objects
123+
- type: Instances
124124
summary: ''
125125
tags: []
126126
deprecation_message: ''

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ methods:
178178
default:
179179
summary: ''
180180
returns:
181-
- type: Objects
181+
- type: Instances
182182
summary: ''
183183
tags: []
184184
deprecation_message: ''

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ methods:
195195
default:
196196
summary: ''
197197
returns:
198-
- type: Objects
198+
- type: Instances
199199
summary: ''
200200
tags: []
201201
deprecation_message: ''

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ methods:
5454
default:
5555
summary: ''
5656
returns:
57-
- type: Objects
57+
- type: Instances
5858
summary: ''
5959
tags: []
6060
deprecation_message: ''

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ methods:
6969
default:
7070
summary: ''
7171
returns:
72-
- type: Objects
72+
- type: Instances
7373
summary: ''
7474
tags: []
7575
deprecation_message: ''

0 commit comments

Comments
 (0)