@rbxts/types 1.0.915 → 1.0.917

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -99,6 +99,7 @@ interface Services {
99
99
  InstanceExtensionsService: InstanceExtensionsService;
100
100
  InstanceFileSyncService: InstanceFileSyncService;
101
101
  InternalMessagingService: InternalMessagingService;
102
+ InternalMessagingServiceVerifier: InternalMessagingServiceVerifier;
102
103
  InternalSyncService: InternalSyncService;
103
104
  IXPService: IXPService;
104
105
  JointsService: JointsService;
@@ -149,6 +150,7 @@ interface Services {
149
150
  PluginManagementService: PluginManagementService;
150
151
  PluginPolicyService: PluginPolicyService;
151
152
  PolicyService: PolicyService;
153
+ Preloaded: Preloaded;
152
154
  ProceduralBehaviorSchedulerService: ProceduralBehaviorSchedulerService;
153
155
  ProcessInstancePhysicsService: ProcessInstancePhysicsService;
154
156
  ProximityPromptService: ProximityPromptService;
@@ -169,6 +171,7 @@ interface Services {
169
171
  RunService: RunService;
170
172
  RuntimeContentService: RuntimeContentService;
171
173
  SafetyService: SafetyService;
174
+ SceneAnalysisService: SceneAnalysisService;
172
175
  ScriptChangeService: ScriptChangeService;
173
176
  ScriptCloneWatcher: ScriptCloneWatcher;
174
177
  ScriptCloneWatcherHelper: ScriptCloneWatcherHelper;
@@ -203,6 +206,7 @@ interface Services {
203
206
  StudioCameraService: StudioCameraService;
204
207
  StudioCaptureService: StudioCaptureService;
205
208
  StudioDeviceEmulatorService: StudioDeviceEmulatorService;
209
+ StudioDeviceSimulatorService: StudioDeviceSimulatorService;
206
210
  StudioPublishService: StudioPublishService;
207
211
  StudioScriptDebugEventListener: StudioScriptDebugEventListener;
208
212
  StudioSdkService: StudioSdkService;
@@ -621,7 +625,6 @@ interface Instances extends Services, CreatableInstances {
621
625
  DebuggerLuaResponse: DebuggerLuaResponse;
622
626
  DebuggerVariable: DebuggerVariable;
623
627
  DynamicRotate: DynamicRotate;
624
- EmotesPages: EmotesPages;
625
628
  ExplorerFilterAutocompleter: ExplorerFilterAutocompleter;
626
629
  FaceInstance: FaceInstance;
627
630
  FacialAnimationStreamingServiceStats: FacialAnimationStreamingServiceStats;
@@ -1048,8 +1051,9 @@ interface EditableImage extends RBXObject {
1048
1051
  * @param color Color of the circle.
1049
1052
  * @param transparency Transparency of the circle with 0 being fully opaque and 1 being fully transparent.
1050
1053
  * @param combineType How the pixels of the source image are blended with the pixels of the added image.
1054
+ * @param antiAliasing Determines whether anti-aliasing is applied to the circle. When set to `AntiAliasing.Enabled`, circle edges are soft. When set to `AntiAliasing.Disabled`, circle edges are hard.
1051
1055
  */
1052
- DrawCircle(this: EditableImage, center: Vector2, radius: number, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>): void;
1056
+ DrawCircle(this: EditableImage, center: Vector2, radius: number, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>, antiAliasing?: CastsToEnum<Enum.AntiAliasing>): void;
1053
1057
  /**
1054
1058
  * Draws another `EditableImage` into this `EditableImage` at the given position.
1055
1059
  *
@@ -1111,8 +1115,9 @@ interface EditableImage extends RBXObject {
1111
1115
  * @param color Color of the line.
1112
1116
  * @param transparency Transparency of the line.
1113
1117
  * @param combineType How the pixels of the source image are blended with the pixels of the added image.
1118
+ * @param antiAliasing Determines whether anti-aliasing is applied to the line. When set to `AntiAliasing.Enabled`, line edges are soft. When set to `AntiAliasing.Disabled`, line edges are hard.
1114
1119
  */
1115
- DrawLine(this: EditableImage, p1: Vector2, p2: Vector2, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>): void;
1120
+ DrawLine(this: EditableImage, p1: Vector2, p2: Vector2, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>, antiAliasing?: CastsToEnum<Enum.AntiAliasing>): void;
1116
1121
  /**
1117
1122
  * Draws a rectangle of the given size at the given top-left position.
1118
1123
  *
@@ -2928,6 +2933,9 @@ interface AdService extends Instance {
2928
2933
  * - **ThreadSafety**: Unsafe
2929
2934
  *
2930
2935
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterDisclosureButton)
2936
+ * @param this A class that allows the display of mobile video ads.
2937
+ * @param disclosureButton The `GuiButton` you want to mark as an ad disclosure.
2938
+ * @param adIntegrationPlacementId The id of the placement that this disclosure is attached to.
2931
2939
  */
2932
2940
  RegisterDisclosureButton(this: AdService, disclosureButton: GuiButton, adIntegrationPlacementId: string): void;
2933
2941
  /**
@@ -2961,6 +2969,7 @@ interface AdService extends Instance {
2961
2969
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#GetAdAvailabilityNowAsync)
2962
2970
  * @param this A class that allows the display of mobile video ads.
2963
2971
  * @param adFormat The format of the requested ad. For example, `RewardedVideo`.
2972
+ * @returns A dictionary with the `AdAvailabilityResult` for the requested ad format.
2964
2973
  */
2965
2974
  GetAdAvailabilityNowAsync(this: AdService, adFormat: CastsToEnum<Enum.AdFormat>): object;
2966
2975
  /**
@@ -2968,6 +2977,10 @@ interface AdService extends Instance {
2968
2977
  * - **Tags**: Yields
2969
2978
  *
2970
2979
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#GetCampaignEligibilityAsync)
2980
+ * @param this A class that allows the display of mobile video ads.
2981
+ * @param campaignId The id of the campaign that you want to check a `Player`'s eligibility for.
2982
+ * @param player The `Player` you want to check eligibility for. If omitted, it will default to `LocalPlayer`.
2983
+ * @returns A dictionary that looks like `{ IsEligible: boolean }`.
2971
2984
  */
2972
2985
  GetCampaignEligibilityAsync(this: AdService, campaignId: string, player?: Player): object;
2973
2986
  /**
@@ -3304,6 +3317,15 @@ interface AnimationClip extends Instance {
3304
3317
  * @deprecated
3305
3318
  */
3306
3319
  readonly _nominal_AnimationClip: unique symbol;
3320
+ /**
3321
+ * Returns the length (in seconds) of this `AnimationClip`. This will return `0` until the animation has fully loaded and thus may not be immediately available.
3322
+ *
3323
+ * - **ThreadSafety**: ReadSafe
3324
+ * - **Tags**: NotReplicated
3325
+ *
3326
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationClip#Length)
3327
+ */
3328
+ readonly Length: number;
3307
3329
  /**
3308
3330
  * Determines whether the animation stored in this `AnimationClip` is intended to loop.
3309
3331
  *
@@ -3966,6 +3988,12 @@ interface Animator extends Instance {
3966
3988
  * @param this Responsible for the playback and replication of `Animations`.
3967
3989
  */
3968
3990
  GetPlayingAnimationTracks(this: Animator): Array<AnimationTrack>;
3991
+ /**
3992
+ * - **ThreadSafety**: Unsafe
3993
+ *
3994
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#GetTrackByAnimationId)
3995
+ */
3996
+ GetTrackByAnimationId(this: Animator, animationId: ContentId): AnimationTrack;
3969
3997
  /**
3970
3998
  * Loads an `Animation` onto an `Animator`, returning an `AnimationTrack`.
3971
3999
  *
@@ -16674,7 +16702,7 @@ interface ExperienceInviteOptions extends Instance {
16674
16702
  */
16675
16703
  InviteMessageId: string;
16676
16704
  /**
16677
- * Roblox `UserId` of the specific connection to invite.
16705
+ * Roblox `UserId` of the specific friend to invite.
16678
16706
  *
16679
16707
  * - **ThreadSafety**: ReadSafe
16680
16708
  *
@@ -16682,7 +16710,7 @@ interface ExperienceInviteOptions extends Instance {
16682
16710
  */
16683
16711
  InviteUser: number;
16684
16712
  /**
16685
- * Used to set a parameter in `Player:GetJoinData()` when a connection joins from the invite notification.
16713
+ * Used to set a parameter in `Player:GetJoinData()` when a friend joins from the invite notification.
16686
16714
  *
16687
16715
  * - **ThreadSafety**: ReadSafe
16688
16716
  *
@@ -17573,6 +17601,8 @@ interface GeneratedFolder extends Folder {
17573
17601
  * - **ThreadSafety**: Unsafe
17574
17602
  *
17575
17603
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeneratedFolder#SetPrimaryPart)
17604
+ * @param this
17605
+ * @param part
17576
17606
  */
17577
17607
  SetPrimaryPart(this: GeneratedFolder, part: BasePart): void;
17578
17608
  }
@@ -17825,7 +17855,7 @@ interface GeometryService extends Instance {
17825
17855
  * - `Radius` — If provided, this will be the center of the area to be fragmented. Either `Origin` and `Radius` should both be provided, or neither.
17826
17856
  *
17827
17857
  *
17828
- * @returns An array of `Vector3` which is typically passed into `FragmentAsync()`. The output depends on the options provided. If `Origin` and `Radius` are provided, then the output array will contain several `Vector3` elements which will all be located within the radius, but the last element of the array will be an inner array containing many `Vector3` sites which are outside the radius. If `Origin` and `Radius` are not provided, the output will simply be an array of `Vector3` positions within the extents of the input `part`.
17858
+ * @returns An array of `Vector3` which is typically passed into `FragmentAsync()`. The output depends on the options provided. If `Origin` and `Radius` are provided, then the output array will contain several `Vector3` elements which will all be located within the radius, but the first element of the array will be an inner array containing many `Vector3` sites which are outside the radius. If `Origin` and `Radius` are not provided, the output will simply be an array of `Vector3` positions within the extents of the input `part`.
17829
17859
  */
17830
17860
  GenerateFragmentSites(this: GeometryService, part: BasePart, options?: object): Array<unknown>;
17831
17861
  /**
@@ -26214,6 +26244,21 @@ interface InternalMessagingService extends Instance {
26214
26244
  */
26215
26245
  readonly _nominal_InternalMessagingService: unique symbol;
26216
26246
  }
26247
+ /**
26248
+ * - **Tags**: NotCreatable, Service, NotReplicated
26249
+ *
26250
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InternalMessagingServiceVerifier)
26251
+ */
26252
+ interface InternalMessagingServiceVerifier extends Instance {
26253
+ /**
26254
+ * **DO NOT USE!**
26255
+ *
26256
+ * This field exists to force TypeScript to recognize this as a nominal type
26257
+ * @hidden
26258
+ * @deprecated
26259
+ */
26260
+ readonly _nominal_InternalMessagingServiceVerifier: unique symbol;
26261
+ }
26217
26262
  /**
26218
26263
  * - **Tags**: NotReplicated
26219
26264
  *
@@ -27861,7 +27906,7 @@ interface LogService extends Instance {
27861
27906
  */
27862
27907
  readonly _nominal_LogService: unique symbol;
27863
27908
  /**
27864
- * Clears the Roblox Studio output window.
27909
+ * Clears Roblox Studio's **Output** window.
27865
27910
  *
27866
27911
  * - **ThreadSafety**: Unsafe
27867
27912
  *
@@ -27870,14 +27915,19 @@ interface LogService extends Instance {
27870
27915
  */
27871
27916
  ClearOutput(this: LogService): void;
27872
27917
  /**
27918
+ * Logs a message at the `MessageType.MessageError` level and throws a structured error with optional context.
27919
+ *
27873
27920
  * - **ThreadSafety**: Unsafe
27874
27921
  * - **Tags**: CustomLuaState
27875
27922
  *
27876
27923
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Error)
27924
+ * @param this A service that allows you to read outputted text.
27925
+ * @param message The message string. Supports `{key}` template placeholders when a context table is provided.
27926
+ * @param context An optional dictionary of key-value pairs. When provided, `{key}` placeholders in the message are replaced with the corresponding values.
27877
27927
  */
27878
27928
  Error(this: LogService, message: string, context?: object): void;
27879
27929
  /**
27880
- * Returns a table of tables, each with the message string, message type, and timestamp of a message that the client displays in the output window.
27930
+ * Returns a table of tables, each with the message string, message type, and timestamp of a message that the client displays in the **Output** window.
27881
27931
  *
27882
27932
  * - **ThreadSafety**: Unsafe
27883
27933
  *
@@ -27886,31 +27936,52 @@ interface LogService extends Instance {
27886
27936
  */
27887
27937
  GetLogHistory(this: LogService): Array<LogInfo>;
27888
27938
  /**
27939
+ * Logs a message at the `MessageType.MessageInfo` level with optional structured context.
27940
+ *
27889
27941
  * - **ThreadSafety**: Unsafe
27890
27942
  * - **Tags**: CustomLuaState
27891
27943
  *
27892
27944
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Info)
27945
+ * @param this A service that allows you to read outputted text.
27946
+ * @param message The message string. Supports `{key}` template placeholders when a context table is provided.
27947
+ * @param context An optional dictionary of key-value pairs. When provided, `{key}` placeholders in the message are replaced with the corresponding values.
27893
27948
  */
27894
27949
  Info(this: LogService, message: string, context?: object): void;
27895
27950
  /**
27951
+ * Logs a message at the specified level with optional structured context.
27952
+ *
27896
27953
  * - **ThreadSafety**: Unsafe
27897
27954
  * - **Tags**: CustomLuaState
27898
27955
  *
27899
27956
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Log)
27957
+ * @param this A service that allows you to read outputted text.
27958
+ * @param messageType The `MessageType` specifying the log level.
27959
+ * @param message The message string. Supports `{key}` template placeholders when a context table is provided.
27960
+ * @param context An optional dictionary of key-value pairs. When provided, `{key}` placeholders in the message are replaced with the corresponding values.
27900
27961
  */
27901
27962
  Log(this: LogService, messageType: CastsToEnum<Enum.MessageType>, message: string, context?: object): void;
27902
27963
  /**
27964
+ * Logs a message at the `MessageType.MessageOutput` level with optional structured context.
27965
+ *
27903
27966
  * - **ThreadSafety**: Unsafe
27904
27967
  * - **Tags**: CustomLuaState
27905
27968
  *
27906
27969
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Output)
27970
+ * @param this A service that allows you to read outputted text.
27971
+ * @param message The message string. Supports `{key}` template placeholders when a context table is provided.
27972
+ * @param context An optional dictionary of key-value pairs. When provided, `{key}` placeholders in the message are replaced with the corresponding values.
27907
27973
  */
27908
27974
  Output(this: LogService, message: string, context?: object): void;
27909
27975
  /**
27976
+ * Logs a message at the `MessageType.MessageWarning` level with optional structured context.
27977
+ *
27910
27978
  * - **ThreadSafety**: Unsafe
27911
27979
  * - **Tags**: CustomLuaState
27912
27980
  *
27913
27981
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Warn)
27982
+ * @param this A service that allows you to read outputted text.
27983
+ * @param message The message string. Supports `{key}` template placeholders when a context table is provided.
27984
+ * @param context An optional dictionary of key-value pairs. When provided, `{key}` placeholders in the message are replaced with the corresponding values.
27914
27985
  */
27915
27986
  Warn(this: LogService, message: string, context?: object): void;
27916
27987
  /**
@@ -28304,6 +28375,18 @@ interface MarketplaceService extends Instance {
28304
28375
  * @deprecated
28305
28376
  */
28306
28377
  readonly _nominal_MarketplaceService: unique symbol;
28378
+ /**
28379
+ * - **ThreadSafety**: Unsafe
28380
+ *
28381
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#BindReceiptHandler)
28382
+ */
28383
+ BindReceiptHandler(this: MarketplaceService, transactionType: CastsToEnum<Enum.ReceiptType>, handler: Callback, filter?: Array<unknown>): RBXScriptConnection;
28384
+ /**
28385
+ * - **ThreadSafety**: Unsafe
28386
+ *
28387
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#OpenShop)
28388
+ */
28389
+ OpenShop(this: MarketplaceService, player: Player): void;
28307
28390
  /**
28308
28391
  * Prompts a user to purchase multiple avatar items with the given `assetId` or `bundleId`.
28309
28392
  *
@@ -28359,10 +28442,13 @@ interface MarketplaceService extends Instance {
28359
28442
  * Prompts a user to purchase Roblox Premium.
28360
28443
  *
28361
28444
  * - **ThreadSafety**: Unsafe
28445
+ * - **Tags**:
28362
28446
  *
28363
28447
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptPremiumPurchase)
28364
28448
  * @param this The service responsible for in-experience transactions.
28365
28449
  * @param player The user being prompted to purchase Premium.
28450
+ *
28451
+ * @deprecated PromptRobloxSubscriptionPurchase
28366
28452
  */
28367
28453
  PromptPremiumPurchase(this: MarketplaceService, player: Player): void;
28368
28454
  /**
@@ -28392,9 +28478,13 @@ interface MarketplaceService extends Instance {
28392
28478
  */
28393
28479
  PromptPurchase(this: MarketplaceService, player: Player, assetId: number, equipIfPurchased?: boolean, currencyType?: CastsToEnum<Enum.CurrencyType>): void;
28394
28480
  /**
28481
+ * Prompts a user to purchase a Roblox Plus subscription.
28482
+ *
28395
28483
  * - **ThreadSafety**: Unsafe
28396
28484
  *
28397
28485
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptRobloxSubscriptionPurchase)
28486
+ * @param this The service responsible for in-experience transactions.
28487
+ * @param user The `Player` to be prompted to purchase Roblox Plus.
28398
28488
  */
28399
28489
  PromptRobloxSubscriptionPurchase(this: MarketplaceService, user: Player): void;
28400
28490
  /**
@@ -28461,12 +28551,15 @@ interface MarketplaceService extends Instance {
28461
28551
  */
28462
28552
  GetProductInfoAsync(this: MarketplaceService, assetId: number, infoType?: CastsToEnum<Enum.InfoType>): object;
28463
28553
  /**
28554
+ * Returns the subscription details for the given user for the Roblox Subscription ecosystem.
28555
+ *
28464
28556
  * - **ThreadSafety**: Unsafe
28465
28557
  * - **Tags**: Yields
28466
28558
  *
28467
28559
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetRobloxSubscriptionDetailsAsync)
28468
28560
  * @param this The service responsible for in-experience transactions.
28469
- * @param user
28561
+ * @param user The user regarding whom to check the subscription status.
28562
+ * @returns A dictionary containing subscription details such as `IsSubscribed`, `IsOriginExperience`, and optionally `StartTime`.
28470
28563
  */
28471
28564
  GetRobloxSubscriptionDetailsAsync(this: MarketplaceService, user: Player): object;
28472
28565
  /**
@@ -28588,6 +28681,13 @@ interface MarketplaceService extends Instance {
28588
28681
  * @returns Indicates whether the given player's inventory contains the given bundle.
28589
28682
  */
28590
28683
  PlayerOwnsBundleAsync(this: MarketplaceService, player: Player, bundleId: number): boolean;
28684
+ /**
28685
+ * - **ThreadSafety**: Unsafe
28686
+ * - **Tags**: Yields
28687
+ *
28688
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptRobuxTransferAsync)
28689
+ */
28690
+ PromptRobuxTransferAsync(this: MarketplaceService, sender: Player, receiverUserId: number, amount: number): string;
28591
28691
  /**
28592
28692
  * Takes a list of product IDs and returns a personalized ordered list of those products.
28593
28693
  *
@@ -28685,6 +28785,8 @@ interface MarketplaceService extends Instance {
28685
28785
  */
28686
28786
  readonly PromptPurchaseFinished: RBXScriptSignal<(player: Player, assetId: number, isPurchased: boolean) => void>;
28687
28787
  /**
28788
+ * Fires when a purchase prompt for Roblox Plus is closed.
28789
+ *
28688
28790
  * - **ThreadSafety**: Unsafe
28689
28791
  *
28690
28792
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptRobloxSubscriptionPurchaseFinished)
@@ -33045,6 +33147,7 @@ interface ProceduralModel extends Model {
33045
33147
  * - **ThreadSafety**: Unsafe
33046
33148
  *
33047
33149
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#ForceGeneration)
33150
+ * @param this
33048
33151
  */
33049
33152
  ForceGeneration(this: ProceduralModel): boolean;
33050
33153
  /**
@@ -33052,6 +33155,7 @@ interface ProceduralModel extends Model {
33052
33155
  * - **Tags**: Yields
33053
33156
  *
33054
33157
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#WaitForGenerationAsync)
33158
+ * @param this
33055
33159
  */
33056
33160
  WaitForGenerationAsync(this: ProceduralModel): boolean;
33057
33161
  }
@@ -33833,7 +33937,7 @@ interface DataStoreVersionPages extends Pages<DataStoreObjectVersionInfo> {
33833
33937
  readonly _nominal_DataStoreVersionPages: unique symbol;
33834
33938
  }
33835
33939
  /**
33836
- * A special version of `Pages` that contains information about a player's connections.
33940
+ * A special version of `Pages` that contains information about a player's friends.
33837
33941
  *
33838
33942
  * - **Tags**: NotCreatable, NotReplicated
33839
33943
  *
@@ -33870,21 +33974,6 @@ interface InventoryPages<T = unknown> extends Pages<T> {
33870
33974
  */
33871
33975
  readonly _nominal_InventoryPages: unique symbol;
33872
33976
  }
33873
- /**
33874
- * - **Tags**: NotCreatable, NotReplicated
33875
- *
33876
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EmotesPages)
33877
- */
33878
- interface EmotesPages extends InventoryPages {
33879
- /**
33880
- * **DO NOT USE!**
33881
- *
33882
- * This field exists to force TypeScript to recognize this as a nominal type
33883
- * @hidden
33884
- * @deprecated
33885
- */
33886
- readonly _nominal_EmotesPages: unique symbol;
33887
- }
33888
33977
  /**
33889
33978
  * A special type of `Pages` object whose pages contain key-value pairs from a `MemoryStoreHashMap`.
33890
33979
  *
@@ -35177,6 +35266,8 @@ interface Player extends Instance {
35177
35266
  */
35178
35267
  get GameplayPaused(): boolean;
35179
35268
  /**
35269
+ * Indicates whether the player has an active Roblox subscription.
35270
+ *
35180
35271
  * - **ThreadSafety**: ReadSafe
35181
35272
  *
35182
35273
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#HasRobloxSubscription)
@@ -35540,31 +35631,38 @@ interface Player extends Instance {
35540
35631
  /**
35541
35632
  * **Deprecated:** This method has been superseded by `GetFriendsOnlineAsync()`.
35542
35633
  *
35543
- * Returns a dictionary of online connections. Returns the product information of an asset using its asset ID.
35634
+ * Returns a dictionary of online friends. Returns the product information of an asset using its asset ID.
35544
35635
  *
35545
35636
  * - **ThreadSafety**: Unsafe
35546
35637
  * - **Tags**: Yields
35547
35638
  *
35548
35639
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnline)
35549
35640
  * @param this An object that represents a presently connected client to the experience.
35550
- * @param maxFriends The maximum number of online connections to return.
35551
- * @returns A dictionary of online connections (see the table above).
35641
+ * @param maxFriends The maximum number of online friends to return.
35642
+ * @returns A dictionary of online friends (see the table above).
35552
35643
  *
35553
35644
  * @deprecated GetFriendsOnlineAsync
35554
35645
  */
35555
35646
  GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
35556
35647
  /**
35557
- * Returns a dictionary of online connections.
35648
+ * Returns a dictionary of online friends.
35558
35649
  *
35559
35650
  * - **ThreadSafety**: Unsafe
35560
35651
  * - **Tags**: Yields
35561
35652
  *
35562
35653
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnlineAsync)
35563
35654
  * @param this An object that represents a presently connected client to the experience.
35564
- * @param maxFriends The maximum number of online connections to return.
35565
- * @returns A dictionary of online connections (see the table above).
35655
+ * @param maxFriends The maximum number of online friends to return.
35656
+ * @returns A dictionary of online friends (see the table above).
35566
35657
  */
35567
35658
  GetFriendsOnlineAsync(this: Player, maxFriends?: number): Array<unknown>;
35659
+ /**
35660
+ * - **ThreadSafety**: Unsafe
35661
+ * - **Tags**: Yields
35662
+ *
35663
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsWhoPlayedAsync)
35664
+ */
35665
+ GetFriendsWhoPlayedAsync(this: Player): Array<unknown>;
35568
35666
  /**
35569
35667
  * **Deprecated:**
35570
35668
  *
@@ -35624,7 +35722,7 @@ interface Player extends Instance {
35624
35722
  /**
35625
35723
  * **Deprecated:** This function is obsolete because the "best friends" feature was removed. Use `Player:IsFriendsWithAsync()` instead.
35626
35724
  *
35627
- * Returns whether a player is connections with the specified user.
35725
+ * Returns whether a player is friends with the specified user.
35628
35726
  *
35629
35727
  * - **ThreadSafety**: Unsafe
35630
35728
  * - **Tags**: Yields
@@ -35639,7 +35737,7 @@ interface Player extends Instance {
35639
35737
  /**
35640
35738
  * **Deprecated:** This method has been superseded by the `Player:IsFriendsWithAsync()` method which should be used for new work.
35641
35739
  *
35642
- * Checks whether a player is a connection of the user with the given `Player.UserId`.
35740
+ * Checks whether a player is a friend of the user with the given `Player.UserId`.
35643
35741
  *
35644
35742
  * - **ThreadSafety**: Unsafe
35645
35743
  * - **Tags**: Yields
@@ -35647,13 +35745,13 @@ interface Player extends Instance {
35647
35745
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWith)
35648
35746
  * @param this An object that represents a presently connected client to the experience.
35649
35747
  * @param userId The `Player.UserId` of the specified player.
35650
- * @returns A boolean indicating whether a player is a connection of the specified user.
35748
+ * @returns A boolean indicating whether a player is a friend of the specified user.
35651
35749
  *
35652
35750
  * @deprecated IsFriendsWithAsync
35653
35751
  */
35654
35752
  IsFriendsWith(this: Player, userId: number): boolean;
35655
35753
  /**
35656
- * Checks whether a player is a connection of the user with the given `Player.UserId`.
35754
+ * Checks whether a player is a friend of the user with the given `Player.UserId`.
35657
35755
  *
35658
35756
  * - **ThreadSafety**: Unsafe
35659
35757
  * - **Tags**: Yields
@@ -35661,7 +35759,7 @@ interface Player extends Instance {
35661
35759
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWithAsync)
35662
35760
  * @param this An object that represents a presently connected client to the experience.
35663
35761
  * @param userId The `Player.UserId` of the specified player.
35664
- * @returns A boolean indicating whether a player is a connection of the specified user.
35762
+ * @returns A boolean indicating whether a player is a friend of the specified user.
35665
35763
  */
35666
35764
  IsFriendsWithAsync(this: Player, userId: number): boolean;
35667
35765
  /**
@@ -36436,7 +36534,7 @@ interface Players extends Instance {
36436
36534
  */
36437
36535
  GetCharacterAppearanceInfoAsync(this: Players, userId: number): CharacterAppearanceInfo;
36438
36536
  /**
36439
- * Returns a `FriendPages` object which contains information for all of the given player's connections.
36537
+ * Returns a `FriendPages` object which contains information for all of the given player's friends.
36440
36538
  *
36441
36539
  * - **ThreadSafety**: Unsafe
36442
36540
  * - **Tags**: Yields
@@ -37070,6 +37168,21 @@ interface SunRaysEffect extends PostEffect {
37070
37168
  */
37071
37169
  Spread: number;
37072
37170
  }
37171
+ /**
37172
+ * - **Tags**: NotCreatable, Service
37173
+ *
37174
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Preloaded)
37175
+ */
37176
+ interface Preloaded extends Instance {
37177
+ /**
37178
+ * **DO NOT USE!**
37179
+ *
37180
+ * This field exists to force TypeScript to recognize this as a nominal type
37181
+ * @hidden
37182
+ * @deprecated
37183
+ */
37184
+ readonly _nominal_Preloaded: unique symbol;
37185
+ }
37073
37186
  /**
37074
37187
  * - **Tags**: NotCreatable, Service, NotReplicated
37075
37188
  *
@@ -38318,6 +38431,8 @@ interface RunService extends Instance {
38318
38431
  */
38319
38432
  readonly Heartbeat: RBXScriptSignal<(deltaTime: number) => void>;
38320
38433
  /**
38434
+ * In the server authority model, fires during prediction when the engine detects that the client has diverged from the server's authoritative state. Intended for plugin-based debugging.
38435
+ *
38321
38436
  * - **ThreadSafety**: Unsafe
38322
38437
  *
38323
38438
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#Misprediction)
@@ -38364,6 +38479,8 @@ interface RunService extends Instance {
38364
38479
  */
38365
38480
  readonly RenderStepped: RBXScriptSignal<(deltaTime: number) => void>;
38366
38481
  /**
38482
+ * In the server authority model, this fires after rolling back the predicted state due to a misprediction, but before resimulation begins.
38483
+ *
38367
38484
  * - **ThreadSafety**: Unsafe
38368
38485
  *
38369
38486
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#Rollback)
@@ -38432,6 +38549,63 @@ interface SafetyService extends Instance {
38432
38549
  */
38433
38550
  readonly _nominal_SafetyService: unique symbol;
38434
38551
  }
38552
+ /**
38553
+ * - **Tags**: NotCreatable, Service, NotReplicated
38554
+ *
38555
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService)
38556
+ */
38557
+ interface SceneAnalysisService extends Instance {
38558
+ /**
38559
+ * **DO NOT USE!**
38560
+ *
38561
+ * This field exists to force TypeScript to recognize this as a nominal type
38562
+ * @hidden
38563
+ * @deprecated
38564
+ */
38565
+ readonly _nominal_SceneAnalysisService: unique symbol;
38566
+ /**
38567
+ * - **ThreadSafety**: Unsafe
38568
+ * - **Tags**: Yields
38569
+ *
38570
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetAnimationMemoryAsync)
38571
+ */
38572
+ GetAnimationMemoryAsync(this: SceneAnalysisService): object;
38573
+ /**
38574
+ * - **ThreadSafety**: Unsafe
38575
+ * - **Tags**: Yields
38576
+ *
38577
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetAudioMemoryAsync)
38578
+ */
38579
+ GetAudioMemoryAsync(this: SceneAnalysisService): object;
38580
+ /**
38581
+ * - **ThreadSafety**: Unsafe
38582
+ * - **Tags**: Yields
38583
+ *
38584
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetInstanceCompositionAsync)
38585
+ */
38586
+ GetInstanceCompositionAsync(this: SceneAnalysisService): object;
38587
+ /**
38588
+ * - **ThreadSafety**: Unsafe
38589
+ * - **Tags**: Yields
38590
+ *
38591
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetScriptMemoryAsync)
38592
+ */
38593
+ GetScriptMemoryAsync(this: SceneAnalysisService): object;
38594
+ /**
38595
+ * - **ThreadSafety**: Unsafe
38596
+ * - **Tags**: Yields
38597
+ *
38598
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetTriangleCompositionAsync)
38599
+ */
38600
+ GetTriangleCompositionAsync(this: SceneAnalysisService): object;
38601
+ /**
38602
+ * - **ThreadSafety**: Unsafe
38603
+ * - **Tags**: Yields
38604
+ *
38605
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetUnparentedInstancesAsync)
38606
+ */
38607
+ GetUnparentedInstancesAsync(this: SceneAnalysisService): object;
38608
+ }
38435
38609
  /**
38436
38610
  * A 2D user interface that allows users to capture and save screenshots to their local device.
38437
38611
  *
@@ -38912,6 +39086,18 @@ interface ControllerPartSensor extends ControllerSensor {
38912
39086
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor#HitNormal)
38913
39087
  */
38914
39088
  HitNormal: Vector3;
39089
+ /**
39090
+ * - **ThreadSafety**: ReadSafe
39091
+ *
39092
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor#LadderSearchHeight)
39093
+ */
39094
+ LadderSearchHeight: number;
39095
+ /**
39096
+ * - **ThreadSafety**: ReadSafe
39097
+ *
39098
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor#LadderSearchOffset)
39099
+ */
39100
+ LadderSearchOffset: number;
38915
39101
  /**
38916
39102
  * The distance from the sensor's parent `BasePart` to use when sensing other parts.
38917
39103
  *
@@ -41878,6 +42064,21 @@ interface StudioDeviceEmulatorService extends Instance {
41878
42064
  */
41879
42065
  readonly _nominal_StudioDeviceEmulatorService: unique symbol;
41880
42066
  }
42067
+ /**
42068
+ * - **Tags**: NotCreatable, Service, NotReplicated
42069
+ *
42070
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService)
42071
+ */
42072
+ interface StudioDeviceSimulatorService extends Instance {
42073
+ /**
42074
+ * **DO NOT USE!**
42075
+ *
42076
+ * This field exists to force TypeScript to recognize this as a nominal type
42077
+ * @hidden
42078
+ * @deprecated
42079
+ */
42080
+ readonly _nominal_StudioDeviceSimulatorService: unique symbol;
42081
+ }
41881
42082
  /**
41882
42083
  * - **Tags**: NotCreatable, NotReplicated
41883
42084
  *
@@ -42296,6 +42497,8 @@ interface StyleLink extends Instance {
42296
42497
  StyleSheet: StyleSheet | undefined;
42297
42498
  }
42298
42499
  /**
42500
+ * Instance used to set conditions such as `"MaxSize"` and `"PreferredInput"` for a `StyleRule`.
42501
+ *
42299
42502
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery)
42300
42503
  */
42301
42504
  interface StyleQuery extends Instance {
@@ -42308,6 +42511,8 @@ interface StyleQuery extends Instance {
42308
42511
  */
42309
42512
  readonly _nominal_StyleQuery: unique symbol;
42310
42513
  /**
42514
+ * A boolean that determines whether a `StyleRule.Selector` of `@` will match the `StyleQuery` name.
42515
+ *
42311
42516
  * - **ThreadSafety**: ReadSafe
42312
42517
  * - **Tags**: NotReplicated
42313
42518
  *
@@ -42315,35 +42520,43 @@ interface StyleQuery extends Instance {
42315
42520
  */
42316
42521
  readonly IsActive: boolean;
42317
42522
  /**
42523
+ * Returns the value of a specific condition in the `StyleQuery`.
42524
+ *
42318
42525
  * - **ThreadSafety**: Unsafe
42319
42526
  *
42320
42527
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#GetCondition)
42321
- * @param this
42322
- * @param name
42528
+ * @param this Instance used to set conditions such as `"MaxSize"` and `"PreferredInput"` for a `StyleRule`.
42529
+ * @param name String name of the condition, for example `"MaxSize"` or `"ViewportDisplaySize"`.
42530
+ * @returns Value of the condition.
42323
42531
  */
42324
42532
  GetCondition(this: StyleQuery, name: string): unknown;
42325
42533
  /**
42534
+ * Returns a dictionary of key-value pairs describing the conditoins set on the `StyleQuery`.
42535
+ *
42326
42536
  * - **ThreadSafety**: Unsafe
42327
42537
  *
42328
42538
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#GetConditions)
42329
- * @param this
42539
+ * @param this Instance used to set conditions such as `"MaxSize"` and `"PreferredInput"` for a `StyleRule`.
42540
+ * @returns Dictionary of key-value pairs describing the conditions set on the `StyleQuery`.
42330
42541
  */
42331
42542
  GetConditions(this: StyleQuery): object;
42332
42543
  /**
42333
42544
  * - **ThreadSafety**: Unsafe
42334
42545
  *
42335
42546
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#SetCondition)
42336
- * @param this
42337
- * @param name
42338
- * @param value
42547
+ * @param this Instance used to set conditions such as `"MaxSize"` and `"PreferredInput"` for a `StyleRule`.
42548
+ * @param name Condition name to set, for example `"MinSize"`.
42549
+ * @param value Condition value to set, for example `Vector2.new(100, 0)`.
42339
42550
  */
42340
42551
  SetCondition(this: StyleQuery, name: string, value: unknown): void;
42341
42552
  /**
42553
+ * Lets you declare and set multiple conditions of the `StyleQuery` at once.
42554
+ *
42342
42555
  * - **ThreadSafety**: Unsafe
42343
42556
  *
42344
42557
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#SetConditions)
42345
- * @param this
42346
- * @param conditions
42558
+ * @param this Instance used to set conditions such as `"MaxSize"` and `"PreferredInput"` for a `StyleRule`.
42559
+ * @param conditions Dictionary of key-value pairs defining the conditions to set.
42347
42560
  */
42348
42561
  SetConditions(this: StyleQuery, conditions: object): void;
42349
42562
  }
@@ -43419,6 +43632,13 @@ interface TestService extends Instance {
43419
43632
  * @param name
43420
43633
  */
43421
43634
  isFeatureEnabled(this: TestService, name: string): boolean;
43635
+ /**
43636
+ * - **ThreadSafety**: Unsafe
43637
+ * - **Tags**: Yields
43638
+ *
43639
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RequestValidationAsync)
43640
+ */
43641
+ RequestValidationAsync(this: TestService, artifactType: string, artifactName: string): unknown;
43422
43642
  /**
43423
43643
  * Fires when the server should collect a conditional test result.
43424
43644
  *