@rbxts/types 1.0.864 → 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.
- package/include/generated/None.d.ts +129 -40
- package/include/generated/PluginSecurity.d.ts +58 -11
- package/include/generated/enums.d.ts +94 -12
- package/package.json +1 -1
|
@@ -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;
|
|
@@ -5514,18 +5515,22 @@ interface AudioGate extends Instance {
|
|
|
5514
5515
|
* - **ThreadSafety**: Unsafe
|
|
5515
5516
|
*
|
|
5516
5517
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetConnectedWires)
|
|
5518
|
+
* @param this
|
|
5519
|
+
* @param pin
|
|
5517
5520
|
*/
|
|
5518
5521
|
GetConnectedWires(this: AudioGate, pin: string): Array<Instance>;
|
|
5519
5522
|
/**
|
|
5520
5523
|
* - **ThreadSafety**: Unsafe
|
|
5521
5524
|
*
|
|
5522
5525
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetInputPins)
|
|
5526
|
+
* @param this
|
|
5523
5527
|
*/
|
|
5524
5528
|
GetInputPins(this: AudioGate): Array<unknown>;
|
|
5525
5529
|
/**
|
|
5526
5530
|
* - **ThreadSafety**: Unsafe
|
|
5527
5531
|
*
|
|
5528
5532
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetOutputPins)
|
|
5533
|
+
* @param this
|
|
5529
5534
|
*/
|
|
5530
5535
|
GetOutputPins(this: AudioGate): Array<unknown>;
|
|
5531
5536
|
/**
|
|
@@ -5960,13 +5965,15 @@ interface AudioPlayer extends Instance {
|
|
|
5960
5965
|
*/
|
|
5961
5966
|
Stop(this: AudioPlayer): void;
|
|
5962
5967
|
/**
|
|
5968
|
+
* Returns a list of samples across a time range for the given audio.
|
|
5969
|
+
*
|
|
5963
5970
|
* - **ThreadSafety**: Unsafe
|
|
5964
5971
|
* - **Tags**: Yields
|
|
5965
5972
|
*
|
|
5966
5973
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetWaveformAsync)
|
|
5967
5974
|
* @param this Used to play audio assets.
|
|
5968
|
-
* @param timeRange
|
|
5969
|
-
* @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.
|
|
5970
5977
|
*/
|
|
5971
5978
|
GetWaveformAsync(this: AudioPlayer, timeRange: NumberRange, samples: number): Array<unknown>;
|
|
5972
5979
|
/**
|
|
@@ -6530,13 +6537,15 @@ interface AudioTextToSpeech extends Instance {
|
|
|
6530
6537
|
*/
|
|
6531
6538
|
Unload(this: AudioTextToSpeech): void;
|
|
6532
6539
|
/**
|
|
6540
|
+
* Returns a list of samples across a time range for the given audio.
|
|
6541
|
+
*
|
|
6533
6542
|
* - **ThreadSafety**: Unsafe
|
|
6534
6543
|
* - **Tags**: Yields
|
|
6535
6544
|
*
|
|
6536
6545
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetWaveformAsync)
|
|
6537
6546
|
* @param this Plays text as speech audio.
|
|
6538
|
-
* @param timeRange
|
|
6539
|
-
* @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.
|
|
6540
6549
|
*/
|
|
6541
6550
|
GetWaveformAsync(this: AudioTextToSpeech, timeRange: NumberRange, samples: number): Array<unknown>;
|
|
6542
6551
|
/**
|
|
@@ -6666,6 +6675,12 @@ interface AuroraService extends Instance {
|
|
|
6666
6675
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IgnoreRotation)
|
|
6667
6676
|
*/
|
|
6668
6677
|
IgnoreRotation: boolean;
|
|
6678
|
+
/**
|
|
6679
|
+
* - **ThreadSafety**: ReadSafe
|
|
6680
|
+
*
|
|
6681
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#LockStepIdOffset)
|
|
6682
|
+
*/
|
|
6683
|
+
LockStepIdOffset: boolean;
|
|
6669
6684
|
/**
|
|
6670
6685
|
* - **ThreadSafety**: ReadSafe
|
|
6671
6686
|
*
|
|
@@ -6899,6 +6914,9 @@ interface AvatarCreationService extends Instance {
|
|
|
6899
6914
|
* - **Tags**: Yields
|
|
6900
6915
|
*
|
|
6901
6916
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AutoSetupAvatarAsync)
|
|
6917
|
+
* @param this A service to support developer avatar creators.
|
|
6918
|
+
* @param player
|
|
6919
|
+
* @param model
|
|
6902
6920
|
*/
|
|
6903
6921
|
AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, model: Model): string;
|
|
6904
6922
|
/**
|
|
@@ -6939,6 +6957,8 @@ interface AvatarCreationService extends Instance {
|
|
|
6939
6957
|
* - **Tags**: Yields
|
|
6940
6958
|
*
|
|
6941
6959
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#LoadGeneratedAvatarAsync)
|
|
6960
|
+
* @param this A service to support developer avatar creators.
|
|
6961
|
+
* @param generationId
|
|
6942
6962
|
*/
|
|
6943
6963
|
LoadGeneratedAvatarAsync(this: AvatarCreationService, generationId: string): HumanoidDescription;
|
|
6944
6964
|
/**
|
|
@@ -8305,7 +8325,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
|
|
|
8305
8325
|
*/
|
|
8306
8326
|
readonly _nominal_UnreliableRemoteEvent: unique symbol;
|
|
8307
8327
|
/**
|
|
8308
|
-
* Fires the `OnClientEvent` event for each client connected to the same `UnreliableRemoteEvent`. Has a
|
|
8328
|
+
* Fires the `OnClientEvent` event for each client connected to the same `UnreliableRemoteEvent`. Has a 1000 byte limit to the payload of the event. Otherwise, the event is dropped.
|
|
8309
8329
|
*
|
|
8310
8330
|
* - **ThreadSafety**: Unsafe
|
|
8311
8331
|
*
|
|
@@ -8315,7 +8335,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
|
|
|
8315
8335
|
*/
|
|
8316
8336
|
FireAllClients(this: UnreliableRemoteEvent, ...args: Parameters<T>): void;
|
|
8317
8337
|
/**
|
|
8318
|
-
* Fires the `OnClientEvent` event for a specific client connected to the same `UnreliableRemoteEvent`. Has a
|
|
8338
|
+
* Fires the `OnClientEvent` event for a specific client connected to the same `UnreliableRemoteEvent`. Has a 1000 byte limit to the payload of the event. Otherwise, the event is dropped.
|
|
8319
8339
|
*
|
|
8320
8340
|
* - **ThreadSafety**: Unsafe
|
|
8321
8341
|
*
|
|
@@ -8326,7 +8346,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
|
|
|
8326
8346
|
*/
|
|
8327
8347
|
FireClient(this: UnreliableRemoteEvent, player: Player, ...args: Parameters<T>): void;
|
|
8328
8348
|
/**
|
|
8329
|
-
* Fires the `OnServerEvent` event on the server from one client connected to the same `UnreliableRemoteEvent`. Has a
|
|
8349
|
+
* Fires the `OnServerEvent` event on the server from one client connected to the same `UnreliableRemoteEvent`. Has a 1000 byte limit to the payload of the event, otherwise event is dropped.
|
|
8330
8350
|
*
|
|
8331
8351
|
* - **ThreadSafety**: Unsafe
|
|
8332
8352
|
*
|
|
@@ -9417,7 +9437,7 @@ interface CalloutService extends Instance {
|
|
|
9417
9437
|
readonly _nominal_CalloutService: unique symbol;
|
|
9418
9438
|
}
|
|
9419
9439
|
/**
|
|
9420
|
-
* A service which provides control over screenshot capture features.
|
|
9440
|
+
* A service which provides control over screenshot and video capture features.
|
|
9421
9441
|
*
|
|
9422
9442
|
* - **Tags**: NotCreatable, Service
|
|
9423
9443
|
*
|
|
@@ -9438,28 +9458,34 @@ interface CaptureService extends Instance {
|
|
|
9438
9458
|
* - **ThreadSafety**: Unsafe
|
|
9439
9459
|
*
|
|
9440
9460
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureScreenshot)
|
|
9441
|
-
* @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.
|
|
9442
9462
|
* @param onCaptureReady A callback function that is called with the `contentId` of the new capture once it is ready.
|
|
9443
9463
|
*/
|
|
9444
9464
|
CaptureScreenshot(this: CaptureService, onCaptureReady: (captureContentId: string) => void): void;
|
|
9465
|
+
/**
|
|
9466
|
+
* - **ThreadSafety**: Unsafe
|
|
9467
|
+
*
|
|
9468
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#GetDeviceInfo)
|
|
9469
|
+
*/
|
|
9470
|
+
GetDeviceInfo(this: CaptureService): object;
|
|
9445
9471
|
/**
|
|
9446
9472
|
* Prompts the user to save specified captures to their gallery.
|
|
9447
9473
|
*
|
|
9448
9474
|
* - **ThreadSafety**: Unsafe
|
|
9449
9475
|
*
|
|
9450
9476
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptSaveCapturesToGallery)
|
|
9451
|
-
* @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.
|
|
9452
9478
|
* @param captures
|
|
9453
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.
|
|
9454
9480
|
*/
|
|
9455
9481
|
PromptSaveCapturesToGallery<T extends string>(this: CaptureService, contentIds: Array<T>, resultCallback: (results: Record<T, boolean>) => void): void;
|
|
9456
9482
|
/**
|
|
9457
|
-
* Prompts the user to share a specified
|
|
9483
|
+
* Prompts the user to share a specified capture.
|
|
9458
9484
|
*
|
|
9459
9485
|
* - **ThreadSafety**: Unsafe
|
|
9460
9486
|
*
|
|
9461
9487
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptShareCapture)
|
|
9462
|
-
* @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.
|
|
9463
9489
|
* @param captureContent
|
|
9464
9490
|
* @param launchData An optional string to include as launch data in the invite link.
|
|
9465
9491
|
* @param onAcceptedCallback An optional callback function invoked if the user accepts sharing.
|
|
@@ -9467,27 +9493,31 @@ interface CaptureService extends Instance {
|
|
|
9467
9493
|
*/
|
|
9468
9494
|
PromptShareCapture(this: CaptureService, contentId: string, launchData: string, onAcceptedCallback: () => void, onDeniedCallback: () => void): void;
|
|
9469
9495
|
/**
|
|
9496
|
+
* Ends a video capture initiated by `StartVideoCaptureAsync()`.
|
|
9497
|
+
*
|
|
9470
9498
|
* - **ThreadSafety**: Unsafe
|
|
9471
9499
|
*
|
|
9472
9500
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StopVideoCapture)
|
|
9473
|
-
* @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.
|
|
9474
9502
|
*/
|
|
9475
9503
|
StopVideoCapture(this: CaptureService): void;
|
|
9476
9504
|
/**
|
|
9477
9505
|
* - **ThreadSafety**: Unsafe
|
|
9478
9506
|
*
|
|
9479
9507
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeCapture)
|
|
9480
|
-
* @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.
|
|
9481
9509
|
* @param onCaptureReady
|
|
9482
9510
|
* @param captureParams
|
|
9483
9511
|
*/
|
|
9484
9512
|
TakeCapture(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
|
|
9485
9513
|
/**
|
|
9514
|
+
* Initiates a video capture recording.
|
|
9515
|
+
*
|
|
9486
9516
|
* - **ThreadSafety**: Unsafe
|
|
9487
9517
|
* - **Tags**: Yields
|
|
9488
9518
|
*
|
|
9489
9519
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartVideoCaptureAsync)
|
|
9490
|
-
* @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.
|
|
9491
9521
|
* @param onCaptureReady
|
|
9492
9522
|
* @param captureParams
|
|
9493
9523
|
*/
|
|
@@ -14655,6 +14685,21 @@ interface ExampleService extends Instance {
|
|
|
14655
14685
|
*/
|
|
14656
14686
|
readonly _nominal_ExampleService: unique symbol;
|
|
14657
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
|
+
}
|
|
14658
14703
|
/**
|
|
14659
14704
|
* - **Tags**: NotCreatable, Service
|
|
14660
14705
|
*
|
|
@@ -14695,7 +14740,7 @@ interface ExperienceInviteOptions extends Instance {
|
|
|
14695
14740
|
*/
|
|
14696
14741
|
InviteMessageId: string;
|
|
14697
14742
|
/**
|
|
14698
|
-
* Roblox `UserId` of the specific
|
|
14743
|
+
* Roblox `UserId` of the specific connection to invite.
|
|
14699
14744
|
*
|
|
14700
14745
|
* - **ThreadSafety**: ReadSafe
|
|
14701
14746
|
*
|
|
@@ -14703,7 +14748,7 @@ interface ExperienceInviteOptions extends Instance {
|
|
|
14703
14748
|
*/
|
|
14704
14749
|
InviteUser: number;
|
|
14705
14750
|
/**
|
|
14706
|
-
* Used to set a parameter in `Player:GetJoinData()` when a
|
|
14751
|
+
* Used to set a parameter in `Player:GetJoinData()` when a connection joins from the invite notification.
|
|
14707
14752
|
*
|
|
14708
14753
|
* - **ThreadSafety**: ReadSafe
|
|
14709
14754
|
*
|
|
@@ -15032,6 +15077,24 @@ interface Decal extends FaceInstance {
|
|
|
15032
15077
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#LocalTransparencyModifier)
|
|
15033
15078
|
*/
|
|
15034
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;
|
|
15035
15098
|
/**
|
|
15036
15099
|
* **Deprecated:** This non-functional property is deprecated and should not be used in new work.
|
|
15037
15100
|
*
|
|
@@ -15076,6 +15139,18 @@ interface Decal extends FaceInstance {
|
|
|
15076
15139
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#Transparency)
|
|
15077
15140
|
*/
|
|
15078
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;
|
|
15079
15154
|
/**
|
|
15080
15155
|
* Determines the rendering order when multiple Decals are assigned the same face.
|
|
15081
15156
|
*
|
|
@@ -15603,7 +15678,7 @@ interface GamepadService extends Instance {
|
|
|
15603
15678
|
EnableGamepadCursor(this: GamepadService, guiObject: GuiObject | undefined): void;
|
|
15604
15679
|
}
|
|
15605
15680
|
/**
|
|
15606
|
-
*
|
|
15681
|
+
* Service that allows developers to generate 3D objects from text prompts.
|
|
15607
15682
|
*
|
|
15608
15683
|
* - **Tags**: NotCreatable, Service
|
|
15609
15684
|
*
|
|
@@ -15619,31 +15694,32 @@ interface GenerationService extends Instance {
|
|
|
15619
15694
|
*/
|
|
15620
15695
|
readonly _nominal_GenerationService: unique symbol;
|
|
15621
15696
|
/**
|
|
15622
|
-
* Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result.
|
|
15697
|
+
* Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result.
|
|
15623
15698
|
*
|
|
15624
15699
|
* - **ThreadSafety**: Unsafe
|
|
15625
15700
|
* - **Tags**: Yields
|
|
15626
15701
|
*
|
|
15627
15702
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateMeshAsync)
|
|
15628
|
-
* @param this
|
|
15703
|
+
* @param this Service that allows developers to generate 3D objects from text prompts.
|
|
15629
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.
|
|
15630
15705
|
* @param player The `Player` requesting the generation.
|
|
15631
|
-
* @param options
|
|
15632
|
-
*
|
|
15633
|
-
*
|
|
15634
|
-
*
|
|
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).
|
|
15635
15711
|
*/
|
|
15636
15712
|
GenerateMeshAsync(this: GenerationService, inputs: object, player: Player, options: object, intermediateResultCallback?: Callback): unknown;
|
|
15637
15713
|
/**
|
|
15638
|
-
* Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`.
|
|
15714
|
+
* Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`.
|
|
15639
15715
|
*
|
|
15640
15716
|
* - **ThreadSafety**: Unsafe
|
|
15641
15717
|
* - **Tags**: Yields
|
|
15642
15718
|
*
|
|
15643
15719
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#LoadGeneratedMeshAsync)
|
|
15644
|
-
* @param this
|
|
15720
|
+
* @param this Service that allows developers to generate 3D objects from text prompts.
|
|
15645
15721
|
* @param generationId The unique ID returned by `GenerateMeshAsync()`. Identifies the mesh to load.
|
|
15646
|
-
* @returns The generated
|
|
15722
|
+
* @returns The generated asset, returned as a `Model` with a single `MeshPart` containing an `EditableMesh`.
|
|
15647
15723
|
*/
|
|
15648
15724
|
LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
|
|
15649
15725
|
}
|
|
@@ -28092,6 +28168,8 @@ interface BasePart extends PVInstance {
|
|
|
28092
28168
|
*/
|
|
28093
28169
|
GetRenderCFrame(this: BasePart): CFrame;
|
|
28094
28170
|
/**
|
|
28171
|
+
* **Deprecated:**
|
|
28172
|
+
*
|
|
28095
28173
|
* Returns the base part of an assembly of parts.
|
|
28096
28174
|
*
|
|
28097
28175
|
* - **ThreadSafety**: Safe
|
|
@@ -31099,7 +31177,7 @@ interface DataStoreVersionPages extends Pages<DataStoreObjectVersionInfo> {
|
|
|
31099
31177
|
readonly _nominal_DataStoreVersionPages: unique symbol;
|
|
31100
31178
|
}
|
|
31101
31179
|
/**
|
|
31102
|
-
* A special version of `Pages` that contains information about a player's
|
|
31180
|
+
* A special version of `Pages` that contains information about a player's connections.
|
|
31103
31181
|
*
|
|
31104
31182
|
* - **Tags**: NotCreatable, NotReplicated
|
|
31105
31183
|
*
|
|
@@ -32752,15 +32830,15 @@ interface Player extends Instance {
|
|
|
32752
32830
|
*/
|
|
32753
32831
|
SaveString(this: Player, key: string, value: string): void;
|
|
32754
32832
|
/**
|
|
32755
|
-
* Returns a dictionary of online
|
|
32833
|
+
* Returns a dictionary of online connections.
|
|
32756
32834
|
*
|
|
32757
32835
|
* - **ThreadSafety**: Unsafe
|
|
32758
32836
|
* - **Tags**: Yields
|
|
32759
32837
|
*
|
|
32760
32838
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnline)
|
|
32761
32839
|
* @param this An object that represents a presently connected client to the experience.
|
|
32762
|
-
* @param maxFriends The maximum number of online
|
|
32763
|
-
* @returns A dictionary of online
|
|
32840
|
+
* @param maxFriends The maximum number of online connections to return.
|
|
32841
|
+
* @returns A dictionary of online connections (see the table above).
|
|
32764
32842
|
*/
|
|
32765
32843
|
GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
|
|
32766
32844
|
/**
|
|
@@ -32790,7 +32868,7 @@ interface Player extends Instance {
|
|
|
32790
32868
|
/**
|
|
32791
32869
|
* **Deprecated:** This function is obsolete because the Best Friends feature was removed. Use `Player:IsFriendsWith()` instead.
|
|
32792
32870
|
*
|
|
32793
|
-
* Returns whether a player is
|
|
32871
|
+
* Returns whether a player is connections with the specified user.
|
|
32794
32872
|
*
|
|
32795
32873
|
* - **ThreadSafety**: Unsafe
|
|
32796
32874
|
* - **Tags**: Yields
|
|
@@ -32803,7 +32881,7 @@ interface Player extends Instance {
|
|
|
32803
32881
|
*/
|
|
32804
32882
|
IsBestFriendsWith(this: Player, userId: number): boolean;
|
|
32805
32883
|
/**
|
|
32806
|
-
* Checks whether a player is a
|
|
32884
|
+
* Checks whether a player is a connection of the user with the given `Player.UserId`.
|
|
32807
32885
|
*
|
|
32808
32886
|
* - **ThreadSafety**: Unsafe
|
|
32809
32887
|
* - **Tags**: Yields
|
|
@@ -32811,7 +32889,7 @@ interface Player extends Instance {
|
|
|
32811
32889
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWith)
|
|
32812
32890
|
* @param this An object that represents a presently connected client to the experience.
|
|
32813
32891
|
* @param userId The `Player.UserId` of the specified player.
|
|
32814
|
-
* @returns A boolean indicating whether a player is a
|
|
32892
|
+
* @returns A boolean indicating whether a player is a connection of the specified user.
|
|
32815
32893
|
*/
|
|
32816
32894
|
IsFriendsWith(this: Player, userId: number): boolean;
|
|
32817
32895
|
/**
|
|
@@ -33505,7 +33583,7 @@ interface Players extends Instance {
|
|
|
33505
33583
|
*/
|
|
33506
33584
|
GetCharacterAppearanceInfoAsync(this: Players, userId: number): CharacterAppearanceInfo;
|
|
33507
33585
|
/**
|
|
33508
|
-
* Returns a `FriendPages` object which contains information for all of the given player's
|
|
33586
|
+
* Returns a `FriendPages` object which contains information for all of the given player's connections.
|
|
33509
33587
|
*
|
|
33510
33588
|
* - **ThreadSafety**: Unsafe
|
|
33511
33589
|
* - **Tags**: Yields
|
|
@@ -34511,7 +34589,7 @@ interface RecommendationService extends Instance {
|
|
|
34511
34589
|
* @param this
|
|
34512
34590
|
* @param registerRecommendationItemsRequest
|
|
34513
34591
|
*/
|
|
34514
|
-
RegisterItemAsync(this: RecommendationService, registerRecommendationItemsRequest: object): object;
|
|
34592
|
+
RegisterItemAsync(this: RecommendationService, player: Player, registerRecommendationItemsRequest: object): object;
|
|
34515
34593
|
/**
|
|
34516
34594
|
* - **ThreadSafety**: Unsafe
|
|
34517
34595
|
* - **Tags**: Yields
|
|
@@ -36558,6 +36636,9 @@ interface SocialService extends Instance {
|
|
|
36558
36636
|
* - **Tags**: Yields
|
|
36559
36637
|
*
|
|
36560
36638
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharing)
|
|
36639
|
+
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
36640
|
+
* @param player
|
|
36641
|
+
* @param options
|
|
36561
36642
|
*/
|
|
36562
36643
|
PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
|
|
36563
36644
|
/**
|
|
@@ -38662,6 +38743,14 @@ interface SurfaceAppearance extends Instance {
|
|
|
38662
38743
|
* @deprecated
|
|
38663
38744
|
*/
|
|
38664
38745
|
readonly _nominal_SurfaceAppearance: unique symbol;
|
|
38746
|
+
/**
|
|
38747
|
+
* Determines how the alpha channel of the `SurfaceAppearance.ColorMap` is used.
|
|
38748
|
+
*
|
|
38749
|
+
* - **ThreadSafety**: ReadSafe
|
|
38750
|
+
*
|
|
38751
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#AlphaMode)
|
|
38752
|
+
*/
|
|
38753
|
+
AlphaMode: Enum.AlphaMode;
|
|
38665
38754
|
/**
|
|
38666
38755
|
* Applies a tint to your existing colormap. Set directly with color picker or programmatically with `Color3`.
|
|
38667
38756
|
*
|
|
@@ -41685,15 +41774,15 @@ interface UIContainerQuery extends UIComponent {
|
|
|
41685
41774
|
/**
|
|
41686
41775
|
* - **ThreadSafety**: ReadSafe
|
|
41687
41776
|
*
|
|
41688
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#
|
|
41777
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#AspectRatioRange)
|
|
41689
41778
|
*/
|
|
41690
|
-
|
|
41779
|
+
AspectRatioRange: NumberRange;
|
|
41691
41780
|
/**
|
|
41692
41781
|
* - **ThreadSafety**: ReadSafe
|
|
41693
41782
|
*
|
|
41694
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#
|
|
41783
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#IsActive)
|
|
41695
41784
|
*/
|
|
41696
|
-
|
|
41785
|
+
IsActive: boolean;
|
|
41697
41786
|
/**
|
|
41698
41787
|
* - **ThreadSafety**: ReadSafe
|
|
41699
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
|
-
*
|
|
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
|
|
9293
|
+
* A special version of `Pages` that contains information about a player's connections.
|
|
9239
9294
|
*
|
|
9240
9295
|
* - **Tags**: NotCreatable, NotReplicated
|
|
9241
9296
|
*
|
|
@@ -13115,14 +13170,6 @@ interface SurfaceAppearance extends Instance {
|
|
|
13115
13170
|
* @deprecated
|
|
13116
13171
|
*/
|
|
13117
13172
|
readonly _nominal_SurfaceAppearance: unique symbol;
|
|
13118
|
-
/**
|
|
13119
|
-
* Determines how the alpha channel of the `SurfaceAppearance.ColorMap` is used.
|
|
13120
|
-
*
|
|
13121
|
-
* - **ThreadSafety**: ReadSafe
|
|
13122
|
-
*
|
|
13123
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#AlphaMode)
|
|
13124
|
-
*/
|
|
13125
|
-
AlphaMode: Enum.AlphaMode;
|
|
13126
13173
|
/**
|
|
13127
13174
|
* Determines the color and opacity of the surface.
|
|
13128
13175
|
*
|
|
@@ -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
|
|
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
|
|
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)
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
*/
|
|
@@ -22979,6 +23013,44 @@ declare namespace Enum {
|
|
|
22979
23013
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PositionAlignmentMode | undefined;
|
|
22980
23014
|
}
|
|
22981
23015
|
export type PositionAlignmentMode = PositionAlignmentMode.OneAttachment | PositionAlignmentMode.TwoAttachment;
|
|
23016
|
+
/**
|
|
23017
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode)
|
|
23018
|
+
*/
|
|
23019
|
+
export namespace PredictionMode {
|
|
23020
|
+
/**
|
|
23021
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#Auto)
|
|
23022
|
+
*/
|
|
23023
|
+
export interface Auto extends globalThis.EnumItem {
|
|
23024
|
+
Name: "Auto";
|
|
23025
|
+
Value: 0;
|
|
23026
|
+
EnumType: typeof globalThis.Enum.PredictionMode;
|
|
23027
|
+
}
|
|
23028
|
+
export const Auto: Auto;
|
|
23029
|
+
/**
|
|
23030
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#None)
|
|
23031
|
+
*/
|
|
23032
|
+
export interface None extends globalThis.EnumItem {
|
|
23033
|
+
Name: "None";
|
|
23034
|
+
Value: 1;
|
|
23035
|
+
EnumType: typeof globalThis.Enum.PredictionMode;
|
|
23036
|
+
}
|
|
23037
|
+
export const None: None;
|
|
23038
|
+
/**
|
|
23039
|
+
* **Deprecated:**
|
|
23040
|
+
*
|
|
23041
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#Forced)
|
|
23042
|
+
*/
|
|
23043
|
+
export interface Forced extends globalThis.EnumItem {
|
|
23044
|
+
Name: "Forced";
|
|
23045
|
+
Value: 2;
|
|
23046
|
+
EnumType: typeof globalThis.Enum.PredictionMode;
|
|
23047
|
+
}
|
|
23048
|
+
export const Forced: Forced;
|
|
23049
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PredictionMode>;
|
|
23050
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.PredictionMode | undefined;
|
|
23051
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PredictionMode | undefined;
|
|
23052
|
+
}
|
|
23053
|
+
export type PredictionMode = PredictionMode.Auto | PredictionMode.None | PredictionMode.Forced;
|
|
22982
23054
|
/**
|
|
22983
23055
|
* This enum is used with `UserInputService.PreferredInput` to indicate the primary input type a player is likely using.
|
|
22984
23056
|
*
|
|
@@ -26698,6 +26770,8 @@ declare namespace Enum {
|
|
|
26698
26770
|
*/
|
|
26699
26771
|
export namespace ShowAdResult {
|
|
26700
26772
|
/**
|
|
26773
|
+
* The ad was successfully shown to completion.
|
|
26774
|
+
*
|
|
26701
26775
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#ShowCompleted)
|
|
26702
26776
|
*/
|
|
26703
26777
|
export interface ShowCompleted extends globalThis.EnumItem {
|
|
@@ -26707,6 +26781,8 @@ declare namespace Enum {
|
|
|
26707
26781
|
}
|
|
26708
26782
|
export const ShowCompleted: ShowCompleted;
|
|
26709
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
|
+
*
|
|
26710
26786
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#AdNotReady)
|
|
26711
26787
|
*/
|
|
26712
26788
|
export interface AdNotReady extends globalThis.EnumItem {
|
|
@@ -26716,6 +26792,8 @@ declare namespace Enum {
|
|
|
26716
26792
|
}
|
|
26717
26793
|
export const AdNotReady: AdNotReady;
|
|
26718
26794
|
/**
|
|
26795
|
+
* You are trying to show a full-screen ad while another full-screen ad is already playing.
|
|
26796
|
+
*
|
|
26719
26797
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#AdAlreadyShowing)
|
|
26720
26798
|
*/
|
|
26721
26799
|
export interface AdAlreadyShowing extends globalThis.EnumItem {
|
|
@@ -26725,6 +26803,8 @@ declare namespace Enum {
|
|
|
26725
26803
|
}
|
|
26726
26804
|
export const AdAlreadyShowing: AdAlreadyShowing;
|
|
26727
26805
|
/**
|
|
26806
|
+
* An unspecified internal error occurred. Try showing the ad again.
|
|
26807
|
+
*
|
|
26728
26808
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#InternalError)
|
|
26729
26809
|
*/
|
|
26730
26810
|
export interface InternalError extends globalThis.EnumItem {
|
|
@@ -26734,6 +26814,8 @@ declare namespace Enum {
|
|
|
26734
26814
|
}
|
|
26735
26815
|
export const InternalError: InternalError;
|
|
26736
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
|
+
*
|
|
26737
26819
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#ShowInterrupted)
|
|
26738
26820
|
*/
|
|
26739
26821
|
export interface ShowInterrupted extends globalThis.EnumItem {
|