@rbxts/types 1.0.859 → 1.0.860
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/include/generated/None.d.ts +312 -111
- package/include/generated/PluginSecurity.d.ts +53 -21
- package/include/generated/enums.d.ts +58 -21
- package/package.json +1 -1
|
@@ -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
|
-
|
|
120
|
+
ModerationService: ModerationService;
|
|
120
121
|
NetworkClient: NetworkClient;
|
|
121
122
|
NetworkServer: NetworkServer;
|
|
122
123
|
NetworkSettings: NetworkSettings;
|
|
@@ -174,6 +175,7 @@ interface Services {
|
|
|
174
175
|
ServerScriptService: ServerScriptService;
|
|
175
176
|
ServerStorage: ServerStorage;
|
|
176
177
|
ServiceVisibilityService: ServiceVisibilityService;
|
|
178
|
+
SessionCheckService: SessionCheckService;
|
|
177
179
|
SessionService: SessionService;
|
|
178
180
|
SharedTableRegistry: SharedTableRegistry;
|
|
179
181
|
SlimContentProvider: SlimContentProvider;
|
|
@@ -502,6 +504,7 @@ interface CreatableInstances {
|
|
|
502
504
|
TremoloSoundEffect: TremoloSoundEffect;
|
|
503
505
|
TrussPart: TrussPart;
|
|
504
506
|
UIAspectRatioConstraint: UIAspectRatioConstraint;
|
|
507
|
+
UIContainerQuery: UIContainerQuery;
|
|
505
508
|
UICorner: UICorner;
|
|
506
509
|
UIDragDetector: UIDragDetector;
|
|
507
510
|
UIFlexItem: UIFlexItem;
|
|
@@ -637,7 +640,6 @@ interface Instances extends Services, CreatableInstances {
|
|
|
637
640
|
LuaSettings: LuaSettings;
|
|
638
641
|
LuaSourceContainer: LuaSourceContainer;
|
|
639
642
|
ManualSurfaceJointInstance: ManualSurfaceJointInstance;
|
|
640
|
-
MaterialGenerationSession: MaterialGenerationSession;
|
|
641
643
|
MaterialImportData: MaterialImportData;
|
|
642
644
|
MemoryStoreHashMap: MemoryStoreHashMap;
|
|
643
645
|
MemoryStoreHashMapPages: MemoryStoreHashMapPages;
|
|
@@ -7844,21 +7846,6 @@ interface MaterialGenerationService extends Instance {
|
|
|
7844
7846
|
*/
|
|
7845
7847
|
readonly _nominal_MaterialGenerationService: unique symbol;
|
|
7846
7848
|
}
|
|
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
7849
|
/**
|
|
7863
7850
|
* The game service responsible for managing materials.
|
|
7864
7851
|
*
|
|
@@ -8140,9 +8127,24 @@ interface MetaBreakpointManager extends Instance {
|
|
|
8140
8127
|
/**
|
|
8141
8128
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
8142
8129
|
*
|
|
8143
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/
|
|
8130
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService)
|
|
8131
|
+
*/
|
|
8132
|
+
interface MicroProfilerService extends Instance {
|
|
8133
|
+
/**
|
|
8134
|
+
* **DO NOT USE!**
|
|
8135
|
+
*
|
|
8136
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
8137
|
+
* @hidden
|
|
8138
|
+
* @deprecated
|
|
8139
|
+
*/
|
|
8140
|
+
readonly _nominal_MicroProfilerService: unique symbol;
|
|
8141
|
+
}
|
|
8142
|
+
/**
|
|
8143
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
8144
|
+
*
|
|
8145
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService)
|
|
8144
8146
|
*/
|
|
8145
|
-
interface
|
|
8147
|
+
interface ModerationService extends Instance {
|
|
8146
8148
|
/**
|
|
8147
8149
|
* **DO NOT USE!**
|
|
8148
8150
|
*
|
|
@@ -8150,7 +8152,7 @@ interface Moderation extends Instance {
|
|
|
8150
8152
|
* @hidden
|
|
8151
8153
|
* @deprecated
|
|
8152
8154
|
*/
|
|
8153
|
-
readonly
|
|
8155
|
+
readonly _nominal_ModerationService: unique symbol;
|
|
8154
8156
|
}
|
|
8155
8157
|
/**
|
|
8156
8158
|
* Legacy object that contains members useful for pointer input.
|
|
@@ -11993,6 +11995,21 @@ interface ServiceVisibilityService extends Instance {
|
|
|
11993
11995
|
*/
|
|
11994
11996
|
readonly _nominal_ServiceVisibilityService: unique symbol;
|
|
11995
11997
|
}
|
|
11998
|
+
/**
|
|
11999
|
+
* - **Tags**: NotCreatable, Service
|
|
12000
|
+
*
|
|
12001
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SessionCheckService)
|
|
12002
|
+
*/
|
|
12003
|
+
interface SessionCheckService extends Instance {
|
|
12004
|
+
/**
|
|
12005
|
+
* **DO NOT USE!**
|
|
12006
|
+
*
|
|
12007
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
12008
|
+
* @hidden
|
|
12009
|
+
* @deprecated
|
|
12010
|
+
*/
|
|
12011
|
+
readonly _nominal_SessionCheckService: unique symbol;
|
|
12012
|
+
}
|
|
11996
12013
|
/**
|
|
11997
12014
|
* - **Tags**: NotCreatable, Service
|
|
11998
12015
|
*
|
|
@@ -14135,6 +14152,21 @@ interface UITextSizeConstraint extends UIConstraint {
|
|
|
14135
14152
|
*/
|
|
14136
14153
|
readonly _nominal_UITextSizeConstraint: unique symbol;
|
|
14137
14154
|
}
|
|
14155
|
+
/**
|
|
14156
|
+
* - **Tags**: NotReplicated, NotBrowsable
|
|
14157
|
+
*
|
|
14158
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery)
|
|
14159
|
+
*/
|
|
14160
|
+
interface UIContainerQuery extends UIComponent {
|
|
14161
|
+
/**
|
|
14162
|
+
* **DO NOT USE!**
|
|
14163
|
+
*
|
|
14164
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
14165
|
+
* @hidden
|
|
14166
|
+
* @deprecated
|
|
14167
|
+
*/
|
|
14168
|
+
readonly _nominal_UIContainerQuery: unique symbol;
|
|
14169
|
+
}
|
|
14138
14170
|
/**
|
|
14139
14171
|
* UI modifier which applies deformation to corners of its parent `GuiObject`.
|
|
14140
14172
|
*
|
|
@@ -14395,7 +14427,7 @@ interface UserGameSettings extends Instance {
|
|
|
14395
14427
|
readonly _nominal_UserGameSettings: unique symbol;
|
|
14396
14428
|
}
|
|
14397
14429
|
/**
|
|
14398
|
-
* `UserInputService` is
|
|
14430
|
+
* `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
14399
14431
|
*
|
|
14400
14432
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
14401
14433
|
*
|
|
@@ -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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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.
|
|
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
|
*/
|
|
@@ -14163,11 +14181,20 @@ declare namespace Enum {
|
|
|
14163
14181
|
EnumType: typeof globalThis.Enum.HttpError;
|
|
14164
14182
|
}
|
|
14165
14183
|
export const ServerProtocolError: ServerProtocolError;
|
|
14184
|
+
/**
|
|
14185
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/HttpError#CreatorEnvironmentsNotSupportedByService)
|
|
14186
|
+
*/
|
|
14187
|
+
export interface CreatorEnvironmentsNotSupportedByService extends globalThis.EnumItem {
|
|
14188
|
+
Name: "CreatorEnvironmentsNotSupportedByService";
|
|
14189
|
+
Value: 15;
|
|
14190
|
+
EnumType: typeof globalThis.Enum.HttpError;
|
|
14191
|
+
}
|
|
14192
|
+
export const CreatorEnvironmentsNotSupportedByService: CreatorEnvironmentsNotSupportedByService;
|
|
14166
14193
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.HttpError>;
|
|
14167
14194
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.HttpError | undefined;
|
|
14168
14195
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.HttpError | undefined;
|
|
14169
14196
|
}
|
|
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;
|
|
14197
|
+
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
14198
|
/**
|
|
14172
14199
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/HttpRequestType)
|
|
14173
14200
|
*/
|
|
@@ -15092,7 +15119,7 @@ declare namespace Enum {
|
|
|
15092
15119
|
*/
|
|
15093
15120
|
export namespace InputActionType {
|
|
15094
15121
|
/**
|
|
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`.
|
|
15122
|
+
* 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
15123
|
*
|
|
15097
15124
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputActionType#Bool)
|
|
15098
15125
|
*/
|
|
@@ -15103,7 +15130,7 @@ declare namespace Enum {
|
|
|
15103
15130
|
}
|
|
15104
15131
|
export const Bool: Bool;
|
|
15105
15132
|
/**
|
|
15106
|
-
* The `InputAction` will receive numerical values, generally from analog gamepad triggers such as `KeyCode.ButtonL2` or `KeyCode.ButtonR2`.
|
|
15133
|
+
* 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
15134
|
*
|
|
15108
15135
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputActionType#Direction1D)
|
|
15109
15136
|
*/
|
|
@@ -15114,7 +15141,7 @@ declare namespace Enum {
|
|
|
15114
15141
|
}
|
|
15115
15142
|
export const Direction1D: Direction1D;
|
|
15116
15143
|
/**
|
|
15117
|
-
* The `InputAction` will receive `Vector2` values, generally from thumbstick inputs such as `KeyCode.Thumbstick1` and `KeyCode.Thumbstick2`.
|
|
15144
|
+
* 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
15145
|
*
|
|
15119
15146
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputActionType#Direction2D)
|
|
15120
15147
|
*/
|
|
@@ -15125,6 +15152,8 @@ declare namespace Enum {
|
|
|
15125
15152
|
}
|
|
15126
15153
|
export const Direction2D: Direction2D;
|
|
15127
15154
|
/**
|
|
15155
|
+
* 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.
|
|
15156
|
+
*
|
|
15128
15157
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputActionType#Direction3D)
|
|
15129
15158
|
*/
|
|
15130
15159
|
export interface Direction3D extends globalThis.EnumItem {
|
|
@@ -22915,10 +22944,14 @@ declare namespace Enum {
|
|
|
22915
22944
|
}
|
|
22916
22945
|
export type PositionAlignmentMode = PositionAlignmentMode.OneAttachment | PositionAlignmentMode.TwoAttachment;
|
|
22917
22946
|
/**
|
|
22947
|
+
* This enum is used with `UserInputService.PreferredInput` to indicate the primary input type a player is likely using.
|
|
22948
|
+
*
|
|
22918
22949
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredInput)
|
|
22919
22950
|
*/
|
|
22920
22951
|
export namespace PreferredInput {
|
|
22921
22952
|
/**
|
|
22953
|
+
* The player has connected or most recently interacted with a keyboard or mouse.
|
|
22954
|
+
*
|
|
22922
22955
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredInput#KeyboardAndMouse)
|
|
22923
22956
|
*/
|
|
22924
22957
|
export interface KeyboardAndMouse extends globalThis.EnumItem {
|
|
@@ -22928,6 +22961,8 @@ declare namespace Enum {
|
|
|
22928
22961
|
}
|
|
22929
22962
|
export const KeyboardAndMouse: KeyboardAndMouse;
|
|
22930
22963
|
/**
|
|
22964
|
+
* The player has connected or most recently interacted with a gamepad.
|
|
22965
|
+
*
|
|
22931
22966
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredInput#Gamepad)
|
|
22932
22967
|
*/
|
|
22933
22968
|
export interface Gamepad extends globalThis.EnumItem {
|
|
@@ -22937,6 +22972,8 @@ declare namespace Enum {
|
|
|
22937
22972
|
}
|
|
22938
22973
|
export const Gamepad: Gamepad;
|
|
22939
22974
|
/**
|
|
22975
|
+
* The player's device has touch capability and no other input method is available or connected.
|
|
22976
|
+
*
|
|
22940
22977
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredInput#Touch)
|
|
22941
22978
|
*/
|
|
22942
22979
|
export interface Touch extends globalThis.EnumItem {
|
|
@@ -32456,13 +32493,13 @@ declare namespace Enum {
|
|
|
32456
32493
|
}
|
|
32457
32494
|
export type UserCFrame = UserCFrame.Head | UserCFrame.LeftHand | UserCFrame.RightHand | UserCFrame.Floor;
|
|
32458
32495
|
/**
|
|
32459
|
-
*
|
|
32496
|
+
* This enum describes the state of an input that is currently or was recently performed.
|
|
32460
32497
|
*
|
|
32461
32498
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState)
|
|
32462
32499
|
*/
|
|
32463
32500
|
export namespace UserInputState {
|
|
32464
32501
|
/**
|
|
32465
|
-
* Occurs when an `InputObject` starts to interact with the
|
|
32502
|
+
* 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
32503
|
*
|
|
32467
32504
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState#Begin)
|
|
32468
32505
|
*/
|
|
@@ -32473,7 +32510,7 @@ declare namespace Enum {
|
|
|
32473
32510
|
}
|
|
32474
32511
|
export const Begin: Begin;
|
|
32475
32512
|
/**
|
|
32476
|
-
* Occurs each frame an `InputObject` has already begun interacting with the
|
|
32513
|
+
* 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
32514
|
*
|
|
32478
32515
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState#Change)
|
|
32479
32516
|
*/
|
|
@@ -32484,7 +32521,7 @@ declare namespace Enum {
|
|
|
32484
32521
|
}
|
|
32485
32522
|
export const Change: Change;
|
|
32486
32523
|
/**
|
|
32487
|
-
*
|
|
32524
|
+
* 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
32525
|
*
|
|
32489
32526
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState#End)
|
|
32490
32527
|
*/
|
|
@@ -32495,7 +32532,7 @@ declare namespace Enum {
|
|
|
32495
32532
|
}
|
|
32496
32533
|
export const End: End;
|
|
32497
32534
|
/**
|
|
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.
|
|
32535
|
+
* 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
32536
|
*
|
|
32500
32537
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState#Cancel)
|
|
32501
32538
|
*/
|
|
@@ -32506,7 +32543,7 @@ declare namespace Enum {
|
|
|
32506
32543
|
}
|
|
32507
32544
|
export const Cancel: Cancel;
|
|
32508
32545
|
/**
|
|
32509
|
-
* A state that should never be seen in
|
|
32546
|
+
* A state that should never be seen in an experience; essentially just marks the end of the enum.
|
|
32510
32547
|
*
|
|
32511
32548
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UserInputState#None)
|
|
32512
32549
|
*/
|