@rbxts/types 1.0.642 → 1.0.644

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.
@@ -129,6 +129,8 @@ interface CreatableInstances {
129
129
  Accessory: Accessory;
130
130
  Accoutrement: Accoutrement;
131
131
  Actor: Actor;
132
+ AdGui: AdGui;
133
+ AdPortal: AdPortal;
132
134
  AirController: AirController;
133
135
  AlignOrientation: AlignOrientation;
134
136
  AlignPosition: AlignPosition;
@@ -194,6 +196,7 @@ interface CreatableInstances {
194
196
  EchoSoundEffect: EchoSoundEffect;
195
197
  EqualizerSoundEffect: EqualizerSoundEffect;
196
198
  EulerRotationCurve: EulerRotationCurve;
199
+ ExperienceInviteOptions: ExperienceInviteOptions;
197
200
  Explosion: Explosion;
198
201
  FaceControls: FaceControls;
199
202
  FileMesh: FileMesh;
@@ -404,8 +407,6 @@ interface AbstractInstances {
404
407
  }
405
408
 
406
409
  interface Instances extends Services, CreatableInstances, AbstractInstances {
407
- AdGui: AdGui;
408
- AdPortal: AdPortal;
409
410
  AnimationClip: AnimationClip;
410
411
  AnimationStreamTrack: AnimationStreamTrack;
411
412
  AnimationTrack: AnimationTrack;
@@ -416,6 +417,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
416
417
  CatalogPages: CatalogPages;
417
418
  ChatInputBarConfiguration: ChatInputBarConfiguration;
418
419
  ChatWindowConfiguration: ChatWindowConfiguration;
420
+ CloudLocalizationTable: CloudLocalizationTable;
419
421
  CommandInstance: CommandInstance;
420
422
  ControllerBase: ControllerBase;
421
423
  CustomSoundEffect: CustomSoundEffect;
@@ -486,6 +488,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
486
488
  TextSource: TextSource;
487
489
  ThreadState: ThreadState;
488
490
  TouchTransmitter: TouchTransmitter;
491
+ TrackerLodController: TrackerLodController;
489
492
  Translator: Translator;
490
493
  Tween: Tween;
491
494
  UserGameSettings: UserGameSettings;
@@ -1202,6 +1205,10 @@ interface AdPortal extends Instance {
1202
1205
  * @deprecated
1203
1206
  */
1204
1207
  readonly _nominal_AdPortal: unique symbol;
1208
+ /**
1209
+ * Tags: ReadOnly, NotReplicated
1210
+ */
1211
+ readonly PortalStatus: Enum.AdPortalStatus;
1205
1212
  PortalType: Enum.AdPortalType;
1206
1213
  }
1207
1214
 
@@ -1990,6 +1997,7 @@ interface Animator extends Instance {
1990
1997
  * @deprecated
1991
1998
  */
1992
1999
  readonly _nominal_Animator: unique symbol;
2000
+ PreferLodEnabled: boolean;
1993
2001
  /**
1994
2002
  * Given the current set of [AnimationTracks](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack) playing, and their current times and play speeds, compute relative velocities between the parts and apply them to Motor6D.Part1 (the part which [Animator](https://developer.roblox.com/en-us/api-reference/class/Animator) considers the “child” part). These relative velocity calculations and assignments happen in the order provided.
1995
2003
  *
@@ -8446,6 +8454,10 @@ interface GroundController extends ControllerBase {
8446
8454
  DecelerationTime: number;
8447
8455
  Friction: number;
8448
8456
  FrictionWeight: number;
8457
+ GroundOffset: number;
8458
+ /**
8459
+ * Tags: Hidden, NotReplicated
8460
+ */
8449
8461
  MaxSlopeAngle: number;
8450
8462
  StandForce: number;
8451
8463
  StandSpeed: number;
@@ -8484,6 +8496,9 @@ interface ControllerManager extends Instance {
8484
8496
  BaseMoveSpeed: number;
8485
8497
  BaseTurnSpeed: number;
8486
8498
  FacingDirection: Vector3;
8499
+ /**
8500
+ * Tags: Hidden, NotReplicated
8501
+ */
8487
8502
  HipHeight: number;
8488
8503
  MovingDirection: Vector3;
8489
8504
  GetControllers(this: ControllerManager): Array<Instance>;
@@ -9092,7 +9107,7 @@ interface DataStoreService extends Instance {
9092
9107
  * * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
9093
9108
  * Tags: Yields
9094
9109
  */
9095
- ListDataStoresAsync(this: DataStoreService, prefix?: string, pageSize?: number): DataStoreListingPages;
9110
+ ListDataStoresAsync(this: DataStoreService, prefix?: string, pageSize?: number, cursor?: string): DataStoreListingPages;
9096
9111
  }
9097
9112
 
9098
9113
  /** An object that specifies additional parameters for a [GlobalDataStore:SetAsync](https://developer.roblox.com/en-us/api-reference/function/GlobalDataStore/SetAsync) call.
@@ -9585,6 +9600,21 @@ interface EventIngestService extends Instance {
9585
9600
  readonly _nominal_EventIngestService: unique symbol;
9586
9601
  }
9587
9602
 
9603
+ interface ExperienceInviteOptions extends Instance {
9604
+ /**
9605
+ * **DO NOT USE!**
9606
+ *
9607
+ * This field exists to force TypeScript to recognize this as a nominal type
9608
+ * @hidden
9609
+ * @deprecated
9610
+ */
9611
+ readonly _nominal_ExperienceInviteOptions: unique symbol;
9612
+ InviteMessageId: number;
9613
+ InviteUser: number;
9614
+ LaunchData: string;
9615
+ PromptMessage: string;
9616
+ }
9617
+
9588
9618
  /** An Explosion applies force to `BaseParts` within the explosion's [Explosion.BlastRadius](https://developer.roblox.com/en-us/api-reference/property/Explosion/BlastRadius). This force breaks joints between parts and kills [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) characters not protected by a [ForceField](https://developer.roblox.com/en-us/api-reference/class/ForceField).
9589
9619
  *
9590
9620
  * If an explosion is instanced whilst the game is running, it will destroy itself shortly afterwards meaning they do not need to be cleaned up using the [Debris](https://developer.roblox.com/en-us/api-reference/class/Debris) service.
@@ -10541,7 +10571,7 @@ interface DataStore extends GlobalDataStore {
10541
10571
  * * [Data Stores](https://developer.roblox.com/en-us/articles/data-store), an in-depth guide on data structure, management, error handling, etc.
10542
10572
  * Tags: Yields
10543
10573
  */
10544
- ListKeysAsync(this: DataStore, prefix?: string, pageSize?: number): DataStoreKeyPages;
10574
+ ListKeysAsync(this: DataStore, prefix?: string, pageSize?: number, cursor?: string): DataStoreKeyPages;
10545
10575
  /**
10546
10576
  * This function enumerates versions of the specified key in either ascending or descending order specified by a [SortDirection](https://developer.roblox.com/en-us/api-reference/enum/SortDirection) parameter. It can optionally filter the returned versions by minimum and maximum timestamp.
10547
10577
  *
@@ -14661,6 +14691,10 @@ interface Humanoid extends Instance {
14661
14691
  * When a Humanoid named `StarterHumanoid` is parented to [StarterPlayer](https://developer.roblox.com/api-reference/class/StarterPlayer), or when a Humanoid is present in a Model named `StarterCharacter`, the DisplayName property will be respected when Characters are loaded by Players in the game. The engine will only override the `DisplayName` property of the Humanoid with the `DisplayName` property of the player if the `StarterHumanoid`'s `DisplayName` property is an empty string.
14662
14692
  */
14663
14693
  DisplayName: string;
14694
+ /**
14695
+ * Tags: NotBrowsable
14696
+ */
14697
+ EvaluateStateMachine: boolean;
14664
14698
  /**
14665
14699
  * This is a read-only property that describes the [Material](https://developer.roblox.com/en-us/api-reference/enum/Material) the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) is currently standing on.
14666
14700
  * It works with both regular [Parts](https://developer.roblox.com/en-us/api-reference/class/BasePart) and [Terrain](https://developer.roblox.com/en-us/api-reference/class/Terrain) voxels.
@@ -16131,7 +16165,8 @@ interface HumanoidDescription extends Instance {
16131
16165
  /**
16132
16166
  * Returns a table of an avatar's current accessories. If the second parameter (includeRigidAccessories) is true then the returned table will also include entries for rigid accessories from the rigid accessory properties.
16133
16167
  */
16134
- GetAccessories(this: HumanoidDescription, includeRigidAccessories: boolean): unknown;
16168
+ GetAccessories(this: HumanoidDescription, includeRigidAccessories: false): Array<LayeredAccessoryInfo>;
16169
+ GetAccessories(this: HumanoidDescription, includeRigidAccessories: boolean): Array<AccessoryInfo>;
16135
16170
  /**
16136
16171
  * **GetEmotes** returns a dictionary of emotes that have been [added](https://developer.roblox.com/en-us/api-reference/function/HumanoidDescription/AddEmote) or [set](https://developer.roblox.com/en-us/api-reference/function/HumanoidDescription/SetEmotes) to this description. The keys of this dictionary are the names of the emotes, and the values are a non-empty array of emote IDs for that name.
16137
16172
  *
@@ -16282,6 +16317,7 @@ interface IKControl extends Instance {
16282
16317
  * @deprecated
16283
16318
  */
16284
16319
  readonly _nominal_IKControl: unique symbol;
16320
+ AlignmentOffset: CFrame;
16285
16321
  ChainRoot: Instance | undefined;
16286
16322
  Enabled: boolean;
16287
16323
  EndEffector: Instance | undefined;
@@ -16506,6 +16542,8 @@ interface IncrementalPatchBuilder extends Instance {
16506
16542
  * @deprecated
16507
16543
  */
16508
16544
  readonly _nominal_IncrementalPatchBuilder: unique symbol;
16545
+ HighCompression: boolean;
16546
+ ZstdCompression: boolean;
16509
16547
  }
16510
16548
 
16511
16549
  /** An **InputObject** represents a single user input, such as mouse movement, touches, key presses and more. It is created when an input begins.
@@ -20816,6 +20854,17 @@ interface LocalizationTable extends Instance {
20816
20854
  SetEntryValue(this: LocalizationTable, key: string, source: string, context: string, localeId: string, text: string): void;
20817
20855
  }
20818
20856
 
20857
+ interface CloudLocalizationTable extends LocalizationTable {
20858
+ /**
20859
+ * **DO NOT USE!**
20860
+ *
20861
+ * This field exists to force TypeScript to recognize this as a nominal type
20862
+ * @hidden
20863
+ * @deprecated
20864
+ */
20865
+ readonly _nominal_CloudLocalizationTable: unique symbol;
20866
+ }
20867
+
20819
20868
  interface LodDataEntity extends Instance {
20820
20869
  /**
20821
20870
  * **DO NOT USE!**
@@ -22530,6 +22579,10 @@ interface BasePart extends PVInstance {
22530
22579
  * Tags: NotReplicated
22531
22580
  */
22532
22581
  Color: Color3;
22582
+ /**
22583
+ * Tags: ReadOnly, NotReplicated
22584
+ */
22585
+ readonly CurrentPhysicalProperties: PhysicalProperties;
22533
22586
  /**
22534
22587
  * CustomPhysicalProperties lets you customize various physical aspects of a [part](https://developer.roblox.com/en-us/api-reference/class/BasePart), such as its's density, friction, and elasticity.
22535
22588
  *
@@ -24106,6 +24159,7 @@ interface Model extends PVInstance {
24106
24159
  * @deprecated
24107
24160
  */
24108
24161
  readonly _nominal_Model: unique symbol;
24162
+ ModelStreamingMode: Enum.ModelStreamingMode;
24109
24163
  /**
24110
24164
  * Points to the primary part of the [Model](https://developer.roblox.com/en-us/api-reference/class/Model). The primary part is the [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) that acts as the physical reference for the pivot of the model. That is, when parts within the model are moved due to physical simulation or other means, the pivot will move in sync with the primary part. If the primary part is **not** set, the pivot will remain at the same location in world space even if parts within the model are moved.
24111
24165
  *
@@ -24890,6 +24944,7 @@ interface Workspace extends WorldRoot {
24890
24944
  * Developers interested in seeing how this function is used in the Roblox Studio should see the [Studio Tools GitHub repository](https://github.com/Roblox/Studio-Tools).
24891
24945
  */
24892
24946
  UnjoinFromOutsiders(this: Workspace, objects: Array<Instance>): void;
24947
+ readonly PersistentLoaded: RBXScriptSignal<(player: Player) => void>;
24893
24948
  }
24894
24949
 
24895
24950
  /** The WorldModel provides some physics features to a [ViewportFrame](https://developer.roblox.com/en-us/api-reference/class/ViewportFrame).
@@ -25024,6 +25079,10 @@ interface DataStoreKeyPages extends Pages {
25024
25079
  * @deprecated
25025
25080
  */
25026
25081
  readonly _nominal_DataStoreKeyPages: unique symbol;
25082
+ /**
25083
+ * Tags: ReadOnly, NotReplicated
25084
+ */
25085
+ readonly Cursor: string;
25027
25086
  }
25028
25087
 
25029
25088
  /** A special type of [Pages](https://developer.roblox.com/en-us/api-reference/class/Pages) object whose pages contain [DataStoreInfo](https://developer.roblox.com/en-us/api-reference/class/DataStoreInfo) instances. [Pages:GetCurrentPage](https://developer.roblox.com/en-us/api-reference/function/Pages/GetCurrentPage) can be used to retrieve an array of the [DataStoreInfo](https://developer.roblox.com/en-us/api-reference/class/DataStoreInfo) instances.
@@ -25042,6 +25101,10 @@ interface DataStoreListingPages extends Pages {
25042
25101
  * @deprecated
25043
25102
  */
25044
25103
  readonly _nominal_DataStoreListingPages: unique symbol;
25104
+ /**
25105
+ * Tags: ReadOnly, NotReplicated
25106
+ */
25107
+ readonly Cursor: string;
25045
25108
  }
25046
25109
 
25047
25110
  /** A special type of [Pages](https://developer.roblox.com/en-us/api-reference/class/Pages) object whose pages contain key/value pairs from an [OrderedDataStore](https://developer.roblox.com/en-us/api-reference/class/OrderedDataStore). For this object, [GetCurrentPage()](https://developer.roblox.com/en-us/api-reference/function/Pages/GetCurrentPage) returns an array of tables, each containing keys named **key** and **value**; these reflect the key/value pair data. */
@@ -25802,6 +25865,7 @@ interface PhysicsService extends Instance {
25802
25865
  */
25803
25866
  GetMaxCollisionGroups(this: PhysicsService): number;
25804
25867
  GetRegisteredCollisionGroups(this: PhysicsService): unknown;
25868
+ IsCollisionGroupRegistered(this: PhysicsService, name: string): boolean;
25805
25869
  RegisterCollisionGroup(this: PhysicsService, name: string): void;
25806
25870
  /**
25807
25871
  * Removes the collision group with the given name. If an invalid name is provided the function will not do anything, although if the reserved name “Default” is provided then the function will throw an error.
@@ -28331,10 +28395,10 @@ interface RunService extends Instance {
28331
28395
  * There is no guarantee that functions connected to this event will fire at the exact same time, or in any specific order. For an alternative where the priority can be specified, see [RunService:BindToRenderStep](https://developer.roblox.com/en-us/api-reference/function/RunService/BindToRenderStep).
28332
28396
  */
28333
28397
  readonly Heartbeat: RBXScriptSignal<(deltaTime: number) => void>;
28334
- readonly PostSimulation: RBXScriptSignal<(deltaTime: number) => void>;
28335
- readonly PreAnimation: RBXScriptSignal<(deltaTime: number) => void>;
28336
- readonly PreRender: RBXScriptSignal<(deltaTime: number) => void>;
28337
- readonly PreSimulation: RBXScriptSignal<(deltaTime: number) => void>;
28398
+ readonly PostSimulation: RBXScriptSignal<(deltaTimeSim: number) => void>;
28399
+ readonly PreAnimation: RBXScriptSignal<(deltaTimeSim: number) => void>;
28400
+ readonly PreRender: RBXScriptSignal<(deltaTimeRender: number) => void>;
28401
+ readonly PreSimulation: RBXScriptSignal<(deltaTimeSim: number) => void>;
28338
28402
  /**
28339
28403
  * The RenderStepped event fires every _frame_, prior to the frame being rendered. The _step_ argument indicates the time that has elapsed since the previous frame.
28340
28404
  *
@@ -31975,6 +32039,14 @@ interface ChatWindowConfiguration extends TextChatConfigurations {
31975
32039
  */
31976
32040
  readonly AbsoluteSize: Vector2;
31977
32041
  Enabled: boolean;
32042
+ /**
32043
+ * Tags: NotReplicated
32044
+ */
32045
+ HorizontalAlignment: Enum.HorizontalAlignment;
32046
+ /**
32047
+ * Tags: NotReplicated
32048
+ */
32049
+ VerticalAlignment: Enum.VerticalAlignment;
31978
32050
  }
31979
32051
 
31980
32052
  interface TextChatMessage extends Instance {
@@ -32202,6 +32274,21 @@ interface TracerService extends Instance {
32202
32274
  readonly _nominal_TracerService: unique symbol;
32203
32275
  }
32204
32276
 
32277
+ interface TrackerLodController extends Instance {
32278
+ /**
32279
+ * **DO NOT USE!**
32280
+ *
32281
+ * This field exists to force TypeScript to recognize this as a nominal type
32282
+ * @hidden
32283
+ * @deprecated
32284
+ */
32285
+ readonly _nominal_TrackerLodController: unique symbol;
32286
+ AudioMode: Enum.TrackerLodFlagMode;
32287
+ VideoExtrapolationMode: Enum.TrackerExtrapolationFlagMode;
32288
+ VideoLodMode: Enum.TrackerLodValueMode;
32289
+ VideoMode: Enum.TrackerLodFlagMode;
32290
+ }
32291
+
32205
32292
  interface TrackerStreamAnimation extends Instance {
32206
32293
  /**
32207
32294
  * **DO NOT USE!**
@@ -2725,8 +2725,10 @@ interface ScriptEditorService extends Instance {
2725
2725
  * @deprecated
2726
2726
  */
2727
2727
  readonly _nominal_ScriptEditorService: unique symbol;
2728
+ DeregisterAutocompleteCallback(this: ScriptEditorService, name: string): void;
2728
2729
  FindScriptDocument(this: ScriptEditorService, script: LuaSourceContainer): ScriptDocument;
2729
2730
  GetScriptDocuments(this: ScriptEditorService): Array<Instance>;
2731
+ RegisterAutocompleteCallback(this: ScriptEditorService, name: string, priority: number, callbackFunction: Callback): void;
2730
2732
  /**
2731
2733
  * Tags: Yields
2732
2734
  */
@@ -2759,6 +2761,10 @@ interface Selection extends Instance {
2759
2761
  * @deprecated
2760
2762
  */
2761
2763
  readonly _nominal_Selection: unique symbol;
2764
+ /**
2765
+ * Tags: Hidden, ReadOnly, NotReplicated
2766
+ */
2767
+ readonly SelectionLineThickness: number;
2762
2768
  /**
2763
2769
  * Tags: ReadOnly, NotReplicated
2764
2770
  */
@@ -3099,6 +3105,7 @@ interface Studio extends Instance {
3099
3105
  * Tags: NotReplicated
3100
3106
  */
3101
3107
  ["Error Color"]: Color3;
3108
+ ["File > New creates a place with Team Create off"]: boolean;
3102
3109
  /**
3103
3110
  * Tags: NotReplicated
3104
3111
  */