Skip to content

Commit 5412cce

Browse files
update Open Source Docs from Roblox internal teams
1 parent 9ca2287 commit 5412cce

File tree

124 files changed

+5458
-5724
lines changed

Some content is hidden

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

124 files changed

+5458
-5724
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4994,6 +4994,11 @@ navigation:
49944994
type: engineapi
49954995
source: /reference/engine/enums/PositionAlignmentMode.yaml
49964996
ignoreTranslation: true
4997+
- title: PredictionMode
4998+
path: /reference/engine/enums/PredictionMode
4999+
type: engineapi
5000+
source: /reference/engine/enums/PredictionMode.yaml
5001+
ignoreTranslation: true
49975002
- title: PreferredInput
49985003
path: /reference/engine/enums/PreferredInput
49995004
type: engineapi
@@ -5044,6 +5049,11 @@ navigation:
50445049
type: engineapi
50455050
source: /reference/engine/enums/PromptCreateAvatarResult.yaml
50465051
ignoreTranslation: true
5052+
- title: PromptLinkSharingResult
5053+
path: /reference/engine/enums/PromptLinkSharingResult
5054+
type: engineapi
5055+
source: /reference/engine/enums/PromptLinkSharingResult.yaml
5056+
ignoreTranslation: true
50475057
- title: PromptPublishAssetResult
50485058
path: /reference/engine/enums/PromptPublishAssetResult
50495059
type: engineapi

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ methods:
258258
A user defined category for items such as "Vehicle," "Weapon.".
259259
- name: amount
260260
type: int
261-
default:
261+
default: ''
262262
summary: |
263263
The amount of the currency.
264264
- name: currency
@@ -611,13 +611,13 @@ methods:
611611
experience.
612612
- name: amount
613613
type: float
614-
default:
614+
default: ''
615615
summary: |
616616
The amount of currency being added or removed. This value should
617617
always be positive.
618618
- name: endingBalance
619619
type: float
620-
default:
620+
default: ''
621621
summary: |
622622
The user's balance after the currency has been added or removed. This
623623
value should always be greater than or equal to 0.
@@ -638,7 +638,7 @@ methods:
638638
Limited to 20 unique types per experience.
639639
- name: itemSku
640640
type: string
641-
default:
641+
default: ''
642642
summary: |
643643
Optional SKU of the item or bundle being purchased. This is a unique
644644
identifier for the item being purchased. Limited to 100 unique SKUs
@@ -685,7 +685,7 @@ methods:
685685
funnel. Limited to 10 unique funnels per experience.
686686
- name: funnelSessionId
687687
type: string
688-
default:
688+
default: ''
689689
summary: |
690690
Optional unique identifier for the funnel session. This should be the
691691
same for all steps in the funnel.
@@ -708,7 +708,7 @@ methods:
708708
considered completed.
709709
- name: stepName
710710
type: string
711-
default:
711+
default: ''
712712
summary: |
713713
Optional name of the step in the funnel. This field is only used for
714714
display purposes in Roblox-provided charts.
@@ -748,7 +748,7 @@ methods:
748748
The user who triggered the event.
749749
- name: step
750750
type: int
751-
default:
751+
default: ''
752752
summary: |
753753
The step number in the funnel. This should be unique for each step in
754754
the funnel. All funnels start at step 1. Limited to steps 1-100.
@@ -757,7 +757,7 @@ methods:
757757
considered completed.
758758
- name: stepName
759759
type: string
760-
default:
760+
default: ''
761761
summary: |
762762
Optional name of the step in the funnel. This field is only used for
763763
display purposes in Roblox-provided charts.
@@ -798,11 +798,11 @@ methods:
798798
summary: ''
799799
- name: level
800800
type: int
801-
default:
801+
default: ''
802802
summary: ''
803803
- name: levelName
804804
type: string
805-
default:
805+
default: ''
806806
summary: ''
807807
- name: customFields
808808
type: Dictionary
@@ -842,11 +842,11 @@ methods:
842842
summary: ''
843843
- name: level
844844
type: int
845-
default:
845+
default: ''
846846
summary: ''
847847
- name: levelName
848848
type: string
849-
default:
849+
default: ''
850850
summary: ''
851851
- name: customFields
852852
type: Dictionary
@@ -880,11 +880,11 @@ methods:
880880
summary: ''
881881
- name: level
882882
type: int
883-
default:
883+
default: ''
884884
summary: ''
885885
- name: levelName
886886
type: string
887-
default:
887+
default: ''
888888
summary: ''
889889
- name: customFields
890890
type: Dictionary
@@ -918,11 +918,11 @@ methods:
918918
summary: ''
919919
- name: level
920920
type: int
921-
default:
921+
default: ''
922922
summary: ''
923923
- name: levelName
924924
type: string
925-
default:
925+
default: ''
926926
summary: ''
927927
- name: customFields
928928
type: Dictionary

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

Lines changed: 78 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -56,34 +56,6 @@ methods:
5656
capabilities:
5757
- Animation
5858
writeCapabilities: []
59-
- name: AnimationClipProvider:GetAnimationClipAsync
60-
summary: |
61-
Returns a `Class.AnimationClip` based on the specified assetId
62-
asynchronously.
63-
description: |
64-
Fetches an `Class.AnimationClip` based on the specified assetId. The
65-
assetId must correspond to an animation asset in Roblox. The function will
66-
yield until the `Class.AnimationClip` is loaded from the website and
67-
should be wrapped in a `pcall`.
68-
code_samples: []
69-
parameters:
70-
- name: assetId
71-
type: ContentId
72-
default:
73-
summary: |
74-
The content ID of the animation.
75-
returns:
76-
- type: AnimationClip
77-
summary: |
78-
The `Class.AnimationClip` found.
79-
tags:
80-
- Yields
81-
deprecation_message: ''
82-
security: None
83-
thread_safety: Unsafe
84-
capabilities:
85-
- Animation
86-
writeCapabilities: []
8759
- name: AnimationClipProvider:GetAnimationClipById
8860
summary: |
8961
Returns a `Class.AnimationClip` from the supplied assetId.
@@ -94,7 +66,7 @@ methods:
9466
parameters:
9567
- name: assetId
9668
type: int64
97-
default:
69+
default: ''
9870
summary: |
9971
The content ID of the animation.
10072
- name: useCache
@@ -117,55 +89,6 @@ methods:
11789
capabilities:
11890
- Animation
11991
writeCapabilities: []
120-
- name: AnimationClipProvider:GetAnimations
121-
summary: |
122-
This function returns an `Class.InventoryPages` object which can be used
123-
to iterate over animations owned by a specific user.
124-
description: |
125-
This function returns an `Class.InventoryPages` object which can be used
126-
to iterate over animations owned by a specific user.
127-
128-
This function has a number of potential uses, such as allowing users to
129-
browse and import animations into a custom animation plugin.
130-
code_samples: []
131-
parameters:
132-
- name: userId
133-
type: int64
134-
default:
135-
summary: |
136-
The user ID of the user.
137-
returns:
138-
- type: Instance
139-
summary: |
140-
An `Class.InventoryPages` of animations.
141-
tags:
142-
- Yields
143-
deprecation_message: ''
144-
security: None
145-
thread_safety: Unsafe
146-
capabilities:
147-
- Animation
148-
writeCapabilities: []
149-
- name: AnimationClipProvider:GetClipEvaluatorAsync
150-
summary: ''
151-
description: ''
152-
code_samples: []
153-
parameters:
154-
- name: assetId
155-
type: ContentId
156-
default:
157-
summary: ''
158-
returns:
159-
- type: ClipEvaluator
160-
summary: ''
161-
tags:
162-
- Yields
163-
deprecation_message: ''
164-
security: None
165-
thread_safety: Unsafe
166-
capabilities:
167-
- Animation
168-
writeCapabilities: []
16992
- name: AnimationClipProvider:RegisterActiveAnimationClip
17093
summary: |
17194
Generates a temporary asset ID from a `Class.AnimationClip` that can be
@@ -236,5 +159,82 @@ methods:
236159
capabilities:
237160
- Animation
238161
writeCapabilities: []
162+
- name: AnimationClipProvider:GetAnimationClipAsync
163+
summary: |
164+
Returns a `Class.AnimationClip` based on the specified assetId
165+
asynchronously.
166+
description: |
167+
Fetches an `Class.AnimationClip` based on the specified assetId. The
168+
assetId must correspond to an animation asset in Roblox. The function will
169+
yield until the `Class.AnimationClip` is loaded from the website and
170+
should be wrapped in a `pcall`.
171+
code_samples: []
172+
parameters:
173+
- name: assetId
174+
type: ContentId
175+
default:
176+
summary: |
177+
The content ID of the animation.
178+
returns:
179+
- type: AnimationClip
180+
summary: |
181+
The `Class.AnimationClip` found.
182+
tags:
183+
- Yields
184+
deprecation_message: ''
185+
security: None
186+
thread_safety: Unsafe
187+
capabilities:
188+
- Animation
189+
writeCapabilities: []
190+
- name: AnimationClipProvider:GetAnimations
191+
summary: |
192+
This function returns an `Class.InventoryPages` object which can be used
193+
to iterate over animations owned by a specific user.
194+
description: |
195+
This function returns an `Class.InventoryPages` object which can be used
196+
to iterate over animations owned by a specific user.
197+
198+
This function has a number of potential uses, such as allowing users to
199+
browse and import animations into a custom animation plugin.
200+
code_samples: []
201+
parameters:
202+
- name: userId
203+
type: int64
204+
default: ''
205+
summary: |
206+
The user ID of the user.
207+
returns:
208+
- type: Instance
209+
summary: |
210+
An `Class.InventoryPages` of animations.
211+
tags:
212+
- Yields
213+
deprecation_message: ''
214+
security: None
215+
thread_safety: Unsafe
216+
capabilities:
217+
- Animation
218+
writeCapabilities: []
219+
- name: AnimationClipProvider:GetClipEvaluatorAsync
220+
summary: ''
221+
description: ''
222+
code_samples: []
223+
parameters:
224+
- name: assetId
225+
type: ContentId
226+
default:
227+
summary: ''
228+
returns:
229+
- type: ClipEvaluator
230+
summary: ''
231+
tags:
232+
- Yields
233+
deprecation_message: ''
234+
security: None
235+
thread_safety: Unsafe
236+
capabilities:
237+
- Animation
238+
writeCapabilities: []
239239
events: []
240240
callbacks: []

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

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,25 @@ inherits:
1414
tags: []
1515
deprecation_message: ''
1616
properties: []
17-
methods: []
17+
methods:
18+
- name: AnimationRigData:LoadFromModel
19+
summary: ''
20+
description: ''
21+
code_samples: []
22+
parameters:
23+
- name: model
24+
type: Instance
25+
default:
26+
summary: ''
27+
returns:
28+
- type: boolean
29+
summary: ''
30+
tags: []
31+
deprecation_message: ''
32+
security: RobloxScriptSecurity
33+
thread_safety: Unsafe
34+
capabilities:
35+
- Animation
36+
writeCapabilities: []
1837
events: []
1938
callbacks: []

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ methods:
269269
parameters:
270270
- name: deltaTime
271271
type: float
272-
default:
272+
default: ''
273273
summary: |
274274
The amount of time in seconds animation playback is to be incremented
275275
by.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,11 @@ events:
9494
summary: ''
9595
- name: relativeAngle
9696
type: float
97-
default:
97+
default: ''
9898
summary: ''
9999
- name: deltaRadius
100100
type: float
101-
default:
101+
default: ''
102102
summary: ''
103103
tags: []
104104
deprecation_message: ''

0 commit comments

Comments
 (0)