@rbxts/types 1.0.663 → 1.0.664
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.
|
@@ -53,6 +53,7 @@ interface Services {
|
|
|
53
53
|
ILegacyStudioBridge: ILegacyStudioBridge;
|
|
54
54
|
IncrementalPatchBuilder: IncrementalPatchBuilder;
|
|
55
55
|
InsertService: InsertService;
|
|
56
|
+
InternalSyncService: InternalSyncService;
|
|
56
57
|
IXPService: IXPService;
|
|
57
58
|
JointsService: JointsService;
|
|
58
59
|
KeyframeSequenceProvider: KeyframeSequenceProvider;
|
|
@@ -236,6 +237,7 @@ interface CreatableInstances {
|
|
|
236
237
|
ImageHandleAdornment: ImageHandleAdornment;
|
|
237
238
|
ImageLabel: ImageLabel;
|
|
238
239
|
IntConstrainedValue: IntConstrainedValue;
|
|
240
|
+
InternalSyncItem: InternalSyncItem;
|
|
239
241
|
IntValue: IntValue;
|
|
240
242
|
Keyframe: Keyframe;
|
|
241
243
|
KeyframeMarker: KeyframeMarker;
|
|
@@ -1671,7 +1673,7 @@ interface AnimationController extends Instance {
|
|
|
1671
1673
|
* local animationTracks = {}
|
|
1672
1674
|
* local track = animationController:LoadTrack(animation)
|
|
1673
1675
|
* table.insert(animationTracks, track)
|
|
1674
|
-
* Tags: Deprecated
|
|
1676
|
+
* Tags: Deprecated, [object Object]
|
|
1675
1677
|
* @deprecated
|
|
1676
1678
|
*/
|
|
1677
1679
|
GetPlayingAnimationTracks(this: AnimationController): Array<AnimationTrack>;
|
|
@@ -1706,7 +1708,7 @@ interface AnimationController extends Instance {
|
|
|
1706
1708
|
*
|
|
1707
1709
|
* * [Using the Animation Editor](https://developer.roblox.com/articles/using-animation-editor), explore this powerful built-in plugin for creating custom animations
|
|
1708
1710
|
* * [Using Animations in Games](https://developer.roblox.com/articles/using-animations-in-games), learn how to add pre-built and custom animations to your game
|
|
1709
|
-
* Tags: Deprecated
|
|
1711
|
+
* Tags: Deprecated, [object Object]
|
|
1710
1712
|
* @deprecated
|
|
1711
1713
|
*/
|
|
1712
1714
|
LoadAnimation(this: AnimationController, animation: Animation): AnimationTrack;
|
|
@@ -1716,7 +1718,7 @@ interface AnimationController extends Instance {
|
|
|
1716
1718
|
* The [AnimationTrack](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack) can be used to access the animation's playback functions and events. It will only fire for animations playing on the specific [AnimationController](https://developer.roblox.com/en-us/api-reference/class/AnimationController).
|
|
1717
1719
|
*
|
|
1718
1720
|
* See [Humanoid.AnimationPlayed](https://developer.roblox.com/en-us/api-reference/event/Humanoid/AnimationPlayed) for the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) variant of this function.
|
|
1719
|
-
* Tags: Deprecated
|
|
1721
|
+
* Tags: Deprecated, [object Object]
|
|
1720
1722
|
* @deprecated
|
|
1721
1723
|
*/
|
|
1722
1724
|
readonly AnimationPlayed: RBXScriptSignal<(animationTrack: AnimationTrack) => void>;
|
|
@@ -2251,7 +2253,7 @@ interface AssetService extends Instance {
|
|
|
2251
2253
|
* ----
|
|
2252
2254
|
*
|
|
2253
2255
|
* This member is broken and currently does not function correctly. You should avoid using it for now.
|
|
2254
|
-
* Tags: Yields, Deprecated
|
|
2256
|
+
* Tags: Yields, Deprecated, [object Object]
|
|
2255
2257
|
* @deprecated
|
|
2256
2258
|
*/
|
|
2257
2259
|
GetCreatorAssetID(this: AssetService, creationID: number): number;
|
|
@@ -2401,7 +2403,7 @@ interface Attachment extends Instance {
|
|
|
2401
2403
|
Position: Vector3;
|
|
2402
2404
|
/**
|
|
2403
2405
|
* A [Vector3](https://developer.roblox.com/api-reference/datatype/Vector3 "Vector3") that describes the rotation of the Attachment relative to the rotation of its parent, in degrees. Rotations are applied in Z, Y, X order.
|
|
2404
|
-
* Tags: Hidden, NotReplicated, Deprecated
|
|
2406
|
+
* Tags: Hidden, NotReplicated, Deprecated, [object Object]
|
|
2405
2407
|
* @deprecated
|
|
2406
2408
|
*/
|
|
2407
2409
|
Rotation: Vector3;
|
|
@@ -2445,7 +2447,7 @@ interface Attachment extends Instance {
|
|
|
2445
2447
|
WorldPosition: Vector3;
|
|
2446
2448
|
/**
|
|
2447
2449
|
* Determines the rotation (in degrees) of the attachment relative to the world, rather than the parent of the [Attachment](https://developer.roblox.com/en-us/api-reference/class/Attachment).
|
|
2448
|
-
* Tags: Hidden, ReadOnly, NotReplicated, Deprecated
|
|
2450
|
+
* Tags: Hidden, ReadOnly, NotReplicated, Deprecated, [object Object]
|
|
2449
2451
|
* @deprecated
|
|
2450
2452
|
*/
|
|
2451
2453
|
readonly WorldRotation: Vector3;
|
|
@@ -2456,25 +2458,25 @@ interface Attachment extends Instance {
|
|
|
2456
2458
|
WorldSecondaryAxis: Vector3;
|
|
2457
2459
|
/**
|
|
2458
2460
|
* Returns the value of the Attachment's [Attachment.Axis](https://developer.roblox.com/en-us/api-reference/property/Attachment/Axis).
|
|
2459
|
-
* Tags: Deprecated
|
|
2461
|
+
* Tags: Deprecated, [object Object]
|
|
2460
2462
|
* @deprecated
|
|
2461
2463
|
*/
|
|
2462
2464
|
GetAxis(this: Attachment): Vector3;
|
|
2463
2465
|
/**
|
|
2464
2466
|
* Returns the value of the Attachment's [Attachment.SecondaryAxis](https://developer.roblox.com/en-us/api-reference/property/Attachment/SecondaryAxis).
|
|
2465
|
-
* Tags: Deprecated
|
|
2467
|
+
* Tags: Deprecated, [object Object]
|
|
2466
2468
|
* @deprecated
|
|
2467
2469
|
*/
|
|
2468
2470
|
GetSecondaryAxis(this: Attachment): Vector3;
|
|
2469
2471
|
/**
|
|
2470
2472
|
* Sets the value of the Attachment's [Attachment.Axis](https://developer.roblox.com/en-us/api-reference/property/Attachment/Axis).
|
|
2471
|
-
* Tags: Deprecated
|
|
2473
|
+
* Tags: Deprecated, [object Object]
|
|
2472
2474
|
* @deprecated
|
|
2473
2475
|
*/
|
|
2474
2476
|
SetAxis(this: Attachment, axis: Vector3): void;
|
|
2475
2477
|
/**
|
|
2476
2478
|
* Sets the value of the Attachment's [Attachment.SecondaryAxis](https://developer.roblox.com/en-us/api-reference/property/Attachment/SecondaryAxis).
|
|
2477
|
-
* Tags: Deprecated
|
|
2479
|
+
* Tags: Deprecated, [object Object]
|
|
2478
2480
|
* @deprecated
|
|
2479
2481
|
*/
|
|
2480
2482
|
SetSecondaryAxis(this: Attachment, axis: Vector3): void;
|
|
@@ -5564,7 +5566,7 @@ interface Camera extends Instance {
|
|
|
5564
5566
|
CameraType: Enum.CameraType;
|
|
5565
5567
|
/**
|
|
5566
5568
|
* This property has been superseded by [Camera.CFrame](https://developer.roblox.com/en-us/api-reference/property/Camera/CFrame) which functions identically and should be used instead.
|
|
5567
|
-
* Tags: Hidden, NotReplicated, Deprecated
|
|
5569
|
+
* Tags: Hidden, NotReplicated, Deprecated, [object Object]
|
|
5568
5570
|
* @deprecated
|
|
5569
5571
|
*/
|
|
5570
5572
|
CoordinateFrame: CFrame;
|
|
@@ -6386,7 +6388,7 @@ interface Chat extends Instance {
|
|
|
6386
6388
|
FilterStringForBroadcast(this: Chat, stringToFilter: string, playerFrom: Player): string;
|
|
6387
6389
|
/**
|
|
6388
6390
|
* The FilterStringForPlayerAsync function filters a string appropriate to the given player's age settings, so they see what is appropriate to them. This function will only work if called from a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) on the server. If called on a client it will fail.
|
|
6389
|
-
* Tags: Yields, Deprecated
|
|
6391
|
+
* Tags: Yields, Deprecated, [object Object]
|
|
6390
6392
|
* @deprecated
|
|
6391
6393
|
*/
|
|
6392
6394
|
FilterStringForPlayerAsync(this: Chat, stringToFilter: string, playerToFilterFor: Player): string;
|
|
@@ -6618,13 +6620,13 @@ interface CollectionService extends Instance {
|
|
|
6618
6620
|
RemoveTag(this: CollectionService, instance: Instance, tag: string): void;
|
|
6619
6621
|
/**
|
|
6620
6622
|
* This function fires when a [Configuration](https://developer.roblox.com/en-us/api-reference/class/Configuration), [CustomEvent](https://developer.roblox.com/en-us/api-reference/class/CustomEvent), [CustomEventReceiver](https://developer.roblox.com/en-us/api-reference/class/CustomEventReceiver), [Dialog](https://developer.roblox.com/en-us/api-reference/class/Dialog), or [VehicleSeat](https://developer.roblox.com/en-us/api-reference/class/VehicleSeat) is added to the [DataModel](https://developer.roblox.com/en-us/api-reference/class/DataModel).
|
|
6621
|
-
* Tags: Deprecated
|
|
6623
|
+
* Tags: Deprecated, [object Object]
|
|
6622
6624
|
* @deprecated
|
|
6623
6625
|
*/
|
|
6624
6626
|
readonly ItemAdded: RBXScriptSignal<(instance: Instance) => void>;
|
|
6625
6627
|
/**
|
|
6626
6628
|
* This function fires when a [Configuration](https://developer.roblox.com/en-us/api-reference/class/Configuration), [CustomEvent](https://developer.roblox.com/en-us/api-reference/class/CustomEvent), [CustomEventReceiver](https://developer.roblox.com/en-us/api-reference/class/CustomEventReceiver), [Dialog](https://developer.roblox.com/en-us/api-reference/class/Dialog), or [VehicleSeat](https://developer.roblox.com/en-us/api-reference/class/VehicleSeat) is removed from the [DataModel](https://developer.roblox.com/en-us/api-reference/class/DataModel).
|
|
6627
|
-
* Tags: Deprecated
|
|
6629
|
+
* Tags: Deprecated, [object Object]
|
|
6628
6630
|
* @deprecated
|
|
6629
6631
|
*/
|
|
6630
6632
|
readonly ItemRemoved: RBXScriptSignal<(instance: Instance) => void>;
|
|
@@ -7848,7 +7850,7 @@ interface TorsionSpringConstraint extends Constraint {
|
|
|
7848
7850
|
* In the example below, you can enable a cone limit on the relative motion of the secondary axes as follows:
|
|
7849
7851
|
*
|
|
7850
7852
|
* torsionSpring.LimitEnabled = true
|
|
7851
|
-
* Tags: Hidden, Deprecated
|
|
7853
|
+
* Tags: Hidden, Deprecated, [object Object]
|
|
7852
7854
|
* @deprecated
|
|
7853
7855
|
*/
|
|
7854
7856
|
LimitEnabled: boolean;
|
|
@@ -8064,7 +8066,7 @@ interface ContentProvider extends Instance {
|
|
|
8064
8066
|
ListEncryptedAssets(this: ContentProvider): unknown;
|
|
8065
8067
|
/**
|
|
8066
8068
|
* Usually, content is loaded only when it starts being used. That explains why it often takes a moment for an image to appear in a [GUI](https://developer.roblox.com/en-us/api-reference/class/GuiObject), or a [mesh](https://developer.roblox.com/en-us/api-reference/class/Mesh) to appear in a [part](https://developer.roblox.com/en-us/api-reference/class/BasePart), or why a [sound](https://developer.roblox.com/en-us/api-reference/class/Sound) doesn't play for the first time. All because the asset has not yet finished loading. Preload is used to load this content beforehand, so that it works instantly.
|
|
8067
|
-
* Tags: Deprecated
|
|
8069
|
+
* Tags: Deprecated, [object Object]
|
|
8068
8070
|
* @deprecated
|
|
8069
8071
|
*/
|
|
8070
8072
|
Preload(this: ContentProvider, contentId: string): void;
|
|
@@ -8222,7 +8224,7 @@ interface ContextActionService extends Instance {
|
|
|
8222
8224
|
* If an input has more than one function bound to it, each function will be placed on a stack. A stack obeys the principle of last in first out. So the first object placed on the stack will be on the top. The next object placed on the stack becomes the top and the previous object moves one position down (like a stack of books). When the input is triggered, the function at the top of the stack is called. If the function returns Enum.ContextActionResult.Pass this will continue down the stack. To remove a function from being called by all input that it was bound by use [ContextActionService:UnbindAction](https://developer.roblox.com/en-us/api-reference/function/ContextActionService/UnbindAction).
|
|
8223
8225
|
*
|
|
8224
8226
|
* BindAction allows control over whether or not a bound action should be processed by other actions on the stack using [ContextActionResult](https://developer.roblox.com/en-us/api-reference/enum/ContextActionResult). If Enum.ContextActionResult.Pass is returned in the callback function, every action below it in the stack (last function called gets executed first) will get a chance to process it. Anything other than Pass will be treated as Enum.ContextActionResult.Sink, including nil. It will also sink if the callback is yielded.
|
|
8225
|
-
* Tags: Deprecated
|
|
8227
|
+
* Tags: Deprecated, [object Object]
|
|
8226
8228
|
* @deprecated
|
|
8227
8229
|
*/
|
|
8228
8230
|
BindActionToInputTypes(this: ContextActionService, actionName: string, functionToBind: Callback, createTouchButton: boolean, inputTypes: Array<any>): void;
|
|
@@ -10961,7 +10963,7 @@ interface GuiBase2d extends GuiBase {
|
|
|
10961
10963
|
AutoLocalize: boolean;
|
|
10962
10964
|
/**
|
|
10963
10965
|
* This property is automatically set to true when a LocalizationTable's Root targets this object, or an ancestor of this object. `LocalizationTable/LocalizationTable`s, with their [LocalizationTable.Root](https://developer.roblox.com/en-us/api-reference/property/LocalizationTable/Root) property pointed at an instance, will localize all `TextLabel/TextButton` that are descendants of the root instance.
|
|
10964
|
-
* Tags: Hidden, NotReplicated, Deprecated
|
|
10966
|
+
* Tags: Hidden, NotReplicated, Deprecated, [object Object]
|
|
10965
10967
|
* @deprecated
|
|
10966
10968
|
*/
|
|
10967
10969
|
Localize: boolean;
|
|
@@ -11937,7 +11939,7 @@ interface TextButton extends GuiButton {
|
|
|
11937
11939
|
FontFace: Font;
|
|
11938
11940
|
/**
|
|
11939
11941
|
* This property determines the font size to be used.
|
|
11940
|
-
* Tags: NotReplicated, Deprecated
|
|
11942
|
+
* Tags: NotReplicated, Deprecated, [object Object]
|
|
11941
11943
|
* @deprecated
|
|
11942
11944
|
*/
|
|
11943
11945
|
FontSize: Enum.FontSize;
|
|
@@ -12062,7 +12064,7 @@ interface TextButton extends GuiButton {
|
|
|
12062
12064
|
TextTruncate: Enum.TextTruncate;
|
|
12063
12065
|
/**
|
|
12064
12066
|
* This property determines whether or not text should wrap at the edges of the object.
|
|
12065
|
-
* Tags: NotReplicated, Deprecated
|
|
12067
|
+
* Tags: NotReplicated, Deprecated, [object Object]
|
|
12066
12068
|
* @deprecated
|
|
12067
12069
|
*/
|
|
12068
12070
|
TextWrap: boolean;
|
|
@@ -12251,7 +12253,7 @@ interface TextLabel extends GuiLabel {
|
|
|
12251
12253
|
FontFace: Font;
|
|
12252
12254
|
/**
|
|
12253
12255
|
* This property determines the height in offsets of one line of text.
|
|
12254
|
-
* Tags: NotReplicated, Deprecated
|
|
12256
|
+
* Tags: NotReplicated, Deprecated, [object Object]
|
|
12255
12257
|
* @deprecated
|
|
12256
12258
|
*/
|
|
12257
12259
|
FontSize: Enum.FontSize;
|
|
@@ -12379,7 +12381,7 @@ interface TextLabel extends GuiLabel {
|
|
|
12379
12381
|
TextTruncate: Enum.TextTruncate;
|
|
12380
12382
|
/**
|
|
12381
12383
|
* This property determines if text wraps to multiple lines within the [GUI](https://developer.roblox.com/en-us/api-reference/class/TextLabel) element space, truncating excess text.
|
|
12382
|
-
* Tags: NotReplicated, Deprecated
|
|
12384
|
+
* Tags: NotReplicated, Deprecated, [object Object]
|
|
12383
12385
|
* @deprecated
|
|
12384
12386
|
*/
|
|
12385
12387
|
TextWrap: boolean;
|
|
@@ -12638,7 +12640,7 @@ interface TextBox extends GuiObject {
|
|
|
12638
12640
|
FontFace: Font;
|
|
12639
12641
|
/**
|
|
12640
12642
|
* This property determines the font size of a [GUI](https://developer.roblox.com/en-us/api-reference/class/TextBox) object.
|
|
12641
|
-
* Tags: NotReplicated, Deprecated
|
|
12643
|
+
* Tags: NotReplicated, Deprecated, [object Object]
|
|
12642
12644
|
* @deprecated
|
|
12643
12645
|
*/
|
|
12644
12646
|
FontSize: Enum.FontSize;
|
|
@@ -12782,7 +12784,7 @@ interface TextBox extends GuiObject {
|
|
|
12782
12784
|
*/
|
|
12783
12785
|
TextTruncate: Enum.TextTruncate;
|
|
12784
12786
|
/**
|
|
12785
|
-
* Tags: NotReplicated, Deprecated
|
|
12787
|
+
* Tags: NotReplicated, Deprecated, [object Object]
|
|
12786
12788
|
* @deprecated
|
|
12787
12789
|
*/
|
|
12788
12790
|
TextWrap: boolean;
|
|
@@ -13642,7 +13644,7 @@ interface SelectionBox extends InstanceAdornment {
|
|
|
13642
13644
|
LineThickness: number;
|
|
13643
13645
|
/**
|
|
13644
13646
|
* A `BrickColor` version of [SurfaceColor3](https://developer.roblox.com/en-us/api-reference/property/SelectionBox/SurfaceColor3)…
|
|
13645
|
-
* Tags: Hidden, NotReplicated, Deprecated
|
|
13647
|
+
* Tags: Hidden, NotReplicated, Deprecated, [object Object]
|
|
13646
13648
|
* @deprecated
|
|
13647
13649
|
*/
|
|
13648
13650
|
SurfaceColor: BrickColor;
|
|
@@ -13927,7 +13929,7 @@ interface SelectionSphere extends PVAdornment {
|
|
|
13927
13929
|
readonly _nominal_SelectionSphere: unique symbol;
|
|
13928
13930
|
/**
|
|
13929
13931
|
* A `BrickColor` version of [SelectionSphere.SurfaceColor3](https://developer.roblox.com/en-us/api-reference/property/SelectionSphere/SurfaceColor3).
|
|
13930
|
-
* Tags: Hidden, NotReplicated, Deprecated
|
|
13932
|
+
* Tags: Hidden, NotReplicated, Deprecated, [object Object]
|
|
13931
13933
|
* @deprecated
|
|
13932
13934
|
*/
|
|
13933
13935
|
SurfaceColor: BrickColor;
|
|
@@ -15314,7 +15316,7 @@ interface Humanoid extends Instance {
|
|
|
15314
15316
|
* local animationTracks = {}
|
|
15315
15317
|
* local track = humanoid:LoadAnimation(animation)
|
|
15316
15318
|
* table.insert(animationTracks, track)
|
|
15317
|
-
* Tags: Deprecated
|
|
15319
|
+
* Tags: Deprecated, [object Object]
|
|
15318
15320
|
* @deprecated
|
|
15319
15321
|
*/
|
|
15320
15322
|
GetPlayingAnimationTracks(this: Humanoid): Array<AnimationTrack>;
|
|
@@ -15379,7 +15381,7 @@ interface Humanoid extends Instance {
|
|
|
15379
15381
|
* If the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) belongs to a NPC (Non Player Character) which the server has [network ownership](http://robloxdev.com/articles/Network-Ownership) of then the [Animations](https://developer.roblox.com/en-us/api-reference/class/Animation) should be loaded and played from the server.
|
|
15380
15382
|
*
|
|
15381
15383
|
* Although generally it is not advisable to do so, these rules can be bypassed using the [Animator](https://developer.roblox.com/en-us/api-reference/class/Animator) object.
|
|
15382
|
-
* Tags: Deprecated
|
|
15384
|
+
* Tags: Deprecated, [object Object]
|
|
15383
15385
|
* @deprecated
|
|
15384
15386
|
*/
|
|
15385
15387
|
LoadAnimation(this: Humanoid, animation: Animation): AnimationTrack;
|
|
@@ -15520,7 +15522,7 @@ interface Humanoid extends Instance {
|
|
|
15520
15522
|
* --------
|
|
15521
15523
|
*
|
|
15522
15524
|
* * For the [AnimationController](https://developer.roblox.com/en-us/api-reference/class/AnimationController) equivalent of this event, please see [AnimationController.AnimationPlayed](https://developer.roblox.com/en-us/api-reference/event/AnimationController/AnimationPlayed)
|
|
15523
|
-
* Tags: Deprecated
|
|
15525
|
+
* Tags: Deprecated, [object Object]
|
|
15524
15526
|
* @deprecated
|
|
15525
15527
|
*/
|
|
15526
15528
|
readonly AnimationPlayed: RBXScriptSignal<(animationTrack: AnimationTrack) => void>;
|
|
@@ -18324,7 +18326,7 @@ interface InsertService extends Instance {
|
|
|
18324
18326
|
*/
|
|
18325
18327
|
Insert(this: InsertService, instance: Instance): void;
|
|
18326
18328
|
/**
|
|
18327
|
-
* Tags: Yields, Deprecated
|
|
18329
|
+
* Tags: Yields, Deprecated, [object Object]
|
|
18328
18330
|
* @deprecated
|
|
18329
18331
|
*/
|
|
18330
18332
|
GetBaseCategories(this: InsertService): unknown;
|
|
@@ -18402,7 +18404,7 @@ interface InsertService extends Instance {
|
|
|
18402
18404
|
*/
|
|
18403
18405
|
GetLatestAssetVersionAsync(this: InsertService, assetId: number): number;
|
|
18404
18406
|
/**
|
|
18405
|
-
* Tags: Yields, Deprecated
|
|
18407
|
+
* Tags: Yields, Deprecated, [object Object]
|
|
18406
18408
|
* @deprecated
|
|
18407
18409
|
*/
|
|
18408
18410
|
GetUserCategories(this: InsertService, userId: number): unknown;
|
|
@@ -18497,6 +18499,32 @@ interface InsertService extends Instance {
|
|
|
18497
18499
|
* Tags: Yields
|
|
18498
18500
|
*/
|
|
18499
18501
|
LoadAssetVersion(this: InsertService, assetVersionId: number): Model;
|
|
18502
|
+
/**
|
|
18503
|
+
* Tags: Hidden
|
|
18504
|
+
*/
|
|
18505
|
+
readonly InternalDelete: RBXScriptSignal<(instance: Instance) => void>;
|
|
18506
|
+
}
|
|
18507
|
+
|
|
18508
|
+
interface InternalSyncItem extends Instance {
|
|
18509
|
+
/**
|
|
18510
|
+
* **DO NOT USE!**
|
|
18511
|
+
*
|
|
18512
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
18513
|
+
* @hidden
|
|
18514
|
+
* @deprecated
|
|
18515
|
+
*/
|
|
18516
|
+
readonly _nominal_InternalSyncItem: unique symbol;
|
|
18517
|
+
}
|
|
18518
|
+
|
|
18519
|
+
interface InternalSyncService extends Instance {
|
|
18520
|
+
/**
|
|
18521
|
+
* **DO NOT USE!**
|
|
18522
|
+
*
|
|
18523
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
18524
|
+
* @hidden
|
|
18525
|
+
* @deprecated
|
|
18526
|
+
*/
|
|
18527
|
+
readonly _nominal_InternalSyncService: unique symbol;
|
|
18500
18528
|
}
|
|
18501
18529
|
|
|
18502
18530
|
/** JointInstance is the base class for joints, such as Connectors, Welds, and Snaps.
|
|
@@ -20847,13 +20875,13 @@ interface LocalizationTable extends Instance {
|
|
|
20847
20875
|
readonly _nominal_LocalizationTable: unique symbol;
|
|
20848
20876
|
/**
|
|
20849
20877
|
* The default IETF tag to use if the ''languageKey'' parameter is excluded from the [LocalizationTable:GetString](https://developer.roblox.com/en-us/api-reference/function/LocalizationTable/GetString) method.
|
|
20850
|
-
* Tags: Hidden, NotReplicated, Deprecated
|
|
20878
|
+
* Tags: Hidden, NotReplicated, Deprecated, [object Object]
|
|
20851
20879
|
* @deprecated
|
|
20852
20880
|
*/
|
|
20853
20881
|
DevelopmentLanguage: string;
|
|
20854
20882
|
/**
|
|
20855
20883
|
* The object that is being targeted for localization by this table. Localization is applied to it and all of it's descendants.
|
|
20856
|
-
* Tags: Hidden, NotReplicated, Deprecated
|
|
20884
|
+
* Tags: Hidden, NotReplicated, Deprecated, [object Object]
|
|
20857
20885
|
* @deprecated
|
|
20858
20886
|
*/
|
|
20859
20887
|
Root: Instance | undefined;
|
|
@@ -20862,7 +20890,7 @@ interface LocalizationTable extends Instance {
|
|
|
20862
20890
|
*/
|
|
20863
20891
|
SourceLocaleId: string;
|
|
20864
20892
|
/**
|
|
20865
|
-
* Tags: Deprecated
|
|
20893
|
+
* Tags: Deprecated, [object Object]
|
|
20866
20894
|
* @deprecated
|
|
20867
20895
|
*/
|
|
20868
20896
|
GetContents(this: LocalizationTable): string;
|
|
@@ -20912,7 +20940,7 @@ interface LocalizationTable extends Instance {
|
|
|
20912
20940
|
GetEntries(this: LocalizationTable): Array<LocalizationEntry>;
|
|
20913
20941
|
/**
|
|
20914
20942
|
* The GetString function returns a translation based on the specified language and key.
|
|
20915
|
-
* Tags: Deprecated
|
|
20943
|
+
* Tags: Deprecated, [object Object]
|
|
20916
20944
|
* @deprecated
|
|
20917
20945
|
*/
|
|
20918
20946
|
GetString(this: LocalizationTable, targetLocaleId: string, key: string): string;
|
|
@@ -20934,7 +20962,7 @@ interface LocalizationTable extends Instance {
|
|
|
20934
20962
|
* Calling RemoveKey is the same as making the following call to RemoveEntry:
|
|
20935
20963
|
*
|
|
20936
20964
|
* LocalizationTable:RemoveEntry(key,"","")
|
|
20937
|
-
* Tags: Deprecated
|
|
20965
|
+
* Tags: Deprecated, [object Object]
|
|
20938
20966
|
* @deprecated
|
|
20939
20967
|
*/
|
|
20940
20968
|
RemoveKey(this: LocalizationTable, key: string): void;
|
|
@@ -20944,7 +20972,7 @@ interface LocalizationTable extends Instance {
|
|
|
20944
20972
|
RemoveTargetLocale(this: LocalizationTable, localeId: string): void;
|
|
20945
20973
|
/**
|
|
20946
20974
|
* The SetContents function sets the contents of the LocalizationTable, via the legacy JSON format.
|
|
20947
|
-
* Tags: Deprecated
|
|
20975
|
+
* Tags: Deprecated, [object Object]
|
|
20948
20976
|
* @deprecated
|
|
20949
20977
|
*/
|
|
20950
20978
|
SetContents(this: LocalizationTable, contents: string): void;
|
|
@@ -20955,7 +20983,7 @@ interface LocalizationTable extends Instance {
|
|
|
20955
20983
|
*/
|
|
20956
20984
|
SetEntries(this: LocalizationTable, entries: Array<LocalizationEntry>): void;
|
|
20957
20985
|
/**
|
|
20958
|
-
* Tags: Deprecated
|
|
20986
|
+
* Tags: Deprecated, [object Object]
|
|
20959
20987
|
* @deprecated
|
|
20960
20988
|
*/
|
|
20961
20989
|
SetEntry(this: LocalizationTable, key: string, targetLocaleId: string, text: string): void;
|
|
@@ -21062,6 +21090,18 @@ interface LuaSourceContainer extends Instance {
|
|
|
21062
21090
|
* @deprecated
|
|
21063
21091
|
*/
|
|
21064
21092
|
readonly _nominal_LuaSourceContainer: unique symbol;
|
|
21093
|
+
/**
|
|
21094
|
+
* Tags: Hidden
|
|
21095
|
+
*/
|
|
21096
|
+
readonly LockGrantedOrNot: RBXScriptSignal<(granted: boolean) => void>;
|
|
21097
|
+
/**
|
|
21098
|
+
* Tags: Hidden
|
|
21099
|
+
*/
|
|
21100
|
+
readonly LostLock: RBXScriptSignal<() => void>;
|
|
21101
|
+
/**
|
|
21102
|
+
* Tags: Hidden
|
|
21103
|
+
*/
|
|
21104
|
+
readonly RequestLock: RBXScriptSignal<() => void>;
|
|
21065
21105
|
}
|
|
21066
21106
|
|
|
21067
21107
|
/** The base class for all script objects which run automatically. */
|
|
@@ -22287,7 +22327,7 @@ interface Mouse extends Instance {
|
|
|
22287
22327
|
* * Not all keys generate this event. However, you can get around this with a few of the keys, “/” for example, by using the [Mouse.KeyUp](https://developer.roblox.com/en-us/api-reference/event/Mouse/KeyUp) event.
|
|
22288
22328
|
* * Some keys generate the same string as other keys.
|
|
22289
22329
|
* * It's possible for the string to be empty (possibly due to “\\0” key code).
|
|
22290
|
-
* Tags: Deprecated
|
|
22330
|
+
* Tags: Deprecated, [object Object]
|
|
22291
22331
|
* @deprecated
|
|
22292
22332
|
*/
|
|
22293
22333
|
readonly KeyDown: RBXScriptSignal<(key: string) => void>;
|
|
@@ -22300,7 +22340,7 @@ interface Mouse extends Instance {
|
|
|
22300
22340
|
* * Not all keys generate this event. However, you can get around this with a few of the keys, “/” for example, by using the \[\[API:Class/Mouse/KeyUp|KeyUp\]\] event.
|
|
22301
22341
|
* * Some keys generate the same string as other keys.
|
|
22302
22342
|
* * It's possible for the string to be empty (possibly due to “\\0” key code).
|
|
22303
|
-
* Tags: Deprecated
|
|
22343
|
+
* Tags: Deprecated, [object Object]
|
|
22304
22344
|
* @deprecated
|
|
22305
22345
|
*/
|
|
22306
22346
|
readonly KeyUp: RBXScriptSignal<(key: string) => void>;
|
|
@@ -23008,7 +23048,7 @@ interface BasePart extends PVInstance {
|
|
|
23008
23048
|
* The unit of this property is **radians per second**.
|
|
23009
23049
|
*
|
|
23010
23050
|
* Using this in conjunction with [AlignOrientation](https://developer.roblox.com/en-us/api-reference/class/AlignOrientation) allows for aligned parts to have matching RotVelocity and Orientation values.
|
|
23011
|
-
* Tags: Hidden, Deprecated
|
|
23051
|
+
* Tags: Hidden, Deprecated, [object Object]
|
|
23012
23052
|
* @deprecated
|
|
23013
23053
|
*/
|
|
23014
23054
|
RotVelocity: Vector3;
|
|
@@ -23113,7 +23153,7 @@ interface BasePart extends PVInstance {
|
|
|
23113
23153
|
* Cobblestone
|
|
23114
23154
|
*
|
|
23115
23155
|
* 2.7
|
|
23116
|
-
* Tags: ReadOnly, NotReplicated, Deprecated
|
|
23156
|
+
* Tags: ReadOnly, NotReplicated, Deprecated, [object Object]
|
|
23117
23157
|
* @deprecated
|
|
23118
23158
|
*/
|
|
23119
23159
|
readonly SpecificGravity: number;
|
|
@@ -23171,7 +23211,7 @@ interface BasePart extends PVInstance {
|
|
|
23171
23211
|
* Setting the Velocity of an part that is [BasePart.Anchored](https://developer.roblox.com/en-us/api-reference/property/BasePart/Anchored) will cause it to act like a conveyor belt. Any object that touches the part will begin to move in accordance with the Velocity.
|
|
23172
23212
|
*
|
|
23173
23213
|
* Some `/BodyMover` objects will apply forces and thus change the Velocity of a part over time. The simplest of these is a `/BodyForce` which can be used to counteract the acceleration due to gravity on a single part (set the +Y axis of the [BodyForce.Force](https://developer.roblox.com/en-us/api-reference/property/BodyForce/Force) to the product of the mass ([BasePart:GetMass](https://developer.roblox.com/en-us/api-reference/function/BasePart/GetMass)) and the gravity constant).
|
|
23174
|
-
* Tags: Hidden, Deprecated
|
|
23214
|
+
* Tags: Hidden, Deprecated, [object Object]
|
|
23175
23215
|
* @deprecated
|
|
23176
23216
|
*/
|
|
23177
23217
|
Velocity: Vector3;
|
|
@@ -23446,7 +23486,7 @@ interface BasePart extends PVInstance {
|
|
|
23446
23486
|
readonly OutfitChanged: RBXScriptSignal<() => void>;
|
|
23447
23487
|
/**
|
|
23448
23488
|
* .
|
|
23449
|
-
* Tags: Deprecated
|
|
23489
|
+
* Tags: Deprecated, [object Object]
|
|
23450
23490
|
* @deprecated
|
|
23451
23491
|
*/
|
|
23452
23492
|
readonly StoppedTouching: RBXScriptSignal<(otherPart: BasePart) => void>;
|
|
@@ -23572,6 +23612,14 @@ interface Platform extends Part {
|
|
|
23572
23612
|
* @deprecated
|
|
23573
23613
|
*/
|
|
23574
23614
|
readonly _nominal_Platform: unique symbol;
|
|
23615
|
+
/**
|
|
23616
|
+
* Tags: Hidden
|
|
23617
|
+
*/
|
|
23618
|
+
readonly RemoteCreateMotor6D: RBXScriptSignal<(humanoid: Humanoid) => void>;
|
|
23619
|
+
/**
|
|
23620
|
+
* Tags: Hidden
|
|
23621
|
+
*/
|
|
23622
|
+
readonly RemoteDestroyMotor6D: RBXScriptSignal<() => void>;
|
|
23575
23623
|
}
|
|
23576
23624
|
|
|
23577
23625
|
/** A type of [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) that a player character can 'sit' in. When a character touches an enabled Seat object, it will be attached to the part by a [Weld](https://developer.roblox.com/en-us/api-reference/class/Weld) and the default character scripts will play a sitting animation.
|
|
@@ -23624,6 +23672,14 @@ interface Seat extends Part {
|
|
|
23624
23672
|
* Forces the character with the specified [Humanoid](https://developer.roblox.com/api-reference/class/Humanoid "Humanoid") to sit in the Seat.
|
|
23625
23673
|
*/
|
|
23626
23674
|
Sit(this: Seat, humanoid: Humanoid): void;
|
|
23675
|
+
/**
|
|
23676
|
+
* Tags: Hidden
|
|
23677
|
+
*/
|
|
23678
|
+
readonly RemoteCreateSeatWeld: RBXScriptSignal<(humanoid: Humanoid) => void>;
|
|
23679
|
+
/**
|
|
23680
|
+
* Tags: Hidden
|
|
23681
|
+
*/
|
|
23682
|
+
readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
|
|
23627
23683
|
}
|
|
23628
23684
|
|
|
23629
23685
|
/** A SkateboardPlatform can be used to create a skateboard. When characters get on a skateboard, they are stuck to it until they press the escape key. Until then, the character uses skateboard animations and travels faster than a walking character. */
|
|
@@ -23670,6 +23726,14 @@ interface SkateboardPlatform extends Part {
|
|
|
23670
23726
|
* Fired when the SkateboardPlatform's [SkateboardPlatform.ControllingHumanoid](https://developer.roblox.com/en-us/api-reference/property/SkateboardPlatform/ControllingHumanoid) changes the force being used on the SkateboardPlatform.
|
|
23671
23727
|
*/
|
|
23672
23728
|
readonly MoveStateChanged: RBXScriptSignal<(newState: Enum.MoveState, oldState: Enum.MoveState) => void>;
|
|
23729
|
+
/**
|
|
23730
|
+
* Tags: Hidden
|
|
23731
|
+
*/
|
|
23732
|
+
readonly RemoteCreateMotor6D: RBXScriptSignal<(humanoid: Humanoid) => void>;
|
|
23733
|
+
/**
|
|
23734
|
+
* Tags: Hidden
|
|
23735
|
+
*/
|
|
23736
|
+
readonly RemoteDestroyMotor6D: RBXScriptSignal<() => void>;
|
|
23673
23737
|
/**
|
|
23674
23738
|
* Fired whenever the skateboard is unequipped.
|
|
23675
23739
|
*/
|
|
@@ -24278,6 +24342,14 @@ interface VehicleSeat extends BasePart {
|
|
|
24278
24342
|
* Forces the character with the specified [Humanoid](https://developer.roblox.com/api-reference/class/Humanoid "Humanoid") to sit in the VehicleSeat.
|
|
24279
24343
|
*/
|
|
24280
24344
|
Sit(this: VehicleSeat, humanoid: Humanoid): void;
|
|
24345
|
+
/**
|
|
24346
|
+
* Tags: Hidden
|
|
24347
|
+
*/
|
|
24348
|
+
readonly RemoteCreateSeatWeld: RBXScriptSignal<(humanoid: Humanoid) => void>;
|
|
24349
|
+
/**
|
|
24350
|
+
* Tags: Hidden
|
|
24351
|
+
*/
|
|
24352
|
+
readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
|
|
24281
24353
|
}
|
|
24282
24354
|
|
|
24283
24355
|
/** Models are container objects, meaning they group objects together. They are best used to hold collections of [BaseParts](https://developer.roblox.com/en-us/api-reference/class/BasePart) and have a number of functions that extend their functionality.
|
|
@@ -24373,13 +24445,13 @@ interface Model extends PVInstance {
|
|
|
24373
24445
|
GetExtentsSize(this: Model): Vector3;
|
|
24374
24446
|
/**
|
|
24375
24447
|
* This value historically returned the CFrame of a central position in the model. It has been deprecated as it did not provide reliable results.
|
|
24376
|
-
* Tags: Deprecated
|
|
24448
|
+
* Tags: Deprecated, [object Object]
|
|
24377
24449
|
* @deprecated
|
|
24378
24450
|
*/
|
|
24379
24451
|
GetModelCFrame(this: Model): CFrame;
|
|
24380
24452
|
/**
|
|
24381
24453
|
* The GetModelSize function returns the `Vector3` size of the [Model](https://developer.roblox.com/en-us/api-reference/class/Model).
|
|
24382
|
-
* Tags: Deprecated
|
|
24454
|
+
* Tags: Deprecated, [object Object]
|
|
24383
24455
|
* @deprecated
|
|
24384
24456
|
*/
|
|
24385
24457
|
GetModelSize(this: Model): Vector3;
|
|
@@ -24399,7 +24471,7 @@ interface Model extends PVInstance {
|
|
|
24399
24471
|
* ```lua
|
|
24400
24472
|
* local cFrame = Model.PrimaryPart and Model.PrimaryPart.CFrame
|
|
24401
24473
|
* ```
|
|
24402
|
-
* Tags: Deprecated
|
|
24474
|
+
* Tags: Deprecated, [object Object]
|
|
24403
24475
|
* @deprecated
|
|
24404
24476
|
*/
|
|
24405
24477
|
GetPrimaryPartCFrame(this: Model): CFrame;
|
|
@@ -24431,14 +24503,14 @@ interface Model extends PVInstance {
|
|
|
24431
24503
|
RemovePersistentPlayer(this: Model, playerInstance?: Player): void;
|
|
24432
24504
|
/**
|
|
24433
24505
|
* Resets the rotation of the model's parts to the previously set identity rotation, which is done through the [Model:SetIdentityOrientation](https://developer.roblox.com/en-us/api-reference/function/Model/SetIdentityOrientation) method.
|
|
24434
|
-
* Tags: Deprecated
|
|
24506
|
+
* Tags: Deprecated, [object Object]
|
|
24435
24507
|
* @deprecated
|
|
24436
24508
|
*/
|
|
24437
24509
|
ResetOrientationToIdentity(this: Model): void;
|
|
24438
24510
|
ScaleTo(this: Model, newScaleFactor: number): void;
|
|
24439
24511
|
/**
|
|
24440
24512
|
* Sets the identity rotation of the given model, allowing you to reset the rotation of the entire model later, through the use of the `ResetOrientationToIdentity` method.
|
|
24441
|
-
* Tags: Deprecated
|
|
24513
|
+
* Tags: Deprecated, [object Object]
|
|
24442
24514
|
* @deprecated
|
|
24443
24515
|
*/
|
|
24444
24516
|
SetIdentityOrientation(this: Model): void;
|
|
@@ -24456,7 +24528,7 @@ interface Model extends PVInstance {
|
|
|
24456
24528
|
* ```
|
|
24457
24529
|
*
|
|
24458
24530
|
* A common use for this is for the 'teleportation' of player characters to different positions.
|
|
24459
|
-
* Tags: Deprecated
|
|
24531
|
+
* Tags: Deprecated, [object Object]
|
|
24460
24532
|
* @deprecated
|
|
24461
24533
|
*/
|
|
24462
24534
|
SetPrimaryPartCFrame(this: Model, cframe: CFrame): void;
|
|
@@ -24537,7 +24609,7 @@ interface WorldRoot extends Model {
|
|
|
24537
24609
|
* * Parts that are in a [collision group](https://developer.roblox.com/en-us/articles/collision-filtering) that does not collide with the “Default” collision group are ignored implicitly.
|
|
24538
24610
|
*
|
|
24539
24611
|
* For a demonstration of how raycasting works in Roblox, see the [Intro to Raycasting](https://developer.roblox.com/articles/Raycasting) article.
|
|
24540
|
-
* Tags: Deprecated
|
|
24612
|
+
* Tags: Deprecated, [object Object]
|
|
24541
24613
|
* @deprecated
|
|
24542
24614
|
*/
|
|
24543
24615
|
FindPartOnRay(
|
|
@@ -24559,7 +24631,7 @@ interface WorldRoot extends Model {
|
|
|
24559
24631
|
* * The length (magnitude) of the directional vector is important, as parts further away than its length will not be tested.
|
|
24560
24632
|
* * If the ray does not intersect anything, the return values will be `nil` and the point at the end of the ray, respectively.
|
|
24561
24633
|
* * Parts that are in a [collision group](https://developer.roblox.com/en-us/articles/collision-filtering) that does not collide with the “Default” collision group are ignored implicitly.
|
|
24562
|
-
* Tags: Deprecated
|
|
24634
|
+
* Tags: Deprecated, [object Object]
|
|
24563
24635
|
* @deprecated
|
|
24564
24636
|
*/
|
|
24565
24637
|
FindPartOnRayWithIgnoreList(
|
|
@@ -24588,7 +24660,7 @@ interface WorldRoot extends Model {
|
|
|
24588
24660
|
* * The length (magnitude) of the directional vector is important, as parts further away than its length will not be tested.
|
|
24589
24661
|
* * If the ray does not intersect anything, the return values will be `nil` and the point at the end of the ray, respectively.
|
|
24590
24662
|
* * Parts that are in a [collision group](https://developer.roblox.com/en-us/articles/collision-filtering) that does not collide with the “Default” collision group are ignored implicitly.
|
|
24591
|
-
* Tags: Deprecated
|
|
24663
|
+
* Tags: Deprecated, [object Object]
|
|
24592
24664
|
* @deprecated
|
|
24593
24665
|
*/
|
|
24594
24666
|
FindPartOnRayWithWhitelist(
|
|
@@ -24621,7 +24693,7 @@ interface WorldRoot extends Model {
|
|
|
24621
24693
|
* This means that the area that is inspected by the function may be larger than the [Region3](https://developer.roblox.com/en-us/api-reference/datatype/Region3). For this reason it is recommended to make sure that the [Region3](https://developer.roblox.com/en-us/api-reference/datatype/Region3) is on the voxel grid. The best way to do this is by setting the coordinates of the [Region3](https://developer.roblox.com/en-us/api-reference/datatype/Region3) to multiples of 4 (since voxels are 4 x 4 x 4 studs).
|
|
24622
24694
|
*
|
|
24623
24695
|
* This method is a fairly quick and easy way to see if parts are in a general area. If a game needs to know if parts are exactly in an area, then [BasePart:GetTouchingParts](https://developer.roblox.com/en-us/api-reference/function/BasePart/GetTouchingParts) should be used. There is a higher cost to using [BasePart:GetTouchingParts](https://developer.roblox.com/en-us/api-reference/function/BasePart/GetTouchingParts) since a part is needed in the [Workspace](https://developer.roblox.com/en-us/api-reference/class/Workspace) and the function takes more time to run.
|
|
24624
|
-
* Tags: Deprecated
|
|
24696
|
+
* Tags: Deprecated, [object Object]
|
|
24625
24697
|
* @deprecated
|
|
24626
24698
|
*/
|
|
24627
24699
|
FindPartsInRegion3(
|
|
@@ -24652,7 +24724,7 @@ interface WorldRoot extends Model {
|
|
|
24652
24724
|
* -----
|
|
24653
24725
|
*
|
|
24654
24726
|
* * If a nil value is given in the ignore list, instances after this value will not be ignored
|
|
24655
|
-
* Tags: Deprecated
|
|
24727
|
+
* Tags: Deprecated, [object Object]
|
|
24656
24728
|
* @deprecated
|
|
24657
24729
|
*/
|
|
24658
24730
|
FindPartsInRegion3WithIgnoreList(
|
|
@@ -24683,7 +24755,7 @@ interface WorldRoot extends Model {
|
|
|
24683
24755
|
* -----
|
|
24684
24756
|
*
|
|
24685
24757
|
* * If a nil value is given in the white list, instances after this value will be disregarded
|
|
24686
|
-
* Tags: Deprecated
|
|
24758
|
+
* Tags: Deprecated, [object Object]
|
|
24687
24759
|
* @deprecated
|
|
24688
24760
|
*/
|
|
24689
24761
|
FindPartsInRegion3WithWhiteList(
|
|
@@ -24751,7 +24823,7 @@ interface WorldRoot extends Model {
|
|
|
24751
24823
|
* This means that the area that is inspected by the function may be larger than the [Region3](https://developer.roblox.com/en-us/api-reference/datatype/Region3). For this reason it is recommended to make sure that the [Region3](https://developer.roblox.com/en-us/api-reference/datatype/Region3) is on the voxel grid. The best way to do this is by setting the coordinates of the [Region3](https://developer.roblox.com/en-us/api-reference/datatype/Region3) to multiples of 4 (since voxels are 4 x 4 x 4 studs).
|
|
24752
24824
|
*
|
|
24753
24825
|
* This method is a fairly quick and easy way to see if any parts are in a general area. If a game needs to know if parts are exactly in an area, then [BasePart:GetTouchingParts](https://developer.roblox.com/en-us/api-reference/function/BasePart/GetTouchingParts) should be used. There is a higher cost to using [BasePart:GetTouchingParts](https://developer.roblox.com/en-us/api-reference/function/BasePart/GetTouchingParts) since a part is needed in the [Workspace](https://developer.roblox.com/en-us/api-reference/class/Workspace) and the function takes more time to run.
|
|
24754
|
-
* Tags: Deprecated
|
|
24826
|
+
* Tags: Deprecated, [object Object]
|
|
24755
24827
|
* @deprecated
|
|
24756
24828
|
*/
|
|
24757
24829
|
IsRegion3Empty(this: WorldRoot, region: Region3, ignoreDescendentsInstance?: Instance): boolean;
|
|
@@ -24782,7 +24854,7 @@ interface WorldRoot extends Model {
|
|
|
24782
24854
|
* -----
|
|
24783
24855
|
*
|
|
24784
24856
|
* * If a nil value is given in the ignore list, instances after this value will not be ignored
|
|
24785
|
-
* Tags: Deprecated
|
|
24857
|
+
* Tags: Deprecated, [object Object]
|
|
24786
24858
|
* @deprecated
|
|
24787
24859
|
*/
|
|
24788
24860
|
IsRegion3EmptyWithIgnoreList(this: WorldRoot, region: Region3, ignoreDescendentsTable: Array<Instance>): boolean;
|
|
@@ -25596,7 +25668,7 @@ interface ParticleEmitter extends Instance {
|
|
|
25596
25668
|
VelocityInheritance: number;
|
|
25597
25669
|
/**
|
|
25598
25670
|
* This property determines how offset a particle can be fired from the local emitter direction of its parent. When a particle is created its offset is picked randomly between 0 and VelocitySpread. This value is measured in degrees.
|
|
25599
|
-
* Tags: NotReplicated, Deprecated
|
|
25671
|
+
* Tags: NotReplicated, Deprecated, [object Object]
|
|
25600
25672
|
* @deprecated
|
|
25601
25673
|
*/
|
|
25602
25674
|
VelocitySpread: number;
|
|
@@ -25625,6 +25697,14 @@ interface ParticleEmitter extends Instance {
|
|
|
25625
25697
|
* To clear any emit particles, use [ParticleEmitter:Clear](https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Clear).
|
|
25626
25698
|
*/
|
|
25627
25699
|
Emit(this: ParticleEmitter, particleCount?: number): void;
|
|
25700
|
+
/**
|
|
25701
|
+
* Tags: Hidden
|
|
25702
|
+
*/
|
|
25703
|
+
readonly OnClearRequested: RBXScriptSignal<() => void>;
|
|
25704
|
+
/**
|
|
25705
|
+
* Tags: Hidden
|
|
25706
|
+
*/
|
|
25707
|
+
readonly OnEmitRequested: RBXScriptSignal<(particleCount: number) => void>;
|
|
25628
25708
|
}
|
|
25629
25709
|
|
|
25630
25710
|
interface PatchMapping extends Instance {
|
|
@@ -25667,7 +25747,7 @@ interface Path extends Instance {
|
|
|
25667
25747
|
readonly Status: Enum.PathStatus;
|
|
25668
25748
|
/**
|
|
25669
25749
|
* This function returns a table of [Path](https://developer.roblox.com/en-us/api-reference/class/Path) instances.
|
|
25670
|
-
* Tags: Deprecated
|
|
25750
|
+
* Tags: Deprecated, [object Object]
|
|
25671
25751
|
* @deprecated
|
|
25672
25752
|
*/
|
|
25673
25753
|
GetPointCoordinates(this: Path): unknown;
|
|
@@ -25870,13 +25950,13 @@ interface PathfindingService extends Instance {
|
|
|
25870
25950
|
CreatePath(this: PathfindingService, agentParameters?: AgentParameters): Path;
|
|
25871
25951
|
/**
|
|
25872
25952
|
* This function computes and returns a [Path](https://developer.roblox.com/en-us/api-reference/class/Path) between two [Vector3s](https://developer.roblox.com/en-us/api-reference/datatype/Vector3). If the given MaxDistance is greater than 512, an error will be thrown. (MaxDistance is too large).
|
|
25873
|
-
* Tags: Yields, Deprecated
|
|
25953
|
+
* Tags: Yields, Deprecated, [object Object]
|
|
25874
25954
|
* @deprecated
|
|
25875
25955
|
*/
|
|
25876
25956
|
ComputeRawPathAsync(this: PathfindingService, start: Vector3, finish: Vector3, maxDistance: number): Instance | undefined;
|
|
25877
25957
|
/**
|
|
25878
25958
|
* This function computes and returns a smooth [Path](https://developer.roblox.com/en-us/api-reference/class/Path) between two [Vector3s](https://developer.roblox.com/en-us/api-reference/datatype/Vector3). This function fulfills the same purpose as [PathfindingService:ComputeRawPathAsync](https://developer.roblox.com/en-us/api-reference/function/PathfindingService/ComputeRawPathAsync), but creates a much smoother path for an NPC to follow in comparison.
|
|
25879
|
-
* Tags: Yields, Deprecated
|
|
25959
|
+
* Tags: Yields, Deprecated, [object Object]
|
|
25880
25960
|
* @deprecated
|
|
25881
25961
|
*/
|
|
25882
25962
|
ComputeSmoothPathAsync(this: PathfindingService, start: Vector3, finish: Vector3, maxDistance: number): Instance | undefined;
|
|
@@ -25947,7 +26027,7 @@ interface PhysicsService extends Instance {
|
|
|
25947
26027
|
*
|
|
25948
26028
|
* * The specified group does not exist.
|
|
25949
26029
|
* * The specified part is not a BasePart.
|
|
25950
|
-
* Tags: Deprecated
|
|
26030
|
+
* Tags: Deprecated, [object Object]
|
|
25951
26031
|
* @deprecated
|
|
25952
26032
|
*/
|
|
25953
26033
|
CollisionGroupContainsPart(this: PhysicsService, name: string, part: BasePart): boolean;
|
|
@@ -25965,7 +26045,7 @@ interface PhysicsService extends Instance {
|
|
|
25965
26045
|
CollisionGroupsAreCollidable(this: PhysicsService, name1: string, name2: string): boolean;
|
|
25966
26046
|
/**
|
|
25967
26047
|
* Creates a new collision group with the given name, and returns the id of the created group.
|
|
25968
|
-
* Tags: Deprecated
|
|
26048
|
+
* Tags: Deprecated, [object Object]
|
|
25969
26049
|
* @deprecated
|
|
25970
26050
|
*/
|
|
25971
26051
|
CreateCollisionGroup(this: PhysicsService, name: string): number;
|
|
@@ -25973,7 +26053,7 @@ interface PhysicsService extends Instance {
|
|
|
25973
26053
|
* The GetCollisionGroupId function returns the id of the collision group with the specified name.
|
|
25974
26054
|
*
|
|
25975
26055
|
* This function will throw an error if no group with the given name exists.
|
|
25976
|
-
* Tags: Deprecated
|
|
26056
|
+
* Tags: Deprecated, [object Object]
|
|
25977
26057
|
* @deprecated
|
|
25978
26058
|
*/
|
|
25979
26059
|
GetCollisionGroupId(this: PhysicsService, name: string): number;
|
|
@@ -25981,7 +26061,7 @@ interface PhysicsService extends Instance {
|
|
|
25981
26061
|
* 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.
|
|
25982
26062
|
*
|
|
25983
26063
|
* This function will throw an error if the id is not in the range of 0 <= id < maxCollisionGroups
|
|
25984
|
-
* Tags: Deprecated
|
|
26064
|
+
* Tags: Deprecated, [object Object]
|
|
25985
26065
|
* @deprecated
|
|
25986
26066
|
*/
|
|
25987
26067
|
GetCollisionGroupName(this: PhysicsService, name: number): string;
|
|
@@ -26011,7 +26091,7 @@ interface PhysicsService extends Instance {
|
|
|
26011
26091
|
* string
|
|
26012
26092
|
*
|
|
26013
26093
|
* The name of the group
|
|
26014
|
-
* Tags: Deprecated
|
|
26094
|
+
* Tags: Deprecated, [object Object]
|
|
26015
26095
|
* @deprecated
|
|
26016
26096
|
*/
|
|
26017
26097
|
GetCollisionGroups(this: PhysicsService): Array<CollisionGroupInfo>;
|
|
@@ -26031,7 +26111,7 @@ interface PhysicsService extends Instance {
|
|
|
26031
26111
|
*
|
|
26032
26112
|
* * The name “Default” is provided.
|
|
26033
26113
|
* * The function is called from a client.
|
|
26034
|
-
* Tags: Deprecated
|
|
26114
|
+
* Tags: Deprecated, [object Object]
|
|
26035
26115
|
* @deprecated
|
|
26036
26116
|
*/
|
|
26037
26117
|
RemoveCollisionGroup(this: PhysicsService, name: string): void;
|
|
@@ -26057,7 +26137,7 @@ interface PhysicsService extends Instance {
|
|
|
26057
26137
|
*
|
|
26058
26138
|
* * The part parameter is not a [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) instance.
|
|
26059
26139
|
* * The specified group does not exist.
|
|
26060
|
-
* Tags: Deprecated
|
|
26140
|
+
* Tags: Deprecated, [object Object]
|
|
26061
26141
|
* @deprecated
|
|
26062
26142
|
*/
|
|
26063
26143
|
SetPartCollisionGroup(this: PhysicsService, part: BasePart, name: string): void;
|
|
@@ -26184,7 +26264,7 @@ interface Player extends Instance {
|
|
|
26184
26264
|
* It is automatically set by Roblox to load your avatar's appearance when you join a game.
|
|
26185
26265
|
*
|
|
26186
26266
|
* Attempting to set the property after the character has spawned will not change the character, you must call [Player:LoadCharacter](https://developer.roblox.com/en-us/api-reference/function/Player/LoadCharacter) to load the new appearance.
|
|
26187
|
-
* Tags: NotBrowsable, Deprecated
|
|
26267
|
+
* Tags: NotBrowsable, Deprecated, [object Object]
|
|
26188
26268
|
* @deprecated
|
|
26189
26269
|
*/
|
|
26190
26270
|
CharacterAppearance: string;
|
|
@@ -27012,7 +27092,7 @@ interface Players extends Instance {
|
|
|
27012
27092
|
readonly MaxPlayers: number;
|
|
27013
27093
|
/**
|
|
27014
27094
|
* This property indicates the number of people in the server at the current time. It is read only. Meaning it cannot be written to, only read.
|
|
27015
|
-
* Tags: ReadOnly, NotReplicated, Deprecated
|
|
27095
|
+
* Tags: ReadOnly, NotReplicated, Deprecated, [object Object]
|
|
27016
27096
|
* @deprecated
|
|
27017
27097
|
*/
|
|
27018
27098
|
readonly NumPlayers: number;
|
|
@@ -28121,6 +28201,22 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
|
|
|
28121
28201
|
* Tags: Yields
|
|
28122
28202
|
*/
|
|
28123
28203
|
InvokeServer(this: RemoteFunction, ...args: Parameters<T>): ReturnType<T>;
|
|
28204
|
+
/**
|
|
28205
|
+
* Tags: Hidden
|
|
28206
|
+
*/
|
|
28207
|
+
readonly RemoteOnInvokeClient: RBXScriptSignal<(id: number, arguments: Array<any>) => void>;
|
|
28208
|
+
/**
|
|
28209
|
+
* Tags: Hidden
|
|
28210
|
+
*/
|
|
28211
|
+
readonly RemoteOnInvokeError: RBXScriptSignal<(id: number, arguments: string) => void>;
|
|
28212
|
+
/**
|
|
28213
|
+
* Tags: Hidden
|
|
28214
|
+
*/
|
|
28215
|
+
readonly RemoteOnInvokeServer: RBXScriptSignal<(id: number, player: Player, arguments: Array<any>) => void>;
|
|
28216
|
+
/**
|
|
28217
|
+
* Tags: Hidden
|
|
28218
|
+
*/
|
|
28219
|
+
readonly RemoteOnInvokeSuccess: RBXScriptSignal<(id: number, arguments: Array<any>) => void>;
|
|
28124
28220
|
OnClientInvoke: T | undefined;
|
|
28125
28221
|
OnServerInvoke: ((player: Player, ...args: Array<unknown>) => void) | undefined;
|
|
28126
28222
|
}
|
|
@@ -28990,13 +29086,13 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
28990
29086
|
readonly PrivateServerOwnerId: number;
|
|
28991
29087
|
/**
|
|
28992
29088
|
* This property was string that could identify the current server as a VIP server.
|
|
28993
|
-
* Tags: Hidden, ReadOnly, NotReplicated, Deprecated
|
|
29089
|
+
* Tags: Hidden, ReadOnly, NotReplicated, Deprecated, [object Object]
|
|
28994
29090
|
* @deprecated
|
|
28995
29091
|
*/
|
|
28996
29092
|
readonly VIPServerId: string;
|
|
28997
29093
|
/**
|
|
28998
29094
|
* This property indicates the [UserId](https://developer.roblox.com/en-us/api-reference/property/Player/UserId) of the account who owns the VIP server.
|
|
28999
|
-
* Tags: Hidden, ReadOnly, NotReplicated, Deprecated
|
|
29095
|
+
* Tags: Hidden, ReadOnly, NotReplicated, Deprecated, [object Object]
|
|
29000
29096
|
* @deprecated
|
|
29001
29097
|
*/
|
|
29002
29098
|
readonly VIPServerOwnerId: number;
|
|
@@ -29133,7 +29229,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
29133
29229
|
*/
|
|
29134
29230
|
readonly Loaded: RBXScriptSignal<() => void>;
|
|
29135
29231
|
/**
|
|
29136
|
-
* Tags: Deprecated
|
|
29232
|
+
* Tags: Deprecated, [object Object]
|
|
29137
29233
|
* @deprecated
|
|
29138
29234
|
*/
|
|
29139
29235
|
OnClose: () => void;
|
|
@@ -29441,7 +29537,7 @@ interface Sound extends Instance {
|
|
|
29441
29537
|
* Sounds parented to a [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) or [Attachment](https://developer.roblox.com/en-us/api-reference/class/Attachment) that are descendants of the [Workspace](https://developer.roblox.com/en-us/api-reference/class/Workspace) are considered 3D sounds and their volume whilst playing is dependent on the distance between the client's sound listener ([Camera](https://developer.roblox.com/en-us/api-reference/class/Camera) position by default) and the Sound's parent. Two properties influence this behavior EmitterSize and [Sound.RollOffMode](https://developer.roblox.com/en-us/api-reference/property/Sound/RollOffMode).
|
|
29442
29538
|
*
|
|
29443
29539
|
* The way the [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) attenuates (fades out) after the distance between the listener and the sound exceeds the EmitterSize is determined by RollOffMode.
|
|
29444
|
-
* Tags: Deprecated
|
|
29540
|
+
* Tags: Deprecated, [object Object]
|
|
29445
29541
|
* @deprecated
|
|
29446
29542
|
*/
|
|
29447
29543
|
EmitterSize: number;
|
|
@@ -29485,7 +29581,7 @@ interface Sound extends Instance {
|
|
|
29485
29581
|
* How MaxDistance impacts the attenuation of a sound (manner in which it fades out) is dependent on the [Sound.RollOffMode](https://developer.roblox.com/en-us/api-reference/property/Sound/RollOffMode) property. When RollOffMode is set to use an inverse type distance model (Inverse or InverseTapered) the MaxDistance will not effect the attenuation of the sound. This means that low values for MaxDistance will cause the sound to abruptly cut off when the listener reaches the MaxDistance. In most cases this is not desirable and developers are advised not to use low MaxDistance values.
|
|
29486
29582
|
*
|
|
29487
29583
|
* When RollOffMode is set to a linear type distance model (Linear or LinearSquared) the sound will attenuate between [Sound.EmitterSize](https://developer.roblox.com/en-us/api-reference/property/Sound/EmitterSize) and MaxDistance (with playback volume reaching zero at MaxDistance). This is less realistic, but in some cases allows attenuation to be handled in a more intuitive way.
|
|
29488
|
-
* Tags: Deprecated
|
|
29584
|
+
* Tags: Deprecated, [object Object]
|
|
29489
29585
|
* @deprecated
|
|
29490
29586
|
*/
|
|
29491
29587
|
MaxDistance: number;
|
|
@@ -29493,7 +29589,7 @@ interface Sound extends Instance {
|
|
|
29493
29589
|
* The minimum distance at which a 3D [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) (direct child of a [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) or [Attachment](https://developer.roblox.com/en-us/api-reference/class/Attachment)) will begin to attenuate. Effectively, the emitter size.
|
|
29494
29590
|
*
|
|
29495
29591
|
* Deprecated in favor of Sound.EmitterSize.
|
|
29496
|
-
* Tags: Deprecated
|
|
29592
|
+
* Tags: Deprecated, [object Object]
|
|
29497
29593
|
* @deprecated
|
|
29498
29594
|
*/
|
|
29499
29595
|
MinDistance: number;
|
|
@@ -29501,7 +29597,7 @@ interface Sound extends Instance {
|
|
|
29501
29597
|
* Sets how high pitched and fast a [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) is when it is played. The greater the integer, the higher and faster the sound is.
|
|
29502
29598
|
*
|
|
29503
29599
|
* This property has been deprecated in favor of [Sound.PlaybackSpeed](https://developer.roblox.com/en-us/api-reference/property/Sound/PlaybackSpeed) whose name suits the behavior better.
|
|
29504
|
-
* Tags: Deprecated
|
|
29600
|
+
* Tags: Deprecated, [object Object]
|
|
29505
29601
|
* @deprecated
|
|
29506
29602
|
*/
|
|
29507
29603
|
Pitch: number;
|
|
@@ -32815,6 +32911,10 @@ interface Trail extends Instance {
|
|
|
32815
32911
|
* Calling this function will only affect old segments that have already been done. It will not affect the drawing of any new trail segments after this function call. If you would like to clear existing trail segments, and temporarily prevent new segments from being drawn, consider toggling the trail's [Trail.Enabled](https://developer.roblox.com/en-us/api-reference/property/Trail/Enabled) property to false at the same time.
|
|
32816
32912
|
*/
|
|
32817
32913
|
Clear(this: Trail): void;
|
|
32914
|
+
/**
|
|
32915
|
+
* Tags: Hidden
|
|
32916
|
+
*/
|
|
32917
|
+
readonly OnClearRequested: RBXScriptSignal<() => void>;
|
|
32818
32918
|
}
|
|
32819
32919
|
|
|
32820
32920
|
/** The role of a Translator is to manufacture/return strings localized for the viewing player. it can be used to retrieve display-ready localized text from a [LocalizationTable](https://developer.roblox.com/en-us/api-reference/class/LocalizationTable). The source of the [Translator.LocaleId](https://developer.roblox.com/en-us/api-reference/property/Translator/LocaleId) property, the set of tables it will search, and the order it will search them in depends on which method was used to create the Translator instance.
|
|
@@ -34124,7 +34224,7 @@ interface UserInputService extends Instance {
|
|
|
34124
34224
|
* This property will only work when used in a [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript) running for the player whose character controls are to be hidden.
|
|
34125
34225
|
*
|
|
34126
34226
|
* Even if mobile controls are hidden for a player on a mobile device, other UserInputService events such as [UserInputService.InputBegan](https://developer.roblox.com/en-us/api-reference/event/UserInputService/InputBegan) and [UserInputService.TouchSwipe](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchSwipe) can still be used to process other forms of user input on mobile devices with an enabled touch screen (see the main UserInputService class page for a full list).
|
|
34127
|
-
* Tags: Deprecated
|
|
34227
|
+
* Tags: Deprecated, [object Object]
|
|
34128
34228
|
* @deprecated
|
|
34129
34229
|
*/
|
|
34130
34230
|
ModalEnabled: boolean;
|
|
@@ -122,12 +122,12 @@ interface AnimationClipProvider extends Instance {
|
|
|
122
122
|
*/
|
|
123
123
|
readonly _nominal_AnimationClipProvider: unique symbol;
|
|
124
124
|
/**
|
|
125
|
-
* Tags: Deprecated
|
|
125
|
+
* Tags: Deprecated, [object Object]
|
|
126
126
|
* @deprecated
|
|
127
127
|
*/
|
|
128
128
|
GetAnimationClip(this: AnimationClipProvider, assetId: string): AnimationClip;
|
|
129
129
|
/**
|
|
130
|
-
* Tags: Deprecated
|
|
130
|
+
* Tags: Deprecated, [object Object]
|
|
131
131
|
* @deprecated
|
|
132
132
|
*/
|
|
133
133
|
GetAnimationClipById(this: AnimationClipProvider, assetId: number, useCache: boolean): AnimationClip;
|
|
@@ -914,13 +914,13 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
914
914
|
readonly _nominal_KeyframeSequenceProvider: unique symbol;
|
|
915
915
|
/**
|
|
916
916
|
* Returns a [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) from a given asset URL.
|
|
917
|
-
* Tags: Deprecated
|
|
917
|
+
* Tags: Deprecated, [object Object]
|
|
918
918
|
* @deprecated
|
|
919
919
|
*/
|
|
920
920
|
GetKeyframeSequence(this: KeyframeSequenceProvider, assetId: string): Instance | undefined;
|
|
921
921
|
/**
|
|
922
922
|
* Returns a [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) from the supplied assetId. Can optionally cache to reduce unnecessary loading freezes.
|
|
923
|
-
* Tags: Deprecated
|
|
923
|
+
* Tags: Deprecated, [object Object]
|
|
924
924
|
* @deprecated
|
|
925
925
|
*/
|
|
926
926
|
GetKeyframeSequenceById(this: KeyframeSequenceProvider, assetId: number, useCache: boolean): Instance | undefined;
|