Skip to content

Commit 5b53694

Browse files
rbx-open-source-docs[bot]rbx-open-source-docs[bot]
committed
update Open Source Docs from Roblox internal teams
1 parent d76e9dc commit 5b53694

39 files changed

+1185
-145
lines changed

‎content/common/navigation/engine/reference.yaml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ navigation:
2525
type: engineapi
2626
source: /reference/engine/classes/Accoutrement.yaml
2727
ignoreTranslation: true
28+
- title: ActivityHistoryEventService
29+
path: /reference/engine/classes/ActivityHistoryEventService
30+
type: engineapi
31+
source: /reference/engine/classes/ActivityHistoryEventService.yaml
32+
ignoreTranslation: true
2833
- title: Actor
2934
path: /reference/engine/classes/Actor
3035
type: engineapi
@@ -265,6 +270,11 @@ navigation:
265270
type: engineapi
266271
source: /reference/engine/classes/AvatarEditorService.yaml
267272
ignoreTranslation: true
273+
- title: AvatarPreloader
274+
path: /reference/engine/classes/AvatarPreloader
275+
type: engineapi
276+
source: /reference/engine/classes/AvatarPreloader.yaml
277+
ignoreTranslation: true
268278
- title: Backpack
269279
path: /reference/engine/classes/Backpack
270280
type: engineapi
@@ -895,6 +905,11 @@ navigation:
895905
type: engineapi
896906
source: /reference/engine/classes/ExperienceNotificationService.yaml
897907
ignoreTranslation: true
908+
- title: ExplorerServiceVisibilityService
909+
path: /reference/engine/classes/ExplorerServiceVisibilityService
910+
type: engineapi
911+
source: /reference/engine/classes/ExplorerServiceVisibilityService.yaml
912+
ignoreTranslation: true
898913
- title: Explosion
899914
path: /reference/engine/classes/Explosion
900915
type: engineapi
@@ -1485,6 +1500,11 @@ navigation:
14851500
type: engineapi
14861501
source: /reference/engine/classes/MessagingService.yaml
14871502
ignoreTranslation: true
1503+
- title: MLModelDeliveryService
1504+
path: /reference/engine/classes/MLModelDeliveryService
1505+
type: engineapi
1506+
source: /reference/engine/classes/MLModelDeliveryService.yaml
1507+
ignoreTranslation: true
14881508
- title: Model
14891509
path: /reference/engine/classes/Model
14901510
type: engineapi
@@ -3423,6 +3443,11 @@ navigation:
34233443
type: engineapi
34243444
source: /reference/engine/enums/AudioFilterType.yaml
34253445
ignoreTranslation: true
3446+
- title: AudioSimulationFidelity
3447+
path: /reference/engine/enums/AudioSimulationFidelity
3448+
type: engineapi
3449+
source: /reference/engine/enums/AudioSimulationFidelity.yaml
3450+
ignoreTranslation: true
34263451
- title: AudioSubType
34273452
path: /reference/engine/enums/AudioSubType
34283453
type: engineapi
@@ -3723,6 +3748,11 @@ navigation:
37233748
type: engineapi
37243749
source: /reference/engine/enums/CoreGuiType.yaml
37253750
ignoreTranslation: true
3751+
- title: CreateAssetResult
3752+
path: /reference/engine/enums/CreateAssetResult
3753+
type: engineapi
3754+
source: /reference/engine/enums/CreateAssetResult.yaml
3755+
ignoreTranslation: true
37263756
- title: CreateOutfitFailure
37273757
path: /reference/engine/enums/CreateOutfitFailure
37283758
type: engineapi

‎content/en-us/reference/cloud/cloud.docs.json‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -504,6 +504,71 @@
504504
}
505505
}
506506
},
507+
"/cloud/v2/groups/{group}/memberships/{membership}": {
508+
"patch": {
509+
"tags": [
510+
"Cloud"
511+
],
512+
"description": "Updates the group membership for a particular group member. This action\n requires the requester to be able to manage lower ranked members. Guest or\n Owner ranks cannot be assigned, and a requester cannot change their own\n rank.",
513+
"operationId": "Cloud_UpdateGroupMembership",
514+
"parameters": [
515+
{
516+
"name": "group",
517+
"in": "path",
518+
"description": "The group ID.",
519+
"required": true,
520+
"schema": {
521+
"type": "string"
522+
}
523+
},
524+
{
525+
"name": "membership",
526+
"in": "path",
527+
"description": "The membership ID.",
528+
"required": true,
529+
"schema": {
530+
"type": "string"
531+
}
532+
}
533+
],
534+
"requestBody": {
535+
"content": {
536+
"application/json": {
537+
"schema": {
538+
"$ref": "#/components/schemas/GroupMembership"
539+
}
540+
}
541+
},
542+
"required": true
543+
},
544+
"responses": {
545+
"200": {
546+
"description": "OK",
547+
"content": {
548+
"application/json": {
549+
"schema": {
550+
"$ref": "#/components/schemas/GroupMembership"
551+
}
552+
}
553+
}
554+
}
555+
},
556+
"x-visibility": "BETA",
557+
"x-roblox-docs": {
558+
"category": "Users and Groups",
559+
"methodProperties": {
560+
"scopes": [
561+
"group:write"
562+
],
563+
"title": "Update Group Membership"
564+
},
565+
"resource": {
566+
"$ref": "#/components/schemas/GroupMembership",
567+
"name": "GroupMembership"
568+
}
569+
}
570+
}
571+
},
507572
"/cloud/v2/groups/{group}/roles": {
508573
"get": {
509574
"tags": [
@@ -577,6 +642,59 @@
577642
}
578643
}
579644
},
645+
"/cloud/v2/groups/{group}/roles/{role}": {
646+
"get": {
647+
"tags": [
648+
"Cloud"
649+
],
650+
"description": "Gets the group role.",
651+
"operationId": "Cloud_GetGroupRole",
652+
"parameters": [
653+
{
654+
"name": "group",
655+
"in": "path",
656+
"description": "The group ID.",
657+
"required": true,
658+
"schema": {
659+
"type": "string"
660+
}
661+
},
662+
{
663+
"name": "role",
664+
"in": "path",
665+
"description": "The role ID.",
666+
"required": true,
667+
"schema": {
668+
"type": "string"
669+
}
670+
}
671+
],
672+
"responses": {
673+
"200": {
674+
"description": "OK",
675+
"content": {
676+
"application/json": {
677+
"schema": {
678+
"$ref": "#/components/schemas/GroupRole"
679+
}
680+
}
681+
}
682+
}
683+
},
684+
"x-visibility": "BETA",
685+
"x-roblox-docs": {
686+
"category": "Users and Groups",
687+
"methodProperties": {
688+
"scopes": [],
689+
"title": "Get Group Role"
690+
},
691+
"resource": {
692+
"$ref": "#/components/schemas/GroupRole",
693+
"name": "GroupRole"
694+
}
695+
}
696+
}
697+
},
580698
"/cloud/v2/groups/{group}/shout": {
581699
"get": {
582700
"tags": [

‎content/en-us/reference/engine/classes/ActivityHistoryEventService.yaml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: ActivityHistoryEventService
2+
type: class
3+
category:
4+
memory_category: Instances
5+
summary: ''
6+
description: ''
7+
code_samples: []
8+
inherits:
9+
- Instance
10+
tags:
11+
- NotCreatable
12+
- Service
13+
deprecation_message: ''
14+
properties: []
15+
methods: []
16+
events:
17+
- name: ActivityHistoryEventService.WriteActivityHistoryEventFromStudio
18+
summary: ''
19+
description: ''
20+
code_samples: []
21+
parameters:
22+
- name: eventType
23+
type: int
24+
default:
25+
summary: ''
26+
- name: resourceId
27+
type: int64
28+
default:
29+
summary: ''
30+
- name: metadata
31+
type: string
32+
default:
33+
summary: ''
34+
tags: []
35+
deprecation_message: ''
36+
security: RobloxScriptSecurity
37+
thread_safety: Unsafe
38+
capabilities: []
39+
writeCapabilities: []
40+
callbacks: []

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

Lines changed: 59 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,67 @@ methods:
8888
thread_safety: Unsafe
8989
capabilities: []
9090
writeCapabilities: []
91+
- name: AssetService:CreateAssetAsync
92+
summary: ''
93+
description: ''
94+
code_samples: []
95+
parameters:
96+
- name: object
97+
type: Object
98+
default:
99+
summary: ''
100+
- name: assetType
101+
type: AssetType
102+
default:
103+
summary: ''
104+
- name: requestParameters
105+
type: Dictionary
106+
default: nil
107+
summary: ''
108+
returns:
109+
- type: Tuple
110+
summary: ''
111+
tags:
112+
- Yields
113+
deprecation_message: ''
114+
security: None
115+
thread_safety: Unsafe
116+
capabilities: []
117+
writeCapabilities: []
118+
- name: AssetService:CreateAssetVersionAsync
119+
summary: ''
120+
description: ''
121+
code_samples: []
122+
parameters:
123+
- name: object
124+
type: Object
125+
default:
126+
summary: ''
127+
- name: assetType
128+
type: AssetType
129+
default:
130+
summary: ''
131+
- name: assetId
132+
type: int64
133+
default:
134+
summary: ''
135+
- name: requestParameters
136+
type: Dictionary
137+
default: nil
138+
summary: ''
139+
returns:
140+
- type: Tuple
141+
summary: ''
142+
tags:
143+
- Yields
144+
deprecation_message: ''
145+
security: None
146+
thread_safety: Unsafe
147+
capabilities: []
148+
writeCapabilities: []
91149
- name: AssetService:CreateEditableImageAsync
92150
summary: |
93-
Creates a new `Class.EditableImage` object populated with the given
94-
image.
151+
Creates a new `Class.EditableImage` object populated with the given image.
95152
description: |
96153
Creates a new `Class.EditableImage` object populated with the given
97154
texture. Non-asset texture IDs such as `rbxthumb://` are supported. If

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

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,5 +131,32 @@ methods:
131131
thread_safety: Unsafe
132132
capabilities: []
133133
writeCapabilities: []
134-
events: []
134+
events:
135+
- name: AudioAnalyzer.WiringChanged
136+
summary: ''
137+
description: ''
138+
code_samples: []
139+
parameters:
140+
- name: connected
141+
type: bool
142+
default:
143+
summary: ''
144+
- name: pin
145+
type: string
146+
default:
147+
summary: ''
148+
- name: wire
149+
type: Wire
150+
default:
151+
summary: ''
152+
- name: instance
153+
type: Instance
154+
default:
155+
summary: ''
156+
tags: []
157+
deprecation_message: ''
158+
security: None
159+
thread_safety: Unsafe
160+
capabilities: []
161+
writeCapabilities: []
135162
callbacks: []

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

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,5 +128,32 @@ methods:
128128
thread_safety: Unsafe
129129
capabilities: []
130130
writeCapabilities: []
131-
events: []
131+
events:
132+
- name: AudioChorus.WiringChanged
133+
summary: ''
134+
description: ''
135+
code_samples: []
136+
parameters:
137+
- name: connected
138+
type: bool
139+
default:
140+
summary: ''
141+
- name: pin
142+
type: string
143+
default:
144+
summary: ''
145+
- name: wire
146+
type: Wire
147+
default:
148+
summary: ''
149+
- name: instance
150+
type: Instance
151+
default:
152+
summary: ''
153+
tags: []
154+
deprecation_message: ''
155+
security: None
156+
thread_safety: Unsafe
157+
capabilities: []
158+
writeCapabilities: []
132159
callbacks: []

0 commit comments

Comments
 (0)