@rbxts/types 1.0.842 → 1.0.844

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.
@@ -38,6 +38,7 @@ interface Services {
38
38
  CollectionService: CollectionService;
39
39
  CommandService: CommandService;
40
40
  CommerceService: CommerceService;
41
+ ConfigService: ConfigService;
41
42
  ConfigureServerService: ConfigureServerService;
42
43
  ConnectivityService: ConnectivityService;
43
44
  ContentProvider: ContentProvider;
@@ -670,6 +671,7 @@ interface Instances extends Services, CreatableInstances {
670
671
  }
671
672
  interface Objects extends Instances {
672
673
  Capture: Capture;
674
+ ConfigSnapshot: ConfigSnapshot;
673
675
  EditableImage: EditableImage;
674
676
  EditableMesh: EditableMesh;
675
677
  Object: RBXObject;
@@ -763,6 +765,59 @@ interface ScreenshotCapture extends Capture {
763
765
  */
764
766
  readonly _nominal_ScreenshotCapture: unique symbol;
765
767
  }
768
+ /**
769
+ * - **Tags**: NotCreatable, NotReplicated
770
+ *
771
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot)
772
+ */
773
+ interface ConfigSnapshot extends RBXObject {
774
+ /**
775
+ * **DO NOT USE!**
776
+ *
777
+ * This field exists to force TypeScript to recognize this as a nominal type
778
+ * @hidden
779
+ * @deprecated
780
+ */
781
+ readonly _nominal_ConfigSnapshot: unique symbol;
782
+ /**
783
+ * - **ThreadSafety**: ReadSafe
784
+ * - **Tags**: NotReplicated
785
+ *
786
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Error)
787
+ */
788
+ readonly Error: Enum.ConfigSnapshotErrorState;
789
+ /**
790
+ * - **ThreadSafety**: ReadSafe
791
+ * - **Tags**: NotReplicated
792
+ *
793
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Outdated)
794
+ */
795
+ readonly Outdated: boolean;
796
+ /**
797
+ * - **ThreadSafety**: Unsafe
798
+ *
799
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValue)
800
+ */
801
+ GetValue(this: ConfigSnapshot, key: string, defaultValue: unknown): unknown;
802
+ /**
803
+ * - **ThreadSafety**: Unsafe
804
+ *
805
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValueChangedSignal)
806
+ */
807
+ GetValueChangedSignal(this: ConfigSnapshot, key: string): RBXScriptSignal;
808
+ /**
809
+ * - **ThreadSafety**: Unsafe
810
+ *
811
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Refresh)
812
+ */
813
+ Refresh(this: ConfigSnapshot): void;
814
+ /**
815
+ * - **ThreadSafety**: Unsafe
816
+ *
817
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#UpdateAvailable)
818
+ */
819
+ readonly UpdateAvailable: RBXScriptSignal<() => void>;
820
+ }
766
821
  /**
767
822
  * Instance which allows for the runtime creation and manipulation of images.
768
823
  *
@@ -2845,12 +2900,15 @@ interface AnimationTrack extends Instance {
2845
2900
  * - **ThreadSafety**: Unsafe
2846
2901
  *
2847
2902
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetInstance)
2903
+ * @param this Controls the playback of an animation on an `Animator`.
2904
+ * @param name
2848
2905
  */
2849
2906
  GetTargetInstance(this: AnimationTrack, name: string): Instance | undefined;
2850
2907
  /**
2851
2908
  * - **ThreadSafety**: Unsafe
2852
2909
  *
2853
2910
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetNames)
2911
+ * @param this Controls the playback of an animation on an `Animator`.
2854
2912
  */
2855
2913
  GetTargetNames(this: AnimationTrack): Array<unknown>;
2856
2914
  /**
@@ -2881,6 +2939,9 @@ interface AnimationTrack extends Instance {
2881
2939
  * - **ThreadSafety**: Unsafe
2882
2940
  *
2883
2941
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetTargetInstance)
2942
+ * @param this Controls the playback of an animation on an `Animator`.
2943
+ * @param name
2944
+ * @param target
2884
2945
  */
2885
2946
  SetTargetInstance(this: AnimationTrack, name: string, target: Instance): void;
2886
2947
  /**
@@ -5868,9 +5929,9 @@ interface AuroraService extends Instance {
5868
5929
  /**
5869
5930
  * - **ThreadSafety**: Unsafe
5870
5931
  *
5871
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetDesyncedInstances)
5932
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetPredictedInstances)
5872
5933
  */
5873
- GetDesyncedInstances(this: AuroraService): Array<unknown>;
5934
+ GetPredictedInstances(this: AuroraService): Array<unknown>;
5874
5935
  /**
5875
5936
  * - **ThreadSafety**: Unsafe
5876
5937
  *
@@ -5892,9 +5953,9 @@ interface AuroraService extends Instance {
5892
5953
  /**
5893
5954
  * - **ThreadSafety**: Unsafe
5894
5955
  *
5895
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsDesynced)
5956
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsPredicted)
5896
5957
  */
5897
- IsDesynced(this: AuroraService, target: Instance): boolean;
5958
+ IsPredicted(this: AuroraService, target: Instance): boolean;
5898
5959
  /**
5899
5960
  * - **ThreadSafety**: Unsafe
5900
5961
  *
@@ -5931,12 +5992,6 @@ interface AuroraService extends Instance {
5931
5992
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#UpdateProperties)
5932
5993
  */
5933
5994
  UpdateProperties(this: AuroraService, target: Instance): void;
5934
- /**
5935
- * - **ThreadSafety**: Unsafe
5936
- *
5937
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Desynced)
5938
- */
5939
- readonly Desynced: RBXScriptSignal<(target: Instance) => void>;
5940
5995
  /**
5941
5996
  * - **ThreadSafety**: Unsafe
5942
5997
  *
@@ -5955,12 +6010,6 @@ interface AuroraService extends Instance {
5955
6010
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Step)
5956
6011
  */
5957
6012
  readonly Step: RBXScriptSignal<() => void>;
5958
- /**
5959
- * - **ThreadSafety**: Unsafe
5960
- *
5961
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Synced)
5962
- */
5963
- readonly Synced: RBXScriptSignal<(target: Instance) => void>;
5964
6013
  }
5965
6014
  /**
5966
6015
  * - **Tags**: NotCreatable, Service
@@ -10207,6 +10256,35 @@ interface CommerceService extends Instance {
10207
10256
  */
10208
10257
  readonly PromptCommerceProductPurchaseFinished: RBXScriptSignal<(user: Player, productId: string) => void>;
10209
10258
  }
10259
+ /**
10260
+ * - **Tags**: NotCreatable, Service, NotReplicated
10261
+ *
10262
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService)
10263
+ */
10264
+ interface ConfigService extends Instance {
10265
+ /**
10266
+ * **DO NOT USE!**
10267
+ *
10268
+ * This field exists to force TypeScript to recognize this as a nominal type
10269
+ * @hidden
10270
+ * @deprecated
10271
+ */
10272
+ readonly _nominal_ConfigService: unique symbol;
10273
+ /**
10274
+ * - **ThreadSafety**: Unsafe
10275
+ * - **Tags**: Yields
10276
+ *
10277
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigAsync)
10278
+ */
10279
+ GetConfigAsync(this: ConfigService): ConfigSnapshot;
10280
+ /**
10281
+ * - **ThreadSafety**: Unsafe
10282
+ * - **Tags**: Yields
10283
+ *
10284
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigForPlayerAsync)
10285
+ */
10286
+ GetConfigForPlayerAsync(this: ConfigService, player: Player): ConfigSnapshot;
10287
+ }
10210
10288
  /**
10211
10289
  * The Configuration object is a container object that is designed to hold value objects to make values used in `Tools` or any model using `Scripts` more accessible.
10212
10290
  *
@@ -14980,6 +15058,8 @@ interface GamepadService extends Instance {
14980
15058
  EnableGamepadCursor(this: GamepadService, guiObject: GuiObject | undefined): void;
14981
15059
  }
14982
15060
  /**
15061
+ * `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).
15062
+ *
14983
15063
  * - **Tags**: NotCreatable, Service
14984
15064
  *
14985
15065
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService)
@@ -14994,24 +15074,31 @@ interface GenerationService extends Instance {
14994
15074
  */
14995
15075
  readonly _nominal_GenerationService: unique symbol;
14996
15076
  /**
15077
+ * 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.
15078
+ *
14997
15079
  * - **ThreadSafety**: Unsafe
14998
15080
  * - **Tags**: Yields
14999
15081
  *
15000
15082
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateMeshAsync)
15001
- * @param this
15002
- * @param inputs
15003
- * @param player
15004
- * @param options
15005
- * @param intermediateResultCallback
15083
+ * @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).
15084
+ * @param inputs A dictionary containing the mesh generation prompts. Currently, the only supported key is the `Prompt` (string) that describes the mesh to generate.
15085
+ * @param player The `Player` requesting the generation.
15086
+ * @param options Additional generation options. Currently, no options are supported.
15087
+ * @param intermediateResultCallback A callback function triggered with intermediate generation results. Useful for retrieving early mesh versions (e.g. before textures are applied).
15088
+ * @returns A tuple of generation ID and context ID. - Generation ID: A unique ID returned for each invocation of `GenerateMeshAsync()`.
15089
+ * - Context ID: Not currently used.
15006
15090
  */
15007
15091
  GenerateMeshAsync(this: GenerationService, inputs: object, player: Player, options: object, intermediateResultCallback?: Callback): unknown;
15008
15092
  /**
15093
+ * Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`. The mesh is returned as a `MeshPart` with `EditableMesh` content.
15094
+ *
15009
15095
  * - **ThreadSafety**: Unsafe
15010
15096
  * - **Tags**: Yields
15011
15097
  *
15012
15098
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#LoadGeneratedMeshAsync)
15013
- * @param this
15014
- * @param generationId
15099
+ * @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).
15100
+ * @param generationId The unique ID returned by `GenerateMeshAsync()`. Identifies the mesh to load.
15101
+ * @returns The generated mesh, returned as a `MeshPart` containing an `EditableMesh`.
15015
15102
  */
15016
15103
  LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
15017
15104
  }
@@ -34559,6 +34646,8 @@ interface SocialService extends Instance {
34559
34646
  * - **ThreadSafety**: Unsafe
34560
34647
  *
34561
34648
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#GetPlayersByPartyId)
34649
+ * @param this Facilitates social functions that impact relationships made on the Roblox platform.
34650
+ * @param partyId
34562
34651
  */
34563
34652
  GetPlayersByPartyId(this: SocialService, partyId: string): Array<Instance>;
34564
34653
  /**
@@ -37579,8 +37668,8 @@ interface TextChannel extends Instance {
37579
37668
  * - **ThreadSafety**: Unsafe
37580
37669
  *
37581
37670
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChannel#ShouldDeliverCallback)
37582
- * @param message
37583
- * @param textSource
37671
+ * @param message The message being sent, which also contains the sender of the message.
37672
+ * @param textSource The `TextSource` of the user who will be receiving the message.
37584
37673
  */
37585
37674
  ShouldDeliverCallback: (message: TextChatMessage, textSource: TextSource) => boolean;
37586
37675
  }
@@ -42573,12 +42662,15 @@ interface WebSocketClient extends Instance {
42573
42662
  * - **ThreadSafety**: Unsafe
42574
42663
  *
42575
42664
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Close)
42665
+ * @param this
42576
42666
  */
42577
42667
  Close(this: WebSocketClient): void;
42578
42668
  /**
42579
42669
  * - **ThreadSafety**: Unsafe
42580
42670
  *
42581
42671
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Send)
42672
+ * @param this
42673
+ * @param data
42582
42674
  */
42583
42675
  Send(this: WebSocketClient, data: string): void;
42584
42676
  /**
@@ -42618,6 +42710,8 @@ interface WebSocketService extends Instance {
42618
42710
  * - **ThreadSafety**: Unsafe
42619
42711
  *
42620
42712
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketService#CreateClient)
42713
+ * @param this
42714
+ * @param uri
42621
42715
  */
42622
42716
  CreateClient(this: WebSocketService, uri: string): WebSocketClient;
42623
42717
  }
@@ -39,6 +39,7 @@ interface Services {
39
39
  CollectionService: CollectionService;
40
40
  CommandService: CommandService;
41
41
  CommerceService: CommerceService;
42
+ ConfigService: ConfigService;
42
43
  ConfigureServerService: ConfigureServerService;
43
44
  ConnectivityService: ConnectivityService;
44
45
  ContentProvider: ContentProvider;
@@ -722,6 +723,7 @@ interface Instances extends Services, CreatableInstances {
722
723
  }
723
724
  interface Objects extends Instances {
724
725
  Capture: Capture;
726
+ ConfigSnapshot: ConfigSnapshot;
725
727
  EditableImage: EditableImage;
726
728
  EditableMesh: EditableMesh;
727
729
  Object: RBXObject;
@@ -775,6 +777,21 @@ interface ScreenshotCapture extends Capture {
775
777
  */
776
778
  readonly _nominal_ScreenshotCapture: unique symbol;
777
779
  }
780
+ /**
781
+ * - **Tags**: NotCreatable, NotReplicated
782
+ *
783
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot)
784
+ */
785
+ interface ConfigSnapshot extends RBXObject {
786
+ /**
787
+ * **DO NOT USE!**
788
+ *
789
+ * This field exists to force TypeScript to recognize this as a nominal type
790
+ * @hidden
791
+ * @deprecated
792
+ */
793
+ readonly _nominal_ConfigSnapshot: unique symbol;
794
+ }
778
795
  /**
779
796
  * Instance which allows for the runtime creation and manipulation of images.
780
797
  *
@@ -3068,6 +3085,21 @@ interface CommerceService extends Instance {
3068
3085
  */
3069
3086
  readonly _nominal_CommerceService: unique symbol;
3070
3087
  }
3088
+ /**
3089
+ * - **Tags**: NotCreatable, Service, NotReplicated
3090
+ *
3091
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService)
3092
+ */
3093
+ interface ConfigService extends Instance {
3094
+ /**
3095
+ * **DO NOT USE!**
3096
+ *
3097
+ * This field exists to force TypeScript to recognize this as a nominal type
3098
+ * @hidden
3099
+ * @deprecated
3100
+ */
3101
+ readonly _nominal_ConfigService: unique symbol;
3102
+ }
3071
3103
  /**
3072
3104
  * The Configuration object is a container object that is designed to hold value objects to make values used in `Tools` or any model using `Scripts` more accessible.
3073
3105
  *
@@ -5290,6 +5322,8 @@ interface GamepadService extends Instance {
5290
5322
  readonly _nominal_GamepadService: unique symbol;
5291
5323
  }
5292
5324
  /**
5325
+ * `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).
5326
+ *
5293
5327
  * - **Tags**: NotCreatable, Service
5294
5328
  *
5295
5329
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService)