@rbxts/types 1.0.880 → 1.0.882
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.
|
@@ -899,7 +899,7 @@ interface ConfigSnapshot extends RBXObject {
|
|
|
899
899
|
* @param key
|
|
900
900
|
* @param defaultValue
|
|
901
901
|
*/
|
|
902
|
-
GetValue(this: ConfigSnapshot, key: string
|
|
902
|
+
GetValue(this: ConfigSnapshot, key: string): unknown;
|
|
903
903
|
/**
|
|
904
904
|
* - **ThreadSafety**: Unsafe
|
|
905
905
|
*
|
|
@@ -2361,6 +2361,12 @@ interface Instance extends RBXObject {
|
|
|
2361
2361
|
* @returns The full name of the `Instance`.
|
|
2362
2362
|
*/
|
|
2363
2363
|
GetFullName(this: Instance): string;
|
|
2364
|
+
/**
|
|
2365
|
+
* - **ThreadSafety**: Unsafe
|
|
2366
|
+
*
|
|
2367
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetPredictionMode)
|
|
2368
|
+
*/
|
|
2369
|
+
GetPredictionMode(this: Instance): Enum.PredictionMode;
|
|
2364
2370
|
/**
|
|
2365
2371
|
* Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
|
|
2366
2372
|
*
|
|
@@ -2422,6 +2428,12 @@ interface Instance extends RBXObject {
|
|
|
2422
2428
|
* @returns True if the `Instance` is a descendant of the given ancestor.
|
|
2423
2429
|
*/
|
|
2424
2430
|
IsDescendantOf(this: Instance, ancestor: Instance): boolean;
|
|
2431
|
+
/**
|
|
2432
|
+
* - **ThreadSafety**: Unsafe
|
|
2433
|
+
*
|
|
2434
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#IsPredicted)
|
|
2435
|
+
*/
|
|
2436
|
+
IsPredicted(this: Instance): boolean;
|
|
2425
2437
|
/**
|
|
2426
2438
|
* Returns `true` if the value stored in the specified property is equal to the code-instantiated default.
|
|
2427
2439
|
*
|
|
@@ -2464,6 +2476,12 @@ interface Instance extends RBXObject {
|
|
|
2464
2476
|
* @param value The value to set the specified attribute to.
|
|
2465
2477
|
*/
|
|
2466
2478
|
SetAttribute(this: Instance, attribute: string, value: AttributeValue | undefined): void;
|
|
2479
|
+
/**
|
|
2480
|
+
* - **ThreadSafety**: Unsafe
|
|
2481
|
+
*
|
|
2482
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#SetPredictionMode)
|
|
2483
|
+
*/
|
|
2484
|
+
SetPredictionMode(this: Instance, mode: CastsToEnum<Enum.PredictionMode>): void;
|
|
2467
2485
|
/**
|
|
2468
2486
|
* Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
|
|
2469
2487
|
*
|
|
@@ -3159,11 +3177,11 @@ interface KeyframeSequence extends AnimationClip {
|
|
|
3159
3177
|
*
|
|
3160
3178
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/KeyframeSequence#GetKeyframes)
|
|
3161
3179
|
* @param this This object stores all of the `Keyframes` and other data for the animation.
|
|
3162
|
-
* @returns An array of `
|
|
3180
|
+
* @returns An array of `Keyframes`.
|
|
3163
3181
|
*/
|
|
3164
3182
|
GetKeyframes(this: KeyframeSequence): Array<Keyframe>;
|
|
3165
3183
|
/**
|
|
3166
|
-
* This
|
|
3184
|
+
* This method removes a `Keyframe` from the `KeyframeSequence` by setting its parent to `nil`.
|
|
3167
3185
|
*
|
|
3168
3186
|
* - **ThreadSafety**: Unsafe
|
|
3169
3187
|
*
|
|
@@ -4286,7 +4304,7 @@ interface Atmosphere extends Instance {
|
|
|
4286
4304
|
Offset: number;
|
|
4287
4305
|
}
|
|
4288
4306
|
/**
|
|
4289
|
-
* Defines a point and orientation relative to
|
|
4307
|
+
* Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4290
4308
|
*
|
|
4291
4309
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment)
|
|
4292
4310
|
*/
|
|
@@ -4431,7 +4449,7 @@ interface Attachment extends Instance {
|
|
|
4431
4449
|
* - **Tags**:
|
|
4432
4450
|
*
|
|
4433
4451
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetAxis)
|
|
4434
|
-
* @param this Defines a point and orientation relative to
|
|
4452
|
+
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4435
4453
|
*
|
|
4436
4454
|
* @deprecated Axis
|
|
4437
4455
|
*/
|
|
@@ -4442,7 +4460,7 @@ interface Attachment extends Instance {
|
|
|
4442
4460
|
* - **ThreadSafety**: Unsafe
|
|
4443
4461
|
*
|
|
4444
4462
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetConstraints)
|
|
4445
|
-
* @param this Defines a point and orientation relative to
|
|
4463
|
+
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4446
4464
|
*/
|
|
4447
4465
|
GetConstraints(this: Attachment): Array<Instance>;
|
|
4448
4466
|
/**
|
|
@@ -4454,7 +4472,7 @@ interface Attachment extends Instance {
|
|
|
4454
4472
|
* - **Tags**:
|
|
4455
4473
|
*
|
|
4456
4474
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetSecondaryAxis)
|
|
4457
|
-
* @param this Defines a point and orientation relative to
|
|
4475
|
+
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4458
4476
|
*
|
|
4459
4477
|
* @deprecated SecondaryAxis
|
|
4460
4478
|
*/
|
|
@@ -4468,7 +4486,7 @@ interface Attachment extends Instance {
|
|
|
4468
4486
|
* - **Tags**:
|
|
4469
4487
|
*
|
|
4470
4488
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#SetAxis)
|
|
4471
|
-
* @param this Defines a point and orientation relative to
|
|
4489
|
+
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4472
4490
|
* @param axis
|
|
4473
4491
|
*
|
|
4474
4492
|
* @deprecated Axis
|
|
@@ -4483,7 +4501,7 @@ interface Attachment extends Instance {
|
|
|
4483
4501
|
* - **Tags**:
|
|
4484
4502
|
*
|
|
4485
4503
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#SetSecondaryAxis)
|
|
4486
|
-
* @param this Defines a point and orientation relative to
|
|
4504
|
+
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4487
4505
|
* @param axis
|
|
4488
4506
|
*
|
|
4489
4507
|
* @deprecated SecondaryAxis
|
|
@@ -6808,6 +6826,8 @@ interface AudioTextToSpeech extends Instance {
|
|
|
6808
6826
|
readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
|
|
6809
6827
|
}
|
|
6810
6828
|
/**
|
|
6829
|
+
* Creates a trembling effect on a sound by varying the volume of the sound up and down.
|
|
6830
|
+
*
|
|
6811
6831
|
* - **Tags**: NotBrowsable
|
|
6812
6832
|
*
|
|
6813
6833
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo)
|
|
@@ -6828,36 +6848,48 @@ interface AudioTremolo extends Instance {
|
|
|
6828
6848
|
*/
|
|
6829
6849
|
Bypass: boolean;
|
|
6830
6850
|
/**
|
|
6851
|
+
* Controls how much the volume will raise and lower.
|
|
6852
|
+
*
|
|
6831
6853
|
* - **ThreadSafety**: ReadSafe
|
|
6832
6854
|
*
|
|
6833
6855
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Depth)
|
|
6834
6856
|
*/
|
|
6835
6857
|
Depth: number;
|
|
6836
6858
|
/**
|
|
6859
|
+
* Controls how long the effect will be active during one volume oscillation.
|
|
6860
|
+
*
|
|
6837
6861
|
* - **ThreadSafety**: ReadSafe
|
|
6838
6862
|
*
|
|
6839
6863
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Duty)
|
|
6840
6864
|
*/
|
|
6841
6865
|
Duty: number;
|
|
6842
6866
|
/**
|
|
6867
|
+
* Sets how often the effect will oscillate the volume.
|
|
6868
|
+
*
|
|
6843
6869
|
* - **ThreadSafety**: ReadSafe
|
|
6844
6870
|
*
|
|
6845
6871
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Frequency)
|
|
6846
6872
|
*/
|
|
6847
6873
|
Frequency: number;
|
|
6848
6874
|
/**
|
|
6875
|
+
* Controls the shape of the low frequency oscillations.
|
|
6876
|
+
*
|
|
6849
6877
|
* - **ThreadSafety**: ReadSafe
|
|
6850
6878
|
*
|
|
6851
6879
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Shape)
|
|
6852
6880
|
*/
|
|
6853
6881
|
Shape: number;
|
|
6854
6882
|
/**
|
|
6883
|
+
* Time-skews the low frequency oscillations cycle.
|
|
6884
|
+
*
|
|
6855
6885
|
* - **ThreadSafety**: ReadSafe
|
|
6856
6886
|
*
|
|
6857
6887
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Skew)
|
|
6858
6888
|
*/
|
|
6859
6889
|
Skew: number;
|
|
6860
6890
|
/**
|
|
6891
|
+
* Flatness of the low frequency oscillations shape.
|
|
6892
|
+
*
|
|
6861
6893
|
* - **ThreadSafety**: ReadSafe
|
|
6862
6894
|
*
|
|
6863
6895
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Square)
|
|
@@ -7051,9 +7083,9 @@ interface AuroraService extends Instance {
|
|
|
7051
7083
|
/**
|
|
7052
7084
|
* - **ThreadSafety**: Unsafe
|
|
7053
7085
|
*
|
|
7054
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#
|
|
7086
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsInstancePredicted)
|
|
7055
7087
|
*/
|
|
7056
|
-
|
|
7088
|
+
IsInstancePredicted(this: AuroraService, target: Instance): boolean;
|
|
7057
7089
|
/**
|
|
7058
7090
|
* - **ThreadSafety**: Unsafe
|
|
7059
7091
|
*
|
|
@@ -7125,7 +7157,7 @@ interface AuroraService extends Instance {
|
|
|
7125
7157
|
*
|
|
7126
7158
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Misprediction)
|
|
7127
7159
|
*/
|
|
7128
|
-
readonly Misprediction: RBXScriptSignal<(
|
|
7160
|
+
readonly Misprediction: RBXScriptSignal<(remoteWorldStepId: number, mispredictedInstances: Array<unknown>) => void>;
|
|
7129
7161
|
/**
|
|
7130
7162
|
* - **ThreadSafety**: Unsafe
|
|
7131
7163
|
*
|
|
@@ -8592,7 +8624,7 @@ interface RemoteEvent<T extends Callback = Callback> extends BaseRemoteEvent {
|
|
|
8592
8624
|
*/
|
|
8593
8625
|
readonly _nominal_RemoteEvent: unique symbol;
|
|
8594
8626
|
/**
|
|
8595
|
-
* Fires the `OnClientEvent` event for each
|
|
8627
|
+
* Fires the `OnClientEvent` event for each connected client.
|
|
8596
8628
|
*
|
|
8597
8629
|
* - **ThreadSafety**: Unsafe
|
|
8598
8630
|
*
|
|
@@ -8602,7 +8634,7 @@ interface RemoteEvent<T extends Callback = Callback> extends BaseRemoteEvent {
|
|
|
8602
8634
|
*/
|
|
8603
8635
|
FireAllClients(this: RemoteEvent, ...args: Parameters<T>): void;
|
|
8604
8636
|
/**
|
|
8605
|
-
* Fires the `OnClientEvent` event for a specific client
|
|
8637
|
+
* Fires the `OnClientEvent` event for a specific client.
|
|
8606
8638
|
*
|
|
8607
8639
|
* - **ThreadSafety**: Unsafe
|
|
8608
8640
|
*
|
|
@@ -8613,7 +8645,7 @@ interface RemoteEvent<T extends Callback = Callback> extends BaseRemoteEvent {
|
|
|
8613
8645
|
*/
|
|
8614
8646
|
FireClient(this: RemoteEvent, player: Player, ...args: Parameters<T>): void;
|
|
8615
8647
|
/**
|
|
8616
|
-
* Fires the `OnServerEvent` event on the server from one
|
|
8648
|
+
* Fires the `OnServerEvent` event on the server from one connected client.
|
|
8617
8649
|
*
|
|
8618
8650
|
* - **ThreadSafety**: Unsafe
|
|
8619
8651
|
*
|
|
@@ -8654,7 +8686,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
|
|
|
8654
8686
|
*/
|
|
8655
8687
|
readonly _nominal_UnreliableRemoteEvent: unique symbol;
|
|
8656
8688
|
/**
|
|
8657
|
-
* Fires the `OnClientEvent` event for
|
|
8689
|
+
* Fires the `OnClientEvent` event for all connected clients. Has a 1000 byte limit to the payload of the event. Events with larger payloads are dropped.
|
|
8658
8690
|
*
|
|
8659
8691
|
* - **ThreadSafety**: Unsafe
|
|
8660
8692
|
*
|
|
@@ -8664,7 +8696,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
|
|
|
8664
8696
|
*/
|
|
8665
8697
|
FireAllClients(this: UnreliableRemoteEvent, ...args: Parameters<T>): void;
|
|
8666
8698
|
/**
|
|
8667
|
-
* Fires the `OnClientEvent` event for a specific client
|
|
8699
|
+
* Fires the `OnClientEvent` event for a specific client. Has a 1000 byte limit to the payload of the event. Events with larger payloads are dropped.
|
|
8668
8700
|
*
|
|
8669
8701
|
* - **ThreadSafety**: Unsafe
|
|
8670
8702
|
*
|
|
@@ -8675,7 +8707,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
|
|
|
8675
8707
|
*/
|
|
8676
8708
|
FireClient(this: UnreliableRemoteEvent, player: Player, ...args: Parameters<T>): void;
|
|
8677
8709
|
/**
|
|
8678
|
-
* Fires the `OnServerEvent` event on the server from one
|
|
8710
|
+
* Fires the `OnServerEvent` event on the server from one connected client. Has a 1000 byte limit to the payload of the event. Events with larger payloads are dropped.
|
|
8679
8711
|
*
|
|
8680
8712
|
* - **ThreadSafety**: Unsafe
|
|
8681
8713
|
*
|
|
@@ -9797,12 +9829,6 @@ interface CaptureService extends Instance {
|
|
|
9797
9829
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#GetDeviceInfo)
|
|
9798
9830
|
*/
|
|
9799
9831
|
GetDeviceInfo(this: CaptureService): object;
|
|
9800
|
-
/**
|
|
9801
|
-
* - **ThreadSafety**: Unsafe
|
|
9802
|
-
*
|
|
9803
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptCaptureGalleryPermission)
|
|
9804
|
-
*/
|
|
9805
|
-
PromptCaptureGalleryPermission(this: CaptureService, captureGalleryPermission: CastsToEnum<Enum.CaptureGalleryPermission>, onAcceptedCallback: Callback, onDeniedCallback: Callback): void;
|
|
9806
9832
|
/**
|
|
9807
9833
|
* Prompts the user to save specified captures to their gallery.
|
|
9808
9834
|
*
|
|
@@ -15455,6 +15481,20 @@ interface Decal extends FaceInstance {
|
|
|
15455
15481
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#Color3)
|
|
15456
15482
|
*/
|
|
15457
15483
|
Color3: Color3;
|
|
15484
|
+
/**
|
|
15485
|
+
* - **ThreadSafety**: ReadSafe
|
|
15486
|
+
* - **Tags**: NotReplicated
|
|
15487
|
+
*
|
|
15488
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#ColorMap)
|
|
15489
|
+
*/
|
|
15490
|
+
ColorMap: ContentId;
|
|
15491
|
+
/**
|
|
15492
|
+
* - **ThreadSafety**: ReadSafe
|
|
15493
|
+
* - **Tags**: NotReplicated
|
|
15494
|
+
*
|
|
15495
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#ColorMapContent)
|
|
15496
|
+
*/
|
|
15497
|
+
ColorMapContent: Content;
|
|
15458
15498
|
/**
|
|
15459
15499
|
* Acts as a multiplier for the decal's `Decal.Transparency` property. The effects are only visible to the local player.
|
|
15460
15500
|
*
|
|
@@ -20536,7 +20576,7 @@ interface Path2D extends GuiBase {
|
|
|
20536
20576
|
readonly ControlPointChanged: RBXScriptSignal<() => void>;
|
|
20537
20577
|
}
|
|
20538
20578
|
/**
|
|
20539
|
-
*
|
|
20579
|
+
* Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20540
20580
|
*
|
|
20541
20581
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
20542
20582
|
*
|
|
@@ -20552,7 +20592,7 @@ interface GuiService extends Instance {
|
|
|
20552
20592
|
*/
|
|
20553
20593
|
readonly _nominal_GuiService: unique symbol;
|
|
20554
20594
|
/**
|
|
20555
|
-
* If activated, the `Select` button on a
|
|
20595
|
+
* If activated, the `Select` button on a gamepad or `Backslash` will automatically set a GUI as the selected object.
|
|
20556
20596
|
*
|
|
20557
20597
|
* - **ThreadSafety**: ReadSafe
|
|
20558
20598
|
*
|
|
@@ -20560,7 +20600,7 @@ interface GuiService extends Instance {
|
|
|
20560
20600
|
*/
|
|
20561
20601
|
AutoSelectGuiEnabled: boolean;
|
|
20562
20602
|
/**
|
|
20563
|
-
* Toggles whether or not objects in the `CoreGui` can be navigated using a
|
|
20603
|
+
* Toggles whether or not objects in the `CoreGui` can be navigated using a gamepad.
|
|
20564
20604
|
*
|
|
20565
20605
|
* - **ThreadSafety**: ReadSafe
|
|
20566
20606
|
* - **Tags**: Hidden, NotReplicated
|
|
@@ -20603,7 +20643,7 @@ interface GuiService extends Instance {
|
|
|
20603
20643
|
*/
|
|
20604
20644
|
readonly IsWindows: boolean;
|
|
20605
20645
|
/**
|
|
20606
|
-
* Returns true if any menu of CoreGui is open.
|
|
20646
|
+
* Returns `true` if any menu of `CoreGui` is open.
|
|
20607
20647
|
*
|
|
20608
20648
|
* - **ThreadSafety**: ReadSafe
|
|
20609
20649
|
* - **Tags**: NotReplicated
|
|
@@ -20612,6 +20652,8 @@ interface GuiService extends Instance {
|
|
|
20612
20652
|
*/
|
|
20613
20653
|
readonly MenuIsOpen: boolean;
|
|
20614
20654
|
/**
|
|
20655
|
+
* Gets the player's preferred text size as an `PreferredTextSize` value.
|
|
20656
|
+
*
|
|
20615
20657
|
* - **ThreadSafety**: ReadSafe
|
|
20616
20658
|
* - **Tags**: NotReplicated
|
|
20617
20659
|
*
|
|
@@ -20619,7 +20661,7 @@ interface GuiService extends Instance {
|
|
|
20619
20661
|
*/
|
|
20620
20662
|
readonly PreferredTextSize: Enum.PreferredTextSize;
|
|
20621
20663
|
/**
|
|
20622
|
-
* Gets the
|
|
20664
|
+
* Gets the player's preferred transparency as a number between `0` and `1`.
|
|
20623
20665
|
*
|
|
20624
20666
|
* - **ThreadSafety**: ReadSafe
|
|
20625
20667
|
* - **Tags**: Hidden, NotReplicated
|
|
@@ -20628,7 +20670,7 @@ interface GuiService extends Instance {
|
|
|
20628
20670
|
*/
|
|
20629
20671
|
readonly PreferredTransparency: number;
|
|
20630
20672
|
/**
|
|
20631
|
-
* Returns `true` if the
|
|
20673
|
+
* Returns `true` if the player has enabled reduced motion.
|
|
20632
20674
|
*
|
|
20633
20675
|
* - **ThreadSafety**: ReadSafe
|
|
20634
20676
|
* - **Tags**: Hidden, NotReplicated
|
|
@@ -20637,7 +20679,7 @@ interface GuiService extends Instance {
|
|
|
20637
20679
|
*/
|
|
20638
20680
|
readonly ReducedMotionEnabled: boolean;
|
|
20639
20681
|
/**
|
|
20640
|
-
* Sets the GuiObject currently being focused on by the GUI
|
|
20682
|
+
* Sets the `GuiObject` currently being focused on by the GUI navigator.
|
|
20641
20683
|
*
|
|
20642
20684
|
* - **ThreadSafety**: ReadSafe
|
|
20643
20685
|
*
|
|
@@ -20654,7 +20696,7 @@ interface GuiService extends Instance {
|
|
|
20654
20696
|
*/
|
|
20655
20697
|
readonly TopbarInset: Rect;
|
|
20656
20698
|
/**
|
|
20657
|
-
* Used to enable and disable touch controls and touch control display UI. Defaults to true
|
|
20699
|
+
* Used to enable and disable touch controls and touch control display UI. Defaults to `true`.
|
|
20658
20700
|
*
|
|
20659
20701
|
* - **ThreadSafety**: ReadSafe
|
|
20660
20702
|
*
|
|
@@ -20673,13 +20715,13 @@ interface GuiService extends Instance {
|
|
|
20673
20715
|
/**
|
|
20674
20716
|
* **Deprecated:**
|
|
20675
20717
|
*
|
|
20676
|
-
* Creates a
|
|
20718
|
+
* Creates a selection group where gamepad GUI navigation will only consider selectable objects that are within the group.
|
|
20677
20719
|
*
|
|
20678
20720
|
* - **ThreadSafety**: Unsafe
|
|
20679
20721
|
* - **Tags**:
|
|
20680
20722
|
*
|
|
20681
20723
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#AddSelectionParent)
|
|
20682
|
-
* @param this
|
|
20724
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20683
20725
|
* @param selectionName
|
|
20684
20726
|
* @param selectionParent
|
|
20685
20727
|
*
|
|
@@ -20698,7 +20740,7 @@ interface GuiService extends Instance {
|
|
|
20698
20740
|
* - **Tags**:
|
|
20699
20741
|
*
|
|
20700
20742
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#AddSelectionTuple)
|
|
20701
|
-
* @param this
|
|
20743
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20702
20744
|
* @param selectionName The name of the added selection.
|
|
20703
20745
|
* @param selections The selection(s) added.
|
|
20704
20746
|
*
|
|
@@ -20706,117 +20748,117 @@ interface GuiService extends Instance {
|
|
|
20706
20748
|
*/
|
|
20707
20749
|
AddSelectionTuple(this: GuiService, selectionName: string, selections: Array<GuiObject>): void;
|
|
20708
20750
|
/**
|
|
20709
|
-
* Closes the
|
|
20751
|
+
* Closes the avatar inspection menu, if open.
|
|
20710
20752
|
*
|
|
20711
20753
|
* - **ThreadSafety**: Unsafe
|
|
20712
20754
|
*
|
|
20713
20755
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#CloseInspectMenu)
|
|
20714
|
-
* @param this
|
|
20756
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20715
20757
|
*/
|
|
20716
20758
|
CloseInspectMenu(this: GuiService): void;
|
|
20717
20759
|
/**
|
|
20718
20760
|
* - **ThreadSafety**: Unsafe
|
|
20719
20761
|
*
|
|
20720
20762
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#DismissNotification)
|
|
20721
|
-
* @param this
|
|
20763
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20722
20764
|
* @param notificationId
|
|
20723
20765
|
*/
|
|
20724
20766
|
DismissNotification(this: GuiService, notificationId: string): boolean;
|
|
20725
20767
|
/**
|
|
20726
|
-
* Checks if the player
|
|
20768
|
+
* Checks if the player emotes menu is open.
|
|
20727
20769
|
*
|
|
20728
20770
|
* - **ThreadSafety**: Unsafe
|
|
20729
20771
|
*
|
|
20730
20772
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetEmotesMenuOpen)
|
|
20731
|
-
* @param this
|
|
20732
|
-
* @returns
|
|
20773
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20774
|
+
* @returns Whether the emotes menu is open.
|
|
20733
20775
|
*/
|
|
20734
20776
|
GetEmotesMenuOpen(this: GuiService): boolean;
|
|
20735
20777
|
/**
|
|
20736
|
-
* Returns whether or not the `
|
|
20778
|
+
* Returns whether or not the `Player.GameplayPaused` notification has been disabled.
|
|
20737
20779
|
*
|
|
20738
20780
|
* - **ThreadSafety**: Unsafe
|
|
20739
20781
|
*
|
|
20740
20782
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetGameplayPausedNotificationEnabled)
|
|
20741
|
-
* @param this
|
|
20742
|
-
* @returns Whether or not the `
|
|
20783
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20784
|
+
* @returns Whether or not the `Player.GameplayPaused` notification has been disabled.
|
|
20743
20785
|
*/
|
|
20744
20786
|
GetGameplayPausedNotificationEnabled(this: GuiService): boolean;
|
|
20745
20787
|
/**
|
|
20746
|
-
* Returns two `Vector2` values representing the inset of user GUIs in pixels, from the top
|
|
20788
|
+
* Returns two `Vector2` values representing the inset of user GUIs in pixels, from the top‑left corner of the screen and the bottom‑right corner of the screen respectively.
|
|
20747
20789
|
*
|
|
20748
20790
|
* - **ThreadSafety**: Unsafe
|
|
20749
20791
|
*
|
|
20750
20792
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetGuiInset)
|
|
20751
|
-
* @param this
|
|
20752
|
-
* @returns A tuple of two Vector2 values describing the current specified
|
|
20793
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20794
|
+
* @returns A tuple of two `Vector2` values describing the current specified GUI inset.
|
|
20753
20795
|
*/
|
|
20754
20796
|
GetGuiInset(this: GuiService): LuaTuple<[
|
|
20755
20797
|
Vector2,
|
|
20756
20798
|
Vector2
|
|
20757
20799
|
]>;
|
|
20758
20800
|
/**
|
|
20759
|
-
* Returns whether the
|
|
20801
|
+
* Returns whether the avatar inspection menu is enabled.
|
|
20760
20802
|
*
|
|
20761
20803
|
* - **ThreadSafety**: Unsafe
|
|
20762
20804
|
*
|
|
20763
20805
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetInspectMenuEnabled)
|
|
20764
|
-
* @param this
|
|
20765
|
-
* @returns
|
|
20806
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20807
|
+
* @returns Whether the avatar inspection menu is enabled.
|
|
20766
20808
|
*/
|
|
20767
20809
|
GetInspectMenuEnabled(this: GuiService): boolean;
|
|
20768
20810
|
/**
|
|
20769
|
-
* Allows
|
|
20811
|
+
* Allows the avatar inspection menu to appear showing the assets listed in a `HumanoidDescription` object.
|
|
20770
20812
|
*
|
|
20771
20813
|
* - **ThreadSafety**: Unsafe
|
|
20772
20814
|
*
|
|
20773
20815
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#InspectPlayerFromHumanoidDescription)
|
|
20774
|
-
* @param this
|
|
20775
|
-
* @param humanoidDescription A `HumanoidDescription` object that contains the assets to show in the
|
|
20776
|
-
* @param name The name of the player being
|
|
20816
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20817
|
+
* @param humanoidDescription A `HumanoidDescription` object that contains the assets to show in the inspection menu.
|
|
20818
|
+
* @param name The name of the player being inspected to show in the menu.
|
|
20777
20819
|
*/
|
|
20778
20820
|
InspectPlayerFromHumanoidDescription(this: GuiService, humanoidDescription: HumanoidDescription, name: string): void;
|
|
20779
20821
|
/**
|
|
20780
|
-
* Allows the
|
|
20822
|
+
* Allows the avatar inspection menu to appear showing the user that has the given `UserId`.
|
|
20781
20823
|
*
|
|
20782
20824
|
* - **ThreadSafety**: Unsafe
|
|
20783
20825
|
*
|
|
20784
20826
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#InspectPlayerFromUserId)
|
|
20785
|
-
* @param this
|
|
20827
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20786
20828
|
* @param userId The `UserId` of the player to inspect.
|
|
20787
20829
|
*/
|
|
20788
20830
|
InspectPlayerFromUserId(this: GuiService, userId: number): void;
|
|
20789
20831
|
/**
|
|
20790
|
-
* Returns true if the client is using the ten foot interface,
|
|
20832
|
+
* Returns `true` if the client is using the ten foot interface, a special version of Roblox's UI exclusive to consoles.
|
|
20791
20833
|
*
|
|
20792
20834
|
* - **ThreadSafety**: Unsafe
|
|
20793
20835
|
*
|
|
20794
20836
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#IsTenFootInterface)
|
|
20795
|
-
* @param this
|
|
20837
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20796
20838
|
*/
|
|
20797
20839
|
IsTenFootInterface(this: GuiService): boolean;
|
|
20798
20840
|
/**
|
|
20799
20841
|
* **Deprecated:**
|
|
20800
20842
|
*
|
|
20801
|
-
* Removes a group that was created with `
|
|
20843
|
+
* Removes a group that was created with `AddSelectionParent()` or `AddSelectionTuple()`.
|
|
20802
20844
|
*
|
|
20803
20845
|
* - **ThreadSafety**: Unsafe
|
|
20804
20846
|
* - **Tags**:
|
|
20805
20847
|
*
|
|
20806
20848
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#RemoveSelectionGroup)
|
|
20807
|
-
* @param this
|
|
20849
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20808
20850
|
* @param selectionName
|
|
20809
20851
|
*
|
|
20810
20852
|
* @deprecated SelectionGroup
|
|
20811
20853
|
*/
|
|
20812
20854
|
RemoveSelectionGroup(this: GuiService, selectionName: string): void;
|
|
20813
20855
|
/**
|
|
20814
|
-
*
|
|
20856
|
+
* Sets `GuiService.SelectedObject` to a child of a provided instance that is the `PlayerGui` or its descendants.
|
|
20815
20857
|
*
|
|
20816
20858
|
* - **ThreadSafety**: Unsafe
|
|
20817
20859
|
*
|
|
20818
20860
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#Select)
|
|
20819
|
-
* @param this
|
|
20861
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20820
20862
|
* @param selectionParent The parent of selection whose descendants are searched.
|
|
20821
20863
|
*/
|
|
20822
20864
|
Select(this: GuiService, selectionParent: Instance): void;
|
|
@@ -20824,42 +20866,42 @@ interface GuiService extends Instance {
|
|
|
20824
20866
|
* - **ThreadSafety**: Unsafe
|
|
20825
20867
|
*
|
|
20826
20868
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SendNotification)
|
|
20827
|
-
* @param this
|
|
20869
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20828
20870
|
* @param notificationInfo
|
|
20829
20871
|
*/
|
|
20830
20872
|
SendNotification(this: GuiService, notificationInfo: object): string;
|
|
20831
20873
|
/**
|
|
20832
|
-
* Opens or closes the player
|
|
20874
|
+
* Opens or closes the player emotes menu.
|
|
20833
20875
|
*
|
|
20834
20876
|
* - **ThreadSafety**: Unsafe
|
|
20835
20877
|
*
|
|
20836
20878
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SetEmotesMenuOpen)
|
|
20837
|
-
* @param this
|
|
20879
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20838
20880
|
* @param isOpen
|
|
20839
20881
|
*/
|
|
20840
20882
|
SetEmotesMenuOpen(this: GuiService, isOpen: boolean): void;
|
|
20841
20883
|
/**
|
|
20842
|
-
*
|
|
20884
|
+
* Lets you disable the built-in notification when a player's gameplay is paused.
|
|
20843
20885
|
*
|
|
20844
20886
|
* - **ThreadSafety**: Unsafe
|
|
20845
20887
|
*
|
|
20846
20888
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SetGameplayPausedNotificationEnabled)
|
|
20847
|
-
* @param this
|
|
20889
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20848
20890
|
* @param enabled Whether or not the built-in notification GUI is disabled.
|
|
20849
20891
|
*/
|
|
20850
20892
|
SetGameplayPausedNotificationEnabled(this: GuiService, enabled: boolean): void;
|
|
20851
20893
|
/**
|
|
20852
|
-
* Allows
|
|
20894
|
+
* Allows you to enable or disable the avatar inspection menu.
|
|
20853
20895
|
*
|
|
20854
20896
|
* - **ThreadSafety**: Unsafe
|
|
20855
20897
|
*
|
|
20856
20898
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SetInspectMenuEnabled)
|
|
20857
|
-
* @param this
|
|
20858
|
-
* @param enabled A boolean indicating whether to enable or disable the
|
|
20899
|
+
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
20900
|
+
* @param enabled A boolean indicating whether to enable or disable the menu.
|
|
20859
20901
|
*/
|
|
20860
20902
|
SetInspectMenuEnabled(this: GuiService, enabled: boolean): void;
|
|
20861
20903
|
/**
|
|
20862
|
-
* Fires when the user **closes** the Roblox
|
|
20904
|
+
* Fires when the user **closes** the Roblox `CoreGui` escape menu.
|
|
20863
20905
|
*
|
|
20864
20906
|
* - **ThreadSafety**: Unsafe
|
|
20865
20907
|
*
|
|
@@ -20867,7 +20909,7 @@ interface GuiService extends Instance {
|
|
|
20867
20909
|
*/
|
|
20868
20910
|
readonly MenuClosed: RBXScriptSignal<() => void>;
|
|
20869
20911
|
/**
|
|
20870
|
-
* Fires when the user **opens** the Roblox
|
|
20912
|
+
* Fires when the user **opens** the Roblox `CoreGui` escape menu.
|
|
20871
20913
|
*
|
|
20872
20914
|
* - **ThreadSafety**: Unsafe
|
|
20873
20915
|
*
|
|
@@ -25441,6 +25483,14 @@ interface Lighting extends Instance {
|
|
|
25441
25483
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Lighting#GlobalShadows)
|
|
25442
25484
|
*/
|
|
25443
25485
|
GlobalShadows: boolean;
|
|
25486
|
+
/**
|
|
25487
|
+
* The artistic intent behind lighting in the experience.
|
|
25488
|
+
*
|
|
25489
|
+
* - **ThreadSafety**: ReadSafe
|
|
25490
|
+
*
|
|
25491
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Lighting#LightingStyle)
|
|
25492
|
+
*/
|
|
25493
|
+
get LightingStyle(): Enum.LightingStyle;
|
|
25444
25494
|
/**
|
|
25445
25495
|
* The lighting hue applied to outdoor areas.
|
|
25446
25496
|
*
|
|
@@ -25462,6 +25512,14 @@ interface Lighting extends Instance {
|
|
|
25462
25512
|
* @deprecated
|
|
25463
25513
|
*/
|
|
25464
25514
|
Outlines: boolean;
|
|
25515
|
+
/**
|
|
25516
|
+
* Indicates whether you prefer lighting/shading quality or view distance to scale down first.
|
|
25517
|
+
*
|
|
25518
|
+
* - **ThreadSafety**: ReadSafe
|
|
25519
|
+
*
|
|
25520
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Lighting#PrioritizeLightingQuality)
|
|
25521
|
+
*/
|
|
25522
|
+
get PrioritizeLightingQuality(): boolean;
|
|
25465
25523
|
/**
|
|
25466
25524
|
* **Deprecated:** This item is deprecated and has no current functionality. Do not use it for new work.
|
|
25467
25525
|
*
|
|
@@ -27757,7 +27815,7 @@ interface OperationGraph extends Instance {
|
|
|
27757
27815
|
readonly _nominal_OperationGraph: unique symbol;
|
|
27758
27816
|
}
|
|
27759
27817
|
/**
|
|
27760
|
-
* Abstract class for all objects that have a physical location in the world
|
|
27818
|
+
* Abstract class for all objects that have a physical location in the world.
|
|
27761
27819
|
*
|
|
27762
27820
|
* - **Tags**: NotCreatable, NotBrowsable
|
|
27763
27821
|
*
|
|
@@ -27778,7 +27836,7 @@ interface PVInstance extends Instance {
|
|
|
27778
27836
|
* - **ThreadSafety**: Safe
|
|
27779
27837
|
*
|
|
27780
27838
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PVInstance#GetPivot)
|
|
27781
|
-
* @param this Abstract class for all objects that have a physical location in the world
|
|
27839
|
+
* @param this Abstract class for all objects that have a physical location in the world.
|
|
27782
27840
|
*/
|
|
27783
27841
|
GetPivot(this: PVInstance): CFrame;
|
|
27784
27842
|
/**
|
|
@@ -27787,7 +27845,7 @@ interface PVInstance extends Instance {
|
|
|
27787
27845
|
* - **ThreadSafety**: Unsafe
|
|
27788
27846
|
*
|
|
27789
27847
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PVInstance#PivotTo)
|
|
27790
|
-
* @param this Abstract class for all objects that have a physical location in the world
|
|
27848
|
+
* @param this Abstract class for all objects that have a physical location in the world.
|
|
27791
27849
|
* @param targetCFrame The `CFrame` that the `PVInstance` pivot should equal after moving it.
|
|
27792
27850
|
*/
|
|
27793
27851
|
PivotTo(this: PVInstance, targetCFrame: CFrame): void;
|
|
@@ -31102,6 +31160,7 @@ interface WorldRoot extends Model {
|
|
|
31102
31160
|
* Returns an array of parts whose **bounding boxes** overlap a given box.
|
|
31103
31161
|
*
|
|
31104
31162
|
* - **ThreadSafety**: Safe
|
|
31163
|
+
* - **Tags**: CustomLuaState
|
|
31105
31164
|
*
|
|
31106
31165
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartBoundsInBox)
|
|
31107
31166
|
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
@@ -31115,6 +31174,7 @@ interface WorldRoot extends Model {
|
|
|
31115
31174
|
* Returns an array of parts whose **bounding boxes** overlap a given sphere.
|
|
31116
31175
|
*
|
|
31117
31176
|
* - **ThreadSafety**: Safe
|
|
31177
|
+
* - **Tags**: CustomLuaState
|
|
31118
31178
|
*
|
|
31119
31179
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartBoundsInRadius)
|
|
31120
31180
|
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
@@ -31128,6 +31188,7 @@ interface WorldRoot extends Model {
|
|
|
31128
31188
|
* Returns an array of parts whose occupied space is shared with the given part.
|
|
31129
31189
|
*
|
|
31130
31190
|
* - **ThreadSafety**: Safe
|
|
31191
|
+
* - **Tags**: CustomLuaState
|
|
31131
31192
|
*
|
|
31132
31193
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartsInPart)
|
|
31133
31194
|
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
@@ -31233,6 +31294,8 @@ interface Workspace extends WorldRoot {
|
|
|
31233
31294
|
*/
|
|
31234
31295
|
AirDensity: number;
|
|
31235
31296
|
/**
|
|
31297
|
+
* Controls the strength of turbulence present in the wind velocity field, affecting the aerodynamic force model.
|
|
31298
|
+
*
|
|
31236
31299
|
* - **ThreadSafety**: ReadSafe
|
|
31237
31300
|
*
|
|
31238
31301
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AirTurbulenceIntensity)
|
|
@@ -31247,6 +31310,12 @@ interface Workspace extends WorldRoot {
|
|
|
31247
31310
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AllowThirdPartySales)
|
|
31248
31311
|
*/
|
|
31249
31312
|
AllowThirdPartySales: boolean;
|
|
31313
|
+
/**
|
|
31314
|
+
* - **ThreadSafety**: ReadSafe
|
|
31315
|
+
*
|
|
31316
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AuthorityMode)
|
|
31317
|
+
*/
|
|
31318
|
+
AuthorityMode: Enum.AuthorityMode;
|
|
31250
31319
|
/**
|
|
31251
31320
|
* Specifies the animation throttling mode for the local client.
|
|
31252
31321
|
*
|
|
@@ -35134,6 +35203,13 @@ interface RecommendationService extends Instance {
|
|
|
35134
35203
|
* @param generateRecommendationItemListRequest
|
|
35135
35204
|
*/
|
|
35136
35205
|
GenerateItemListAsync(this: RecommendationService, generateRecommendationItemListRequest: object): RecommendationPages;
|
|
35206
|
+
/**
|
|
35207
|
+
* - **ThreadSafety**: Unsafe
|
|
35208
|
+
* - **Tags**: Yields
|
|
35209
|
+
*
|
|
35210
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#GetRecommendationItemAsync)
|
|
35211
|
+
*/
|
|
35212
|
+
GetRecommendationItemAsync(this: RecommendationService, itemId: string): object;
|
|
35137
35213
|
/**
|
|
35138
35214
|
* - **ThreadSafety**: Unsafe
|
|
35139
35215
|
* - **Tags**: Yields
|
|
@@ -35616,6 +35692,13 @@ interface RunService extends Instance {
|
|
|
35616
35692
|
* @deprecated
|
|
35617
35693
|
*/
|
|
35618
35694
|
readonly _nominal_RunService: unique symbol;
|
|
35695
|
+
/**
|
|
35696
|
+
* - **ThreadSafety**: ReadSafe
|
|
35697
|
+
* - **Tags**: NotReplicated
|
|
35698
|
+
*
|
|
35699
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#ServerFrame)
|
|
35700
|
+
*/
|
|
35701
|
+
readonly ServerFrame: number;
|
|
35619
35702
|
/**
|
|
35620
35703
|
* Given a string name of a function and a priority, this method binds the function to `RunService.PreRender`.
|
|
35621
35704
|
*
|
|
@@ -35688,6 +35771,12 @@ interface RunService extends Instance {
|
|
|
35688
35771
|
* @param name The name of the function being unbound.
|
|
35689
35772
|
*/
|
|
35690
35773
|
UnbindFromRenderStep(this: RunService, name: string): void;
|
|
35774
|
+
/**
|
|
35775
|
+
* - **ThreadSafety**: Unsafe
|
|
35776
|
+
*
|
|
35777
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#FixedHeartbeat)
|
|
35778
|
+
*/
|
|
35779
|
+
readonly FixedHeartbeat: RBXScriptSignal<(deltaTime: number) => void>;
|
|
35691
35780
|
/**
|
|
35692
35781
|
* Fires every frame, after the physics simulation has completed.
|
|
35693
35782
|
*
|
|
@@ -38103,6 +38192,12 @@ interface SoundService extends Instance {
|
|
|
38103
38192
|
* @deprecated
|
|
38104
38193
|
*/
|
|
38105
38194
|
readonly _nominal_SoundService: unique symbol;
|
|
38195
|
+
/**
|
|
38196
|
+
* - **ThreadSafety**: ReadSafe
|
|
38197
|
+
*
|
|
38198
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#AcousticSimulationEnabled)
|
|
38199
|
+
*/
|
|
38200
|
+
AcousticSimulationEnabled: boolean;
|
|
38106
38201
|
/**
|
|
38107
38202
|
* The ambient sound environment preset used by `SoundService`.
|
|
38108
38203
|
*
|
|
@@ -41544,6 +41639,8 @@ interface TextFilterTranslatedResult extends Instance {
|
|
|
41544
41639
|
GetTranslations(this: TextFilterTranslatedResult): object;
|
|
41545
41640
|
}
|
|
41546
41641
|
/**
|
|
41642
|
+
* Gives access to a large language model for text generation.
|
|
41643
|
+
*
|
|
41547
41644
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator)
|
|
41548
41645
|
*/
|
|
41549
41646
|
interface TextGenerator extends Instance {
|
|
@@ -41556,16 +41653,47 @@ interface TextGenerator extends Instance {
|
|
|
41556
41653
|
*/
|
|
41557
41654
|
readonly _nominal_TextGenerator: unique symbol;
|
|
41558
41655
|
/**
|
|
41656
|
+
* Sets a fixed seed for the random number generator, allowing reproducible responses in cases where the same input parameters are used across multiple requests.
|
|
41657
|
+
*
|
|
41658
|
+
* - **ThreadSafety**: ReadSafe
|
|
41659
|
+
*
|
|
41660
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#Seed)
|
|
41661
|
+
*/
|
|
41662
|
+
Seed: number;
|
|
41663
|
+
/**
|
|
41664
|
+
* Provides context to the model about its role, tone, or behavior during conversation.
|
|
41665
|
+
*
|
|
41559
41666
|
* - **ThreadSafety**: ReadSafe
|
|
41560
41667
|
*
|
|
41561
41668
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#SystemPrompt)
|
|
41562
41669
|
*/
|
|
41563
41670
|
SystemPrompt: string;
|
|
41564
41671
|
/**
|
|
41672
|
+
* Controls the "creativity" or randomness of the model's responses.
|
|
41673
|
+
*
|
|
41674
|
+
* - **ThreadSafety**: ReadSafe
|
|
41675
|
+
*
|
|
41676
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#Temperature)
|
|
41677
|
+
*/
|
|
41678
|
+
Temperature: number;
|
|
41679
|
+
/**
|
|
41680
|
+
* Helps the AI model narrow or expand the range of possible words to sample from while generating the next token.
|
|
41681
|
+
*
|
|
41682
|
+
* - **ThreadSafety**: ReadSafe
|
|
41683
|
+
*
|
|
41684
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#TopP)
|
|
41685
|
+
*/
|
|
41686
|
+
TopP: number;
|
|
41687
|
+
/**
|
|
41688
|
+
* Returns text generated by an LLM based on the provided system and user prompts.
|
|
41689
|
+
*
|
|
41565
41690
|
* - **ThreadSafety**: Unsafe
|
|
41566
41691
|
* - **Tags**: Yields
|
|
41567
41692
|
*
|
|
41568
41693
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#GenerateTextAsync)
|
|
41694
|
+
* @param this Gives access to a large language model for text generation.
|
|
41695
|
+
* @param request A dictionary containing optional parameters for the text generation request. The currently supported parameters are `UserPrompt`, `ContextToken`, and `MaxTokens`.
|
|
41696
|
+
* @returns A dictionary containing the LLM's generated response.
|
|
41569
41697
|
*/
|
|
41570
41698
|
GenerateTextAsync(this: TextGenerator, request: object): object;
|
|
41571
41699
|
}
|
|
@@ -45122,12 +45250,6 @@ interface VideoPlayer extends Instance {
|
|
|
45122
45250
|
* @deprecated
|
|
45123
45251
|
*/
|
|
45124
45252
|
readonly _nominal_VideoPlayer: unique symbol;
|
|
45125
|
-
/**
|
|
45126
|
-
* - **ThreadSafety**: ReadSafe
|
|
45127
|
-
*
|
|
45128
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Asset)
|
|
45129
|
-
*/
|
|
45130
|
-
Asset: ContentId;
|
|
45131
45253
|
/**
|
|
45132
45254
|
* - **ThreadSafety**: ReadSafe
|
|
45133
45255
|
* - **Tags**: NotReplicated
|
|
@@ -45755,6 +45877,24 @@ interface WrapTextureTransfer extends Instance {
|
|
|
45755
45877
|
* @deprecated
|
|
45756
45878
|
*/
|
|
45757
45879
|
readonly _nominal_WrapTextureTransfer: unique symbol;
|
|
45880
|
+
/**
|
|
45881
|
+
* - **ThreadSafety**: ReadSafe
|
|
45882
|
+
*
|
|
45883
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#ReferenceCageMeshContent)
|
|
45884
|
+
*/
|
|
45885
|
+
ReferenceCageMeshContent: Content;
|
|
45886
|
+
/**
|
|
45887
|
+
* - **ThreadSafety**: ReadSafe
|
|
45888
|
+
*
|
|
45889
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#UVMaxBound)
|
|
45890
|
+
*/
|
|
45891
|
+
UVMaxBound: Vector2;
|
|
45892
|
+
/**
|
|
45893
|
+
* - **ThreadSafety**: ReadSafe
|
|
45894
|
+
*
|
|
45895
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#UVMinBound)
|
|
45896
|
+
*/
|
|
45897
|
+
UVMinBound: Vector2;
|
|
45758
45898
|
}
|
|
45759
45899
|
/**
|
|
45760
45900
|
* - **Tags**: NotCreatable, NotReplicated
|
|
@@ -1506,7 +1506,7 @@ interface Atmosphere extends Instance {
|
|
|
1506
1506
|
readonly _nominal_Atmosphere: unique symbol;
|
|
1507
1507
|
}
|
|
1508
1508
|
/**
|
|
1509
|
-
* Defines a point and orientation relative to
|
|
1509
|
+
* Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
1510
1510
|
*
|
|
1511
1511
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment)
|
|
1512
1512
|
*/
|
|
@@ -1913,6 +1913,8 @@ interface AudioTextToSpeech extends Instance {
|
|
|
1913
1913
|
readonly _nominal_AudioTextToSpeech: unique symbol;
|
|
1914
1914
|
}
|
|
1915
1915
|
/**
|
|
1916
|
+
* Creates a trembling effect on a sound by varying the volume of the sound up and down.
|
|
1917
|
+
*
|
|
1916
1918
|
* - **Tags**: NotBrowsable
|
|
1917
1919
|
*
|
|
1918
1920
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo)
|
|
@@ -6611,7 +6613,7 @@ interface Path2D extends GuiBase {
|
|
|
6611
6613
|
readonly _nominal_Path2D: unique symbol;
|
|
6612
6614
|
}
|
|
6613
6615
|
/**
|
|
6614
|
-
*
|
|
6616
|
+
* Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
6615
6617
|
*
|
|
6616
6618
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
6617
6619
|
*
|
|
@@ -8579,7 +8581,7 @@ interface OperationGraph extends Instance {
|
|
|
8579
8581
|
readonly _nominal_OperationGraph: unique symbol;
|
|
8580
8582
|
}
|
|
8581
8583
|
/**
|
|
8582
|
-
* Abstract class for all objects that have a physical location in the world
|
|
8584
|
+
* Abstract class for all objects that have a physical location in the world.
|
|
8583
8585
|
*
|
|
8584
8586
|
* - **Tags**: NotCreatable, NotBrowsable
|
|
8585
8587
|
*
|
|
@@ -10146,11 +10148,14 @@ interface Plugin extends Instance {
|
|
|
10146
10148
|
* Used to open the given script instance in an editor window, in Roblox studio, at the given line. If no line is given as an argument it will default to 1.
|
|
10147
10149
|
*
|
|
10148
10150
|
* - **ThreadSafety**: Unsafe
|
|
10151
|
+
* - **Tags**:
|
|
10149
10152
|
*
|
|
10150
10153
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#OpenScript)
|
|
10151
10154
|
* @param this
|
|
10152
10155
|
* @param script
|
|
10153
10156
|
* @param lineNumber
|
|
10157
|
+
*
|
|
10158
|
+
* @deprecated
|
|
10154
10159
|
*/
|
|
10155
10160
|
OpenScript(this: Plugin, script: LuaSourceContainer, lineNumber?: number): void;
|
|
10156
10161
|
/**
|
|
@@ -13944,6 +13949,8 @@ interface TextFilterTranslatedResult extends Instance {
|
|
|
13944
13949
|
readonly _nominal_TextFilterTranslatedResult: unique symbol;
|
|
13945
13950
|
}
|
|
13946
13951
|
/**
|
|
13952
|
+
* Gives access to a large language model for text generation.
|
|
13953
|
+
*
|
|
13947
13954
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator)
|
|
13948
13955
|
*/
|
|
13949
13956
|
interface TextGenerator extends Instance {
|
|
@@ -2149,11 +2149,20 @@ declare namespace Enum {
|
|
|
2149
2149
|
EnumType: typeof globalThis.Enum.AppUpdateStatus;
|
|
2150
2150
|
}
|
|
2151
2151
|
export const AvailableBoundChannel: AvailableBoundChannel;
|
|
2152
|
+
/**
|
|
2153
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#AvailableBetaProgram)
|
|
2154
|
+
*/
|
|
2155
|
+
export interface AvailableBetaProgram extends globalThis.EnumItem {
|
|
2156
|
+
Name: "AvailableBetaProgram";
|
|
2157
|
+
Value: 6;
|
|
2158
|
+
EnumType: typeof globalThis.Enum.AppUpdateStatus;
|
|
2159
|
+
}
|
|
2160
|
+
export const AvailableBetaProgram: AvailableBetaProgram;
|
|
2152
2161
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AppUpdateStatus>;
|
|
2153
2162
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AppUpdateStatus | undefined;
|
|
2154
2163
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AppUpdateStatus | undefined;
|
|
2155
2164
|
}
|
|
2156
|
-
export type AppUpdateStatus = AppUpdateStatus.Unknown | AppUpdateStatus.NotSupported | AppUpdateStatus.Failed | AppUpdateStatus.NotAvailable | AppUpdateStatus.Available | AppUpdateStatus.AvailableBoundChannel;
|
|
2165
|
+
export type AppUpdateStatus = AppUpdateStatus.Unknown | AppUpdateStatus.NotSupported | AppUpdateStatus.Failed | AppUpdateStatus.NotAvailable | AppUpdateStatus.Available | AppUpdateStatus.AvailableBoundChannel | AppUpdateStatus.AvailableBetaProgram;
|
|
2157
2166
|
/**
|
|
2158
2167
|
* Used by `UIStroke.ApplyStrokeMode` to determine where to apply the stroke.
|
|
2159
2168
|
*
|
|
@@ -8011,6 +8020,15 @@ declare namespace Enum {
|
|
|
8011
8020
|
EnumType: typeof globalThis.Enum.ConnectionError;
|
|
8012
8021
|
}
|
|
8013
8022
|
export const AndroidRootedKick: AndroidRootedKick;
|
|
8023
|
+
/**
|
|
8024
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ScreentimeLockoutKick)
|
|
8025
|
+
*/
|
|
8026
|
+
export interface ScreentimeLockoutKick extends globalThis.EnumItem {
|
|
8027
|
+
Name: "ScreentimeLockoutKick";
|
|
8028
|
+
Value: 307;
|
|
8029
|
+
EnumType: typeof globalThis.Enum.ConnectionError;
|
|
8030
|
+
}
|
|
8031
|
+
export const ScreentimeLockoutKick: ScreentimeLockoutKick;
|
|
8014
8032
|
/**
|
|
8015
8033
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchErrors)
|
|
8016
8034
|
*/
|
|
@@ -8240,7 +8258,7 @@ declare namespace Enum {
|
|
|
8240
8258
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ConnectionError | undefined;
|
|
8241
8259
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ConnectionError | undefined;
|
|
8242
8260
|
}
|
|
8243
|
-
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;
|
|
8261
|
+
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.ScreentimeLockoutKick | 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;
|
|
8244
8262
|
/**
|
|
8245
8263
|
* Used to determine the connection state of the client to the game server.
|
|
8246
8264
|
*
|
|
@@ -22331,6 +22349,33 @@ declare namespace Enum {
|
|
|
22331
22349
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PathfindingUseImprovedSearch | undefined;
|
|
22332
22350
|
}
|
|
22333
22351
|
export type PathfindingUseImprovedSearch = PathfindingUseImprovedSearch.Default | PathfindingUseImprovedSearch.Disabled | PathfindingUseImprovedSearch.Enabled;
|
|
22352
|
+
/**
|
|
22353
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PeoplePageLayout)
|
|
22354
|
+
*/
|
|
22355
|
+
export namespace PeoplePageLayout {
|
|
22356
|
+
/**
|
|
22357
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PeoplePageLayout#Card)
|
|
22358
|
+
*/
|
|
22359
|
+
export interface Card extends globalThis.EnumItem {
|
|
22360
|
+
Name: "Card";
|
|
22361
|
+
Value: 0;
|
|
22362
|
+
EnumType: typeof globalThis.Enum.PeoplePageLayout;
|
|
22363
|
+
}
|
|
22364
|
+
export const Card: Card;
|
|
22365
|
+
/**
|
|
22366
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PeoplePageLayout#List)
|
|
22367
|
+
*/
|
|
22368
|
+
export interface List extends globalThis.EnumItem {
|
|
22369
|
+
Name: "List";
|
|
22370
|
+
Value: 1;
|
|
22371
|
+
EnumType: typeof globalThis.Enum.PeoplePageLayout;
|
|
22372
|
+
}
|
|
22373
|
+
export const List: List;
|
|
22374
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PeoplePageLayout>;
|
|
22375
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.PeoplePageLayout | undefined;
|
|
22376
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PeoplePageLayout | undefined;
|
|
22377
|
+
}
|
|
22378
|
+
export type PeoplePageLayout = PeoplePageLayout.Card | PeoplePageLayout.List;
|
|
22334
22379
|
/**
|
|
22335
22380
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PerformanceOverlayMode)
|
|
22336
22381
|
*/
|
|
@@ -23275,28 +23320,28 @@ declare namespace Enum {
|
|
|
23275
23320
|
}
|
|
23276
23321
|
export const Auto: Auto;
|
|
23277
23322
|
/**
|
|
23278
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#
|
|
23323
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#On)
|
|
23279
23324
|
*/
|
|
23280
|
-
export interface
|
|
23281
|
-
Name: "
|
|
23325
|
+
export interface On extends globalThis.EnumItem {
|
|
23326
|
+
Name: "On";
|
|
23282
23327
|
Value: 1;
|
|
23283
23328
|
EnumType: typeof globalThis.Enum.PredictionMode;
|
|
23284
23329
|
}
|
|
23285
|
-
export const
|
|
23330
|
+
export const On: On;
|
|
23286
23331
|
/**
|
|
23287
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#
|
|
23332
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#Off)
|
|
23288
23333
|
*/
|
|
23289
|
-
export interface
|
|
23290
|
-
Name: "
|
|
23334
|
+
export interface Off extends globalThis.EnumItem {
|
|
23335
|
+
Name: "Off";
|
|
23291
23336
|
Value: 2;
|
|
23292
23337
|
EnumType: typeof globalThis.Enum.PredictionMode;
|
|
23293
23338
|
}
|
|
23294
|
-
export const
|
|
23339
|
+
export const Off: Off;
|
|
23295
23340
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PredictionMode>;
|
|
23296
23341
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.PredictionMode | undefined;
|
|
23297
23342
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PredictionMode | undefined;
|
|
23298
23343
|
}
|
|
23299
|
-
export type PredictionMode = PredictionMode.Auto | PredictionMode.
|
|
23344
|
+
export type PredictionMode = PredictionMode.Auto | PredictionMode.On | PredictionMode.Off;
|
|
23300
23345
|
/**
|
|
23301
23346
|
* This enum is used with `UserInputService.PreferredInput` to indicate the primary input type a player is likely using.
|
|
23302
23347
|
*
|
|
@@ -23342,10 +23387,14 @@ declare namespace Enum {
|
|
|
23342
23387
|
}
|
|
23343
23388
|
export type PreferredInput = PreferredInput.KeyboardAndMouse | PreferredInput.Gamepad | PreferredInput.Touch;
|
|
23344
23389
|
/**
|
|
23390
|
+
* This enum is used with `GuiService.PreferredTextSize` to indicate the player's preferred text size.
|
|
23391
|
+
*
|
|
23345
23392
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize)
|
|
23346
23393
|
*/
|
|
23347
23394
|
export namespace PreferredTextSize {
|
|
23348
23395
|
/**
|
|
23396
|
+
* The player prefers default text size.
|
|
23397
|
+
*
|
|
23349
23398
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Medium)
|
|
23350
23399
|
*/
|
|
23351
23400
|
export interface Medium extends globalThis.EnumItem {
|
|
@@ -23355,6 +23404,8 @@ declare namespace Enum {
|
|
|
23355
23404
|
}
|
|
23356
23405
|
export const Medium: Medium;
|
|
23357
23406
|
/**
|
|
23407
|
+
* The player prefers text size slightly increased beyond default.
|
|
23408
|
+
*
|
|
23358
23409
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Large)
|
|
23359
23410
|
*/
|
|
23360
23411
|
export interface Large extends globalThis.EnumItem {
|
|
@@ -23364,6 +23415,8 @@ declare namespace Enum {
|
|
|
23364
23415
|
}
|
|
23365
23416
|
export const Large: Large;
|
|
23366
23417
|
/**
|
|
23418
|
+
* The player prefers text size moderately increased beyond default.
|
|
23419
|
+
*
|
|
23367
23420
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Larger)
|
|
23368
23421
|
*/
|
|
23369
23422
|
export interface Larger extends globalThis.EnumItem {
|
|
@@ -23373,6 +23426,8 @@ declare namespace Enum {
|
|
|
23373
23426
|
}
|
|
23374
23427
|
export const Larger: Larger;
|
|
23375
23428
|
/**
|
|
23429
|
+
* The player prefers text size considerably increased beyond default.
|
|
23430
|
+
*
|
|
23376
23431
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Largest)
|
|
23377
23432
|
*/
|
|
23378
23433
|
export interface Largest extends globalThis.EnumItem {
|