@rbxts/types 1.0.598 → 1.0.601
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 +42 -15
- 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;
|
|
@@ -1091,7 +1092,9 @@ interface Instance {
|
|
|
1091
1092
|
*/
|
|
1092
1093
|
readonly DescendantRemoving: RBXScriptSignal<(descendant: Instance) => void>;
|
|
1093
1094
|
/**
|
|
1094
|
-
*
|
|
1095
|
+
* The Destroying event fires immediately before the Instance or one of its ancestors is destroyed.
|
|
1096
|
+
*
|
|
1097
|
+
* The Instance will never be deleted from memory while a connected function is still using it. However, if the function yields at any point, the Instance and its descendants will be parented to `nil`.
|
|
1095
1098
|
*/
|
|
1096
1099
|
readonly Destroying: RBXScriptSignal<() => void>;
|
|
1097
1100
|
}
|
|
@@ -4196,13 +4199,13 @@ interface WrapLayer extends BaseWrap {
|
|
|
4196
4199
|
/**
|
|
4197
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.
|
|
4198
4201
|
*/
|
|
4199
|
-
|
|
4202
|
+
Order: number;
|
|
4200
4203
|
/**
|
|
4201
4204
|
* Controls how much underlying clothing items inflate the current clothing item.
|
|
4202
4205
|
*
|
|
4203
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.
|
|
4204
4207
|
*/
|
|
4205
|
-
|
|
4208
|
+
Puffiness: number;
|
|
4206
4209
|
/**
|
|
4207
4210
|
* AssetID for reference mesh used to define Inner Cage of a 3D object
|
|
4208
4211
|
*
|
|
@@ -10162,6 +10165,21 @@ interface GamePassService extends Instance {
|
|
|
10162
10165
|
PlayerHasPass(this: GamePassService, player: Player, gamePassId: number): boolean;
|
|
10163
10166
|
}
|
|
10164
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
|
+
|
|
10165
10183
|
/** A **GlobalDataStore** exposes functions for saving and loading data for the [DataStoreService](https://developer.roblox.com/en-us/api-reference/class/DataStoreService).
|
|
10166
10184
|
*
|
|
10167
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.
|
|
@@ -16186,13 +16204,19 @@ interface ImporterMeshSettings extends ImporterBaseSettings {
|
|
|
16186
16204
|
/**
|
|
16187
16205
|
* Tags: ReadOnly, NotReplicated
|
|
16188
16206
|
*/
|
|
16189
|
-
readonly
|
|
16190
|
-
|
|
16191
|
-
|
|
16207
|
+
readonly CageManifold: boolean;
|
|
16208
|
+
CageManifoldPreview: boolean;
|
|
16209
|
+
/**
|
|
16210
|
+
* Tags: ReadOnly, NotReplicated
|
|
16211
|
+
*/
|
|
16212
|
+
readonly CageNoOverlappingVertices: boolean;
|
|
16213
|
+
CageNoOverlappingVerticesPreview: boolean;
|
|
16192
16214
|
/**
|
|
16193
16215
|
* Tags: ReadOnly, NotReplicated
|
|
16194
16216
|
*/
|
|
16195
|
-
readonly
|
|
16217
|
+
readonly Dimensions: Vector3;
|
|
16218
|
+
DoubleSided: boolean;
|
|
16219
|
+
IgnoreVertexColors: boolean;
|
|
16196
16220
|
/**
|
|
16197
16221
|
* Tags: ReadOnly, NotReplicated
|
|
16198
16222
|
*/
|
|
@@ -16224,6 +16248,7 @@ interface ImporterRootSettings extends ImporterBaseSettings {
|
|
|
16224
16248
|
readonly PolygonCount: number;
|
|
16225
16249
|
RigType: Enum.RigType;
|
|
16226
16250
|
ScaleUnit: Enum.MeshScaleUnit;
|
|
16251
|
+
UseSceneOriginAsPivot: boolean;
|
|
16227
16252
|
WorldForward: Enum.NormalId;
|
|
16228
16253
|
WorldUp: Enum.NormalId;
|
|
16229
16254
|
}
|
|
@@ -21066,6 +21091,10 @@ interface MarketplaceService extends Instance {
|
|
|
21066
21091
|
* Tags: Yields
|
|
21067
21092
|
*/
|
|
21068
21093
|
PlayerOwnsAsset(this: MarketplaceService, player: Player, assetId: number): boolean;
|
|
21094
|
+
/**
|
|
21095
|
+
* Tags: Yields
|
|
21096
|
+
*/
|
|
21097
|
+
PlayerOwnsBundle(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
21069
21098
|
/**
|
|
21070
21099
|
* 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).
|
|
21071
21100
|
*
|
|
@@ -21172,15 +21201,9 @@ interface MaterialService extends Instance {
|
|
|
21172
21201
|
* @deprecated
|
|
21173
21202
|
*/
|
|
21174
21203
|
readonly _nominal_MaterialService: unique symbol;
|
|
21175
|
-
ClearOverridePartMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): void;
|
|
21176
|
-
ClearOverrideTerrainMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): void;
|
|
21177
21204
|
GetBaseMaterialOverride(this: MaterialService, material: CastsToEnum<Enum.Material>): string;
|
|
21178
21205
|
GetMaterialVariant(this: MaterialService, material: CastsToEnum<Enum.Material>, name: string): MaterialVariant;
|
|
21179
|
-
GetOverridePartMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): MaterialVariant;
|
|
21180
|
-
GetOverrideTerrainMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): MaterialVariant;
|
|
21181
21206
|
SetBaseMaterialOverride(this: MaterialService, material: CastsToEnum<Enum.Material>, name: string): void;
|
|
21182
|
-
SetOverridePartMaterial(this: MaterialService, materialVariant: MaterialVariant): void;
|
|
21183
|
-
SetOverrideTerrainMaterial(this: MaterialService, materialVariant: MaterialVariant): void;
|
|
21184
21207
|
}
|
|
21185
21208
|
|
|
21186
21209
|
interface MaterialVariant extends Instance {
|
|
@@ -26822,11 +26845,11 @@ interface Players extends Instance {
|
|
|
26822
26845
|
* local Players = game:GetService("Players")
|
|
26823
26846
|
*
|
|
26824
26847
|
* Players.PlayerAdded:Connect(function(player)
|
|
26825
|
-
* print(player.Name
|
|
26848
|
+
* print(player.Name .. " joined the game!")
|
|
26826
26849
|
* end)
|
|
26827
26850
|
*
|
|
26828
26851
|
* Players.PlayerRemoving:Connect(function(player)
|
|
26829
|
-
* print(player.Name
|
|
26852
|
+
* print(player.Name .. " left the game!")
|
|
26830
26853
|
* end)
|
|
26831
26854
|
*
|
|
26832
26855
|
* If you want to track when a player's character is added or removed from the game, such as when a player respawns or dies, you can use the [Player.CharacterAdded](https://developer.roblox.com/en-us/api-reference/event/Player/CharacterAdded) and [Player.CharacterRemoving](https://developer.roblox.com/en-us/api-reference/event/Player/CharacterRemoving) functions.
|
|
@@ -31726,6 +31749,10 @@ interface TextService extends Instance {
|
|
|
31726
31749
|
* Tags: Yields
|
|
31727
31750
|
*/
|
|
31728
31751
|
GetFamilyInfoAsync(this: TextService, assetId: string): object;
|
|
31752
|
+
/**
|
|
31753
|
+
* Tags: Yields
|
|
31754
|
+
*/
|
|
31755
|
+
GetTextBoundsAsync(this: TextService, params: GetTextBoundsParams): Vector2;
|
|
31729
31756
|
}
|
|
31730
31757
|
|
|
31731
31758
|
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
|
|