@rbxts/types 1.0.883 → 1.0.885

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.
@@ -89,6 +89,7 @@ interface Services {
89
89
  ILegacyStudioBridge: ILegacyStudioBridge;
90
90
  IncrementalPatchBuilder: IncrementalPatchBuilder;
91
91
  InsertService: InsertService;
92
+ InstanceExtensionsService: InstanceExtensionsService;
92
93
  InternalSyncService: InternalSyncService;
93
94
  IXPService: IXPService;
94
95
  JointsService: JointsService;
@@ -153,6 +154,7 @@ interface Services {
153
154
  RomarkService: RomarkService;
154
155
  RtMessagingService: RtMessagingService;
155
156
  RunService: RunService;
157
+ RuntimeContentService: RuntimeContentService;
156
158
  SafetyService: SafetyService;
157
159
  ScriptChangeService: ScriptChangeService;
158
160
  ScriptCloneWatcher: ScriptCloneWatcher;
@@ -464,6 +466,7 @@ interface CreatableInstances {
464
466
  StudioCallout: StudioCallout;
465
467
  StyleDerive: StyleDerive;
466
468
  StyleLink: StyleLink;
469
+ StyleQuery: StyleQuery;
467
470
  StyleRule: StyleRule;
468
471
  StyleSheet: StyleSheet;
469
472
  SunRaysEffect: SunRaysEffect;
@@ -492,7 +495,6 @@ interface CreatableInstances {
492
495
  TremoloSoundEffect: TremoloSoundEffect;
493
496
  TrussPart: TrussPart;
494
497
  UIAspectRatioConstraint: UIAspectRatioConstraint;
495
- UIContainerQuery: UIContainerQuery;
496
498
  UICorner: UICorner;
497
499
  UIDragDetector: UIDragDetector;
498
500
  UIFlexItem: UIFlexItem;
@@ -1711,7 +1713,7 @@ interface EditableMesh extends RBXObject {
1711
1713
  */
1712
1714
  GetVerticesWithAttribute(this: EditableMesh, id: number): Array<unknown>;
1713
1715
  /**
1714
- * Returns an array of face IDs that use the given color ID.
1716
+ * Returns an array of vertex IDs that use the given color ID.
1715
1717
  *
1716
1718
  * - **ThreadSafety**: Unsafe
1717
1719
  * - **Tags**: CustomLuaState
@@ -3964,10 +3966,15 @@ interface AssetService extends Instance {
3964
3966
  */
3965
3967
  CreateEditableMesh(this: AssetService, editableMeshOptions?: object): EditableMesh;
3966
3968
  /**
3969
+ * Creates a Decal instance that uses composite PBR textures created by layering the provided textures in the order they are provided in the `layers` array. Textures layer based on the alpha value of the ColorMap.
3970
+ *
3967
3971
  * - **ThreadSafety**: Unsafe
3968
3972
  * - **Tags**: Yields
3969
3973
  *
3970
3974
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#ComposeDecalAsync)
3975
+ * @param this A non-replicated service that handles asset-related queries to the Roblox web API.
3976
+ * @param layers An array of `Dictionary` tables that maps PBR names to ContentID.
3977
+ * @returns A new `Decal` containing the composed texture set.
3971
3978
  */
3972
3979
  ComposeDecalAsync(this: AssetService, layers: Array<unknown>): Decal;
3973
3980
  /**
@@ -5261,6 +5268,12 @@ interface AudioEmitter extends Instance {
5261
5268
  * @deprecated
5262
5269
  */
5263
5270
  readonly _nominal_AudioEmitter: unique symbol;
5271
+ /**
5272
+ * - **ThreadSafety**: ReadSafe
5273
+ *
5274
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#AcousticSimulationEnabled)
5275
+ */
5276
+ AcousticSimulationEnabled: boolean;
5264
5277
  /**
5265
5278
  * Controls which `AudioListeners` are capable of hearing this `AudioEmitter`.
5266
5279
  *
@@ -5270,11 +5283,16 @@ interface AudioEmitter extends Instance {
5270
5283
  */
5271
5284
  AudioInteractionGroup: string;
5272
5285
  /**
5286
+ * **Deprecated:**
5287
+ *
5273
5288
  * Controls how detailed the audio simulation should be for this `AudioEmitter`.
5274
5289
  *
5275
5290
  * - **ThreadSafety**: ReadSafe
5291
+ * - **Tags**:
5276
5292
  *
5277
5293
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#SimulationFidelity)
5294
+ *
5295
+ * @deprecated AcousticSimulationEnabled
5278
5296
  */
5279
5297
  SimulationFidelity: Enum.AudioSimulationFidelity;
5280
5298
  /**
@@ -5864,6 +5882,12 @@ interface AudioListener extends Instance {
5864
5882
  * @deprecated
5865
5883
  */
5866
5884
  readonly _nominal_AudioListener: unique symbol;
5885
+ /**
5886
+ * - **ThreadSafety**: ReadSafe
5887
+ *
5888
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#AcousticSimulationEnabled)
5889
+ */
5890
+ AcousticSimulationEnabled: boolean;
5867
5891
  /**
5868
5892
  * Controls which `AudioEmitters` are audible to this `AudioListener`.
5869
5893
  *
@@ -5873,11 +5897,16 @@ interface AudioListener extends Instance {
5873
5897
  */
5874
5898
  AudioInteractionGroup: string;
5875
5899
  /**
5900
+ * **Deprecated:**
5901
+ *
5876
5902
  * Controls how detailed the audio simulation should be for this `AudioListener`.
5877
5903
  *
5878
5904
  * - **ThreadSafety**: ReadSafe
5905
+ * - **Tags**:
5879
5906
  *
5880
5907
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#SimulationFidelity)
5908
+ *
5909
+ * @deprecated AcousticSimulationEnabled
5881
5910
  */
5882
5911
  SimulationFidelity: Enum.AudioSimulationFidelity;
5883
5912
  /**
@@ -6591,6 +6620,8 @@ interface AudioSearchParams extends Instance {
6591
6620
  Title: string;
6592
6621
  }
6593
6622
  /**
6623
+ * Converts spoken audio into text.
6624
+ *
6594
6625
  * - **Tags**: NotBrowsable
6595
6626
  *
6596
6627
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText)
@@ -6605,18 +6636,24 @@ interface AudioSpeechToText extends Instance {
6605
6636
  */
6606
6637
  readonly _nominal_AudioSpeechToText: unique symbol;
6607
6638
  /**
6639
+ * Whether the `AudioSpeechToText` object is enabled for processing input audio into text.
6640
+ *
6608
6641
  * - **ThreadSafety**: ReadSafe
6609
6642
  *
6610
6643
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#Enabled)
6611
6644
  */
6612
6645
  Enabled: boolean;
6613
6646
  /**
6647
+ * The text resulting from the conversion of speech audio.
6648
+ *
6614
6649
  * - **ThreadSafety**: ReadSafe
6615
6650
  *
6616
6651
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#Text)
6617
6652
  */
6618
6653
  Text: string;
6619
6654
  /**
6655
+ * Whether the `AudioSpeechToText` object is detecting speech in the incoming audio signal.
6656
+ *
6620
6657
  * - **ThreadSafety**: ReadSafe
6621
6658
  * - **Tags**: NotReplicated
6622
6659
  *
@@ -6624,14 +6661,18 @@ interface AudioSpeechToText extends Instance {
6624
6661
  */
6625
6662
  readonly VoiceDetected: boolean;
6626
6663
  /**
6664
+ * Returns an array of `Wires` that are connected to the specified pin.
6665
+ *
6627
6666
  * - **ThreadSafety**: Unsafe
6628
6667
  *
6629
6668
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetConnectedWires)
6630
- * @param this
6669
+ * @param this Converts spoken audio into text.
6631
6670
  * @param pin
6632
6671
  */
6633
6672
  GetConnectedWires(this: AudioSpeechToText, pin: string): Array<Instance>;
6634
6673
  /**
6674
+ * Fires when another instance is connected to or disconnected from the `AudioSpeechToText` via a `Wire`.
6675
+ *
6635
6676
  * - **ThreadSafety**: Unsafe
6636
6677
  *
6637
6678
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#WiringChanged)
@@ -6827,8 +6868,6 @@ interface AudioTextToSpeech extends Instance {
6827
6868
  /**
6828
6869
  * Creates a trembling effect on a sound by varying the volume of the sound up and down.
6829
6870
  *
6830
- * - **Tags**: NotBrowsable
6831
- *
6832
6871
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo)
6833
6872
  */
6834
6873
  interface AudioTremolo extends Instance {
@@ -18743,7 +18782,7 @@ interface TextBox extends GuiObject {
18743
18782
  readonly ReturnPressedFromOnScreenKeyboard: RBXScriptSignal<() => void>;
18744
18783
  }
18745
18784
  /**
18746
- * - **Tags**: NotBrowsable
18785
+ * A GUI object that displays video content from a connected `VideoPlayer`.
18747
18786
  *
18748
18787
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay)
18749
18788
  */
@@ -18757,12 +18796,16 @@ interface VideoDisplay extends GuiObject {
18757
18796
  */
18758
18797
  readonly _nominal_VideoDisplay: unique symbol;
18759
18798
  /**
18799
+ * Selects the texture resampling mode for the `VideoDisplay`.
18800
+ *
18760
18801
  * - **ThreadSafety**: ReadSafe
18761
18802
  *
18762
18803
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#ResampleMode)
18763
18804
  */
18764
18805
  ResampleMode: Enum.ResamplerMode;
18765
18806
  /**
18807
+ * Determines how a video will scale if displayed in a UI element whose aspect ratio differs from the source video.
18808
+ *
18766
18809
  * - **ThreadSafety**: ReadSafe
18767
18810
  *
18768
18811
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#ScaleType)
@@ -18775,34 +18818,44 @@ interface VideoDisplay extends GuiObject {
18775
18818
  */
18776
18819
  TileSize: UDim2;
18777
18820
  /**
18821
+ * Determines how a rendered video will be colorized.
18822
+ *
18778
18823
  * - **ThreadSafety**: ReadSafe
18779
18824
  *
18780
18825
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoColor3)
18781
18826
  */
18782
18827
  VideoColor3: Color3;
18783
18828
  /**
18829
+ * The offset in pixels of the sub-area of a video to be displayed.
18830
+ *
18784
18831
  * - **ThreadSafety**: ReadSafe
18785
18832
  *
18786
18833
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoRectOffset)
18787
18834
  */
18788
18835
  VideoRectOffset: Vector2;
18789
18836
  /**
18837
+ * Determines the size in pixels of the sub-area of a video to be displayed.
18838
+ *
18790
18839
  * - **ThreadSafety**: ReadSafe
18791
18840
  *
18792
18841
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoRectSize)
18793
18842
  */
18794
18843
  VideoRectSize: Vector2;
18795
18844
  /**
18845
+ * Determines the transparency of the rendered video.
18846
+ *
18796
18847
  * - **ThreadSafety**: ReadSafe
18797
18848
  *
18798
18849
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoTransparency)
18799
18850
  */
18800
18851
  VideoTransparency: number;
18801
18852
  /**
18853
+ * Returns an array of `Wires` that are connected to the specified pin.
18854
+ *
18802
18855
  * - **ThreadSafety**: Unsafe
18803
18856
  *
18804
18857
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetConnectedWires)
18805
- * @param this
18858
+ * @param this A GUI object that displays video content from a connected `VideoPlayer`.
18806
18859
  * @param pin
18807
18860
  */
18808
18861
  GetConnectedWires(this: VideoDisplay, pin: string): Array<Instance>;
@@ -18810,17 +18863,19 @@ interface VideoDisplay extends GuiObject {
18810
18863
  * - **ThreadSafety**: Unsafe
18811
18864
  *
18812
18865
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetInputPins)
18813
- * @param this
18866
+ * @param this A GUI object that displays video content from a connected `VideoPlayer`.
18814
18867
  */
18815
18868
  GetInputPins(this: VideoDisplay): Array<unknown>;
18816
18869
  /**
18817
18870
  * - **ThreadSafety**: Unsafe
18818
18871
  *
18819
18872
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetOutputPins)
18820
- * @param this
18873
+ * @param this A GUI object that displays video content from a connected `VideoPlayer`.
18821
18874
  */
18822
18875
  GetOutputPins(this: VideoDisplay): Array<unknown>;
18823
18876
  /**
18877
+ * Fires when another instance is connected to or disconnected from the `VideoDisplay` via a `Wire`.
18878
+ *
18824
18879
  * - **ThreadSafety**: Unsafe
18825
18880
  *
18826
18881
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#WiringChanged)
@@ -19144,27 +19199,38 @@ interface BillboardGui extends LayerCollector {
19144
19199
  */
19145
19200
  readonly CurrentDistance: number;
19146
19201
  /**
19202
+ * **Deprecated:**
19203
+ *
19147
19204
  * Determines the distance in studs at which the `BillboardGui` will stop scaling larger in size.
19148
19205
  *
19149
19206
  * - **ThreadSafety**: ReadSafe
19207
+ * - **Tags**:
19150
19208
  *
19151
19209
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BillboardGui#DistanceLowerLimit)
19210
+ *
19211
+ * @deprecated
19152
19212
  */
19153
19213
  DistanceLowerLimit: number;
19154
19214
  /**
19155
19215
  * Determines the size `CurrentDistance` increments and decrements in studs as the player's camera moves closer and further from the `BillboardGui`.
19156
19216
  *
19157
19217
  * - **ThreadSafety**: ReadSafe
19218
+ * - **Tags**: NotReplicated
19158
19219
  *
19159
19220
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BillboardGui#DistanceStep)
19160
19221
  */
19161
19222
  DistanceStep: number;
19162
19223
  /**
19224
+ * **Deprecated:**
19225
+ *
19163
19226
  * Determines the distance in studs at which the `BillboardGui` will stop scaling smaller in size.
19164
19227
  *
19165
19228
  * - **ThreadSafety**: ReadSafe
19229
+ * - **Tags**:
19166
19230
  *
19167
19231
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BillboardGui#DistanceUpperLimit)
19232
+ *
19233
+ * @deprecated
19168
19234
  */
19169
19235
  DistanceUpperLimit: number;
19170
19236
  /**
@@ -21323,6 +21389,8 @@ interface HapticEffect extends Instance {
21323
21389
  */
21324
21390
  Stop(this: HapticEffect): void;
21325
21391
  /**
21392
+ * Fires when the `HapticEffect` has completed playback and stopped.
21393
+ *
21326
21394
  * - **ThreadSafety**: Unsafe
21327
21395
  *
21328
21396
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Ended)
@@ -23994,6 +24062,12 @@ interface IncrementalPatchBuilder extends Instance {
23994
24062
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#SerializePatch)
23995
24063
  */
23996
24064
  SerializePatch: boolean;
24065
+ /**
24066
+ * - **ThreadSafety**: ReadSafe
24067
+ *
24068
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#UseFileLevelCompressionInsteadOfChunk)
24069
+ */
24070
+ UseFileLevelCompressionInsteadOfChunk: boolean;
23997
24071
  /**
23998
24072
  * - **ThreadSafety**: ReadSafe
23999
24073
  *
@@ -24525,6 +24599,21 @@ interface InsertService extends Instance {
24525
24599
  */
24526
24600
  readonly InternalDelete: RBXScriptSignal<(instance: Instance) => void>;
24527
24601
  }
24602
+ /**
24603
+ * - **Tags**: NotCreatable, Service
24604
+ *
24605
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceExtensionsService)
24606
+ */
24607
+ interface InstanceExtensionsService extends Instance {
24608
+ /**
24609
+ * **DO NOT USE!**
24610
+ *
24611
+ * This field exists to force TypeScript to recognize this as a nominal type
24612
+ * @hidden
24613
+ * @deprecated
24614
+ */
24615
+ readonly _nominal_InstanceExtensionsService: unique symbol;
24616
+ }
24528
24617
  /**
24529
24618
  * - **Tags**: NotReplicated
24530
24619
  *
@@ -26688,12 +26777,15 @@ interface MarketplaceService extends Instance {
26688
26777
  */
26689
26778
  GetUserSubscriptionStatusAsync(this: MarketplaceService, user: Player, subscriptionId: string): UserSubscriptionStatus;
26690
26779
  /**
26780
+ * Returns the regionalized price level of a user, representing the recommended price for an item in their regional market.
26781
+ *
26691
26782
  * - **ThreadSafety**: Unsafe
26692
26783
  * - **Tags**: Yields
26693
26784
  *
26694
26785
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetUsersPriceLevelsAsync)
26695
26786
  * @param this The service responsible for in-experience transactions.
26696
- * @param userIds
26787
+ * @param userIds An array of user IDs.
26788
+ * @returns Returns an array of `PriceLevelInfo` objects with a dictionary where the keys are user IDs (strings) and their values are the corresponding price levels (integers between 1 and 1000).
26697
26789
  */
26698
26790
  GetUsersPriceLevelsAsync(this: MarketplaceService, userIds: Array<unknown>): Array<unknown>;
26699
26791
  /**
@@ -27440,6 +27532,12 @@ interface ModerationService extends Instance {
27440
27532
  * @deprecated
27441
27533
  */
27442
27534
  readonly _nominal_ModerationService: unique symbol;
27535
+ /**
27536
+ * - **ThreadSafety**: Unsafe
27537
+ *
27538
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentKey)
27539
+ */
27540
+ CreateReviewableContentKey(this: ModerationService, content: Content): string;
27443
27541
  /**
27444
27542
  * - **ThreadSafety**: Unsafe
27445
27543
  * - **Tags**: Yields
@@ -29865,10 +29963,14 @@ interface MeshPart extends TriangleMeshPart {
29865
29963
  */
29866
29964
  get DoubleSided(): boolean;
29867
29965
  /**
29966
+ * **Deprecated:**
29967
+ *
29868
29968
  * - **ThreadSafety**: ReadSafe
29869
29969
  * - **Tags**: Hidden
29870
29970
  *
29871
29971
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MeshPart#HasJointOffset)
29972
+ *
29973
+ * @deprecated
29872
29974
  */
29873
29975
  get HasJointOffset(): boolean;
29874
29976
  /**
@@ -29879,10 +29981,14 @@ interface MeshPart extends TriangleMeshPart {
29879
29981
  */
29880
29982
  get HasSkinnedMesh(): boolean;
29881
29983
  /**
29984
+ * **Deprecated:**
29985
+ *
29882
29986
  * - **ThreadSafety**: ReadSafe
29883
29987
  * - **Tags**: Hidden
29884
29988
  *
29885
29989
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MeshPart#JointOffset)
29990
+ *
29991
+ * @deprecated
29886
29992
  */
29887
29993
  get JointOffset(): Vector3;
29888
29994
  /**
@@ -31550,7 +31656,7 @@ interface Workspace extends WorldRoot {
31550
31656
  readonly PersistentLoaded: RBXScriptSignal<(player: Player) => void>;
31551
31657
  }
31552
31658
  /**
31553
- * Provides some physics features to a `ViewportFrame`.
31659
+ * Extends limited physics for its children on to a parent `ViewportFrame`.
31554
31660
  *
31555
31661
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldModel)
31556
31662
  */
@@ -32014,7 +32120,7 @@ interface ParticleEmitter extends Instance {
32014
32120
  */
32015
32121
  FlipbookIncompatible: string;
32016
32122
  /**
32017
- * Determines the layout of the flipbook texture. Must be None, Grid2x2, Grid4x4, or Grid8x8.
32123
+ * Determines the layout of the flipbook texture. Must be None, Grid2x2, Grid4x4, Grid8x8 or Custom.
32018
32124
  *
32019
32125
  * - **ThreadSafety**: ReadSafe
32020
32126
  *
@@ -32030,12 +32136,16 @@ interface ParticleEmitter extends Instance {
32030
32136
  */
32031
32137
  FlipbookMode: Enum.ParticleFlipbookMode;
32032
32138
  /**
32139
+ * Defines the number of horizontal frames in a custom flipbook layout.
32140
+ *
32033
32141
  * - **ThreadSafety**: ReadSafe
32034
32142
  *
32035
32143
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#FlipbookSizeX)
32036
32144
  */
32037
32145
  FlipbookSizeX: number;
32038
32146
  /**
32147
+ * Defines the number of vertical frames in a custom flipbook layout.
32148
+ *
32039
32149
  * - **ThreadSafety**: ReadSafe
32040
32150
  *
32041
32151
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#FlipbookSizeY)
@@ -34353,7 +34463,7 @@ interface Players extends Instance {
34353
34463
  *
34354
34464
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#PlayerRemoving)
34355
34465
  */
34356
- readonly PlayerRemoving: RBXScriptSignal<(player: Player) => void>;
34466
+ readonly PlayerRemoving: RBXScriptSignal<(player: Player, reason: Enum.PlayerExitReason) => void>;
34357
34467
  /**
34358
34468
  * Fires when the game server recognizes that the user's status for a certain subscription has changed.
34359
34469
  *
@@ -35760,6 +35870,13 @@ interface RunService extends Instance {
35760
35870
  * @deprecated
35761
35871
  */
35762
35872
  readonly _nominal_RunService: unique symbol;
35873
+ /**
35874
+ * - **ThreadSafety**: ReadSafe
35875
+ * - **Tags**: NotReplicated
35876
+ *
35877
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#PredictionState)
35878
+ */
35879
+ readonly PredictionState: Enum.PredictionState;
35763
35880
  /**
35764
35881
  * - **ThreadSafety**: ReadSafe
35765
35882
  * - **Tags**: NotReplicated
@@ -35853,6 +35970,12 @@ interface RunService extends Instance {
35853
35970
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#Heartbeat)
35854
35971
  */
35855
35972
  readonly Heartbeat: RBXScriptSignal<(deltaTime: number) => void>;
35973
+ /**
35974
+ * - **ThreadSafety**: Unsafe
35975
+ *
35976
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#Misprediction)
35977
+ */
35978
+ readonly Misprediction: RBXScriptSignal<(remoteWorldStepId: number, mispredictedInstances: Array<unknown>) => void>;
35856
35979
  /**
35857
35980
  * Fires every frame, after the physics simulation has completed.
35858
35981
  *
@@ -35902,6 +36025,39 @@ interface RunService extends Instance {
35902
36025
  */
35903
36026
  readonly Stepped: RBXScriptSignal<(time: number, deltaTime: number) => void>;
35904
36027
  }
36028
+ /**
36029
+ * - **Tags**: NotCreatable, Service
36030
+ *
36031
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService)
36032
+ */
36033
+ interface RuntimeContentService extends Instance {
36034
+ /**
36035
+ * **DO NOT USE!**
36036
+ *
36037
+ * This field exists to force TypeScript to recognize this as a nominal type
36038
+ * @hidden
36039
+ * @deprecated
36040
+ */
36041
+ readonly _nominal_RuntimeContentService: unique symbol;
36042
+ /**
36043
+ * - **ThreadSafety**: Unsafe
36044
+ *
36045
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentFail)
36046
+ */
36047
+ readonly RuntimeContentFail: RBXScriptSignal<(id: string) => void>;
36048
+ /**
36049
+ * - **ThreadSafety**: Unsafe
36050
+ *
36051
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentQuery)
36052
+ */
36053
+ readonly RuntimeContentQuery: RBXScriptSignal<(id: string, content: string) => void>;
36054
+ /**
36055
+ * - **ThreadSafety**: Unsafe
36056
+ *
36057
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentShare)
36058
+ */
36059
+ readonly RuntimeContentShare: RBXScriptSignal<(id: string, content: string) => void>;
36060
+ }
35905
36061
  /**
35906
36062
  * - **Tags**: NotCreatable, Service
35907
36063
  *
@@ -37381,14 +37537,29 @@ interface SocialService extends Instance {
37381
37537
  * @returns An array of dictionaries representing the members of the specified party who are currently in the experience.
37382
37538
  */
37383
37539
  GetPartyAsync(this: SocialService, partyId: string): Array<unknown>;
37540
+ /**
37541
+ * Prompts the player to submit feedback about the current experience.
37542
+ *
37543
+ * - **ThreadSafety**: Unsafe
37544
+ * - **Tags**: Yields
37545
+ *
37546
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptFeedbackSubmissionAsync)
37547
+ * @param this Facilitates social functions that impact relationships made on the Roblox platform.
37548
+ */
37549
+ PromptFeedbackSubmissionAsync(this: SocialService): void;
37384
37550
  /**
37385
37551
  * - **ThreadSafety**: Unsafe
37386
37552
  * - **Tags**: Yields
37387
37553
  *
37388
37554
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharing)
37389
37555
  * @param this Facilitates social functions that impact relationships made on the Roblox platform.
37390
- * @param player
37391
- * @param options
37556
+ * @param player Prompts the given `Player` with a Roblox platform-level share sheet with a generated share link.
37557
+ * @param options `Dictionary` that specifies the configuration for the generated link. It includes the following optional key-value pairs: - `FallbackLinkId` (string). Determines how this share link will direct player to once expired. Default to experience join link.
37558
+ * - `ExpirationSeconds` (number). Determines time to expiration once the share link is created. Truncates to nearest integer. Defaults to 86,400.
37559
+ * - `PreviewTitle` (string) Preview title of the share link.
37560
+ * - `PreiviewDescription` (string) Preview description of the share link.
37561
+ * - `PreviewAssettId` (number) Image asset ID used for share link preview.
37562
+ * - `LaunchData` (string). Used to set a parameter in `Player:GetJoinData()` when a player joined using the generated share link.
37392
37563
  */
37393
37564
  PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
37394
37565
  /**
@@ -39502,6 +39673,46 @@ interface StyleLink extends Instance {
39502
39673
  */
39503
39674
  StyleSheet: StyleSheet | undefined;
39504
39675
  }
39676
+ /**
39677
+ * - **Tags**: NotReplicated, NotBrowsable
39678
+ *
39679
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery)
39680
+ */
39681
+ interface StyleQuery extends Instance {
39682
+ /**
39683
+ * **DO NOT USE!**
39684
+ *
39685
+ * This field exists to force TypeScript to recognize this as a nominal type
39686
+ * @hidden
39687
+ * @deprecated
39688
+ */
39689
+ readonly _nominal_StyleQuery: unique symbol;
39690
+ /**
39691
+ * - **ThreadSafety**: ReadSafe
39692
+ *
39693
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#AspectRatioRange)
39694
+ */
39695
+ AspectRatioRange: NumberRange;
39696
+ /**
39697
+ * - **ThreadSafety**: ReadSafe
39698
+ * - **Tags**: NotReplicated
39699
+ *
39700
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#IsActive)
39701
+ */
39702
+ readonly IsActive: boolean;
39703
+ /**
39704
+ * - **ThreadSafety**: ReadSafe
39705
+ *
39706
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#MaxSize)
39707
+ */
39708
+ MaxSize: Vector2;
39709
+ /**
39710
+ * - **ThreadSafety**: ReadSafe
39711
+ *
39712
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#MinSize)
39713
+ */
39714
+ MinSize: Vector2;
39715
+ }
39505
39716
  /**
39506
39717
  * - **Tags**: NotCreatable, Service, NotReplicated
39507
39718
  *
@@ -42448,19 +42659,19 @@ interface TweenService extends Instance {
42448
42659
  */
42449
42660
  GetValue(this: TweenService, alpha: number, easingStyle: CastsToEnum<Enum.EasingStyle>, easingDirection: CastsToEnum<Enum.EasingDirection>): number;
42450
42661
  /**
42451
- * Calculates a value simulating a critically damped spring.
42662
+ * Smoothly interpolates a value towards a target, simulating a critically damped spring.
42452
42663
  *
42453
42664
  * - **ThreadSafety**: Safe
42454
42665
  *
42455
42666
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TweenService#SmoothDamp)
42456
42667
  * @param this Used to create `Tweens` which interpolate, or tween, the properties of instances.
42457
- * @param current The current position.
42458
- * @param target The target position.
42459
- * @param velocity The initial velocity at which the current position should approach the target position.
42460
- * @param smoothTime The duration in which the total smoothing operation should take place.
42461
- * @param maxSpeed The maximum speed at which the current position should approach the target position.
42462
- * @param dt The rate at which the smoothing operation should be applied.
42463
- * @returns The new position and velocity calculated from the smoothing operation.
42668
+ * @param current The current value to smooth.
42669
+ * @param target The target value to reach.
42670
+ * @param velocity The current velocity with which the current value should approach the target value. You shouldn't modify this value between calls yourself, it's used to store the stateful velocity. In most cases, initialize this with `0`, `zero`, `zero`, or `identity` depending on the type, or if needed, with your initial velocity.
42671
+ * @param smoothTime The duration over which the total smoothing operation should take place. Note that since this is a damped spring, there's no guarantee `current` will be exactly `target` after this time, but it will be close. Smaller values result in quicker smoothing.
42672
+ * @param maxSpeed The maximum speed at which the current value should approach the target value. Leaving this nil defaults to `huge`, meaning the velocity isn't clamped.
42673
+ * @param dt The rate at which the smoothing operation should be applied. If left nil, the current engine delta time will be used.
42674
+ * @returns The new value and new velocity calculated from the smoothing operation.
42464
42675
  */
42465
42676
  SmoothDamp<T extends number | Vector2 | Vector3 | CFrame>(this: TweenService, current: T, target: T, velocity: T, smoothTime: number, maxSpeed?: number, dt?: number): LuaTuple<[
42466
42677
  T,
@@ -42634,46 +42845,6 @@ interface UITextSizeConstraint extends UIConstraint {
42634
42845
  */
42635
42846
  MinTextSize: number;
42636
42847
  }
42637
- /**
42638
- * - **Tags**: NotReplicated, NotBrowsable
42639
- *
42640
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery)
42641
- */
42642
- interface UIContainerQuery extends UIComponent {
42643
- /**
42644
- * **DO NOT USE!**
42645
- *
42646
- * This field exists to force TypeScript to recognize this as a nominal type
42647
- * @hidden
42648
- * @deprecated
42649
- */
42650
- readonly _nominal_UIContainerQuery: unique symbol;
42651
- /**
42652
- * - **ThreadSafety**: ReadSafe
42653
- *
42654
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#AspectRatioRange)
42655
- */
42656
- AspectRatioRange: NumberRange;
42657
- /**
42658
- * - **ThreadSafety**: ReadSafe
42659
- * - **Tags**: NotReplicated
42660
- *
42661
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#IsActive)
42662
- */
42663
- readonly IsActive: boolean;
42664
- /**
42665
- * - **ThreadSafety**: ReadSafe
42666
- *
42667
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#MaxSize)
42668
- */
42669
- MaxSize: Vector2;
42670
- /**
42671
- * - **ThreadSafety**: ReadSafe
42672
- *
42673
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#MinSize)
42674
- */
42675
- MinSize: Vector2;
42676
- }
42677
42848
  /**
42678
42849
  * UI modifier which applies deformation to corners of its parent `GuiObject`.
42679
42850
  *
@@ -43581,12 +43752,16 @@ interface UIStroke extends UIComponent {
43581
43752
  */
43582
43753
  ApplyStrokeMode: Enum.ApplyStrokeMode;
43583
43754
  /**
43755
+ * Specifies an additional offset to the stroke's position, relative to the parent's minimum height or width.
43756
+ *
43584
43757
  * - **ThreadSafety**: ReadSafe
43585
43758
  *
43586
43759
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIStroke#BorderOffset)
43587
43760
  */
43588
43761
  BorderOffset: UDim;
43589
43762
  /**
43763
+ * Determines the stroke's position on its parent's border.
43764
+ *
43590
43765
  * - **ThreadSafety**: ReadSafe
43591
43766
  *
43592
43767
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIStroke#BorderStrokePosition)
@@ -43617,6 +43792,8 @@ interface UIStroke extends UIComponent {
43617
43792
  */
43618
43793
  LineJoinMode: Enum.LineJoinMode;
43619
43794
  /**
43795
+ * Determines whether the stroke's `Thickness` will be measured in pixels or be relative to the parent.
43796
+ *
43620
43797
  * - **ThreadSafety**: ReadSafe
43621
43798
  *
43622
43799
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIStroke#StrokeSizingMode)
@@ -43639,6 +43816,8 @@ interface UIStroke extends UIComponent {
43639
43816
  */
43640
43817
  Transparency: number;
43641
43818
  /**
43819
+ * Determines the order in which the stroke renders relative to sibling `UIStroke` instances.
43820
+ *
43642
43821
  * - **ThreadSafety**: ReadSafe
43643
43822
  *
43644
43823
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIStroke#ZIndex)
@@ -45335,7 +45514,7 @@ interface VideoDeviceInput extends Instance {
45335
45514
  readonly IsReady: boolean;
45336
45515
  }
45337
45516
  /**
45338
- * - **Tags**: NotBrowsable
45517
+ * Used to play video assets.
45339
45518
  *
45340
45519
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer)
45341
45520
  */
@@ -45349,6 +45528,8 @@ interface VideoPlayer extends Instance {
45349
45528
  */
45350
45529
  readonly _nominal_VideoPlayer: unique symbol;
45351
45530
  /**
45531
+ * Indicates when the `VideoContent` has loaded and is ready to play.
45532
+ *
45352
45533
  * - **ThreadSafety**: ReadSafe
45353
45534
  * - **Tags**: NotReplicated
45354
45535
  *
@@ -45356,6 +45537,8 @@ interface VideoPlayer extends Instance {
45356
45537
  */
45357
45538
  readonly IsLoaded: boolean;
45358
45539
  /**
45540
+ * Denotes whether this `VideoPlayer` is currently playing.
45541
+ *
45359
45542
  * - **ThreadSafety**: ReadSafe
45360
45543
  * - **Tags**: NotReplicated
45361
45544
  *
@@ -45363,18 +45546,24 @@ interface VideoPlayer extends Instance {
45363
45546
  */
45364
45547
  readonly IsPlaying: boolean;
45365
45548
  /**
45549
+ * Controls whether this `VideoPlayer` loops.
45550
+ *
45366
45551
  * - **ThreadSafety**: ReadSafe
45367
45552
  *
45368
45553
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Looping)
45369
45554
  */
45370
45555
  Looping: boolean;
45371
45556
  /**
45557
+ * Controls the speed at which the video is played.
45558
+ *
45372
45559
  * - **ThreadSafety**: ReadSafe
45373
45560
  *
45374
45561
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#PlaybackSpeed)
45375
45562
  */
45376
45563
  PlaybackSpeed: number;
45377
45564
  /**
45565
+ * Gets the original source resolution of the `VideoContent` file.
45566
+ *
45378
45567
  * - **ThreadSafety**: ReadSafe
45379
45568
  * - **Tags**: NotReplicated
45380
45569
  *
@@ -45382,6 +45571,8 @@ interface VideoPlayer extends Instance {
45382
45571
  */
45383
45572
  readonly Resolution: Vector2;
45384
45573
  /**
45574
+ * Indicates the length of the `VideoContent` in seconds.
45575
+ *
45385
45576
  * - **ThreadSafety**: ReadSafe
45386
45577
  * - **Tags**: NotReplicated
45387
45578
  *
@@ -45389,28 +45580,36 @@ interface VideoPlayer extends Instance {
45389
45580
  */
45390
45581
  readonly TimeLength: number;
45391
45582
  /**
45583
+ * Indicates the progress in seconds of the `VideoContent`.
45584
+ *
45392
45585
  * - **ThreadSafety**: ReadSafe
45393
45586
  *
45394
45587
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#TimePosition)
45395
45588
  */
45396
45589
  TimePosition: number;
45397
45590
  /**
45591
+ * The asset to be loaded into the `VideoPlayer`.
45592
+ *
45398
45593
  * - **ThreadSafety**: ReadSafe
45399
45594
  *
45400
45595
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#VideoContent)
45401
45596
  */
45402
45597
  VideoContent: Content;
45403
45598
  /**
45599
+ * Controls how loudly the audio track will be played.
45600
+ *
45404
45601
  * - **ThreadSafety**: ReadSafe
45405
45602
  *
45406
45603
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Volume)
45407
45604
  */
45408
45605
  Volume: number;
45409
45606
  /**
45607
+ * Returns an array of `Wires` that are connected to the specified pin.
45608
+ *
45410
45609
  * - **ThreadSafety**: Unsafe
45411
45610
  *
45412
45611
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetConnectedWires)
45413
- * @param this
45612
+ * @param this Used to play video assets.
45414
45613
  * @param pin
45415
45614
  */
45416
45615
  GetConnectedWires(this: VideoPlayer, pin: string): Array<Instance>;
@@ -45418,52 +45617,64 @@ interface VideoPlayer extends Instance {
45418
45617
  * - **ThreadSafety**: Unsafe
45419
45618
  *
45420
45619
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetInputPins)
45421
- * @param this
45620
+ * @param this Used to play video assets.
45422
45621
  */
45423
45622
  GetInputPins(this: VideoPlayer): Array<unknown>;
45424
45623
  /**
45425
45624
  * - **ThreadSafety**: Unsafe
45426
45625
  *
45427
45626
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetOutputPins)
45428
- * @param this
45627
+ * @param this Used to play video assets.
45429
45628
  */
45430
45629
  GetOutputPins(this: VideoPlayer): Array<unknown>;
45431
45630
  /**
45631
+ * Pauses the `VideoPlayer` wherever its `TimePosition` is.
45632
+ *
45432
45633
  * - **ThreadSafety**: Unsafe
45433
45634
  *
45434
45635
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Pause)
45435
- * @param this
45636
+ * @param this Used to play video assets.
45436
45637
  */
45437
45638
  Pause(this: VideoPlayer): void;
45438
45639
  /**
45640
+ * Plays the `VideoPlayer` from wherever its `TimePosition` is.
45641
+ *
45439
45642
  * - **ThreadSafety**: Unsafe
45440
45643
  *
45441
45644
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Play)
45442
- * @param this
45645
+ * @param this Used to play video assets.
45443
45646
  */
45444
45647
  Play(this: VideoPlayer): void;
45445
45648
  /**
45649
+ * Unloads the `VideoPlayer.VideoContent` to save resources.
45650
+ *
45446
45651
  * - **ThreadSafety**: Unsafe
45447
45652
  *
45448
45653
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Unload)
45449
- * @param this
45654
+ * @param this Used to play video assets.
45450
45655
  */
45451
45656
  Unload(this: VideoPlayer): void;
45452
45657
  /**
45658
+ * Loads the `VideoContent` before it is played.
45659
+ *
45453
45660
  * - **ThreadSafety**: Unsafe
45454
45661
  * - **Tags**: Yields
45455
45662
  *
45456
45663
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#LoadAsync)
45457
- * @param this
45664
+ * @param this Used to play video assets.
45458
45665
  */
45459
45666
  LoadAsync(this: VideoPlayer): Enum.AssetFetchStatus;
45460
45667
  /**
45668
+ * Fires when the `VideoContent` has completed playback and stopped.
45669
+ *
45461
45670
  * - **ThreadSafety**: Unsafe
45462
45671
  *
45463
45672
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#DidEnd)
45464
45673
  */
45465
45674
  readonly DidEnd: RBXScriptSignal<() => void>;
45466
45675
  /**
45676
+ * Fires when the `VideoContent` loops.
45677
+ *
45467
45678
  * - **ThreadSafety**: Unsafe
45468
45679
  *
45469
45680
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#DidLoop)
@@ -45476,6 +45687,8 @@ interface VideoPlayer extends Instance {
45476
45687
  */
45477
45688
  readonly PlayFailed: RBXScriptSignal<(error: Enum.AssetFetchStatus) => void>;
45478
45689
  /**
45690
+ * Fires when another instance is connected to or disconnected from the `VideoPlayer` via a `Wire`.
45691
+ *
45479
45692
  * - **ThreadSafety**: Unsafe
45480
45693
  *
45481
45694
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#WiringChanged)
@@ -45964,6 +46177,8 @@ interface Wire extends Instance {
45964
46177
  TargetName: string;
45965
46178
  }
45966
46179
  /**
46180
+ * `WrapTextureTransfer` allows a parent `Decal` to be wrapped around its parent `MeshPart` based on the cage of its `WrapTarget`.
46181
+ *
45967
46182
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer)
45968
46183
  */
45969
46184
  interface WrapTextureTransfer extends Instance {
@@ -45976,18 +46191,24 @@ interface WrapTextureTransfer extends Instance {
45976
46191
  */
45977
46192
  readonly _nominal_WrapTextureTransfer: unique symbol;
45978
46193
  /**
46194
+ * An optional reference mesh used for pruning and validating the target cage.
46195
+ *
45979
46196
  * - **ThreadSafety**: ReadSafe
45980
46197
  *
45981
46198
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#ReferenceCageMeshContent)
45982
46199
  */
45983
46200
  ReferenceCageMeshContent: Content;
45984
46201
  /**
46202
+ * Determines the maximum bound of the UV space to include in the transfer.
46203
+ *
45985
46204
  * - **ThreadSafety**: ReadSafe
45986
46205
  *
45987
46206
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#UVMaxBound)
45988
46207
  */
45989
46208
  UVMaxBound: Vector2;
45990
46209
  /**
46210
+ * Determines the minimum bound of the UV space to include in the transfer.
46211
+ *
45991
46212
  * - **ThreadSafety**: ReadSafe
45992
46213
  *
45993
46214
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#UVMinBound)