@rbxts/types 1.0.859 → 1.0.861

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.
@@ -114,9 +114,10 @@ interface Services {
114
114
  MessageBusService: MessageBusService;
115
115
  MessagingService: MessagingService;
116
116
  MetaBreakpointManager: MetaBreakpointManager;
117
+ MicroProfilerService: MicroProfilerService;
117
118
  MLModelDeliveryService: MLModelDeliveryService;
118
119
  MLService: MLService;
119
- Moderation: Moderation;
120
+ ModerationService: ModerationService;
120
121
  NetworkClient: NetworkClient;
121
122
  NetworkServer: NetworkServer;
122
123
  NetworkSettings: NetworkSettings;
@@ -124,6 +125,7 @@ interface Services {
124
125
  OpenCloudService: OpenCloudService;
125
126
  PackageService: PackageService;
126
127
  PackageUIService: PackageUIService;
128
+ PartyEmulatorService: PartyEmulatorService;
127
129
  PatchBundlerFileWatch: PatchBundlerFileWatch;
128
130
  PathfindingService: PathfindingService;
129
131
  PerformanceControlService: PerformanceControlService;
@@ -174,6 +176,7 @@ interface Services {
174
176
  ServerScriptService: ServerScriptService;
175
177
  ServerStorage: ServerStorage;
176
178
  ServiceVisibilityService: ServiceVisibilityService;
179
+ SessionCheckService: SessionCheckService;
177
180
  SessionService: SessionService;
178
181
  SharedTableRegistry: SharedTableRegistry;
179
182
  SlimContentProvider: SlimContentProvider;
@@ -274,6 +277,7 @@ interface CreatableInstances {
274
277
  AudioFader: AudioFader;
275
278
  AudioFilter: AudioFilter;
276
279
  AudioFlanger: AudioFlanger;
280
+ AudioGate: AudioGate;
277
281
  AudioLimiter: AudioLimiter;
278
282
  AudioListener: AudioListener;
279
283
  AudioPitchShifter: AudioPitchShifter;
@@ -502,6 +506,7 @@ interface CreatableInstances {
502
506
  TremoloSoundEffect: TremoloSoundEffect;
503
507
  TrussPart: TrussPart;
504
508
  UIAspectRatioConstraint: UIAspectRatioConstraint;
509
+ UIContainerQuery: UIContainerQuery;
505
510
  UICorner: UICorner;
506
511
  UIDragDetector: UIDragDetector;
507
512
  UIFlexItem: UIFlexItem;
@@ -637,7 +642,6 @@ interface Instances extends Services, CreatableInstances {
637
642
  LuaSettings: LuaSettings;
638
643
  LuaSourceContainer: LuaSourceContainer;
639
644
  ManualSurfaceJointInstance: ManualSurfaceJointInstance;
640
- MaterialGenerationSession: MaterialGenerationSession;
641
645
  MaterialImportData: MaterialImportData;
642
646
  MemoryStoreHashMap: MemoryStoreHashMap;
643
647
  MemoryStoreHashMapPages: MemoryStoreHashMapPages;
@@ -1717,6 +1721,21 @@ interface AudioFocusService extends Instance {
1717
1721
  */
1718
1722
  readonly _nominal_AudioFocusService: unique symbol;
1719
1723
  }
1724
+ /**
1725
+ * - **Tags**: NotBrowsable
1726
+ *
1727
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate)
1728
+ */
1729
+ interface AudioGate extends Instance {
1730
+ /**
1731
+ * **DO NOT USE!**
1732
+ *
1733
+ * This field exists to force TypeScript to recognize this as a nominal type
1734
+ * @hidden
1735
+ * @deprecated
1736
+ */
1737
+ readonly _nominal_AudioGate: unique symbol;
1738
+ }
1720
1739
  /**
1721
1740
  * Limits how loud audio streams are allowed to be.
1722
1741
  *
@@ -1844,8 +1863,6 @@ interface AudioSpeechToText extends Instance {
1844
1863
  /**
1845
1864
  * Plays text as speech audio.
1846
1865
  *
1847
- * - **Tags**: NotBrowsable
1848
- *
1849
1866
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
1850
1867
  */
1851
1868
  interface AudioTextToSpeech extends Instance {
@@ -7844,21 +7861,6 @@ interface MaterialGenerationService extends Instance {
7844
7861
  */
7845
7862
  readonly _nominal_MaterialGenerationService: unique symbol;
7846
7863
  }
7847
- /**
7848
- * - **Tags**: NotCreatable, NotReplicated
7849
- *
7850
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialGenerationSession)
7851
- */
7852
- interface MaterialGenerationSession extends Instance {
7853
- /**
7854
- * **DO NOT USE!**
7855
- *
7856
- * This field exists to force TypeScript to recognize this as a nominal type
7857
- * @hidden
7858
- * @deprecated
7859
- */
7860
- readonly _nominal_MaterialGenerationSession: unique symbol;
7861
- }
7862
7864
  /**
7863
7865
  * The game service responsible for managing materials.
7864
7866
  *
@@ -8140,9 +8142,9 @@ interface MetaBreakpointManager extends Instance {
8140
8142
  /**
8141
8143
  * - **Tags**: NotCreatable, Service, NotReplicated
8142
8144
  *
8143
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Moderation)
8145
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService)
8144
8146
  */
8145
- interface Moderation extends Instance {
8147
+ interface MicroProfilerService extends Instance {
8146
8148
  /**
8147
8149
  * **DO NOT USE!**
8148
8150
  *
@@ -8150,7 +8152,22 @@ interface Moderation extends Instance {
8150
8152
  * @hidden
8151
8153
  * @deprecated
8152
8154
  */
8153
- readonly _nominal_Moderation: unique symbol;
8155
+ readonly _nominal_MicroProfilerService: unique symbol;
8156
+ }
8157
+ /**
8158
+ * - **Tags**: NotCreatable, Service, NotReplicated
8159
+ *
8160
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService)
8161
+ */
8162
+ interface ModerationService extends Instance {
8163
+ /**
8164
+ * **DO NOT USE!**
8165
+ *
8166
+ * This field exists to force TypeScript to recognize this as a nominal type
8167
+ * @hidden
8168
+ * @deprecated
8169
+ */
8170
+ readonly _nominal_ModerationService: unique symbol;
8154
8171
  }
8155
8172
  /**
8156
8173
  * Legacy object that contains members useful for pointer input.
@@ -9393,6 +9410,21 @@ interface ParticleEmitter extends Instance {
9393
9410
  */
9394
9411
  readonly _nominal_ParticleEmitter: unique symbol;
9395
9412
  }
9413
+ /**
9414
+ * - **Tags**: NotCreatable, Service, NotReplicated
9415
+ *
9416
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartyEmulatorService)
9417
+ */
9418
+ interface PartyEmulatorService extends Instance {
9419
+ /**
9420
+ * **DO NOT USE!**
9421
+ *
9422
+ * This field exists to force TypeScript to recognize this as a nominal type
9423
+ * @hidden
9424
+ * @deprecated
9425
+ */
9426
+ readonly _nominal_PartyEmulatorService: unique symbol;
9427
+ }
9396
9428
  /**
9397
9429
  * - **Tags**: NotCreatable, Service, NotReplicated
9398
9430
  *
@@ -9653,7 +9685,7 @@ interface PlatformFriendsService extends Instance {
9653
9685
  readonly _nominal_PlatformFriendsService: unique symbol;
9654
9686
  }
9655
9687
  /**
9656
- * An object that represents a presently connected client to the game.
9688
+ * An object that represents a presently connected client to the experience.
9657
9689
  *
9658
9690
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player)
9659
9691
  */
@@ -9667,12 +9699,12 @@ interface Player extends Instance {
9667
9699
  */
9668
9700
  readonly _nominal_Player: unique symbol;
9669
9701
  /**
9670
- * Sets the AccountAge of the player.
9702
+ * Sets the `AccountAge` of the player.
9671
9703
  *
9672
9704
  * - **ThreadSafety**: Unsafe
9673
9705
  *
9674
9706
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SetAccountAge)
9675
- * @param this An object that represents a presently connected client to the game.
9707
+ * @param this An object that represents a presently connected client to the experience.
9676
9708
  * @param accountAge The age of the account in days.
9677
9709
  */
9678
9710
  SetAccountAge(this: Player, accountAge: number): void;
@@ -9682,7 +9714,7 @@ interface Player extends Instance {
9682
9714
  * - **ThreadSafety**: Unsafe
9683
9715
  *
9684
9716
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SetSuperSafeChat)
9685
- * @param this An object that represents a presently connected client to the game.
9717
+ * @param this An object that represents a presently connected client to the experience.
9686
9718
  * @param value A boolean indicating whether or not the player sees filtered chat.
9687
9719
  */
9688
9720
  SetSuperSafeChat(this: Player, value: boolean): void;
@@ -11495,6 +11527,7 @@ interface ScriptEditorService extends Instance {
11495
11527
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#OpenScriptDocumentAsync)
11496
11528
  * @param this This service is used for interacting with `ScriptDocument` instances.
11497
11529
  * @param script
11530
+ * @param options
11498
11531
  */
11499
11532
  OpenScriptDocumentAsync(this: ScriptEditorService, script: LuaSourceContainer, options?: object): unknown;
11500
11533
  /**
@@ -11993,6 +12026,21 @@ interface ServiceVisibilityService extends Instance {
11993
12026
  */
11994
12027
  readonly _nominal_ServiceVisibilityService: unique symbol;
11995
12028
  }
12029
+ /**
12030
+ * - **Tags**: NotCreatable, Service
12031
+ *
12032
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SessionCheckService)
12033
+ */
12034
+ interface SessionCheckService extends Instance {
12035
+ /**
12036
+ * **DO NOT USE!**
12037
+ *
12038
+ * This field exists to force TypeScript to recognize this as a nominal type
12039
+ * @hidden
12040
+ * @deprecated
12041
+ */
12042
+ readonly _nominal_SessionCheckService: unique symbol;
12043
+ }
11996
12044
  /**
11997
12045
  * - **Tags**: NotCreatable, Service
11998
12046
  *
@@ -14135,6 +14183,21 @@ interface UITextSizeConstraint extends UIConstraint {
14135
14183
  */
14136
14184
  readonly _nominal_UITextSizeConstraint: unique symbol;
14137
14185
  }
14186
+ /**
14187
+ * - **Tags**: NotReplicated, NotBrowsable
14188
+ *
14189
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery)
14190
+ */
14191
+ interface UIContainerQuery extends UIComponent {
14192
+ /**
14193
+ * **DO NOT USE!**
14194
+ *
14195
+ * This field exists to force TypeScript to recognize this as a nominal type
14196
+ * @hidden
14197
+ * @deprecated
14198
+ */
14199
+ readonly _nominal_UIContainerQuery: unique symbol;
14200
+ }
14138
14201
  /**
14139
14202
  * UI modifier which applies deformation to corners of its parent `GuiObject`.
14140
14203
  *
@@ -14395,7 +14458,7 @@ interface UserGameSettings extends Instance {
14395
14458
  readonly _nominal_UserGameSettings: unique symbol;
14396
14459
  }
14397
14460
  /**
14398
- * `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
14461
+ * `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
14399
14462
  *
14400
14463
  * - **Tags**: NotCreatable, Service, NotReplicated
14401
14464
  *
@@ -4177,11 +4177,29 @@ declare namespace Enum {
4177
4177
  EnumType: typeof globalThis.Enum.AvatarSettingsAccessoryLimitMethod;
4178
4178
  }
4179
4179
  export const Remove: Remove;
4180
+ /**
4181
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod#PreviewScale)
4182
+ */
4183
+ export interface PreviewScale extends globalThis.EnumItem {
4184
+ Name: "PreviewScale";
4185
+ Value: 2;
4186
+ EnumType: typeof globalThis.Enum.AvatarSettingsAccessoryLimitMethod;
4187
+ }
4188
+ export const PreviewScale: PreviewScale;
4189
+ /**
4190
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod#PreviewRemove)
4191
+ */
4192
+ export interface PreviewRemove extends globalThis.EnumItem {
4193
+ Name: "PreviewRemove";
4194
+ Value: 3;
4195
+ EnumType: typeof globalThis.Enum.AvatarSettingsAccessoryLimitMethod;
4196
+ }
4197
+ export const PreviewRemove: PreviewRemove;
4180
4198
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AvatarSettingsAccessoryLimitMethod>;
4181
4199
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsAccessoryLimitMethod | undefined;
4182
4200
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsAccessoryLimitMethod | undefined;
4183
4201
  }
4184
- export type AvatarSettingsAccessoryLimitMethod = AvatarSettingsAccessoryLimitMethod.Scale | AvatarSettingsAccessoryLimitMethod.Remove;
4202
+ export type AvatarSettingsAccessoryLimitMethod = AvatarSettingsAccessoryLimitMethod.Scale | AvatarSettingsAccessoryLimitMethod.Remove | AvatarSettingsAccessoryLimitMethod.PreviewScale | AvatarSettingsAccessoryLimitMethod.PreviewRemove;
4185
4203
  /**
4186
4204
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryMode)
4187
4205
  */
@@ -8216,13 +8234,13 @@ declare namespace Enum {
8216
8234
  }
8217
8235
  export type ContextActionPriority = ContextActionPriority.Low | ContextActionPriority.Medium | ContextActionPriority.High;
8218
8236
  /**
8219
- * Describes whether a ContextAction should sink or pass input events.
8237
+ * Describes whether a contextual action should sink or pass input events.
8220
8238
  *
8221
8239
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContextActionResult)
8222
8240
  */
8223
8241
  export namespace ContextActionResult {
8224
8242
  /**
8225
- * If *functionToBind* from `ContextActionService:BindAction()` returns Enum.ContextActionResult.Sink, the input event will stop at that function and no other bound actions under it will be processed. This is the default behavior if *functionToBind* does not return anything or yields in any way.
8243
+ * If `functionToBind` from `ContextActionService:BindAction()` returns `ContextActionResult.Sink`, the input event will stop at that function and no other bound actions under it will be processed. This is the default behavior if `functionToBind` does not return anything or yields in any way.
8226
8244
  *
8227
8245
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContextActionResult#Sink)
8228
8246
  */
@@ -8233,7 +8251,7 @@ declare namespace Enum {
8233
8251
  }
8234
8252
  export const Sink: Sink;
8235
8253
  /**
8236
- * If *functionToBind* from `ContextActionService:BindAction()` returns Enum.ContextActionResult.Pass, the input event is considered to have not been handled by *functionToBind* and will continue being passed to actions bound to the same input type.
8254
+ * If `functionToBind` from `ContextActionService:BindAction()` returns `ContextActionResult.Pass`, the input event is considered to have not been handled by `functionToBind` and will continue being passed to actions bound to the same input type.
8237
8255
  *
8238
8256
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContextActionResult#Pass)
8239
8257
  */
@@ -9185,7 +9203,7 @@ declare namespace Enum {
9185
9203
  */
9186
9204
  export namespace DevComputerMovementMode {
9187
9205
  /**
9188
- * The player's character will moved based on the user's settings.
9206
+ * Allows players to choose their desired control scheme from the in-experience menu. This is the default movement mode.
9189
9207
  *
9190
9208
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode#UserChoice)
9191
9209
  */
@@ -9207,7 +9225,7 @@ declare namespace Enum {
9207
9225
  }
9208
9226
  export const KeyboardMouse: KeyboardMouse;
9209
9227
  /**
9210
- * The player can right click in the game world and the character will move there. Player can also control character with mouse and keyboard.
9228
+ * Players can only move through the experience by clicking a target location. The player's character will automatically jump when reaching a surmountable obstacle/gap while moving to the click destination.
9211
9229
  *
9212
9230
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode#ClickToMove)
9213
9231
  */
@@ -9218,7 +9236,7 @@ declare namespace Enum {
9218
9236
  }
9219
9237
  export const ClickToMove: ClickToMove;
9220
9238
  /**
9221
- * The player will not respond to default controls. You must define any character movement in custom scripts.
9239
+ * Disables all default controls and allows you to script your own control scheme.
9222
9240
  *
9223
9241
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode#Scriptable)
9224
9242
  */
@@ -9289,13 +9307,13 @@ declare namespace Enum {
9289
9307
  }
9290
9308
  export type DevTouchCameraMovementMode = DevTouchCameraMovementMode.UserChoice | DevTouchCameraMovementMode.Classic | DevTouchCameraMovementMode.Follow | DevTouchCameraMovementMode.Orbital;
9291
9309
  /**
9292
- * Overrides the movement mode of players who are playing on touch devices.
9310
+ * Overrides the movement mode of players who are playing on touch-enabled devices.
9293
9311
  *
9294
9312
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode)
9295
9313
  */
9296
9314
  export namespace DevTouchMovementMode {
9297
9315
  /**
9298
- * The player's character will moved based on the user's settings.
9316
+ * Allows players to choose their desired control scheme from the in-experience menu. This is the default movement mode.
9299
9317
  *
9300
9318
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#UserChoice)
9301
9319
  */
@@ -9344,7 +9362,7 @@ declare namespace Enum {
9344
9362
  }
9345
9363
  export const ClickToMove: ClickToMove;
9346
9364
  /**
9347
- * The player will not respond to default controls; any character movement must be defined in custom scripts.
9365
+ * The player's character will not respond to default controls; any character movement must be defined in custom scripts.
9348
9366
  *
9349
9367
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#Scriptable)
9350
9368
  */
@@ -9355,7 +9373,7 @@ declare namespace Enum {
9355
9373
  }
9356
9374
  export const Scriptable: Scriptable;
9357
9375
  /**
9358
- * The player's character is controlled with a virtual thumbstick that appears when they touch the lower portion of the screen. Jumping is controlled with a separate button. Good for portrait mode and one handed play.
9376
+ * The player's character is controlled with a virtual thumbstick that appears when they touch the lower portion of the screen. Jumping is controlled with a separate button.
9359
9377
  *
9360
9378
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#DynamicThumbstick)
9361
9379
  */
@@ -9925,6 +9943,42 @@ declare namespace Enum {
9925
9943
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DialogTone | undefined;
9926
9944
  }
9927
9945
  export type DialogTone = DialogTone.Neutral | DialogTone.Friendly | DialogTone.Enemy;
9946
+ /**
9947
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize)
9948
+ */
9949
+ export namespace DisplaySize {
9950
+ /**
9951
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Small)
9952
+ */
9953
+ export interface Small extends globalThis.EnumItem {
9954
+ Name: "Small";
9955
+ Value: 0;
9956
+ EnumType: typeof globalThis.Enum.DisplaySize;
9957
+ }
9958
+ export const Small: Small;
9959
+ /**
9960
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Medium)
9961
+ */
9962
+ export interface Medium extends globalThis.EnumItem {
9963
+ Name: "Medium";
9964
+ Value: 1;
9965
+ EnumType: typeof globalThis.Enum.DisplaySize;
9966
+ }
9967
+ export const Medium: Medium;
9968
+ /**
9969
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Large)
9970
+ */
9971
+ export interface Large extends globalThis.EnumItem {
9972
+ Name: "Large";
9973
+ Value: 2;
9974
+ EnumType: typeof globalThis.Enum.DisplaySize;
9975
+ }
9976
+ export const Large: Large;
9977
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DisplaySize>;
9978
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DisplaySize | undefined;
9979
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DisplaySize | undefined;
9980
+ }
9981
+ export type DisplaySize = DisplaySize.Small | DisplaySize.Medium | DisplaySize.Large;
9928
9982
  /**
9929
9983
  * Used by `UIAspectRatioConstraint.DominantAxis` for resizing the object to maintain the aspect ratio.
9930
9984
  *
@@ -14163,11 +14217,20 @@ declare namespace Enum {
14163
14217
  EnumType: typeof globalThis.Enum.HttpError;
14164
14218
  }
14165
14219
  export const ServerProtocolError: ServerProtocolError;
14220
+ /**
14221
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/HttpError#CreatorEnvironmentsNotSupportedByService)
14222
+ */
14223
+ export interface CreatorEnvironmentsNotSupportedByService extends globalThis.EnumItem {
14224
+ Name: "CreatorEnvironmentsNotSupportedByService";
14225
+ Value: 15;
14226
+ EnumType: typeof globalThis.Enum.HttpError;
14227
+ }
14228
+ export const CreatorEnvironmentsNotSupportedByService: CreatorEnvironmentsNotSupportedByService;
14166
14229
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.HttpError>;
14167
14230
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.HttpError | undefined;
14168
14231
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.HttpError | undefined;
14169
14232
  }
14170
- export type HttpError = HttpError.OK | HttpError.InvalidUrl | HttpError.DnsResolve | HttpError.ConnectFail | HttpError.OutOfMemory | HttpError.TimedOut | HttpError.TooManyRedirects | HttpError.InvalidRedirect | HttpError.NetFail | HttpError.Aborted | HttpError.SslConnectFail | HttpError.SslVerificationFail | HttpError.Unknown | HttpError.ConnectionClosed | HttpError.ServerProtocolError;
14233
+ export type HttpError = HttpError.OK | HttpError.InvalidUrl | HttpError.DnsResolve | HttpError.ConnectFail | HttpError.OutOfMemory | HttpError.TimedOut | HttpError.TooManyRedirects | HttpError.InvalidRedirect | HttpError.NetFail | HttpError.Aborted | HttpError.SslConnectFail | HttpError.SslVerificationFail | HttpError.Unknown | HttpError.ConnectionClosed | HttpError.ServerProtocolError | HttpError.CreatorEnvironmentsNotSupportedByService;
14171
14234
  /**
14172
14235
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/HttpRequestType)
14173
14236
  */
@@ -15092,7 +15155,7 @@ declare namespace Enum {
15092
15155
  */
15093
15156
  export namespace InputActionType {
15094
15157
  /**
15095
- * The `InputAction` will receive boolean values from button inputs, for example `true`/`false` on press/release from inputs such as `KeyCode.ButtonA` or `KeyCode.E`.
15158
+ * The `InputAction` will receive boolean values from button inputs, for example `true`/`false` on press/release from inputs such as `KeyCode.ButtonA` or `KeyCode.E`. This setting also exposes the `UIButton` property on child `InputBindings`, allowing you to easily hook up press or release of a `GuiButton` for the action.
15096
15159
  *
15097
15160
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputActionType#Bool)
15098
15161
  */
@@ -15103,7 +15166,7 @@ declare namespace Enum {
15103
15166
  }
15104
15167
  export const Bool: Bool;
15105
15168
  /**
15106
- * The `InputAction` will receive numerical values, generally from analog gamepad triggers such as `KeyCode.ButtonL2` or `KeyCode.ButtonR2`.
15169
+ * The `InputAction` will receive numerical values, generally from analog gamepad triggers such as `KeyCode.ButtonL2` or `KeyCode.ButtonR2`. This setting also exposes the `Up` and `Down` properties on child `InputBindings`, allowing for boolean inputs or "1D" inputs as composite directions for the action.
15107
15170
  *
15108
15171
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputActionType#Direction1D)
15109
15172
  */
@@ -15114,7 +15177,7 @@ declare namespace Enum {
15114
15177
  }
15115
15178
  export const Direction1D: Direction1D;
15116
15179
  /**
15117
- * The `InputAction` will receive `Vector2` values, generally from thumbstick inputs such as `KeyCode.Thumbstick1` and `KeyCode.Thumbstick2`.
15180
+ * The `InputAction` will receive `Vector2` values, generally from thumbstick inputs such as `KeyCode.Thumbstick1` and `KeyCode.Thumbstick2`. This setting also exposes the `Up`, `Down`, `Left`, and `Right` properties on child `InputBindings`, allowing for "2D" inputs as composite directions for the action.
15118
15181
  *
15119
15182
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputActionType#Direction2D)
15120
15183
  */
@@ -15125,6 +15188,8 @@ declare namespace Enum {
15125
15188
  }
15126
15189
  export const Direction2D: Direction2D;
15127
15190
  /**
15191
+ * The `InputAction` will receive `Vector3` values from inputs assigned to the `Up`, `Down`, `Left`, `Right`, `Forward`, and/or `Backward` properties on child `InputBindings`, allowing for "3D" inputs as composite directions for the action.
15192
+ *
15128
15193
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputActionType#Direction3D)
15129
15194
  */
15130
15195
  export interface Direction3D extends globalThis.EnumItem {
@@ -19879,7 +19944,7 @@ declare namespace Enum {
19879
19944
  }
19880
19945
  export const Glacier: Glacier;
19881
19946
  /**
19882
- * Applies to `BasePart` only.
19947
+ * Applies to `BasePart` only. Note that refraction of light through this material is not supported on mobile devices due to computational limitations.
19883
19948
  *
19884
19949
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Material#Glass)
19885
19950
  */
@@ -19890,7 +19955,7 @@ declare namespace Enum {
19890
19955
  }
19891
19956
  export const Glass: Glass;
19892
19957
  /**
19893
- * Must be used on a `MeshPart` with UVs laid out to cover much of the 0:1 UV space or more (larger is better). The `MeshPart` must also have a texture applied to its `TextureID`, and that texture image must have a wide value range since the material displays the range from dark/black to light/white values. Obtain [this model](https://create.roblox.com/store/asset/15507769146/ForceFieldMesh) for a functional example of the **ForceField** material.
19958
+ * Must be used on a `MeshPart` with UVs laid out to cover much of the 0:1 UV space or more (larger is better). The `MeshPart` must also have a texture applied to its `TextureID`, and that texture image must have a wide value range since the material displays the range from dark/black to light/white values. Obtain [this model](https://create.roblox.com/store/asset/15507769146/ForceFieldMesh) for a functional example.
19894
19959
  *
19895
19960
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Material#ForceField)
19896
19961
  */
@@ -22915,10 +22980,14 @@ declare namespace Enum {
22915
22980
  }
22916
22981
  export type PositionAlignmentMode = PositionAlignmentMode.OneAttachment | PositionAlignmentMode.TwoAttachment;
22917
22982
  /**
22983
+ * This enum is used with `UserInputService.PreferredInput` to indicate the primary input type a player is likely using.
22984
+ *
22918
22985
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredInput)
22919
22986
  */
22920
22987
  export namespace PreferredInput {
22921
22988
  /**
22989
+ * The player has connected or most recently interacted with a keyboard or mouse.
22990
+ *
22922
22991
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredInput#KeyboardAndMouse)
22923
22992
  */
22924
22993
  export interface KeyboardAndMouse extends globalThis.EnumItem {
@@ -22928,6 +22997,8 @@ declare namespace Enum {
22928
22997
  }
22929
22998
  export const KeyboardAndMouse: KeyboardAndMouse;
22930
22999
  /**
23000
+ * The player has connected or most recently interacted with a gamepad.
23001
+ *
22931
23002
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredInput#Gamepad)
22932
23003
  */
22933
23004
  export interface Gamepad extends globalThis.EnumItem {
@@ -22937,6 +23008,8 @@ declare namespace Enum {
22937
23008
  }
22938
23009
  export const Gamepad: Gamepad;
22939
23010
  /**
23011
+ * The player's device has touch capability and no other input method is available or connected.
23012
+ *
22940
23013
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredInput#Touch)
22941
23014
  */
22942
23015
  export interface Touch extends globalThis.EnumItem {
@@ -23462,6 +23535,42 @@ declare namespace Enum {
23462
23535
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PromptCreateAvatarResult | undefined;
23463
23536
  }
23464
23537
  export type PromptCreateAvatarResult = PromptCreateAvatarResult.Success | PromptCreateAvatarResult.PermissionDenied | PromptCreateAvatarResult.Timeout | PromptCreateAvatarResult.UploadFailed | PromptCreateAvatarResult.NoUserInput | PromptCreateAvatarResult.InvalidHumanoidDescription | PromptCreateAvatarResult.UGCValidationFailed | PromptCreateAvatarResult.ModeratedName | PromptCreateAvatarResult.MaxOutfits | PromptCreateAvatarResult.PurchaseFailure | PromptCreateAvatarResult.UnknownFailure | PromptCreateAvatarResult.TokenInvalid;
23538
+ /**
23539
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult)
23540
+ */
23541
+ export namespace PromptLinkSharingResult {
23542
+ /**
23543
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult#Success)
23544
+ */
23545
+ export interface Success extends globalThis.EnumItem {
23546
+ Name: "Success";
23547
+ Value: 1;
23548
+ EnumType: typeof globalThis.Enum.PromptLinkSharingResult;
23549
+ }
23550
+ export const Success: Success;
23551
+ /**
23552
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult#PlayerLeft)
23553
+ */
23554
+ export interface PlayerLeft extends globalThis.EnumItem {
23555
+ Name: "PlayerLeft";
23556
+ Value: 2;
23557
+ EnumType: typeof globalThis.Enum.PromptLinkSharingResult;
23558
+ }
23559
+ export const PlayerLeft: PlayerLeft;
23560
+ /**
23561
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult#InvalidLaunchData)
23562
+ */
23563
+ export interface InvalidLaunchData extends globalThis.EnumItem {
23564
+ Name: "InvalidLaunchData";
23565
+ Value: 3;
23566
+ EnumType: typeof globalThis.Enum.PromptLinkSharingResult;
23567
+ }
23568
+ export const InvalidLaunchData: InvalidLaunchData;
23569
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PromptLinkSharingResult>;
23570
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.PromptLinkSharingResult | undefined;
23571
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PromptLinkSharingResult | undefined;
23572
+ }
23573
+ export type PromptLinkSharingResult = PromptLinkSharingResult.Success | PromptLinkSharingResult.PlayerLeft | PromptLinkSharingResult.InvalidLaunchData;
23465
23574
  /**
23466
23575
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptPublishAssetResult)
23467
23576
  */
@@ -32456,13 +32565,13 @@ declare namespace Enum {
32456
32565
  }
32457
32566
  export type UserCFrame = UserCFrame.Head | UserCFrame.LeftHand | UserCFrame.RightHand | UserCFrame.Floor;
32458
32567
  /**
32459
- * The **UserInputState** enum describes the state of an input that is currently or was recently performed.
32568
+ * This enum describes the state of an input that is currently or was recently performed.
32460
32569
  *
32461
32570
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState)
32462
32571
  */
32463
32572
  export namespace UserInputState {
32464
32573
  /**
32465
- * Occurs when an `InputObject` starts to interact with the game. For example, a mouse button down, or a key down, or when a touch begins touching the screen.
32574
+ * Occurs when an `InputObject` starts to interact with the experience. For example, a mouse button down, a key down, or when the player begins touching the screen.
32466
32575
  *
32467
32576
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState#Begin)
32468
32577
  */
@@ -32473,7 +32582,7 @@ declare namespace Enum {
32473
32582
  }
32474
32583
  export const Begin: Begin;
32475
32584
  /**
32476
- * Occurs each frame an `InputObject` has already begun interacting with the game and part of its state is changing. For example, a movement of the mouse position, a gamepad thumbstick, gamepad trigger button, or screen touch point.
32585
+ * Occurs each frame an `InputObject` has already begun interacting with the experience and part of its state is changing. For example, movement of the mouse position, a gamepad thumbstick movement, an analog gamepad trigger button change, or screen touch point change.
32477
32586
  *
32478
32587
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState#Change)
32479
32588
  */
@@ -32484,7 +32593,7 @@ declare namespace Enum {
32484
32593
  }
32485
32594
  export const Change: Change;
32486
32595
  /**
32487
- * When an `InputObject` finishes interacting with the game. For example, a mouse button up, or a key up, or when a touch stops touching the screen.
32596
+ * Occurs when an `InputObject` finishes interacting with the experience. For example, a mouse button up, a key up, or when the player stops touching the screen.
32488
32597
  *
32489
32598
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState#End)
32490
32599
  */
@@ -32495,7 +32604,7 @@ declare namespace Enum {
32495
32604
  }
32496
32605
  export const End: End;
32497
32606
  /**
32498
- * A special circumstance state that indicates this input is no longer relevant, particularly with `ContextActionService`. For example, binding two action-handling functions will cause the first to Cancel if an input was already in-progress when the second was bound.
32607
+ * A special circumstance state that indicates this input is no longer relevant, particularly with `ContextActionService`. For example, binding two action-handling functions will cause the first to `Cancel` if an input was already in-progress when the second was bound.
32499
32608
  *
32500
32609
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState#Cancel)
32501
32610
  */
@@ -32506,7 +32615,7 @@ declare namespace Enum {
32506
32615
  }
32507
32616
  export const Cancel: Cancel;
32508
32617
  /**
32509
- * A state that should never be seen in a game, essentially just marks the end of the enum.
32618
+ * A state that should never be seen in an experience; essentially just marks the end of the enum.
32510
32619
  *
32511
32620
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState#None)
32512
32621
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.859",
3
+ "version": "1.0.861",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },