Skip to content

Commit 4682d46

Browse files
authored
Merge branch 'main' into patch-11
2 parents c68e798 + 5d4e7ea commit 4682d46

File tree

6 files changed

+36
-43
lines changed

6 files changed

+36
-43
lines changed

.github/actions/quality-checks/action.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ inputs:
99
description: Whether to check markdown lint
1010
CHECK_PROTECTED_FIELDS:
1111
description: Whether to check protected YAML fields
12+
CHECK_RELATIVE_LINKS:
13+
description: Whether to check relative links
1214
CHECK_RETEXT_ANALYSIS:
1315
description: Whether to check retext analysis
1416
COMMIT_HASH:
@@ -49,6 +51,7 @@ runs:
4951
CHECK_LOCALIZED_CONTENT: ${{ inputs.CHECK_LOCALIZED_CONTENT }}
5052
CHECK_MARKDOWN_LINT: ${{ inputs.CHECK_MARKDOWN_LINT }}
5153
CHECK_PROTECTED_FIELDS: ${{ inputs.CHECK_PROTECTED_FIELDS }}
54+
CHECK_RELATIVE_LINKS: ${{ inputs.CHECK_RELATIVE_LINKS }}
5255
CHECK_RETEXT_ANALYSIS: ${{ inputs.CHECK_RETEXT_ANALYSIS }}
5356
COMMIT_HASH: ${{ inputs.COMMIT_HASH }}
5457
POST_PULL_REQUEST_COMMENTS: ${{ inputs.POST_PULL_REQUEST_COMMENTS }}

.github/workflows/content-checks.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ jobs:
7676
CHECK_LOCALIZED_CONTENT: false
7777
CHECK_MARKDOWN_LINT: true
7878
CHECK_PROTECTED_FIELDS: true
79+
CHECK_RELATIVE_LINKS: true
7980
CHECK_RETEXT_ANALYSIS: true
8081
COMMIT_HASH: ${{ github.event.pull_request.head.sha }}
8182
EVENT_NAME: ${{ github.event_name }}

content/common/navigation/engine/reference.yaml

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -440,11 +440,6 @@ navigation:
440440
type: engineapi
441441
source: /reference/engine/classes/BubbleChatMessageProperties.yaml
442442
ignoreTranslation: true
443-
- title: BugReporterService
444-
path: /reference/engine/classes/BugReporterService
445-
type: engineapi
446-
source: /reference/engine/classes/BugReporterService.yaml
447-
ignoreTranslation: true
448443
- title: BuoyancySensor
449444
path: /reference/engine/classes/BuoyancySensor
450445
type: engineapi
@@ -920,6 +915,11 @@ navigation:
920915
type: engineapi
921916
source: /reference/engine/classes/Feature.yaml
922917
ignoreTranslation: true
918+
- title: FeatureRestrictionManager
919+
path: /reference/engine/classes/FeatureRestrictionManager
920+
type: engineapi
921+
source: /reference/engine/classes/FeatureRestrictionManager.yaml
922+
ignoreTranslation: true
923923
- title: File
924924
path: /reference/engine/classes/File
925925
type: engineapi
@@ -1135,11 +1135,6 @@ navigation:
11351135
type: engineapi
11361136
source: /reference/engine/classes/HandlesBase.yaml
11371137
ignoreTranslation: true
1138-
- title: HapticEffect
1139-
path: /reference/engine/classes/HapticEffect
1140-
type: engineapi
1141-
source: /reference/engine/classes/HapticEffect.yaml
1142-
ignoreTranslation: true
11431138
- title: HapticService
11441139
path: /reference/engine/classes/HapticService
11451140
type: engineapi
@@ -1360,11 +1355,6 @@ navigation:
13601355
type: engineapi
13611356
source: /reference/engine/classes/LineHandleAdornment.yaml
13621357
ignoreTranslation: true
1363-
- title: LiveSyncService
1364-
path: /reference/engine/classes/LiveSyncService
1365-
type: engineapi
1366-
source: /reference/engine/classes/LiveSyncService.yaml
1367-
ignoreTranslation: true
13681358
- title: LocalizationService
13691359
path: /reference/engine/classes/LocalizationService
13701360
type: engineapi
@@ -2435,11 +2425,6 @@ navigation:
24352425
type: engineapi
24362426
source: /reference/engine/classes/StyleSheet.yaml
24372427
ignoreTranslation: true
2438-
- title: StylingService
2439-
path: /reference/engine/classes/StylingService
2440-
type: engineapi
2441-
source: /reference/engine/classes/StylingService.yaml
2442-
ignoreTranslation: true
24432428
- title: SunRaysEffect
24442429
path: /reference/engine/classes/SunRaysEffect
24452430
type: engineapi
@@ -4088,11 +4073,6 @@ navigation:
40884073
type: engineapi
40894074
source: /reference/engine/enums/HandlesStyle.yaml
40904075
ignoreTranslation: true
4091-
- title: HapticEffectType
4092-
path: /reference/engine/enums/HapticEffectType
4093-
type: engineapi
4094-
source: /reference/engine/enums/HapticEffectType.yaml
4095-
ignoreTranslation: true
40964076
- title: HighlightDepthMode
40974077
path: /reference/engine/enums/HighlightDepthMode
40984078
type: engineapi

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

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,13 @@ tags: []
1515
deprecation_message: ''
1616
properties:
1717
- name: AudioPlayer.Asset
18-
summary: ''
19-
description: ''
18+
summary: |
19+
The asset to be loaded into the `Class.AudioPlayer`.
20+
description: |
21+
The asset to be loaded into the `Class.AudioPlayer`. If
22+
`Class.AudioPlayer.AutoLoad|AutoLoad` is `true`, the asset loads
23+
immediately once this property is assigned. When loading is complete,
24+
`Class.AudioPlayer.IsReady|IsReady` becomes `true`.
2025
code_samples: []
2126
type: ContentId
2227
tags: []
@@ -37,16 +42,17 @@ properties:
3742
The asset to be loaded into the `Class.AudioPlayer`.
3843
description: |
3944
The asset to be loaded into the `Class.AudioPlayer`. If
40-
`Class.AudioPlayer.AutoLoad|AutoLoad` is true, the asset loads immediately
41-
once this property is assigned. When loading is complete,
42-
`Class.AudioPlayer.IsReady|IsReady` becomes true.
45+
`Class.AudioPlayer.AutoLoad|AutoLoad` is `true`, the asset loads
46+
immediately once this property is assigned. When loading is complete,
47+
`Class.AudioPlayer.IsReady|IsReady` becomes `true`.
4348
code_samples: []
4449
type: string
4550
tags:
4651
- Hidden
4752
- NotReplicated
4853
- Deprecated
49-
deprecation_message: ''
54+
deprecation_message: |
55+
This property is deprecated; use `Class.AudioPlayer.Asset|Asset` instead.
5056
security:
5157
read: None
5258
write: None
@@ -60,12 +66,11 @@ properties:
6066
writeCapabilities: []
6167
- name: AudioPlayer.AutoLoad
6268
summary: |
63-
Controls whether `Class.AudioPlayer.AssetId|AssetId` loads automatically
64-
once assigned.
69+
Controls whether `Class.AudioPlayer.Asset|Asset` loads automatically once
70+
assigned.
6571
description: |
66-
Controls whether `Class.AudioPlayer.AssetId|AssetId` loads automatically
67-
once assigned. If false, the asset will load upon the first attempt to
68-
play.
72+
Controls whether `Class.AudioPlayer.Asset|Asset` loads automatically once
73+
assigned. If `false`, the asset will load upon the first attempt to play.
6974
code_samples: []
7075
type: bool
7176
tags: []
@@ -266,7 +271,7 @@ properties:
266271
summary: |
267272
Denotes the length of the loaded asset.
268273
description: |
269-
Denotes the length of the loaded `Class.AudioPlayer.AssetId|AssetId` in
274+
Denotes the length of the loaded `Class.AudioPlayer.Asset|Asset` in
270275
seconds.
271276
code_samples: []
272277
type: double
@@ -290,7 +295,7 @@ properties:
290295
Tracks the current position of the playhead within the asset.
291296
description: |
292297
Tracks and controls the current position of the playhead within the
293-
`Class.AudioPlayer.AssetId|AssetId`, in seconds.
298+
`Class.AudioPlayer.Asset|Asset`, in seconds.
294299
code_samples: []
295300
type: double
296301
tags: []

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,9 @@ methods:
234234
- `Response.items[n].preselect` If true, the editor sorts this completion
235235
item ahead of all others and selects it for the user by default. No
236236
effect if false or missing.
237-
- `Response.items[n].textEdit` If present, accepting the completion applies this text edit - inserting or replacing the span between the positions start and end with newText.
237+
- `Response.items[n].textEdit` If present, accepting the completion
238+
applies this text edit - inserting or replacing the span between the
239+
positions start and end with newText.
238240
239241
If a callback returns a malformed result or encounters an error, the
240242
editor discards the modified Response table and uses the built-in

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -291,10 +291,12 @@ methods:
291291
Determines whether a user has permission to chat in experiences. Factors
292292
such as parental control settings may prevent the user from sending
293293
messages. Errors if the userId is not in the current server. Note that
294-
this method can be used with all current player `Class.Player.UserId|UserIds` in a `Class.Script`
295-
with `Class.Script.RunContext|RunContext` of `Enum.RunContext.Server` or
296-
`Enum.RunContext.Legacy`. This method can also be used in a `Class.LocalScript`
297-
but only with the `Class.Player.UserId|UserId` of the local player.
294+
this method can be used with all current player
295+
`Class.Player.UserId|UserIds` in a `Class.Script` with
296+
`Class.Script.RunContext|RunContext` of `Enum.RunContext.Server` or
297+
`Enum.RunContext.Legacy`. This method can also be used in a
298+
`Class.LocalScript` but only with the `Class.Player.UserId|UserId` of the
299+
local player.
298300
code_samples: []
299301
parameters:
300302
- name: userId

0 commit comments

Comments
 (0)