@rbxts/types 1.0.839 → 1.0.840

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.
@@ -249,7 +249,6 @@ interface CreatableInstances {
249
249
  AudioPlayer: AudioPlayer;
250
250
  AudioReverb: AudioReverb;
251
251
  AudioSearchParams: AudioSearchParams;
252
- AudioTextToSpeech: AudioTextToSpeech;
253
252
  AuroraScript: AuroraScript;
254
253
  Backpack: Backpack;
255
254
  BallSocketConstraint: BallSocketConstraint;
@@ -2856,7 +2855,7 @@ interface AnimationTrack extends Instance {
2856
2855
  */
2857
2856
  Play(this: AnimationTrack, fadeTime?: number, weight?: number, speed?: number): void;
2858
2857
  /**
2859
- * Stops the `AnimationTrack`. Once called playback of the `AnimationTrack` will stop and the weight of the animation will move towards zero over a length of time specified by the optional fadeTime parameter.
2858
+ * Stops the `AnimationTrack`.
2860
2859
  *
2861
2860
  * - **ThreadSafety**: Unsafe
2862
2861
  * - **Tags**: CustomLuaState
@@ -3026,12 +3025,6 @@ interface AnnotationsService extends Instance {
3026
3025
  * @deprecated
3027
3026
  */
3028
3027
  readonly _nominal_AnnotationsService: unique symbol;
3029
- /**
3030
- * - **ThreadSafety**: Unsafe
3031
- *
3032
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnnotationsService#DEPRECATED_EditAnnotation)
3033
- */
3034
- DEPRECATED_EditAnnotation(this: AnnotationsService, uniqueId: string, contents: string): void;
3035
3028
  }
3036
3029
  /**
3037
3030
  * - **Tags**: NotCreatable, Service, NotReplicated
@@ -5622,19 +5615,6 @@ interface AudioSearchParams extends Instance {
5622
5615
  */
5623
5616
  Title: string;
5624
5617
  }
5625
- /**
5626
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
5627
- */
5628
- interface AudioTextToSpeech extends Instance {
5629
- /**
5630
- * **DO NOT USE!**
5631
- *
5632
- * This field exists to force TypeScript to recognize this as a nominal type
5633
- * @hidden
5634
- * @deprecated
5635
- */
5636
- readonly _nominal_AudioTextToSpeech: unique symbol;
5637
- }
5638
5618
  /**
5639
5619
  * - **Tags**: NotCreatable, Service
5640
5620
  *
@@ -5765,6 +5745,12 @@ interface AuroraService extends Instance {
5765
5745
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#SetIncomingReplicationLag)
5766
5746
  */
5767
5747
  SetIncomingReplicationLag(this: AuroraService, seconds: number): void;
5748
+ /**
5749
+ * - **ThreadSafety**: Unsafe
5750
+ *
5751
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#SetPropertyIsInput)
5752
+ */
5753
+ SetPropertyIsInput(this: AuroraService, target: Instance, propertyName: string, isInput: boolean): void;
5768
5754
  /**
5769
5755
  * - **ThreadSafety**: Unsafe
5770
5756
  *
@@ -5921,6 +5907,13 @@ interface AvatarCreationService extends Instance {
5921
5907
  * @param generationId
5922
5908
  */
5923
5909
  LoadGeneratedAvatarAsync(this: AvatarCreationService, generationId: string): HumanoidDescription;
5910
+ /**
5911
+ * - **ThreadSafety**: Unsafe
5912
+ * - **Tags**: Yields
5913
+ *
5914
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PrepareAvatarForPreviewAsync)
5915
+ */
5916
+ PrepareAvatarForPreviewAsync(this: AvatarCreationService, humanoidModel: Model): void;
5924
5917
  /**
5925
5918
  * Prompts a `Player` to purchase and create an avatar from a `HumanoidDescription`.
5926
5919
  *
@@ -5995,6 +5988,12 @@ interface AvatarCreationService extends Instance {
5995
5988
  * - An optional table of strings. This includes failure reasons if validation was unsuccessful; otherwise `nil` if validation was successful.
5996
5989
  */
5997
5990
  ValidateUGCFullBodyAsync(this: AvatarCreationService, player: Player, humanoidDescription: HumanoidDescription): unknown;
5991
+ /**
5992
+ * - **ThreadSafety**: Unsafe
5993
+ *
5994
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AvatarModerationCompleted)
5995
+ */
5996
+ readonly AvatarModerationCompleted: RBXScriptSignal<(outfitId: number, moderationStatus: Enum.ModerationStatus) => void>;
5998
5997
  }
5999
5998
  /**
6000
5999
  * A service to support developer Avatar Editors.
@@ -9623,6 +9622,13 @@ interface DragDetector extends ClickDetector {
9623
9622
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragStartReplicate)
9624
9623
  */
9625
9624
  readonly DragStartReplicate: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
9625
+ /**
9626
+ * - **ThreadSafety**: Unsafe
9627
+ * - **Tags**: Hidden
9628
+ *
9629
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#RestartPhysicalDragReplicate)
9630
+ */
9631
+ readonly RestartPhysicalDragReplicate: RBXScriptSignal<(hitPoint: Vector3) => void>;
9626
9632
  }
9627
9633
  /**
9628
9634
  * - **Tags**: NotCreatable, Service, NotReplicated
@@ -24747,7 +24753,7 @@ interface MarketplaceService extends Instance {
24747
24753
  * - `PlaceIdWherePurchased` — The place ID in which the purchase was made. Depending on where the user is during gameplay, the purchase place's ID can be the same as or different from the current place's ID.
24748
24754
  * - `CurrencySpent` — The amount of currency spent in the transaction.
24749
24755
  * - `CurrencyType` — The type of currency spent in the purchase; always `CurrencyType.Robux`.
24750
- * - `ProductPurchaseChannel` — An enum that represents how the user acquired the developer product.
24756
+ * - `ProductPurchaseChannel` — How the user acquired the developer product. One of `ProductPurchaseChannel`.
24751
24757
  *
24752
24758
  *
24753
24759
  * @returns An enum that represents how the developer product receipt was processed. - `PurchaseGranted`:
@@ -30953,15 +30959,12 @@ interface PlayerData extends Instance {
30953
30959
  * - **ThreadSafety**: Unsafe
30954
30960
  *
30955
30961
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerData#GetPlayer)
30956
- * @param this
30957
30962
  */
30958
30963
  GetPlayer(this: PlayerData): Player;
30959
30964
  /**
30960
30965
  * - **ThreadSafety**: Unsafe
30961
30966
  *
30962
30967
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerData#GetRecord)
30963
- * @param this
30964
- * @param recordName
30965
30968
  */
30966
30969
  GetRecord(this: PlayerData, recordName?: string): PlayerDataRecord;
30967
30970
  }
@@ -31060,47 +31063,36 @@ interface PlayerDataRecord extends Instance {
31060
31063
  * - **ThreadSafety**: Unsafe
31061
31064
  *
31062
31065
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#GetPlayer)
31063
- * @param this
31064
31066
  */
31065
31067
  GetPlayer(this: PlayerDataRecord): Player;
31066
31068
  /**
31067
31069
  * - **ThreadSafety**: Unsafe
31068
31070
  *
31069
31071
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#GetValue)
31070
- * @param this
31071
- * @param key
31072
31072
  */
31073
31073
  GetValue(this: PlayerDataRecord, key: string): unknown;
31074
31074
  /**
31075
31075
  * - **ThreadSafety**: Unsafe
31076
31076
  *
31077
31077
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#GetValueChangedSignal)
31078
- * @param this
31079
- * @param key
31080
31078
  */
31081
31079
  GetValueChangedSignal(this: PlayerDataRecord, key: string): RBXScriptSignal;
31082
31080
  /**
31083
31081
  * - **ThreadSafety**: Unsafe
31084
31082
  *
31085
31083
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#Release)
31086
- * @param this
31087
31084
  */
31088
31085
  Release(this: PlayerDataRecord): void;
31089
31086
  /**
31090
31087
  * - **ThreadSafety**: Unsafe
31091
31088
  *
31092
31089
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#RemoveValue)
31093
- * @param this
31094
- * @param key
31095
31090
  */
31096
31091
  RemoveValue(this: PlayerDataRecord, key: string): void;
31097
31092
  /**
31098
31093
  * - **ThreadSafety**: Unsafe
31099
31094
  *
31100
31095
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#SetValue)
31101
- * @param this
31102
- * @param key
31103
- * @param value
31104
31096
  */
31105
31097
  SetValue(this: PlayerDataRecord, key: string, value: unknown): void;
31106
31098
  /**
@@ -31108,7 +31100,6 @@ interface PlayerDataRecord extends Instance {
31108
31100
  * - **Tags**: Yields
31109
31101
  *
31110
31102
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#RequestFlushAsync)
31111
- * @param this
31112
31103
  */
31113
31104
  RequestFlushAsync(this: PlayerDataRecord): void;
31114
31105
  /**
@@ -31116,7 +31107,6 @@ interface PlayerDataRecord extends Instance {
31116
31107
  * - **Tags**: Yields
31117
31108
  *
31118
31109
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#WaitForLoadAsync)
31119
- * @param this
31120
31110
  */
31121
31111
  WaitForLoadAsync(this: PlayerDataRecord): void;
31122
31112
  /**
@@ -31163,17 +31153,12 @@ interface PlayerDataRecordConfig extends Instance {
31163
31153
  * - **ThreadSafety**: Unsafe
31164
31154
  *
31165
31155
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecordConfig#GetDefaultValue)
31166
- * @param this
31167
- * @param key
31168
31156
  */
31169
31157
  GetDefaultValue(this: PlayerDataRecordConfig, key: string): unknown;
31170
31158
  /**
31171
31159
  * - **ThreadSafety**: Unsafe
31172
31160
  *
31173
31161
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecordConfig#SetDefaultValue)
31174
- * @param this
31175
- * @param key
31176
- * @param value
31177
31162
  */
31178
31163
  SetDefaultValue(this: PlayerDataRecordConfig, key: string, value: unknown): void;
31179
31164
  }
@@ -31201,8 +31186,6 @@ interface PlayerDataService extends Instance {
31201
31186
  * - **ThreadSafety**: Unsafe
31202
31187
  *
31203
31188
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataService#GetRecordConfig)
31204
- * @param this
31205
- * @param recordName
31206
31189
  */
31207
31190
  GetRecordConfig(this: PlayerDataService, recordName?: string): PlayerDataRecordConfig;
31208
31191
  }
@@ -267,7 +267,6 @@ interface CreatableInstances {
267
267
  AudioPlayer: AudioPlayer;
268
268
  AudioReverb: AudioReverb;
269
269
  AudioSearchParams: AudioSearchParams;
270
- AudioTextToSpeech: AudioTextToSpeech;
271
270
  AuroraScript: AuroraScript;
272
271
  Backpack: Backpack;
273
272
  BallSocketConstraint: BallSocketConstraint;
@@ -1761,19 +1760,6 @@ interface AudioSearchParams extends Instance {
1761
1760
  */
1762
1761
  readonly _nominal_AudioSearchParams: unique symbol;
1763
1762
  }
1764
- /**
1765
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
1766
- */
1767
- interface AudioTextToSpeech extends Instance {
1768
- /**
1769
- * **DO NOT USE!**
1770
- *
1771
- * This field exists to force TypeScript to recognize this as a nominal type
1772
- * @hidden
1773
- * @deprecated
1774
- */
1775
- readonly _nominal_AudioTextToSpeech: unique symbol;
1776
- }
1777
1763
  /**
1778
1764
  * - **Tags**: NotCreatable, Service
1779
1765
  *
@@ -7781,6 +7781,8 @@ declare namespace Enum {
7781
7781
  }
7782
7782
  export const EmotesMenu: EmotesMenu;
7783
7783
  /**
7784
+ * A player's perspective or view of their own character.
7785
+ *
7784
7786
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#SelfView)
7785
7787
  */
7786
7788
  export interface SelfView extends globalThis.EnumItem {
@@ -14300,7 +14302,7 @@ declare namespace Enum {
14300
14302
  }
14301
14303
  export type JointCreationMode = JointCreationMode.All | JointCreationMode.Surface | JointCreationMode.None;
14302
14304
  /**
14303
- * A physical button that a user is pressing.
14305
+ * Byte keycodes that represent the key or button involved in user input.
14304
14306
  *
14305
14307
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode)
14306
14308
  */
@@ -14350,7 +14352,7 @@ declare namespace Enum {
14350
14352
  }
14351
14353
  export const Clear: Clear;
14352
14354
  /**
14353
- * Better known as enter.
14355
+ * Frequently known as **Enter**.
14354
14356
  *
14355
14357
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#Return)
14356
14358
  */
@@ -16902,7 +16904,7 @@ declare namespace Enum {
16902
16904
  }
16903
16905
  export const Undo: Undo;
16904
16906
  /**
16905
- * Gamepad X button.
16907
+ * Gamepad `X` button.
16906
16908
  *
16907
16909
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonX)
16908
16910
  */
@@ -16913,7 +16915,7 @@ declare namespace Enum {
16913
16915
  }
16914
16916
  export const ButtonX: ButtonX;
16915
16917
  /**
16916
- * Gamepad Y button.
16918
+ * Gamepad `Y` button.
16917
16919
  *
16918
16920
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonY)
16919
16921
  */
@@ -16924,7 +16926,7 @@ declare namespace Enum {
16924
16926
  }
16925
16927
  export const ButtonY: ButtonY;
16926
16928
  /**
16927
- * Gamepad A button.
16929
+ * Gamepad `A` button.
16928
16930
  *
16929
16931
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonA)
16930
16932
  */
@@ -16935,7 +16937,7 @@ declare namespace Enum {
16935
16937
  }
16936
16938
  export const ButtonA: ButtonA;
16937
16939
  /**
16938
- * Gamepad B button.
16940
+ * Gamepad `B` button.
16939
16941
  *
16940
16942
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonB)
16941
16943
  */
@@ -16946,7 +16948,7 @@ declare namespace Enum {
16946
16948
  }
16947
16949
  export const ButtonB: ButtonB;
16948
16950
  /**
16949
- * Gamepad R1 button.
16951
+ * Gamepad `R1` button.
16950
16952
  *
16951
16953
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonR1)
16952
16954
  */
@@ -16957,7 +16959,7 @@ declare namespace Enum {
16957
16959
  }
16958
16960
  export const ButtonR1: ButtonR1;
16959
16961
  /**
16960
- * Gamepad L1 button.
16962
+ * Gamepad `L1` button.
16961
16963
  *
16962
16964
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonL1)
16963
16965
  */
@@ -16968,7 +16970,7 @@ declare namespace Enum {
16968
16970
  }
16969
16971
  export const ButtonL1: ButtonL1;
16970
16972
  /**
16971
- * Gamepad R2 button.
16973
+ * Gamepad `R2` button.
16972
16974
  *
16973
16975
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonR2)
16974
16976
  */
@@ -16979,7 +16981,7 @@ declare namespace Enum {
16979
16981
  }
16980
16982
  export const ButtonR2: ButtonR2;
16981
16983
  /**
16982
- * Gamepad L2 button.
16984
+ * Gamepad `L2` button.
16983
16985
  *
16984
16986
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonL2)
16985
16987
  */
@@ -16990,7 +16992,7 @@ declare namespace Enum {
16990
16992
  }
16991
16993
  export const ButtonL2: ButtonL2;
16992
16994
  /**
16993
- * Gamepad R3 button.
16995
+ * Gamepad `R3` button.
16994
16996
  *
16995
16997
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonR3)
16996
16998
  */
@@ -17001,7 +17003,7 @@ declare namespace Enum {
17001
17003
  }
17002
17004
  export const ButtonR3: ButtonR3;
17003
17005
  /**
17004
- * Gamepad L3 button.
17006
+ * Gamepad `L3` button.
17005
17007
  *
17006
17008
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonL3)
17007
17009
  */
@@ -17012,7 +17014,7 @@ declare namespace Enum {
17012
17014
  }
17013
17015
  export const ButtonL3: ButtonL3;
17014
17016
  /**
17015
- * Gamepad Start button.
17017
+ * Gamepad `Start` button.
17016
17018
  *
17017
17019
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonStart)
17018
17020
  */
@@ -17023,7 +17025,7 @@ declare namespace Enum {
17023
17025
  }
17024
17026
  export const ButtonStart: ButtonStart;
17025
17027
  /**
17026
- * Gamepad Select button.
17028
+ * Gamepad `Select` button.
17027
17029
  *
17028
17030
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonSelect)
17029
17031
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.839",
3
+ "version": "1.0.840",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },