Skip to content

Commit 7a8aa12

Browse files
update Open Source Docs from Roblox internal teams
1 parent 142fcd9 commit 7a8aa12

38 files changed

Lines changed: 148 additions & 341 deletions

content/common/navigation/engine/reference.yaml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5722,11 +5722,6 @@ navigation:
57225722
type: engineapi
57235723
source: /reference/engine/enums/SizeConstraint.yaml
57245724
ignoreTranslation: true
5725-
- title: SlimTintMode
5726-
path: /reference/engine/enums/SlimTintMode
5727-
type: engineapi
5728-
source: /reference/engine/enums/SlimTintMode.yaml
5729-
ignoreTranslation: true
57305725
- title: SolverConvergenceMetricType
57315726
path: /reference/engine/enums/SolverConvergenceMetricType
57325727
type: engineapi

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

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ properties:
3535
type: string
3636
tags:
3737
- Deprecated
38-
deprecation_message: |
39-
This property is deprecated. Do not use it for new work.
38+
deprecation_message: ''
4039
security:
4140
read: LocalUserSecurity
4241
write: LocalUserSecurity
@@ -53,8 +52,7 @@ methods:
5352
Fires a custom event with a custom event name and data.
5453
description: |
5554
This function triggers a custom event with a custom event name data.
56-
code_samples:
57-
- analytics-event---custom
55+
code_samples: []
5856
parameters:
5957
- name: player
6058
type: Instance
@@ -123,12 +121,12 @@ methods:
123121
- name: AnalyticsService:FireInGameEconomyEvent
124122
summary: |
125123
Fire an event used to track player actions pertaining to the in-game
124+
economy.
126125
description: |
127126
This function triggers an event used to track player actions pertaining to
128127
the in-game economy. For example, it should be called to track when
129128
players acquire or spend virtual items within the economy like currency.
130-
code_samples:
131-
- analytics-event---economy
129+
code_samples: []
132130
parameters:
133131
- name: player
134132
type: Instance
@@ -206,8 +204,7 @@ methods:
206204
experienced by players. For example, it could be called to indicate when a
207205
function call fails, such as a datastore save or
208206
`Class.TeleportService:Teleport()`. See the example below.
209-
code_samples:
210-
- analytics-event---log
207+
code_samples: []
211208
parameters:
212209
- name: player
213210
type: Instance
@@ -242,8 +239,7 @@ methods:
242239
No return.
243240
tags:
244241
- Deprecated
245-
deprecation_message: |
246-
This method is deprecated. Do not use it for new work.
242+
deprecation_message: ''
247243
security: None
248244
thread_safety: Unsafe
249245
capabilities:
@@ -255,8 +251,7 @@ methods:
255251
This function triggers an event used to track player progression through
256252
the game. For example, it should be called when a player starts an in-game
257253
tutorial and again that player finishes the tutorial.
258-
code_samples:
259-
- analytics-event---progression
254+
code_samples: []
260255
parameters:
261256
- name: player
262257
type: Instance

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -610,10 +610,7 @@ methods:
610610
tags:
611611
- Yields
612612
- Deprecated
613-
deprecation_message: |
614-
Use
615-
`Class.AssetService:GetAssetIdsForPackageAsync()|GetAssetIdsForPackageAsync()`
616-
instead.
613+
deprecation_message: ''
617614
security: None
618615
thread_safety: Unsafe
619616
capabilities:
@@ -968,8 +965,7 @@ methods:
968965
tags:
969966
- Yields
970967
- Deprecated
971-
deprecation_message: |
972-
Use `Class.AssetService:SearchAudioAsync()|SearchAudioAsync()` instead.
968+
deprecation_message: ''
973969
security: None
974970
thread_safety: Unsafe
975971
capabilities:

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,7 @@ properties:
9090
tags:
9191
- NotReplicated
9292
- Deprecated
93-
deprecation_message: |
94-
Use `Class.AudioSearchParams.AudioSubType|AudioSubType` instead.
93+
deprecation_message: ''
9594
security:
9695
read: None
9796
write: None

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

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -902,7 +902,10 @@ methods:
902902
type: AccessoryType
903903
default:
904904
summary: |
905-
The `Enum.AccessoryType` the instance is expected to be.
905+
`Enum.AccessoryType` the instance is expected to be. Expects
906+
`Enum.AccessoryType.Eyebrow|Eyebrow`,
907+
`Enum.AccessoryType.Eyelash|Eyelash`, or
908+
`Enum.AccessoryType.Hair|Hair`.
906909
returns:
907910
- type: Tuple
908911
summary: |
@@ -975,10 +978,10 @@ methods:
975978
instances in the `Class.HumanoidDescription` will be validated.
976979
977980
The `Class.HumanoidDescription` is expected to include instances set on
978-
`Class.BodyPartDescription` children for each of the six required
981+
`Class.BodyPartDescription` children for each of the 6 required
979982
`Enum.BodyPart` values. Optionally, it can include instances set on
980-
`Class.AccessoryDescription` children for any supported
981-
`Enum.AccessoryType`.
983+
`Class.AccessoryDescription` children for `Eyebrow`, `Eyelash`, and `Hair`
984+
`Enum.AccessoryType|AccessoryTypes`.
982985
code_samples: []
983986
parameters:
984987
- name: player

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@ methods:
4646
tags:
4747
- Yields
4848
- Deprecated
49-
deprecation_message: |
50-
Use `Class.BadgeService:AwardBadgeAsync()|AwardBadgeAsync()` instead.
49+
deprecation_message: ''
5150
security: None
5251
thread_safety: Unsafe
5352
capabilities:
@@ -235,7 +234,8 @@ methods:
235234
Badges that are associated with special events are a common reason for a
236235
badge to be disabled. Often, it is easier to simply disable a badge
237236
instead of hard-coding a time check for when some event ends.
238-
code_samples: []
237+
code_samples:
238+
- BadgeService-IsDisabled1
239239
parameters:
240240
- name: badgeId
241241
type: int64

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@ description: |
4545
- If parented to a `Class.Tool` and given the name **Handle**, a
4646
`Class.BasePart` can be held by characters. See
4747
[In-Experience Tools](../../../players/tools.md).
48-
code_samples:
49-
- SmoothDamp-CFrame
48+
code_samples: []
5049
inherits:
5150
- PVInstance
5251
descendants:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ methods:
2626
- name: BasePlayerGui:GetGuiObjectsAtPosition
2727
summary: |
2828
Returns a list of all `Class.GuiObject` instances occupying the given
29+
point on the screen.
2930
description: |
3031
Takes a screen position and returns a list of all the `Class.GuiObject`
3132
instances which are occupying that screen position, sorted in the order
@@ -36,8 +37,7 @@ methods:
3637
Since the child classes of `Class.BasePlayerGui` inherit this function, it
3738
can be fired by container classes such as `Class.PlayerGui` and
3839
`Class.StarterGui`.
39-
code_samples:
40-
- selecting-guis-at-a-position
40+
code_samples: []
4141
parameters:
4242
- name: x
4343
type: int

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

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -329,20 +329,8 @@ properties:
329329
capabilities:
330330
- Basic
331331
- name: Beam.LocalTransparencyModifier
332-
summary: |
333-
Determines a multiplier for `Class.Beam.Transparency` that is only visible
334-
to the local client.
335-
description: |
336-
The `LocalTransparencyModifier` property is a multiplier applied to the
337-
beam's `Class.Beam.Transparency|Transparency` that is only visible to the
338-
local client. It does not replicate from client to server and is useful
339-
for when a beam should not render for a specific client.
340-
341-
Uses the same formula as `Class.BasePart.LocalTransparencyModifier`.
342-
343-
A value of `0` (default) has no effect on the beam's transparency. A value
344-
of `1` makes the beam completely invisible to the local client regardless
345-
of its `Class.Beam.Transparency|Transparency` value.
332+
summary: ''
333+
description: ''
346334
code_samples: []
347335
type: float
348336
tags:

0 commit comments

Comments
 (0)