@rbxts/types 1.0.599 → 1.0.602
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 +1 -1
- package/include/generated/None.d.ts +48 -21
- package/include/generated/enums.d.ts +14 -14
- package/package.json +1 -1
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
|
|
|
@@ -197,6 +197,7 @@ interface CreatableInstances {
|
|
|
197
197
|
Folder: Folder;
|
|
198
198
|
ForceField: ForceField;
|
|
199
199
|
Frame: Frame;
|
|
200
|
+
GetTextBoundsParams: GetTextBoundsParams;
|
|
200
201
|
Glue: Glue;
|
|
201
202
|
Handles: Handles;
|
|
202
203
|
Hat: Hat;
|
|
@@ -4198,13 +4199,13 @@ interface WrapLayer extends BaseWrap {
|
|
|
4198
4199
|
/**
|
|
4199
4200
|
* Controls the composition order for layered clothing. Clothing items with higher order will appear on top of clothing items with lower order. If two items have the same order, the deformer composition order is ambiguous and depends on serialization order. Default value is 1.
|
|
4200
4201
|
*/
|
|
4201
|
-
|
|
4202
|
+
Order: number;
|
|
4202
4203
|
/**
|
|
4203
4204
|
* Controls how much underlying clothing items inflate the current clothing item.
|
|
4204
4205
|
*
|
|
4205
4206
|
* Valid range is 0 to 1. A value of 0 makes the clothing item always fit the body regardless of how many clothing layers are under it (all underlying clothing layers will be compressed). A value of 1 (default) never compresses anything and infinitely inflates over underlying clothing items.
|
|
4206
4207
|
*/
|
|
4207
|
-
|
|
4208
|
+
Puffiness: number;
|
|
4208
4209
|
/**
|
|
4209
4210
|
* AssetID for reference mesh used to define Inner Cage of a 3D object
|
|
4210
4211
|
*
|
|
@@ -10164,6 +10165,21 @@ interface GamePassService extends Instance {
|
|
|
10164
10165
|
PlayerHasPass(this: GamePassService, player: Player, gamePassId: number): boolean;
|
|
10165
10166
|
}
|
|
10166
10167
|
|
|
10168
|
+
interface GetTextBoundsParams extends Instance {
|
|
10169
|
+
/**
|
|
10170
|
+
* **DO NOT USE!**
|
|
10171
|
+
*
|
|
10172
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
10173
|
+
* @hidden
|
|
10174
|
+
* @deprecated
|
|
10175
|
+
*/
|
|
10176
|
+
readonly _nominal_GetTextBoundsParams: unique symbol;
|
|
10177
|
+
Font: Font;
|
|
10178
|
+
Size: number;
|
|
10179
|
+
Text: string;
|
|
10180
|
+
Width: number;
|
|
10181
|
+
}
|
|
10182
|
+
|
|
10167
10183
|
/** A **GlobalDataStore** exposes functions for saving and loading data for the [DataStoreService](https://developer.roblox.com/en-us/api-reference/class/DataStoreService).
|
|
10168
10184
|
*
|
|
10169
10185
|
* See the [Data Stores](https://developer.roblox.com/en-us/articles/data-store) article for an in-depth guide on data structure, management, error handling, etc.
|
|
@@ -10202,7 +10218,7 @@ interface GlobalDataStore extends Instance {
|
|
|
10202
10218
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
10203
10219
|
* Tags: Yields
|
|
10204
10220
|
*/
|
|
10205
|
-
GetAsync
|
|
10221
|
+
readonly GetAsync: unknown;
|
|
10206
10222
|
/**
|
|
10207
10223
|
* This function increments the value of a key by the provided amount (both must be integers).
|
|
10208
10224
|
*
|
|
@@ -10214,7 +10230,7 @@ interface GlobalDataStore extends Instance {
|
|
|
10214
10230
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
10215
10231
|
* Tags: Yields
|
|
10216
10232
|
*/
|
|
10217
|
-
IncrementAsync
|
|
10233
|
+
readonly IncrementAsync: unknown;
|
|
10218
10234
|
/**
|
|
10219
10235
|
* 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.
|
|
10220
10236
|
*
|
|
@@ -10232,7 +10248,7 @@ interface GlobalDataStore extends Instance {
|
|
|
10232
10248
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
10233
10249
|
* Tags: Yields
|
|
10234
10250
|
*/
|
|
10235
|
-
RemoveAsync
|
|
10251
|
+
readonly RemoveAsync: unknown;
|
|
10236
10252
|
/**
|
|
10237
10253
|
* This function sets the latest value, [UserIds](https://developer.roblox.com/en-us/api-reference/property/Player/UserId), and metadata for the given key.
|
|
10238
10254
|
*
|
|
@@ -10256,7 +10272,7 @@ interface GlobalDataStore extends Instance {
|
|
|
10256
10272
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
10257
10273
|
* Tags: Yields
|
|
10258
10274
|
*/
|
|
10259
|
-
SetAsync
|
|
10275
|
+
readonly SetAsync: unknown;
|
|
10260
10276
|
/**
|
|
10261
10277
|
* 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.
|
|
10262
10278
|
*
|
|
@@ -10296,11 +10312,7 @@ interface GlobalDataStore extends Instance {
|
|
|
10296
10312
|
* * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
|
|
10297
10313
|
* Tags: Yields
|
|
10298
10314
|
*/
|
|
10299
|
-
UpdateAsync
|
|
10300
|
-
this: GlobalDataStore,
|
|
10301
|
-
key: string,
|
|
10302
|
-
transformFunction: (oldValue: O | undefined) => R,
|
|
10303
|
-
): R extends undefined ? O | undefined : R;
|
|
10315
|
+
readonly UpdateAsync: unknown;
|
|
10304
10316
|
}
|
|
10305
10317
|
|
|
10306
10318
|
interface DataStore extends GlobalDataStore {
|
|
@@ -10404,6 +10416,12 @@ interface OrderedDataStore extends GlobalDataStore {
|
|
|
10404
10416
|
GetAsync(this: OrderedDataStore, key: string): number | undefined;
|
|
10405
10417
|
IncrementAsync(this: OrderedDataStore, key: string, delta?: number): number;
|
|
10406
10418
|
RemoveAsync(this: OrderedDataStore, key: string): number;
|
|
10419
|
+
SetAsync(this: GlobalDataStore, key: string, value?: unknown): void;
|
|
10420
|
+
UpdateAsync<O, R>(
|
|
10421
|
+
this: GlobalDataStore,
|
|
10422
|
+
key: string,
|
|
10423
|
+
transformFunction: (oldValue: O | undefined) => R,
|
|
10424
|
+
): R extends undefined ? O | undefined : R;
|
|
10407
10425
|
/**
|
|
10408
10426
|
* 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.
|
|
10409
10427
|
*
|
|
@@ -16188,13 +16206,19 @@ interface ImporterMeshSettings extends ImporterBaseSettings {
|
|
|
16188
16206
|
/**
|
|
16189
16207
|
* Tags: ReadOnly, NotReplicated
|
|
16190
16208
|
*/
|
|
16191
|
-
readonly
|
|
16192
|
-
|
|
16193
|
-
IgnoreVertexColors: boolean;
|
|
16209
|
+
readonly CageManifold: boolean;
|
|
16210
|
+
CageManifoldPreview: boolean;
|
|
16194
16211
|
/**
|
|
16195
16212
|
* Tags: ReadOnly, NotReplicated
|
|
16196
16213
|
*/
|
|
16197
|
-
readonly
|
|
16214
|
+
readonly CageNoOverlappingVertices: boolean;
|
|
16215
|
+
CageNoOverlappingVerticesPreview: boolean;
|
|
16216
|
+
/**
|
|
16217
|
+
* Tags: ReadOnly, NotReplicated
|
|
16218
|
+
*/
|
|
16219
|
+
readonly Dimensions: Vector3;
|
|
16220
|
+
DoubleSided: boolean;
|
|
16221
|
+
IgnoreVertexColors: boolean;
|
|
16198
16222
|
/**
|
|
16199
16223
|
* Tags: ReadOnly, NotReplicated
|
|
16200
16224
|
*/
|
|
@@ -16226,6 +16250,7 @@ interface ImporterRootSettings extends ImporterBaseSettings {
|
|
|
16226
16250
|
readonly PolygonCount: number;
|
|
16227
16251
|
RigType: Enum.RigType;
|
|
16228
16252
|
ScaleUnit: Enum.MeshScaleUnit;
|
|
16253
|
+
UseSceneOriginAsPivot: boolean;
|
|
16229
16254
|
WorldForward: Enum.NormalId;
|
|
16230
16255
|
WorldUp: Enum.NormalId;
|
|
16231
16256
|
}
|
|
@@ -21068,6 +21093,10 @@ interface MarketplaceService extends Instance {
|
|
|
21068
21093
|
* Tags: Yields
|
|
21069
21094
|
*/
|
|
21070
21095
|
PlayerOwnsAsset(this: MarketplaceService, player: Player, assetId: number): boolean;
|
|
21096
|
+
/**
|
|
21097
|
+
* Tags: Yields
|
|
21098
|
+
*/
|
|
21099
|
+
PlayerOwnsBundle(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
21071
21100
|
/**
|
|
21072
21101
|
* UserOwnsGamePassAsync returns true if the [Player](https://developer.roblox.com/en-us/api-reference/class/Player) with the given [UserId](https://developer.roblox.com/en-us/api-reference/property/Player/UserId) owns the game pass with the given **game pass ID** (not to be confused with asset ID).
|
|
21073
21102
|
*
|
|
@@ -21174,15 +21203,9 @@ interface MaterialService extends Instance {
|
|
|
21174
21203
|
* @deprecated
|
|
21175
21204
|
*/
|
|
21176
21205
|
readonly _nominal_MaterialService: unique symbol;
|
|
21177
|
-
ClearOverridePartMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): void;
|
|
21178
|
-
ClearOverrideTerrainMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): void;
|
|
21179
21206
|
GetBaseMaterialOverride(this: MaterialService, material: CastsToEnum<Enum.Material>): string;
|
|
21180
21207
|
GetMaterialVariant(this: MaterialService, material: CastsToEnum<Enum.Material>, name: string): MaterialVariant;
|
|
21181
|
-
GetOverridePartMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): MaterialVariant;
|
|
21182
|
-
GetOverrideTerrainMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): MaterialVariant;
|
|
21183
21208
|
SetBaseMaterialOverride(this: MaterialService, material: CastsToEnum<Enum.Material>, name: string): void;
|
|
21184
|
-
SetOverridePartMaterial(this: MaterialService, materialVariant: MaterialVariant): void;
|
|
21185
|
-
SetOverrideTerrainMaterial(this: MaterialService, materialVariant: MaterialVariant): void;
|
|
21186
21209
|
}
|
|
21187
21210
|
|
|
21188
21211
|
interface MaterialVariant extends Instance {
|
|
@@ -31728,6 +31751,10 @@ interface TextService extends Instance {
|
|
|
31728
31751
|
* Tags: Yields
|
|
31729
31752
|
*/
|
|
31730
31753
|
GetFamilyInfoAsync(this: TextService, assetId: string): object;
|
|
31754
|
+
/**
|
|
31755
|
+
* Tags: Yields
|
|
31756
|
+
*/
|
|
31757
|
+
GetTextBoundsAsync(this: TextService, params: GetTextBoundsParams): Vector2;
|
|
31731
31758
|
}
|
|
31732
31759
|
|
|
31733
31760
|
interface TextSource extends Instance {
|
|
@@ -5122,13 +5122,13 @@ declare namespace Enum {
|
|
|
5122
5122
|
|
|
5123
5123
|
export const Gotham: Gotham;
|
|
5124
5124
|
|
|
5125
|
-
export interface
|
|
5126
|
-
Name: "
|
|
5125
|
+
export interface GothamMedium {
|
|
5126
|
+
Name: "GothamMedium";
|
|
5127
5127
|
Value: 18;
|
|
5128
5128
|
EnumType: EnumType<Font>;
|
|
5129
5129
|
}
|
|
5130
5130
|
|
|
5131
|
-
export const
|
|
5131
|
+
export const GothamMedium: GothamMedium;
|
|
5132
5132
|
|
|
5133
5133
|
export interface GothamBold {
|
|
5134
5134
|
Name: "GothamBold";
|
|
@@ -5356,7 +5356,7 @@ declare namespace Enum {
|
|
|
5356
5356
|
|
|
5357
5357
|
export function GetEnumItems(this: defined): Array<Font>
|
|
5358
5358
|
}
|
|
5359
|
-
export type Font = Font.Legacy | Font.Arial | Font.ArialBold | Font.SourceSans | Font.SourceSansBold | Font.SourceSansSemibold | Font.SourceSansLight | Font.SourceSansItalic | Font.Bodoni | Font.Garamond | Font.Cartoon | Font.Code | Font.Highway | Font.SciFi | Font.Arcade | Font.Fantasy | Font.Antique | Font.Gotham | Font.
|
|
5359
|
+
export type Font = Font.Legacy | Font.Arial | Font.ArialBold | Font.SourceSans | Font.SourceSansBold | Font.SourceSansSemibold | Font.SourceSansLight | Font.SourceSansItalic | Font.Bodoni | Font.Garamond | Font.Cartoon | Font.Code | Font.Highway | Font.SciFi | Font.Arcade | Font.Fantasy | Font.Antique | Font.Gotham | Font.GothamMedium | Font.GothamBold | Font.GothamBlack | Font.AmaticSC | Font.Bangers | Font.Creepster | Font.DenkOne | Font.Fondamento | Font.FredokaOne | Font.GrenzeGotisch | Font.IndieFlower | Font.JosefinSans | Font.Jura | Font.Kalam | Font.LuckiestGuy | Font.Merriweather | Font.Michroma | Font.Nunito | Font.Oswald | Font.PatrickHand | Font.PermanentMarker | Font.Roboto | Font.RobotoCondensed | Font.RobotoMono | Font.Sarpanch | Font.SpecialElite | Font.TitilliumWeb | Font.Ubuntu | Font.Unknown;
|
|
5360
5360
|
export namespace FontSize {
|
|
5361
5361
|
export interface Size8 {
|
|
5362
5362
|
Name: "Size8";
|
|
@@ -9252,7 +9252,7 @@ declare namespace Enum {
|
|
|
9252
9252
|
|
|
9253
9253
|
export interface TextDocument_publishDiagnostics {
|
|
9254
9254
|
Name: "TextDocument_publishDiagnostics";
|
|
9255
|
-
Value:
|
|
9255
|
+
Value: 19;
|
|
9256
9256
|
EnumType: EnumType<LSPMethodType>;
|
|
9257
9257
|
}
|
|
9258
9258
|
|
|
@@ -9260,7 +9260,7 @@ declare namespace Enum {
|
|
|
9260
9260
|
|
|
9261
9261
|
export interface Window_showMessage {
|
|
9262
9262
|
Name: "Window_showMessage";
|
|
9263
|
-
Value:
|
|
9263
|
+
Value: 20;
|
|
9264
9264
|
EnumType: EnumType<LSPMethodType>;
|
|
9265
9265
|
}
|
|
9266
9266
|
|
|
@@ -9268,7 +9268,7 @@ declare namespace Enum {
|
|
|
9268
9268
|
|
|
9269
9269
|
export interface Window_showMessageRequest {
|
|
9270
9270
|
Name: "Window_showMessageRequest";
|
|
9271
|
-
Value:
|
|
9271
|
+
Value: 21;
|
|
9272
9272
|
EnumType: EnumType<LSPMethodType>;
|
|
9273
9273
|
}
|
|
9274
9274
|
|
|
@@ -9276,7 +9276,7 @@ declare namespace Enum {
|
|
|
9276
9276
|
|
|
9277
9277
|
export interface Roblox_registerSyntaxCategories {
|
|
9278
9278
|
Name: "Roblox_registerSyntaxCategories";
|
|
9279
|
-
Value:
|
|
9279
|
+
Value: 22;
|
|
9280
9280
|
EnumType: EnumType<LSPMethodType>;
|
|
9281
9281
|
}
|
|
9282
9282
|
|
|
@@ -9284,7 +9284,7 @@ declare namespace Enum {
|
|
|
9284
9284
|
|
|
9285
9285
|
export interface Roblox_signalQuiescence {
|
|
9286
9286
|
Name: "Roblox_signalQuiescence";
|
|
9287
|
-
Value:
|
|
9287
|
+
Value: 23;
|
|
9288
9288
|
EnumType: EnumType<LSPMethodType>;
|
|
9289
9289
|
}
|
|
9290
9290
|
|
|
@@ -9292,7 +9292,7 @@ declare namespace Enum {
|
|
|
9292
9292
|
|
|
9293
9293
|
export interface Roblox_syntaxHighlight {
|
|
9294
9294
|
Name: "Roblox_syntaxHighlight";
|
|
9295
|
-
Value:
|
|
9295
|
+
Value: 24;
|
|
9296
9296
|
EnumType: EnumType<LSPMethodType>;
|
|
9297
9297
|
}
|
|
9298
9298
|
|
|
@@ -9300,7 +9300,7 @@ declare namespace Enum {
|
|
|
9300
9300
|
|
|
9301
9301
|
export interface Roblox_suggestExtraSelections {
|
|
9302
9302
|
Name: "Roblox_suggestExtraSelections";
|
|
9303
|
-
Value:
|
|
9303
|
+
Value: 25;
|
|
9304
9304
|
EnumType: EnumType<LSPMethodType>;
|
|
9305
9305
|
}
|
|
9306
9306
|
|
|
@@ -9308,7 +9308,7 @@ declare namespace Enum {
|
|
|
9308
9308
|
|
|
9309
9309
|
export interface Roblox_findExecutablePosition {
|
|
9310
9310
|
Name: "Roblox_findExecutablePosition";
|
|
9311
|
-
Value:
|
|
9311
|
+
Value: 26;
|
|
9312
9312
|
EnumType: EnumType<LSPMethodType>;
|
|
9313
9313
|
}
|
|
9314
9314
|
|
|
@@ -9316,7 +9316,7 @@ declare namespace Enum {
|
|
|
9316
9316
|
|
|
9317
9317
|
export interface Roblox_findColor3 {
|
|
9318
9318
|
Name: "Roblox_findColor3";
|
|
9319
|
-
Value:
|
|
9319
|
+
Value: 27;
|
|
9320
9320
|
EnumType: EnumType<LSPMethodType>;
|
|
9321
9321
|
}
|
|
9322
9322
|
|
|
@@ -9324,7 +9324,7 @@ declare namespace Enum {
|
|
|
9324
9324
|
|
|
9325
9325
|
export interface Roblox_patchSnippetData {
|
|
9326
9326
|
Name: "Roblox_patchSnippetData";
|
|
9327
|
-
Value:
|
|
9327
|
+
Value: 28;
|
|
9328
9328
|
EnumType: EnumType<LSPMethodType>;
|
|
9329
9329
|
}
|
|
9330
9330
|
|