@rbxts/types 1.0.559 → 1.0.563
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.
|
@@ -6029,7 +6029,7 @@ interface Chat extends Instance {
|
|
|
6029
6029
|
* * Set `message.ShouldDeliver` to false in order to cancel delivery of the message to players (useful for implementing a chat blacklist)
|
|
6030
6030
|
* * Get/set the speaker's name color (`message.ExtraData.NameColor`, a Color3) on a message-by-message basis
|
|
6031
6031
|
*/
|
|
6032
|
-
RegisterChatCallback(this: Chat, callbackType: CastsToEnum<Enum.ChatCallbackType>, callbackFunction:
|
|
6032
|
+
RegisterChatCallback(this: Chat, callbackType: CastsToEnum<Enum.ChatCallbackType>, callbackFunction: Callback): void;
|
|
6033
6033
|
/**
|
|
6034
6034
|
* **Note**
|
|
6035
6035
|
*
|
|
@@ -7860,7 +7860,7 @@ interface ContextActionService extends Instance {
|
|
|
7860
7860
|
* Tags: Deprecated
|
|
7861
7861
|
* @deprecated
|
|
7862
7862
|
*/
|
|
7863
|
-
BindActionToInputTypes(this: ContextActionService, actionName: string, functionToBind:
|
|
7863
|
+
BindActionToInputTypes(this: ContextActionService, actionName: string, functionToBind: Callback, createTouchButton: boolean, inputTypes: Array<any>): void;
|
|
7864
7864
|
/**
|
|
7865
7865
|
* Bind an [KeyCode](https://developer.roblox.com/en-us/api-reference/enum/KeyCode) that can be used with an [UserInputType](https://developer.roblox.com/en-us/api-reference/enum/UserInputType) to activate [ClickDetector](https://developer.roblox.com/en-us/api-reference/class/ClickDetector) events and [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) objects. When the given key/button is pressed, it fires the [Mouse.Button1Down](https://developer.roblox.com/en-us/api-reference/event/Mouse/Button1Down) event on the mouse sent to [Tool.Equipped](https://developer.roblox.com/en-us/api-reference/event/Tool/Equipped). This in turn fires the [Tool.Activated](https://developer.roblox.com/en-us/api-reference/event/Tool/Activated) event if [Tool.ManualActivationOnly](https://developer.roblox.com/en-us/api-reference/property/Tool/ManualActivationOnly) is not set to true. For gamepad input, this function is called by the default control scripts in order to bind the ButtonR2 [KeyCode](https://developer.roblox.com/en-us/api-reference/enum/KeyCode).
|
|
7866
7866
|
*
|
|
@@ -9841,7 +9841,7 @@ interface GlobalDataStore extends Instance {
|
|
|
9841
9841
|
* Tags: Deprecated
|
|
9842
9842
|
* @deprecated
|
|
9843
9843
|
*/
|
|
9844
|
-
OnUpdate(this: GlobalDataStore, key: string, callback:
|
|
9844
|
+
OnUpdate(this: GlobalDataStore, key: string, callback: Callback): RBXScriptConnection;
|
|
9845
9845
|
/**
|
|
9846
9846
|
* This function returns the latest value of the provided key and a [DataStoreKeyInfo](https://developer.roblox.com/en-us/api-reference/class/DataStoreKeyInfo) instance. If the key does not exist or if the latest version has been marked as deleted, both return values will be `nil`.
|
|
9847
9847
|
*
|
|
@@ -14642,7 +14642,7 @@ interface Humanoid extends Instance {
|
|
|
14642
14642
|
* * [Humanoid.Sit](https://developer.roblox.com/en-us/api-reference/property/Humanoid/Sit), which indicates if a Humanoid is currently sitting
|
|
14643
14643
|
* * [Humanoid.SeatPart](https://developer.roblox.com/en-us/api-reference/property/Humanoid/SeatPart), which indicates the seat a Humanoid is currently sitting in, if any.
|
|
14644
14644
|
*/
|
|
14645
|
-
readonly Seated: RBXScriptSignal<(active: boolean, currentSeatPart: Seat | VehicleSeat) => void>;
|
|
14645
|
+
readonly Seated: RBXScriptSignal<(active: boolean, currentSeatPart: Seat | VehicleSeat | undefined) => void>;
|
|
14646
14646
|
/**
|
|
14647
14647
|
* This event fires when the state of the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) is changed.
|
|
14648
14648
|
*
|
|
@@ -20583,7 +20583,7 @@ interface MemoryStoreSortedMap extends Instance {
|
|
|
20583
20583
|
* For a more in-depth look, take a look at the `articles/Memory Store|Memory Store` article.
|
|
20584
20584
|
* Tags: Yields
|
|
20585
20585
|
*/
|
|
20586
|
-
UpdateAsync(this: MemoryStoreSortedMap, key: string, transformFunction:
|
|
20586
|
+
UpdateAsync(this: MemoryStoreSortedMap, key: string, transformFunction: Callback, expiration: number): unknown;
|
|
20587
20587
|
}
|
|
20588
20588
|
|
|
20589
20589
|
interface MessageBusConnection extends Instance {
|
|
@@ -31687,7 +31687,7 @@ interface UIGridStyleLayout extends UILayout {
|
|
|
31687
31687
|
* Tags: Deprecated
|
|
31688
31688
|
* @deprecated
|
|
31689
31689
|
*/
|
|
31690
|
-
SetCustomSortFunction(this: UIGridStyleLayout, callback?:
|
|
31690
|
+
SetCustomSortFunction(this: UIGridStyleLayout, callback?: Callback): void;
|
|
31691
31691
|
}
|
|
31692
31692
|
|
|
31693
31693
|
/** A UIGridLayout (not to be confused with the abstract [UIGridStyleLayout](https://developer.roblox.com/en-us/api-reference/class/UIGridStyleLayout) from which this class inherits) lays out sibling UI elements in multiple rows within the parent UI element, adding elements to a row one-by-one until the next element would not fit. It then continues adding elements in the next row. A UIGridLayout will take UI elements' [GuiObject.Size](https://developer.roblox.com/en-us/api-reference/property/GuiObject/Size) and [GuiObject.Position](https://developer.roblox.com/en-us/api-reference/property/GuiObject/Position) under control. While under control, these UI elements' properties will not be editable in the Properties window.
|
|
@@ -833,7 +833,7 @@ interface PluginGui extends LayerCollector {
|
|
|
833
833
|
* * [Plugin:CreateDockWidgetPluginGui](https://developer.roblox.com/en-us/api-reference/function/Plugin/CreateDockWidgetPluginGui) to create a [PluginGui](https://developer.roblox.com/en-us/api-reference/class/PluginGui)
|
|
834
834
|
* * [DataModel:BindToClose](https://developer.roblox.com/en-us/api-reference/function/DataModel/BindToClose), which can be used to bind a function to the game ending and should not be confused with this function
|
|
835
835
|
*/
|
|
836
|
-
BindToClose(this: PluginGui, callback?:
|
|
836
|
+
BindToClose(this: PluginGui, callback?: Callback): void;
|
|
837
837
|
/**
|
|
838
838
|
* GetRelativeMousePosition returns the position of the mouse relative to the top-left corner of the [PluginGui](https://developer.roblox.com/en-us/api-reference/class/PluginGui). The returned value changes only if a mouse input began on the PluginGui, or if the mouse is presently hovering over the window.
|
|
839
839
|
*
|
|
@@ -1915,8 +1915,8 @@ interface Plugin extends Instance {
|
|
|
1915
1915
|
* Negates the given parts and returns the resulting NegateOperations.
|
|
1916
1916
|
*/
|
|
1917
1917
|
Negate(this: Plugin, objects: Array<Instance>): Array<Instance>;
|
|
1918
|
-
OnInvoke(this: Plugin, key: string, callback:
|
|
1919
|
-
OnSetItem(this: Plugin, key: string, callback:
|
|
1918
|
+
OnInvoke(this: Plugin, key: string, callback: Callback): Instance | undefined;
|
|
1919
|
+
OnSetItem(this: Plugin, key: string, callback: Callback): Instance | undefined;
|
|
1920
1920
|
/**
|
|
1921
1921
|
* Used to open the given script instance in an editor window, in Roblox studio, at the given line. If no line is given as an argument it will default to 0.
|
|
1922
1922
|
*/
|
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 {
|