Skip to content

Commit f1b66e8

Browse files
Merge branch 'main' into patch-12
2 parents a5bcab1 + 5d4e7ea commit f1b66e8

26 files changed

+78
-893
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/cloud/cloud.docs.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6173,6 +6173,13 @@
61736173
"privateServerDetails": {
61746174
"$ref": "#/components/schemas/InventoryItem_PrivateServerDetails",
61756175
"description": "Populated if this item is a private server."
6176+
},
6177+
"addTime": {
6178+
"readOnly": true,
6179+
"example": "2023-07-05T12:34:56Z",
6180+
"type": "string",
6181+
"description": "The time when the item was added to the user's inventory. For example, the time when the user purchased a private server or was awarded a badge. \n\n This field is currently not populated for passes.",
6182+
"format": "date-time"
61766183
}
61776184
},
61786185
"description": "Represents an item in a user's inventory.",

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

Lines changed: 1 addition & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -37,58 +37,6 @@ methods:
3737
thread_safety: Unsafe
3838
capabilities: []
3939
writeCapabilities: []
40-
- name: AdService:HandleWhyThisAdClicked
41-
summary: ''
42-
description: ''
43-
code_samples: []
44-
parameters:
45-
- name: advertiserName
46-
type: string
47-
default:
48-
summary: ''
49-
- name: payerName
50-
type: string
51-
default:
52-
summary: ''
53-
returns:
54-
- type: void
55-
summary: ''
56-
tags: []
57-
deprecation_message: ''
58-
security: RobloxScriptSecurity
59-
thread_safety: Unsafe
60-
capabilities: []
61-
writeCapabilities: []
62-
- name: AdService:OnDemandVideoCompleteFromUI
63-
summary: ''
64-
description: ''
65-
code_samples: []
66-
parameters:
67-
- name: result
68-
type: ShowAdResult
69-
default:
70-
summary: ''
71-
- name: encryptedAdTrackingData
72-
type: string
73-
default:
74-
summary: ''
75-
- name: encryptionMetadata
76-
type: string
77-
default:
78-
summary: ''
79-
- name: rewardDetails
80-
type: string
81-
default:
82-
summary: ''
83-
returns:
84-
- type: void
85-
summary: ''
86-
tags: []
87-
deprecation_message: ''
88-
security: RobloxScriptSecurity
89-
thread_safety: Unsafe
90-
capabilities: []
91-
writeCapabilities: []
9240
- name: AdService:ShowVideoAd
9341
summary: |
9442
Show mobile video advertisements.
@@ -173,22 +121,4 @@ events:
173121
thread_safety: Unsafe
174122
capabilities: []
175123
writeCapabilities: []
176-
callbacks:
177-
- name: AdService.onDemandVideoPlayInUI
178-
summary: ''
179-
description: ''
180-
code_samples: []
181-
parameters:
182-
- name: data
183-
type: Dictionary
184-
default:
185-
summary: ''
186-
returns:
187-
- type: VideoFrame
188-
summary: ''
189-
tags: []
190-
deprecation_message: ''
191-
security: RobloxScriptSecurity
192-
thread_safety: Unsafe
193-
capabilities: []
194-
writeCapabilities: []
124+
callbacks: []

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

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -160,20 +160,6 @@ methods:
160160
thread_safety: Unsafe
161161
capabilities: []
162162
writeCapabilities: []
163-
- name: AudioEcho:Reset
164-
summary: ''
165-
description: ''
166-
code_samples: []
167-
parameters: []
168-
returns:
169-
- type: void
170-
summary: ''
171-
tags: []
172-
deprecation_message: ''
173-
security: RobloxScriptSecurity
174-
thread_safety: Unsafe
175-
capabilities: []
176-
writeCapabilities: []
177163
events:
178164
- name: AudioEcho.WiringChanged
179165
summary: |

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

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -202,20 +202,6 @@ methods:
202202
thread_safety: Unsafe
203203
capabilities: []
204204
writeCapabilities: []
205-
- name: AudioListener:Reset
206-
summary: ''
207-
description: ''
208-
code_samples: []
209-
parameters: []
210-
returns:
211-
- type: void
212-
summary: ''
213-
tags: []
214-
deprecation_message: ''
215-
security: RobloxScriptSecurity
216-
thread_safety: Unsafe
217-
capabilities: []
218-
writeCapabilities: []
219205
- name: AudioListener:SetAngleAttenuation
220206
summary: |
221207
Sets the angle attenuation curve that the `Class.AudioListener` should

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

Lines changed: 34 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,45 @@ inherits:
1414
tags: []
1515
deprecation_message: ''
1616
properties:
17+
- name: AudioPlayer.Asset
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`.
25+
code_samples: []
26+
type: ContentId
27+
tags: []
28+
deprecation_message: ''
29+
security:
30+
read: None
31+
write: None
32+
thread_safety: ReadSafe
33+
category: Asset
34+
serialization:
35+
can_load: true
36+
can_save: true
37+
capabilities:
38+
- Audio
39+
writeCapabilities: []
1740
- name: AudioPlayer.AssetId
1841
summary: |
1942
The asset to be loaded into the `Class.AudioPlayer`.
2043
description: |
2144
The asset to be loaded into the `Class.AudioPlayer`. If
22-
`Class.AudioPlayer.AutoLoad|AutoLoad` is true, the asset loads immediately
23-
once this property is assigned. When loading is complete,
24-
`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`.
2548
code_samples: []
2649
type: string
2750
tags:
2851
- Hidden
2952
- NotReplicated
3053
- Deprecated
31-
deprecation_message: ''
54+
deprecation_message: |
55+
This property is deprecated; use `Class.AudioPlayer.Asset|Asset` instead.
3256
security:
3357
read: None
3458
write: None
@@ -42,12 +66,11 @@ properties:
4266
writeCapabilities: []
4367
- name: AudioPlayer.AutoLoad
4468
summary: |
45-
Controls whether `Class.AudioPlayer.AssetId|AssetId` loads automatically
46-
once assigned.
69+
Controls whether `Class.AudioPlayer.Asset|Asset` loads automatically once
70+
assigned.
4771
description: |
48-
Controls whether `Class.AudioPlayer.AssetId|AssetId` loads automatically
49-
once assigned. If false, the asset will load upon the first attempt to
50-
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.
5174
code_samples: []
5275
type: bool
5376
tags: []
@@ -248,7 +271,7 @@ properties:
248271
summary: |
249272
Denotes the length of the loaded asset.
250273
description: |
251-
Denotes the length of the loaded `Class.AudioPlayer.AssetId|AssetId` in
274+
Denotes the length of the loaded `Class.AudioPlayer.Asset|Asset` in
252275
seconds.
253276
code_samples: []
254277
type: double
@@ -272,7 +295,7 @@ properties:
272295
Tracks the current position of the playhead within the asset.
273296
description: |
274297
Tracks and controls the current position of the playhead within the
275-
`Class.AudioPlayer.AssetId|AssetId`, in seconds.
298+
`Class.AudioPlayer.Asset|Asset`, in seconds.
276299
code_samples: []
277300
type: double
278301
tags: []

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

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -317,20 +317,6 @@ methods:
317317
thread_safety: Unsafe
318318
capabilities: []
319319
writeCapabilities: []
320-
- name: AudioReverb:Reset
321-
summary: ''
322-
description: ''
323-
code_samples: []
324-
parameters: []
325-
returns:
326-
- type: void
327-
summary: ''
328-
tags: []
329-
deprecation_message: ''
330-
security: RobloxScriptSecurity
331-
thread_safety: Unsafe
332-
capabilities: []
333-
writeCapabilities: []
334320
events:
335321
- name: AudioReverb.WiringChanged
336322
summary: |

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

Lines changed: 0 additions & 48 deletions
This file was deleted.

0 commit comments

Comments
 (0)