@rbxts/types 1.0.904 → 1.0.906
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/include/generated/None.d.ts +141 -84
- package/include/generated/PluginSecurity.d.ts +348 -11
- package/include/generated/enums.d.ts +362 -7
- package/package.json +1 -1
|
@@ -77,6 +77,7 @@ interface Services {
|
|
|
77
77
|
FacialAnimationRecordingService: FacialAnimationRecordingService;
|
|
78
78
|
FacialAnimationStreamingServiceV2: FacialAnimationStreamingServiceV2;
|
|
79
79
|
FeatureRestrictionManager: FeatureRestrictionManager;
|
|
80
|
+
FileManagerService: FileManagerService;
|
|
80
81
|
GamepadService: GamepadService;
|
|
81
82
|
GamePassService: GamePassService;
|
|
82
83
|
GenerationService: GenerationService;
|
|
@@ -217,6 +218,7 @@ interface Services {
|
|
|
217
218
|
TextService: TextService;
|
|
218
219
|
TextureGenerationService: TextureGenerationService;
|
|
219
220
|
ToastNotificationService: ToastNotificationService;
|
|
221
|
+
TraceRouteService: TraceRouteService;
|
|
220
222
|
TracerService: TracerService;
|
|
221
223
|
TutorialService: TutorialService;
|
|
222
224
|
TweenService: TweenService;
|
|
@@ -239,6 +241,7 @@ interface Services {
|
|
|
239
241
|
WebSocketService: WebSocketService;
|
|
240
242
|
WebViewService: WebViewService;
|
|
241
243
|
Workspace: Workspace;
|
|
244
|
+
WrapDeformMeshProvider: WrapDeformMeshProvider;
|
|
242
245
|
}
|
|
243
246
|
interface CreatableInstances {
|
|
244
247
|
Accessory: Accessory;
|
|
@@ -2429,9 +2432,10 @@ interface Instance extends RBXObject {
|
|
|
2429
2432
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetStyled)
|
|
2430
2433
|
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
2431
2434
|
* @param name Name of the property to query.
|
|
2435
|
+
* @param selector Optional selector for the pseudo instance you are targeting on the instance.
|
|
2432
2436
|
* @returns The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
|
|
2433
2437
|
*/
|
|
2434
|
-
GetStyled(this: Instance, name: string): unknown;
|
|
2438
|
+
GetStyled(this: Instance, name: string, selector?: string): unknown;
|
|
2435
2439
|
/**
|
|
2436
2440
|
* - **ThreadSafety**: Unsafe
|
|
2437
2441
|
*
|
|
@@ -3022,7 +3026,7 @@ interface AnalyticsService extends Instance {
|
|
|
3022
3026
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#FireEvent)
|
|
3023
3027
|
* @param this Collection of methods that allows developers to track how users interact with their experiences.
|
|
3024
3028
|
* @param category 'The category of event to report. Cannot contain the following characters: comma `,`, double quote `"` or newline characters `\r\n`'.
|
|
3025
|
-
* @param value A value to be serialized and reported. Serialized length must not exceed 1
|
|
3029
|
+
* @param value A value to be serialized and reported. Serialized length must not exceed 1 KiB, or 1024 bytes.
|
|
3026
3030
|
*
|
|
3027
3031
|
* @deprecated
|
|
3028
3032
|
*/
|
|
@@ -3133,7 +3137,7 @@ interface AnalyticsService extends Instance {
|
|
|
3133
3137
|
* @param flowType Should specify the direction that currency is flowing using `AnalyticsEconomyFlowType`.
|
|
3134
3138
|
* @param currencyType The name of the currency being added or removed, for example `"gold"`, `"gems"`, or `"energy"`. Limited to 5 unique currency types per experience.
|
|
3135
3139
|
* @param amount The amount of currency being added or removed. This value should always be positive.
|
|
3136
|
-
* @param endingBalance The user's balance after the currency has been added or removed. This value should always be greater than or equal to 0
|
|
3140
|
+
* @param endingBalance The user's balance after the currency has been added or removed. This value should always be greater than or equal to `0`.
|
|
3137
3141
|
* @param transactionType The type of transaction that occurred. While you're free to use any transaction type, it's recommended to use the provided types from `AnalyticsEconomyTransactionType` such as `"IAP"` or `"ContextualPurchase"` to enable future insights from Roblox tools and charts. Because this field type is a string, you'll need to pass the `Name` value of the enum. For example `Enum.AnalyticsEconomyTransactionType.IAP.Name`. Limited to 20 unique types per experience.
|
|
3138
3142
|
* @param itemSku Optional SKU of the item or bundle being purchased. This is a unique identifier for the item being purchased. Limited to 100 unique SKUs per experience.
|
|
3139
3143
|
* @param customFields Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by `AnalyticsCustomFieldKeys`, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience.
|
|
@@ -3548,24 +3552,6 @@ interface AnimationNodeDefinition extends Instance {
|
|
|
3548
3552
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#NodeType)
|
|
3549
3553
|
*/
|
|
3550
3554
|
NodeType: Enum.AnimationNodeType;
|
|
3551
|
-
/**
|
|
3552
|
-
* - **ThreadSafety**: Unsafe
|
|
3553
|
-
*
|
|
3554
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#GetConnectedWires)
|
|
3555
|
-
*/
|
|
3556
|
-
GetConnectedWires(this: AnimationNodeDefinition, pin: string): Array<Instance>;
|
|
3557
|
-
/**
|
|
3558
|
-
* - **ThreadSafety**: Unsafe
|
|
3559
|
-
*
|
|
3560
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#GetInputPins)
|
|
3561
|
-
*/
|
|
3562
|
-
GetInputPins(this: AnimationNodeDefinition): Array<unknown>;
|
|
3563
|
-
/**
|
|
3564
|
-
* - **ThreadSafety**: Unsafe
|
|
3565
|
-
*
|
|
3566
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#GetOutputPins)
|
|
3567
|
-
*/
|
|
3568
|
-
GetOutputPins(this: AnimationNodeDefinition): Array<unknown>;
|
|
3569
3555
|
}
|
|
3570
3556
|
/**
|
|
3571
3557
|
* Used to store information regarding the model an animation was authored for.
|
|
@@ -10576,9 +10562,14 @@ interface CaptureService extends Instance {
|
|
|
10576
10562
|
*/
|
|
10577
10563
|
StopVideoCapture(this: CaptureService): void;
|
|
10578
10564
|
/**
|
|
10565
|
+
* Initiates a screenshot capture.
|
|
10566
|
+
*
|
|
10579
10567
|
* - **ThreadSafety**: Unsafe
|
|
10580
10568
|
*
|
|
10581
10569
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeScreenshotCaptureAsync)
|
|
10570
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
10571
|
+
* @param onCaptureReady A callback function that is called on screenshot capture completion with a `ScreenshotCaptureResult` and, if successful, a `ScreenshotCapture`.
|
|
10572
|
+
* @param captureParams A dictionary that modifies capture behavior.
|
|
10582
10573
|
*/
|
|
10583
10574
|
TakeScreenshotCaptureAsync(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
|
|
10584
10575
|
/**
|
|
@@ -10614,7 +10605,7 @@ interface CaptureService extends Instance {
|
|
|
10614
10605
|
* @param captureTypeFilters An array of `CaptureType`.
|
|
10615
10606
|
* @returns Tuple of (result: `ReadCapturesFromGalleryResult`, capturesPages: `CapturesPages`)
|
|
10616
10607
|
*/
|
|
10617
|
-
ReadCapturesFromGalleryAsync(this: CaptureService, captureTypeFilters?: Array<unknown
|
|
10608
|
+
ReadCapturesFromGalleryAsync(this: CaptureService, captureTypeFilters?: Array<unknown>, readFromAllEligibleExperiences?: boolean): unknown;
|
|
10618
10609
|
/**
|
|
10619
10610
|
* Initiates a video capture recording.
|
|
10620
10611
|
*
|
|
@@ -12456,7 +12447,7 @@ interface AnimationConstraint extends Constraint {
|
|
|
12456
12447
|
*/
|
|
12457
12448
|
readonly C1: CFrame;
|
|
12458
12449
|
/**
|
|
12459
|
-
* Toggles whether the
|
|
12450
|
+
* Toggles whether the constraint is kinematic or physically simulated.
|
|
12460
12451
|
*
|
|
12461
12452
|
* - **ThreadSafety**: ReadSafe
|
|
12462
12453
|
*
|
|
@@ -12502,7 +12493,7 @@ interface AnimationConstraint extends Constraint {
|
|
|
12502
12493
|
*/
|
|
12503
12494
|
readonly Part1: BasePart | undefined;
|
|
12504
12495
|
/**
|
|
12505
|
-
* Describes the current animation offset of the
|
|
12496
|
+
* Describes the current animation offset of the constraint joint.
|
|
12506
12497
|
*
|
|
12507
12498
|
* - **ThreadSafety**: ReadSafe
|
|
12508
12499
|
*
|
|
@@ -16713,6 +16704,21 @@ interface FeatureRestrictionManager extends Instance {
|
|
|
16713
16704
|
*/
|
|
16714
16705
|
readonly _nominal_FeatureRestrictionManager: unique symbol;
|
|
16715
16706
|
}
|
|
16707
|
+
/**
|
|
16708
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
16709
|
+
*
|
|
16710
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileManagerService)
|
|
16711
|
+
*/
|
|
16712
|
+
interface FileManagerService extends Instance {
|
|
16713
|
+
/**
|
|
16714
|
+
* **DO NOT USE!**
|
|
16715
|
+
*
|
|
16716
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16717
|
+
* @hidden
|
|
16718
|
+
* @deprecated
|
|
16719
|
+
*/
|
|
16720
|
+
readonly _nominal_FileManagerService: unique symbol;
|
|
16721
|
+
}
|
|
16716
16722
|
/**
|
|
16717
16723
|
* A preconfigured particle emitter with the visual aesthetic of fire.
|
|
16718
16724
|
*
|
|
@@ -20741,7 +20747,7 @@ interface HandleAdornment extends PVAdornment {
|
|
|
20741
20747
|
readonly MouseLeave: RBXScriptSignal<() => void>;
|
|
20742
20748
|
}
|
|
20743
20749
|
/**
|
|
20744
|
-
* A box that can be adorned to a `BasePart`.
|
|
20750
|
+
* A box-shaped handle that can be adorned to a `BasePart`.
|
|
20745
20751
|
*
|
|
20746
20752
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BoxHandleAdornment)
|
|
20747
20753
|
*/
|
|
@@ -20761,7 +20767,7 @@ interface BoxHandleAdornment extends HandleAdornment {
|
|
|
20761
20767
|
*/
|
|
20762
20768
|
Shading: Enum.AdornShading;
|
|
20763
20769
|
/**
|
|
20764
|
-
*
|
|
20770
|
+
* Size of the adornment.
|
|
20765
20771
|
*
|
|
20766
20772
|
* - **ThreadSafety**: ReadSafe
|
|
20767
20773
|
*
|
|
@@ -20770,7 +20776,7 @@ interface BoxHandleAdornment extends HandleAdornment {
|
|
|
20770
20776
|
Size: Vector3;
|
|
20771
20777
|
}
|
|
20772
20778
|
/**
|
|
20773
|
-
* A cone that can be adorned to a `BasePart`.
|
|
20779
|
+
* A cone-shaped handle that can be adorned to a `BasePart`.
|
|
20774
20780
|
*
|
|
20775
20781
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConeHandleAdornment)
|
|
20776
20782
|
*/
|
|
@@ -20784,7 +20790,7 @@ interface ConeHandleAdornment extends HandleAdornment {
|
|
|
20784
20790
|
*/
|
|
20785
20791
|
readonly _nominal_ConeHandleAdornment: unique symbol;
|
|
20786
20792
|
/**
|
|
20787
|
-
*
|
|
20793
|
+
* Height of the cone adornment.
|
|
20788
20794
|
*
|
|
20789
20795
|
* - **ThreadSafety**: ReadSafe
|
|
20790
20796
|
*
|
|
@@ -20798,7 +20804,7 @@ interface ConeHandleAdornment extends HandleAdornment {
|
|
|
20798
20804
|
*/
|
|
20799
20805
|
Hollow: boolean;
|
|
20800
20806
|
/**
|
|
20801
|
-
*
|
|
20807
|
+
* Radius of the cone adornment.
|
|
20802
20808
|
*
|
|
20803
20809
|
* - **ThreadSafety**: ReadSafe
|
|
20804
20810
|
*
|
|
@@ -20813,7 +20819,7 @@ interface ConeHandleAdornment extends HandleAdornment {
|
|
|
20813
20819
|
Shading: Enum.AdornShading;
|
|
20814
20820
|
}
|
|
20815
20821
|
/**
|
|
20816
|
-
* A cylinder that can be adorned to a `BasePart`.
|
|
20822
|
+
* A cylinder-shaped handle that can be adorned to a `BasePart`.
|
|
20817
20823
|
*
|
|
20818
20824
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CylinderHandleAdornment)
|
|
20819
20825
|
*/
|
|
@@ -20827,7 +20833,7 @@ interface CylinderHandleAdornment extends HandleAdornment {
|
|
|
20827
20833
|
*/
|
|
20828
20834
|
readonly _nominal_CylinderHandleAdornment: unique symbol;
|
|
20829
20835
|
/**
|
|
20830
|
-
* Angle of
|
|
20836
|
+
* Angle of the cylinder handle as in a "pie slice" sector.
|
|
20831
20837
|
*
|
|
20832
20838
|
* - **ThreadSafety**: ReadSafe
|
|
20833
20839
|
*
|
|
@@ -20835,7 +20841,7 @@ interface CylinderHandleAdornment extends HandleAdornment {
|
|
|
20835
20841
|
*/
|
|
20836
20842
|
Angle: number;
|
|
20837
20843
|
/**
|
|
20838
|
-
*
|
|
20844
|
+
* Height of the cylinder adornment.
|
|
20839
20845
|
*
|
|
20840
20846
|
* - **ThreadSafety**: ReadSafe
|
|
20841
20847
|
*
|
|
@@ -20843,7 +20849,7 @@ interface CylinderHandleAdornment extends HandleAdornment {
|
|
|
20843
20849
|
*/
|
|
20844
20850
|
Height: number;
|
|
20845
20851
|
/**
|
|
20846
|
-
* Inner radius
|
|
20852
|
+
* Inner radius with which to render a hollow cylinder.
|
|
20847
20853
|
*
|
|
20848
20854
|
* - **ThreadSafety**: ReadSafe
|
|
20849
20855
|
*
|
|
@@ -20851,7 +20857,7 @@ interface CylinderHandleAdornment extends HandleAdornment {
|
|
|
20851
20857
|
*/
|
|
20852
20858
|
InnerRadius: number;
|
|
20853
20859
|
/**
|
|
20854
|
-
*
|
|
20860
|
+
* Radius of the cylinder adornment.
|
|
20855
20861
|
*
|
|
20856
20862
|
* - **ThreadSafety**: ReadSafe
|
|
20857
20863
|
*
|
|
@@ -20866,7 +20872,7 @@ interface CylinderHandleAdornment extends HandleAdornment {
|
|
|
20866
20872
|
Shading: Enum.AdornShading;
|
|
20867
20873
|
}
|
|
20868
20874
|
/**
|
|
20869
|
-
* An image that can be adorned to a `BasePart`.
|
|
20875
|
+
* An image handle that can be adorned to a `BasePart`.
|
|
20870
20876
|
*
|
|
20871
20877
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageHandleAdornment)
|
|
20872
20878
|
*/
|
|
@@ -20880,7 +20886,7 @@ interface ImageHandleAdornment extends HandleAdornment {
|
|
|
20880
20886
|
*/
|
|
20881
20887
|
readonly _nominal_ImageHandleAdornment: unique symbol;
|
|
20882
20888
|
/**
|
|
20883
|
-
*
|
|
20889
|
+
* Image to draw for the adornment.
|
|
20884
20890
|
*
|
|
20885
20891
|
* - **ThreadSafety**: ReadSafe
|
|
20886
20892
|
*
|
|
@@ -20888,7 +20894,7 @@ interface ImageHandleAdornment extends HandleAdornment {
|
|
|
20888
20894
|
*/
|
|
20889
20895
|
Image: ContentId;
|
|
20890
20896
|
/**
|
|
20891
|
-
*
|
|
20897
|
+
* Size of the image in studs.
|
|
20892
20898
|
*
|
|
20893
20899
|
* - **ThreadSafety**: ReadSafe
|
|
20894
20900
|
*
|
|
@@ -20897,7 +20903,7 @@ interface ImageHandleAdornment extends HandleAdornment {
|
|
|
20897
20903
|
Size: Vector2;
|
|
20898
20904
|
}
|
|
20899
20905
|
/**
|
|
20900
|
-
* A line that can be adorned to a `BasePart`.
|
|
20906
|
+
* A line-shaped handle that can be adorned to a `BasePart`.
|
|
20901
20907
|
*
|
|
20902
20908
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LineHandleAdornment)
|
|
20903
20909
|
*/
|
|
@@ -20911,7 +20917,7 @@ interface LineHandleAdornment extends HandleAdornment {
|
|
|
20911
20917
|
*/
|
|
20912
20918
|
readonly _nominal_LineHandleAdornment: unique symbol;
|
|
20913
20919
|
/**
|
|
20914
|
-
*
|
|
20920
|
+
* Length of the line.
|
|
20915
20921
|
*
|
|
20916
20922
|
* - **ThreadSafety**: ReadSafe
|
|
20917
20923
|
*
|
|
@@ -20919,7 +20925,7 @@ interface LineHandleAdornment extends HandleAdornment {
|
|
|
20919
20925
|
*/
|
|
20920
20926
|
Length: number;
|
|
20921
20927
|
/**
|
|
20922
|
-
*
|
|
20928
|
+
* Thickness of the line in pixels.
|
|
20923
20929
|
*
|
|
20924
20930
|
* - **ThreadSafety**: ReadSafe
|
|
20925
20931
|
*
|
|
@@ -20928,6 +20934,8 @@ interface LineHandleAdornment extends HandleAdornment {
|
|
|
20928
20934
|
Thickness: number;
|
|
20929
20935
|
}
|
|
20930
20936
|
/**
|
|
20937
|
+
* A pyramid-shaped handle that can be adorned to a `BasePart`.
|
|
20938
|
+
*
|
|
20931
20939
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PyramidHandleAdornment)
|
|
20932
20940
|
*/
|
|
20933
20941
|
interface PyramidHandleAdornment extends HandleAdornment {
|
|
@@ -20940,6 +20948,8 @@ interface PyramidHandleAdornment extends HandleAdornment {
|
|
|
20940
20948
|
*/
|
|
20941
20949
|
readonly _nominal_PyramidHandleAdornment: unique symbol;
|
|
20942
20950
|
/**
|
|
20951
|
+
* Height of the pyramid adornment.
|
|
20952
|
+
*
|
|
20943
20953
|
* - **ThreadSafety**: ReadSafe
|
|
20944
20954
|
*
|
|
20945
20955
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PyramidHandleAdornment#Height)
|
|
@@ -20952,12 +20962,16 @@ interface PyramidHandleAdornment extends HandleAdornment {
|
|
|
20952
20962
|
*/
|
|
20953
20963
|
Shading: Enum.AdornShading;
|
|
20954
20964
|
/**
|
|
20965
|
+
* Number of sides for the pyramid adornment.
|
|
20966
|
+
*
|
|
20955
20967
|
* - **ThreadSafety**: ReadSafe
|
|
20956
20968
|
*
|
|
20957
20969
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PyramidHandleAdornment#Sides)
|
|
20958
20970
|
*/
|
|
20959
20971
|
Sides: number;
|
|
20960
20972
|
/**
|
|
20973
|
+
* Size of the pyramid adornment's base.
|
|
20974
|
+
*
|
|
20961
20975
|
* - **ThreadSafety**: ReadSafe
|
|
20962
20976
|
*
|
|
20963
20977
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PyramidHandleAdornment#Size)
|
|
@@ -20965,7 +20979,7 @@ interface PyramidHandleAdornment extends HandleAdornment {
|
|
|
20965
20979
|
Size: number;
|
|
20966
20980
|
}
|
|
20967
20981
|
/**
|
|
20968
|
-
*
|
|
20982
|
+
* A sphere-shaped handle that can be adorned to a `BasePart`.
|
|
20969
20983
|
*
|
|
20970
20984
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SphereHandleAdornment)
|
|
20971
20985
|
*/
|
|
@@ -20979,7 +20993,7 @@ interface SphereHandleAdornment extends HandleAdornment {
|
|
|
20979
20993
|
*/
|
|
20980
20994
|
readonly _nominal_SphereHandleAdornment: unique symbol;
|
|
20981
20995
|
/**
|
|
20982
|
-
*
|
|
20996
|
+
* Radius of the sphere adornment.
|
|
20983
20997
|
*
|
|
20984
20998
|
* - **ThreadSafety**: ReadSafe
|
|
20985
20999
|
*
|
|
@@ -21435,7 +21449,7 @@ interface Path2D extends GuiBase {
|
|
|
21435
21449
|
*/
|
|
21436
21450
|
Closed: boolean;
|
|
21437
21451
|
/**
|
|
21438
|
-
* Determines the
|
|
21452
|
+
* Determines the color of the `Path2D`.
|
|
21439
21453
|
*
|
|
21440
21454
|
* - **ThreadSafety**: ReadSafe
|
|
21441
21455
|
*
|
|
@@ -23318,7 +23332,7 @@ interface Humanoid extends Instance {
|
|
|
23318
23332
|
*/
|
|
23319
23333
|
UnequipTools(this: Humanoid): void;
|
|
23320
23334
|
/**
|
|
23321
|
-
* **Deprecated:**
|
|
23335
|
+
* **Deprecated:** This method has been superseded by `ApplyDescriptionAsync()`.
|
|
23322
23336
|
*
|
|
23323
23337
|
* Makes the character's look match that of the passed in `HumanoidDescription`.
|
|
23324
23338
|
*
|
|
@@ -23346,7 +23360,7 @@ interface Humanoid extends Instance {
|
|
|
23346
23360
|
*/
|
|
23347
23361
|
ApplyDescriptionAsync(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
23348
23362
|
/**
|
|
23349
|
-
* **Deprecated:**
|
|
23363
|
+
* **Deprecated:** This method has been superseded by `ApplyDescriptionResetAsync()`.
|
|
23350
23364
|
*
|
|
23351
23365
|
* Makes the character's look match that of the passed in `HumanoidDescription`, even after external changes.
|
|
23352
23366
|
*
|
|
@@ -23374,7 +23388,7 @@ interface Humanoid extends Instance {
|
|
|
23374
23388
|
*/
|
|
23375
23389
|
ApplyDescriptionResetAsync(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
23376
23390
|
/**
|
|
23377
|
-
* **Deprecated:**
|
|
23391
|
+
* **Deprecated:** This method has been superseded by `PlayEmoteAsync()`.
|
|
23378
23392
|
*
|
|
23379
23393
|
* Plays emotes and returns if was successfully ran.
|
|
23380
23394
|
*
|
|
@@ -25734,7 +25748,7 @@ interface JointInstance extends Instance {
|
|
|
25734
25748
|
*/
|
|
25735
25749
|
C0: CFrame;
|
|
25736
25750
|
/**
|
|
25737
|
-
*
|
|
25751
|
+
* Subtracted from the `C0` property to create an offset point for `Part1`.
|
|
25738
25752
|
*
|
|
25739
25753
|
* - **ThreadSafety**: ReadSafe
|
|
25740
25754
|
*
|
|
@@ -27066,13 +27080,14 @@ interface LocalizationTable extends Instance {
|
|
|
27066
27080
|
*/
|
|
27067
27081
|
GetString(this: LocalizationTable, targetLocaleId: string, key: string): string;
|
|
27068
27082
|
/**
|
|
27069
|
-
* Returns a `Translator` for entries in this LocalizationTable, in the specified
|
|
27083
|
+
* Returns a `Translator` for entries in this LocalizationTable, in the specified locale.
|
|
27070
27084
|
*
|
|
27071
27085
|
* - **ThreadSafety**: Unsafe
|
|
27072
27086
|
*
|
|
27073
27087
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetTranslator)
|
|
27074
27088
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27075
27089
|
* @param localeId
|
|
27090
|
+
* @returns The `Translator` instance for the specified locale.
|
|
27076
27091
|
*/
|
|
27077
27092
|
GetTranslator(this: LocalizationTable, localeId: string): Translator;
|
|
27078
27093
|
/**
|
|
@@ -27828,7 +27843,7 @@ interface MarketplaceService extends Instance {
|
|
|
27828
27843
|
Name: string;
|
|
27829
27844
|
}>;
|
|
27830
27845
|
/**
|
|
27831
|
-
* **Deprecated:**
|
|
27846
|
+
* **Deprecated:** This method has been superseded by `GetProductInfoAsync()`.
|
|
27832
27847
|
*
|
|
27833
27848
|
* Returns the product information of an asset using its asset ID.
|
|
27834
27849
|
*
|
|
@@ -27923,7 +27938,7 @@ interface MarketplaceService extends Instance {
|
|
|
27923
27938
|
*/
|
|
27924
27939
|
GetUsersPriceLevelsAsync(this: MarketplaceService, userIds: Array<unknown>): Array<unknown>;
|
|
27925
27940
|
/**
|
|
27926
|
-
* **Deprecated:**
|
|
27941
|
+
* **Deprecated:** This method has been superseded by `PlayerOwnsAssetAsync()`.
|
|
27927
27942
|
*
|
|
27928
27943
|
* Returns whether the given user has the given asset.
|
|
27929
27944
|
*
|
|
@@ -27953,7 +27968,7 @@ interface MarketplaceService extends Instance {
|
|
|
27953
27968
|
*/
|
|
27954
27969
|
PlayerOwnsAssetAsync(this: MarketplaceService, player: Instance, assetId: number): boolean;
|
|
27955
27970
|
/**
|
|
27956
|
-
* **Deprecated:**
|
|
27971
|
+
* **Deprecated:** This method has been superseded by `PlayerOwnsBundleAsync()`.
|
|
27957
27972
|
*
|
|
27958
27973
|
* Returns whether the given player owns the given bundle.
|
|
27959
27974
|
*
|
|
@@ -28777,15 +28792,6 @@ interface ModerationService extends Instance {
|
|
|
28777
28792
|
* @param config
|
|
28778
28793
|
*/
|
|
28779
28794
|
CreateReviewableContentAsync(this: ModerationService, config: object): string;
|
|
28780
|
-
/**
|
|
28781
|
-
* - **ThreadSafety**: Unsafe
|
|
28782
|
-
* - **Tags**: Yields
|
|
28783
|
-
*
|
|
28784
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalCreateReviewableContentAsync)
|
|
28785
|
-
* @param this
|
|
28786
|
-
* @param config
|
|
28787
|
-
*/
|
|
28788
|
-
InternalCreateReviewableContentAsync(this: ModerationService, config: object): string;
|
|
28789
28795
|
/**
|
|
28790
28796
|
* - **ThreadSafety**: Unsafe
|
|
28791
28797
|
* - **Tags**: Yields
|
|
@@ -28795,13 +28801,6 @@ interface ModerationService extends Instance {
|
|
|
28795
28801
|
* @param config
|
|
28796
28802
|
*/
|
|
28797
28803
|
InternalRequestReviewableContentReviewAsync(this: ModerationService, config: object): void;
|
|
28798
|
-
/**
|
|
28799
|
-
* - **ThreadSafety**: Unsafe
|
|
28800
|
-
*
|
|
28801
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalProcessReviewableContentEvent)
|
|
28802
|
-
* @param event
|
|
28803
|
-
*/
|
|
28804
|
-
InternalProcessReviewableContentEvent: ((event: object) => boolean) | undefined;
|
|
28805
28804
|
}
|
|
28806
28805
|
/**
|
|
28807
28806
|
* Legacy object that contains members useful for pointer input.
|
|
@@ -34859,9 +34858,9 @@ interface Player extends Instance {
|
|
|
34859
34858
|
*/
|
|
34860
34859
|
SaveString(this: Player, key: string, value: string): void;
|
|
34861
34860
|
/**
|
|
34862
|
-
* **Deprecated:**
|
|
34861
|
+
* **Deprecated:** This method has been superseded by `GetFriendsOnline()`.
|
|
34863
34862
|
*
|
|
34864
|
-
* Returns a dictionary of online connections.
|
|
34863
|
+
* Returns a dictionary of online connections. Returns the product information of an asset using its asset ID.
|
|
34865
34864
|
*
|
|
34866
34865
|
* - **ThreadSafety**: Unsafe
|
|
34867
34866
|
* - **Tags**: Yields
|
|
@@ -34915,7 +34914,7 @@ interface Player extends Instance {
|
|
|
34915
34914
|
*/
|
|
34916
34915
|
GetRankInGroupAsync(this: Player, groupId: number): number;
|
|
34917
34916
|
/**
|
|
34918
|
-
* **Deprecated:**
|
|
34917
|
+
* **Deprecated:** This method has been superseded by `GetRoleInGroup()`.
|
|
34919
34918
|
*
|
|
34920
34919
|
* Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
|
|
34921
34920
|
*
|
|
@@ -34986,7 +34985,7 @@ interface Player extends Instance {
|
|
|
34986
34985
|
*/
|
|
34987
34986
|
IsFriendsWithAsync(this: Player, userId: number): boolean;
|
|
34988
34987
|
/**
|
|
34989
|
-
* **Deprecated:**
|
|
34988
|
+
* **Deprecated:** This method has been superseded by `IsInGroupAsync()`.
|
|
34990
34989
|
*
|
|
34991
34990
|
* Checks whether a player is a member of a group with the given ID.
|
|
34992
34991
|
*
|
|
@@ -35014,7 +35013,7 @@ interface Player extends Instance {
|
|
|
35014
35013
|
*/
|
|
35015
35014
|
IsInGroupAsync(this: Player, groupId: number): boolean;
|
|
35016
35015
|
/**
|
|
35017
|
-
* **Deprecated:**
|
|
35016
|
+
* **Deprecated:** This method has been superseded by `LoadCharacterAsync()`.
|
|
35018
35017
|
*
|
|
35019
35018
|
* Creates a new character for the player, removing the old one. Also clears the player's `Backpack` and `PlayerGui`.
|
|
35020
35019
|
*
|
|
@@ -35038,7 +35037,7 @@ interface Player extends Instance {
|
|
|
35038
35037
|
*/
|
|
35039
35038
|
LoadCharacterAsync(this: Player): void;
|
|
35040
35039
|
/**
|
|
35041
|
-
* **Deprecated:**
|
|
35040
|
+
* **Deprecated:** This method has been superseded by `LoadCharacterWithHumanoidDescriptionAsync()`.
|
|
35042
35041
|
*
|
|
35043
35042
|
* Spawns a player character with everything equipped in the passed in `HumanoidDescription`.
|
|
35044
35043
|
*
|
|
@@ -35610,7 +35609,7 @@ interface Players extends Instance {
|
|
|
35610
35609
|
*/
|
|
35611
35610
|
RespawnTime: number;
|
|
35612
35611
|
/**
|
|
35613
|
-
* Returns the `Player` with the given `UserId` if they are in-
|
|
35612
|
+
* Returns the `Player` with the given `UserId` if they are in-experience.
|
|
35614
35613
|
*
|
|
35615
35614
|
* - **ThreadSafety**: Safe
|
|
35616
35615
|
*
|
|
@@ -35656,7 +35655,7 @@ interface Players extends Instance {
|
|
|
35656
35655
|
*/
|
|
35657
35656
|
BanAsync(this: Players, config: BanAsyncConfig): void;
|
|
35658
35657
|
/**
|
|
35659
|
-
* **Deprecated:**
|
|
35658
|
+
* **Deprecated:** This method has been superseded by `CreateHumanoidModelFromDescription()`.
|
|
35660
35659
|
*
|
|
35661
35660
|
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
|
|
35662
35661
|
*
|
|
@@ -35688,7 +35687,7 @@ interface Players extends Instance {
|
|
|
35688
35687
|
*/
|
|
35689
35688
|
CreateHumanoidModelFromDescriptionAsync(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
35690
35689
|
/**
|
|
35691
|
-
* **Deprecated:**
|
|
35690
|
+
* **Deprecated:** This method has been superseded by `CreateHumanoidModelFromUserIdAsync()`.
|
|
35692
35691
|
*
|
|
35693
35692
|
* Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.
|
|
35694
35693
|
*
|
|
@@ -35766,7 +35765,7 @@ interface Players extends Instance {
|
|
|
35766
35765
|
*/
|
|
35767
35766
|
GetFriendsAsync(this: Players, userId: number): FriendPages;
|
|
35768
35767
|
/**
|
|
35769
|
-
* **Deprecated:**
|
|
35768
|
+
* **Deprecated:** This method has been superseded by `GetHumanoidDescriptionFromOutfitIdAsync()`.
|
|
35770
35769
|
*
|
|
35771
35770
|
* Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.
|
|
35772
35771
|
*
|
|
@@ -35794,7 +35793,7 @@ interface Players extends Instance {
|
|
|
35794
35793
|
*/
|
|
35795
35794
|
GetHumanoidDescriptionFromOutfitIdAsync(this: Players, outfitId: number): HumanoidDescription;
|
|
35796
35795
|
/**
|
|
35797
|
-
* **Deprecated:**
|
|
35796
|
+
* **Deprecated:** This method has been superseded by `GetHumanoidDescriptionFromUserIdAsync()`.
|
|
35798
35797
|
*
|
|
35799
35798
|
* Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
|
|
35800
35799
|
*
|
|
@@ -35881,7 +35880,7 @@ interface Players extends Instance {
|
|
|
35881
35880
|
*/
|
|
35882
35881
|
UnbanAsync(this: Players, config: UnbanAsyncConfig): void;
|
|
35883
35882
|
/**
|
|
35884
|
-
* Fires when a player enters the
|
|
35883
|
+
* Fires when a player enters the experience.
|
|
35885
35884
|
*
|
|
35886
35885
|
* - **ThreadSafety**: Unsafe
|
|
35887
35886
|
*
|
|
@@ -35889,7 +35888,7 @@ interface Players extends Instance {
|
|
|
35889
35888
|
*/
|
|
35890
35889
|
readonly PlayerAdded: RBXScriptSignal<(player: Player) => void>;
|
|
35891
35890
|
/**
|
|
35892
|
-
* Fires when the
|
|
35891
|
+
* Fires when the experience server recognizes that a player's membership has changed.
|
|
35893
35892
|
*
|
|
35894
35893
|
* - **ThreadSafety**: Unsafe
|
|
35895
35894
|
*
|
|
@@ -35897,7 +35896,7 @@ interface Players extends Instance {
|
|
|
35897
35896
|
*/
|
|
35898
35897
|
readonly PlayerMembershipChanged: RBXScriptSignal<(player: Player) => void>;
|
|
35899
35898
|
/**
|
|
35900
|
-
* Fires when a player is about to leave the
|
|
35899
|
+
* Fires when a player is about to leave the experience.
|
|
35901
35900
|
*
|
|
35902
35901
|
* - **ThreadSafety**: Unsafe
|
|
35903
35902
|
*
|
|
@@ -35905,7 +35904,7 @@ interface Players extends Instance {
|
|
|
35905
35904
|
*/
|
|
35906
35905
|
readonly PlayerRemoving: RBXScriptSignal<(player: Player, reason: Enum.PlayerExitReason) => void>;
|
|
35907
35906
|
/**
|
|
35908
|
-
* Fires when the
|
|
35907
|
+
* Fires when the experience server recognizes that the user's status for a certain subscription has changed.
|
|
35909
35908
|
*
|
|
35910
35909
|
* - **ThreadSafety**: Unsafe
|
|
35911
35910
|
*
|
|
@@ -36931,6 +36930,20 @@ interface ReflectionService extends Instance {
|
|
|
36931
36930
|
* @returns A list of `ReflectedClass` dictionaries with reflection information for each class that matches the filter criteria.
|
|
36932
36931
|
*/
|
|
36933
36932
|
GetClasses(this: ReflectionService, filter?: object): Array<unknown>;
|
|
36933
|
+
/**
|
|
36934
|
+
* - **ThreadSafety**: Unsafe
|
|
36935
|
+
* - **Tags**: CustomLuaState
|
|
36936
|
+
*
|
|
36937
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetEventsOfClass)
|
|
36938
|
+
*/
|
|
36939
|
+
GetEventsOfClass(this: ReflectionService, className: string, filter?: object): Array<unknown>;
|
|
36940
|
+
/**
|
|
36941
|
+
* - **ThreadSafety**: Unsafe
|
|
36942
|
+
* - **Tags**: CustomLuaState
|
|
36943
|
+
*
|
|
36944
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetMethodsOfClass)
|
|
36945
|
+
*/
|
|
36946
|
+
GetMethodsOfClass(this: ReflectionService, className: string, filter?: object): Array<unknown>;
|
|
36934
36947
|
/**
|
|
36935
36948
|
* Returns a list of properties for a given class with filters applied.
|
|
36936
36949
|
*
|
|
@@ -37120,7 +37133,7 @@ interface ReplicatedFirst extends Instance {
|
|
|
37120
37133
|
*/
|
|
37121
37134
|
readonly _nominal_ReplicatedFirst: unique symbol;
|
|
37122
37135
|
/**
|
|
37123
|
-
* Immediately removes the default Roblox loading screen.
|
|
37136
|
+
* Immediately removes the default Roblox loading screen.
|
|
37124
37137
|
*
|
|
37125
37138
|
* - **ThreadSafety**: Unsafe
|
|
37126
37139
|
*
|
|
@@ -43547,6 +43560,13 @@ interface TextChatService extends Instance {
|
|
|
43547
43560
|
* @returns A list of users who could participate in the direct chat request. If none of the users can direct chat with the requesterUserId, the result is an empty array.
|
|
43548
43561
|
*/
|
|
43549
43562
|
CanUsersDirectChatAsync(this: TextChatService, requesterUserId: number, userIds: Array<unknown>): Array<unknown>;
|
|
43563
|
+
/**
|
|
43564
|
+
* - **ThreadSafety**: Unsafe
|
|
43565
|
+
* - **Tags**: Yields
|
|
43566
|
+
*
|
|
43567
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatService#GetChatGroupsAsync)
|
|
43568
|
+
*/
|
|
43569
|
+
GetChatGroupsAsync(this: TextChatService, players: Array<Instance>): Array<unknown>;
|
|
43550
43570
|
/**
|
|
43551
43571
|
* Fires when `TextChatService:DisplayBubble()` is called.
|
|
43552
43572
|
*
|
|
@@ -43980,6 +44000,21 @@ interface TouchTransmitter extends Instance {
|
|
|
43980
44000
|
*/
|
|
43981
44001
|
readonly _nominal_TouchTransmitter: unique symbol;
|
|
43982
44002
|
}
|
|
44003
|
+
/**
|
|
44004
|
+
* - **Tags**: NotCreatable, Service
|
|
44005
|
+
*
|
|
44006
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TraceRouteService)
|
|
44007
|
+
*/
|
|
44008
|
+
interface TraceRouteService extends Instance {
|
|
44009
|
+
/**
|
|
44010
|
+
* **DO NOT USE!**
|
|
44011
|
+
*
|
|
44012
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
44013
|
+
* @hidden
|
|
44014
|
+
* @deprecated
|
|
44015
|
+
*/
|
|
44016
|
+
readonly _nominal_TraceRouteService: unique symbol;
|
|
44017
|
+
}
|
|
43983
44018
|
/**
|
|
43984
44019
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
43985
44020
|
*
|
|
@@ -46062,7 +46097,7 @@ interface UserInputService extends Instance {
|
|
|
46062
46097
|
CFrame
|
|
46063
46098
|
]>;
|
|
46064
46099
|
/**
|
|
46065
|
-
* Returns the
|
|
46100
|
+
* Returns the `TextBox` the client is currently focused on.
|
|
46066
46101
|
*
|
|
46067
46102
|
* - **ThreadSafety**: Unsafe
|
|
46068
46103
|
*
|
|
@@ -47875,6 +47910,13 @@ interface VoiceChatService extends Instance {
|
|
|
47875
47910
|
* @deprecated
|
|
47876
47911
|
*/
|
|
47877
47912
|
readonly _nominal_VoiceChatService: unique symbol;
|
|
47913
|
+
/**
|
|
47914
|
+
* - **ThreadSafety**: Unsafe
|
|
47915
|
+
* - **Tags**: Yields
|
|
47916
|
+
*
|
|
47917
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VoiceChatService#GetChatGroupsAsync)
|
|
47918
|
+
*/
|
|
47919
|
+
GetChatGroupsAsync(this: VoiceChatService, players: Array<Instance>): Array<unknown>;
|
|
47878
47920
|
/**
|
|
47879
47921
|
* Returns whether or not the given user has voice enabled.
|
|
47880
47922
|
*
|
|
@@ -48083,6 +48125,21 @@ interface Wire extends Instance {
|
|
|
48083
48125
|
*/
|
|
48084
48126
|
TargetName: string;
|
|
48085
48127
|
}
|
|
48128
|
+
/**
|
|
48129
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
48130
|
+
*
|
|
48131
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapDeformMeshProvider)
|
|
48132
|
+
*/
|
|
48133
|
+
interface WrapDeformMeshProvider extends Instance {
|
|
48134
|
+
/**
|
|
48135
|
+
* **DO NOT USE!**
|
|
48136
|
+
*
|
|
48137
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
48138
|
+
* @hidden
|
|
48139
|
+
* @deprecated
|
|
48140
|
+
*/
|
|
48141
|
+
readonly _nominal_WrapDeformMeshProvider: unique symbol;
|
|
48142
|
+
}
|
|
48086
48143
|
/**
|
|
48087
48144
|
* `WrapTextureTransfer` allows a parent `Decal` to be wrapped around its parent `MeshPart` based on the cage of its `WrapTarget`.
|
|
48088
48145
|
*
|