@rbxts/types 1.0.937 → 1.0.938
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 +691 -174
- package/include/generated/PluginSecurity.d.ts +164 -30
- package/include/generated/enums.d.ts +16 -0
- package/include/roblox.d.ts +1 -0
- package/include/selector.d.ts +152 -0
- package/package.json +1 -1
|
@@ -23,6 +23,8 @@ interface Services {
|
|
|
23
23
|
AssetQualityService: AssetQualityService;
|
|
24
24
|
AssetService: AssetService;
|
|
25
25
|
AudioFocusService: AudioFocusService;
|
|
26
|
+
AuroraScriptService: AuroraScriptService;
|
|
27
|
+
AuroraService: AuroraService;
|
|
26
28
|
AvatarChatService: AvatarChatService;
|
|
27
29
|
AvatarCreationService: AvatarCreationService;
|
|
28
30
|
AvatarEditorService: AvatarEditorService;
|
|
@@ -61,6 +63,7 @@ interface Services {
|
|
|
61
63
|
DebuggerUIService: DebuggerUIService;
|
|
62
64
|
DeferredAssetManagerService: DeferredAssetManagerService;
|
|
63
65
|
DesignFoundationsService: DesignFoundationsService;
|
|
66
|
+
DeviceDisplayService: DeviceDisplayService;
|
|
64
67
|
DeviceIdService: DeviceIdService;
|
|
65
68
|
DraggerService: DraggerService;
|
|
66
69
|
EditableService: EditableService;
|
|
@@ -103,6 +106,7 @@ interface Services {
|
|
|
103
106
|
InstanceFileSyncService: InstanceFileSyncService;
|
|
104
107
|
InternalMessagingService: InternalMessagingService;
|
|
105
108
|
InternalMessagingServiceVerifier: InternalMessagingServiceVerifier;
|
|
109
|
+
InternalSyncService: InternalSyncService;
|
|
106
110
|
IXPService: IXPService;
|
|
107
111
|
JointsService: JointsService;
|
|
108
112
|
KeyframeSequenceProvider: KeyframeSequenceProvider;
|
|
@@ -152,6 +156,7 @@ interface Services {
|
|
|
152
156
|
PluginManagementService: PluginManagementService;
|
|
153
157
|
PluginPolicyService: PluginPolicyService;
|
|
154
158
|
PolicyService: PolicyService;
|
|
159
|
+
PopLatencyService: PopLatencyService;
|
|
155
160
|
Preloaded: Preloaded;
|
|
156
161
|
ProceduralBehaviorSchedulerService: ProceduralBehaviorSchedulerService;
|
|
157
162
|
ProcessInstancePhysicsService: ProcessInstancePhysicsService;
|
|
@@ -306,6 +311,7 @@ interface CreatableInstances {
|
|
|
306
311
|
AudioSpeechToText: AudioSpeechToText;
|
|
307
312
|
AudioTextToSpeech: AudioTextToSpeech;
|
|
308
313
|
AudioTremolo: AudioTremolo;
|
|
314
|
+
AuroraScript: AuroraScript;
|
|
309
315
|
AvatarAbilityRules: AvatarAbilityRules;
|
|
310
316
|
AvatarAccessoryRules: AvatarAccessoryRules;
|
|
311
317
|
AvatarAnimationRules: AvatarAnimationRules;
|
|
@@ -412,6 +418,7 @@ interface CreatableInstances {
|
|
|
412
418
|
InputBinding: InputBinding;
|
|
413
419
|
InputContext: InputContext;
|
|
414
420
|
IntConstrainedValue: IntConstrainedValue;
|
|
421
|
+
InternalSyncItem: InternalSyncItem;
|
|
415
422
|
IntersectOperation: IntersectOperation;
|
|
416
423
|
IntValue: IntValue;
|
|
417
424
|
Keyframe: Keyframe;
|
|
@@ -627,6 +634,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
627
634
|
DebuggerConnection: DebuggerConnection;
|
|
628
635
|
DebuggerLuaResponse: DebuggerLuaResponse;
|
|
629
636
|
DebuggerVariable: DebuggerVariable;
|
|
637
|
+
DisplayWakeLock: DisplayWakeLock;
|
|
630
638
|
DynamicRotate: DynamicRotate;
|
|
631
639
|
ExplorerFilterAutocompleter: ExplorerFilterAutocompleter;
|
|
632
640
|
FaceInstance: FaceInstance;
|
|
@@ -2532,7 +2540,7 @@ interface Instance extends RBXObject {
|
|
|
2532
2540
|
* @param selector Selector string used to filter elements.
|
|
2533
2541
|
* @returns An array of instances (empty if nothing matched the selector).
|
|
2534
2542
|
*/
|
|
2535
|
-
QueryDescendants(this: Instance, selector:
|
|
2543
|
+
QueryDescendants<S extends string>(this: Instance, selector: Selector.ValidateSelector<S> extends S ? S : Selector.ValidateSelector<S>): string extends S ? Array<Instance> : Array<Selector.Solve<S>>;
|
|
2536
2544
|
/**
|
|
2537
2545
|
* Removes a tag from the instance.
|
|
2538
2546
|
*
|
|
@@ -2911,7 +2919,7 @@ interface AdPortal extends Instance {
|
|
|
2911
2919
|
readonly Status: Enum.AdUnitStatus;
|
|
2912
2920
|
}
|
|
2913
2921
|
/**
|
|
2914
|
-
*
|
|
2922
|
+
* The service responsible for in-experience advertising.
|
|
2915
2923
|
*
|
|
2916
2924
|
* - **Tags**: NotCreatable, Service
|
|
2917
2925
|
*
|
|
@@ -2927,22 +2935,24 @@ interface AdService extends Instance {
|
|
|
2927
2935
|
*/
|
|
2928
2936
|
readonly _nominal_AdService: unique symbol;
|
|
2929
2937
|
/**
|
|
2930
|
-
* Creates
|
|
2938
|
+
* Creates an `AdReward` to give users who watch a video ad.
|
|
2931
2939
|
*
|
|
2932
2940
|
* - **ThreadSafety**: Unsafe
|
|
2933
2941
|
*
|
|
2934
2942
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#CreateAdRewardFromDevProductId)
|
|
2935
|
-
* @param this
|
|
2943
|
+
* @param this The service responsible for in-experience advertising.
|
|
2936
2944
|
* @param devProductId The ID of the developer product you want to grant as a reward.
|
|
2937
2945
|
*/
|
|
2938
2946
|
CreateAdRewardFromDevProductId(this: AdService, devProductId: number): AdReward;
|
|
2939
2947
|
/**
|
|
2948
|
+
* Registers an ad disclosure button for an [ad integration](../../../production/promotion/ad-integrations.md).
|
|
2949
|
+
*
|
|
2940
2950
|
* - **ThreadSafety**: Unsafe
|
|
2941
2951
|
*
|
|
2942
2952
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterDisclosureButton)
|
|
2943
|
-
* @param this
|
|
2944
|
-
* @param disclosureButton The `GuiButton` you want to mark as an ad disclosure.
|
|
2945
|
-
* @param adIntegrationPlacementId The
|
|
2953
|
+
* @param this The service responsible for in-experience advertising.
|
|
2954
|
+
* @param disclosureButton The `GuiButton` you want to mark as an ad integration disclosure. The `GuiButton` must follow labeling guidelines outlined [here](../../../production/promotion/ad-integrations.md#labeling-and-disclosure).
|
|
2955
|
+
* @param adIntegrationPlacementId The ID of the placement that this disclosure is attached to.
|
|
2946
2956
|
*/
|
|
2947
2957
|
RegisterDisclosureButton(this: AdService, disclosureButton: GuiButton, adIntegrationPlacementId: string): void;
|
|
2948
2958
|
/**
|
|
@@ -2954,7 +2964,7 @@ interface AdService extends Instance {
|
|
|
2954
2964
|
* - **Tags**:
|
|
2955
2965
|
*
|
|
2956
2966
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#ShowVideoAd)
|
|
2957
|
-
* @param this
|
|
2967
|
+
* @param this The service responsible for in-experience advertising.
|
|
2958
2968
|
*
|
|
2959
2969
|
* @deprecated
|
|
2960
2970
|
*/
|
|
@@ -2963,30 +2973,32 @@ interface AdService extends Instance {
|
|
|
2963
2973
|
* - **ThreadSafety**: Unsafe
|
|
2964
2974
|
*
|
|
2965
2975
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#UnregisterAdOpportunity)
|
|
2966
|
-
* @param this
|
|
2976
|
+
* @param this The service responsible for in-experience advertising.
|
|
2967
2977
|
* @param instance
|
|
2968
2978
|
*/
|
|
2969
2979
|
UnregisterAdOpportunity(this: AdService, instance: Instance): void;
|
|
2970
2980
|
/**
|
|
2971
|
-
* Checks if
|
|
2981
|
+
* Checks if an ad with the specified format is available to be shown to the `LocalPlayer`.
|
|
2972
2982
|
*
|
|
2973
2983
|
* - **ThreadSafety**: Unsafe
|
|
2974
2984
|
* - **Tags**: Yields
|
|
2975
2985
|
*
|
|
2976
2986
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#GetAdAvailabilityNowAsync)
|
|
2977
|
-
* @param this
|
|
2978
|
-
* @param adFormat The format of the requested ad. For example, `RewardedVideo`.
|
|
2979
|
-
* @returns A dictionary
|
|
2987
|
+
* @param this The service responsible for in-experience advertising.
|
|
2988
|
+
* @param adFormat The format of the requested ad. For example, `AdFormat.RewardedVideo`.
|
|
2989
|
+
* @returns A dictionary that looks like `{ AdAvailabilityResult: Enum.AdAvailabilityResult }`.
|
|
2980
2990
|
*/
|
|
2981
2991
|
GetAdAvailabilityNowAsync(this: AdService, adFormat: CastsToEnum<Enum.AdFormat>): object;
|
|
2982
2992
|
/**
|
|
2993
|
+
* Checks a `Player`'s eligibility to be shown an [ad integration](../../../production/promotion/ad-integrations.md) campaign.
|
|
2994
|
+
*
|
|
2983
2995
|
* - **ThreadSafety**: Unsafe
|
|
2984
2996
|
* - **Tags**: Yields
|
|
2985
2997
|
*
|
|
2986
2998
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#GetCampaignEligibilityAsync)
|
|
2987
|
-
* @param this
|
|
2988
|
-
* @param campaignId The
|
|
2989
|
-
* @param player The `Player` you want to check eligibility for. If omitted, it will default to `LocalPlayer`.
|
|
2999
|
+
* @param this The service responsible for in-experience advertising.
|
|
3000
|
+
* @param campaignId The ID of the campaign that you want to check a `Player`'s eligibility for.
|
|
3001
|
+
* @param player The `Player` you want to check eligibility for. If omitted, it will default to the `LocalPlayer`. On the server, `player` argument is required.
|
|
2990
3002
|
* @returns A dictionary that looks like `{ IsEligible: boolean }`.
|
|
2991
3003
|
*/
|
|
2992
3004
|
GetCampaignEligibilityAsync(this: AdService, campaignId: string, player?: Player): object;
|
|
@@ -2997,7 +3009,7 @@ interface AdService extends Instance {
|
|
|
2997
3009
|
* - **Tags**: Yields
|
|
2998
3010
|
*
|
|
2999
3011
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterAdOpportunityAsync)
|
|
3000
|
-
* @param this
|
|
3012
|
+
* @param this The service responsible for in-experience advertising.
|
|
3001
3013
|
* @param instance
|
|
3002
3014
|
* @param placementId The ID of the placement of the rewarded video ad inside the experience. Allows for reporting on the performance of individual ad placements.
|
|
3003
3015
|
*/
|
|
@@ -3009,10 +3021,11 @@ interface AdService extends Instance {
|
|
|
3009
3021
|
* - **Tags**: Yields
|
|
3010
3022
|
*
|
|
3011
3023
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#ShowRewardedVideoAdAsync)
|
|
3012
|
-
* @param this
|
|
3013
|
-
* @param player The `Player`
|
|
3014
|
-
* @param reward The
|
|
3024
|
+
* @param this The service responsible for in-experience advertising.
|
|
3025
|
+
* @param player The `Player` to trigger a rewarded video ad play for.
|
|
3026
|
+
* @param reward The `AdReward` to grant the user after they view the ad.
|
|
3015
3027
|
* @param placementId The ID of the placement of the rewarded video ad inside the experience. Allows for reporting on the performance of individual ad placements.
|
|
3028
|
+
* @returns The `ShowAdResult` of the client's ad presentation. You should not use this result to grant the reward. Instead, you should grant the reward from your `ProcessReceipt` implementation. For [developer products](../../../production/monetization/developer-products.md) earned through rewarded video ads, the `ProductPurchaseChannel` will be `ProductPurchaseChannel.AdReward`.
|
|
3016
3029
|
*/
|
|
3017
3030
|
ShowRewardedVideoAdAsync(this: AdService, player: Player, reward: AdReward, placementId?: number): Enum.ShowAdResult;
|
|
3018
3031
|
/**
|
|
@@ -3492,7 +3505,7 @@ interface AnimationClipProvider extends Instance {
|
|
|
3492
3505
|
* @param userId The user ID of the user.
|
|
3493
3506
|
* @returns An `InventoryPages` of animations.
|
|
3494
3507
|
*
|
|
3495
|
-
* @deprecated
|
|
3508
|
+
* @deprecated GetAnimationsAsync
|
|
3496
3509
|
*/
|
|
3497
3510
|
GetAnimations(this: AnimationClipProvider, userId: User): Instance | undefined;
|
|
3498
3511
|
/**
|
|
@@ -4479,7 +4492,7 @@ interface AssetService extends Instance {
|
|
|
4479
4492
|
* @param packageAssetId
|
|
4480
4493
|
* @returns Asset IDs that are contained in a specified package.
|
|
4481
4494
|
*
|
|
4482
|
-
* @deprecated
|
|
4495
|
+
* @deprecated GetAssetIdsForPackageAsync
|
|
4483
4496
|
*/
|
|
4484
4497
|
GetAssetIdsForPackage(this: AssetService, packageAssetId: number): Array<number>;
|
|
4485
4498
|
/**
|
|
@@ -4545,7 +4558,7 @@ interface AssetService extends Instance {
|
|
|
4545
4558
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4546
4559
|
* @param creationID
|
|
4547
4560
|
*
|
|
4548
|
-
* @deprecated
|
|
4561
|
+
* @deprecated GetProductInfo
|
|
4549
4562
|
*/
|
|
4550
4563
|
GetCreatorAssetID(this: AssetService, creationID: number): number;
|
|
4551
4564
|
/**
|
|
@@ -4620,7 +4633,7 @@ interface AssetService extends Instance {
|
|
|
4620
4633
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4621
4634
|
* @param searchParameters
|
|
4622
4635
|
*
|
|
4623
|
-
* @deprecated
|
|
4636
|
+
* @deprecated SearchAudioAsync
|
|
4624
4637
|
*/
|
|
4625
4638
|
SearchAudio(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
|
|
4626
4639
|
/**
|
|
@@ -4757,7 +4770,7 @@ interface Attachment extends Instance {
|
|
|
4757
4770
|
*
|
|
4758
4771
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#Rotation)
|
|
4759
4772
|
*
|
|
4760
|
-
* @deprecated
|
|
4773
|
+
* @deprecated Orientation
|
|
4761
4774
|
*/
|
|
4762
4775
|
Rotation: Vector3;
|
|
4763
4776
|
/**
|
|
@@ -4823,7 +4836,7 @@ interface Attachment extends Instance {
|
|
|
4823
4836
|
*
|
|
4824
4837
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#WorldRotation)
|
|
4825
4838
|
*
|
|
4826
|
-
* @deprecated
|
|
4839
|
+
* @deprecated WorldOrientation
|
|
4827
4840
|
*/
|
|
4828
4841
|
readonly WorldRotation: Vector3;
|
|
4829
4842
|
/**
|
|
@@ -4846,7 +4859,7 @@ interface Attachment extends Instance {
|
|
|
4846
4859
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetAxis)
|
|
4847
4860
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4848
4861
|
*
|
|
4849
|
-
* @deprecated
|
|
4862
|
+
* @deprecated Axis
|
|
4850
4863
|
*/
|
|
4851
4864
|
GetAxis(this: Attachment): Vector3;
|
|
4852
4865
|
/**
|
|
@@ -4869,7 +4882,7 @@ interface Attachment extends Instance {
|
|
|
4869
4882
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetSecondaryAxis)
|
|
4870
4883
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4871
4884
|
*
|
|
4872
|
-
* @deprecated
|
|
4885
|
+
* @deprecated SecondaryAxis
|
|
4873
4886
|
*/
|
|
4874
4887
|
GetSecondaryAxis(this: Attachment): Vector3;
|
|
4875
4888
|
/**
|
|
@@ -4884,7 +4897,7 @@ interface Attachment extends Instance {
|
|
|
4884
4897
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4885
4898
|
* @param axis
|
|
4886
4899
|
*
|
|
4887
|
-
* @deprecated
|
|
4900
|
+
* @deprecated Axis
|
|
4888
4901
|
*/
|
|
4889
4902
|
SetAxis(this: Attachment, axis: Vector3): void;
|
|
4890
4903
|
/**
|
|
@@ -4899,7 +4912,7 @@ interface Attachment extends Instance {
|
|
|
4899
4912
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4900
4913
|
* @param axis
|
|
4901
4914
|
*
|
|
4902
|
-
* @deprecated
|
|
4915
|
+
* @deprecated SecondaryAxis
|
|
4903
4916
|
*/
|
|
4904
4917
|
SetSecondaryAxis(this: Attachment, axis: Vector3): void;
|
|
4905
4918
|
}
|
|
@@ -5777,7 +5790,7 @@ interface AudioEmitter extends Instance {
|
|
|
5777
5790
|
*
|
|
5778
5791
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#SimulationFidelity)
|
|
5779
5792
|
*
|
|
5780
|
-
* @deprecated
|
|
5793
|
+
* @deprecated AcousticSimulationEnabled
|
|
5781
5794
|
*/
|
|
5782
5795
|
SimulationFidelity: Enum.AudioSimulationFidelity;
|
|
5783
5796
|
/**
|
|
@@ -6490,7 +6503,7 @@ interface AudioListener extends Instance {
|
|
|
6490
6503
|
*
|
|
6491
6504
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#SimulationFidelity)
|
|
6492
6505
|
*
|
|
6493
|
-
* @deprecated
|
|
6506
|
+
* @deprecated AcousticSimulationEnabled
|
|
6494
6507
|
*/
|
|
6495
6508
|
SimulationFidelity: Enum.AudioSimulationFidelity;
|
|
6496
6509
|
/**
|
|
@@ -6705,7 +6718,7 @@ interface AudioPlayer extends Instance {
|
|
|
6705
6718
|
*
|
|
6706
6719
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AssetId)
|
|
6707
6720
|
*
|
|
6708
|
-
* @deprecated
|
|
6721
|
+
* @deprecated Asset
|
|
6709
6722
|
*/
|
|
6710
6723
|
AssetId: string;
|
|
6711
6724
|
/**
|
|
@@ -7250,7 +7263,7 @@ interface AudioSearchParams extends Instance {
|
|
|
7250
7263
|
*
|
|
7251
7264
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#AudioSubtype)
|
|
7252
7265
|
*
|
|
7253
|
-
* @deprecated
|
|
7266
|
+
* @deprecated AudioSubType
|
|
7254
7267
|
*/
|
|
7255
7268
|
AudioSubtype: Enum.AudioSubType;
|
|
7256
7269
|
/**
|
|
@@ -7688,6 +7701,216 @@ interface AuroraScriptObject extends Instance {
|
|
|
7688
7701
|
*/
|
|
7689
7702
|
PriorFrameInvoked: number;
|
|
7690
7703
|
}
|
|
7704
|
+
/**
|
|
7705
|
+
* - **Tags**: NotCreatable, Service
|
|
7706
|
+
*
|
|
7707
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService)
|
|
7708
|
+
*
|
|
7709
|
+
* @deprecated
|
|
7710
|
+
*/
|
|
7711
|
+
interface AuroraScriptService extends Instance {
|
|
7712
|
+
/**
|
|
7713
|
+
* **DO NOT USE!**
|
|
7714
|
+
*
|
|
7715
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
7716
|
+
* @hidden
|
|
7717
|
+
* @deprecated
|
|
7718
|
+
*/
|
|
7719
|
+
readonly _nominal_AuroraScriptService: unique symbol;
|
|
7720
|
+
/**
|
|
7721
|
+
* - **ThreadSafety**: Unsafe
|
|
7722
|
+
*
|
|
7723
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#CreateCollection)
|
|
7724
|
+
*/
|
|
7725
|
+
CreateCollection(this: AuroraScriptService, query: string, root?: Instance): CollectionHandle;
|
|
7726
|
+
/**
|
|
7727
|
+
* - **ThreadSafety**: Safe
|
|
7728
|
+
* - **Tags**: CustomLuaState
|
|
7729
|
+
*
|
|
7730
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBinding)
|
|
7731
|
+
*/
|
|
7732
|
+
FindBinding(this: AuroraScriptService, instance: Instance, scriptName: string): RBXObject;
|
|
7733
|
+
/**
|
|
7734
|
+
* - **ThreadSafety**: Safe
|
|
7735
|
+
* - **Tags**: CustomLuaState
|
|
7736
|
+
*
|
|
7737
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBindings)
|
|
7738
|
+
*/
|
|
7739
|
+
FindBindings(this: AuroraScriptService, instance: Instance): object;
|
|
7740
|
+
/**
|
|
7741
|
+
* - **ThreadSafety**: Unsafe
|
|
7742
|
+
*
|
|
7743
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#GetAllCollections)
|
|
7744
|
+
*/
|
|
7745
|
+
GetAllCollections(this: AuroraScriptService): Array<unknown>;
|
|
7746
|
+
/**
|
|
7747
|
+
* - **ThreadSafety**: Safe
|
|
7748
|
+
*
|
|
7749
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#GetLocalFrameId)
|
|
7750
|
+
*/
|
|
7751
|
+
GetLocalFrameId(this: AuroraScriptService): number;
|
|
7752
|
+
/**
|
|
7753
|
+
* - **ThreadSafety**: Safe
|
|
7754
|
+
*
|
|
7755
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#SendMessage)
|
|
7756
|
+
*/
|
|
7757
|
+
SendMessage(this: AuroraScriptService, instance: Instance, behaviorName: string, functionName: string, args: unknown): void;
|
|
7758
|
+
/**
|
|
7759
|
+
* - **ThreadSafety**: Unsafe
|
|
7760
|
+
*
|
|
7761
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getBehaviors)
|
|
7762
|
+
*/
|
|
7763
|
+
getBehaviors(this: AuroraScriptService): Array<Instance>;
|
|
7764
|
+
/**
|
|
7765
|
+
* - **ThreadSafety**: Unsafe
|
|
7766
|
+
*
|
|
7767
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getBehaviorsForInstance)
|
|
7768
|
+
*/
|
|
7769
|
+
getBehaviorsForInstance(this: AuroraScriptService, instance: Instance): Array<Instance>;
|
|
7770
|
+
/**
|
|
7771
|
+
* - **ThreadSafety**: Unsafe
|
|
7772
|
+
*
|
|
7773
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getInstancesForBehavior)
|
|
7774
|
+
*/
|
|
7775
|
+
getInstancesForBehavior(this: AuroraScriptService, behavior: AuroraScript): Array<Instance>;
|
|
7776
|
+
}
|
|
7777
|
+
/**
|
|
7778
|
+
* - **Tags**: NotCreatable, Service
|
|
7779
|
+
*
|
|
7780
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService)
|
|
7781
|
+
*
|
|
7782
|
+
* @deprecated
|
|
7783
|
+
*/
|
|
7784
|
+
interface AuroraService extends Instance {
|
|
7785
|
+
/**
|
|
7786
|
+
* **DO NOT USE!**
|
|
7787
|
+
*
|
|
7788
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
7789
|
+
* @hidden
|
|
7790
|
+
* @deprecated
|
|
7791
|
+
*/
|
|
7792
|
+
readonly _nominal_AuroraService: unique symbol;
|
|
7793
|
+
/**
|
|
7794
|
+
* - **ThreadSafety**: ReadSafe
|
|
7795
|
+
*
|
|
7796
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#HashRoundingPoint)
|
|
7797
|
+
*/
|
|
7798
|
+
HashRoundingPoint: number;
|
|
7799
|
+
/**
|
|
7800
|
+
* - **ThreadSafety**: ReadSafe
|
|
7801
|
+
*
|
|
7802
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IgnoreRotation)
|
|
7803
|
+
*/
|
|
7804
|
+
IgnoreRotation: boolean;
|
|
7805
|
+
/**
|
|
7806
|
+
* - **ThreadSafety**: ReadSafe
|
|
7807
|
+
*
|
|
7808
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#LockStepIdOffset)
|
|
7809
|
+
*/
|
|
7810
|
+
LockStepIdOffset: boolean;
|
|
7811
|
+
/**
|
|
7812
|
+
* - **ThreadSafety**: ReadSafe
|
|
7813
|
+
*
|
|
7814
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#RollbackOffset)
|
|
7815
|
+
*/
|
|
7816
|
+
RollbackOffset: number;
|
|
7817
|
+
/**
|
|
7818
|
+
* - **ThreadSafety**: Unsafe
|
|
7819
|
+
*
|
|
7820
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetPredictedInstances)
|
|
7821
|
+
*/
|
|
7822
|
+
GetPredictedInstances(this: AuroraService): Array<unknown>;
|
|
7823
|
+
/**
|
|
7824
|
+
* - **ThreadSafety**: Unsafe
|
|
7825
|
+
*
|
|
7826
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetRemoteWorldStepId)
|
|
7827
|
+
*/
|
|
7828
|
+
GetRemoteWorldStepId(this: AuroraService): number;
|
|
7829
|
+
/**
|
|
7830
|
+
* - **ThreadSafety**: Unsafe
|
|
7831
|
+
*
|
|
7832
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetServerView)
|
|
7833
|
+
*/
|
|
7834
|
+
GetServerView(this: AuroraService, target: Instance): Instance | undefined;
|
|
7835
|
+
/**
|
|
7836
|
+
* - **ThreadSafety**: Unsafe
|
|
7837
|
+
*
|
|
7838
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetWorldStepId)
|
|
7839
|
+
*/
|
|
7840
|
+
GetWorldStepId(this: AuroraService): number;
|
|
7841
|
+
/**
|
|
7842
|
+
* - **ThreadSafety**: Unsafe
|
|
7843
|
+
*
|
|
7844
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsInstancePredicted)
|
|
7845
|
+
*/
|
|
7846
|
+
IsInstancePredicted(this: AuroraService, target: Instance): boolean;
|
|
7847
|
+
/**
|
|
7848
|
+
* - **ThreadSafety**: Unsafe
|
|
7849
|
+
*
|
|
7850
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#PlayInputRecording)
|
|
7851
|
+
*/
|
|
7852
|
+
PlayInputRecording(this: AuroraService): void;
|
|
7853
|
+
/**
|
|
7854
|
+
* - **ThreadSafety**: Unsafe
|
|
7855
|
+
*
|
|
7856
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#SetReplicationLag)
|
|
7857
|
+
*/
|
|
7858
|
+
SetReplicationLag(this: AuroraService, seconds: number): void;
|
|
7859
|
+
/**
|
|
7860
|
+
* - **ThreadSafety**: Unsafe
|
|
7861
|
+
*
|
|
7862
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#ShowDebugVisualizer)
|
|
7863
|
+
*/
|
|
7864
|
+
ShowDebugVisualizer(this: AuroraService, state: boolean): void;
|
|
7865
|
+
/**
|
|
7866
|
+
* - **ThreadSafety**: Unsafe
|
|
7867
|
+
*
|
|
7868
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StartInputRecording)
|
|
7869
|
+
*/
|
|
7870
|
+
StartInputRecording(this: AuroraService): void;
|
|
7871
|
+
/**
|
|
7872
|
+
* - **ThreadSafety**: Unsafe
|
|
7873
|
+
*
|
|
7874
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StartPrediction)
|
|
7875
|
+
*/
|
|
7876
|
+
StartPrediction(this: AuroraService, target: Instance): void;
|
|
7877
|
+
/**
|
|
7878
|
+
* - **ThreadSafety**: Unsafe
|
|
7879
|
+
*
|
|
7880
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StepPhysics)
|
|
7881
|
+
*/
|
|
7882
|
+
StepPhysics(this: AuroraService, worldSteps: number, parts?: Array<Instance>): void;
|
|
7883
|
+
/**
|
|
7884
|
+
* - **ThreadSafety**: Unsafe
|
|
7885
|
+
*
|
|
7886
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StopInputRecording)
|
|
7887
|
+
*/
|
|
7888
|
+
StopInputRecording(this: AuroraService): void;
|
|
7889
|
+
/**
|
|
7890
|
+
* - **ThreadSafety**: Unsafe
|
|
7891
|
+
*
|
|
7892
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StopPrediction)
|
|
7893
|
+
*/
|
|
7894
|
+
StopPrediction(this: AuroraService, target: Instance): void;
|
|
7895
|
+
/**
|
|
7896
|
+
* - **ThreadSafety**: Unsafe
|
|
7897
|
+
*
|
|
7898
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#UpdateProperties)
|
|
7899
|
+
*/
|
|
7900
|
+
UpdateProperties(this: AuroraService, target: Instance): void;
|
|
7901
|
+
/**
|
|
7902
|
+
* - **ThreadSafety**: Unsafe
|
|
7903
|
+
*
|
|
7904
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#FixedRateTick)
|
|
7905
|
+
*/
|
|
7906
|
+
readonly FixedRateTick: RBXScriptSignal<(deltaTime: number, worldStepId: number) => void>;
|
|
7907
|
+
/**
|
|
7908
|
+
* - **ThreadSafety**: Unsafe
|
|
7909
|
+
*
|
|
7910
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Step)
|
|
7911
|
+
*/
|
|
7912
|
+
readonly Step: RBXScriptSignal<() => void>;
|
|
7913
|
+
}
|
|
7691
7914
|
/**
|
|
7692
7915
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarAbilityRules)
|
|
7693
7916
|
*/
|
|
@@ -8127,7 +8350,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8127
8350
|
* @param humanoidDescription The HumanoidDescription to check if default clothing is required.
|
|
8128
8351
|
* @returns Returns a HumanoidDescription if default clothing was necessary. Otherwise returns `nil`.
|
|
8129
8352
|
*
|
|
8130
|
-
* @deprecated
|
|
8353
|
+
* @deprecated CheckApplyDefaultClothingAsync
|
|
8131
8354
|
*/
|
|
8132
8355
|
CheckApplyDefaultClothing(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription | undefined;
|
|
8133
8356
|
/**
|
|
@@ -8152,7 +8375,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8152
8375
|
* @param this A service to support developer Avatar Editors.
|
|
8153
8376
|
* @param humanoidDescription
|
|
8154
8377
|
*
|
|
8155
|
-
* @deprecated
|
|
8378
|
+
* @deprecated ConformToAvatarRulesAsync
|
|
8156
8379
|
*/
|
|
8157
8380
|
ConformToAvatarRules(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
|
|
8158
8381
|
/**
|
|
@@ -8179,7 +8402,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8179
8402
|
* @param this A service to support developer Avatar Editors.
|
|
8180
8403
|
* @returns A dictionary containing the platform Avatar rules for things like scaling, default shirts and pants, number of wearable assets, ect. See the example return in the main description above.
|
|
8181
8404
|
*
|
|
8182
|
-
* @deprecated
|
|
8405
|
+
* @deprecated GetAvatarRulesAsync
|
|
8183
8406
|
*/
|
|
8184
8407
|
GetAvatarRules(this: AvatarEditorService): AvatarRules;
|
|
8185
8408
|
/**
|
|
@@ -8207,7 +8430,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8207
8430
|
* @param itemType The type of the item ids provided.
|
|
8208
8431
|
* @returns Returns an array of item details. See `AvatarEditorService:GetBatchItemDetailsAsync()` for the response format.
|
|
8209
8432
|
*
|
|
8210
|
-
* @deprecated
|
|
8433
|
+
* @deprecated GetBatchItemDetailsAsync
|
|
8211
8434
|
*/
|
|
8212
8435
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): ReadonlyArray<AssetItemDetails>;
|
|
8213
8436
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): ReadonlyArray<BundleItemDetails>;
|
|
@@ -8226,10 +8449,16 @@ interface AvatarEditorService extends Instance {
|
|
|
8226
8449
|
*/
|
|
8227
8450
|
GetBatchItemDetailsAsync(this: AvatarEditorService, itemIds: Array<unknown>, itemType: CastsToEnum<Enum.AvatarItemType>): Array<unknown>;
|
|
8228
8451
|
/**
|
|
8452
|
+
* Returns a `CatalogPages` object containing bundles that include the given asset.
|
|
8453
|
+
*
|
|
8229
8454
|
* - **ThreadSafety**: Unsafe
|
|
8230
8455
|
* - **Tags**: Yields
|
|
8231
8456
|
*
|
|
8232
8457
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetBundlesByAssetIdAsync)
|
|
8458
|
+
* @param this A service to support developer Avatar Editors.
|
|
8459
|
+
* @param assetId The ID of the asset to find bundles for.
|
|
8460
|
+
* @param limit The number of results per page. Accepts `10`, `25`, `50`, and `100`.
|
|
8461
|
+
* @returns A `CatalogPages` object containing bundles that include the given asset.
|
|
8233
8462
|
*/
|
|
8234
8463
|
GetBundlesByAssetIdAsync(this: AvatarEditorService, assetId: number, limit?: number): CatalogPages;
|
|
8235
8464
|
/**
|
|
@@ -8246,7 +8475,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8246
8475
|
* @param itemType The `AvatarItemType` of the specified asset or bundle.
|
|
8247
8476
|
* @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
|
|
8248
8477
|
*
|
|
8249
|
-
* @deprecated
|
|
8478
|
+
* @deprecated GetFavoriteAsync
|
|
8250
8479
|
*/
|
|
8251
8480
|
GetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
|
|
8252
8481
|
/**
|
|
@@ -8285,7 +8514,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8285
8514
|
* @param this A service to support developer Avatar Editors.
|
|
8286
8515
|
* @param assetTypes The `AvatarAssetType` that can will be checked for in the player's inventory.
|
|
8287
8516
|
*
|
|
8288
|
-
* @deprecated
|
|
8517
|
+
* @deprecated GetInventoryAsync
|
|
8289
8518
|
*/
|
|
8290
8519
|
GetInventory(this: AvatarEditorService, assetTypes: ReadonlyArray<Enum.AvatarAssetType>): InventoryPages<{
|
|
8291
8520
|
AssetId: number;
|
|
@@ -8318,7 +8547,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8318
8547
|
* @param itemType An enum value indicating the type of item whose details are being retrieved.
|
|
8319
8548
|
* @returns A table containing the item info for the retrieved item. See above for a sample table.
|
|
8320
8549
|
*
|
|
8321
|
-
* @deprecated
|
|
8550
|
+
* @deprecated GetItemDetailsAsync
|
|
8322
8551
|
*/
|
|
8323
8552
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): AssetItemDetails;
|
|
8324
8553
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): BundleItemDetails;
|
|
@@ -8349,7 +8578,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8349
8578
|
* @param outfitId The ID of the outfit whose details are being retrieved.
|
|
8350
8579
|
* @returns A table containing the outfit info for the retrieved outfit. See above for a sample table.
|
|
8351
8580
|
*
|
|
8352
|
-
* @deprecated
|
|
8581
|
+
* @deprecated GetOutfitDetailsAsync
|
|
8353
8582
|
*/
|
|
8354
8583
|
GetOutfitDetails(this: AvatarEditorService, outfitId: number): object;
|
|
8355
8584
|
/**
|
|
@@ -8377,7 +8606,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8377
8606
|
* @param outfitSource
|
|
8378
8607
|
* @param outfitType
|
|
8379
8608
|
*
|
|
8380
|
-
* @deprecated
|
|
8609
|
+
* @deprecated GetOutfitsAsync
|
|
8381
8610
|
*/
|
|
8382
8611
|
GetOutfits(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
|
|
8383
8612
|
/**
|
|
@@ -8406,7 +8635,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8406
8635
|
* @param contextAssetId The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.
|
|
8407
8636
|
* @returns A list of recommendations based on the given `AssetType`.
|
|
8408
8637
|
*
|
|
8409
|
-
* @deprecated
|
|
8638
|
+
* @deprecated GetRecommendedAssetsAsync
|
|
8410
8639
|
*/
|
|
8411
8640
|
GetRecommendedAssets(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): ReadonlyArray<RecommendedAsset>;
|
|
8412
8641
|
/**
|
|
@@ -8435,7 +8664,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8435
8664
|
* @param bundleId A list of recommended bundles.
|
|
8436
8665
|
* @returns The bundle ID that the recommended bundles will be returned for.
|
|
8437
8666
|
*
|
|
8438
|
-
* @deprecated
|
|
8667
|
+
* @deprecated GetRecommendedBundlesAsync
|
|
8439
8668
|
*/
|
|
8440
8669
|
GetRecommendedBundles(this: AvatarEditorService, bundleId: number): ReadonlyArray<RecommendedBundle>;
|
|
8441
8670
|
/**
|
|
@@ -8462,7 +8691,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8462
8691
|
* @param this A service to support developer Avatar Editors.
|
|
8463
8692
|
* @param searchParameters An object containing the parameters used for the search.
|
|
8464
8693
|
*
|
|
8465
|
-
* @deprecated
|
|
8694
|
+
* @deprecated SearchCatalogAsync
|
|
8466
8695
|
*/
|
|
8467
8696
|
SearchCatalog(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
|
|
8468
8697
|
/**
|
|
@@ -8622,7 +8851,7 @@ interface BadgeService extends Instance {
|
|
|
8622
8851
|
* @param badgeId The ID of the badge to be awarded.
|
|
8623
8852
|
* @returns Boolean of `true` if the badge was awarded successfully.
|
|
8624
8853
|
*
|
|
8625
|
-
* @deprecated
|
|
8854
|
+
* @deprecated AwardBadgeAsync
|
|
8626
8855
|
*/
|
|
8627
8856
|
AwardBadge(this: BadgeService, userId: number, badgeId: number): boolean;
|
|
8628
8857
|
/**
|
|
@@ -10181,7 +10410,7 @@ interface BodyMover extends Instance {
|
|
|
10181
10410
|
*
|
|
10182
10411
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyAngularVelocity)
|
|
10183
10412
|
*
|
|
10184
|
-
* @deprecated
|
|
10413
|
+
* @deprecated AngularVelocity
|
|
10185
10414
|
*/
|
|
10186
10415
|
interface BodyAngularVelocity extends BodyMover {
|
|
10187
10416
|
/**
|
|
@@ -10226,7 +10455,7 @@ interface BodyAngularVelocity extends BodyMover {
|
|
|
10226
10455
|
*
|
|
10227
10456
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyForce)
|
|
10228
10457
|
*
|
|
10229
|
-
* @deprecated
|
|
10458
|
+
* @deprecated VectorForce
|
|
10230
10459
|
*/
|
|
10231
10460
|
interface BodyForce extends BodyMover {
|
|
10232
10461
|
/**
|
|
@@ -10255,7 +10484,7 @@ interface BodyForce extends BodyMover {
|
|
|
10255
10484
|
*
|
|
10256
10485
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyGyro)
|
|
10257
10486
|
*
|
|
10258
|
-
* @deprecated
|
|
10487
|
+
* @deprecated AlignOrientation
|
|
10259
10488
|
*/
|
|
10260
10489
|
interface BodyGyro extends BodyMover {
|
|
10261
10490
|
/**
|
|
@@ -10308,7 +10537,7 @@ interface BodyGyro extends BodyMover {
|
|
|
10308
10537
|
*
|
|
10309
10538
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyPosition)
|
|
10310
10539
|
*
|
|
10311
|
-
* @deprecated
|
|
10540
|
+
* @deprecated AlignPosition
|
|
10312
10541
|
*/
|
|
10313
10542
|
interface BodyPosition extends BodyMover {
|
|
10314
10543
|
/**
|
|
@@ -10380,7 +10609,7 @@ interface BodyPosition extends BodyMover {
|
|
|
10380
10609
|
*
|
|
10381
10610
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyThrust)
|
|
10382
10611
|
*
|
|
10383
|
-
* @deprecated
|
|
10612
|
+
* @deprecated VectorForce
|
|
10384
10613
|
*/
|
|
10385
10614
|
interface BodyThrust extends BodyMover {
|
|
10386
10615
|
/**
|
|
@@ -10417,7 +10646,7 @@ interface BodyThrust extends BodyMover {
|
|
|
10417
10646
|
*
|
|
10418
10647
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyVelocity)
|
|
10419
10648
|
*
|
|
10420
|
-
* @deprecated
|
|
10649
|
+
* @deprecated LinearVelocity
|
|
10421
10650
|
*/
|
|
10422
10651
|
interface BodyVelocity extends BodyMover {
|
|
10423
10652
|
/**
|
|
@@ -10484,7 +10713,7 @@ interface BodyVelocity extends BodyMover {
|
|
|
10484
10713
|
*
|
|
10485
10714
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion)
|
|
10486
10715
|
*
|
|
10487
|
-
* @deprecated
|
|
10716
|
+
* @deprecated LineForce
|
|
10488
10717
|
*/
|
|
10489
10718
|
interface RocketPropulsion extends BodyMover {
|
|
10490
10719
|
/**
|
|
@@ -10936,7 +11165,7 @@ interface CaptureService extends Instance {
|
|
|
10936
11165
|
*
|
|
10937
11166
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureSaved)
|
|
10938
11167
|
*
|
|
10939
|
-
* @deprecated
|
|
11168
|
+
* @deprecated UserCaptureSaved
|
|
10940
11169
|
*/
|
|
10941
11170
|
readonly CaptureSaved: RBXScriptSignal<(captureInfo: Record<string, unknown>) => void>;
|
|
10942
11171
|
/**
|
|
@@ -11416,7 +11645,7 @@ interface Chat extends Instance {
|
|
|
11416
11645
|
* @param playerToFilterFor Player that the string is being filtered for.
|
|
11417
11646
|
* @returns Filtered string result.
|
|
11418
11647
|
*
|
|
11419
|
-
* @deprecated
|
|
11648
|
+
* @deprecated FilterStringAsync
|
|
11420
11649
|
*/
|
|
11421
11650
|
FilterStringForPlayerAsync(this: Chat, stringToFilter: string, playerToFilterFor: Player): string;
|
|
11422
11651
|
/**
|
|
@@ -11792,6 +12021,13 @@ interface DragDetector extends ClickDetector {
|
|
|
11792
12021
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragContinue)
|
|
11793
12022
|
*/
|
|
11794
12023
|
readonly DragContinue: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
12024
|
+
/**
|
|
12025
|
+
* - **ThreadSafety**: Unsafe
|
|
12026
|
+
* - **Tags**: Hidden
|
|
12027
|
+
*
|
|
12028
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragContinueReplicate)
|
|
12029
|
+
*/
|
|
12030
|
+
readonly DragContinueReplicate: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
11795
12031
|
/**
|
|
11796
12032
|
* Fires when a user stops dragging the object.
|
|
11797
12033
|
*
|
|
@@ -11800,6 +12036,13 @@ interface DragDetector extends ClickDetector {
|
|
|
11800
12036
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragEnd)
|
|
11801
12037
|
*/
|
|
11802
12038
|
readonly DragEnd: RBXScriptSignal<(playerWhoDragged: Player) => void>;
|
|
12039
|
+
/**
|
|
12040
|
+
* - **ThreadSafety**: Unsafe
|
|
12041
|
+
* - **Tags**: Hidden
|
|
12042
|
+
*
|
|
12043
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragEndReplicate)
|
|
12044
|
+
*/
|
|
12045
|
+
readonly DragEndReplicate: RBXScriptSignal<(playerWhoDragged: Player) => void>;
|
|
11803
12046
|
/**
|
|
11804
12047
|
* Fires when a user starts dragging the object.
|
|
11805
12048
|
*
|
|
@@ -11808,6 +12051,20 @@ interface DragDetector extends ClickDetector {
|
|
|
11808
12051
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragStart)
|
|
11809
12052
|
*/
|
|
11810
12053
|
readonly DragStart: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
12054
|
+
/**
|
|
12055
|
+
* - **ThreadSafety**: Unsafe
|
|
12056
|
+
* - **Tags**: Hidden
|
|
12057
|
+
*
|
|
12058
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragStartReplicate)
|
|
12059
|
+
*/
|
|
12060
|
+
readonly DragStartReplicate: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
12061
|
+
/**
|
|
12062
|
+
* - **ThreadSafety**: Unsafe
|
|
12063
|
+
* - **Tags**: Hidden
|
|
12064
|
+
*
|
|
12065
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#RestartPhysicalDragReplicate)
|
|
12066
|
+
*/
|
|
12067
|
+
readonly RestartPhysicalDragReplicate: RBXScriptSignal<(hitPoint: Vector3) => void>;
|
|
11811
12068
|
}
|
|
11812
12069
|
/**
|
|
11813
12070
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -11928,7 +12185,7 @@ interface Collaborator extends Instance {
|
|
|
11928
12185
|
*
|
|
11929
12186
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Collaborator#CollaboratorColor)
|
|
11930
12187
|
*
|
|
11931
|
-
* @deprecated
|
|
12188
|
+
* @deprecated CollaboratorColor3
|
|
11932
12189
|
*/
|
|
11933
12190
|
CollaboratorColor: number;
|
|
11934
12191
|
/**
|
|
@@ -12117,7 +12374,7 @@ interface CollectionService extends Instance {
|
|
|
12117
12374
|
*
|
|
12118
12375
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CollectionService#ItemAdded)
|
|
12119
12376
|
*
|
|
12120
|
-
* @deprecated
|
|
12377
|
+
* @deprecated GetInstanceAddedSignal
|
|
12121
12378
|
*/
|
|
12122
12379
|
readonly ItemAdded: RBXScriptSignal<(instance: Instance) => void>;
|
|
12123
12380
|
/**
|
|
@@ -12130,7 +12387,7 @@ interface CollectionService extends Instance {
|
|
|
12130
12387
|
*
|
|
12131
12388
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CollectionService#ItemRemoved)
|
|
12132
12389
|
*
|
|
12133
|
-
* @deprecated
|
|
12390
|
+
* @deprecated GetInstanceRemovedSignal
|
|
12134
12391
|
*/
|
|
12135
12392
|
readonly ItemRemoved: RBXScriptSignal<(instance: Instance) => void>;
|
|
12136
12393
|
/**
|
|
@@ -13254,7 +13511,7 @@ interface PlaneConstraint extends Constraint {
|
|
|
13254
13511
|
*
|
|
13255
13512
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plane)
|
|
13256
13513
|
*
|
|
13257
|
-
* @deprecated
|
|
13514
|
+
* @deprecated PlaneConstraint
|
|
13258
13515
|
*/
|
|
13259
13516
|
interface Plane extends PlaneConstraint {
|
|
13260
13517
|
/**
|
|
@@ -13927,7 +14184,7 @@ interface TorsionSpringConstraint extends Constraint {
|
|
|
13927
14184
|
*
|
|
13928
14185
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#LimitEnabled)
|
|
13929
14186
|
*
|
|
13930
|
-
* @deprecated
|
|
14187
|
+
* @deprecated LimitsEnabled
|
|
13931
14188
|
*/
|
|
13932
14189
|
LimitEnabled: boolean;
|
|
13933
14190
|
/**
|
|
@@ -14139,7 +14396,7 @@ interface ContentProvider extends Instance {
|
|
|
14139
14396
|
* @param this Service that is used to load content, or assets, into a game.
|
|
14140
14397
|
* @param contentId
|
|
14141
14398
|
*
|
|
14142
|
-
* @deprecated
|
|
14399
|
+
* @deprecated PreloadAsync
|
|
14143
14400
|
*/
|
|
14144
14401
|
Preload(this: ContentProvider, contentId: ContentId): void;
|
|
14145
14402
|
/**
|
|
@@ -14268,7 +14525,7 @@ interface ContextActionService extends Instance {
|
|
|
14268
14525
|
* @param createTouchButton
|
|
14269
14526
|
* @param inputTypes
|
|
14270
14527
|
*
|
|
14271
|
-
* @deprecated
|
|
14528
|
+
* @deprecated BindAction
|
|
14272
14529
|
*/
|
|
14273
14530
|
BindActionToInputTypes(this: ContextActionService, actionName: string, functionToBind: Callback, createTouchButton: boolean, inputTypes: unknown): void;
|
|
14274
14531
|
/**
|
|
@@ -15811,6 +16068,21 @@ interface DesignFoundationsService extends Instance {
|
|
|
15811
16068
|
*/
|
|
15812
16069
|
readonly _nominal_DesignFoundationsService: unique symbol;
|
|
15813
16070
|
}
|
|
16071
|
+
/**
|
|
16072
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
16073
|
+
*
|
|
16074
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DeviceDisplayService)
|
|
16075
|
+
*/
|
|
16076
|
+
interface DeviceDisplayService extends Instance {
|
|
16077
|
+
/**
|
|
16078
|
+
* **DO NOT USE!**
|
|
16079
|
+
*
|
|
16080
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16081
|
+
* @hidden
|
|
16082
|
+
* @deprecated
|
|
16083
|
+
*/
|
|
16084
|
+
readonly _nominal_DeviceDisplayService: unique symbol;
|
|
16085
|
+
}
|
|
15814
16086
|
/**
|
|
15815
16087
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
15816
16088
|
*
|
|
@@ -16280,6 +16552,21 @@ interface DigitsRigDescription extends Instance {
|
|
|
16280
16552
|
*/
|
|
16281
16553
|
SetFingerTip(this: DigitsRigDescription, fingerIndex: number, point: Vector3): void;
|
|
16282
16554
|
}
|
|
16555
|
+
/**
|
|
16556
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
16557
|
+
*
|
|
16558
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DisplayWakeLock)
|
|
16559
|
+
*/
|
|
16560
|
+
interface DisplayWakeLock extends Instance {
|
|
16561
|
+
/**
|
|
16562
|
+
* **DO NOT USE!**
|
|
16563
|
+
*
|
|
16564
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16565
|
+
* @hidden
|
|
16566
|
+
* @deprecated
|
|
16567
|
+
*/
|
|
16568
|
+
readonly _nominal_DisplayWakeLock: unique symbol;
|
|
16569
|
+
}
|
|
16283
16570
|
/**
|
|
16284
16571
|
* A helper object used to create tools that can drag parts.
|
|
16285
16572
|
*
|
|
@@ -18515,7 +18802,7 @@ interface GuiBase2d extends GuiBase {
|
|
|
18515
18802
|
*
|
|
18516
18803
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#Localize)
|
|
18517
18804
|
*
|
|
18518
|
-
* @deprecated
|
|
18805
|
+
* @deprecated AutoLocalize
|
|
18519
18806
|
*/
|
|
18520
18807
|
Localize: boolean;
|
|
18521
18808
|
/**
|
|
@@ -19427,7 +19714,7 @@ interface TextButton extends GuiButton {
|
|
|
19427
19714
|
*
|
|
19428
19715
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextButton#FontSize)
|
|
19429
19716
|
*
|
|
19430
|
-
* @deprecated
|
|
19717
|
+
* @deprecated TextSize
|
|
19431
19718
|
*/
|
|
19432
19719
|
FontSize: Enum.FontSize;
|
|
19433
19720
|
/**
|
|
@@ -19589,7 +19876,7 @@ interface TextButton extends GuiButton {
|
|
|
19589
19876
|
*
|
|
19590
19877
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextButton#TextWrap)
|
|
19591
19878
|
*
|
|
19592
|
-
* @deprecated
|
|
19879
|
+
* @deprecated TextWrapped
|
|
19593
19880
|
*/
|
|
19594
19881
|
TextWrap: boolean;
|
|
19595
19882
|
/**
|
|
@@ -19796,7 +20083,7 @@ interface TextLabel extends GuiLabel {
|
|
|
19796
20083
|
*
|
|
19797
20084
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextLabel#FontSize)
|
|
19798
20085
|
*
|
|
19799
|
-
* @deprecated
|
|
20086
|
+
* @deprecated TextSize
|
|
19800
20087
|
*/
|
|
19801
20088
|
FontSize: Enum.FontSize;
|
|
19802
20089
|
/**
|
|
@@ -19958,7 +20245,7 @@ interface TextLabel extends GuiLabel {
|
|
|
19958
20245
|
*
|
|
19959
20246
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextWrap)
|
|
19960
20247
|
*
|
|
19961
|
-
* @deprecated
|
|
20248
|
+
* @deprecated TextWrapped
|
|
19962
20249
|
*/
|
|
19963
20250
|
TextWrap: boolean;
|
|
19964
20251
|
/**
|
|
@@ -20258,7 +20545,7 @@ interface TextBox extends GuiObject {
|
|
|
20258
20545
|
*
|
|
20259
20546
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#FontSize)
|
|
20260
20547
|
*
|
|
20261
|
-
* @deprecated
|
|
20548
|
+
* @deprecated TextSize
|
|
20262
20549
|
*/
|
|
20263
20550
|
FontSize: Enum.FontSize;
|
|
20264
20551
|
/**
|
|
@@ -20453,7 +20740,7 @@ interface TextBox extends GuiObject {
|
|
|
20453
20740
|
*
|
|
20454
20741
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#TextWrap)
|
|
20455
20742
|
*
|
|
20456
|
-
* @deprecated
|
|
20743
|
+
* @deprecated TextWrapped
|
|
20457
20744
|
*/
|
|
20458
20745
|
TextWrap: boolean;
|
|
20459
20746
|
/**
|
|
@@ -21548,7 +21835,7 @@ interface SelectionBox extends InstanceAdornment {
|
|
|
21548
21835
|
*
|
|
21549
21836
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelectionBox#SurfaceColor)
|
|
21550
21837
|
*
|
|
21551
|
-
* @deprecated
|
|
21838
|
+
* @deprecated SurfaceColor3
|
|
21552
21839
|
*/
|
|
21553
21840
|
SurfaceColor: BrickColor;
|
|
21554
21841
|
/**
|
|
@@ -22070,7 +22357,7 @@ interface SelectionSphere extends PVAdornment {
|
|
|
22070
22357
|
*
|
|
22071
22358
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelectionSphere#SurfaceColor)
|
|
22072
22359
|
*
|
|
22073
|
-
* @deprecated
|
|
22360
|
+
* @deprecated SurfaceColor3
|
|
22074
22361
|
*/
|
|
22075
22362
|
SurfaceColor: BrickColor;
|
|
22076
22363
|
/**
|
|
@@ -22714,7 +23001,7 @@ interface GuiService extends Instance {
|
|
|
22714
23001
|
* @param selectionName
|
|
22715
23002
|
* @param selectionParent
|
|
22716
23003
|
*
|
|
22717
|
-
* @deprecated
|
|
23004
|
+
* @deprecated SelectionGroup
|
|
22718
23005
|
*/
|
|
22719
23006
|
AddSelectionParent(this: GuiService, selectionName: string, selectionParent: GuiObject): void;
|
|
22720
23007
|
/**
|
|
@@ -22733,7 +23020,7 @@ interface GuiService extends Instance {
|
|
|
22733
23020
|
* @param selectionName The name of the added selection.
|
|
22734
23021
|
* @param selections The selection(s) added.
|
|
22735
23022
|
*
|
|
22736
|
-
* @deprecated
|
|
23023
|
+
* @deprecated SelectionGroup
|
|
22737
23024
|
*/
|
|
22738
23025
|
AddSelectionTuple(this: GuiService, selectionName: string, selections: Array<GuiObject>): void;
|
|
22739
23026
|
/**
|
|
@@ -22848,7 +23135,7 @@ interface GuiService extends Instance {
|
|
|
22848
23135
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
22849
23136
|
* @param selectionName
|
|
22850
23137
|
*
|
|
22851
|
-
* @deprecated
|
|
23138
|
+
* @deprecated SelectionGroup
|
|
22852
23139
|
*/
|
|
22853
23140
|
RemoveSelectionGroup(this: GuiService, selectionName: string): void;
|
|
22854
23141
|
/**
|
|
@@ -24025,7 +24312,7 @@ interface Humanoid extends Instance {
|
|
|
24025
24312
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
24026
24313
|
* @param assetTypeVerification The asset type verification mode.
|
|
24027
24314
|
*
|
|
24028
|
-
* @deprecated
|
|
24315
|
+
* @deprecated ApplyDescriptionAsync
|
|
24029
24316
|
*/
|
|
24030
24317
|
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
24031
24318
|
/**
|
|
@@ -24053,7 +24340,7 @@ interface Humanoid extends Instance {
|
|
|
24053
24340
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
24054
24341
|
* @param assetTypeVerification The asset type verification mode.
|
|
24055
24342
|
*
|
|
24056
|
-
* @deprecated
|
|
24343
|
+
* @deprecated ApplyDescriptionResetAsync
|
|
24057
24344
|
*/
|
|
24058
24345
|
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
24059
24346
|
/**
|
|
@@ -24081,7 +24368,7 @@ interface Humanoid extends Instance {
|
|
|
24081
24368
|
* @param emoteName name of the emote to play.
|
|
24082
24369
|
* @returns successfully played.
|
|
24083
24370
|
*
|
|
24084
|
-
* @deprecated
|
|
24371
|
+
* @deprecated PlayEmoteAsync
|
|
24085
24372
|
*/
|
|
24086
24373
|
PlayEmote(this: Humanoid, emoteName: string): boolean;
|
|
24087
24374
|
/**
|
|
@@ -26241,7 +26528,7 @@ interface InsertService extends Instance {
|
|
|
26241
26528
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetBaseCategories)
|
|
26242
26529
|
* @param this Used to insert assets from the Roblox website.
|
|
26243
26530
|
*
|
|
26244
|
-
* @deprecated
|
|
26531
|
+
* @deprecated GetBaseSets
|
|
26245
26532
|
*/
|
|
26246
26533
|
GetBaseCategories(this: InsertService): Array<unknown>;
|
|
26247
26534
|
/**
|
|
@@ -26287,7 +26574,7 @@ interface InsertService extends Instance {
|
|
|
26287
26574
|
* @param pageNum The page number in the Catalog to return.
|
|
26288
26575
|
* @returns A single table (of returned free decals) wrapped in a table.
|
|
26289
26576
|
*
|
|
26290
|
-
* @deprecated
|
|
26577
|
+
* @deprecated GetFreeDecalsAsync
|
|
26291
26578
|
*/
|
|
26292
26579
|
GetFreeDecals(this: InsertService, searchText: string, pageNum: number): [
|
|
26293
26580
|
Array<FreeSearchResult>
|
|
@@ -26319,7 +26606,7 @@ interface InsertService extends Instance {
|
|
|
26319
26606
|
* @param pageNum The page number in the Catalog to return.
|
|
26320
26607
|
* @returns A single table (of returned free models) wrapped in a table.
|
|
26321
26608
|
*
|
|
26322
|
-
* @deprecated
|
|
26609
|
+
* @deprecated GetFreeModelsAsync
|
|
26323
26610
|
*/
|
|
26324
26611
|
GetFreeModels(this: InsertService, searchText: string, pageNum: number): [
|
|
26325
26612
|
Array<FreeSearchResult>
|
|
@@ -26358,7 +26645,7 @@ interface InsertService extends Instance {
|
|
|
26358
26645
|
* @param this Used to insert assets from the Roblox website.
|
|
26359
26646
|
* @param userId
|
|
26360
26647
|
*
|
|
26361
|
-
* @deprecated
|
|
26648
|
+
* @deprecated GetUserSets
|
|
26362
26649
|
*/
|
|
26363
26650
|
GetUserCategories(this: InsertService, userId: User): Array<unknown>;
|
|
26364
26651
|
/**
|
|
@@ -26399,6 +26686,13 @@ interface InsertService extends Instance {
|
|
|
26399
26686
|
* @param assetVersionId
|
|
26400
26687
|
*/
|
|
26401
26688
|
LoadAssetVersion(this: InsertService, assetVersionId: number): Model;
|
|
26689
|
+
/**
|
|
26690
|
+
* - **ThreadSafety**: Unsafe
|
|
26691
|
+
* - **Tags**: Hidden
|
|
26692
|
+
*
|
|
26693
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#InternalDelete)
|
|
26694
|
+
*/
|
|
26695
|
+
readonly InternalDelete: RBXScriptSignal<(instance: Instance) => void>;
|
|
26402
26696
|
}
|
|
26403
26697
|
/**
|
|
26404
26698
|
* - **Tags**: NotCreatable, Service
|
|
@@ -26462,6 +26756,36 @@ interface InternalMessagingServiceVerifier extends Instance {
|
|
|
26462
26756
|
*/
|
|
26463
26757
|
readonly _nominal_InternalMessagingServiceVerifier: unique symbol;
|
|
26464
26758
|
}
|
|
26759
|
+
/**
|
|
26760
|
+
* - **Tags**: NotReplicated
|
|
26761
|
+
*
|
|
26762
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InternalSyncItem)
|
|
26763
|
+
*/
|
|
26764
|
+
interface InternalSyncItem extends Instance {
|
|
26765
|
+
/**
|
|
26766
|
+
* **DO NOT USE!**
|
|
26767
|
+
*
|
|
26768
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26769
|
+
* @hidden
|
|
26770
|
+
* @deprecated
|
|
26771
|
+
*/
|
|
26772
|
+
readonly _nominal_InternalSyncItem: unique symbol;
|
|
26773
|
+
}
|
|
26774
|
+
/**
|
|
26775
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
26776
|
+
*
|
|
26777
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InternalSyncService)
|
|
26778
|
+
*/
|
|
26779
|
+
interface InternalSyncService extends Instance {
|
|
26780
|
+
/**
|
|
26781
|
+
* **DO NOT USE!**
|
|
26782
|
+
*
|
|
26783
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26784
|
+
* @hidden
|
|
26785
|
+
* @deprecated
|
|
26786
|
+
*/
|
|
26787
|
+
readonly _nominal_InternalSyncService: unique symbol;
|
|
26788
|
+
}
|
|
26465
26789
|
/**
|
|
26466
26790
|
* The base class for joints.
|
|
26467
26791
|
*
|
|
@@ -26560,7 +26884,7 @@ interface DynamicRotate extends JointInstance {
|
|
|
26560
26884
|
*
|
|
26561
26885
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotateP)
|
|
26562
26886
|
*
|
|
26563
|
-
* @deprecated
|
|
26887
|
+
* @deprecated HingeConstraint
|
|
26564
26888
|
*/
|
|
26565
26889
|
interface RotateP extends DynamicRotate {
|
|
26566
26890
|
/**
|
|
@@ -26579,7 +26903,7 @@ interface RotateP extends DynamicRotate {
|
|
|
26579
26903
|
*
|
|
26580
26904
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotateV)
|
|
26581
26905
|
*
|
|
26582
|
-
* @deprecated
|
|
26906
|
+
* @deprecated HingeConstraint
|
|
26583
26907
|
*/
|
|
26584
26908
|
interface RotateV extends DynamicRotate {
|
|
26585
26909
|
/**
|
|
@@ -26600,7 +26924,7 @@ interface RotateV extends DynamicRotate {
|
|
|
26600
26924
|
*
|
|
26601
26925
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Glue)
|
|
26602
26926
|
*
|
|
26603
|
-
* @deprecated
|
|
26927
|
+
* @deprecated WeldConstraint
|
|
26604
26928
|
*/
|
|
26605
26929
|
interface Glue extends JointInstance {
|
|
26606
26930
|
/**
|
|
@@ -26653,7 +26977,7 @@ interface Glue extends JointInstance {
|
|
|
26653
26977
|
*
|
|
26654
26978
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualSurfaceJointInstance)
|
|
26655
26979
|
*
|
|
26656
|
-
* @deprecated
|
|
26980
|
+
* @deprecated WeldConstraint
|
|
26657
26981
|
*/
|
|
26658
26982
|
interface ManualSurfaceJointInstance extends JointInstance {
|
|
26659
26983
|
/**
|
|
@@ -26674,7 +26998,7 @@ interface ManualSurfaceJointInstance extends JointInstance {
|
|
|
26674
26998
|
*
|
|
26675
26999
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualGlue)
|
|
26676
27000
|
*
|
|
26677
|
-
* @deprecated
|
|
27001
|
+
* @deprecated WeldConstraint
|
|
26678
27002
|
*/
|
|
26679
27003
|
interface ManualGlue extends ManualSurfaceJointInstance {
|
|
26680
27004
|
/**
|
|
@@ -26695,7 +27019,7 @@ interface ManualGlue extends ManualSurfaceJointInstance {
|
|
|
26695
27019
|
*
|
|
26696
27020
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualWeld)
|
|
26697
27021
|
*
|
|
26698
|
-
* @deprecated
|
|
27022
|
+
* @deprecated WeldConstraint
|
|
26699
27023
|
*/
|
|
26700
27024
|
interface ManualWeld extends ManualSurfaceJointInstance {
|
|
26701
27025
|
/**
|
|
@@ -26788,7 +27112,7 @@ interface Motor6D extends Motor {
|
|
|
26788
27112
|
*
|
|
26789
27113
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Rotate)
|
|
26790
27114
|
*
|
|
26791
|
-
* @deprecated
|
|
27115
|
+
* @deprecated HingeConstraint
|
|
26792
27116
|
*/
|
|
26793
27117
|
interface Rotate extends JointInstance {
|
|
26794
27118
|
/**
|
|
@@ -26809,7 +27133,7 @@ interface Rotate extends JointInstance {
|
|
|
26809
27133
|
*
|
|
26810
27134
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Snap)
|
|
26811
27135
|
*
|
|
26812
|
-
* @deprecated
|
|
27136
|
+
* @deprecated WeldConstraint
|
|
26813
27137
|
*/
|
|
26814
27138
|
interface Snap extends JointInstance {
|
|
26815
27139
|
/**
|
|
@@ -27114,7 +27438,7 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
27114
27438
|
* @param userId The user ID of the user.
|
|
27115
27439
|
* @returns An `InventoryPages` of animations.
|
|
27116
27440
|
*
|
|
27117
|
-
* @deprecated
|
|
27441
|
+
* @deprecated GetAnimationsAsync
|
|
27118
27442
|
*/
|
|
27119
27443
|
GetAnimations(this: KeyframeSequenceProvider, userId: number): InventoryPages<number>;
|
|
27120
27444
|
/**
|
|
@@ -27749,7 +28073,7 @@ interface LocalizationTable extends Instance {
|
|
|
27749
28073
|
*
|
|
27750
28074
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#DevelopmentLanguage)
|
|
27751
28075
|
*
|
|
27752
|
-
* @deprecated
|
|
28076
|
+
* @deprecated SourceLocaleId
|
|
27753
28077
|
*/
|
|
27754
28078
|
DevelopmentLanguage: string;
|
|
27755
28079
|
/**
|
|
@@ -27762,7 +28086,7 @@ interface LocalizationTable extends Instance {
|
|
|
27762
28086
|
*
|
|
27763
28087
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#Root)
|
|
27764
28088
|
*
|
|
27765
|
-
* @deprecated
|
|
28089
|
+
* @deprecated RootLocalizationTable
|
|
27766
28090
|
*/
|
|
27767
28091
|
Root: Instance | undefined;
|
|
27768
28092
|
/**
|
|
@@ -27782,7 +28106,7 @@ interface LocalizationTable extends Instance {
|
|
|
27782
28106
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetContents)
|
|
27783
28107
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27784
28108
|
*
|
|
27785
|
-
* @deprecated
|
|
28109
|
+
* @deprecated GetEntries
|
|
27786
28110
|
*/
|
|
27787
28111
|
GetContents(this: LocalizationTable): string;
|
|
27788
28112
|
/**
|
|
@@ -27809,7 +28133,7 @@ interface LocalizationTable extends Instance {
|
|
|
27809
28133
|
* @param key An optional unique key for fast hash lookups in code. If it is non-empty it must be unique in the table.
|
|
27810
28134
|
* @returns Translated string.
|
|
27811
28135
|
*
|
|
27812
|
-
* @deprecated
|
|
28136
|
+
* @deprecated GetTranslator
|
|
27813
28137
|
*/
|
|
27814
28138
|
GetString(this: LocalizationTable, targetLocaleId: string, key: string): string;
|
|
27815
28139
|
/**
|
|
@@ -27860,7 +28184,7 @@ interface LocalizationTable extends Instance {
|
|
|
27860
28184
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27861
28185
|
* @param key
|
|
27862
28186
|
*
|
|
27863
|
-
* @deprecated
|
|
28187
|
+
* @deprecated RemoveEntry
|
|
27864
28188
|
*/
|
|
27865
28189
|
RemoveKey(this: LocalizationTable, key: string): void;
|
|
27866
28190
|
/**
|
|
@@ -27885,7 +28209,7 @@ interface LocalizationTable extends Instance {
|
|
|
27885
28209
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27886
28210
|
* @param contents
|
|
27887
28211
|
*
|
|
27888
|
-
* @deprecated
|
|
28212
|
+
* @deprecated SetEntries
|
|
27889
28213
|
*/
|
|
27890
28214
|
SetContents(this: LocalizationTable, contents: string): void;
|
|
27891
28215
|
/**
|
|
@@ -27910,7 +28234,7 @@ interface LocalizationTable extends Instance {
|
|
|
27910
28234
|
* @param targetLocaleId
|
|
27911
28235
|
* @param text
|
|
27912
28236
|
*
|
|
27913
|
-
* @deprecated
|
|
28237
|
+
* @deprecated SetEntryValue
|
|
27914
28238
|
*/
|
|
27915
28239
|
SetEntry(this: LocalizationTable, key: string, targetLocaleId: string, text: string): void;
|
|
27916
28240
|
/**
|
|
@@ -28168,6 +28492,77 @@ interface LuaSourceContainer extends Instance {
|
|
|
28168
28492
|
*/
|
|
28169
28493
|
readonly _nominal_LuaSourceContainer: unique symbol;
|
|
28170
28494
|
}
|
|
28495
|
+
/**
|
|
28496
|
+
* - **Tags**:
|
|
28497
|
+
*
|
|
28498
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript)
|
|
28499
|
+
*
|
|
28500
|
+
* @deprecated
|
|
28501
|
+
*/
|
|
28502
|
+
interface AuroraScript extends LuaSourceContainer {
|
|
28503
|
+
/**
|
|
28504
|
+
* **DO NOT USE!**
|
|
28505
|
+
*
|
|
28506
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
28507
|
+
* @hidden
|
|
28508
|
+
* @deprecated
|
|
28509
|
+
*/
|
|
28510
|
+
readonly _nominal_AuroraScript: unique symbol;
|
|
28511
|
+
/**
|
|
28512
|
+
* - **ThreadSafety**: ReadSafe
|
|
28513
|
+
*
|
|
28514
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#EnableCulling)
|
|
28515
|
+
*/
|
|
28516
|
+
EnableCulling: boolean;
|
|
28517
|
+
/**
|
|
28518
|
+
* - **ThreadSafety**: ReadSafe
|
|
28519
|
+
*
|
|
28520
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#EnableLOD)
|
|
28521
|
+
*/
|
|
28522
|
+
EnableLOD: boolean;
|
|
28523
|
+
/**
|
|
28524
|
+
* - **ThreadSafety**: ReadSafe
|
|
28525
|
+
*
|
|
28526
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#LODCriticality)
|
|
28527
|
+
*/
|
|
28528
|
+
LODCriticality: number;
|
|
28529
|
+
/**
|
|
28530
|
+
* - **ThreadSafety**: ReadSafe
|
|
28531
|
+
*
|
|
28532
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#Priority)
|
|
28533
|
+
*/
|
|
28534
|
+
Priority: number;
|
|
28535
|
+
/**
|
|
28536
|
+
* - **ThreadSafety**: ReadSafe
|
|
28537
|
+
*
|
|
28538
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#Source)
|
|
28539
|
+
*/
|
|
28540
|
+
Source: ProtectedString;
|
|
28541
|
+
/**
|
|
28542
|
+
* - **ThreadSafety**: Unsafe
|
|
28543
|
+
*
|
|
28544
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#AddTo)
|
|
28545
|
+
*/
|
|
28546
|
+
AddTo(this: AuroraScript, instance: Instance, parameters?: object): void;
|
|
28547
|
+
/**
|
|
28548
|
+
* - **ThreadSafety**: Unsafe
|
|
28549
|
+
*
|
|
28550
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#IsOnInstance)
|
|
28551
|
+
*/
|
|
28552
|
+
IsOnInstance(this: AuroraScript, instance: Instance): boolean;
|
|
28553
|
+
/**
|
|
28554
|
+
* - **ThreadSafety**: Unsafe
|
|
28555
|
+
*
|
|
28556
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#RemoveFrom)
|
|
28557
|
+
*/
|
|
28558
|
+
RemoveFrom(this: AuroraScript, instance: Instance): void;
|
|
28559
|
+
/**
|
|
28560
|
+
* - **ThreadSafety**: Unsafe
|
|
28561
|
+
*
|
|
28562
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#SignalFired)
|
|
28563
|
+
*/
|
|
28564
|
+
SignalFired(this: AuroraScript, instance: Instance, topic: string): RBXScriptSignal;
|
|
28565
|
+
}
|
|
28171
28566
|
/**
|
|
28172
28567
|
* The base class for all script objects which run automatically.
|
|
28173
28568
|
*
|
|
@@ -28540,9 +28935,10 @@ interface MarketplaceService extends Instance {
|
|
|
28540
28935
|
* @param player The user to prompt to purchase items.
|
|
28541
28936
|
* @param lineItems An array of avatar items to be included in the bulk purchase. Each line item contains the following structure:
|
|
28542
28937
|
* ```lua
|
|
28543
|
-
* { Type: MarketplaceProductType, Id: string }
|
|
28938
|
+
* { Type: MarketplaceProductType, Id: string, PurchaseOptions: { {Type: PurchaseOption, Value: number?} }? }
|
|
28544
28939
|
* ``` Each line item contains the following pairs: - `Type`: The corresponding `MarketplaceProductType` (Enum).
|
|
28545
28940
|
* - `Id`: The ID of the asset or bundle.
|
|
28941
|
+
* - `PurchaseOptions`: Optional. An array containing a single purchase option to display in the prompt. If omitted, the permanent purchase is prompted. See the PurchaseOptions section below for details.
|
|
28546
28942
|
*
|
|
28547
28943
|
*
|
|
28548
28944
|
* @param options Not available at this time.
|
|
@@ -28593,7 +28989,7 @@ interface MarketplaceService extends Instance {
|
|
|
28593
28989
|
* @param this The service responsible for in-experience transactions.
|
|
28594
28990
|
* @param player The user being prompted to purchase Premium.
|
|
28595
28991
|
*
|
|
28596
|
-
* @deprecated
|
|
28992
|
+
* @deprecated PromptRobloxSubscriptionPurchase
|
|
28597
28993
|
*/
|
|
28598
28994
|
PromptPremiumPurchase(this: MarketplaceService, player: Player): void;
|
|
28599
28995
|
/**
|
|
@@ -28673,7 +29069,7 @@ interface MarketplaceService extends Instance {
|
|
|
28673
29069
|
* @param infoType An `InfoType` enum value specifying the type of information being retrieved.
|
|
28674
29070
|
* @returns A dictionary containing information about the queried item, described in the previous tables.
|
|
28675
29071
|
*
|
|
28676
|
-
* @deprecated
|
|
29072
|
+
* @deprecated GetProductInfoAsync
|
|
28677
29073
|
*/
|
|
28678
29074
|
GetProductInfo(this: MarketplaceService, id: number): AssetProductInfo;
|
|
28679
29075
|
GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Asset>): AssetProductInfo;
|
|
@@ -28780,7 +29176,7 @@ interface MarketplaceService extends Instance {
|
|
|
28780
29176
|
* @param assetId The asset ID for which the given player's inventory is tested.
|
|
28781
29177
|
* @returns Indicates whether the given player's inventory contains the given asset.
|
|
28782
29178
|
*
|
|
28783
|
-
* @deprecated
|
|
29179
|
+
* @deprecated PlayerOwnsAssetAsync
|
|
28784
29180
|
*/
|
|
28785
29181
|
PlayerOwnsAsset(this: MarketplaceService, player: Player, assetId: number): boolean;
|
|
28786
29182
|
/**
|
|
@@ -28810,7 +29206,7 @@ interface MarketplaceService extends Instance {
|
|
|
28810
29206
|
* @param bundleId The bundle ID for which the given player's inventory is tested.
|
|
28811
29207
|
* @returns Indicates whether the given player's inventory contains the given bundle.
|
|
28812
29208
|
*
|
|
28813
|
-
* @deprecated
|
|
29209
|
+
* @deprecated PlayerOwnsBundleAsync
|
|
28814
29210
|
*/
|
|
28815
29211
|
PlayerOwnsBundle(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
28816
29212
|
/**
|
|
@@ -29849,7 +30245,7 @@ interface Mouse extends Instance {
|
|
|
29849
30245
|
*
|
|
29850
30246
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#KeyDown)
|
|
29851
30247
|
*
|
|
29852
|
-
* @deprecated
|
|
30248
|
+
* @deprecated InputBegan
|
|
29853
30249
|
*/
|
|
29854
30250
|
readonly KeyDown: RBXScriptSignal<(key: string) => void>;
|
|
29855
30251
|
/**
|
|
@@ -29862,7 +30258,7 @@ interface Mouse extends Instance {
|
|
|
29862
30258
|
*
|
|
29863
30259
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#KeyUp)
|
|
29864
30260
|
*
|
|
29865
|
-
* @deprecated
|
|
30261
|
+
* @deprecated InputEnded
|
|
29866
30262
|
*/
|
|
29867
30263
|
readonly KeyUp: RBXScriptSignal<(key: string) => void>;
|
|
29868
30264
|
/**
|
|
@@ -30008,7 +30404,7 @@ interface OmniRecommendationsService extends Instance {
|
|
|
30008
30404
|
*
|
|
30009
30405
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1)
|
|
30010
30406
|
*
|
|
30011
|
-
* @deprecated
|
|
30407
|
+
* @deprecated HttpService
|
|
30012
30408
|
*/
|
|
30013
30409
|
interface OpenCloudApiV1 extends Instance {
|
|
30014
30410
|
/**
|
|
@@ -30054,7 +30450,7 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
30054
30450
|
*
|
|
30055
30451
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudService)
|
|
30056
30452
|
*
|
|
30057
|
-
* @deprecated
|
|
30453
|
+
* @deprecated HttpService
|
|
30058
30454
|
*/
|
|
30059
30455
|
interface OpenCloudService extends Instance {
|
|
30060
30456
|
/**
|
|
@@ -30391,7 +30787,7 @@ interface BasePart extends PVInstance {
|
|
|
30391
30787
|
*
|
|
30392
30788
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#CollisionGroupId)
|
|
30393
30789
|
*
|
|
30394
|
-
* @deprecated
|
|
30790
|
+
* @deprecated CollisionGroup
|
|
30395
30791
|
*/
|
|
30396
30792
|
CollisionGroupId: number;
|
|
30397
30793
|
/**
|
|
@@ -30743,7 +31139,7 @@ interface BasePart extends PVInstance {
|
|
|
30743
31139
|
*
|
|
30744
31140
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#RotVelocity)
|
|
30745
31141
|
*
|
|
30746
|
-
* @deprecated
|
|
31142
|
+
* @deprecated AssemblyAngularVelocity
|
|
30747
31143
|
*/
|
|
30748
31144
|
RotVelocity: Vector3;
|
|
30749
31145
|
/**
|
|
@@ -30756,7 +31152,7 @@ interface BasePart extends PVInstance {
|
|
|
30756
31152
|
*/
|
|
30757
31153
|
Rotation: Vector3;
|
|
30758
31154
|
/**
|
|
30759
|
-
* Determines the dimensions of a part (length,
|
|
31155
|
+
* Determines the dimensions of a part (length, height, width).
|
|
30760
31156
|
*
|
|
30761
31157
|
* - **ThreadSafety**: ReadSafe
|
|
30762
31158
|
* - **Tags**: NotReplicated
|
|
@@ -30842,7 +31238,7 @@ interface BasePart extends PVInstance {
|
|
|
30842
31238
|
*
|
|
30843
31239
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#Velocity)
|
|
30844
31240
|
*
|
|
30845
|
-
* @deprecated
|
|
31241
|
+
* @deprecated AssemblyLinearVelocity
|
|
30846
31242
|
*/
|
|
30847
31243
|
Velocity: Vector3;
|
|
30848
31244
|
/**
|
|
@@ -31020,7 +31416,7 @@ interface BasePart extends PVInstance {
|
|
|
31020
31416
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
31021
31417
|
* @returns The base part of an assembly (a collection of parts connected together).
|
|
31022
31418
|
*
|
|
31023
|
-
* @deprecated
|
|
31419
|
+
* @deprecated AssemblyRootPart
|
|
31024
31420
|
*/
|
|
31025
31421
|
GetRootPart(this: BasePart): BasePart;
|
|
31026
31422
|
/**
|
|
@@ -31200,7 +31596,7 @@ interface BasePart extends PVInstance {
|
|
|
31200
31596
|
*
|
|
31201
31597
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#StoppedTouching)
|
|
31202
31598
|
*
|
|
31203
|
-
* @deprecated
|
|
31599
|
+
* @deprecated TouchEnded
|
|
31204
31600
|
*/
|
|
31205
31601
|
readonly StoppedTouching: RBXScriptSignal<(otherPart: BasePart) => void>;
|
|
31206
31602
|
/**
|
|
@@ -31301,6 +31697,20 @@ interface Platform extends Part {
|
|
|
31301
31697
|
* @deprecated
|
|
31302
31698
|
*/
|
|
31303
31699
|
readonly _nominal_Platform: unique symbol;
|
|
31700
|
+
/**
|
|
31701
|
+
* - **ThreadSafety**: Unsafe
|
|
31702
|
+
* - **Tags**: Hidden
|
|
31703
|
+
*
|
|
31704
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Platform#RemoteCreateMotor6D)
|
|
31705
|
+
*/
|
|
31706
|
+
readonly RemoteCreateMotor6D: RBXScriptSignal<(humanoid: Instance) => void>;
|
|
31707
|
+
/**
|
|
31708
|
+
* - **ThreadSafety**: Unsafe
|
|
31709
|
+
* - **Tags**: Hidden
|
|
31710
|
+
*
|
|
31711
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Platform#RemoteDestroyMotor6D)
|
|
31712
|
+
*/
|
|
31713
|
+
readonly RemoteDestroyMotor6D: RBXScriptSignal<() => void>;
|
|
31304
31714
|
}
|
|
31305
31715
|
/**
|
|
31306
31716
|
* A type of `BasePart` that characters can 'sit' in. When a character touches an enabled Seat object, it will be attached to the part by a `Weld` and the default character scripts will play a sitting animation.
|
|
@@ -31343,6 +31753,20 @@ interface Seat extends Part {
|
|
|
31343
31753
|
* @param humanoid
|
|
31344
31754
|
*/
|
|
31345
31755
|
Sit(this: Seat, humanoid: Humanoid | undefined): void;
|
|
31756
|
+
/**
|
|
31757
|
+
* - **ThreadSafety**: Unsafe
|
|
31758
|
+
* - **Tags**: Hidden
|
|
31759
|
+
*
|
|
31760
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Seat#RemoteCreateSeatWeld)
|
|
31761
|
+
*/
|
|
31762
|
+
readonly RemoteCreateSeatWeld: RBXScriptSignal<(humanoid: Instance) => void>;
|
|
31763
|
+
/**
|
|
31764
|
+
* - **ThreadSafety**: Unsafe
|
|
31765
|
+
* - **Tags**: Hidden
|
|
31766
|
+
*
|
|
31767
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Seat#RemoteDestroySeatWeld)
|
|
31768
|
+
*/
|
|
31769
|
+
readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
|
|
31346
31770
|
}
|
|
31347
31771
|
/**
|
|
31348
31772
|
* **Deprecated:** The SkateboardPlatform object has been deprecated and is no longer supported by Roblox. Developers looking to create skateboards or similar vehicles are advised to program their own systems. Additionally, the `VehicleSeat` object can be used to quickly create simple vehicles.
|
|
@@ -31434,6 +31858,20 @@ interface SkateboardPlatform extends Part {
|
|
|
31434
31858
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#MoveStateChanged)
|
|
31435
31859
|
*/
|
|
31436
31860
|
readonly MoveStateChanged: RBXScriptSignal<(newState: Enum.MoveState, oldState: Enum.MoveState) => void>;
|
|
31861
|
+
/**
|
|
31862
|
+
* - **ThreadSafety**: Unsafe
|
|
31863
|
+
* - **Tags**: Hidden
|
|
31864
|
+
*
|
|
31865
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#RemoteCreateMotor6D)
|
|
31866
|
+
*/
|
|
31867
|
+
readonly RemoteCreateMotor6D: RBXScriptSignal<(humanoid: Instance) => void>;
|
|
31868
|
+
/**
|
|
31869
|
+
* - **ThreadSafety**: Unsafe
|
|
31870
|
+
* - **Tags**: Hidden
|
|
31871
|
+
*
|
|
31872
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#RemoteDestroyMotor6D)
|
|
31873
|
+
*/
|
|
31874
|
+
readonly RemoteDestroyMotor6D: RBXScriptSignal<() => void>;
|
|
31437
31875
|
/**
|
|
31438
31876
|
* Fired whenever the skateboard is unequipped.
|
|
31439
31877
|
*
|
|
@@ -32408,6 +32846,20 @@ interface VehicleSeat extends BasePart {
|
|
|
32408
32846
|
* @param humanoid The `Humanoid` being forced to sit in the `VehicleSeat`.
|
|
32409
32847
|
*/
|
|
32410
32848
|
Sit(this: VehicleSeat, humanoid: Instance): void;
|
|
32849
|
+
/**
|
|
32850
|
+
* - **ThreadSafety**: Unsafe
|
|
32851
|
+
* - **Tags**: Hidden
|
|
32852
|
+
*
|
|
32853
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#RemoteCreateSeatWeld)
|
|
32854
|
+
*/
|
|
32855
|
+
readonly RemoteCreateSeatWeld: RBXScriptSignal<(humanoid: Instance) => void>;
|
|
32856
|
+
/**
|
|
32857
|
+
* - **ThreadSafety**: Unsafe
|
|
32858
|
+
* - **Tags**: Hidden
|
|
32859
|
+
*
|
|
32860
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#RemoteDestroySeatWeld)
|
|
32861
|
+
*/
|
|
32862
|
+
readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
|
|
32411
32863
|
}
|
|
32412
32864
|
/**
|
|
32413
32865
|
* A class which defines a view of the 3D world.
|
|
@@ -32457,7 +32909,7 @@ interface Camera extends PVInstance {
|
|
|
32457
32909
|
*
|
|
32458
32910
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CoordinateFrame)
|
|
32459
32911
|
*
|
|
32460
|
-
* @deprecated
|
|
32912
|
+
* @deprecated CFrame
|
|
32461
32913
|
*/
|
|
32462
32914
|
CoordinateFrame: CFrame;
|
|
32463
32915
|
/**
|
|
@@ -32744,7 +33196,7 @@ interface Camera extends PVInstance {
|
|
|
32744
33196
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToViewportPoint)
|
|
32745
33197
|
* @param this A class which defines a view of the 3D world.
|
|
32746
33198
|
* @param worldPoint The `Vector3` world position.
|
|
32747
|
-
* @returns A tuple containing, in order: - A `Vector3` whose **X** and **Y** components represent the offset of the `worldPoint` from the top left corner of the viewport, in pixels.
|
|
33199
|
+
* @returns A tuple containing, in order: - A `Vector3` whose **X** and **Y** components represent the offset of the `worldPoint` from the top left corner of the viewport, in pixels for `Workspace.CurrentCamera`. For cameras inside a `ViewportFrame`, the values are normalized to [0, 1]. The `Vector3` **Z** component represents the depth of the `worldPoint` from the screen (in studs).
|
|
32748
33200
|
* - A boolean indicating if the `worldPoint` is within the bounds of the screen.
|
|
32749
33201
|
*/
|
|
32750
33202
|
WorldToViewportPoint(this: Camera, worldPoint: Vector3): LuaTuple<[
|
|
@@ -32868,7 +33320,7 @@ interface Model extends PVInstance {
|
|
|
32868
33320
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetModelCFrame)
|
|
32869
33321
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
32870
33322
|
*
|
|
32871
|
-
* @deprecated
|
|
33323
|
+
* @deprecated GetPrimaryPartCFrame
|
|
32872
33324
|
*/
|
|
32873
33325
|
GetModelCFrame(this: Model): CFrame;
|
|
32874
33326
|
/**
|
|
@@ -32882,7 +33334,7 @@ interface Model extends PVInstance {
|
|
|
32882
33334
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetModelSize)
|
|
32883
33335
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
32884
33336
|
*
|
|
32885
|
-
* @deprecated
|
|
33337
|
+
* @deprecated GetExtentsSize
|
|
32886
33338
|
*/
|
|
32887
33339
|
GetModelSize(this: Model): Vector3;
|
|
32888
33340
|
/**
|
|
@@ -32906,7 +33358,7 @@ interface Model extends PVInstance {
|
|
|
32906
33358
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetPrimaryPartCFrame)
|
|
32907
33359
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
32908
33360
|
*
|
|
32909
|
-
* @deprecated
|
|
33361
|
+
* @deprecated GetPivot
|
|
32910
33362
|
*/
|
|
32911
33363
|
GetPrimaryPartCFrame(this: Model): CFrame;
|
|
32912
33364
|
/**
|
|
@@ -32964,7 +33416,7 @@ interface Model extends PVInstance {
|
|
|
32964
33416
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#ResetOrientationToIdentity)
|
|
32965
33417
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
32966
33418
|
*
|
|
32967
|
-
* @deprecated
|
|
33419
|
+
* @deprecated SetPrimaryPartCFrame
|
|
32968
33420
|
*/
|
|
32969
33421
|
ResetOrientationToIdentity(this: Model): void;
|
|
32970
33422
|
/**
|
|
@@ -32988,7 +33440,7 @@ interface Model extends PVInstance {
|
|
|
32988
33440
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#SetIdentityOrientation)
|
|
32989
33441
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
32990
33442
|
*
|
|
32991
|
-
* @deprecated
|
|
33443
|
+
* @deprecated SetPrimaryPartCFrame
|
|
32992
33444
|
*/
|
|
32993
33445
|
SetIdentityOrientation(this: Model): void;
|
|
32994
33446
|
/**
|
|
@@ -33003,7 +33455,7 @@ interface Model extends PVInstance {
|
|
|
33003
33455
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
33004
33456
|
* @param cframe The `CFrame` to be set.
|
|
33005
33457
|
*
|
|
33006
|
-
* @deprecated
|
|
33458
|
+
* @deprecated PivotTo
|
|
33007
33459
|
*/
|
|
33008
33460
|
SetPrimaryPartCFrame(this: Model, cframe: CFrame): void;
|
|
33009
33461
|
/**
|
|
@@ -33377,7 +33829,7 @@ interface WorldRoot extends Model {
|
|
|
33377
33829
|
* @param ignoreWater
|
|
33378
33830
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
33379
33831
|
*
|
|
33380
|
-
* @deprecated
|
|
33832
|
+
* @deprecated Raycast
|
|
33381
33833
|
*/
|
|
33382
33834
|
FindPartOnRay(this: WorldRoot, ray: Ray, ignoreDescendantsInstance?: Instance, terrainCellsAreCubes?: boolean, ignoreWater?: boolean): LuaTuple<[
|
|
33383
33835
|
BasePart | undefined,
|
|
@@ -33401,7 +33853,7 @@ interface WorldRoot extends Model {
|
|
|
33401
33853
|
* @param ignoreWater
|
|
33402
33854
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
33403
33855
|
*
|
|
33404
|
-
* @deprecated
|
|
33856
|
+
* @deprecated Raycast
|
|
33405
33857
|
*/
|
|
33406
33858
|
FindPartOnRayWithIgnoreList(this: WorldRoot, ray: Ray, ignoreDescendantsTable: Array<Instance>, terrainCellsAreCubes?: boolean, ignoreWater?: boolean): LuaTuple<[
|
|
33407
33859
|
BasePart | undefined,
|
|
@@ -33424,7 +33876,7 @@ interface WorldRoot extends Model {
|
|
|
33424
33876
|
* @param ignoreWater
|
|
33425
33877
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
33426
33878
|
*
|
|
33427
|
-
* @deprecated
|
|
33879
|
+
* @deprecated Raycast
|
|
33428
33880
|
*/
|
|
33429
33881
|
FindPartOnRayWithWhitelist(this: WorldRoot, ray: Ray, whitelistDescendantsTable: Array<Instance>, ignoreWater?: boolean): LuaTuple<[
|
|
33430
33882
|
BasePart | undefined,
|
|
@@ -33447,7 +33899,7 @@ interface WorldRoot extends Model {
|
|
|
33447
33899
|
* @param maxParts The maximum amount of `BaseParts` to be returned.
|
|
33448
33900
|
* @returns An array of `BaseParts` within the `Region3`.
|
|
33449
33901
|
*
|
|
33450
|
-
* @deprecated
|
|
33902
|
+
* @deprecated GetPartBoundsInBox
|
|
33451
33903
|
*/
|
|
33452
33904
|
FindPartsInRegion3(this: WorldRoot, region: Region3, ignoreDescendantsInstance?: Instance, maxParts?: number): Array<BasePart>;
|
|
33453
33905
|
/**
|
|
@@ -33465,7 +33917,7 @@ interface WorldRoot extends Model {
|
|
|
33465
33917
|
* @param maxParts The maximum number of `BaseParts` to be returned.
|
|
33466
33918
|
* @returns An array of `BaseParts` found within the `Region3`.
|
|
33467
33919
|
*
|
|
33468
|
-
* @deprecated
|
|
33920
|
+
* @deprecated GetPartBoundsInBox
|
|
33469
33921
|
*/
|
|
33470
33922
|
FindPartsInRegion3WithIgnoreList(this: WorldRoot, region: Region3, ignoreDescendantsTable: Array<Instance>, maxParts?: number): Array<BasePart>;
|
|
33471
33923
|
/**
|
|
@@ -33483,7 +33935,7 @@ interface WorldRoot extends Model {
|
|
|
33483
33935
|
* @param maxParts The maximum number of `BaseParts` to be returned.
|
|
33484
33936
|
* @returns An array of `BaseParts` within the `Region3`.
|
|
33485
33937
|
*
|
|
33486
|
-
* @deprecated
|
|
33938
|
+
* @deprecated GetPartBoundsInBox
|
|
33487
33939
|
*/
|
|
33488
33940
|
FindPartsInRegion3WithWhiteList(this: WorldRoot, region: Region3, whitelistDescendantsTable: Array<Instance>, maxParts?: number): Array<BasePart>;
|
|
33489
33941
|
/**
|
|
@@ -33541,7 +33993,7 @@ interface WorldRoot extends Model {
|
|
|
33541
33993
|
* @param ignoreDescendentsInstance An `Instance` to be ignored.
|
|
33542
33994
|
* @returns True if the `Region3` is empty.
|
|
33543
33995
|
*
|
|
33544
|
-
* @deprecated
|
|
33996
|
+
* @deprecated GetPartBoundsInBox
|
|
33545
33997
|
*/
|
|
33546
33998
|
IsRegion3Empty(this: WorldRoot, region: Region3, ignoreDescendentsInstance?: Instance): boolean;
|
|
33547
33999
|
/**
|
|
@@ -33558,7 +34010,7 @@ interface WorldRoot extends Model {
|
|
|
33558
34010
|
* @param ignoreDescendentsTable An array of objects to be ignored.
|
|
33559
34011
|
* @returns True if the `Region3` is empty.
|
|
33560
34012
|
*
|
|
33561
|
-
* @deprecated
|
|
34013
|
+
* @deprecated GetPartBoundsInBox
|
|
33562
34014
|
*/
|
|
33563
34015
|
IsRegion3EmptyWithIgnoreList(this: WorldRoot, region: Region3, ignoreDescendentsTable: Array<Instance>): boolean;
|
|
33564
34016
|
/**
|
|
@@ -34529,7 +34981,7 @@ interface ParticleEmitter extends Instance {
|
|
|
34529
34981
|
*
|
|
34530
34982
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#VelocitySpread)
|
|
34531
34983
|
*
|
|
34532
|
-
* @deprecated
|
|
34984
|
+
* @deprecated SpreadAngle
|
|
34533
34985
|
*/
|
|
34534
34986
|
VelocitySpread: number;
|
|
34535
34987
|
/**
|
|
@@ -34567,6 +35019,20 @@ interface ParticleEmitter extends Instance {
|
|
|
34567
35019
|
* @param particleCount The number of particles to emit.
|
|
34568
35020
|
*/
|
|
34569
35021
|
Emit(this: ParticleEmitter, particleCount?: number): void;
|
|
35022
|
+
/**
|
|
35023
|
+
* - **ThreadSafety**: Unsafe
|
|
35024
|
+
* - **Tags**: Hidden
|
|
35025
|
+
*
|
|
35026
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#OnClearRequested)
|
|
35027
|
+
*/
|
|
35028
|
+
readonly OnClearRequested: RBXScriptSignal<() => void>;
|
|
35029
|
+
/**
|
|
35030
|
+
* - **ThreadSafety**: Unsafe
|
|
35031
|
+
* - **Tags**: Hidden
|
|
35032
|
+
*
|
|
35033
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#OnEmitRequested)
|
|
35034
|
+
*/
|
|
35035
|
+
readonly OnEmitRequested: RBXScriptSignal<(particleCount: number) => void>;
|
|
34570
35036
|
}
|
|
34571
35037
|
/**
|
|
34572
35038
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -34667,7 +35133,7 @@ interface Path extends Instance {
|
|
|
34667
35133
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path#GetPointCoordinates)
|
|
34668
35134
|
* @param this Stores the result of paths created by `PathfindingService:CreatePath()`.
|
|
34669
35135
|
*
|
|
34670
|
-
* @deprecated
|
|
35136
|
+
* @deprecated GetWaypoints
|
|
34671
35137
|
*/
|
|
34672
35138
|
GetPointCoordinates(this: Path): Array<unknown>;
|
|
34673
35139
|
/**
|
|
@@ -34851,7 +35317,7 @@ interface PathfindingService extends Instance {
|
|
|
34851
35317
|
* @param maxDistance
|
|
34852
35318
|
* @returns A `Path` object.
|
|
34853
35319
|
*
|
|
34854
|
-
* @deprecated
|
|
35320
|
+
* @deprecated FindPathAsync
|
|
34855
35321
|
*/
|
|
34856
35322
|
ComputeRawPathAsync(this: PathfindingService, start: Vector3, finish: Vector3, maxDistance: number): Path;
|
|
34857
35323
|
/**
|
|
@@ -34868,7 +35334,7 @@ interface PathfindingService extends Instance {
|
|
|
34868
35334
|
* @param finish
|
|
34869
35335
|
* @param maxDistance
|
|
34870
35336
|
*
|
|
34871
|
-
* @deprecated
|
|
35337
|
+
* @deprecated FindPathAsync
|
|
34872
35338
|
*/
|
|
34873
35339
|
ComputeSmoothPathAsync(this: PathfindingService, start: Vector3, finish: Vector3, maxDistance: number): Path;
|
|
34874
35340
|
/**
|
|
@@ -34972,7 +35438,7 @@ interface PhysicsService extends Instance {
|
|
|
34972
35438
|
* @param name
|
|
34973
35439
|
* @param part
|
|
34974
35440
|
*
|
|
34975
|
-
* @deprecated
|
|
35441
|
+
* @deprecated CollisionGroup
|
|
34976
35442
|
*/
|
|
34977
35443
|
CollisionGroupContainsPart(this: PhysicsService, name: string, part: BasePart): boolean;
|
|
34978
35444
|
/**
|
|
@@ -35010,7 +35476,7 @@ interface PhysicsService extends Instance {
|
|
|
35010
35476
|
* @param this
|
|
35011
35477
|
* @param name
|
|
35012
35478
|
*
|
|
35013
|
-
* @deprecated
|
|
35479
|
+
* @deprecated RegisterCollisionGroup
|
|
35014
35480
|
*/
|
|
35015
35481
|
CreateCollisionGroup(this: PhysicsService, name: string): number;
|
|
35016
35482
|
/**
|
|
@@ -35026,7 +35492,7 @@ interface PhysicsService extends Instance {
|
|
|
35026
35492
|
* @param name The name of the collision group being retrieved.
|
|
35027
35493
|
* @returns The ID of the retrieved collision group, or `nil` if no such group exists.
|
|
35028
35494
|
*
|
|
35029
|
-
* @deprecated
|
|
35495
|
+
* @deprecated CollisionGroup
|
|
35030
35496
|
*/
|
|
35031
35497
|
GetCollisionGroupId(this: PhysicsService, name: string): number;
|
|
35032
35498
|
/**
|
|
@@ -35041,7 +35507,7 @@ interface PhysicsService extends Instance {
|
|
|
35041
35507
|
* @param this
|
|
35042
35508
|
* @param name
|
|
35043
35509
|
*
|
|
35044
|
-
* @deprecated
|
|
35510
|
+
* @deprecated CollisionGroup
|
|
35045
35511
|
*/
|
|
35046
35512
|
GetCollisionGroupName(this: PhysicsService, name: number): string;
|
|
35047
35513
|
/**
|
|
@@ -35055,7 +35521,7 @@ interface PhysicsService extends Instance {
|
|
|
35055
35521
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetCollisionGroups)
|
|
35056
35522
|
* @param this
|
|
35057
35523
|
*
|
|
35058
|
-
* @deprecated
|
|
35524
|
+
* @deprecated GetRegisteredCollisionGroups
|
|
35059
35525
|
*/
|
|
35060
35526
|
GetCollisionGroups(this: PhysicsService): Array<CollisionGroupInfo & {
|
|
35061
35527
|
id: number;
|
|
@@ -35110,7 +35576,7 @@ interface PhysicsService extends Instance {
|
|
|
35110
35576
|
* @param this
|
|
35111
35577
|
* @param name
|
|
35112
35578
|
*
|
|
35113
|
-
* @deprecated
|
|
35579
|
+
* @deprecated UnregisterCollisionGroup
|
|
35114
35580
|
*/
|
|
35115
35581
|
RemoveCollisionGroup(this: PhysicsService, name: string): void;
|
|
35116
35582
|
/**
|
|
@@ -35137,7 +35603,7 @@ interface PhysicsService extends Instance {
|
|
|
35137
35603
|
* @param part The part being set.
|
|
35138
35604
|
* @param name The name of collision group that the part's collision group is being set to.
|
|
35139
35605
|
*
|
|
35140
|
-
* @deprecated
|
|
35606
|
+
* @deprecated CollisionGroup
|
|
35141
35607
|
*/
|
|
35142
35608
|
SetPartCollisionGroup(this: PhysicsService, part: BasePart, name: string): void;
|
|
35143
35609
|
/**
|
|
@@ -35328,7 +35794,7 @@ interface Player extends Instance {
|
|
|
35328
35794
|
*
|
|
35329
35795
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#CharacterAppearance)
|
|
35330
35796
|
*
|
|
35331
|
-
* @deprecated
|
|
35797
|
+
* @deprecated CharacterAppearanceId
|
|
35332
35798
|
*/
|
|
35333
35799
|
CharacterAppearance: string;
|
|
35334
35800
|
/**
|
|
@@ -35845,7 +36311,7 @@ interface Player extends Instance {
|
|
|
35845
36311
|
* @param maxFriends The maximum number of online friends to return.
|
|
35846
36312
|
* @returns A dictionary of online friends (see the table above).
|
|
35847
36313
|
*
|
|
35848
|
-
* @deprecated
|
|
36314
|
+
* @deprecated GetFriendsOnlineAsync
|
|
35849
36315
|
*/
|
|
35850
36316
|
GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
|
|
35851
36317
|
/**
|
|
@@ -35882,7 +36348,7 @@ interface Player extends Instance {
|
|
|
35882
36348
|
* @param groupId The `groupId` of the specified group.
|
|
35883
36349
|
* @returns The player's rank in the group.
|
|
35884
36350
|
*
|
|
35885
|
-
* @deprecated
|
|
36351
|
+
* @deprecated GetRankInGroupAsync
|
|
35886
36352
|
*/
|
|
35887
36353
|
GetRankInGroup(this: Player, groupId: number): number;
|
|
35888
36354
|
/**
|
|
@@ -35898,7 +36364,7 @@ interface Player extends Instance {
|
|
|
35898
36364
|
* @param groupId The `groupId` of the specified group.
|
|
35899
36365
|
* @returns The player's rank in the group.
|
|
35900
36366
|
*
|
|
35901
|
-
* @deprecated
|
|
36367
|
+
* @deprecated GetRolesInGroupAsync
|
|
35902
36368
|
*/
|
|
35903
36369
|
GetRankInGroupAsync(this: Player, groupId: number): number;
|
|
35904
36370
|
/**
|
|
@@ -35914,7 +36380,7 @@ interface Player extends Instance {
|
|
|
35914
36380
|
* @param groupId The group ID of the specified group.
|
|
35915
36381
|
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
35916
36382
|
*
|
|
35917
|
-
* @deprecated
|
|
36383
|
+
* @deprecated GetRoleInGroupAsync
|
|
35918
36384
|
*/
|
|
35919
36385
|
GetRoleInGroup(this: Player, groupId: number): string;
|
|
35920
36386
|
/**
|
|
@@ -35930,7 +36396,7 @@ interface Player extends Instance {
|
|
|
35930
36396
|
* @param groupId The group ID of the specified group.
|
|
35931
36397
|
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
35932
36398
|
*
|
|
35933
|
-
* @deprecated
|
|
36399
|
+
* @deprecated GetRolesInGroupAsync
|
|
35934
36400
|
*/
|
|
35935
36401
|
GetRoleInGroupAsync(this: Player, groupId: number): string;
|
|
35936
36402
|
/**
|
|
@@ -35961,7 +36427,7 @@ interface Player extends Instance {
|
|
|
35961
36427
|
* @param userId The `Player.UserId` of the specified player.
|
|
35962
36428
|
* @returns A boolean indicating whether a player is a friend of the specified user.
|
|
35963
36429
|
*
|
|
35964
|
-
* @deprecated
|
|
36430
|
+
* @deprecated IsFriendsWithAsync
|
|
35965
36431
|
*/
|
|
35966
36432
|
IsFriendsWith(this: Player, userId: User): boolean;
|
|
35967
36433
|
/**
|
|
@@ -35989,7 +36455,7 @@ interface Player extends Instance {
|
|
|
35989
36455
|
* @param groupId The group ID of the specified group.
|
|
35990
36456
|
* @returns A boolean indicating whether the player is in the specified group.
|
|
35991
36457
|
*
|
|
35992
|
-
* @deprecated
|
|
36458
|
+
* @deprecated IsInGroupAsync
|
|
35993
36459
|
*/
|
|
35994
36460
|
IsInGroup(this: Player, groupId: number): boolean;
|
|
35995
36461
|
/**
|
|
@@ -36015,7 +36481,7 @@ interface Player extends Instance {
|
|
|
36015
36481
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacter)
|
|
36016
36482
|
* @param this An object that represents a presently connected client to the experience.
|
|
36017
36483
|
*
|
|
36018
|
-
* @deprecated
|
|
36484
|
+
* @deprecated LoadCharacterAsync
|
|
36019
36485
|
*/
|
|
36020
36486
|
LoadCharacter(this: Player): void;
|
|
36021
36487
|
/**
|
|
@@ -36041,7 +36507,7 @@ interface Player extends Instance {
|
|
|
36041
36507
|
* @param humanoidDescription A `HumanoidDescription` containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character.
|
|
36042
36508
|
* @param assetTypeVerification The asset type verification mode.
|
|
36043
36509
|
*
|
|
36044
|
-
* @deprecated
|
|
36510
|
+
* @deprecated LoadCharacterWithHumanoidDescriptionAsync
|
|
36045
36511
|
*/
|
|
36046
36512
|
LoadCharacterWithHumanoidDescription(this: Player, humanoidDescription: HumanoidDescription): void;
|
|
36047
36513
|
/**
|
|
@@ -36582,7 +37048,7 @@ interface Players extends Instance {
|
|
|
36582
37048
|
*
|
|
36583
37049
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#NumPlayers)
|
|
36584
37050
|
*
|
|
36585
|
-
* @deprecated
|
|
37051
|
+
* @deprecated GetPlayers
|
|
36586
37052
|
*/
|
|
36587
37053
|
readonly NumPlayers: number;
|
|
36588
37054
|
/**
|
|
@@ -36664,7 +37130,7 @@ interface Players extends Instance {
|
|
|
36664
37130
|
* @param assetTypeVerification The asset type verification mode.
|
|
36665
37131
|
* @returns A `Humanoid` character `Model`.
|
|
36666
37132
|
*
|
|
36667
|
-
* @deprecated
|
|
37133
|
+
* @deprecated CreateHumanoidModelFromDescriptionAsync
|
|
36668
37134
|
*/
|
|
36669
37135
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
36670
37136
|
/**
|
|
@@ -36694,7 +37160,7 @@ interface Players extends Instance {
|
|
|
36694
37160
|
* @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
|
|
36695
37161
|
* @returns A Humanoid character Model.
|
|
36696
37162
|
*
|
|
36697
|
-
* @deprecated
|
|
37163
|
+
* @deprecated CreateHumanoidModelFromUserIdAsync
|
|
36698
37164
|
*/
|
|
36699
37165
|
CreateHumanoidModelFromUserId(this: Players, userId: User): Model;
|
|
36700
37166
|
/**
|
|
@@ -36772,7 +37238,7 @@ interface Players extends Instance {
|
|
|
36772
37238
|
* @param outfitId The ID of the outfit for which the HumanoidDescription is sought.
|
|
36773
37239
|
* @returns HumanoidDescription initialized with the specification for the passed in outfitId.
|
|
36774
37240
|
*
|
|
36775
|
-
* @deprecated
|
|
37241
|
+
* @deprecated GetHumanoidDescriptionFromOutfitIdAsync
|
|
36776
37242
|
*/
|
|
36777
37243
|
GetHumanoidDescriptionFromOutfitId(this: Players, outfitId: number): HumanoidDescription;
|
|
36778
37244
|
/**
|
|
@@ -36800,7 +37266,7 @@ interface Players extends Instance {
|
|
|
36800
37266
|
* @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
|
|
36801
37267
|
* @returns HumanoidDescription initialized with the passed in user's avatar specification.
|
|
36802
37268
|
*
|
|
36803
|
-
* @deprecated
|
|
37269
|
+
* @deprecated GetHumanoidDescriptionFromUserIdAsync
|
|
36804
37270
|
*/
|
|
36805
37271
|
GetHumanoidDescriptionFromUserId(this: Players, userId: User): HumanoidDescription;
|
|
36806
37272
|
/**
|
|
@@ -37031,6 +37497,21 @@ interface PolicyService extends Instance {
|
|
|
37031
37497
|
*/
|
|
37032
37498
|
GetPolicyInfoForPlayerAsync(this: PolicyService, player: Player): PolicyInfo;
|
|
37033
37499
|
}
|
|
37500
|
+
/**
|
|
37501
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
37502
|
+
*
|
|
37503
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PopLatencyService)
|
|
37504
|
+
*/
|
|
37505
|
+
interface PopLatencyService extends Instance {
|
|
37506
|
+
/**
|
|
37507
|
+
* **DO NOT USE!**
|
|
37508
|
+
*
|
|
37509
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
37510
|
+
* @hidden
|
|
37511
|
+
* @deprecated
|
|
37512
|
+
*/
|
|
37513
|
+
readonly _nominal_PopLatencyService: unique symbol;
|
|
37514
|
+
}
|
|
37034
37515
|
/**
|
|
37035
37516
|
* Base class of all 'Pose Instance' objects.
|
|
37036
37517
|
*
|
|
@@ -37836,6 +38317,13 @@ interface RealtimeMedia extends Instance {
|
|
|
37836
38317
|
* @deprecated
|
|
37837
38318
|
*/
|
|
37838
38319
|
readonly _nominal_RealtimeMedia: unique symbol;
|
|
38320
|
+
/**
|
|
38321
|
+
* - **ThreadSafety**: ReadSafe
|
|
38322
|
+
* - **Tags**: NotReplicated
|
|
38323
|
+
*
|
|
38324
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#AudioInputActive)
|
|
38325
|
+
*/
|
|
38326
|
+
readonly AudioInputActive: boolean;
|
|
37839
38327
|
/**
|
|
37840
38328
|
* - **ThreadSafety**: ReadSafe
|
|
37841
38329
|
* - **Tags**: NotReplicated
|
|
@@ -38213,6 +38701,34 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
|
|
|
38213
38701
|
* @returns Values returned from the `OnServerInvoke` callback.
|
|
38214
38702
|
*/
|
|
38215
38703
|
InvokeServer(this: RemoteFunction, ...args: Parameters<T>): ReturnType<T>;
|
|
38704
|
+
/**
|
|
38705
|
+
* - **ThreadSafety**: Unsafe
|
|
38706
|
+
* - **Tags**: Hidden
|
|
38707
|
+
*
|
|
38708
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeClient)
|
|
38709
|
+
*/
|
|
38710
|
+
readonly RemoteOnInvokeClient: RBXScriptSignal<(id: number, arguments: unknown) => void>;
|
|
38711
|
+
/**
|
|
38712
|
+
* - **ThreadSafety**: Unsafe
|
|
38713
|
+
* - **Tags**: Hidden
|
|
38714
|
+
*
|
|
38715
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeError)
|
|
38716
|
+
*/
|
|
38717
|
+
readonly RemoteOnInvokeError: RBXScriptSignal<(id: number, arguments: string) => void>;
|
|
38718
|
+
/**
|
|
38719
|
+
* - **ThreadSafety**: Unsafe
|
|
38720
|
+
* - **Tags**: Hidden
|
|
38721
|
+
*
|
|
38722
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeServer)
|
|
38723
|
+
*/
|
|
38724
|
+
readonly RemoteOnInvokeServer: RBXScriptSignal<(id: number, player: Player, arguments: unknown) => void>;
|
|
38725
|
+
/**
|
|
38726
|
+
* - **ThreadSafety**: Unsafe
|
|
38727
|
+
* - **Tags**: Hidden
|
|
38728
|
+
*
|
|
38729
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeSuccess)
|
|
38730
|
+
*/
|
|
38731
|
+
readonly RemoteOnInvokeSuccess: RBXScriptSignal<(id: number, arguments: unknown) => void>;
|
|
38216
38732
|
/**
|
|
38217
38733
|
* Callback for when the `RemoteFunction` is invoked with `InvokeClient()`.
|
|
38218
38734
|
*
|
|
@@ -38730,12 +39246,6 @@ interface RuntimeContentService extends Instance {
|
|
|
38730
39246
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentFail)
|
|
38731
39247
|
*/
|
|
38732
39248
|
readonly RuntimeContentFail: RBXScriptSignal<(id: string) => void>;
|
|
38733
|
-
/**
|
|
38734
|
-
* - **ThreadSafety**: Unsafe
|
|
38735
|
-
*
|
|
38736
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentLRCleanup)
|
|
38737
|
-
*/
|
|
38738
|
-
readonly RuntimeContentLRCleanup: RBXScriptSignal<(id: string, priorityList: string) => void>;
|
|
38739
39249
|
/**
|
|
38740
39250
|
* - **ThreadSafety**: Unsafe
|
|
38741
39251
|
*
|
|
@@ -39008,7 +39518,7 @@ interface SyncScriptBuilder extends ScriptBuilder {
|
|
|
39008
39518
|
*
|
|
39009
39519
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SyncScriptBuilder#RawBytecode)
|
|
39010
39520
|
*
|
|
39011
|
-
* @deprecated
|
|
39521
|
+
* @deprecated CompileTarget
|
|
39012
39522
|
*/
|
|
39013
39523
|
RawBytecode: boolean;
|
|
39014
39524
|
}
|
|
@@ -39708,7 +40218,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39708
40218
|
*
|
|
39709
40219
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#VIPServerId)
|
|
39710
40220
|
*
|
|
39711
|
-
* @deprecated
|
|
40221
|
+
* @deprecated PrivateServerId
|
|
39712
40222
|
*/
|
|
39713
40223
|
readonly VIPServerId: string;
|
|
39714
40224
|
/**
|
|
@@ -39721,7 +40231,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39721
40231
|
*
|
|
39722
40232
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#VIPServerOwnerId)
|
|
39723
40233
|
*
|
|
39724
|
-
* @deprecated
|
|
40234
|
+
* @deprecated PrivateServerOwnerId
|
|
39725
40235
|
*/
|
|
39726
40236
|
readonly VIPServerOwnerId: number;
|
|
39727
40237
|
/**
|
|
@@ -39878,7 +40388,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39878
40388
|
*
|
|
39879
40389
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#OnClose)
|
|
39880
40390
|
*
|
|
39881
|
-
* @deprecated
|
|
40391
|
+
* @deprecated BindToClose
|
|
39882
40392
|
*/
|
|
39883
40393
|
OnClose: (() => unknown) | undefined;
|
|
39884
40394
|
}
|
|
@@ -40506,7 +41016,7 @@ interface SocialService extends Instance {
|
|
|
40506
41016
|
*/
|
|
40507
41017
|
GetUpcomingExperienceEventsAsync(this: SocialService): Array<unknown>;
|
|
40508
41018
|
/**
|
|
40509
|
-
* Prompts the player to submit feedback about the current experience.
|
|
41019
|
+
* Prompts the player to submit feedback or a player support ticket about the current experience.
|
|
40510
41020
|
*
|
|
40511
41021
|
* - **ThreadSafety**: Unsafe
|
|
40512
41022
|
* - **Tags**: Yields
|
|
@@ -40535,7 +41045,7 @@ interface SocialService extends Instance {
|
|
|
40535
41045
|
*
|
|
40536
41046
|
* @returns A tuple containing an `PromptLinkSharingResult` indicating the result of the link sharing prompt.
|
|
40537
41047
|
*
|
|
40538
|
-
* @deprecated
|
|
41048
|
+
* @deprecated PromptLinkSharingAsync
|
|
40539
41049
|
*/
|
|
40540
41050
|
PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
|
|
40541
41051
|
/**
|
|
@@ -40649,7 +41159,7 @@ interface Sound extends Instance {
|
|
|
40649
41159
|
*
|
|
40650
41160
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#EmitterSize)
|
|
40651
41161
|
*
|
|
40652
|
-
* @deprecated
|
|
41162
|
+
* @deprecated RollOffMinDistance
|
|
40653
41163
|
*/
|
|
40654
41164
|
EmitterSize: number;
|
|
40655
41165
|
/**
|
|
@@ -40705,7 +41215,7 @@ interface Sound extends Instance {
|
|
|
40705
41215
|
*
|
|
40706
41216
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#MaxDistance)
|
|
40707
41217
|
*
|
|
40708
|
-
* @deprecated
|
|
41218
|
+
* @deprecated RollOffMaxDistance
|
|
40709
41219
|
*/
|
|
40710
41220
|
MaxDistance: number;
|
|
40711
41221
|
/**
|
|
@@ -40718,7 +41228,7 @@ interface Sound extends Instance {
|
|
|
40718
41228
|
*
|
|
40719
41229
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#MinDistance)
|
|
40720
41230
|
*
|
|
40721
|
-
* @deprecated
|
|
41231
|
+
* @deprecated RollOffMinDistance
|
|
40722
41232
|
*/
|
|
40723
41233
|
MinDistance: number;
|
|
40724
41234
|
/**
|
|
@@ -40731,7 +41241,7 @@ interface Sound extends Instance {
|
|
|
40731
41241
|
*
|
|
40732
41242
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#Pitch)
|
|
40733
41243
|
*
|
|
40734
|
-
* @deprecated
|
|
41244
|
+
* @deprecated PlaybackSpeed
|
|
40735
41245
|
*/
|
|
40736
41246
|
Pitch: number;
|
|
40737
41247
|
/**
|
|
@@ -43508,7 +44018,7 @@ interface TeleportService extends Instance {
|
|
|
43508
44018
|
* @param placeId The `DataModel.PlaceId` of the place the reserved server is being created for.
|
|
43509
44019
|
* @returns The server access code required by `TeleportService:TeleportToPrivateServer()` and the `DataModel.PrivateServerId` for the reserved server.
|
|
43510
44020
|
*
|
|
43511
|
-
* @deprecated
|
|
44021
|
+
* @deprecated ReserveServerAsync
|
|
43512
44022
|
*/
|
|
43513
44023
|
ReserveServer(this: TeleportService, placeId: number): LuaTuple<[
|
|
43514
44024
|
string,
|
|
@@ -43790,7 +44300,7 @@ interface TestService extends Instance {
|
|
|
43790
44300
|
*
|
|
43791
44301
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Is30FpsThrottleEnabled)
|
|
43792
44302
|
*
|
|
43793
|
-
* @deprecated
|
|
44303
|
+
* @deprecated ThrottlePhysicsToRealtime
|
|
43794
44304
|
*/
|
|
43795
44305
|
Is30FpsThrottleEnabled: boolean;
|
|
43796
44306
|
/**
|
|
@@ -45867,6 +46377,13 @@ interface Trail extends Instance {
|
|
|
45867
46377
|
* @param this Used to create a trail effect between two attachments.
|
|
45868
46378
|
*/
|
|
45869
46379
|
Clear(this: Trail): void;
|
|
46380
|
+
/**
|
|
46381
|
+
* - **ThreadSafety**: Unsafe
|
|
46382
|
+
* - **Tags**: Hidden
|
|
46383
|
+
*
|
|
46384
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Trail#OnClearRequested)
|
|
46385
|
+
*/
|
|
46386
|
+
readonly OnClearRequested: RBXScriptSignal<() => void>;
|
|
45870
46387
|
}
|
|
45871
46388
|
/**
|
|
45872
46389
|
* The role of a Translator is to manufacture/return strings localized for the viewing player.
|
|
@@ -47673,7 +48190,7 @@ interface UserInputService extends Instance {
|
|
|
47673
48190
|
*
|
|
47674
48191
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#ModalEnabled)
|
|
47675
48192
|
*
|
|
47676
|
-
* @deprecated
|
|
48193
|
+
* @deprecated TouchControlsEnabled
|
|
47677
48194
|
*/
|
|
47678
48195
|
ModalEnabled: boolean;
|
|
47679
48196
|
/**
|