@rbxts/types 1.0.576 → 1.0.579
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.
|
@@ -2001,7 +2001,6 @@ interface AssetImportService extends Instance {
|
|
|
2001
2001
|
*/
|
|
2002
2002
|
readonly _nominal_AssetImportService: unique symbol;
|
|
2003
2003
|
readonly ProgressUpdate: RBXScriptSignal<(progressRatio: number) => void>;
|
|
2004
|
-
readonly SettingsChanged: RBXScriptSignal<(property: string) => void>;
|
|
2005
2004
|
readonly UploadFinished: RBXScriptSignal<(succeeded: boolean, errorMap: object) => void>;
|
|
2006
2005
|
}
|
|
2007
2006
|
|
|
@@ -8888,7 +8887,7 @@ interface DataStoreService extends Instance {
|
|
|
8888
8887
|
*
|
|
8889
8888
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
8890
8889
|
*/
|
|
8891
|
-
GetDataStore(this: DataStoreService, name: string, scope?: string):
|
|
8890
|
+
GetDataStore(this: DataStoreService, name: string, scope?: string, options?: DataStoreOptions): DataStore;
|
|
8892
8891
|
/**
|
|
8893
8892
|
* This function returns the default [GlobalDataStore](https://developer.roblox.com/en-us/api-reference/class/GlobalDataStore). If you want to access a specific **named** data store instead, you should use the [GetDataStore()](https://developer.roblox.com/en-us/api-reference/function/DataStoreService/GetDataStore) function.
|
|
8894
8893
|
*/
|
|
@@ -10130,7 +10129,7 @@ interface GlobalDataStore extends Instance {
|
|
|
10130
10129
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
10131
10130
|
* Tags: Yields
|
|
10132
10131
|
*/
|
|
10133
|
-
GetAsync
|
|
10132
|
+
GetAsync(this: GlobalDataStore, key: string): unknown;
|
|
10134
10133
|
/**
|
|
10135
10134
|
* This function increments the value of a key by the provided amount (both must be integers).
|
|
10136
10135
|
*
|
|
@@ -10142,7 +10141,7 @@ interface GlobalDataStore extends Instance {
|
|
|
10142
10141
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
10143
10142
|
* Tags: Yields
|
|
10144
10143
|
*/
|
|
10145
|
-
IncrementAsync(this: GlobalDataStore, key: string, delta?: number):
|
|
10144
|
+
IncrementAsync(this: GlobalDataStore, key: string, delta?: number, userIds?: Array<any>, options?: DataStoreIncrementOptions): unknown;
|
|
10146
10145
|
/**
|
|
10147
10146
|
* This function marks the specified key as deleted by creating a new “tombstone” version of the key. Prior to this, it returns the latest version prior to the remove call.
|
|
10148
10147
|
*
|
|
@@ -10160,7 +10159,7 @@ interface GlobalDataStore extends Instance {
|
|
|
10160
10159
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
10161
10160
|
* Tags: Yields
|
|
10162
10161
|
*/
|
|
10163
|
-
RemoveAsync
|
|
10162
|
+
RemoveAsync(this: GlobalDataStore, key: string): unknown;
|
|
10164
10163
|
/**
|
|
10165
10164
|
* This function sets the latest value, [UserIds](https://developer.roblox.com/en-us/api-reference/property/Player/UserId), and metadata for the given key.
|
|
10166
10165
|
*
|
|
@@ -10240,6 +10239,32 @@ interface DataStore extends GlobalDataStore {
|
|
|
10240
10239
|
* @deprecated
|
|
10241
10240
|
*/
|
|
10242
10241
|
readonly _nominal_DataStore: unique symbol;
|
|
10242
|
+
GetAsync<T>(this: DataStore, key: string): LuaTuple<[T | undefined, DataStoreKeyInfo]>;
|
|
10243
|
+
IncrementAsync(
|
|
10244
|
+
this: DataStore,
|
|
10245
|
+
key: string,
|
|
10246
|
+
delta?: number,
|
|
10247
|
+
userIds?: Array<number>,
|
|
10248
|
+
options?: DataStoreIncrementOptions,
|
|
10249
|
+
): LuaTuple<[number, DataStoreKeyInfo]>;
|
|
10250
|
+
SetAsync(
|
|
10251
|
+
this: DataStore,
|
|
10252
|
+
key: string,
|
|
10253
|
+
value?: unknown,
|
|
10254
|
+
userIds?: Array<number>,
|
|
10255
|
+
options?: DataStoreSetOptions,
|
|
10256
|
+
): string;
|
|
10257
|
+
UpdateAsync<O, R>(
|
|
10258
|
+
this: DataStore,
|
|
10259
|
+
key: string,
|
|
10260
|
+
transformFunction: (
|
|
10261
|
+
oldValue: O | undefined,
|
|
10262
|
+
keyInfo: DataStoreKeyInfo,
|
|
10263
|
+
) => LuaTuple<[newValue: R, userIds?: Array<number>, metadata?: object]>,
|
|
10264
|
+
): R extends undefined
|
|
10265
|
+
? LuaTuple<[newValue: O | undefined, keyInfo: DataStoreKeyInfo]>
|
|
10266
|
+
: LuaTuple<[newValue: R, keyInfo: DataStoreKeyInfo]>;
|
|
10267
|
+
RemoveAsync<T>(this: DataStore, key: string): LuaTuple<[T | undefined, DataStoreKeyInfo]>;
|
|
10243
10268
|
/**
|
|
10244
10269
|
* This function retrieves the specified key version as well as a [DataStoreKeyInfo](https://developer.roblox.com/en-us/api-reference/class/DataStoreKeyInfo) instance. A version identifier can be found through [DataStore:ListVersionsAsync](https://developer.roblox.com/en-us/api-reference/function/DataStore/ListVersionsAsync) or alternatively be the identifier returned by [GlobalDataStore:SetAsync](https://developer.roblox.com/en-us/api-reference/function/GlobalDataStore/SetAsync).
|
|
10245
10270
|
*
|
|
@@ -10249,7 +10274,11 @@ interface DataStore extends GlobalDataStore {
|
|
|
10249
10274
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
10250
10275
|
* Tags: Yields
|
|
10251
10276
|
*/
|
|
10252
|
-
GetVersionAsync(
|
|
10277
|
+
GetVersionAsync(
|
|
10278
|
+
this: DataStore,
|
|
10279
|
+
key: string,
|
|
10280
|
+
version: string,
|
|
10281
|
+
): LuaTuple<[value: unknown, keyInfo: DataStoreKeyInfo]>;
|
|
10253
10282
|
/**
|
|
10254
10283
|
* This function returns a [DataStoreKeyPages](https://developer.roblox.com/en-us/api-reference/class/DataStoreKeyPages) object for enumerating through keys of a data store. It accepts an optional `prefix` parameter to only locate keys whose names start with the provided prefix.
|
|
10255
10284
|
*
|
|
@@ -10299,6 +10328,9 @@ interface OrderedDataStore extends GlobalDataStore {
|
|
|
10299
10328
|
* @deprecated
|
|
10300
10329
|
*/
|
|
10301
10330
|
readonly _nominal_OrderedDataStore: unique symbol;
|
|
10331
|
+
GetAsync(this: OrderedDataStore, key: string): number | undefined;
|
|
10332
|
+
IncrementAsync(this: OrderedDataStore, key: string, delta?: number): number;
|
|
10333
|
+
RemoveAsync(this: OrderedDataStore, key: string): number;
|
|
10302
10334
|
/**
|
|
10303
10335
|
* Returns a [DataStorePages](https://developer.roblox.com/en-us/api-reference/class/DataStorePages) object. The sort order is determined by **ascending**, the length of each page by **pageSize**, and **minValue** /**maxValue** are optional parameters which filter the results.
|
|
10304
10336
|
*
|
|
@@ -10566,6 +10598,26 @@ interface GuiBase2d extends GuiBase {
|
|
|
10566
10598
|
* If there is no translation available in the referenced table it will look for a translation in the parent of that table, if it is also a LocalizationTable, and so on.
|
|
10567
10599
|
*/
|
|
10568
10600
|
RootLocalizationTable: LocalizationTable | undefined;
|
|
10601
|
+
/**
|
|
10602
|
+
* Tags: NotBrowsable
|
|
10603
|
+
*/
|
|
10604
|
+
SelectionBehaviorDown: Enum.SelectionBehavior;
|
|
10605
|
+
/**
|
|
10606
|
+
* Tags: NotBrowsable
|
|
10607
|
+
*/
|
|
10608
|
+
SelectionBehaviorLeft: Enum.SelectionBehavior;
|
|
10609
|
+
/**
|
|
10610
|
+
* Tags: NotBrowsable
|
|
10611
|
+
*/
|
|
10612
|
+
SelectionBehaviorRight: Enum.SelectionBehavior;
|
|
10613
|
+
/**
|
|
10614
|
+
* Tags: NotBrowsable
|
|
10615
|
+
*/
|
|
10616
|
+
SelectionBehaviorUp: Enum.SelectionBehavior;
|
|
10617
|
+
/**
|
|
10618
|
+
* Tags: NotBrowsable
|
|
10619
|
+
*/
|
|
10620
|
+
SelectionGroup: boolean;
|
|
10569
10621
|
}
|
|
10570
10622
|
|
|
10571
10623
|
/** GuiObject is an abstract class (much like [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart)) for a 2D user interface object. It defines all the properties relating to the display of a graphical user interface (GUI) object such as [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). It also has some useful read-only properties like `GuiObject/AbsolutePosition`, `GuiObject/AbsoluteSize`, and `GuiObject/AbsoluteRotation`. It should be noted that [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject) can have negative sizes and render normally, though [GuiObject.AnchorPoint](https://developer.roblox.com/en-us/api-reference/property/GuiObject/AnchorPoint) ought to be used to better control rendering.
|
|
@@ -13823,6 +13875,7 @@ interface GuiService extends Instance {
|
|
|
13823
13875
|
* Removes a group that was created with [GuiService:AddSelectionParent](https://developer.roblox.com/en-us/api-reference/function/GuiService/AddSelectionParent) or [GuiService:AddSelectionTuple](https://developer.roblox.com/en-us/api-reference/function/GuiService/AddSelectionTuple).
|
|
13824
13876
|
*/
|
|
13825
13877
|
RemoveSelectionGroup(this: GuiService, selectionName: string): void;
|
|
13878
|
+
Select(this: GuiService, selectionParent: Selection): void;
|
|
13826
13879
|
/**
|
|
13827
13880
|
* Opens or closes the player Emotes menu.
|
|
13828
13881
|
*/
|
|
@@ -24664,6 +24717,7 @@ interface DataStoreVersionPages extends Pages {
|
|
|
24664
24717
|
* @deprecated
|
|
24665
24718
|
*/
|
|
24666
24719
|
readonly _nominal_DataStoreVersionPages: unique symbol;
|
|
24720
|
+
GetCurrentPage(this: Pages): Array<DataStoreObjectVersionInfo>;
|
|
24667
24721
|
}
|
|
24668
24722
|
|
|
24669
24723
|
/** FriendPages is a special version of the [Pages](https://developer.roblox.com/en-us/api-reference/class/Pages) returned by [Players:GetFriendsAsync](https://developer.roblox.com/en-us/api-reference/function/Players/GetFriendsAsync). The items contained within describe information about a player's friends, and have the following structure:
|