@rbxts/types 1.0.554 → 1.0.558

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.
@@ -92,6 +92,7 @@ interface Services {
92
92
  TeleportService: TeleportService;
93
93
  TemporaryCageMeshProvider: TemporaryCageMeshProvider;
94
94
  TemporaryScriptService: TemporaryScriptService;
95
+ TextBoxService: TextBoxService;
95
96
  TextChatService: TextChatService;
96
97
  TextService: TextService;
97
98
  ToastNotificationService: ToastNotificationService;
@@ -187,6 +188,7 @@ interface CreatableInstances {
187
188
  Glue: Glue;
188
189
  Handles: Handles;
189
190
  Hat: Hat;
191
+ HiddenSurfaceRemovalAsset: HiddenSurfaceRemovalAsset;
190
192
  Highlight: Highlight;
191
193
  HingeConstraint: HingeConstraint;
192
194
  Hole: Hole;
@@ -1129,7 +1131,7 @@ interface Accessory extends Accoutrement {
1129
1131
  */
1130
1132
  readonly _nominal_Accessory: unique symbol;
1131
1133
  /**
1132
- * Specifies the AccessoryType of the Accessory. Will be `Enum/AccessoryType|AccessoryType.Unknown` unless the Accessory has been equipped through the player spawning process or [Humanoid:ApplyDescription](https://developer.roblox.com/en-us/api-reference/function/Humanoid/ApplyDescription).
1134
+ * Specifies the AccessoryType of the Accessory. Will be `Enum/AccessoryType|AccessoryType.Unknown` unless the Accessory has been equipped through the player spawning process or [Humanoid:ApplyDescription](https://developer.roblox.com/en-us/api-reference/function/Humanoid/ApplyDescription). If available on the Avatar shop, the Accessory item is categorized by the set [AccessoryType](https://developer.roblox.com/en-us/api-reference/enum/AccessoryType) (for example, “Hat” or “Face”).
1133
1135
  */
1134
1136
  readonly AccessoryType: Enum.AccessoryType;
1135
1137
  }
@@ -2960,12 +2962,16 @@ interface Tool extends BackpackItem {
2960
2962
  /**
2961
2963
  * The Equipped event fires when a player when a player takes a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) out of their [Backpack](https://developer.roblox.com/en-us/api-reference/class/Backpack) to use. This event can be used to determine when a player stops using and puts a tool away.
2962
2964
  *
2965
+ * This event does not fire when [Tool.RequiresHandle](https://developer.roblox.com/en-us/api-reference/property/Tool/RequiresHandle) is enabled and no handle is present.
2966
+ *
2963
2967
  * The opposite of this event, [Tool.Unequipped](https://developer.roblox.com/en-us/api-reference/event/Tool/Unequipped), can be used alongside this event to determine unequips a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) by putting in back in their backpack.
2964
2968
  */
2965
2969
  readonly Equipped: RBXScriptSignal<(mouse: Mouse) => void>;
2966
2970
  /**
2967
2971
  * The Unequipped event fires when a player unequips a [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) by putting in back in their [Backpack](https://developer.roblox.com/en-us/api-reference/class/Backpack). This event can be used to determine when a player stops using and puts a tool away.
2968
2972
  *
2973
+ * This event does not fire when [Tool.RequiresHandle](https://developer.roblox.com/en-us/api-reference/property/Tool/RequiresHandle) is enabled and no handle is present.
2974
+ *
2969
2975
  * The opposite of this event, [Tool.Equipped](https://developer.roblox.com/en-us/api-reference/event/Tool/Equipped), can be used alongside this event to determine when a player takes a tool out of their backpack to use.
2970
2976
  *
2971
2977
  * The example shown below will print “A tool was unequipped” each time the tool is unequipped by the player. Please note that the below example assumes that you've already defined what “Tool” is.
@@ -10212,7 +10218,7 @@ interface GroupService extends Instance {
10212
10218
  *
10213
10219
  * A boolean indicating if this is the player's primary group
10214
10220
  *
10215
- * IsInClan
10221
+ * ### IsInClan
10216
10222
  *
10217
10223
  * A boolean indicating if the player is in this group's clan
10218
10224
  *
@@ -13360,6 +13366,17 @@ interface HeightmapImporterService extends Instance {
13360
13366
  readonly _nominal_HeightmapImporterService: unique symbol;
13361
13367
  }
13362
13368
 
13369
+ interface HiddenSurfaceRemovalAsset extends Instance {
13370
+ /**
13371
+ * **DO NOT USE!**
13372
+ *
13373
+ * This field exists to force TypeScript to recognize this as a nominal type
13374
+ * @hidden
13375
+ * @deprecated
13376
+ */
13377
+ readonly _nominal_HiddenSurfaceRemovalAsset: unique symbol;
13378
+ }
13379
+
13363
13380
  interface Highlight extends Instance {
13364
13381
  /**
13365
13382
  * **DO NOT USE!**
@@ -17755,11 +17772,11 @@ interface JointsService extends Instance {
17755
17772
  */
17756
17773
  CreateJoinAfterMoveJoints(this: JointsService): void;
17757
17774
  /**
17758
- * Sets the PVInstance that will be connected with the target PVInstance specified by [SetJoinAfterMoveTarget](https://developer.roblox.com/api-reference/function/JointsService/SetJoinAfterMoveTarget "SetJoinAfterMoveTarget").
17775
+ * Sets the PVInstance that will be connected with the target PVInstance specified by [JointsService:SetJoinAfterMoveTarget](https://developer.roblox.com/en-us/api-reference/function/JointsService/SetJoinAfterMoveTarget).
17759
17776
  */
17760
17777
  SetJoinAfterMoveInstance(this: JointsService, joinInstance: PVInstance): void;
17761
17778
  /**
17762
- * Sets the PVInstance that will be connected with the PVInstance specified by [SetJoinAfterMoveInstance](https://developer.roblox.com/api-reference/function/JointsService/SetJoinAfterMoveInstance "SetJoinAfterMoveInstance").
17779
+ * Sets the PVInstance that will be connected with the PVInstance specified by [JointsService:SetJoinAfterMoveInstance](https://developer.roblox.com/en-us/api-reference/function/JointsService/SetJoinAfterMoveInstance).
17763
17780
  */
17764
17781
  SetJoinAfterMoveTarget(this: JointsService, joinTarget: PVInstance): void;
17765
17782
  /**
@@ -23214,7 +23231,7 @@ interface Model extends PVInstance {
23214
23231
  TranslateBy(this: Model, delta: Vector3): void;
23215
23232
  }
23216
23233
 
23217
- /** Actor */
23234
+ /** This is the Actor Class */
23218
23235
  interface Actor extends Model {
23219
23236
  /**
23220
23237
  * **DO NOT USE!**
@@ -24163,6 +24180,11 @@ interface ParticleEmitter extends Instance {
24163
24180
  * If you want no particles to render, you should call [ParticleEmitter:Clear](https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Clear) to clear any existing particles. You can use [ParticleEmitter:Emit](https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Emit) on disabled [ParticleEmitter](https://developer.roblox.com/en-us/api-reference/class/ParticleEmitter)s and they will still emit and render particles.
24164
24181
  */
24165
24182
  Enabled: boolean;
24183
+ FlipbookFramerate: NumberRange;
24184
+ FlipbookIncompatible: string;
24185
+ FlipbookLayout: Enum.ParticleFlipbookLayout;
24186
+ FlipbookMode: Enum.ParticleFlipbookMode;
24187
+ FlipbookStartRandom: boolean;
24166
24188
  /**
24167
24189
  * The Lifetime property defines the maximum and minimum ages a newly emit particle will. When a particle is emit, a random lifetime is chosen uniformly. Lifetimes are stored on a per-particle basis, so if this value is changed, existing particles will stay “alive” until their randomly chosen lifetime is lived. The bounds for this property should be in the range \[0, 20\]. By default, [ParticleEmitter](https://developer.roblox.com/en-us/api-reference/class/ParticleEmitter)s will have a lifetime of 5 to 10 seconds. A lifetime of 0 will prevent particles from being emit in the first place.
24168
24190
  *
@@ -24652,19 +24674,19 @@ interface PhysicsService extends Instance {
24652
24674
  * This function will throw a runtime error in the following circumstances:
24653
24675
  *
24654
24676
  * * The specified group does not exist.
24655
- * * The specified part is not a BasePart.Returns whether the part is in the collision group.
24677
+ * * The specified part is not a BasePart.
24656
24678
  */
24657
24679
  CollisionGroupContainsPart(this: PhysicsService, name: string, part: BasePart): boolean;
24658
24680
  /**
24659
24681
  * Sets the collision status between two groups.
24660
24682
  *
24661
- * This function will throw an error if either of the groups do not exist.Sets the collision status between two groups.
24683
+ * This function will throw an error if either of the groups do not exist.
24662
24684
  */
24663
24685
  CollisionGroupSetCollidable(this: PhysicsService, name1: string, name2: string, collidable: boolean): void;
24664
24686
  /**
24665
24687
  * Returns whether the two specified collision groups will collide.
24666
24688
  *
24667
- * This function will throw an error if either of the groups do not exist.Returns whether the two groups will collide.
24689
+ * This function will throw an error if either of the groups do not exist.
24668
24690
  */
24669
24691
  CollisionGroupsAreCollidable(this: PhysicsService, name1: string, name2: string): boolean;
24670
24692
  /**
@@ -24680,7 +24702,7 @@ interface PhysicsService extends Instance {
24680
24702
  /**
24681
24703
  * Returns the name of the collision group with the corresponding id. This function will return nil if the group with the corresponding id has not been named.
24682
24704
  *
24683
- * This function will throw an error if the id is not in the range of 0 <= id < maxCollisionGroupsReturns the name of the group with the corresponding id.
24705
+ * This function will throw an error if the id is not in the range of 0 <= id < maxCollisionGroups
24684
24706
  */
24685
24707
  GetCollisionGroupName(this: PhysicsService, name: number): string;
24686
24708
  /**
@@ -24723,7 +24745,7 @@ interface PhysicsService extends Instance {
24723
24745
  * This function will throw a runtime error in the following circumstances:
24724
24746
  *
24725
24747
  * * The name “Default” is provided.
24726
- * * The function is called from a client.Removes the collision group with the given name.
24748
+ * * The function is called from a client.
24727
24749
  */
24728
24750
  RemoveCollisionGroup(this: PhysicsService, name: string): void;
24729
24751
  /**
@@ -24734,7 +24756,7 @@ interface PhysicsService extends Instance {
24734
24756
  * This function will throw a runtime error in the following circumstances:
24735
24757
  *
24736
24758
  * * Invalid or empty name provided for either argument.
24737
- * * The function is called from a client.Renames specified collision group.
24759
+ * * The function is called from a client.
24738
24760
  */
24739
24761
  RenameCollisionGroup(this: PhysicsService, from: string, to: string): void;
24740
24762
  /**
@@ -26663,7 +26685,9 @@ interface RemoteEvent<T extends Callback = Callback> extends Instance {
26663
26685
  *
26664
26686
  * Since this function is used to communicate from the server to the client, it will only work when used in a [Script](https://developer.roblox.com/en-us/api-reference/class/Script).
26665
26687
  *
26666
- * The functionality of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
26688
+ * The behavior of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
26689
+ *
26690
+ * There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
26667
26691
  *
26668
26692
  * Note
26669
26693
  * ----
@@ -26676,6 +26700,8 @@ interface RemoteEvent<T extends Callback = Callback> extends Instance {
26676
26700
  *
26677
26701
  * Since this function is used for communication from server to client, so it will only work when used by a server-side [Script](https://developer.roblox.com/en-us/api-reference/class/Script). For client-to-server communication (the other direction), use [FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer). Direct client-to-client communication not possible on Roblox; however, it can be simulated using a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) that relays information received through some other means, such as [FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer).
26678
26702
  *
26703
+ * There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
26704
+ *
26679
26705
  * See also
26680
26706
  * --------
26681
26707
  *
@@ -26693,7 +26719,9 @@ interface RemoteEvent<T extends Callback = Callback> extends Instance {
26693
26719
  *
26694
26720
  * When firing from the client note that nothing has to be passed in by default (unlike firing to the client from the server - where the player is passed in).
26695
26721
  *
26696
- * The functionality of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
26722
+ * The behavior of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
26723
+ *
26724
+ * There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
26697
26725
  */
26698
26726
  FireServer(this: RemoteEvent, ...args: Parameters<T>): void;
26699
26727
  /**
@@ -26750,7 +26778,9 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
26750
26778
  * Warning
26751
26779
  * -------
26752
26780
  *
26753
- * If a client disconnects or leaves the game while it is being invoked from the server, the InvokeClient function will error. It is therefore recommended to wrap this function in a pcall so it does stop the execution of other code.
26781
+ * If a client disconnects or leaves the game while it is being invoked from the server, the InvokeClient function will error. It is therefore recommended to wrap this function in a pcall so it doesn't stop the execution of other code.
26782
+ *
26783
+ * There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
26754
26784
  * Tags: Yields
26755
26785
  */
26756
26786
  InvokeClient(this: RemoteFunction, player: Player, ...args: Parameters<T>): unknown;
@@ -26767,6 +26797,8 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
26767
26797
  * ----
26768
26798
  *
26769
26799
  * When handling the invocation from the client note that nothing has to be passed in by default (unlike invoking the server where the player is passed in).
26800
+ *
26801
+ * There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
26770
26802
  * Tags: Yields
26771
26803
  */
26772
26804
  InvokeServer(this: RemoteFunction, ...args: Parameters<T>): ReturnType<T>;
@@ -30580,6 +30612,17 @@ interface TerrainRegion extends Instance {
30580
30612
  readonly SizeInCells: Vector3;
30581
30613
  }
30582
30614
 
30615
+ interface TextBoxService extends Instance {
30616
+ /**
30617
+ * **DO NOT USE!**
30618
+ *
30619
+ * This field exists to force TypeScript to recognize this as a nominal type
30620
+ * @hidden
30621
+ * @deprecated
30622
+ */
30623
+ readonly _nominal_TextBoxService: unique symbol;
30624
+ }
30625
+
30583
30626
  interface TextChannel extends Instance {
30584
30627
  /**
30585
30628
  * **DO NOT USE!**
@@ -34267,6 +34310,9 @@ interface Vector3Curve extends Instance {
34267
34310
  * @deprecated
34268
34311
  */
34269
34312
  readonly _nominal_Vector3Curve: unique symbol;
34313
+ /**
34314
+ * Samples the 3 FloatCurves (X, Y, Z) at the time passed as argument. Returns the 3 samples as a tuple of 3 numbers. If a channel curve is missing or no key is found in the curve the channel is evaluated as nil.
34315
+ */
34270
34316
  GetValueAtTime(this: Vector3Curve, time: number): unknown;
34271
34317
  /**
34272
34318
  * Returns the FloatCurve controlling the X channel. It is the first child instance of type FloatCurve named `X`. If none is found an empty FloatCurve is created.
@@ -3394,6 +3394,7 @@ interface Studio extends Instance {
3394
3394
  readonly ["Show Light Guides"]: boolean;
3395
3395
  readonly ["Show Navigation Areas"]: boolean;
3396
3396
  ["Show Navigation Mesh"]: boolean;
3397
+ readonly ["Show Pathfinding Links"]: boolean;
3397
3398
  ["Show Plugin GUI Service in Explorer"]: boolean;
3398
3399
  ["Show QT warnings in output"]: boolean;
3399
3400
  ["Show Whitespace"]: boolean;
@@ -3642,6 +3643,7 @@ interface StudioService extends Instance {
3642
3643
  * displayClassIcon(imageLabel, "Part")
3643
3644
  */
3644
3645
  GetClassIcon(this: StudioService, className: string): object;
3646
+ GetPlaceIsPersistedToCloud(this: StudioService): boolean;
3645
3647
  GetResourceByCategory(this: StudioService, category: string): object;
3646
3648
  GetStartupAssetId(this: StudioService): string;
3647
3649
  GetStartupPluginId(this: StudioService): string;
@@ -3650,15 +3652,18 @@ interface StudioService extends Instance {
3650
3652
  * Returns the studio user's userId if they're logged in, otherwise returns 0.
3651
3653
  */
3652
3654
  GetUserId(this: StudioService): number;
3655
+ GetUserIsInTeamCreateToggleRamp(this: StudioService): boolean;
3653
3656
  GizmoRaycast(this: StudioService, origin: Vector3, direction: Vector3, raycastParams?: RaycastParams): RaycastResult;
3654
3657
  HasInternalPermission(this: StudioService): boolean;
3655
3658
  IsPluginInstalled(this: StudioService, assetId: number): boolean;
3656
3659
  IsPluginUpToDate(this: StudioService, assetId: number, currentAssetVersion: number): boolean;
3657
3660
  OpenInBrowser_DONOTUSE(this: StudioService, url: string): void;
3658
3661
  PublishAs(this: StudioService, universeId: number, placeId: number, groupId: number): void;
3662
+ RefreshDocumentDisplayName(this: StudioService): void;
3659
3663
  RequestClose(this: StudioService, closeMode: CastsToEnum<Enum.StudioCloseMode>): void;
3660
3664
  SerializeInstances(this: StudioService, instances: Array<Instance>): string;
3661
3665
  SetPluginEnabled(this: StudioService, assetId: number, state: boolean): void;
3666
+ SetTurnOnTeamCreateOnPublish(this: StudioService, turnOn: boolean): void;
3662
3667
  SetUniverseDisplayName(this: StudioService, newName: string): void;
3663
3668
  ShowPlaceVersionHistoryDialog(this: StudioService, placeId: number): void;
3664
3669
  ShowPublishToRoblox(this: StudioService): void;
@@ -3222,6 +3222,14 @@ declare namespace Enum {
3222
3222
 
3223
3223
  export const DisconnectClientFailure: DisconnectClientFailure;
3224
3224
 
3225
+ export interface DisconnectClientRequest {
3226
+ Name: "DisconnectClientRequest";
3227
+ Value: 285;
3228
+ EnumType: EnumType<ConnectionError>;
3229
+ }
3230
+
3231
+ export const DisconnectClientRequest: DisconnectClientRequest;
3232
+
3225
3233
  export interface PlacelaunchErrors {
3226
3234
  Name: "PlacelaunchErrors";
3227
3235
  Value: 512;
@@ -3408,7 +3416,7 @@ declare namespace Enum {
3408
3416
 
3409
3417
  export function GetEnumItems(this: defined): Array<ConnectionError>
3410
3418
  }
3411
- export type ConnectionError = ConnectionError.OK | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
3419
+ export type ConnectionError = ConnectionError.OK | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
3412
3420
  export namespace ConnectionState {
3413
3421
  export interface Connected {
3414
3422
  Name: "Connected";
@@ -3918,9 +3926,17 @@ declare namespace Enum {
3918
3926
 
3919
3927
  export const InvalidArgument: InvalidArgument;
3920
3928
 
3929
+ export interface ConnectionClosed {
3930
+ Name: "ConnectionClosed";
3931
+ Value: 8;
3932
+ EnumType: EnumType<DebuggerStatus>;
3933
+ }
3934
+
3935
+ export const ConnectionClosed: ConnectionClosed;
3936
+
3921
3937
  export function GetEnumItems(this: defined): Array<DebuggerStatus>
3922
3938
  }
3923
- export type DebuggerStatus = DebuggerStatus.Success | DebuggerStatus.Timeout | DebuggerStatus.ConnectionLost | DebuggerStatus.InvalidResponse | DebuggerStatus.InternalError | DebuggerStatus.InvalidState | DebuggerStatus.RpcError | DebuggerStatus.InvalidArgument;
3939
+ export type DebuggerStatus = DebuggerStatus.Success | DebuggerStatus.Timeout | DebuggerStatus.ConnectionLost | DebuggerStatus.InvalidResponse | DebuggerStatus.InternalError | DebuggerStatus.InvalidState | DebuggerStatus.RpcError | DebuggerStatus.InvalidArgument | DebuggerStatus.ConnectionClosed;
3924
3940
  export namespace DevCameraOcclusionMode {
3925
3941
  export interface Zoom {
3926
3942
  Name: "Zoom";
@@ -4192,7 +4208,7 @@ declare namespace Enum {
4192
4208
 
4193
4209
  export interface GraphicsMeshParts {
4194
4210
  Name: "GraphicsMeshParts";
4195
- Value: 9;
4211
+ Value: 10;
4196
4212
  EnumType: EnumType<DeveloperMemoryTag>;
4197
4213
  }
4198
4214
 
@@ -4200,7 +4216,7 @@ declare namespace Enum {
4200
4216
 
4201
4217
  export interface GraphicsParticles {
4202
4218
  Name: "GraphicsParticles";
4203
- Value: 10;
4219
+ Value: 11;
4204
4220
  EnumType: EnumType<DeveloperMemoryTag>;
4205
4221
  }
4206
4222
 
@@ -4208,7 +4224,7 @@ declare namespace Enum {
4208
4224
 
4209
4225
  export interface GraphicsParts {
4210
4226
  Name: "GraphicsParts";
4211
- Value: 11;
4227
+ Value: 12;
4212
4228
  EnumType: EnumType<DeveloperMemoryTag>;
4213
4229
  }
4214
4230
 
@@ -4216,7 +4232,7 @@ declare namespace Enum {
4216
4232
 
4217
4233
  export interface GraphicsSpatialHash {
4218
4234
  Name: "GraphicsSpatialHash";
4219
- Value: 12;
4235
+ Value: 13;
4220
4236
  EnumType: EnumType<DeveloperMemoryTag>;
4221
4237
  }
4222
4238
 
@@ -4224,7 +4240,7 @@ declare namespace Enum {
4224
4240
 
4225
4241
  export interface GraphicsTerrain {
4226
4242
  Name: "GraphicsTerrain";
4227
- Value: 13;
4243
+ Value: 14;
4228
4244
  EnumType: EnumType<DeveloperMemoryTag>;
4229
4245
  }
4230
4246
 
@@ -4232,7 +4248,7 @@ declare namespace Enum {
4232
4248
 
4233
4249
  export interface GraphicsTexture {
4234
4250
  Name: "GraphicsTexture";
4235
- Value: 14;
4251
+ Value: 15;
4236
4252
  EnumType: EnumType<DeveloperMemoryTag>;
4237
4253
  }
4238
4254
 
@@ -4240,7 +4256,7 @@ declare namespace Enum {
4240
4256
 
4241
4257
  export interface GraphicsTextureCharacter {
4242
4258
  Name: "GraphicsTextureCharacter";
4243
- Value: 15;
4259
+ Value: 16;
4244
4260
  EnumType: EnumType<DeveloperMemoryTag>;
4245
4261
  }
4246
4262
 
@@ -4248,7 +4264,7 @@ declare namespace Enum {
4248
4264
 
4249
4265
  export interface Sounds {
4250
4266
  Name: "Sounds";
4251
- Value: 16;
4267
+ Value: 17;
4252
4268
  EnumType: EnumType<DeveloperMemoryTag>;
4253
4269
  }
4254
4270
 
@@ -4256,7 +4272,7 @@ declare namespace Enum {
4256
4272
 
4257
4273
  export interface StreamingSounds {
4258
4274
  Name: "StreamingSounds";
4259
- Value: 17;
4275
+ Value: 18;
4260
4276
  EnumType: EnumType<DeveloperMemoryTag>;
4261
4277
  }
4262
4278
 
@@ -4264,7 +4280,7 @@ declare namespace Enum {
4264
4280
 
4265
4281
  export interface TerrainVoxels {
4266
4282
  Name: "TerrainVoxels";
4267
- Value: 18;
4283
+ Value: 19;
4268
4284
  EnumType: EnumType<DeveloperMemoryTag>;
4269
4285
  }
4270
4286
 
@@ -4272,7 +4288,7 @@ declare namespace Enum {
4272
4288
 
4273
4289
  export interface Gui {
4274
4290
  Name: "Gui";
4275
- Value: 20;
4291
+ Value: 21;
4276
4292
  EnumType: EnumType<DeveloperMemoryTag>;
4277
4293
  }
4278
4294
 
@@ -4280,7 +4296,7 @@ declare namespace Enum {
4280
4296
 
4281
4297
  export interface Animation {
4282
4298
  Name: "Animation";
4283
- Value: 21;
4299
+ Value: 22;
4284
4300
  EnumType: EnumType<DeveloperMemoryTag>;
4285
4301
  }
4286
4302
 
@@ -4288,7 +4304,7 @@ declare namespace Enum {
4288
4304
 
4289
4305
  export interface Navigation {
4290
4306
  Name: "Navigation";
4291
- Value: 22;
4307
+ Value: 23;
4292
4308
  EnumType: EnumType<DeveloperMemoryTag>;
4293
4309
  }
4294
4310
 
@@ -10265,6 +10281,78 @@ declare namespace Enum {
10265
10281
  export function GetEnumItems(this: defined): Array<ParticleEmitterShapeStyle>
10266
10282
  }
10267
10283
  export type ParticleEmitterShapeStyle = ParticleEmitterShapeStyle.Volume | ParticleEmitterShapeStyle.Surface;
10284
+ export namespace ParticleFlipbookLayout {
10285
+ export interface None {
10286
+ Name: "None";
10287
+ Value: 0;
10288
+ EnumType: EnumType<ParticleFlipbookLayout>;
10289
+ }
10290
+
10291
+ export const None: None;
10292
+
10293
+ export interface TwoByTwo {
10294
+ Name: "TwoByTwo";
10295
+ Value: 1;
10296
+ EnumType: EnumType<ParticleFlipbookLayout>;
10297
+ }
10298
+
10299
+ export const TwoByTwo: TwoByTwo;
10300
+
10301
+ export interface FourByFour {
10302
+ Name: "FourByFour";
10303
+ Value: 2;
10304
+ EnumType: EnumType<ParticleFlipbookLayout>;
10305
+ }
10306
+
10307
+ export const FourByFour: FourByFour;
10308
+
10309
+ export interface EightByEight {
10310
+ Name: "EightByEight";
10311
+ Value: 3;
10312
+ EnumType: EnumType<ParticleFlipbookLayout>;
10313
+ }
10314
+
10315
+ export const EightByEight: EightByEight;
10316
+
10317
+ export function GetEnumItems(this: defined): Array<ParticleFlipbookLayout>
10318
+ }
10319
+ export type ParticleFlipbookLayout = ParticleFlipbookLayout.None | ParticleFlipbookLayout.TwoByTwo | ParticleFlipbookLayout.FourByFour | ParticleFlipbookLayout.EightByEight;
10320
+ export namespace ParticleFlipbookMode {
10321
+ export interface Loop {
10322
+ Name: "Loop";
10323
+ Value: 0;
10324
+ EnumType: EnumType<ParticleFlipbookMode>;
10325
+ }
10326
+
10327
+ export const Loop: Loop;
10328
+
10329
+ export interface OneShot {
10330
+ Name: "OneShot";
10331
+ Value: 1;
10332
+ EnumType: EnumType<ParticleFlipbookMode>;
10333
+ }
10334
+
10335
+ export const OneShot: OneShot;
10336
+
10337
+ export interface PingPong {
10338
+ Name: "PingPong";
10339
+ Value: 2;
10340
+ EnumType: EnumType<ParticleFlipbookMode>;
10341
+ }
10342
+
10343
+ export const PingPong: PingPong;
10344
+
10345
+ export interface Random {
10346
+ Name: "Random";
10347
+ Value: 3;
10348
+ EnumType: EnumType<ParticleFlipbookMode>;
10349
+ }
10350
+
10351
+ export const Random: Random;
10352
+
10353
+ export function GetEnumItems(this: defined): Array<ParticleFlipbookMode>
10354
+ }
10355
+ export type ParticleFlipbookMode = ParticleFlipbookMode.Loop | ParticleFlipbookMode.OneShot | ParticleFlipbookMode.PingPong | ParticleFlipbookMode.Random;
10268
10356
  export namespace ParticleOrientation {
10269
10357
  export interface FacingCamera {
10270
10358
  Name: "FacingCamera";
package/include/lua.d.ts CHANGED
@@ -721,6 +721,9 @@ declare namespace coroutine {
721
721
 
722
722
  /** Suspends the execution of the calling coroutine. Any arguments to yield are passed as extra results to resume. */
723
723
  function yield(...params: Array<unknown>): LuaTuple<Array<unknown>>;
724
+
725
+ /** Takes a suspended coroutine and makes it "dead" (non-runnable). */
726
+ function close(co: thread): void;
724
727
  }
725
728
 
726
729
  declare function next<T extends ReadonlyArray<any>>(
@@ -1052,6 +1052,8 @@ interface CFrame {
1052
1052
  readonly _nominal_CFrame: unique symbol;
1053
1053
  /** The 3D position of the CFrame */
1054
1054
  readonly Position: Vector3;
1055
+ /** A copy of the CFrame with no translation. */
1056
+ readonly Rotation: CFrame;
1055
1057
  /** The x-coordinate of the position */
1056
1058
  readonly X: number;
1057
1059
  /** The y-coordinate of the position */
@@ -1101,6 +1103,17 @@ interface CFrame {
1101
1103
  }
1102
1104
 
1103
1105
  interface CFrameConstructor {
1106
+ /**
1107
+ * An identity CFrame, one with no translation or rotation.
1108
+ *
1109
+ * This API member is a **constant**, and must be accessed through the `CFrame` global as opposed to an individual
1110
+ * `CFrame` object.
1111
+ *
1112
+ * ```lua
1113
+ * print(CFrame.identity) --> 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1
1114
+ * ```
1115
+ */
1116
+ readonly identity: CFrame;
1104
1117
  /** Equivalent to fromEulerAnglesXYZ */
1105
1118
  Angles: (rX: number, rY: number, rZ: number) => CFrame;
1106
1119
  /** Creates a rotated CFrame from a Unit Vector3 and a rotation in radians */
@@ -1807,7 +1820,9 @@ interface Vector2 {
1807
1820
  * @deprecated
1808
1821
  */
1809
1822
  readonly _nominal_Vector2: unique symbol;
1823
+ /** The x-coordinate of the Vector2. */
1810
1824
  readonly X: number;
1825
+ /** The y-coordinate of the Vector2. */
1811
1826
  readonly Y: number;
1812
1827
  /** A normalized copy of the vector - has a magnitude of 1. */
1813
1828
  readonly Unit: Vector2;
@@ -1821,7 +1836,54 @@ interface Vector2 {
1821
1836
  Cross(this: Vector2, other: Vector2): number;
1822
1837
  }
1823
1838
 
1824
- type Vector2Constructor = new (x?: number, y?: number) => Vector2;
1839
+ interface Vector2Constructor {
1840
+ /**
1841
+ * A Vector2 with a magnitude of zero.
1842
+ *
1843
+ * This API member is a **constant**, and must be accessed through the `Vector2` global as opposed to an individual
1844
+ * `Vector2` object.
1845
+ *
1846
+ * ```lua
1847
+ * print(Vector2.zero) --> 0, 0
1848
+ * ```
1849
+ */
1850
+ readonly zero: Vector2;
1851
+ /**
1852
+ * A Vector2 with a value of 1 on every axis.
1853
+ *
1854
+ * This API member is a **constant**, and must be accessed through the `Vector2` global as opposed to an individual
1855
+ * `Vector2` object.
1856
+ *
1857
+ * ```lua
1858
+ * print(Vector2.one) --> 1, 1
1859
+ * ```
1860
+ */
1861
+ readonly one: Vector2;
1862
+ /**
1863
+ * A Vector2 with a value of 1 on the X axis.
1864
+ *
1865
+ * This API member is a **constant**, and must be accessed through the `Vector2` global as opposed to an individual
1866
+ * `Vector2` object.
1867
+ *
1868
+ * ```lua
1869
+ * print(Vector2.xAxis) --> 1, 0
1870
+ * ```
1871
+ */
1872
+ readonly xAxis: Vector2;
1873
+ /**
1874
+ * A Vector2 with a value of 1 on the Y axis.
1875
+ *
1876
+ * This API member is a **constant**, and must be accessed through the `Vector2` global as opposed to an individual
1877
+ * `Vector2` object.
1878
+ *
1879
+ * ```lua
1880
+ * print(Vector2.yAxis) --> 0, 1
1881
+ * ```
1882
+ */
1883
+ readonly yAxis: Vector2;
1884
+ /** Returns a Vector2 from the given x and y components. */
1885
+ new (x?: number, y?: number): Vector2;
1886
+ }
1825
1887
 
1826
1888
  declare const Vector2: Vector2Constructor;
1827
1889
 
@@ -1871,8 +1933,66 @@ interface Vector3 {
1871
1933
  }
1872
1934
 
1873
1935
  interface Vector3Constructor {
1936
+ /**
1937
+ * A Vector3 with a magnitude of zero.
1938
+ *
1939
+ * This API member is a **constant**, and must be accessed through the `Vector3` global as opposed to an individual
1940
+ * `Vector3` object.
1941
+ *
1942
+ * ```lua
1943
+ * print(Vector3.zero) --> 0, 0, 0
1944
+ * ```
1945
+ */
1946
+ readonly zero: Vector3;
1947
+ /**
1948
+ * A Vector3 with a value of 1 on every axis.
1949
+ *
1950
+ * This API member is a **constant**, and must be accessed through the `Vector3` global as opposed to an individual
1951
+ * `Vector3` object.
1952
+ *
1953
+ * ```lua
1954
+ * print(Vector3.one) --> 1, 1, 1
1955
+ * ```
1956
+ */
1957
+ readonly one: Vector3;
1958
+ /**
1959
+ * A Vector3 with a value of 1 on the X axis.
1960
+ *
1961
+ * This API member is a **constant**, and must be accessed through the `Vector3` global as opposed to an individual
1962
+ * `Vector3` object.
1963
+ *
1964
+ * ```lua
1965
+ * print(Vector3.xAxis) --> 1, 0, 0
1966
+ * ```
1967
+ */
1968
+ readonly xAxis: Vector3;
1969
+ /**
1970
+ * A Vector3 with a value of 1 on the Y axis.
1971
+ *
1972
+ * This API member is a **constant**, and must be accessed through the `Vector3` global as opposed to an individual
1973
+ * `Vector3` object.
1974
+ *
1975
+ * ```lua
1976
+ * print(Vector3.yAxis) --> 0, 1, 0
1977
+ * ```
1978
+ */
1979
+ readonly yAxis: Vector3;
1980
+ /**
1981
+ * A Vector3 with a value of 1 on the Z axis.
1982
+ *
1983
+ * This API member is a **constant**, and must be accessed through the `Vector3` global as opposed to an individual
1984
+ * `Vector3` object.
1985
+ *
1986
+ * ```lua
1987
+ * print(Vector3.zAxis) --> 0, 0, 1
1988
+ * ```
1989
+ */
1990
+ readonly zAxis: Vector3;
1991
+ /** Constructs a new Vector3 in a particular direction. */
1874
1992
  FromNormalId: (norm: Enum.NormalId) => Vector3;
1993
+ /** Constructs a new Vector3 for a particular axis. */
1875
1994
  FromAxis: (axis: Enum.Axis) => Vector3;
1995
+ /** Constructs a new Vector3 using the given x, y, and z components. */
1876
1996
  new (x?: number, y?: number, z?: number): Vector3;
1877
1997
  }
1878
1998
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.554",
3
+ "version": "1.0.558",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },