@rbxts/types 1.0.766 → 1.0.767

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.
@@ -1439,6 +1439,7 @@ interface AnalyticsService extends Instance {
1439
1439
  * * [AnalyticsService:FirePlayerProgressionEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FirePlayerProgressionEvent), triggers an event used to track player progression through the game
1440
1440
  * * [AnalyticsService:FireInGameEconomyEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FireInGameEconomyEvent), triggers an event used to track player actions pertaining to the in-game economy
1441
1441
  * * [AnalyticsService:FireLogEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FireLogEvent), triggers an event used to track errors and warnings experienced by players
1442
+ * @deprecated
1442
1443
  */
1443
1444
  FireCustomEvent(
1444
1445
  this: AnalyticsService,
@@ -1498,6 +1499,7 @@ interface AnalyticsService extends Instance {
1498
1499
  * * [AnalyticsService:FirePlayerProgressionEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FirePlayerProgressionEvent), triggers an event used to track player progression through the game
1499
1500
  * * [AnalyticsService:FireLogEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FireLogEvent), triggers an event used to track errors and warnings experienced by players
1500
1501
  * * [AnalyticsService:FireCustomEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FireCustomEvent), triggers an event used to emit a custom event
1502
+ * @deprecated
1501
1503
  */
1502
1504
  FireInGameEconomyEvent(
1503
1505
  this: AnalyticsService,
@@ -1555,6 +1557,7 @@ interface AnalyticsService extends Instance {
1555
1557
  * * [AnalyticsService:FireInGameEconomyEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FireInGameEconomyEvent), triggers an event used to track player actions pertaining to the in-game economy
1556
1558
  * * [AnalyticsService:FirePlayerProgressionEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FirePlayerProgressionEvent), triggers an event used to track player progression through the game
1557
1559
  * * [AnalyticsService:FireCustomEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FireCustomEvent), triggers an event used to emit a custom event
1560
+ * @deprecated
1558
1561
  */
1559
1562
  FireLogEvent(
1560
1563
  this: AnalyticsService,
@@ -1612,6 +1615,7 @@ interface AnalyticsService extends Instance {
1612
1615
  * * [AnalyticsService:FireInGameEconomyEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FireInGameEconomyEvent), triggers an event used to track player actions pertaining to the in-game economy
1613
1616
  * * [AnalyticsService:FireLogEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FireLogEvent), triggers an event used to track errors and warnings experienced by players
1614
1617
  * * [AnalyticsService:FireCustomEvent](https://developer.roblox.com/en-us/api-reference/function/AnalyticsService/FireCustomEvent), triggers an event used to emit a custom event
1618
+ * @deprecated
1615
1619
  */
1616
1620
  FirePlayerProgressionEvent(
1617
1621
  this: AnalyticsService,
@@ -1622,6 +1626,13 @@ interface AnalyticsService extends Instance {
1622
1626
  statistics?: { [index: string]: number },
1623
1627
  customData?: unknown,
1624
1628
  ): void;
1629
+ LogEconomyEvent(this: AnalyticsService, player: Player, flowType: CastsToEnum<Enum.AnalyticsEconomyFlowType>, currencyType: string, endingBalance: number, amount: number, transactionType: string, itemSku: string, customFields: Array<any>): void;
1630
+ LogFunnelStepEvent(this: AnalyticsService, player: Player, funnelName: string, step: number, customFields: Array<any>): void;
1631
+ LogOnboardingFunnelStepEvent(this: AnalyticsService, player: Player, step: number, customFields: Array<any>): void;
1632
+ LogProgressionCompleteEvent(this: AnalyticsService, player: Player, level: number, levelName: string, customFields: Array<any>): void;
1633
+ LogProgressionEvent(this: AnalyticsService, player: Player, status: CastsToEnum<Enum.AnalyticsProgressionType>, level: number, levelName: string, customFields: Array<any>): void;
1634
+ LogProgressionFailEvent(this: AnalyticsService, player: Player, level: number, levelName: string, customFields: Array<any>): void;
1635
+ LogProgressionStartEvent(this: AnalyticsService, player: Player, level: number, levelName: string, customFields: Array<any>): void;
1625
1636
  }
1626
1637
 
1627
1638
  /** An object that references an animation asset (AnimationId) which can be loaded by a [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) or [AnimationController](https://developer.roblox.com/en-us/api-reference/class/AnimationController)
@@ -9743,7 +9754,7 @@ interface EditableMesh extends DataModelMesh {
9743
9754
  /**
9744
9755
  * Tags: Yields
9745
9756
  */
9746
- CreateMeshPartAsync(this: EditableMesh, collisionFidelity: CastsToEnum<Enum.CollisionFidelity>): MeshPart;
9757
+ CreateMeshPartAsync(this: EditableMesh, options?: object): MeshPart;
9747
9758
  }
9748
9759
 
9749
9760
  interface RobloxEditableMesh extends EditableMesh {
@@ -154,6 +154,21 @@ interface Animator extends Instance {
154
154
  StepAnimations(this: Animator, deltaTime: number): void;
155
155
  }
156
156
 
157
+ interface AssetService extends Instance {
158
+ /**
159
+ * **DO NOT USE!**
160
+ *
161
+ * This field exists to force TypeScript to recognize this as a nominal type
162
+ * @hidden
163
+ * @deprecated
164
+ */
165
+ readonly _nominal_AssetService: unique symbol;
166
+ /**
167
+ * Tags: Yields
168
+ */
169
+ CreateMeshPartAsync(this: AssetService, meshId: string, options?: object): MeshPart;
170
+ }
171
+
157
172
  /** The CoreGui is a service used to store Guis created in-game by Roblox for the core user interface found in every game (such as the game menu, the playerlist, the backpack, etc.). It can also be used by [Plugins](https://developer.roblox.com/en-us/api-reference/class/Plugin) in Roblox Studio.
158
173
  *
159
174
  * You can use the [StarterGui:SetCoreGuiEnabled](https://developer.roblox.com/en-us/api-reference/function/StarterGui/SetCoreGuiEnabled) and [StarterGui:GetCoreGuiEnabled](https://developer.roblox.com/en-us/api-reference/function/StarterGui/GetCoreGuiEnabled) methods in a [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript) to enable and disable most elements of the CoreGui. You can also use [PlayerGui:SetTopbarTransparency](https://developer.roblox.com/en-us/api-reference/function/PlayerGui/SetTopbarTransparency) to set the transparency of the top bar.
@@ -560,6 +560,80 @@ declare namespace Enum {
560
560
  }
561
561
  export type AnalyticsEconomyAction = AnalyticsEconomyAction.Default | AnalyticsEconomyAction.Acquire | AnalyticsEconomyAction.Spend;
562
562
 
563
+ export namespace AnalyticsEconomyFlowType {
564
+ export interface Sink extends globalThis.EnumItem {
565
+ Name: "Sink";
566
+ Value: 0;
567
+ EnumType: typeof globalThis.Enum.AnalyticsEconomyFlowType;
568
+ }
569
+
570
+ export const Sink: Sink;
571
+
572
+ export interface Source extends globalThis.EnumItem {
573
+ Name: "Source";
574
+ Value: 1;
575
+ EnumType: typeof globalThis.Enum.AnalyticsEconomyFlowType;
576
+ }
577
+
578
+ export const Source: Source;
579
+
580
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AnalyticsEconomyFlowType>;
581
+ }
582
+ export type AnalyticsEconomyFlowType = AnalyticsEconomyFlowType.Sink | AnalyticsEconomyFlowType.Source;
583
+
584
+ export namespace AnalyticsEconomyTransactionType {
585
+ export interface IAP extends globalThis.EnumItem {
586
+ Name: "IAP";
587
+ Value: 0;
588
+ EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
589
+ }
590
+
591
+ export const IAP: IAP;
592
+
593
+ export interface Shop extends globalThis.EnumItem {
594
+ Name: "Shop";
595
+ Value: 1;
596
+ EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
597
+ }
598
+
599
+ export const Shop: Shop;
600
+
601
+ export interface Gameplay extends globalThis.EnumItem {
602
+ Name: "Gameplay";
603
+ Value: 2;
604
+ EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
605
+ }
606
+
607
+ export const Gameplay: Gameplay;
608
+
609
+ export interface ContextualPurchase extends globalThis.EnumItem {
610
+ Name: "ContextualPurchase";
611
+ Value: 3;
612
+ EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
613
+ }
614
+
615
+ export const ContextualPurchase: ContextualPurchase;
616
+
617
+ export interface TimedReward extends globalThis.EnumItem {
618
+ Name: "TimedReward";
619
+ Value: 4;
620
+ EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
621
+ }
622
+
623
+ export const TimedReward: TimedReward;
624
+
625
+ export interface Onboarding extends globalThis.EnumItem {
626
+ Name: "Onboarding";
627
+ Value: 5;
628
+ EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
629
+ }
630
+
631
+ export const Onboarding: Onboarding;
632
+
633
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AnalyticsEconomyTransactionType>;
634
+ }
635
+ export type AnalyticsEconomyTransactionType = AnalyticsEconomyTransactionType.IAP | AnalyticsEconomyTransactionType.Shop | AnalyticsEconomyTransactionType.Gameplay | AnalyticsEconomyTransactionType.ContextualPurchase | AnalyticsEconomyTransactionType.TimedReward | AnalyticsEconomyTransactionType.Onboarding;
636
+
563
637
  export namespace AnalyticsLogLevel {
564
638
  export interface Trace extends globalThis.EnumItem {
565
639
  Name: "Trace";
@@ -658,6 +732,43 @@ declare namespace Enum {
658
732
  }
659
733
  export type AnalyticsProgressionStatus = AnalyticsProgressionStatus.Default | AnalyticsProgressionStatus.Begin | AnalyticsProgressionStatus.Complete | AnalyticsProgressionStatus.Abandon | AnalyticsProgressionStatus.Fail;
660
734
 
735
+ export namespace AnalyticsProgressionType {
736
+ export interface Custom extends globalThis.EnumItem {
737
+ Name: "Custom";
738
+ Value: 0;
739
+ EnumType: typeof globalThis.Enum.AnalyticsProgressionType;
740
+ }
741
+
742
+ export const Custom: Custom;
743
+
744
+ export interface Start extends globalThis.EnumItem {
745
+ Name: "Start";
746
+ Value: 1;
747
+ EnumType: typeof globalThis.Enum.AnalyticsProgressionType;
748
+ }
749
+
750
+ export const Start: Start;
751
+
752
+ export interface Fail extends globalThis.EnumItem {
753
+ Name: "Fail";
754
+ Value: 2;
755
+ EnumType: typeof globalThis.Enum.AnalyticsProgressionType;
756
+ }
757
+
758
+ export const Fail: Fail;
759
+
760
+ export interface Complete extends globalThis.EnumItem {
761
+ Name: "Complete";
762
+ Value: 3;
763
+ EnumType: typeof globalThis.Enum.AnalyticsProgressionType;
764
+ }
765
+
766
+ export const Complete: Complete;
767
+
768
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AnalyticsProgressionType>;
769
+ }
770
+ export type AnalyticsProgressionType = AnalyticsProgressionType.Custom | AnalyticsProgressionType.Start | AnalyticsProgressionType.Fail | AnalyticsProgressionType.Complete;
771
+
661
772
  export namespace AnimationClipFromVideoStatus {
662
773
  export interface Initializing extends globalThis.EnumItem {
663
774
  Name: "Initializing";
@@ -4791,6 +4902,14 @@ declare namespace Enum {
4791
4902
 
4792
4903
  export const PlacelaunchUserPrivacyUnauthorized: PlacelaunchUserPrivacyUnauthorized;
4793
4904
 
4905
+ export interface PlacelaunchCreatorBan extends globalThis.EnumItem {
4906
+ Name: "PlacelaunchCreatorBan";
4907
+ Value: 600;
4908
+ EnumType: typeof globalThis.Enum.ConnectionError;
4909
+ }
4910
+
4911
+ export const PlacelaunchCreatorBan: PlacelaunchCreatorBan;
4912
+
4794
4913
  export interface PlacelaunchCustomMessage extends globalThis.EnumItem {
4795
4914
  Name: "PlacelaunchCustomMessage";
4796
4915
  Value: 610;
@@ -4873,7 +4992,7 @@ declare namespace Enum {
4873
4992
 
4874
4993
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ConnectionError>;
4875
4994
  }
4876
- export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | 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.DisconnectNewSecurityKeyMismatch | 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.DisconnectPrivateServerKickout | ConnectionError.DisconnectModeratedGame | ConnectionError.ServerShutdown | ConnectionError.ReplicatorTimeout | ConnectionError.PlayerRemoved | ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave | ConnectionError.DisconnectRomarkEndOfTest | ConnectionError.DisconnectCollaboratorPermissionRevoked | ConnectionError.DisconnectCollaboratorUnderage | ConnectionError.NetworkInternal | ConnectionError.NetworkSend | ConnectionError.NetworkTimeout | ConnectionError.NetworkMisbehavior | ConnectionError.NetworkSecurity | ConnectionError.ReplacementReady | 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.PlacelaunchUserPrivacyUnauthorized | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
4995
+ export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | 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.DisconnectNewSecurityKeyMismatch | 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.DisconnectPrivateServerKickout | ConnectionError.DisconnectModeratedGame | ConnectionError.ServerShutdown | ConnectionError.ReplicatorTimeout | ConnectionError.PlayerRemoved | ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave | ConnectionError.DisconnectRomarkEndOfTest | ConnectionError.DisconnectCollaboratorPermissionRevoked | ConnectionError.DisconnectCollaboratorUnderage | ConnectionError.NetworkInternal | ConnectionError.NetworkSend | ConnectionError.NetworkTimeout | ConnectionError.NetworkMisbehavior | ConnectionError.NetworkSecurity | ConnectionError.ReplacementReady | 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.PlacelaunchUserPrivacyUnauthorized | ConnectionError.PlacelaunchCreatorBan | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
4877
4996
 
4878
4997
  export namespace ConnectionState {
4879
4998
  export interface Connected extends globalThis.EnumItem {
@@ -7228,6 +7347,22 @@ declare namespace Enum {
7228
7347
 
7229
7348
  export const BuilderSansExtraBold: BuilderSansExtraBold;
7230
7349
 
7350
+ export interface Arimo extends globalThis.EnumItem {
7351
+ Name: "Arimo";
7352
+ Value: 50;
7353
+ EnumType: typeof globalThis.Enum.Font;
7354
+ }
7355
+
7356
+ export const Arimo: Arimo;
7357
+
7358
+ export interface ArimoBold extends globalThis.EnumItem {
7359
+ Name: "ArimoBold";
7360
+ Value: 51;
7361
+ EnumType: typeof globalThis.Enum.Font;
7362
+ }
7363
+
7364
+ export const ArimoBold: ArimoBold;
7365
+
7231
7366
  export interface Unknown extends globalThis.EnumItem {
7232
7367
  Name: "Unknown";
7233
7368
  Value: 100;
@@ -7238,7 +7373,7 @@ declare namespace Enum {
7238
7373
 
7239
7374
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.Font>;
7240
7375
  }
7241
- export type Font = Font.Legacy | Font.Arial | Font.ArialBold | Font.SourceSans | Font.SourceSansBold | Font.SourceSansLight | Font.SourceSansItalic | Font.Bodoni | Font.Garamond | Font.Cartoon | Font.Code | Font.Highway | Font.SciFi | Font.Arcade | Font.Fantasy | Font.Antique | Font.SourceSansSemibold | 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.BuilderSans | Font.BuilderSansMedium | Font.BuilderSansBold | Font.BuilderSansExtraBold | Font.Unknown;
7376
+ export type Font = Font.Legacy | Font.Arial | Font.ArialBold | Font.SourceSans | Font.SourceSansBold | Font.SourceSansLight | Font.SourceSansItalic | Font.Bodoni | Font.Garamond | Font.Cartoon | Font.Code | Font.Highway | Font.SciFi | Font.Arcade | Font.Fantasy | Font.Antique | Font.SourceSansSemibold | 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.BuilderSans | Font.BuilderSansMedium | Font.BuilderSansBold | Font.BuilderSansExtraBold | Font.Arimo | Font.ArimoBold | Font.Unknown;
7242
7377
 
7243
7378
  export namespace FontSize {
7244
7379
  export interface Size8 extends globalThis.EnumItem {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.766",
3
+ "version": "1.0.767",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },