@rbxts/types 1.0.933 → 1.0.935
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 +112 -34
- package/include/generated/PluginSecurity.d.ts +21 -21
- package/include/generated/enums.d.ts +9 -1
- package/include/lua.d.ts +15 -0
- package/package.json +1 -1
|
@@ -1054,7 +1054,7 @@ interface EditableImage extends RBXObject {
|
|
|
1054
1054
|
* @param radius Radius of the circle in pixels.
|
|
1055
1055
|
* @param color Color of the circle.
|
|
1056
1056
|
* @param transparency Transparency of the circle with 0 being fully opaque and 1 being fully transparent.
|
|
1057
|
-
* @param combineType How the pixels
|
|
1057
|
+
* @param combineType How the drawn pixels (source) are combined with the existing pixels of this image (destination).
|
|
1058
1058
|
* @param antiAliasing Determines whether anti-aliasing is applied to the circle. When set to `AntiAliasing.Enabled`, circle edges are soft. When set to `AntiAliasing.Disabled`, circle edges are hard.
|
|
1059
1059
|
*/
|
|
1060
1060
|
DrawCircle(this: EditableImage, center: Vector2, radius: number, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>, antiAliasing?: CastsToEnum<Enum.AntiAliasing>): void;
|
|
@@ -1065,9 +1065,9 @@ interface EditableImage extends RBXObject {
|
|
|
1065
1065
|
*
|
|
1066
1066
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImage)
|
|
1067
1067
|
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1068
|
-
* @param position Position at which the top-left corner of the
|
|
1069
|
-
* @param image The `EditableImage` to draw into this `EditableImage`.
|
|
1070
|
-
* @param combineType How the pixels of the source image
|
|
1068
|
+
* @param position Position at which the top-left corner of the source image will be drawn.
|
|
1069
|
+
* @param image The source `EditableImage` to draw into this `EditableImage`.
|
|
1070
|
+
* @param combineType How the pixels of the source image are combined with the existing pixels of this image (destination).
|
|
1071
1071
|
*/
|
|
1072
1072
|
DrawImage(this: EditableImage, position: Vector2, image: EditableImage, combineType: CastsToEnum<Enum.ImageCombineType>): void;
|
|
1073
1073
|
/**
|
|
@@ -1118,7 +1118,7 @@ interface EditableImage extends RBXObject {
|
|
|
1118
1118
|
* @param p2 End point of the line.
|
|
1119
1119
|
* @param color Color of the line.
|
|
1120
1120
|
* @param transparency Transparency of the line.
|
|
1121
|
-
* @param combineType How the pixels
|
|
1121
|
+
* @param combineType How the drawn pixels (source) are combined with the existing pixels of this image (destination).
|
|
1122
1122
|
* @param antiAliasing Determines whether anti-aliasing is applied to the line. When set to `AntiAliasing.Enabled`, line edges are soft. When set to `AntiAliasing.Disabled`, line edges are hard.
|
|
1123
1123
|
*/
|
|
1124
1124
|
DrawLine(this: EditableImage, p1: Vector2, p2: Vector2, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>, antiAliasing?: CastsToEnum<Enum.AntiAliasing>): void;
|
|
@@ -1133,7 +1133,7 @@ interface EditableImage extends RBXObject {
|
|
|
1133
1133
|
* @param size Size of the rectangle to draw, in pixels.
|
|
1134
1134
|
* @param color Color of the rectangle.
|
|
1135
1135
|
* @param transparency Transparency of the rectangle.
|
|
1136
|
-
* @param combineType How the pixels
|
|
1136
|
+
* @param combineType How the drawn pixels (source) are combined with the existing pixels of this image (destination).
|
|
1137
1137
|
*/
|
|
1138
1138
|
DrawRectangle(this: EditableImage, position: Vector2, size: Vector2, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>): void;
|
|
1139
1139
|
/**
|
|
@@ -2706,6 +2706,8 @@ interface AccessoryDescription extends Instance {
|
|
|
2706
2706
|
*/
|
|
2707
2707
|
Position: Vector3;
|
|
2708
2708
|
/**
|
|
2709
|
+
* **Deprecated:**
|
|
2710
|
+
*
|
|
2709
2711
|
* The layered clothing puffiness, if the `Accessory` is layered.
|
|
2710
2712
|
*
|
|
2711
2713
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -7829,9 +7831,10 @@ interface AvatarCreationService extends Instance {
|
|
|
7829
7831
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#GenerateAvatar2DPreviewAsync)
|
|
7830
7832
|
* @param this A service to support developer avatar creators.
|
|
7831
7833
|
* @param avatarGeneration2dPreviewParams A table of arguments for 2D preview generation. Type: `avatarGeneration2dPreviewParams: {SessionId: string, FileId: string, TextPrompt: string?}`
|
|
7834
|
+
* @param progressCallback Optional callback function that will be invoked periodically with a progressInfo table with the overall progress (from 0 to 1). Type: `(progressInfo: { Progress: number }) -> ()`
|
|
7832
7835
|
* @returns A string previewId
|
|
7833
7836
|
*/
|
|
7834
|
-
GenerateAvatar2DPreviewAsync(this: AvatarCreationService, avatarGeneration2dPreviewParams: object): string;
|
|
7837
|
+
GenerateAvatar2DPreviewAsync(this: AvatarCreationService, avatarGeneration2dPreviewParams: object, progressCallback?: Callback): string;
|
|
7835
7838
|
/**
|
|
7836
7839
|
* Generates an avatar and returns a generationId.
|
|
7837
7840
|
*
|
|
@@ -7841,9 +7844,10 @@ interface AvatarCreationService extends Instance {
|
|
|
7841
7844
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#GenerateAvatarAsync)
|
|
7842
7845
|
* @param this A service to support developer avatar creators.
|
|
7843
7846
|
* @param avatarGenerationParams A table of arguments for generating an avatar. Type: `avatarGenerationParams: {SessionId: string, PreviewId: string}`
|
|
7847
|
+
* @param progressCallback Optional callback function that will be invoked periodically with a progressInfo table with the overall progress (from 0 to 1). Type: `(progressInfo: { Progress: number }) -> ()`
|
|
7844
7848
|
* @returns A string generationId.
|
|
7845
7849
|
*/
|
|
7846
|
-
GenerateAvatarAsync(this: AvatarCreationService, avatarGenerationParams: object): string;
|
|
7850
|
+
GenerateAvatarAsync(this: AvatarCreationService, avatarGenerationParams: object, progressCallback?: Callback): string;
|
|
7847
7851
|
/**
|
|
7848
7852
|
* Gets the avatar creation token details for a list of avatar creation tokens at once.
|
|
7849
7853
|
*
|
|
@@ -9802,6 +9806,8 @@ interface WrapLayer extends BaseWrap {
|
|
|
9802
9806
|
*/
|
|
9803
9807
|
Order: number;
|
|
9804
9808
|
/**
|
|
9809
|
+
* **Deprecated:**
|
|
9810
|
+
*
|
|
9805
9811
|
* Controls how much underlying clothing items inflate the current clothing item.
|
|
9806
9812
|
*
|
|
9807
9813
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -9844,6 +9850,8 @@ interface WrapLayer extends BaseWrap {
|
|
|
9844
9850
|
*/
|
|
9845
9851
|
readonly ReferenceOriginWorld: CFrame;
|
|
9846
9852
|
/**
|
|
9853
|
+
* **Deprecated:**
|
|
9854
|
+
*
|
|
9847
9855
|
* Allows slight shrinking/expanding of the resulting render mesh, without affecting any other layers.
|
|
9848
9856
|
*
|
|
9849
9857
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -9870,6 +9878,8 @@ interface WrapTarget extends BaseWrap {
|
|
|
9870
9878
|
*/
|
|
9871
9879
|
readonly _nominal_WrapTarget: unique symbol;
|
|
9872
9880
|
/**
|
|
9881
|
+
* **Deprecated:**
|
|
9882
|
+
*
|
|
9873
9883
|
* Defines how much the body mesh can be compressed by clothing.
|
|
9874
9884
|
*
|
|
9875
9885
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -12708,7 +12718,7 @@ interface AngularVelocity extends Constraint {
|
|
|
12708
12718
|
RelativeTo: Enum.ActuatorRelativeTo;
|
|
12709
12719
|
}
|
|
12710
12720
|
/**
|
|
12711
|
-
* Aligns two `BaseParts` with an animate-able kinematic or force-based joint.
|
|
12721
|
+
* Aligns two `BaseParts` with an animate-able kinematic or force-based joint that supports physical simulation (ragdoll, arm strength). The default joint type for R15 avatar rigs.
|
|
12712
12722
|
*
|
|
12713
12723
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint)
|
|
12714
12724
|
*/
|
|
@@ -15976,6 +15986,8 @@ interface DialogChoice extends Instance {
|
|
|
15976
15986
|
UserDialog: string;
|
|
15977
15987
|
}
|
|
15978
15988
|
/**
|
|
15989
|
+
* Maps the 15 phalanx joints of one hand (5 fingers, 3 joints each) and exposes forward- and inverse-kinematics helpers for controlling finger poses at runtime.
|
|
15990
|
+
*
|
|
15979
15991
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription)
|
|
15980
15992
|
*/
|
|
15981
15993
|
interface DigitsRigDescription extends Instance {
|
|
@@ -16237,7 +16249,7 @@ interface DigitsRigDescription extends Instance {
|
|
|
16237
16249
|
* - **ThreadSafety**: Unsafe
|
|
16238
16250
|
*
|
|
16239
16251
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#GetFingerControl)
|
|
16240
|
-
* @param this
|
|
16252
|
+
* @param this Maps the 15 phalanx joints of one hand (5 fingers, 3 joints each) and exposes forward- and inverse-kinematics helpers for controlling finger poses at runtime.
|
|
16241
16253
|
* @param fingerIndex
|
|
16242
16254
|
*/
|
|
16243
16255
|
GetFingerControl(this: DigitsRigDescription, fingerIndex: number): Vector3;
|
|
@@ -16245,7 +16257,7 @@ interface DigitsRigDescription extends Instance {
|
|
|
16245
16257
|
* - **ThreadSafety**: Unsafe
|
|
16246
16258
|
*
|
|
16247
16259
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#GetFingerTip)
|
|
16248
|
-
* @param this
|
|
16260
|
+
* @param this Maps the 15 phalanx joints of one hand (5 fingers, 3 joints each) and exposes forward- and inverse-kinematics helpers for controlling finger poses at runtime.
|
|
16249
16261
|
* @param fingerIndex
|
|
16250
16262
|
*/
|
|
16251
16263
|
GetFingerTip(this: DigitsRigDescription, fingerIndex: number): Vector3;
|
|
@@ -16253,7 +16265,7 @@ interface DigitsRigDescription extends Instance {
|
|
|
16253
16265
|
* - **ThreadSafety**: Unsafe
|
|
16254
16266
|
*
|
|
16255
16267
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#SetFingerControl)
|
|
16256
|
-
* @param this
|
|
16268
|
+
* @param this Maps the 15 phalanx joints of one hand (5 fingers, 3 joints each) and exposes forward- and inverse-kinematics helpers for controlling finger poses at runtime.
|
|
16257
16269
|
* @param fingerIndex
|
|
16258
16270
|
* @param control
|
|
16259
16271
|
*/
|
|
@@ -16262,7 +16274,7 @@ interface DigitsRigDescription extends Instance {
|
|
|
16262
16274
|
* - **ThreadSafety**: Unsafe
|
|
16263
16275
|
*
|
|
16264
16276
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#SetFingerTip)
|
|
16265
|
-
* @param this
|
|
16277
|
+
* @param this Maps the 15 phalanx joints of one hand (5 fingers, 3 joints each) and exposes forward- and inverse-kinematics helpers for controlling finger poses at runtime.
|
|
16266
16278
|
* @param fingerIndex
|
|
16267
16279
|
* @param point
|
|
16268
16280
|
*/
|
|
@@ -17005,6 +17017,12 @@ interface Decal extends FaceInstance {
|
|
|
17005
17017
|
* @deprecated
|
|
17006
17018
|
*/
|
|
17007
17019
|
readonly _nominal_Decal: unique symbol;
|
|
17020
|
+
/**
|
|
17021
|
+
* - **ThreadSafety**: ReadSafe
|
|
17022
|
+
*
|
|
17023
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#AutoLocalize)
|
|
17024
|
+
*/
|
|
17025
|
+
AutoLocalize: boolean;
|
|
17008
17026
|
/**
|
|
17009
17027
|
* The `Color3` tint of the `Decal`.
|
|
17010
17028
|
*
|
|
@@ -19207,6 +19225,8 @@ interface GuiButton extends GuiObject {
|
|
|
19207
19225
|
*/
|
|
19208
19226
|
readonly MouseButton2Up: RBXScriptSignal<(x: number, y: number) => void>;
|
|
19209
19227
|
/**
|
|
19228
|
+
* Fires when the button's "secondary" input is activated.
|
|
19229
|
+
*
|
|
19210
19230
|
* - **ThreadSafety**: Unsafe
|
|
19211
19231
|
*
|
|
19212
19232
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#SecondaryActivated)
|
|
@@ -20658,6 +20678,7 @@ interface VideoFrame extends GuiObject {
|
|
|
20658
20678
|
readonly _nominal_VideoFrame: unique symbol;
|
|
20659
20679
|
/**
|
|
20660
20680
|
* - **ThreadSafety**: ReadSafe
|
|
20681
|
+
* - **Tags**: Hidden
|
|
20661
20682
|
*
|
|
20662
20683
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#InternalVideoUsage)
|
|
20663
20684
|
*/
|
|
@@ -20681,6 +20702,7 @@ interface VideoFrame extends GuiObject {
|
|
|
20681
20702
|
Looped: boolean;
|
|
20682
20703
|
/**
|
|
20683
20704
|
* - **ThreadSafety**: ReadSafe
|
|
20705
|
+
* - **Tags**: Hidden
|
|
20684
20706
|
*
|
|
20685
20707
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#MaximumResolution)
|
|
20686
20708
|
*/
|
|
@@ -23775,10 +23797,13 @@ interface Humanoid extends Instance {
|
|
|
23775
23797
|
*/
|
|
23776
23798
|
GetLimb(this: Humanoid, part: Instance): Enum.Limb;
|
|
23777
23799
|
/**
|
|
23800
|
+
* Returns the current intended movement velocity of the Humanoid.
|
|
23801
|
+
*
|
|
23778
23802
|
* - **ThreadSafety**: Unsafe
|
|
23779
23803
|
*
|
|
23780
23804
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetMoveVelocity)
|
|
23781
23805
|
* @param this A special object that gives models the functionality of a character.
|
|
23806
|
+
* @returns A `Vector3` representing the Humanoid's intended movement velocity in world space.
|
|
23782
23807
|
*/
|
|
23783
23808
|
GetMoveVelocity(this: Humanoid): Vector3;
|
|
23784
23809
|
/**
|
|
@@ -24746,6 +24771,8 @@ interface HumanoidDescription extends Instance {
|
|
|
24746
24771
|
readonly EquippedEmotesChanged: RBXScriptSignal<(newEquippedEmotes: EquippedEmotes) => void>;
|
|
24747
24772
|
}
|
|
24748
24773
|
/**
|
|
24774
|
+
* Stores the joint mapping, T-pose, and per-joint properties for a 22-joint bipedal character rig. Joints may be `AnimationConstraint`, `Motor6D`, or `Bone` instances.
|
|
24775
|
+
*
|
|
24749
24776
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription)
|
|
24750
24777
|
*/
|
|
24751
24778
|
interface HumanoidRigDescription extends Instance {
|
|
@@ -25421,7 +25448,7 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25421
25448
|
* - **ThreadSafety**: Safe
|
|
25422
25449
|
*
|
|
25423
25450
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointFromName)
|
|
25424
|
-
* @param this
|
|
25451
|
+
* @param this Stores the joint mapping, T-pose, and per-joint properties for a 22-joint bipedal character rig. Joints may be `AnimationConstraint`, `Motor6D`, or `Bone` instances.
|
|
25425
25452
|
* @param name string
|
|
25426
25453
|
* @returns Instance
|
|
25427
25454
|
*/
|
|
@@ -25430,7 +25457,7 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25430
25457
|
* - **ThreadSafety**: Safe
|
|
25431
25458
|
*
|
|
25432
25459
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointNames)
|
|
25433
|
-
* @param this
|
|
25460
|
+
* @param this Stores the joint mapping, T-pose, and per-joint properties for a 22-joint bipedal character rig. Joints may be `AnimationConstraint`, `Motor6D`, or `Bone` instances.
|
|
25434
25461
|
* @returns Array
|
|
25435
25462
|
*/
|
|
25436
25463
|
GetJointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
@@ -25438,7 +25465,7 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25438
25465
|
* - **ThreadSafety**: Safe
|
|
25439
25466
|
*
|
|
25440
25467
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR15JointNames)
|
|
25441
|
-
* @param this
|
|
25468
|
+
* @param this Stores the joint mapping, T-pose, and per-joint properties for a 22-joint bipedal character rig. Joints may be `AnimationConstraint`, `Motor6D`, or `Bone` instances.
|
|
25442
25469
|
* @returns Array
|
|
25443
25470
|
*/
|
|
25444
25471
|
GetR15JointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
@@ -25446,7 +25473,7 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25446
25473
|
* - **ThreadSafety**: Safe
|
|
25447
25474
|
*
|
|
25448
25475
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR6JointNames)
|
|
25449
|
-
* @param this
|
|
25476
|
+
* @param this Stores the joint mapping, T-pose, and per-joint properties for a 22-joint bipedal character rig. Joints may be `AnimationConstraint`, `Motor6D`, or `Bone` instances.
|
|
25450
25477
|
* @returns Array
|
|
25451
25478
|
*/
|
|
25452
25479
|
GetR6JointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
@@ -25782,6 +25809,8 @@ interface InputAction extends Instance {
|
|
|
25782
25809
|
*/
|
|
25783
25810
|
Type: Enum.InputActionType;
|
|
25784
25811
|
/**
|
|
25812
|
+
* **Deprecated:** Use `InputBinding:Fire()` with a `Scriptable` binding instead.
|
|
25813
|
+
*
|
|
25785
25814
|
* Updates the `InputAction` to the given state and fires the appropriate signals.
|
|
25786
25815
|
*
|
|
25787
25816
|
* - **ThreadSafety**: Unsafe
|
|
@@ -25954,6 +25983,8 @@ interface InputBinding extends Instance {
|
|
|
25954
25983
|
*/
|
|
25955
25984
|
SecondaryModifier: Enum.KeyCode;
|
|
25956
25985
|
/**
|
|
25986
|
+
* Determines whether this binding is triggered by hardware input or programmatically via `Fire()`.
|
|
25987
|
+
*
|
|
25957
25988
|
* - **ThreadSafety**: ReadSafe
|
|
25958
25989
|
*
|
|
25959
25990
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Type)
|
|
@@ -26727,7 +26758,7 @@ interface Motor extends JointInstance {
|
|
|
26727
26758
|
SetDesiredAngle(this: Motor, value: number): void;
|
|
26728
26759
|
}
|
|
26729
26760
|
/**
|
|
26730
|
-
* Creates an animatable joint between two `BaseParts`.
|
|
26761
|
+
* Creates an animatable joint between two `BaseParts`. Superseded by `AnimationConstraint` for avatar/character rigs. Motor6D is no longer used by default for player characters when `AvatarJointUpgrade` is enabled.
|
|
26731
26762
|
*
|
|
26732
26763
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Motor6D)
|
|
26733
26764
|
*/
|
|
@@ -27130,8 +27161,6 @@ interface LanguageService extends Instance {
|
|
|
27130
27161
|
* - **Tags**: Yields
|
|
27131
27162
|
*
|
|
27132
27163
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LanguageService#GetCapabilitiesUsedInPackageAsync)
|
|
27133
|
-
* @param this
|
|
27134
|
-
* @param instances
|
|
27135
27164
|
*/
|
|
27136
27165
|
GetCapabilitiesUsedInPackageAsync(this: LanguageService, instances: Array<Instance>): object;
|
|
27137
27166
|
}
|
|
@@ -27585,8 +27614,6 @@ interface LiveSyncService extends Instance {
|
|
|
27585
27614
|
* - **ThreadSafety**: Unsafe
|
|
27586
27615
|
*
|
|
27587
27616
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LiveSyncService#GetSyncState)
|
|
27588
|
-
* @param this
|
|
27589
|
-
* @param instance
|
|
27590
27617
|
*/
|
|
27591
27618
|
GetSyncState(this: LiveSyncService, instance: Instance): unknown;
|
|
27592
27619
|
/**
|
|
@@ -30862,7 +30889,7 @@ interface BasePart extends PVInstance {
|
|
|
30862
30889
|
*/
|
|
30863
30890
|
ApplyImpulseAtPosition(this: BasePart, impulse: Vector3, position: Vector3): void;
|
|
30864
30891
|
/**
|
|
30865
|
-
* **Deprecated:**
|
|
30892
|
+
* **Deprecated:** This method is deprecated. To break specific joints, iterate over the part's connections using `BasePart:GetJoints()` and call `Instance:Destroy()` on the joints you want to remove.
|
|
30866
30893
|
*
|
|
30867
30894
|
* Breaks any surface connection with any adjacent part, including `Weld` and other `JointInstance`.
|
|
30868
30895
|
*
|
|
@@ -32057,7 +32084,7 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
32057
32084
|
*
|
|
32058
32085
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MeshPart#DoubleSided)
|
|
32059
32086
|
*/
|
|
32060
|
-
|
|
32087
|
+
DoubleSided: boolean;
|
|
32061
32088
|
/**
|
|
32062
32089
|
* **Deprecated:**
|
|
32063
32090
|
*
|
|
@@ -35808,7 +35835,7 @@ interface Player extends Instance {
|
|
|
35808
35835
|
/**
|
|
35809
35836
|
* **Deprecated:** This method has been superseded by `GetFriendsOnlineAsync()`.
|
|
35810
35837
|
*
|
|
35811
|
-
* Returns a dictionary of online friends.
|
|
35838
|
+
* Returns a dictionary of online friends.
|
|
35812
35839
|
*
|
|
35813
35840
|
* - **ThreadSafety**: Unsafe
|
|
35814
35841
|
* - **Tags**: Yields
|
|
@@ -35843,7 +35870,7 @@ interface Player extends Instance {
|
|
|
35843
35870
|
*/
|
|
35844
35871
|
GetFriendsWhoPlayedAsync(this: Player): Array<unknown>;
|
|
35845
35872
|
/**
|
|
35846
|
-
* **Deprecated:**
|
|
35873
|
+
* **Deprecated:** This method has been superseded by `GetRankInGroupAsync()`.
|
|
35847
35874
|
*
|
|
35848
35875
|
* Returns the player's rank in the group as an integer.
|
|
35849
35876
|
*
|
|
@@ -35859,6 +35886,8 @@ interface Player extends Instance {
|
|
|
35859
35886
|
*/
|
|
35860
35887
|
GetRankInGroup(this: Player, groupId: number): number;
|
|
35861
35888
|
/**
|
|
35889
|
+
* **Deprecated:** This method only returns a single role rank and may produce arbitrary results when a user holds multiple roles. Use `GroupService:GetRolesInGroupAsync()` instead, which returns all roles.
|
|
35890
|
+
*
|
|
35862
35891
|
* Returns the player's rank in the group as an integer.
|
|
35863
35892
|
*
|
|
35864
35893
|
* - **ThreadSafety**: Unsafe
|
|
@@ -35889,6 +35918,8 @@ interface Player extends Instance {
|
|
|
35889
35918
|
*/
|
|
35890
35919
|
GetRoleInGroup(this: Player, groupId: number): string;
|
|
35891
35920
|
/**
|
|
35921
|
+
* **Deprecated:** This method only returns a single role name and may produce arbitrary results when a user holds multiple roles. Use `GroupService:GetRolesInGroupAsync()` instead, which returns all roles.
|
|
35922
|
+
*
|
|
35892
35923
|
* Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
|
|
35893
35924
|
*
|
|
35894
35925
|
* - **ThreadSafety**: Unsafe
|
|
@@ -36796,6 +36827,13 @@ interface Players extends Instance {
|
|
|
36796
36827
|
* @returns The name of a user with the specified `Player.UserId`.
|
|
36797
36828
|
*/
|
|
36798
36829
|
GetNameFromUserIdAsync(this: Players, userId: User): string;
|
|
36830
|
+
/**
|
|
36831
|
+
* - **ThreadSafety**: Unsafe
|
|
36832
|
+
* - **Tags**: Yields
|
|
36833
|
+
*
|
|
36834
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetProfileConfigurationFromUserIdAsync)
|
|
36835
|
+
*/
|
|
36836
|
+
GetProfileConfigurationFromUserIdAsync(this: Players, userId: User): object;
|
|
36799
36837
|
/**
|
|
36800
36838
|
* Sends a query to the Roblox website for the `userId` of an account with a given username.
|
|
36801
36839
|
*
|
|
@@ -41798,6 +41836,8 @@ interface StarterPlayer extends Instance {
|
|
|
41798
41836
|
*/
|
|
41799
41837
|
CharacterWalkSpeed: number;
|
|
41800
41838
|
/**
|
|
41839
|
+
* Controls whether the character uses the classic death behavior when the Humanoid's health reaches zero.
|
|
41840
|
+
*
|
|
41801
41841
|
* - **ThreadSafety**: ReadSafe
|
|
41802
41842
|
*
|
|
41803
41843
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#ClassicDeath)
|
|
@@ -41868,6 +41908,8 @@ interface StarterPlayer extends Instance {
|
|
|
41868
41908
|
*/
|
|
41869
41909
|
LoadCharacterAppearance: boolean;
|
|
41870
41910
|
/**
|
|
41911
|
+
* Sets the character controller mode used by the player's character.
|
|
41912
|
+
*
|
|
41871
41913
|
* - **ThreadSafety**: ReadSafe
|
|
41872
41914
|
*
|
|
41873
41915
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#LuaCharacterController)
|
|
@@ -43875,6 +43917,18 @@ interface TestService extends Instance {
|
|
|
43875
43917
|
* @param line
|
|
43876
43918
|
*/
|
|
43877
43919
|
Fail(this: TestService, description: string, source?: Instance, line?: number): void;
|
|
43920
|
+
/**
|
|
43921
|
+
* - **ThreadSafety**: Unsafe
|
|
43922
|
+
*
|
|
43923
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#GetTestControlSchema)
|
|
43924
|
+
*/
|
|
43925
|
+
GetTestControlSchema(this: TestService, providerName: string): object;
|
|
43926
|
+
/**
|
|
43927
|
+
* - **ThreadSafety**: Unsafe
|
|
43928
|
+
*
|
|
43929
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#GetTestControls)
|
|
43930
|
+
*/
|
|
43931
|
+
GetTestControls(this: TestService, providerName: string): object;
|
|
43878
43932
|
/**
|
|
43879
43933
|
* Prints `TestService:` followed by a string to the output in blue text.
|
|
43880
43934
|
*
|
|
@@ -43908,6 +43962,12 @@ interface TestService extends Instance {
|
|
|
43908
43962
|
* @param line
|
|
43909
43963
|
*/
|
|
43910
43964
|
Require(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
|
|
43965
|
+
/**
|
|
43966
|
+
* - **ThreadSafety**: Unsafe
|
|
43967
|
+
*
|
|
43968
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#ResetTestControl)
|
|
43969
|
+
*/
|
|
43970
|
+
ResetTestControl(this: TestService, providerName: string, controlName: string): void;
|
|
43911
43971
|
/**
|
|
43912
43972
|
* - **ThreadSafety**: Unsafe
|
|
43913
43973
|
*
|
|
@@ -43915,6 +43975,12 @@ interface TestService extends Instance {
|
|
|
43915
43975
|
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
43916
43976
|
*/
|
|
43917
43977
|
ScopeTime(this: TestService): object;
|
|
43978
|
+
/**
|
|
43979
|
+
* - **ThreadSafety**: Unsafe
|
|
43980
|
+
*
|
|
43981
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#SetTestControl)
|
|
43982
|
+
*/
|
|
43983
|
+
SetTestControl(this: TestService, providerName: string, controlName: string, value: unknown): void;
|
|
43918
43984
|
/**
|
|
43919
43985
|
* - **ThreadSafety**: Unsafe
|
|
43920
43986
|
*
|
|
@@ -43977,6 +44043,20 @@ interface TestService extends Instance {
|
|
|
43977
44043
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RequestValidationAsync)
|
|
43978
44044
|
*/
|
|
43979
44045
|
RequestValidationAsync(this: TestService, artifactType: string, artifactName: string): unknown;
|
|
44046
|
+
/**
|
|
44047
|
+
* - **ThreadSafety**: Unsafe
|
|
44048
|
+
* - **Tags**: Yields
|
|
44049
|
+
*
|
|
44050
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#StartVideoCaptureAsync)
|
|
44051
|
+
*/
|
|
44052
|
+
StartVideoCaptureAsync(this: TestService, artifactName?: string, options?: object): unknown;
|
|
44053
|
+
/**
|
|
44054
|
+
* - **ThreadSafety**: Unsafe
|
|
44055
|
+
* - **Tags**: Yields
|
|
44056
|
+
*
|
|
44057
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#StopVideoCaptureAsync)
|
|
44058
|
+
*/
|
|
44059
|
+
StopVideoCaptureAsync(this: TestService): unknown;
|
|
43980
44060
|
/**
|
|
43981
44061
|
* Fires when the server should collect a conditional test result.
|
|
43982
44062
|
*
|
|
@@ -47879,14 +47959,15 @@ interface UserInputService extends Instance {
|
|
|
47879
47959
|
*/
|
|
47880
47960
|
GetNavigationGamepads(this: UserInputService): Array<Enum.UserInputType>;
|
|
47881
47961
|
/**
|
|
47882
|
-
* Returns a string representing a key the user should press in order to input a given `KeyCode
|
|
47962
|
+
* Returns a string representing a key the user should press in order to input a given `KeyCode`, optionally in an abbreviated format.
|
|
47883
47963
|
*
|
|
47884
47964
|
* - **ThreadSafety**: Unsafe
|
|
47885
47965
|
*
|
|
47886
47966
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetStringForKeyCode)
|
|
47887
47967
|
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
47888
|
-
* @param keyCode
|
|
47889
|
-
* @param format
|
|
47968
|
+
* @param keyCode The `KeyCode` to get the display string for.
|
|
47969
|
+
* @param format An `KeyCodeStringFormat` value that controls the format of the returned string. Defaults to `KeyCodeStringFormat.Default`. Pass `KeyCodeStringFormat.Abbreviated` to get shortened labels suitable for compact UI such as `"Bksp"`, `"LCtrl"`, or `"Esc"`.
|
|
47970
|
+
* @returns A string representing the key the user should press for the given key code, formatted according to the specified `KeyCodeStringFormat`.
|
|
47890
47971
|
*/
|
|
47891
47972
|
GetStringForKeyCode(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>, format?: CastsToEnum<Enum.KeyCodeStringFormat>): string;
|
|
47892
47973
|
/**
|
|
@@ -49134,6 +49215,7 @@ interface VideoPlayer extends Instance {
|
|
|
49134
49215
|
readonly _nominal_VideoPlayer: unique symbol;
|
|
49135
49216
|
/**
|
|
49136
49217
|
* - **ThreadSafety**: ReadSafe
|
|
49218
|
+
* - **Tags**: Hidden
|
|
49137
49219
|
*
|
|
49138
49220
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#InternalVideoUsage)
|
|
49139
49221
|
*/
|
|
@@ -49166,6 +49248,7 @@ interface VideoPlayer extends Instance {
|
|
|
49166
49248
|
Looping: boolean;
|
|
49167
49249
|
/**
|
|
49168
49250
|
* - **ThreadSafety**: ReadSafe
|
|
49251
|
+
* - **Tags**: Hidden
|
|
49169
49252
|
*
|
|
49170
49253
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#MaximumResolution)
|
|
49171
49254
|
*/
|
|
@@ -49654,15 +49737,12 @@ interface WebSocketClient extends Instance {
|
|
|
49654
49737
|
* - **ThreadSafety**: Unsafe
|
|
49655
49738
|
*
|
|
49656
49739
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Close)
|
|
49657
|
-
* @param this
|
|
49658
49740
|
*/
|
|
49659
49741
|
Close(this: WebSocketClient): void;
|
|
49660
49742
|
/**
|
|
49661
49743
|
* - **ThreadSafety**: Unsafe
|
|
49662
49744
|
*
|
|
49663
49745
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Send)
|
|
49664
|
-
* @param this
|
|
49665
|
-
* @param data
|
|
49666
49746
|
*/
|
|
49667
49747
|
Send(this: WebSocketClient, data: string): void;
|
|
49668
49748
|
/**
|
|
@@ -49702,8 +49782,6 @@ interface WebSocketService extends Instance {
|
|
|
49702
49782
|
* - **ThreadSafety**: Unsafe
|
|
49703
49783
|
*
|
|
49704
49784
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketService#CreateClient)
|
|
49705
|
-
* @param this
|
|
49706
|
-
* @param uri
|
|
49707
49785
|
*/
|
|
49708
49786
|
CreateClient(this: WebSocketService, uri: string): WebSocketClient;
|
|
49709
49787
|
}
|
|
@@ -2704,6 +2704,8 @@ interface WrapLayer extends BaseWrap {
|
|
|
2704
2704
|
*/
|
|
2705
2705
|
set ReferenceOrigin(value: CFrame);
|
|
2706
2706
|
/**
|
|
2707
|
+
* **Deprecated:**
|
|
2708
|
+
*
|
|
2707
2709
|
* Allows slight shrinking/expanding of the resulting render mesh, without affecting any other layers.
|
|
2708
2710
|
*
|
|
2709
2711
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -2730,6 +2732,8 @@ interface WrapTarget extends BaseWrap {
|
|
|
2730
2732
|
*/
|
|
2731
2733
|
readonly _nominal_WrapTarget: unique symbol;
|
|
2732
2734
|
/**
|
|
2735
|
+
* **Deprecated:**
|
|
2736
|
+
*
|
|
2733
2737
|
* Defines how much the body mesh can be compressed by clothing.
|
|
2734
2738
|
*
|
|
2735
2739
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -3658,7 +3662,7 @@ interface AngularVelocity extends Constraint {
|
|
|
3658
3662
|
readonly _nominal_AngularVelocity: unique symbol;
|
|
3659
3663
|
}
|
|
3660
3664
|
/**
|
|
3661
|
-
* Aligns two `BaseParts` with an animate-able kinematic or force-based joint.
|
|
3665
|
+
* Aligns two `BaseParts` with an animate-able kinematic or force-based joint that supports physical simulation (ragdoll, arm strength). The default joint type for R15 avatar rigs.
|
|
3662
3666
|
*
|
|
3663
3667
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint)
|
|
3664
3668
|
*/
|
|
@@ -4826,6 +4830,8 @@ interface DialogChoice extends Instance {
|
|
|
4826
4830
|
readonly _nominal_DialogChoice: unique symbol;
|
|
4827
4831
|
}
|
|
4828
4832
|
/**
|
|
4833
|
+
* Maps the 15 phalanx joints of one hand (5 fingers, 3 joints each) and exposes forward- and inverse-kinematics helpers for controlling finger poses at runtime.
|
|
4834
|
+
*
|
|
4829
4835
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription)
|
|
4830
4836
|
*/
|
|
4831
4837
|
interface DigitsRigDescription extends Instance {
|
|
@@ -7304,6 +7310,8 @@ interface HumanoidDescription extends Instance {
|
|
|
7304
7310
|
readonly _nominal_HumanoidDescription: unique symbol;
|
|
7305
7311
|
}
|
|
7306
7312
|
/**
|
|
7313
|
+
* Stores the joint mapping, T-pose, and per-joint properties for a 22-joint bipedal character rig. Joints may be `AnimationConstraint`, `Motor6D`, or `Bone` instances.
|
|
7314
|
+
*
|
|
7307
7315
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription)
|
|
7308
7316
|
*/
|
|
7309
7317
|
interface HumanoidRigDescription extends Instance {
|
|
@@ -7789,7 +7797,7 @@ interface Motor extends JointInstance {
|
|
|
7789
7797
|
readonly _nominal_Motor: unique symbol;
|
|
7790
7798
|
}
|
|
7791
7799
|
/**
|
|
7792
|
-
* Creates an animatable joint between two `BaseParts`.
|
|
7800
|
+
* Creates an animatable joint between two `BaseParts`. Superseded by `AnimationConstraint` for avatar/character rigs. Motor6D is no longer used by default for player characters when `AvatarJointUpgrade` is enabled.
|
|
7793
7801
|
*
|
|
7794
7802
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Motor6D)
|
|
7795
7803
|
*/
|
|
@@ -9388,14 +9396,6 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
9388
9396
|
* @deprecated
|
|
9389
9397
|
*/
|
|
9390
9398
|
readonly _nominal_MeshPart: unique symbol;
|
|
9391
|
-
/**
|
|
9392
|
-
* Determines whether to render both faces of polygons in the mesh.
|
|
9393
|
-
*
|
|
9394
|
-
* - **ThreadSafety**: ReadSafe
|
|
9395
|
-
*
|
|
9396
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MeshPart#DoubleSided)
|
|
9397
|
-
*/
|
|
9398
|
-
set DoubleSided(value: boolean);
|
|
9399
9399
|
/**
|
|
9400
9400
|
* The level of detail used to render the `MeshPart`.
|
|
9401
9401
|
*
|
|
@@ -13405,17 +13405,6 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
13405
13405
|
* @returns A table containing information about the jobs performed by the task scheduler, see above for the format.
|
|
13406
13406
|
*/
|
|
13407
13407
|
GetJobsInfo(this: DataModel): Array<unknown>;
|
|
13408
|
-
/**
|
|
13409
|
-
* Returns an array of `Instances` associated with the given content URL.
|
|
13410
|
-
*
|
|
13411
|
-
* - **ThreadSafety**: Unsafe
|
|
13412
|
-
*
|
|
13413
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#GetObjects)
|
|
13414
|
-
* @param this The root of Roblox's parent-child hierarchy. Its direct children are services, such as `Workspace` and `Lighting`, that act as the fundamental components of a Roblox game.
|
|
13415
|
-
* @param url The given content URL.
|
|
13416
|
-
* @returns An array of `Instances` associated with the content URL.
|
|
13417
|
-
*/
|
|
13418
|
-
GetObjects(this: DataModel, url: ContentId): Array<Instance>;
|
|
13419
13408
|
/**
|
|
13420
13409
|
* Sets the `DataModel.PlaceId` of the current game instance.
|
|
13421
13410
|
*
|
|
@@ -13436,6 +13425,17 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
13436
13425
|
* @param universeId The ID to set the `DataModel.GameId` to.
|
|
13437
13426
|
*/
|
|
13438
13427
|
SetUniverseId(this: DataModel, universeId: number): void;
|
|
13428
|
+
/**
|
|
13429
|
+
* Returns an array of `Instances` associated with the given content URL.
|
|
13430
|
+
*
|
|
13431
|
+
* - **ThreadSafety**: Unsafe
|
|
13432
|
+
*
|
|
13433
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#GetObjects)
|
|
13434
|
+
* @param this The root of Roblox's parent-child hierarchy. Its direct children are services, such as `Workspace` and `Lighting`, that act as the fundamental components of a Roblox game.
|
|
13435
|
+
* @param url The given content URL.
|
|
13436
|
+
* @returns An array of `Instances` associated with the content URL.
|
|
13437
|
+
*/
|
|
13438
|
+
GetObjects(this: DataModel, url: ContentId): Array<Instance>;
|
|
13439
13439
|
}
|
|
13440
13440
|
/**
|
|
13441
13441
|
* The abstract class for settings database classes.
|
|
@@ -6789,6 +6789,8 @@ declare namespace Enum {
|
|
|
6789
6789
|
}
|
|
6790
6790
|
export const Featured: Featured;
|
|
6791
6791
|
/**
|
|
6792
|
+
* **Deprecated:**
|
|
6793
|
+
*
|
|
6792
6794
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#Collectibles)
|
|
6793
6795
|
*/
|
|
6794
6796
|
export interface Collectibles extends globalThis.EnumItem {
|
|
@@ -17922,7 +17924,7 @@ declare namespace Enum {
|
|
|
17922
17924
|
}
|
|
17923
17925
|
export type InputActionType = InputActionType.Bool | InputActionType.Direction1D | InputActionType.Direction2D | InputActionType.Direction3D | InputActionType.ViewportPosition;
|
|
17924
17926
|
/**
|
|
17925
|
-
* This enum is used by `InputBinding.
|
|
17927
|
+
* This enum is used by `InputBinding.Type` to determine whether the binding responds to hardware input or is driven programmatically.
|
|
17926
17928
|
*
|
|
17927
17929
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputBindingType)
|
|
17928
17930
|
*/
|
|
@@ -21484,10 +21486,14 @@ declare namespace Enum {
|
|
|
21484
21486
|
}
|
|
21485
21487
|
export type KeyCode = KeyCode.Unknown | KeyCode.Backspace | KeyCode.Tab | KeyCode.Clear | KeyCode.Return | KeyCode.Pause | KeyCode.Escape | KeyCode.Space | KeyCode.QuotedDouble | KeyCode.Hash | KeyCode.Dollar | KeyCode.Percent | KeyCode.Ampersand | KeyCode.Quote | KeyCode.LeftParenthesis | KeyCode.RightParenthesis | KeyCode.Asterisk | KeyCode.Plus | KeyCode.Comma | KeyCode.Minus | KeyCode.Period | KeyCode.Slash | KeyCode.Zero | KeyCode.One | KeyCode.Two | KeyCode.Three | KeyCode.Four | KeyCode.Five | KeyCode.Six | KeyCode.Seven | KeyCode.Eight | KeyCode.Nine | KeyCode.Colon | KeyCode.Semicolon | KeyCode.LessThan | KeyCode.Equals | KeyCode.GreaterThan | KeyCode.Question | KeyCode.At | KeyCode.LeftBracket | KeyCode.BackSlash | KeyCode.RightBracket | KeyCode.Caret | KeyCode.Underscore | KeyCode.Backquote | KeyCode.A | KeyCode.B | KeyCode.C | KeyCode.D | KeyCode.E | KeyCode.F | KeyCode.G | KeyCode.H | KeyCode.I | KeyCode.J | KeyCode.K | KeyCode.L | KeyCode.M | KeyCode.N | KeyCode.O | KeyCode.P | KeyCode.Q | KeyCode.R | KeyCode.S | KeyCode.T | KeyCode.U | KeyCode.V | KeyCode.W | KeyCode.X | KeyCode.Y | KeyCode.Z | KeyCode.LeftCurly | KeyCode.Pipe | KeyCode.RightCurly | KeyCode.Tilde | KeyCode.Delete | KeyCode.World0 | KeyCode.World1 | KeyCode.World2 | KeyCode.World3 | KeyCode.World4 | KeyCode.World5 | KeyCode.World6 | KeyCode.World7 | KeyCode.World8 | KeyCode.World9 | KeyCode.World10 | KeyCode.World11 | KeyCode.World12 | KeyCode.World13 | KeyCode.World14 | KeyCode.World15 | KeyCode.World16 | KeyCode.World17 | KeyCode.World18 | KeyCode.World19 | KeyCode.World20 | KeyCode.World21 | KeyCode.World22 | KeyCode.World23 | KeyCode.World24 | KeyCode.World25 | KeyCode.World26 | KeyCode.World27 | KeyCode.World28 | KeyCode.World29 | KeyCode.World30 | KeyCode.World31 | KeyCode.World32 | KeyCode.World33 | KeyCode.World34 | KeyCode.World35 | KeyCode.World36 | KeyCode.World37 | KeyCode.World38 | KeyCode.World39 | KeyCode.World40 | KeyCode.World41 | KeyCode.World42 | KeyCode.World43 | KeyCode.World44 | KeyCode.World45 | KeyCode.World46 | KeyCode.World47 | KeyCode.World48 | KeyCode.World49 | KeyCode.World50 | KeyCode.World51 | KeyCode.World52 | KeyCode.World53 | KeyCode.World54 | KeyCode.World55 | KeyCode.World56 | KeyCode.World57 | KeyCode.World58 | KeyCode.World59 | KeyCode.World60 | KeyCode.World61 | KeyCode.World62 | KeyCode.World63 | KeyCode.World64 | KeyCode.World65 | KeyCode.World66 | KeyCode.World67 | KeyCode.World68 | KeyCode.World69 | KeyCode.World70 | KeyCode.World71 | KeyCode.World72 | KeyCode.World73 | KeyCode.World74 | KeyCode.World75 | KeyCode.World76 | KeyCode.World77 | KeyCode.World78 | KeyCode.World79 | KeyCode.World80 | KeyCode.World81 | KeyCode.World82 | KeyCode.World83 | KeyCode.World84 | KeyCode.World85 | KeyCode.World86 | KeyCode.World87 | KeyCode.World88 | KeyCode.World89 | KeyCode.World90 | KeyCode.World91 | KeyCode.World92 | KeyCode.World93 | KeyCode.World94 | KeyCode.World95 | KeyCode.KeypadZero | KeyCode.KeypadOne | KeyCode.KeypadTwo | KeyCode.KeypadThree | KeyCode.KeypadFour | KeyCode.KeypadFive | KeyCode.KeypadSix | KeyCode.KeypadSeven | KeyCode.KeypadEight | KeyCode.KeypadNine | KeyCode.KeypadPeriod | KeyCode.KeypadDivide | KeyCode.KeypadMultiply | KeyCode.KeypadMinus | KeyCode.KeypadPlus | KeyCode.KeypadEnter | KeyCode.KeypadEquals | KeyCode.Up | KeyCode.Down | KeyCode.Right | KeyCode.Left | KeyCode.Insert | KeyCode.Home | KeyCode.End | KeyCode.PageUp | KeyCode.PageDown | KeyCode.F1 | KeyCode.F2 | KeyCode.F3 | KeyCode.F4 | KeyCode.F5 | KeyCode.F6 | KeyCode.F7 | KeyCode.F8 | KeyCode.F9 | KeyCode.F10 | KeyCode.F11 | KeyCode.F12 | KeyCode.F13 | KeyCode.F14 | KeyCode.F15 | KeyCode.NumLock | KeyCode.CapsLock | KeyCode.ScrollLock | KeyCode.RightShift | KeyCode.LeftShift | KeyCode.RightControl | KeyCode.LeftControl | KeyCode.RightAlt | KeyCode.LeftAlt | KeyCode.RightMeta | KeyCode.LeftMeta | KeyCode.LeftSuper | KeyCode.RightSuper | KeyCode.Mode | KeyCode.Compose | KeyCode.Help | KeyCode.Print | KeyCode.SysReq | KeyCode.Break | KeyCode.Menu | KeyCode.Power | KeyCode.Euro | KeyCode.Undo | KeyCode.ButtonX | KeyCode.ButtonY | KeyCode.ButtonA | KeyCode.ButtonB | KeyCode.ButtonR1 | KeyCode.ButtonL1 | KeyCode.ButtonR2 | KeyCode.ButtonL2 | KeyCode.ButtonR3 | KeyCode.ButtonL3 | KeyCode.ButtonStart | KeyCode.ButtonSelect | KeyCode.DPadLeft | KeyCode.DPadRight | KeyCode.DPadUp | KeyCode.DPadDown | KeyCode.Thumbstick1 | KeyCode.Thumbstick2 | KeyCode.Thumbstick1Up | KeyCode.Thumbstick1Down | KeyCode.Thumbstick1Left | KeyCode.Thumbstick1Right | KeyCode.Thumbstick2Up | KeyCode.Thumbstick2Down | KeyCode.Thumbstick2Left | KeyCode.Thumbstick2Right | KeyCode.MouseLeftButton | KeyCode.MouseRightButton | KeyCode.MouseMiddleButton | KeyCode.MouseBackButton | KeyCode.MouseNoButton | KeyCode.MouseX | KeyCode.MouseY | KeyCode.MousePosition | KeyCode.TouchPosition | KeyCode.MouseWheel | KeyCode.TrackpadPan | KeyCode.TrackpadPinch | KeyCode.MouseDelta | KeyCode.TouchDelta | KeyCode.TouchPinch;
|
|
21486
21488
|
/**
|
|
21489
|
+
* Determines the string format returned by `UserInputService:GetStringForKeyCode()`.
|
|
21490
|
+
*
|
|
21487
21491
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCodeStringFormat)
|
|
21488
21492
|
*/
|
|
21489
21493
|
export namespace KeyCodeStringFormat {
|
|
21490
21494
|
/**
|
|
21495
|
+
* Default behavior which returns the full key string, for example `"LeftControl"`, `"Backspace"`, or `"Escape"`.
|
|
21496
|
+
*
|
|
21491
21497
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCodeStringFormat#Default)
|
|
21492
21498
|
*/
|
|
21493
21499
|
export interface Default extends globalThis.EnumItem {
|
|
@@ -21497,6 +21503,8 @@ declare namespace Enum {
|
|
|
21497
21503
|
}
|
|
21498
21504
|
export const Default: Default;
|
|
21499
21505
|
/**
|
|
21506
|
+
* Returns a shortened key string when available, for example `"LCtrl"`, `"Bksp"`, or `"Esc"`.
|
|
21507
|
+
*
|
|
21500
21508
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCodeStringFormat#Abbreviated)
|
|
21501
21509
|
*/
|
|
21502
21510
|
export interface Abbreviated extends globalThis.EnumItem {
|
package/include/lua.d.ts
CHANGED
|
@@ -460,6 +460,21 @@ declare namespace math {
|
|
|
460
460
|
/** The value HUGE_VAL, a value larger than or equal to any other numerical value. */
|
|
461
461
|
const huge: number;
|
|
462
462
|
|
|
463
|
+
/** The value of Euler's number, e. */
|
|
464
|
+
const e: number;
|
|
465
|
+
|
|
466
|
+
/** A NaN value, as defined by the IEEE 754 standard. Comparing directly to `math.nan` will always return false; use `math.isnan()` instead. */
|
|
467
|
+
const nan: number;
|
|
468
|
+
|
|
469
|
+
/** The value of the golden ratio. */
|
|
470
|
+
const phi: number;
|
|
471
|
+
|
|
472
|
+
/** The value of the square root of 2. */
|
|
473
|
+
const sqrt2: number;
|
|
474
|
+
|
|
475
|
+
/** The value of tau, which is defined as `2 * math.pi` */
|
|
476
|
+
const tau: number;
|
|
477
|
+
|
|
463
478
|
/** Returns the absolute value of x. */
|
|
464
479
|
function abs(n: number): number;
|
|
465
480
|
|