diff --git a/.github/actions/quality-checks/action.yml b/.github/actions/quality-checks/action.yml index b235d0452..2bbfbc968 100644 --- a/.github/actions/quality-checks/action.yml +++ b/.github/actions/quality-checks/action.yml @@ -9,6 +9,8 @@ inputs: description: Whether to check markdown lint CHECK_PROTECTED_FIELDS: description: Whether to check protected YAML fields + CHECK_RELATIVE_LINKS: + description: Whether to check relative links CHECK_RETEXT_ANALYSIS: description: Whether to check retext analysis COMMIT_HASH: @@ -49,6 +51,7 @@ runs: CHECK_LOCALIZED_CONTENT: ${{ inputs.CHECK_LOCALIZED_CONTENT }} CHECK_MARKDOWN_LINT: ${{ inputs.CHECK_MARKDOWN_LINT }} CHECK_PROTECTED_FIELDS: ${{ inputs.CHECK_PROTECTED_FIELDS }} + CHECK_RELATIVE_LINKS: ${{ inputs.CHECK_RELATIVE_LINKS }} CHECK_RETEXT_ANALYSIS: ${{ inputs.CHECK_RETEXT_ANALYSIS }} COMMIT_HASH: ${{ inputs.COMMIT_HASH }} POST_PULL_REQUEST_COMMENTS: ${{ inputs.POST_PULL_REQUEST_COMMENTS }} diff --git a/.github/workflows/content-checks.yml b/.github/workflows/content-checks.yml index 54d823975..1ed524fb4 100644 --- a/.github/workflows/content-checks.yml +++ b/.github/workflows/content-checks.yml @@ -76,6 +76,7 @@ jobs: CHECK_LOCALIZED_CONTENT: false CHECK_MARKDOWN_LINT: true CHECK_PROTECTED_FIELDS: true + CHECK_RELATIVE_LINKS: true CHECK_RETEXT_ANALYSIS: true COMMIT_HASH: ${{ github.event.pull_request.head.sha }} EVENT_NAME: ${{ github.event_name }} diff --git a/content/common/navigation/engine/reference.yaml b/content/common/navigation/engine/reference.yaml index 2e5b1634a..a80855810 100644 --- a/content/common/navigation/engine/reference.yaml +++ b/content/common/navigation/engine/reference.yaml @@ -440,11 +440,6 @@ navigation: type: engineapi source: /reference/engine/classes/BubbleChatMessageProperties.yaml ignoreTranslation: true - - title: BugReporterService - path: /reference/engine/classes/BugReporterService - type: engineapi - source: /reference/engine/classes/BugReporterService.yaml - ignoreTranslation: true - title: BuoyancySensor path: /reference/engine/classes/BuoyancySensor type: engineapi @@ -920,6 +915,11 @@ navigation: type: engineapi source: /reference/engine/classes/Feature.yaml ignoreTranslation: true + - title: FeatureRestrictionManager + path: /reference/engine/classes/FeatureRestrictionManager + type: engineapi + source: /reference/engine/classes/FeatureRestrictionManager.yaml + ignoreTranslation: true - title: File path: /reference/engine/classes/File type: engineapi @@ -1135,11 +1135,6 @@ navigation: type: engineapi source: /reference/engine/classes/HandlesBase.yaml ignoreTranslation: true - - title: HapticEffect - path: /reference/engine/classes/HapticEffect - type: engineapi - source: /reference/engine/classes/HapticEffect.yaml - ignoreTranslation: true - title: HapticService path: /reference/engine/classes/HapticService type: engineapi @@ -1360,11 +1355,6 @@ navigation: type: engineapi source: /reference/engine/classes/LineHandleAdornment.yaml ignoreTranslation: true - - title: LiveSyncService - path: /reference/engine/classes/LiveSyncService - type: engineapi - source: /reference/engine/classes/LiveSyncService.yaml - ignoreTranslation: true - title: LocalizationService path: /reference/engine/classes/LocalizationService type: engineapi @@ -2435,11 +2425,6 @@ navigation: type: engineapi source: /reference/engine/classes/StyleSheet.yaml ignoreTranslation: true - - title: StylingService - path: /reference/engine/classes/StylingService - type: engineapi - source: /reference/engine/classes/StylingService.yaml - ignoreTranslation: true - title: SunRaysEffect path: /reference/engine/classes/SunRaysEffect type: engineapi @@ -4088,11 +4073,6 @@ navigation: type: engineapi source: /reference/engine/enums/HandlesStyle.yaml ignoreTranslation: true - - title: HapticEffectType - path: /reference/engine/enums/HapticEffectType - type: engineapi - source: /reference/engine/enums/HapticEffectType.yaml - ignoreTranslation: true - title: HighlightDepthMode path: /reference/engine/enums/HighlightDepthMode type: engineapi diff --git a/content/en-us/reference/engine/classes/AudioPlayer.yaml b/content/en-us/reference/engine/classes/AudioPlayer.yaml index 0f90c34ba..7b056d818 100644 --- a/content/en-us/reference/engine/classes/AudioPlayer.yaml +++ b/content/en-us/reference/engine/classes/AudioPlayer.yaml @@ -15,8 +15,13 @@ tags: [] deprecation_message: '' properties: - name: AudioPlayer.Asset - summary: '' - description: '' + summary: | + The asset to be loaded into the `Class.AudioPlayer`. + description: | + The asset to be loaded into the `Class.AudioPlayer`. If + `Class.AudioPlayer.AutoLoad|AutoLoad` is `true`, the asset loads + immediately once this property is assigned. When loading is complete, + `Class.AudioPlayer.IsReady|IsReady` becomes `true`. code_samples: [] type: ContentId tags: [] @@ -37,16 +42,17 @@ properties: The asset to be loaded into the `Class.AudioPlayer`. description: | The asset to be loaded into the `Class.AudioPlayer`. If - `Class.AudioPlayer.AutoLoad|AutoLoad` is true, the asset loads immediately - once this property is assigned. When loading is complete, - `Class.AudioPlayer.IsReady|IsReady` becomes true. + `Class.AudioPlayer.AutoLoad|AutoLoad` is `true`, the asset loads + immediately once this property is assigned. When loading is complete, + `Class.AudioPlayer.IsReady|IsReady` becomes `true`. code_samples: [] type: string tags: - Hidden - NotReplicated - Deprecated - deprecation_message: '' + deprecation_message: | + This property is deprecated; use `Class.AudioPlayer.Asset|Asset` instead. security: read: None write: None @@ -60,12 +66,11 @@ properties: writeCapabilities: [] - name: AudioPlayer.AutoLoad summary: | - Controls whether `Class.AudioPlayer.AssetId|AssetId` loads automatically - once assigned. + Controls whether `Class.AudioPlayer.Asset|Asset` loads automatically once + assigned. description: | - Controls whether `Class.AudioPlayer.AssetId|AssetId` loads automatically - once assigned. If false, the asset will load upon the first attempt to - play. + Controls whether `Class.AudioPlayer.Asset|Asset` loads automatically once + assigned. If `false`, the asset will load upon the first attempt to play. code_samples: [] type: bool tags: [] @@ -266,7 +271,7 @@ properties: summary: | Denotes the length of the loaded asset. description: | - Denotes the length of the loaded `Class.AudioPlayer.AssetId|AssetId` in + Denotes the length of the loaded `Class.AudioPlayer.Asset|Asset` in seconds. code_samples: [] type: double @@ -290,7 +295,7 @@ properties: Tracks the current position of the playhead within the asset. description: | Tracks and controls the current position of the playhead within the - `Class.AudioPlayer.AssetId|AssetId`, in seconds. + `Class.AudioPlayer.Asset|Asset`, in seconds. code_samples: [] type: double tags: [] diff --git a/content/en-us/reference/engine/classes/ScriptEditorService.yaml b/content/en-us/reference/engine/classes/ScriptEditorService.yaml index 46ae48a4a..1369cd12b 100644 --- a/content/en-us/reference/engine/classes/ScriptEditorService.yaml +++ b/content/en-us/reference/engine/classes/ScriptEditorService.yaml @@ -234,7 +234,9 @@ methods: - `Response.items[n].preselect` If true, the editor sorts this completion item ahead of all others and selects it for the user by default. No effect if false or missing. - - `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. + - `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. If a callback returns a malformed result or encounters an error, the editor discards the modified Response table and uses the built-in diff --git a/content/en-us/reference/engine/classes/TextChatService.yaml b/content/en-us/reference/engine/classes/TextChatService.yaml index 8eb17bbf9..19199b111 100644 --- a/content/en-us/reference/engine/classes/TextChatService.yaml +++ b/content/en-us/reference/engine/classes/TextChatService.yaml @@ -291,10 +291,12 @@ methods: Determines whether a user has permission to chat in experiences. Factors such as parental control settings may prevent the user from sending messages. Errors if the userId is not in the current server. Note that - this method can be used with all current player `Class.Player.UserId|UserIds` in a `Class.Script` - with `Class.Script.RunContext|RunContext` of `Enum.RunContext.Server` or - `Enum.RunContext.Legacy`. This method can also be used in a `Class.LocalScript` - but only with the `Class.Player.UserId|UserId` of the local player. + this method can be used with all current player + `Class.Player.UserId|UserIds` in a `Class.Script` with + `Class.Script.RunContext|RunContext` of `Enum.RunContext.Server` or + `Enum.RunContext.Legacy`. This method can also be used in a + `Class.LocalScript` but only with the `Class.Player.UserId|UserId` of the + local player. code_samples: [] parameters: - name: userId