@rbxts/types 1.0.557 → 1.0.561
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.
|
@@ -126,7 +126,6 @@ interface CreatableInstances {
|
|
|
126
126
|
BallSocketConstraint: BallSocketConstraint;
|
|
127
127
|
Beam: Beam;
|
|
128
128
|
BillboardGui: BillboardGui;
|
|
129
|
-
BinaryStringValue: BinaryStringValue;
|
|
130
129
|
BindableEvent: BindableEvent;
|
|
131
130
|
BindableFunction: BindableFunction;
|
|
132
131
|
BlockMesh: BlockMesh;
|
|
@@ -1131,7 +1130,7 @@ interface Accessory extends Accoutrement {
|
|
|
1131
1130
|
*/
|
|
1132
1131
|
readonly _nominal_Accessory: unique symbol;
|
|
1133
1132
|
/**
|
|
1134
|
-
* Specifies the AccessoryType of the Accessory. Will be `Enum/AccessoryType|AccessoryType.Unknown` unless the Accessory has been equipped through the player spawning process or [Humanoid:ApplyDescription](https://developer.roblox.com/en-us/api-reference/function/Humanoid/ApplyDescription).
|
|
1133
|
+
* Specifies the AccessoryType of the Accessory. Will be `Enum/AccessoryType|AccessoryType.Unknown` unless the Accessory has been equipped through the player spawning process or [Humanoid:ApplyDescription](https://developer.roblox.com/en-us/api-reference/function/Humanoid/ApplyDescription). If available on the Avatar shop, the Accessory item is categorized by the set [AccessoryType](https://developer.roblox.com/en-us/api-reference/enum/AccessoryType) (for example, “Hat” or “Face”).
|
|
1135
1134
|
*/
|
|
1136
1135
|
readonly AccessoryType: Enum.AccessoryType;
|
|
1137
1136
|
}
|
|
@@ -1499,7 +1498,7 @@ interface CurveAnimation extends AnimationClip {
|
|
|
1499
1498
|
*
|
|
1500
1499
|
* In some cases the developer may wish to download the KeyframeSequence corresponding to an existing uploaded Animation. This can be done so using [KeyframeSequenceProvider:GetKeyframeSequenceAsync](https://developer.roblox.com/en-us/api-reference/function/KeyframeSequenceProvider/GetKeyframeSequenceAsync).
|
|
1501
1500
|
*/
|
|
1502
|
-
interface KeyframeSequence extends
|
|
1501
|
+
interface KeyframeSequence extends AnimationClip {
|
|
1503
1502
|
/**
|
|
1504
1503
|
* **DO NOT USE!**
|
|
1505
1504
|
*
|
|
@@ -2962,12 +2961,16 @@ interface Tool extends BackpackItem {
|
|
|
2962
2961
|
/**
|
|
2963
2962
|
* The Equipped event fires when a player when a player takes a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) out of their [Backpack](https://developer.roblox.com/en-us/api-reference/class/Backpack) to use. This event can be used to determine when a player stops using and puts a tool away.
|
|
2964
2963
|
*
|
|
2964
|
+
* This event does not fire when [Tool.RequiresHandle](https://developer.roblox.com/en-us/api-reference/property/Tool/RequiresHandle) is enabled and no handle is present.
|
|
2965
|
+
*
|
|
2965
2966
|
* The opposite of this event, [Tool.Unequipped](https://developer.roblox.com/en-us/api-reference/event/Tool/Unequipped), can be used alongside this event to determine unequips a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) by putting in back in their backpack.
|
|
2966
2967
|
*/
|
|
2967
2968
|
readonly Equipped: RBXScriptSignal<(mouse: Mouse) => void>;
|
|
2968
2969
|
/**
|
|
2969
2970
|
* The Unequipped event fires when a player unequips a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) by putting in back in their [Backpack](https://developer.roblox.com/en-us/api-reference/class/Backpack). This event can be used to determine when a player stops using and puts a tool away.
|
|
2970
2971
|
*
|
|
2972
|
+
* This event does not fire when [Tool.RequiresHandle](https://developer.roblox.com/en-us/api-reference/property/Tool/RequiresHandle) is enabled and no handle is present.
|
|
2973
|
+
*
|
|
2971
2974
|
* The opposite of this event, [Tool.Equipped](https://developer.roblox.com/en-us/api-reference/event/Tool/Equipped), can be used alongside this event to determine when a player takes a tool out of their backpack to use.
|
|
2972
2975
|
*
|
|
2973
2976
|
* The example shown below will print “A tool was unequipped” each time the tool is unequipped by the player. Please note that the below example assumes that you've already defined what “Tool” is.
|
|
@@ -9610,7 +9613,7 @@ interface FloatCurve extends Instance {
|
|
|
9610
9613
|
/**
|
|
9611
9614
|
* Samples the float curve at a given time passed as argument.
|
|
9612
9615
|
*/
|
|
9613
|
-
GetValueAtTime(this: FloatCurve, time: number):
|
|
9616
|
+
GetValueAtTime(this: FloatCurve, time: number): number | undefined;
|
|
9614
9617
|
/**
|
|
9615
9618
|
* Adds the key passed as argument to this curve. If a key exists at the same time it will be replaced. First return value is true if a key was added, false if a previous key was replaced. Second return value is the index at which the marker was added.
|
|
9616
9619
|
*/
|
|
@@ -23227,7 +23230,7 @@ interface Model extends PVInstance {
|
|
|
23227
23230
|
TranslateBy(this: Model, delta: Vector3): void;
|
|
23228
23231
|
}
|
|
23229
23232
|
|
|
23230
|
-
/** Actor Class */
|
|
23233
|
+
/** This is the Actor Class */
|
|
23231
23234
|
interface Actor extends Model {
|
|
23232
23235
|
/**
|
|
23233
23236
|
* **DO NOT USE!**
|
|
@@ -26902,7 +26905,7 @@ interface RotationCurve extends Instance {
|
|
|
26902
26905
|
/**
|
|
26903
26906
|
* Samples the RotationCurve at a given time and returns the corresponding rotation. Empty RotationCurves are interpreted as zero.
|
|
26904
26907
|
*/
|
|
26905
|
-
GetValueAtTime(this: RotationCurve, time: number):
|
|
26908
|
+
GetValueAtTime(this: RotationCurve, time: number): CFrame | undefined;
|
|
26906
26909
|
/**
|
|
26907
26910
|
* Adds the key passed as argument to this curve. If a key at the same time is found it will be replaced. First return value is true if a key was added, false if a previous key was replaced. Second return value is the index at which the marker was added.
|
|
26908
26911
|
*/
|
|
@@ -33902,29 +33905,6 @@ interface ValueBase extends Instance {
|
|
|
33902
33905
|
readonly Changed: RBXScriptSignal<(value?: unknown) => void>;
|
|
33903
33906
|
}
|
|
33904
33907
|
|
|
33905
|
-
/** An internal type of [StringValue](https://developer.roblox.com/en-us/api-reference/class/StringValue) object, that stores a `BinaryString` value. */
|
|
33906
|
-
interface BinaryStringValue extends ValueBase {
|
|
33907
|
-
/**
|
|
33908
|
-
* **DO NOT USE!**
|
|
33909
|
-
*
|
|
33910
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
33911
|
-
* @hidden
|
|
33912
|
-
* @deprecated
|
|
33913
|
-
*/
|
|
33914
|
-
readonly _nominal_BinaryStringValue: unique symbol;
|
|
33915
|
-
/**
|
|
33916
|
-
* Fires if the `BinaryStringValue/Value` of the [BinaryStringValue](https://developer.roblox.com/en-us/api-reference/class/BinaryStringValue) is changed by the engine.
|
|
33917
|
-
*
|
|
33918
|
-
* In practice, this object is stored out of reach from normal scripts, so this event cannot be connected to. If a BinaryStringValue is created by a script, the engine will not do anything with it, so the event will never fire.
|
|
33919
|
-
*
|
|
33920
|
-
* Note
|
|
33921
|
-
* ----
|
|
33922
|
-
*
|
|
33923
|
-
* Equivalent changed events exist for similar objects, such as [NumberValue](https://developer.roblox.com/en-us/api-reference/class/NumberValue) and [StringValue](https://developer.roblox.com/en-us/api-reference/class/StringValue), depending on what object type best suits the need.
|
|
33924
|
-
*/
|
|
33925
|
-
readonly Changed: RBXScriptSignal<(value: unknown) => void>;
|
|
33926
|
-
}
|
|
33927
|
-
|
|
33928
33908
|
/** An instance which is used to hold a boolean value. The value can be used for many things, including to communicate between scripts. */
|
|
33929
33909
|
interface BoolValue extends ValueBase {
|
|
33930
33910
|
/**
|
|
@@ -124,7 +124,7 @@ interface ABTestService extends Instance {
|
|
|
124
124
|
readonly OnUserABTestLoadingStatusChanged: RBXScriptSignal<(status: Enum.ABTestLoadingStatus, userId: number) => void>;
|
|
125
125
|
}
|
|
126
126
|
|
|
127
|
-
interface KeyframeSequence extends
|
|
127
|
+
interface KeyframeSequence extends AnimationClip {
|
|
128
128
|
/**
|
|
129
129
|
* **DO NOT USE!**
|
|
130
130
|
*
|
package/include/roblox.d.ts
CHANGED
|
@@ -1447,6 +1447,28 @@ interface Faces {
|
|
|
1447
1447
|
type FacesConstructor = new (...ids: Array<Enum.NormalId>) => Faces;
|
|
1448
1448
|
declare const Faces: FacesConstructor;
|
|
1449
1449
|
|
|
1450
|
+
// FloatCurveKey
|
|
1451
|
+
interface FloatCurveKey {
|
|
1452
|
+
/**
|
|
1453
|
+
* **DO NOT USE!**
|
|
1454
|
+
*
|
|
1455
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1456
|
+
* @hidden
|
|
1457
|
+
* @deprecated
|
|
1458
|
+
*/
|
|
1459
|
+
readonly _nominal_FloatCurveKey: unique symbol;
|
|
1460
|
+
readonly Time: number;
|
|
1461
|
+
readonly Value: number;
|
|
1462
|
+
readonly RightTangent: number;
|
|
1463
|
+
readonly LeftTangent: number;
|
|
1464
|
+
}
|
|
1465
|
+
type FloatCurveKeyConstructor = new (
|
|
1466
|
+
time: number,
|
|
1467
|
+
value: number,
|
|
1468
|
+
interpolation: CastsToEnum<Enum.KeyInterpolationMode>,
|
|
1469
|
+
) => FloatCurveKey;
|
|
1470
|
+
declare const FloatCurveKey: FloatCurveKeyConstructor;
|
|
1471
|
+
|
|
1450
1472
|
// NumberRange
|
|
1451
1473
|
interface NumberRange {
|
|
1452
1474
|
/**
|
|
@@ -1736,6 +1758,38 @@ type Region3int16Constructor = new (min?: Vector3int16, max?: Vector3int16) => R
|
|
|
1736
1758
|
|
|
1737
1759
|
declare const Region3int16: Region3int16Constructor;
|
|
1738
1760
|
|
|
1761
|
+
// RotationCurveKey
|
|
1762
|
+
interface RotationCurveKey {
|
|
1763
|
+
/**
|
|
1764
|
+
* **DO NOT USE!**
|
|
1765
|
+
*
|
|
1766
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1767
|
+
* @hidden
|
|
1768
|
+
* @deprecated
|
|
1769
|
+
*/
|
|
1770
|
+
readonly _nominal_RotationCurveKey: unique symbol;
|
|
1771
|
+
readonly Time: number;
|
|
1772
|
+
readonly Value: CFrame;
|
|
1773
|
+
}
|
|
1774
|
+
type RotationCurveKeyConstructor = new (
|
|
1775
|
+
time: number,
|
|
1776
|
+
value: CFrame,
|
|
1777
|
+
interpolation: CastsToEnum<Enum.KeyInterpolationMode>,
|
|
1778
|
+
) => RotationCurveKey;
|
|
1779
|
+
declare const RotationCurveKey: RotationCurveKeyConstructor;
|
|
1780
|
+
|
|
1781
|
+
// TextChatMessage
|
|
1782
|
+
interface TextChatMessage {
|
|
1783
|
+
/**
|
|
1784
|
+
* **DO NOT USE!**
|
|
1785
|
+
*
|
|
1786
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1787
|
+
* @hidden
|
|
1788
|
+
* @deprecated
|
|
1789
|
+
*/
|
|
1790
|
+
readonly _nominal_TextChatMessage: unique symbol;
|
|
1791
|
+
}
|
|
1792
|
+
|
|
1739
1793
|
// TweenInfo
|
|
1740
1794
|
interface TweenInfo {
|
|
1741
1795
|
/**
|
|
@@ -1834,6 +1888,10 @@ interface Vector2 {
|
|
|
1834
1888
|
Lerp(this: Vector2, goal: Vector2, alpha: number): Vector2;
|
|
1835
1889
|
/** Returns the cross product of the two vectors */
|
|
1836
1890
|
Cross(this: Vector2, other: Vector2): number;
|
|
1891
|
+
/** Returns a new Vector2 with the minimum of each component. */
|
|
1892
|
+
Min(this: Vector2, ...vectors: Array<Vector2>): Vector2;
|
|
1893
|
+
/** Returns a new Vector2 with the maximum of each component. */
|
|
1894
|
+
Max(this: Vector2, ...vectors: Array<Vector2>): Vector2;
|
|
1837
1895
|
}
|
|
1838
1896
|
|
|
1839
1897
|
interface Vector2Constructor {
|
|
@@ -1930,6 +1988,10 @@ interface Vector3 {
|
|
|
1930
1988
|
Cross(this: Vector3, other: Vector3): Vector3;
|
|
1931
1989
|
/** Returns true if the other Vector3 falls within the epsilon radius of this Vector3. */
|
|
1932
1990
|
FuzzyEq(this: Vector3, other: Vector3, epsilon?: number): boolean;
|
|
1991
|
+
/** Returns a new Vector3 with the minimum of each component. */
|
|
1992
|
+
Min(this: Vector3, ...vectors: Array<Vector3>): Vector3;
|
|
1993
|
+
/** Returns a new Vector3 with the maximum of each component. */
|
|
1994
|
+
Max(this: Vector3, ...vectors: Array<Vector3>): Vector3;
|
|
1933
1995
|
}
|
|
1934
1996
|
|
|
1935
1997
|
interface Vector3Constructor {
|