@rbxts/types 1.0.600 → 1.0.603

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/README.md CHANGED
@@ -6,7 +6,7 @@ TypeScript typings for the Roblox platform. Partially handwritten and partially
6
6
 
7
7
  To install @rbxts/types into your project, run the following command:
8
8
 
9
- `npm i @rbxts/types`
9
+ `npm i -D @rbxts/types`
10
10
 
11
11
  Then, make sure `node_modules/@rbxts` is listed in your `compilerOptions.typeRoots` field in your project's `tsconfig.json` like so:
12
12
 
@@ -2073,13 +2073,7 @@ interface AssetService extends Instance {
2073
2073
  * Clones a place which has a placeId equal to the given templatePlaceID, placing it into the inventory of the given player with the given name and description, if they accept when prompted. This method cannot be used to clone places that you do not own, or those which have disabled the use of the CreatePlace API in their place's configuration.
2074
2074
  * Tags: Yields
2075
2075
  */
2076
- CreatePlaceInPlayerInventoryAsync(
2077
- this: AssetService,
2078
- player: Player,
2079
- placeName: string,
2080
- templatePlaceID: number,
2081
- description?: string,
2082
- ): number;
2076
+ CreatePlaceInPlayerInventoryAsync(this: AssetService, player: Player, placeName: string, templatePlaceID: number, description?: string): number;
2083
2077
  /**
2084
2078
  * Returns an array of assetIds that are contained in a specified package.
2085
2079
  * Tags: Yields
@@ -10218,7 +10212,7 @@ interface GlobalDataStore extends Instance {
10218
10212
  * * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
10219
10213
  * Tags: Yields
10220
10214
  */
10221
- GetAsync(this: GlobalDataStore, key: string): unknown;
10215
+ readonly GetAsync: unknown;
10222
10216
  /**
10223
10217
  * This function increments the value of a key by the provided amount (both must be integers).
10224
10218
  *
@@ -10230,7 +10224,7 @@ interface GlobalDataStore extends Instance {
10230
10224
  * * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
10231
10225
  * Tags: Yields
10232
10226
  */
10233
- IncrementAsync(this: GlobalDataStore, key: string, delta?: number, userIds?: Array<any>, options?: DataStoreIncrementOptions): unknown;
10227
+ readonly IncrementAsync: unknown;
10234
10228
  /**
10235
10229
  * 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.
10236
10230
  *
@@ -10248,7 +10242,7 @@ interface GlobalDataStore extends Instance {
10248
10242
  * * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
10249
10243
  * Tags: Yields
10250
10244
  */
10251
- RemoveAsync(this: GlobalDataStore, key: string): unknown;
10245
+ readonly RemoveAsync: unknown;
10252
10246
  /**
10253
10247
  * This function sets the latest value, [UserIds](https://developer.roblox.com/en-us/api-reference/property/Player/UserId), and metadata for the given key.
10254
10248
  *
@@ -10272,7 +10266,7 @@ interface GlobalDataStore extends Instance {
10272
10266
  * * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
10273
10267
  * Tags: Yields
10274
10268
  */
10275
- SetAsync(this: GlobalDataStore, key: string, value?: unknown): void;
10269
+ readonly SetAsync: unknown;
10276
10270
  /**
10277
10271
  * This function retrieves the value and metadata of a key from the data store and updates it with a new value determined by the callback function specified through the second parameter.
10278
10272
  *
@@ -10312,11 +10306,7 @@ interface GlobalDataStore extends Instance {
10312
10306
  * * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
10313
10307
  * Tags: Yields
10314
10308
  */
10315
- UpdateAsync<O, R>(
10316
- this: GlobalDataStore,
10317
- key: string,
10318
- transformFunction: (oldValue: O | undefined) => R,
10319
- ): R extends undefined ? O | undefined : R;
10309
+ readonly UpdateAsync: unknown;
10320
10310
  }
10321
10311
 
10322
10312
  interface DataStore extends GlobalDataStore {
@@ -10420,6 +10410,12 @@ interface OrderedDataStore extends GlobalDataStore {
10420
10410
  GetAsync(this: OrderedDataStore, key: string): number | undefined;
10421
10411
  IncrementAsync(this: OrderedDataStore, key: string, delta?: number): number;
10422
10412
  RemoveAsync(this: OrderedDataStore, key: string): number;
10413
+ SetAsync(this: GlobalDataStore, key: string, value?: unknown): void;
10414
+ UpdateAsync<O, R>(
10415
+ this: GlobalDataStore,
10416
+ key: string,
10417
+ transformFunction: (oldValue: O | undefined) => R,
10418
+ ): R extends undefined ? O | undefined : R;
10423
10419
  /**
10424
10420
  * 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.
10425
10421
  *
@@ -24479,7 +24475,7 @@ interface Workspace extends WorldRoot {
24479
24475
  * workspace.Terrain.WaterColor = Color3.new(0, 1, 0) -- make the water green
24480
24476
  * Tags: ReadOnly, NotReplicated
24481
24477
  */
24482
- Terrain: Terrain;
24478
+ readonly Terrain: Terrain;
24483
24479
  /**
24484
24480
  * Returns the number of [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart)s that are deemed physically active, due to being recently under the influence of physics.
24485
24481
  *
@@ -2762,7 +2762,7 @@ interface ScriptDebugger extends Instance {
2762
2762
  * Returns a dictionary of all variables that are present in the global environment of the stack frame, where the keys are the names of the variables, and the values are the actual values of the variables.
2763
2763
  * Each stack frame might see different global variables if function environments are different.
2764
2764
  */
2765
- GetGlobals(this: ScriptDebugger): Map<string, unknown>;
2765
+ GetGlobals(this: ScriptDebugger, stackFrame?: number): Map<string, unknown>;
2766
2766
  /**
2767
2767
  * Returns a dictionary of all local variables in the specified stack frame, where the keys are the names of the variables, and the values are the actual values of the variables.
2768
2768
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.600",
3
+ "version": "1.0.603",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },