@rbxts/types 1.0.863 → 1.0.865

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.
@@ -60,6 +60,7 @@ interface Services {
60
60
  EditableService: EditableService;
61
61
  EventIngestService: EventIngestService;
62
62
  ExampleService: ExampleService;
63
+ ExampleV2Service: ExampleV2Service;
63
64
  ExperienceAuthService: ExperienceAuthService;
64
65
  ExperienceNotificationService: ExperienceNotificationService;
65
66
  ExperienceService: ExperienceService;
@@ -5964,13 +5965,15 @@ interface AudioPlayer extends Instance {
5964
5965
  */
5965
5966
  Stop(this: AudioPlayer): void;
5966
5967
  /**
5968
+ * Returns a list of samples across a time range for the given audio.
5969
+ *
5967
5970
  * - **ThreadSafety**: Unsafe
5968
5971
  * - **Tags**: Yields
5969
5972
  *
5970
5973
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetWaveformAsync)
5971
5974
  * @param this Used to play audio assets.
5972
- * @param timeRange
5973
- * @param samples
5975
+ * @param timeRange A `NumberRange` which represents the start and end point of where to sample the audio.
5976
+ * @param samples The number of samples to return.
5974
5977
  */
5975
5978
  GetWaveformAsync(this: AudioPlayer, timeRange: NumberRange, samples: number): Array<unknown>;
5976
5979
  /**
@@ -6534,13 +6537,15 @@ interface AudioTextToSpeech extends Instance {
6534
6537
  */
6535
6538
  Unload(this: AudioTextToSpeech): void;
6536
6539
  /**
6540
+ * Returns a list of samples across a time range for the given audio.
6541
+ *
6537
6542
  * - **ThreadSafety**: Unsafe
6538
6543
  * - **Tags**: Yields
6539
6544
  *
6540
6545
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetWaveformAsync)
6541
6546
  * @param this Plays text as speech audio.
6542
- * @param timeRange
6543
- * @param samples
6547
+ * @param timeRange A `NumberRange` which represents the start and end point of where to sample the audio.
6548
+ * @param samples The number of samples to return.
6544
6549
  */
6545
6550
  GetWaveformAsync(this: AudioTextToSpeech, timeRange: NumberRange, samples: number): Array<unknown>;
6546
6551
  /**
@@ -9432,7 +9437,7 @@ interface CalloutService extends Instance {
9432
9437
  readonly _nominal_CalloutService: unique symbol;
9433
9438
  }
9434
9439
  /**
9435
- * A service which provides control over screenshot capture features.
9440
+ * A service which provides control over screenshot and video capture features.
9436
9441
  *
9437
9442
  * - **Tags**: NotCreatable, Service
9438
9443
  *
@@ -9453,7 +9458,7 @@ interface CaptureService extends Instance {
9453
9458
  * - **ThreadSafety**: Unsafe
9454
9459
  *
9455
9460
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureScreenshot)
9456
- * @param this A service which provides control over screenshot capture features.
9461
+ * @param this A service which provides control over screenshot and video capture features.
9457
9462
  * @param onCaptureReady A callback function that is called with the `contentId` of the new capture once it is ready.
9458
9463
  */
9459
9464
  CaptureScreenshot(this: CaptureService, onCaptureReady: (captureContentId: string) => void): void;
@@ -9469,18 +9474,18 @@ interface CaptureService extends Instance {
9469
9474
  * - **ThreadSafety**: Unsafe
9470
9475
  *
9471
9476
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptSaveCapturesToGallery)
9472
- * @param this A service which provides control over screenshot capture features.
9477
+ * @param this A service which provides control over screenshot and video capture features.
9473
9478
  * @param captures
9474
9479
  * @param resultCallback A callback function that will be invoked with a dictionary mapping each `contentId` to a boolean indicating if the user accepted saving that capture.
9475
9480
  */
9476
9481
  PromptSaveCapturesToGallery<T extends string>(this: CaptureService, contentIds: Array<T>, resultCallback: (results: Record<T, boolean>) => void): void;
9477
9482
  /**
9478
- * Prompts the user to share a specified screenshot capture.
9483
+ * Prompts the user to share a specified capture.
9479
9484
  *
9480
9485
  * - **ThreadSafety**: Unsafe
9481
9486
  *
9482
9487
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptShareCapture)
9483
- * @param this A service which provides control over screenshot capture features.
9488
+ * @param this A service which provides control over screenshot and video capture features.
9484
9489
  * @param captureContent
9485
9490
  * @param launchData An optional string to include as launch data in the invite link.
9486
9491
  * @param onAcceptedCallback An optional callback function invoked if the user accepts sharing.
@@ -9488,27 +9493,31 @@ interface CaptureService extends Instance {
9488
9493
  */
9489
9494
  PromptShareCapture(this: CaptureService, contentId: string, launchData: string, onAcceptedCallback: () => void, onDeniedCallback: () => void): void;
9490
9495
  /**
9496
+ * Ends a video capture initiated by `StartVideoCaptureAsync()`.
9497
+ *
9491
9498
  * - **ThreadSafety**: Unsafe
9492
9499
  *
9493
9500
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StopVideoCapture)
9494
- * @param this A service which provides control over screenshot capture features.
9501
+ * @param this A service which provides control over screenshot and video capture features.
9495
9502
  */
9496
9503
  StopVideoCapture(this: CaptureService): void;
9497
9504
  /**
9498
9505
  * - **ThreadSafety**: Unsafe
9499
9506
  *
9500
9507
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeCapture)
9501
- * @param this A service which provides control over screenshot capture features.
9508
+ * @param this A service which provides control over screenshot and video capture features.
9502
9509
  * @param onCaptureReady
9503
9510
  * @param captureParams
9504
9511
  */
9505
9512
  TakeCapture(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
9506
9513
  /**
9514
+ * Initiates a video capture recording.
9515
+ *
9507
9516
  * - **ThreadSafety**: Unsafe
9508
9517
  * - **Tags**: Yields
9509
9518
  *
9510
9519
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartVideoCaptureAsync)
9511
- * @param this A service which provides control over screenshot capture features.
9520
+ * @param this A service which provides control over screenshot and video capture features.
9512
9521
  * @param onCaptureReady
9513
9522
  * @param captureParams
9514
9523
  */
@@ -14676,6 +14685,21 @@ interface ExampleService extends Instance {
14676
14685
  */
14677
14686
  readonly _nominal_ExampleService: unique symbol;
14678
14687
  }
14688
+ /**
14689
+ * - **Tags**: NotCreatable, Service, NotReplicated
14690
+ *
14691
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExampleV2Service)
14692
+ */
14693
+ interface ExampleV2Service extends Instance {
14694
+ /**
14695
+ * **DO NOT USE!**
14696
+ *
14697
+ * This field exists to force TypeScript to recognize this as a nominal type
14698
+ * @hidden
14699
+ * @deprecated
14700
+ */
14701
+ readonly _nominal_ExampleV2Service: unique symbol;
14702
+ }
14679
14703
  /**
14680
14704
  * - **Tags**: NotCreatable, Service
14681
14705
  *
@@ -14716,7 +14740,7 @@ interface ExperienceInviteOptions extends Instance {
14716
14740
  */
14717
14741
  InviteMessageId: string;
14718
14742
  /**
14719
- * Roblox `UserId` of the specific friend to invite.
14743
+ * Roblox `UserId` of the specific connection to invite.
14720
14744
  *
14721
14745
  * - **ThreadSafety**: ReadSafe
14722
14746
  *
@@ -14724,7 +14748,7 @@ interface ExperienceInviteOptions extends Instance {
14724
14748
  */
14725
14749
  InviteUser: number;
14726
14750
  /**
14727
- * Used to set a parameter in `Player:GetJoinData()` when a friend joins from the invite notification.
14751
+ * Used to set a parameter in `Player:GetJoinData()` when a connection joins from the invite notification.
14728
14752
  *
14729
14753
  * - **ThreadSafety**: ReadSafe
14730
14754
  *
@@ -15053,6 +15077,24 @@ interface Decal extends FaceInstance {
15053
15077
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#LocalTransparencyModifier)
15054
15078
  */
15055
15079
  LocalTransparencyModifier: number;
15080
+ /**
15081
+ * - **ThreadSafety**: ReadSafe
15082
+ *
15083
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#MetalnessMapContent)
15084
+ */
15085
+ get MetalnessMapContent(): Content;
15086
+ /**
15087
+ * - **ThreadSafety**: ReadSafe
15088
+ *
15089
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#NormalMapContent)
15090
+ */
15091
+ get NormalMapContent(): Content;
15092
+ /**
15093
+ * - **ThreadSafety**: ReadSafe
15094
+ *
15095
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#RoughnessMapContent)
15096
+ */
15097
+ get RoughnessMapContent(): Content;
15056
15098
  /**
15057
15099
  * **Deprecated:** This non-functional property is deprecated and should not be used in new work.
15058
15100
  *
@@ -15097,6 +15139,18 @@ interface Decal extends FaceInstance {
15097
15139
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#Transparency)
15098
15140
  */
15099
15141
  Transparency: number;
15142
+ /**
15143
+ * - **ThreadSafety**: ReadSafe
15144
+ *
15145
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#UVOffset)
15146
+ */
15147
+ UVOffset: Vector2;
15148
+ /**
15149
+ * - **ThreadSafety**: ReadSafe
15150
+ *
15151
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#UVScale)
15152
+ */
15153
+ UVScale: Vector2;
15100
15154
  /**
15101
15155
  * Determines the rendering order when multiple Decals are assigned the same face.
15102
15156
  *
@@ -15624,7 +15678,7 @@ interface GamepadService extends Instance {
15624
15678
  EnableGamepadCursor(this: GamepadService, guiObject: GuiObject | undefined): void;
15625
15679
  }
15626
15680
  /**
15627
- * `GenerationService` is a service that allows developers to generate 3D objects from text prompts utilizing Roblox's [Cube 3D foundation model](https://corp.roblox.com/newsroom/2025/03/introducing-roblox-cube).
15681
+ * Service that allows developers to generate 3D objects from text prompts.
15628
15682
  *
15629
15683
  * - **Tags**: NotCreatable, Service
15630
15684
  *
@@ -15640,31 +15694,32 @@ interface GenerationService extends Instance {
15640
15694
  */
15641
15695
  readonly _nominal_GenerationService: unique symbol;
15642
15696
  /**
15643
- * Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result. After the generation is complete, use `LoadGeneratedMeshAsync()` to load and display the generated mesh.
15697
+ * Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result.
15644
15698
  *
15645
15699
  * - **ThreadSafety**: Unsafe
15646
15700
  * - **Tags**: Yields
15647
15701
  *
15648
15702
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateMeshAsync)
15649
- * @param this `GenerationService` is a service that allows developers to generate 3D objects from text prompts utilizing Roblox's [Cube 3D foundation model](https://corp.roblox.com/newsroom/2025/03/introducing-roblox-cube).
15703
+ * @param this Service that allows developers to generate 3D objects from text prompts.
15650
15704
  * @param inputs A dictionary containing the mesh generation prompts. Currently, the only supported key is the `Prompt` (string) that describes the mesh to generate.
15651
15705
  * @param player The `Player` requesting the generation.
15652
- * @param options Additional generation options. Currently, no options are supported.
15653
- * @param intermediateResultCallback A callback function triggered with intermediate generation results. Useful for retrieving early mesh versions (e.g. before textures are applied).
15654
- * @returns A tuple of generation ID and context ID. - Generation ID: A unique ID returned for each invocation of `GenerateMeshAsync()`.
15655
- * - Context ID: Not currently used.
15706
+ * @param options A dictionary for additional generation options to influence the result. The following key is supported: - `SuggestedSize` — Optional `Vector3` representing a size guide for the generated asset. The service will attempt to create a model with a size and proportion similar to the provided `Vector3`. This does not guarantee the final output size.
15707
+ *
15708
+ *
15709
+ * @param intermediateResultCallback A callback function triggered with intermediate generation results. Useful for retrieving early mesh versions before textures are applied.
15710
+ * @returns A tuple of the generation ID (a unique ID returned for each invocation of `GenerateMeshAsync()`) and context ID (not currently used).
15656
15711
  */
15657
15712
  GenerateMeshAsync(this: GenerationService, inputs: object, player: Player, options: object, intermediateResultCallback?: Callback): unknown;
15658
15713
  /**
15659
- * Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`. The mesh is returned as a `MeshPart` with `EditableMesh` content.
15714
+ * Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`.
15660
15715
  *
15661
15716
  * - **ThreadSafety**: Unsafe
15662
15717
  * - **Tags**: Yields
15663
15718
  *
15664
15719
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#LoadGeneratedMeshAsync)
15665
- * @param this `GenerationService` is a service that allows developers to generate 3D objects from text prompts utilizing Roblox's [Cube 3D foundation model](https://corp.roblox.com/newsroom/2025/03/introducing-roblox-cube).
15720
+ * @param this Service that allows developers to generate 3D objects from text prompts.
15666
15721
  * @param generationId The unique ID returned by `GenerateMeshAsync()`. Identifies the mesh to load.
15667
- * @returns The generated mesh, returned as a `MeshPart` containing an `EditableMesh`.
15722
+ * @returns The generated asset, returned as a `Model` with a single `MeshPart` containing an `EditableMesh`.
15668
15723
  */
15669
15724
  LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
15670
15725
  }
@@ -31122,7 +31177,7 @@ interface DataStoreVersionPages extends Pages<DataStoreObjectVersionInfo> {
31122
31177
  readonly _nominal_DataStoreVersionPages: unique symbol;
31123
31178
  }
31124
31179
  /**
31125
- * A special version of `Pages` that contains information about a player's friends.
31180
+ * A special version of `Pages` that contains information about a player's connections.
31126
31181
  *
31127
31182
  * - **Tags**: NotCreatable, NotReplicated
31128
31183
  *
@@ -32775,15 +32830,15 @@ interface Player extends Instance {
32775
32830
  */
32776
32831
  SaveString(this: Player, key: string, value: string): void;
32777
32832
  /**
32778
- * Returns a dictionary of online friends.
32833
+ * Returns a dictionary of online connections.
32779
32834
  *
32780
32835
  * - **ThreadSafety**: Unsafe
32781
32836
  * - **Tags**: Yields
32782
32837
  *
32783
32838
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnline)
32784
32839
  * @param this An object that represents a presently connected client to the experience.
32785
- * @param maxFriends The maximum number of online friends to return.
32786
- * @returns A dictionary of online friends (see the table above).
32840
+ * @param maxFriends The maximum number of online connections to return.
32841
+ * @returns A dictionary of online connections (see the table above).
32787
32842
  */
32788
32843
  GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
32789
32844
  /**
@@ -32813,7 +32868,7 @@ interface Player extends Instance {
32813
32868
  /**
32814
32869
  * **Deprecated:** This function is obsolete because the Best Friends feature was removed. Use `Player:IsFriendsWith()` instead.
32815
32870
  *
32816
- * Returns whether a player is friends with the specified user.
32871
+ * Returns whether a player is connections with the specified user.
32817
32872
  *
32818
32873
  * - **ThreadSafety**: Unsafe
32819
32874
  * - **Tags**: Yields
@@ -32826,7 +32881,7 @@ interface Player extends Instance {
32826
32881
  */
32827
32882
  IsBestFriendsWith(this: Player, userId: number): boolean;
32828
32883
  /**
32829
- * Checks whether a player is a friend of the user with the given `Player.UserId`.
32884
+ * Checks whether a player is a connection of the user with the given `Player.UserId`.
32830
32885
  *
32831
32886
  * - **ThreadSafety**: Unsafe
32832
32887
  * - **Tags**: Yields
@@ -32834,7 +32889,7 @@ interface Player extends Instance {
32834
32889
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWith)
32835
32890
  * @param this An object that represents a presently connected client to the experience.
32836
32891
  * @param userId The `Player.UserId` of the specified player.
32837
- * @returns A boolean indicating whether a player is a friend of the specified user.
32892
+ * @returns A boolean indicating whether a player is a connection of the specified user.
32838
32893
  */
32839
32894
  IsFriendsWith(this: Player, userId: number): boolean;
32840
32895
  /**
@@ -33528,7 +33583,7 @@ interface Players extends Instance {
33528
33583
  */
33529
33584
  GetCharacterAppearanceInfoAsync(this: Players, userId: number): CharacterAppearanceInfo;
33530
33585
  /**
33531
- * Returns a `FriendPages` object which contains information for all of the given player's friends.
33586
+ * Returns a `FriendPages` object which contains information for all of the given player's connections.
33532
33587
  *
33533
33588
  * - **ThreadSafety**: Unsafe
33534
33589
  * - **Tags**: Yields
@@ -34534,7 +34589,7 @@ interface RecommendationService extends Instance {
34534
34589
  * @param this
34535
34590
  * @param registerRecommendationItemsRequest
34536
34591
  */
34537
- RegisterItemAsync(this: RecommendationService, registerRecommendationItemsRequest: object): object;
34592
+ RegisterItemAsync(this: RecommendationService, player: Player, registerRecommendationItemsRequest: object): object;
34538
34593
  /**
34539
34594
  * - **ThreadSafety**: Unsafe
34540
34595
  * - **Tags**: Yields
@@ -41719,15 +41774,15 @@ interface UIContainerQuery extends UIComponent {
41719
41774
  /**
41720
41775
  * - **ThreadSafety**: ReadSafe
41721
41776
  *
41722
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#Active)
41777
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#AspectRatioRange)
41723
41778
  */
41724
- Active: boolean;
41779
+ AspectRatioRange: NumberRange;
41725
41780
  /**
41726
41781
  * - **ThreadSafety**: ReadSafe
41727
41782
  *
41728
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#AspectRatioRange)
41783
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#IsActive)
41729
41784
  */
41730
- AspectRatioRange: NumberRange;
41785
+ IsActive: boolean;
41731
41786
  /**
41732
41787
  * - **ThreadSafety**: ReadSafe
41733
41788
  *
@@ -63,6 +63,7 @@ interface Services {
63
63
  EditableService: EditableService;
64
64
  EventIngestService: EventIngestService;
65
65
  ExampleService: ExampleService;
66
+ ExampleV2Service: ExampleV2Service;
66
67
  ExperienceAuthService: ExperienceAuthService;
67
68
  ExperienceNotificationService: ExperienceNotificationService;
68
69
  ExperienceService: ExperienceService;
@@ -2808,7 +2809,7 @@ interface CalloutService extends Instance {
2808
2809
  readonly _nominal_CalloutService: unique symbol;
2809
2810
  }
2810
2811
  /**
2811
- * A service which provides control over screenshot capture features.
2812
+ * A service which provides control over screenshot and video capture features.
2812
2813
  *
2813
2814
  * - **Tags**: NotCreatable, Service
2814
2815
  *
@@ -4517,6 +4518,21 @@ interface ExampleService extends Instance {
4517
4518
  */
4518
4519
  readonly _nominal_ExampleService: unique symbol;
4519
4520
  }
4521
+ /**
4522
+ * - **Tags**: NotCreatable, Service, NotReplicated
4523
+ *
4524
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExampleV2Service)
4525
+ */
4526
+ interface ExampleV2Service extends Instance {
4527
+ /**
4528
+ * **DO NOT USE!**
4529
+ *
4530
+ * This field exists to force TypeScript to recognize this as a nominal type
4531
+ * @hidden
4532
+ * @deprecated
4533
+ */
4534
+ readonly _nominal_ExampleV2Service: unique symbol;
4535
+ }
4520
4536
  /**
4521
4537
  * - **Tags**: NotCreatable, Service
4522
4538
  *
@@ -5182,6 +5198,45 @@ interface Decal extends FaceInstance {
5182
5198
  * @deprecated
5183
5199
  */
5184
5200
  readonly _nominal_Decal: unique symbol;
5201
+ /**
5202
+ * - **ThreadSafety**: ReadSafe
5203
+ * - **Tags**: Hidden
5204
+ *
5205
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#MetalnessMap)
5206
+ */
5207
+ MetalnessMap: ContentId;
5208
+ /**
5209
+ * - **ThreadSafety**: ReadSafe
5210
+ *
5211
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#MetalnessMapContent)
5212
+ */
5213
+ set MetalnessMapContent(value: Content);
5214
+ /**
5215
+ * - **ThreadSafety**: ReadSafe
5216
+ * - **Tags**: Hidden
5217
+ *
5218
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#NormalMap)
5219
+ */
5220
+ NormalMap: ContentId;
5221
+ /**
5222
+ * - **ThreadSafety**: ReadSafe
5223
+ *
5224
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#NormalMapContent)
5225
+ */
5226
+ set NormalMapContent(value: Content);
5227
+ /**
5228
+ * - **ThreadSafety**: ReadSafe
5229
+ * - **Tags**: Hidden
5230
+ *
5231
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#RoughnessMap)
5232
+ */
5233
+ RoughnessMap: ContentId;
5234
+ /**
5235
+ * - **ThreadSafety**: ReadSafe
5236
+ *
5237
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#RoughnessMapContent)
5238
+ */
5239
+ set RoughnessMapContent(value: Content);
5185
5240
  }
5186
5241
  /**
5187
5242
  * A Texture object applies a repeating texture to the face of a `BasePart`.
@@ -5501,7 +5556,7 @@ interface GamepadService extends Instance {
5501
5556
  readonly _nominal_GamepadService: unique symbol;
5502
5557
  }
5503
5558
  /**
5504
- * `GenerationService` is a service that allows developers to generate 3D objects from text prompts utilizing Roblox's [Cube 3D foundation model](https://corp.roblox.com/newsroom/2025/03/introducing-roblox-cube).
5559
+ * Service that allows developers to generate 3D objects from text prompts.
5505
5560
  *
5506
5561
  * - **Tags**: NotCreatable, Service
5507
5562
  *
@@ -9235,7 +9290,7 @@ interface DataStoreVersionPages extends Pages<DataStoreObjectVersionInfo> {
9235
9290
  readonly _nominal_DataStoreVersionPages: unique symbol;
9236
9291
  }
9237
9292
  /**
9238
- * A special version of `Pages` that contains information about a player's friends.
9293
+ * A special version of `Pages` that contains information about a player's connections.
9239
9294
  *
9240
9295
  * - **Tags**: NotCreatable, NotReplicated
9241
9296
  *
@@ -493,6 +493,8 @@ declare namespace Enum {
493
493
  */
494
494
  export namespace AdAvailabilityResult {
495
495
  /**
496
+ * An ad is available to show the user.
497
+ *
496
498
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#IsAvailable)
497
499
  */
498
500
  export interface IsAvailable extends globalThis.EnumItem {
@@ -502,6 +504,8 @@ declare namespace Enum {
502
504
  }
503
505
  export const IsAvailable: IsAvailable;
504
506
  /**
507
+ * The device is ineligible to receive ads.
508
+ *
505
509
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#DeviceIneligible)
506
510
  */
507
511
  export interface DeviceIneligible extends globalThis.EnumItem {
@@ -511,6 +515,8 @@ declare namespace Enum {
511
515
  }
512
516
  export const DeviceIneligible: DeviceIneligible;
513
517
  /**
518
+ * The experience is ineligible to receive ads. Check if its eligibility has been revoked.
519
+ *
514
520
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#ExperienceIneligible)
515
521
  */
516
522
  export interface ExperienceIneligible extends globalThis.EnumItem {
@@ -520,6 +526,8 @@ declare namespace Enum {
520
526
  }
521
527
  export const ExperienceIneligible: ExperienceIneligible;
522
528
  /**
529
+ * An unspecified internal error occurred. Try fetching the ad again.
530
+ *
523
531
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#InternalError)
524
532
  */
525
533
  export interface InternalError extends globalThis.EnumItem {
@@ -529,6 +537,8 @@ declare namespace Enum {
529
537
  }
530
538
  export const InternalError: InternalError;
531
539
  /**
540
+ * There are no ads available to fill your ad request. You might have hit the ad frequency limit.
541
+ *
532
542
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#NoFill)
533
543
  */
534
544
  export interface NoFill extends globalThis.EnumItem {
@@ -538,6 +548,8 @@ declare namespace Enum {
538
548
  }
539
549
  export const NoFill: NoFill;
540
550
  /**
551
+ * The user is ineligible to receive ads during this session. The user might be under 13 or located in a blocked region.
552
+ *
541
553
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#PlayerIneligible)
542
554
  */
543
555
  export interface PlayerIneligible extends globalThis.EnumItem {
@@ -547,6 +559,8 @@ declare namespace Enum {
547
559
  }
548
560
  export const PlayerIneligible: PlayerIneligible;
549
561
  /**
562
+ * The publisher is ineligible to receive ads because they have not met the publisher eligibility requirements.
563
+ *
550
564
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#PublisherIneligible)
551
565
  */
552
566
  export interface PublisherIneligible extends globalThis.EnumItem {
@@ -640,6 +654,8 @@ declare namespace Enum {
640
654
  */
641
655
  export namespace AdFormat {
642
656
  /**
657
+ * The format of the rewarded video ad.
658
+ *
643
659
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdFormat#RewardedVideo)
644
660
  */
645
661
  export interface RewardedVideo extends globalThis.EnumItem {
@@ -6423,7 +6439,7 @@ declare namespace Enum {
6423
6439
  }
6424
6440
  export const NoOne: NoOne;
6425
6441
  /**
6426
- * A player can only chat with users in a game that are on their friends list.
6442
+ * A player can only chat with users in a game that are on their connections list.
6427
6443
  *
6428
6444
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatPrivacyMode#Friends)
6429
6445
  */
@@ -7878,6 +7894,15 @@ declare namespace Enum {
7878
7894
  EnumType: typeof globalThis.Enum.ConnectionError;
7879
7895
  }
7880
7896
  export const AndroidEmulatorKick: AndroidEmulatorKick;
7897
+ /**
7898
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#AndroidRootedKick)
7899
+ */
7900
+ export interface AndroidRootedKick extends globalThis.EnumItem {
7901
+ Name: "AndroidRootedKick";
7902
+ Value: 306;
7903
+ EnumType: typeof globalThis.Enum.ConnectionError;
7904
+ }
7905
+ export const AndroidRootedKick: AndroidRootedKick;
7881
7906
  /**
7882
7907
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchErrors)
7883
7908
  */
@@ -8107,7 +8132,7 @@ declare namespace Enum {
8107
8132
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ConnectionError | undefined;
8108
8133
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ConnectionError | undefined;
8109
8134
  }
8110
- export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.DisconnectPrivateServerKickout | ConnectionError.DisconnectModeratedGame | ConnectionError.ServerShutdown | ConnectionError.ReplicatorTimeout | ConnectionError.PlayerRemoved | ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave | ConnectionError.DisconnectRomarkEndOfTest | ConnectionError.DisconnectCollaboratorPermissionRevoked | ConnectionError.DisconnectCollaboratorUnderage | ConnectionError.NetworkInternal | ConnectionError.NetworkSend | ConnectionError.NetworkTimeout | ConnectionError.NetworkMisbehavior | ConnectionError.NetworkSecurity | ConnectionError.ReplacementReady | ConnectionError.ServerEmpty | ConnectionError.PhantomFreeze | ConnectionError.AndroidAnticheatKick | ConnectionError.AndroidEmulatorKick | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchUserPrivacyUnauthorized | ConnectionError.PlacelaunchCreatorBan | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
8135
+ export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.DisconnectPrivateServerKickout | ConnectionError.DisconnectModeratedGame | ConnectionError.ServerShutdown | ConnectionError.ReplicatorTimeout | ConnectionError.PlayerRemoved | ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave | ConnectionError.DisconnectRomarkEndOfTest | ConnectionError.DisconnectCollaboratorPermissionRevoked | ConnectionError.DisconnectCollaboratorUnderage | ConnectionError.NetworkInternal | ConnectionError.NetworkSend | ConnectionError.NetworkTimeout | ConnectionError.NetworkMisbehavior | ConnectionError.NetworkSecurity | ConnectionError.ReplacementReady | ConnectionError.ServerEmpty | ConnectionError.PhantomFreeze | ConnectionError.AndroidAnticheatKick | ConnectionError.AndroidEmulatorKick | ConnectionError.AndroidRootedKick | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchUserPrivacyUnauthorized | ConnectionError.PlacelaunchCreatorBan | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
8111
8136
  /**
8112
8137
  * Used to determine the connection state of the client to the game server.
8113
8138
  *
@@ -9726,11 +9751,20 @@ declare namespace Enum {
9726
9751
  EnumType: typeof globalThis.Enum.DeviceForm;
9727
9752
  }
9728
9753
  export const VR: VR;
9754
+ /**
9755
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceForm#Handheld)
9756
+ */
9757
+ export interface Handheld extends globalThis.EnumItem {
9758
+ Name: "Handheld";
9759
+ Value: 5;
9760
+ EnumType: typeof globalThis.Enum.DeviceForm;
9761
+ }
9762
+ export const Handheld: Handheld;
9729
9763
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DeviceForm>;
9730
9764
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DeviceForm | undefined;
9731
9765
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DeviceForm | undefined;
9732
9766
  }
9733
- export type DeviceForm = DeviceForm.Console | DeviceForm.Phone | DeviceForm.Tablet | DeviceForm.Desktop | DeviceForm.VR;
9767
+ export type DeviceForm = DeviceForm.Console | DeviceForm.Phone | DeviceForm.Tablet | DeviceForm.Desktop | DeviceForm.VR | DeviceForm.Handheld;
9734
9768
  /**
9735
9769
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceLevel)
9736
9770
  */
@@ -12853,7 +12887,7 @@ declare namespace Enum {
12853
12887
  */
12854
12888
  export namespace FriendRequestEvent {
12855
12889
  /**
12856
- * A player invokes (sends) a friend request.
12890
+ * A player invokes (sends) a connection request.
12857
12891
  *
12858
12892
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Issue)
12859
12893
  */
@@ -12864,7 +12898,7 @@ declare namespace Enum {
12864
12898
  }
12865
12899
  export const Issue: Issue;
12866
12900
  /**
12867
- * A player revokes (cancels) a previously invoked (sent) friend request.
12901
+ * A player revokes (cancels) a previously invoked (sent) connection request.
12868
12902
  *
12869
12903
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Revoke)
12870
12904
  */
@@ -12875,7 +12909,7 @@ declare namespace Enum {
12875
12909
  }
12876
12910
  export const Revoke: Revoke;
12877
12911
  /**
12878
- * A player accepts a friend request.
12912
+ * A player accepts a connection request.
12879
12913
  *
12880
12914
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Accept)
12881
12915
  */
@@ -12886,7 +12920,7 @@ declare namespace Enum {
12886
12920
  }
12887
12921
  export const Accept: Accept;
12888
12922
  /**
12889
- * A player denies a friend request.
12923
+ * A player denies a connection request.
12890
12924
  *
12891
12925
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Deny)
12892
12926
  */
@@ -12906,7 +12940,7 @@ declare namespace Enum {
12906
12940
  */
12907
12941
  export namespace FriendStatus {
12908
12942
  /**
12909
- * The friendship status of two players is unknown.
12943
+ * The connection status of two players is unknown.
12910
12944
  *
12911
12945
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendStatus#Unknown)
12912
12946
  */
@@ -12917,7 +12951,7 @@ declare namespace Enum {
12917
12951
  }
12918
12952
  export const Unknown: Unknown;
12919
12953
  /**
12920
- * Two players are not friends.
12954
+ * Two players are not connections.
12921
12955
  *
12922
12956
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendStatus#NotFriend)
12923
12957
  */
@@ -12928,7 +12962,7 @@ declare namespace Enum {
12928
12962
  }
12929
12963
  export const NotFriend: NotFriend;
12930
12964
  /**
12931
- * Two players are friends.
12965
+ * Two players are connections.
12932
12966
  *
12933
12967
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendStatus#Friend)
12934
12968
  */
@@ -12939,7 +12973,7 @@ declare namespace Enum {
12939
12973
  }
12940
12974
  export const Friend: Friend;
12941
12975
  /**
12942
- * At least one of two players has sent a friend request to the other player.
12976
+ * At least one of two players has sent a connection request to the other player.
12943
12977
  *
12944
12978
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendStatus#FriendRequestSent)
12945
12979
  */
@@ -12950,7 +12984,7 @@ declare namespace Enum {
12950
12984
  }
12951
12985
  export const FriendRequestSent: FriendRequestSent;
12952
12986
  /**
12953
- * At least one of two players has received a friend request sent by the other player.
12987
+ * At least one of two players has received a connection request sent by the other player.
12954
12988
  *
12955
12989
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendStatus#FriendRequestReceived)
12956
12990
  */
@@ -23002,6 +23036,8 @@ declare namespace Enum {
23002
23036
  }
23003
23037
  export const None: None;
23004
23038
  /**
23039
+ * **Deprecated:**
23040
+ *
23005
23041
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#Forced)
23006
23042
  */
23007
23043
  export interface Forced extends globalThis.EnumItem {
@@ -26734,6 +26770,8 @@ declare namespace Enum {
26734
26770
  */
26735
26771
  export namespace ShowAdResult {
26736
26772
  /**
26773
+ * The ad was successfully shown to completion.
26774
+ *
26737
26775
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#ShowCompleted)
26738
26776
  */
26739
26777
  export interface ShowCompleted extends globalThis.EnumItem {
@@ -26743,6 +26781,8 @@ declare namespace Enum {
26743
26781
  }
26744
26782
  export const ShowCompleted: ShowCompleted;
26745
26783
  /**
26784
+ * You are trying to show a full-screen ad before the ad has fully loaded. You might have failed to properly fetch the ad, or the ad might have expired.
26785
+ *
26746
26786
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#AdNotReady)
26747
26787
  */
26748
26788
  export interface AdNotReady extends globalThis.EnumItem {
@@ -26752,6 +26792,8 @@ declare namespace Enum {
26752
26792
  }
26753
26793
  export const AdNotReady: AdNotReady;
26754
26794
  /**
26795
+ * You are trying to show a full-screen ad while another full-screen ad is already playing.
26796
+ *
26755
26797
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#AdAlreadyShowing)
26756
26798
  */
26757
26799
  export interface AdAlreadyShowing extends globalThis.EnumItem {
@@ -26761,6 +26803,8 @@ declare namespace Enum {
26761
26803
  }
26762
26804
  export const AdAlreadyShowing: AdAlreadyShowing;
26763
26805
  /**
26806
+ * An unspecified internal error occurred. Try showing the ad again.
26807
+ *
26764
26808
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#InternalError)
26765
26809
  */
26766
26810
  export interface InternalError extends globalThis.EnumItem {
@@ -26770,6 +26814,8 @@ declare namespace Enum {
26770
26814
  }
26771
26815
  export const InternalError: InternalError;
26772
26816
  /**
26817
+ * The ad view of the user has been interrupted. The user might have closed the ad view or left the experience, and should not receive a reward.
26818
+ *
26773
26819
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#ShowInterrupted)
26774
26820
  */
26775
26821
  export interface ShowInterrupted extends globalThis.EnumItem {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.863",
3
+ "version": "1.0.865",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },