@rbxts/types 1.0.937 → 1.0.939
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 +789 -187
- package/include/generated/PluginSecurity.d.ts +191 -34
- package/include/generated/enums.d.ts +135 -19
- 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,9 +63,11 @@ 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;
|
|
70
|
+
EditorSourceService: EditorSourceService;
|
|
67
71
|
EncodingService: EncodingService;
|
|
68
72
|
EventIngestService: EventIngestService;
|
|
69
73
|
ExampleV2Service: ExampleV2Service;
|
|
@@ -103,6 +107,7 @@ interface Services {
|
|
|
103
107
|
InstanceFileSyncService: InstanceFileSyncService;
|
|
104
108
|
InternalMessagingService: InternalMessagingService;
|
|
105
109
|
InternalMessagingServiceVerifier: InternalMessagingServiceVerifier;
|
|
110
|
+
InternalSyncService: InternalSyncService;
|
|
106
111
|
IXPService: IXPService;
|
|
107
112
|
JointsService: JointsService;
|
|
108
113
|
KeyframeSequenceProvider: KeyframeSequenceProvider;
|
|
@@ -152,6 +157,7 @@ interface Services {
|
|
|
152
157
|
PluginManagementService: PluginManagementService;
|
|
153
158
|
PluginPolicyService: PluginPolicyService;
|
|
154
159
|
PolicyService: PolicyService;
|
|
160
|
+
PopLatencyService: PopLatencyService;
|
|
155
161
|
Preloaded: Preloaded;
|
|
156
162
|
ProceduralBehaviorSchedulerService: ProceduralBehaviorSchedulerService;
|
|
157
163
|
ProcessInstancePhysicsService: ProcessInstancePhysicsService;
|
|
@@ -306,6 +312,7 @@ interface CreatableInstances {
|
|
|
306
312
|
AudioSpeechToText: AudioSpeechToText;
|
|
307
313
|
AudioTextToSpeech: AudioTextToSpeech;
|
|
308
314
|
AudioTremolo: AudioTremolo;
|
|
315
|
+
AuroraScript: AuroraScript;
|
|
309
316
|
AvatarAbilityRules: AvatarAbilityRules;
|
|
310
317
|
AvatarAccessoryRules: AvatarAccessoryRules;
|
|
311
318
|
AvatarAnimationRules: AvatarAnimationRules;
|
|
@@ -412,6 +419,7 @@ interface CreatableInstances {
|
|
|
412
419
|
InputBinding: InputBinding;
|
|
413
420
|
InputContext: InputContext;
|
|
414
421
|
IntConstrainedValue: IntConstrainedValue;
|
|
422
|
+
InternalSyncItem: InternalSyncItem;
|
|
415
423
|
IntersectOperation: IntersectOperation;
|
|
416
424
|
IntValue: IntValue;
|
|
417
425
|
Keyframe: Keyframe;
|
|
@@ -627,6 +635,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
627
635
|
DebuggerConnection: DebuggerConnection;
|
|
628
636
|
DebuggerLuaResponse: DebuggerLuaResponse;
|
|
629
637
|
DebuggerVariable: DebuggerVariable;
|
|
638
|
+
DisplayWakeLock: DisplayWakeLock;
|
|
630
639
|
DynamicRotate: DynamicRotate;
|
|
631
640
|
ExplorerFilterAutocompleter: ExplorerFilterAutocompleter;
|
|
632
641
|
FaceInstance: FaceInstance;
|
|
@@ -2532,7 +2541,7 @@ interface Instance extends RBXObject {
|
|
|
2532
2541
|
* @param selector Selector string used to filter elements.
|
|
2533
2542
|
* @returns An array of instances (empty if nothing matched the selector).
|
|
2534
2543
|
*/
|
|
2535
|
-
QueryDescendants(this: Instance, selector:
|
|
2544
|
+
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
2545
|
/**
|
|
2537
2546
|
* Removes a tag from the instance.
|
|
2538
2547
|
*
|
|
@@ -2911,7 +2920,7 @@ interface AdPortal extends Instance {
|
|
|
2911
2920
|
readonly Status: Enum.AdUnitStatus;
|
|
2912
2921
|
}
|
|
2913
2922
|
/**
|
|
2914
|
-
*
|
|
2923
|
+
* The service responsible for in-experience advertising.
|
|
2915
2924
|
*
|
|
2916
2925
|
* - **Tags**: NotCreatable, Service
|
|
2917
2926
|
*
|
|
@@ -2927,22 +2936,24 @@ interface AdService extends Instance {
|
|
|
2927
2936
|
*/
|
|
2928
2937
|
readonly _nominal_AdService: unique symbol;
|
|
2929
2938
|
/**
|
|
2930
|
-
* Creates
|
|
2939
|
+
* Creates an `AdReward` to give users who watch a video ad.
|
|
2931
2940
|
*
|
|
2932
2941
|
* - **ThreadSafety**: Unsafe
|
|
2933
2942
|
*
|
|
2934
2943
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#CreateAdRewardFromDevProductId)
|
|
2935
|
-
* @param this
|
|
2944
|
+
* @param this The service responsible for in-experience advertising.
|
|
2936
2945
|
* @param devProductId The ID of the developer product you want to grant as a reward.
|
|
2937
2946
|
*/
|
|
2938
2947
|
CreateAdRewardFromDevProductId(this: AdService, devProductId: number): AdReward;
|
|
2939
2948
|
/**
|
|
2949
|
+
* Registers an ad disclosure button for an [ad integration](../../../production/promotion/ad-integrations.md).
|
|
2950
|
+
*
|
|
2940
2951
|
* - **ThreadSafety**: Unsafe
|
|
2941
2952
|
*
|
|
2942
2953
|
* [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
|
|
2954
|
+
* @param this The service responsible for in-experience advertising.
|
|
2955
|
+
* @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).
|
|
2956
|
+
* @param adIntegrationPlacementId The ID of the placement that this disclosure is attached to.
|
|
2946
2957
|
*/
|
|
2947
2958
|
RegisterDisclosureButton(this: AdService, disclosureButton: GuiButton, adIntegrationPlacementId: string): void;
|
|
2948
2959
|
/**
|
|
@@ -2954,7 +2965,7 @@ interface AdService extends Instance {
|
|
|
2954
2965
|
* - **Tags**:
|
|
2955
2966
|
*
|
|
2956
2967
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#ShowVideoAd)
|
|
2957
|
-
* @param this
|
|
2968
|
+
* @param this The service responsible for in-experience advertising.
|
|
2958
2969
|
*
|
|
2959
2970
|
* @deprecated
|
|
2960
2971
|
*/
|
|
@@ -2963,30 +2974,32 @@ interface AdService extends Instance {
|
|
|
2963
2974
|
* - **ThreadSafety**: Unsafe
|
|
2964
2975
|
*
|
|
2965
2976
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#UnregisterAdOpportunity)
|
|
2966
|
-
* @param this
|
|
2977
|
+
* @param this The service responsible for in-experience advertising.
|
|
2967
2978
|
* @param instance
|
|
2968
2979
|
*/
|
|
2969
2980
|
UnregisterAdOpportunity(this: AdService, instance: Instance): void;
|
|
2970
2981
|
/**
|
|
2971
|
-
* Checks if
|
|
2982
|
+
* Checks if an ad with the specified format is available to be shown to the `LocalPlayer`.
|
|
2972
2983
|
*
|
|
2973
2984
|
* - **ThreadSafety**: Unsafe
|
|
2974
2985
|
* - **Tags**: Yields
|
|
2975
2986
|
*
|
|
2976
2987
|
* [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
|
|
2988
|
+
* @param this The service responsible for in-experience advertising.
|
|
2989
|
+
* @param adFormat The format of the requested ad. For example, `AdFormat.RewardedVideo`.
|
|
2990
|
+
* @returns A dictionary that looks like `{ AdAvailabilityResult: Enum.AdAvailabilityResult }`.
|
|
2980
2991
|
*/
|
|
2981
2992
|
GetAdAvailabilityNowAsync(this: AdService, adFormat: CastsToEnum<Enum.AdFormat>): object;
|
|
2982
2993
|
/**
|
|
2994
|
+
* Checks a `Player`'s eligibility to be shown an [ad integration](../../../production/promotion/ad-integrations.md) campaign.
|
|
2995
|
+
*
|
|
2983
2996
|
* - **ThreadSafety**: Unsafe
|
|
2984
2997
|
* - **Tags**: Yields
|
|
2985
2998
|
*
|
|
2986
2999
|
* [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`.
|
|
3000
|
+
* @param this The service responsible for in-experience advertising.
|
|
3001
|
+
* @param campaignId The ID of the campaign that you want to check a `Player`'s eligibility for.
|
|
3002
|
+
* @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
3003
|
* @returns A dictionary that looks like `{ IsEligible: boolean }`.
|
|
2991
3004
|
*/
|
|
2992
3005
|
GetCampaignEligibilityAsync(this: AdService, campaignId: string, player?: Player): object;
|
|
@@ -2997,7 +3010,7 @@ interface AdService extends Instance {
|
|
|
2997
3010
|
* - **Tags**: Yields
|
|
2998
3011
|
*
|
|
2999
3012
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterAdOpportunityAsync)
|
|
3000
|
-
* @param this
|
|
3013
|
+
* @param this The service responsible for in-experience advertising.
|
|
3001
3014
|
* @param instance
|
|
3002
3015
|
* @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
3016
|
*/
|
|
@@ -3009,10 +3022,11 @@ interface AdService extends Instance {
|
|
|
3009
3022
|
* - **Tags**: Yields
|
|
3010
3023
|
*
|
|
3011
3024
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#ShowRewardedVideoAdAsync)
|
|
3012
|
-
* @param this
|
|
3013
|
-
* @param player The `Player`
|
|
3014
|
-
* @param reward The
|
|
3025
|
+
* @param this The service responsible for in-experience advertising.
|
|
3026
|
+
* @param player The `Player` to trigger a rewarded video ad play for.
|
|
3027
|
+
* @param reward The `AdReward` to grant the user after they view the ad.
|
|
3015
3028
|
* @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.
|
|
3029
|
+
* @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
3030
|
*/
|
|
3017
3031
|
ShowRewardedVideoAdAsync(this: AdService, player: Player, reward: AdReward, placementId?: number): Enum.ShowAdResult;
|
|
3018
3032
|
/**
|
|
@@ -3081,7 +3095,7 @@ interface AnalyticsService extends Instance {
|
|
|
3081
3095
|
/**
|
|
3082
3096
|
* **Deprecated:** This deprecated function is a variant of `AnalyticsService:LogEconomyEvent()` which should be used instead.
|
|
3083
3097
|
*
|
|
3084
|
-
* Fire an event used to track player actions pertaining to the in-game
|
|
3098
|
+
* Fire an event used to track player actions pertaining to the in-game
|
|
3085
3099
|
*
|
|
3086
3100
|
* - **ThreadSafety**: Unsafe
|
|
3087
3101
|
* - **Tags**:
|
|
@@ -3202,6 +3216,12 @@ interface AnalyticsService extends Instance {
|
|
|
3202
3216
|
* @param customFields Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by `AnalyticsCustomFieldKeys`, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience.
|
|
3203
3217
|
*/
|
|
3204
3218
|
LogFunnelStepEvent(this: AnalyticsService, player: Player, funnelName: string, funnelSessionId?: string, step?: number, stepName?: string, customFields?: object): void;
|
|
3219
|
+
/**
|
|
3220
|
+
* - **ThreadSafety**: Unsafe
|
|
3221
|
+
*
|
|
3222
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#LogJourneyEvent)
|
|
3223
|
+
*/
|
|
3224
|
+
LogJourneyEvent(this: AnalyticsService, player: Player, journeyName: string, nodeName: string, journeySessionId?: string, customFields?: object): void;
|
|
3205
3225
|
/**
|
|
3206
3226
|
* Logs an event used to track user actions stepping through an onboarding funnel.
|
|
3207
3227
|
*
|
|
@@ -3492,7 +3512,7 @@ interface AnimationClipProvider extends Instance {
|
|
|
3492
3512
|
* @param userId The user ID of the user.
|
|
3493
3513
|
* @returns An `InventoryPages` of animations.
|
|
3494
3514
|
*
|
|
3495
|
-
* @deprecated
|
|
3515
|
+
* @deprecated GetAnimationsAsync
|
|
3496
3516
|
*/
|
|
3497
3517
|
GetAnimations(this: AnimationClipProvider, userId: User): Instance | undefined;
|
|
3498
3518
|
/**
|
|
@@ -4479,7 +4499,7 @@ interface AssetService extends Instance {
|
|
|
4479
4499
|
* @param packageAssetId
|
|
4480
4500
|
* @returns Asset IDs that are contained in a specified package.
|
|
4481
4501
|
*
|
|
4482
|
-
* @deprecated
|
|
4502
|
+
* @deprecated GetAssetIdsForPackageAsync
|
|
4483
4503
|
*/
|
|
4484
4504
|
GetAssetIdsForPackage(this: AssetService, packageAssetId: number): Array<number>;
|
|
4485
4505
|
/**
|
|
@@ -4545,7 +4565,7 @@ interface AssetService extends Instance {
|
|
|
4545
4565
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4546
4566
|
* @param creationID
|
|
4547
4567
|
*
|
|
4548
|
-
* @deprecated
|
|
4568
|
+
* @deprecated GetProductInfo
|
|
4549
4569
|
*/
|
|
4550
4570
|
GetCreatorAssetID(this: AssetService, creationID: number): number;
|
|
4551
4571
|
/**
|
|
@@ -4620,7 +4640,7 @@ interface AssetService extends Instance {
|
|
|
4620
4640
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4621
4641
|
* @param searchParameters
|
|
4622
4642
|
*
|
|
4623
|
-
* @deprecated
|
|
4643
|
+
* @deprecated SearchAudioAsync
|
|
4624
4644
|
*/
|
|
4625
4645
|
SearchAudio(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
|
|
4626
4646
|
/**
|
|
@@ -4757,7 +4777,7 @@ interface Attachment extends Instance {
|
|
|
4757
4777
|
*
|
|
4758
4778
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#Rotation)
|
|
4759
4779
|
*
|
|
4760
|
-
* @deprecated
|
|
4780
|
+
* @deprecated Orientation
|
|
4761
4781
|
*/
|
|
4762
4782
|
Rotation: Vector3;
|
|
4763
4783
|
/**
|
|
@@ -4823,7 +4843,7 @@ interface Attachment extends Instance {
|
|
|
4823
4843
|
*
|
|
4824
4844
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#WorldRotation)
|
|
4825
4845
|
*
|
|
4826
|
-
* @deprecated
|
|
4846
|
+
* @deprecated WorldOrientation
|
|
4827
4847
|
*/
|
|
4828
4848
|
readonly WorldRotation: Vector3;
|
|
4829
4849
|
/**
|
|
@@ -4846,7 +4866,7 @@ interface Attachment extends Instance {
|
|
|
4846
4866
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetAxis)
|
|
4847
4867
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4848
4868
|
*
|
|
4849
|
-
* @deprecated
|
|
4869
|
+
* @deprecated Axis
|
|
4850
4870
|
*/
|
|
4851
4871
|
GetAxis(this: Attachment): Vector3;
|
|
4852
4872
|
/**
|
|
@@ -4869,7 +4889,7 @@ interface Attachment extends Instance {
|
|
|
4869
4889
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetSecondaryAxis)
|
|
4870
4890
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4871
4891
|
*
|
|
4872
|
-
* @deprecated
|
|
4892
|
+
* @deprecated SecondaryAxis
|
|
4873
4893
|
*/
|
|
4874
4894
|
GetSecondaryAxis(this: Attachment): Vector3;
|
|
4875
4895
|
/**
|
|
@@ -4884,7 +4904,7 @@ interface Attachment extends Instance {
|
|
|
4884
4904
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4885
4905
|
* @param axis
|
|
4886
4906
|
*
|
|
4887
|
-
* @deprecated
|
|
4907
|
+
* @deprecated Axis
|
|
4888
4908
|
*/
|
|
4889
4909
|
SetAxis(this: Attachment, axis: Vector3): void;
|
|
4890
4910
|
/**
|
|
@@ -4899,7 +4919,7 @@ interface Attachment extends Instance {
|
|
|
4899
4919
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4900
4920
|
* @param axis
|
|
4901
4921
|
*
|
|
4902
|
-
* @deprecated
|
|
4922
|
+
* @deprecated SecondaryAxis
|
|
4903
4923
|
*/
|
|
4904
4924
|
SetSecondaryAxis(this: Attachment, axis: Vector3): void;
|
|
4905
4925
|
}
|
|
@@ -5777,7 +5797,7 @@ interface AudioEmitter extends Instance {
|
|
|
5777
5797
|
*
|
|
5778
5798
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#SimulationFidelity)
|
|
5779
5799
|
*
|
|
5780
|
-
* @deprecated
|
|
5800
|
+
* @deprecated AcousticSimulationEnabled
|
|
5781
5801
|
*/
|
|
5782
5802
|
SimulationFidelity: Enum.AudioSimulationFidelity;
|
|
5783
5803
|
/**
|
|
@@ -6490,7 +6510,7 @@ interface AudioListener extends Instance {
|
|
|
6490
6510
|
*
|
|
6491
6511
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#SimulationFidelity)
|
|
6492
6512
|
*
|
|
6493
|
-
* @deprecated
|
|
6513
|
+
* @deprecated AcousticSimulationEnabled
|
|
6494
6514
|
*/
|
|
6495
6515
|
SimulationFidelity: Enum.AudioSimulationFidelity;
|
|
6496
6516
|
/**
|
|
@@ -6705,7 +6725,7 @@ interface AudioPlayer extends Instance {
|
|
|
6705
6725
|
*
|
|
6706
6726
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AssetId)
|
|
6707
6727
|
*
|
|
6708
|
-
* @deprecated
|
|
6728
|
+
* @deprecated Asset
|
|
6709
6729
|
*/
|
|
6710
6730
|
AssetId: string;
|
|
6711
6731
|
/**
|
|
@@ -7250,7 +7270,7 @@ interface AudioSearchParams extends Instance {
|
|
|
7250
7270
|
*
|
|
7251
7271
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#AudioSubtype)
|
|
7252
7272
|
*
|
|
7253
|
-
* @deprecated
|
|
7273
|
+
* @deprecated AudioSubType
|
|
7254
7274
|
*/
|
|
7255
7275
|
AudioSubtype: Enum.AudioSubType;
|
|
7256
7276
|
/**
|
|
@@ -7344,6 +7364,18 @@ interface AudioSpeechToText extends Instance {
|
|
|
7344
7364
|
* @returns An array of `Wires`
|
|
7345
7365
|
*/
|
|
7346
7366
|
GetConnectedWires(this: AudioSpeechToText, pin: string): Array<Instance>;
|
|
7367
|
+
/**
|
|
7368
|
+
* - **ThreadSafety**: Unsafe
|
|
7369
|
+
*
|
|
7370
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetInputPins)
|
|
7371
|
+
*/
|
|
7372
|
+
GetInputPins(this: AudioSpeechToText): Array<unknown>;
|
|
7373
|
+
/**
|
|
7374
|
+
* - **ThreadSafety**: Unsafe
|
|
7375
|
+
*
|
|
7376
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetOutputPins)
|
|
7377
|
+
*/
|
|
7378
|
+
GetOutputPins(this: AudioSpeechToText): Array<unknown>;
|
|
7347
7379
|
/**
|
|
7348
7380
|
* Fires when another instance is connected to or disconnected from the `AudioSpeechToText` via a `Wire`.
|
|
7349
7381
|
*
|
|
@@ -7468,6 +7500,18 @@ interface AudioTextToSpeech extends Instance {
|
|
|
7468
7500
|
* @returns An array of `Wires`
|
|
7469
7501
|
*/
|
|
7470
7502
|
GetConnectedWires(this: AudioTextToSpeech, pin: string): Array<Instance>;
|
|
7503
|
+
/**
|
|
7504
|
+
* - **ThreadSafety**: Unsafe
|
|
7505
|
+
*
|
|
7506
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetInputPins)
|
|
7507
|
+
*/
|
|
7508
|
+
GetInputPins(this: AudioTextToSpeech): Array<unknown>;
|
|
7509
|
+
/**
|
|
7510
|
+
* - **ThreadSafety**: Unsafe
|
|
7511
|
+
*
|
|
7512
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetOutputPins)
|
|
7513
|
+
*/
|
|
7514
|
+
GetOutputPins(this: AudioTextToSpeech): Array<unknown>;
|
|
7471
7515
|
/**
|
|
7472
7516
|
* Pauses the `AudioTextToSpeech` object wherever its `TimePosition` is.
|
|
7473
7517
|
*
|
|
@@ -7688,6 +7732,216 @@ interface AuroraScriptObject extends Instance {
|
|
|
7688
7732
|
*/
|
|
7689
7733
|
PriorFrameInvoked: number;
|
|
7690
7734
|
}
|
|
7735
|
+
/**
|
|
7736
|
+
* - **Tags**: NotCreatable, Service
|
|
7737
|
+
*
|
|
7738
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService)
|
|
7739
|
+
*
|
|
7740
|
+
* @deprecated
|
|
7741
|
+
*/
|
|
7742
|
+
interface AuroraScriptService extends Instance {
|
|
7743
|
+
/**
|
|
7744
|
+
* **DO NOT USE!**
|
|
7745
|
+
*
|
|
7746
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
7747
|
+
* @hidden
|
|
7748
|
+
* @deprecated
|
|
7749
|
+
*/
|
|
7750
|
+
readonly _nominal_AuroraScriptService: unique symbol;
|
|
7751
|
+
/**
|
|
7752
|
+
* - **ThreadSafety**: Unsafe
|
|
7753
|
+
*
|
|
7754
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#CreateCollection)
|
|
7755
|
+
*/
|
|
7756
|
+
CreateCollection(this: AuroraScriptService, query: string, root?: Instance): CollectionHandle;
|
|
7757
|
+
/**
|
|
7758
|
+
* - **ThreadSafety**: Safe
|
|
7759
|
+
* - **Tags**: CustomLuaState
|
|
7760
|
+
*
|
|
7761
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBinding)
|
|
7762
|
+
*/
|
|
7763
|
+
FindBinding(this: AuroraScriptService, instance: Instance, scriptName: string): RBXObject;
|
|
7764
|
+
/**
|
|
7765
|
+
* - **ThreadSafety**: Safe
|
|
7766
|
+
* - **Tags**: CustomLuaState
|
|
7767
|
+
*
|
|
7768
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBindings)
|
|
7769
|
+
*/
|
|
7770
|
+
FindBindings(this: AuroraScriptService, instance: Instance): object;
|
|
7771
|
+
/**
|
|
7772
|
+
* - **ThreadSafety**: Unsafe
|
|
7773
|
+
*
|
|
7774
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#GetAllCollections)
|
|
7775
|
+
*/
|
|
7776
|
+
GetAllCollections(this: AuroraScriptService): Array<unknown>;
|
|
7777
|
+
/**
|
|
7778
|
+
* - **ThreadSafety**: Safe
|
|
7779
|
+
*
|
|
7780
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#GetLocalFrameId)
|
|
7781
|
+
*/
|
|
7782
|
+
GetLocalFrameId(this: AuroraScriptService): number;
|
|
7783
|
+
/**
|
|
7784
|
+
* - **ThreadSafety**: Safe
|
|
7785
|
+
*
|
|
7786
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#SendMessage)
|
|
7787
|
+
*/
|
|
7788
|
+
SendMessage(this: AuroraScriptService, instance: Instance, behaviorName: string, functionName: string, args: unknown): void;
|
|
7789
|
+
/**
|
|
7790
|
+
* - **ThreadSafety**: Unsafe
|
|
7791
|
+
*
|
|
7792
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getBehaviors)
|
|
7793
|
+
*/
|
|
7794
|
+
getBehaviors(this: AuroraScriptService): Array<Instance>;
|
|
7795
|
+
/**
|
|
7796
|
+
* - **ThreadSafety**: Unsafe
|
|
7797
|
+
*
|
|
7798
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getBehaviorsForInstance)
|
|
7799
|
+
*/
|
|
7800
|
+
getBehaviorsForInstance(this: AuroraScriptService, instance: Instance): Array<Instance>;
|
|
7801
|
+
/**
|
|
7802
|
+
* - **ThreadSafety**: Unsafe
|
|
7803
|
+
*
|
|
7804
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getInstancesForBehavior)
|
|
7805
|
+
*/
|
|
7806
|
+
getInstancesForBehavior(this: AuroraScriptService, behavior: AuroraScript): Array<Instance>;
|
|
7807
|
+
}
|
|
7808
|
+
/**
|
|
7809
|
+
* - **Tags**: NotCreatable, Service
|
|
7810
|
+
*
|
|
7811
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService)
|
|
7812
|
+
*
|
|
7813
|
+
* @deprecated
|
|
7814
|
+
*/
|
|
7815
|
+
interface AuroraService extends Instance {
|
|
7816
|
+
/**
|
|
7817
|
+
* **DO NOT USE!**
|
|
7818
|
+
*
|
|
7819
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
7820
|
+
* @hidden
|
|
7821
|
+
* @deprecated
|
|
7822
|
+
*/
|
|
7823
|
+
readonly _nominal_AuroraService: unique symbol;
|
|
7824
|
+
/**
|
|
7825
|
+
* - **ThreadSafety**: ReadSafe
|
|
7826
|
+
*
|
|
7827
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#HashRoundingPoint)
|
|
7828
|
+
*/
|
|
7829
|
+
HashRoundingPoint: number;
|
|
7830
|
+
/**
|
|
7831
|
+
* - **ThreadSafety**: ReadSafe
|
|
7832
|
+
*
|
|
7833
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IgnoreRotation)
|
|
7834
|
+
*/
|
|
7835
|
+
IgnoreRotation: boolean;
|
|
7836
|
+
/**
|
|
7837
|
+
* - **ThreadSafety**: ReadSafe
|
|
7838
|
+
*
|
|
7839
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#LockStepIdOffset)
|
|
7840
|
+
*/
|
|
7841
|
+
LockStepIdOffset: boolean;
|
|
7842
|
+
/**
|
|
7843
|
+
* - **ThreadSafety**: ReadSafe
|
|
7844
|
+
*
|
|
7845
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#RollbackOffset)
|
|
7846
|
+
*/
|
|
7847
|
+
RollbackOffset: number;
|
|
7848
|
+
/**
|
|
7849
|
+
* - **ThreadSafety**: Unsafe
|
|
7850
|
+
*
|
|
7851
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetPredictedInstances)
|
|
7852
|
+
*/
|
|
7853
|
+
GetPredictedInstances(this: AuroraService): Array<unknown>;
|
|
7854
|
+
/**
|
|
7855
|
+
* - **ThreadSafety**: Unsafe
|
|
7856
|
+
*
|
|
7857
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetRemoteWorldStepId)
|
|
7858
|
+
*/
|
|
7859
|
+
GetRemoteWorldStepId(this: AuroraService): number;
|
|
7860
|
+
/**
|
|
7861
|
+
* - **ThreadSafety**: Unsafe
|
|
7862
|
+
*
|
|
7863
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetServerView)
|
|
7864
|
+
*/
|
|
7865
|
+
GetServerView(this: AuroraService, target: Instance): Instance | undefined;
|
|
7866
|
+
/**
|
|
7867
|
+
* - **ThreadSafety**: Unsafe
|
|
7868
|
+
*
|
|
7869
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetWorldStepId)
|
|
7870
|
+
*/
|
|
7871
|
+
GetWorldStepId(this: AuroraService): number;
|
|
7872
|
+
/**
|
|
7873
|
+
* - **ThreadSafety**: Unsafe
|
|
7874
|
+
*
|
|
7875
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsInstancePredicted)
|
|
7876
|
+
*/
|
|
7877
|
+
IsInstancePredicted(this: AuroraService, target: Instance): boolean;
|
|
7878
|
+
/**
|
|
7879
|
+
* - **ThreadSafety**: Unsafe
|
|
7880
|
+
*
|
|
7881
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#PlayInputRecording)
|
|
7882
|
+
*/
|
|
7883
|
+
PlayInputRecording(this: AuroraService): void;
|
|
7884
|
+
/**
|
|
7885
|
+
* - **ThreadSafety**: Unsafe
|
|
7886
|
+
*
|
|
7887
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#SetReplicationLag)
|
|
7888
|
+
*/
|
|
7889
|
+
SetReplicationLag(this: AuroraService, seconds: number): void;
|
|
7890
|
+
/**
|
|
7891
|
+
* - **ThreadSafety**: Unsafe
|
|
7892
|
+
*
|
|
7893
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#ShowDebugVisualizer)
|
|
7894
|
+
*/
|
|
7895
|
+
ShowDebugVisualizer(this: AuroraService, state: boolean): void;
|
|
7896
|
+
/**
|
|
7897
|
+
* - **ThreadSafety**: Unsafe
|
|
7898
|
+
*
|
|
7899
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StartInputRecording)
|
|
7900
|
+
*/
|
|
7901
|
+
StartInputRecording(this: AuroraService): void;
|
|
7902
|
+
/**
|
|
7903
|
+
* - **ThreadSafety**: Unsafe
|
|
7904
|
+
*
|
|
7905
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StartPrediction)
|
|
7906
|
+
*/
|
|
7907
|
+
StartPrediction(this: AuroraService, target: Instance): void;
|
|
7908
|
+
/**
|
|
7909
|
+
* - **ThreadSafety**: Unsafe
|
|
7910
|
+
*
|
|
7911
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StepPhysics)
|
|
7912
|
+
*/
|
|
7913
|
+
StepPhysics(this: AuroraService, worldSteps: number, parts?: Array<Instance>): void;
|
|
7914
|
+
/**
|
|
7915
|
+
* - **ThreadSafety**: Unsafe
|
|
7916
|
+
*
|
|
7917
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StopInputRecording)
|
|
7918
|
+
*/
|
|
7919
|
+
StopInputRecording(this: AuroraService): void;
|
|
7920
|
+
/**
|
|
7921
|
+
* - **ThreadSafety**: Unsafe
|
|
7922
|
+
*
|
|
7923
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StopPrediction)
|
|
7924
|
+
*/
|
|
7925
|
+
StopPrediction(this: AuroraService, target: Instance): void;
|
|
7926
|
+
/**
|
|
7927
|
+
* - **ThreadSafety**: Unsafe
|
|
7928
|
+
*
|
|
7929
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#UpdateProperties)
|
|
7930
|
+
*/
|
|
7931
|
+
UpdateProperties(this: AuroraService, target: Instance): void;
|
|
7932
|
+
/**
|
|
7933
|
+
* - **ThreadSafety**: Unsafe
|
|
7934
|
+
*
|
|
7935
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#FixedRateTick)
|
|
7936
|
+
*/
|
|
7937
|
+
readonly FixedRateTick: RBXScriptSignal<(deltaTime: number, worldStepId: number) => void>;
|
|
7938
|
+
/**
|
|
7939
|
+
* - **ThreadSafety**: Unsafe
|
|
7940
|
+
*
|
|
7941
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Step)
|
|
7942
|
+
*/
|
|
7943
|
+
readonly Step: RBXScriptSignal<() => void>;
|
|
7944
|
+
}
|
|
7691
7945
|
/**
|
|
7692
7946
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarAbilityRules)
|
|
7693
7947
|
*/
|
|
@@ -7927,6 +8181,13 @@ interface AvatarCreationService extends Instance {
|
|
|
7927
8181
|
* - A secondary optional string result. In the case of `PromptCreateAvatarResult.Success`, this will indicate the outfit ID. In the case of any failure enum, this will be `nil`.
|
|
7928
8182
|
*/
|
|
7929
8183
|
PromptCreateAvatarAsync(this: AvatarCreationService, tokenId: string, player: Player, humanoidDescription: HumanoidDescription): unknown;
|
|
8184
|
+
/**
|
|
8185
|
+
* - **ThreadSafety**: Unsafe
|
|
8186
|
+
* - **Tags**: Yields
|
|
8187
|
+
*
|
|
8188
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptCreateMakeupAsync)
|
|
8189
|
+
*/
|
|
8190
|
+
PromptCreateMakeupAsync(this: AvatarCreationService, player: Player, makeupAssetEntries: Array<unknown>, thumbnailHeadColor?: Color3): unknown;
|
|
7930
8191
|
/**
|
|
7931
8192
|
* Prompt the `Player` to take a selfie and return the FileId.
|
|
7932
8193
|
*
|
|
@@ -8127,7 +8388,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8127
8388
|
* @param humanoidDescription The HumanoidDescription to check if default clothing is required.
|
|
8128
8389
|
* @returns Returns a HumanoidDescription if default clothing was necessary. Otherwise returns `nil`.
|
|
8129
8390
|
*
|
|
8130
|
-
* @deprecated
|
|
8391
|
+
* @deprecated CheckApplyDefaultClothingAsync
|
|
8131
8392
|
*/
|
|
8132
8393
|
CheckApplyDefaultClothing(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription | undefined;
|
|
8133
8394
|
/**
|
|
@@ -8152,7 +8413,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8152
8413
|
* @param this A service to support developer Avatar Editors.
|
|
8153
8414
|
* @param humanoidDescription
|
|
8154
8415
|
*
|
|
8155
|
-
* @deprecated
|
|
8416
|
+
* @deprecated ConformToAvatarRulesAsync
|
|
8156
8417
|
*/
|
|
8157
8418
|
ConformToAvatarRules(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
|
|
8158
8419
|
/**
|
|
@@ -8179,7 +8440,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8179
8440
|
* @param this A service to support developer Avatar Editors.
|
|
8180
8441
|
* @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
8442
|
*
|
|
8182
|
-
* @deprecated
|
|
8443
|
+
* @deprecated GetAvatarRulesAsync
|
|
8183
8444
|
*/
|
|
8184
8445
|
GetAvatarRules(this: AvatarEditorService): AvatarRules;
|
|
8185
8446
|
/**
|
|
@@ -8207,7 +8468,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8207
8468
|
* @param itemType The type of the item ids provided.
|
|
8208
8469
|
* @returns Returns an array of item details. See `AvatarEditorService:GetBatchItemDetailsAsync()` for the response format.
|
|
8209
8470
|
*
|
|
8210
|
-
* @deprecated
|
|
8471
|
+
* @deprecated GetBatchItemDetailsAsync
|
|
8211
8472
|
*/
|
|
8212
8473
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): ReadonlyArray<AssetItemDetails>;
|
|
8213
8474
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): ReadonlyArray<BundleItemDetails>;
|
|
@@ -8226,10 +8487,16 @@ interface AvatarEditorService extends Instance {
|
|
|
8226
8487
|
*/
|
|
8227
8488
|
GetBatchItemDetailsAsync(this: AvatarEditorService, itemIds: Array<unknown>, itemType: CastsToEnum<Enum.AvatarItemType>): Array<unknown>;
|
|
8228
8489
|
/**
|
|
8490
|
+
* Returns a `CatalogPages` object containing bundles that include the given asset.
|
|
8491
|
+
*
|
|
8229
8492
|
* - **ThreadSafety**: Unsafe
|
|
8230
8493
|
* - **Tags**: Yields
|
|
8231
8494
|
*
|
|
8232
8495
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetBundlesByAssetIdAsync)
|
|
8496
|
+
* @param this A service to support developer Avatar Editors.
|
|
8497
|
+
* @param assetId The ID of the asset to find bundles for.
|
|
8498
|
+
* @param limit The number of results per page. Accepts `10`, `25`, `50`, and `100`.
|
|
8499
|
+
* @returns A `CatalogPages` object containing bundles that include the given asset.
|
|
8233
8500
|
*/
|
|
8234
8501
|
GetBundlesByAssetIdAsync(this: AvatarEditorService, assetId: number, limit?: number): CatalogPages;
|
|
8235
8502
|
/**
|
|
@@ -8246,7 +8513,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8246
8513
|
* @param itemType The `AvatarItemType` of the specified asset or bundle.
|
|
8247
8514
|
* @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
|
|
8248
8515
|
*
|
|
8249
|
-
* @deprecated
|
|
8516
|
+
* @deprecated GetFavoriteAsync
|
|
8250
8517
|
*/
|
|
8251
8518
|
GetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
|
|
8252
8519
|
/**
|
|
@@ -8285,7 +8552,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8285
8552
|
* @param this A service to support developer Avatar Editors.
|
|
8286
8553
|
* @param assetTypes The `AvatarAssetType` that can will be checked for in the player's inventory.
|
|
8287
8554
|
*
|
|
8288
|
-
* @deprecated
|
|
8555
|
+
* @deprecated GetInventoryAsync
|
|
8289
8556
|
*/
|
|
8290
8557
|
GetInventory(this: AvatarEditorService, assetTypes: ReadonlyArray<Enum.AvatarAssetType>): InventoryPages<{
|
|
8291
8558
|
AssetId: number;
|
|
@@ -8318,7 +8585,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8318
8585
|
* @param itemType An enum value indicating the type of item whose details are being retrieved.
|
|
8319
8586
|
* @returns A table containing the item info for the retrieved item. See above for a sample table.
|
|
8320
8587
|
*
|
|
8321
|
-
* @deprecated
|
|
8588
|
+
* @deprecated GetItemDetailsAsync
|
|
8322
8589
|
*/
|
|
8323
8590
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): AssetItemDetails;
|
|
8324
8591
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): BundleItemDetails;
|
|
@@ -8349,7 +8616,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8349
8616
|
* @param outfitId The ID of the outfit whose details are being retrieved.
|
|
8350
8617
|
* @returns A table containing the outfit info for the retrieved outfit. See above for a sample table.
|
|
8351
8618
|
*
|
|
8352
|
-
* @deprecated
|
|
8619
|
+
* @deprecated GetOutfitDetailsAsync
|
|
8353
8620
|
*/
|
|
8354
8621
|
GetOutfitDetails(this: AvatarEditorService, outfitId: number): object;
|
|
8355
8622
|
/**
|
|
@@ -8377,7 +8644,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8377
8644
|
* @param outfitSource
|
|
8378
8645
|
* @param outfitType
|
|
8379
8646
|
*
|
|
8380
|
-
* @deprecated
|
|
8647
|
+
* @deprecated GetOutfitsAsync
|
|
8381
8648
|
*/
|
|
8382
8649
|
GetOutfits(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
|
|
8383
8650
|
/**
|
|
@@ -8406,7 +8673,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8406
8673
|
* @param contextAssetId The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.
|
|
8407
8674
|
* @returns A list of recommendations based on the given `AssetType`.
|
|
8408
8675
|
*
|
|
8409
|
-
* @deprecated
|
|
8676
|
+
* @deprecated GetRecommendedAssetsAsync
|
|
8410
8677
|
*/
|
|
8411
8678
|
GetRecommendedAssets(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): ReadonlyArray<RecommendedAsset>;
|
|
8412
8679
|
/**
|
|
@@ -8435,7 +8702,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8435
8702
|
* @param bundleId A list of recommended bundles.
|
|
8436
8703
|
* @returns The bundle ID that the recommended bundles will be returned for.
|
|
8437
8704
|
*
|
|
8438
|
-
* @deprecated
|
|
8705
|
+
* @deprecated GetRecommendedBundlesAsync
|
|
8439
8706
|
*/
|
|
8440
8707
|
GetRecommendedBundles(this: AvatarEditorService, bundleId: number): ReadonlyArray<RecommendedBundle>;
|
|
8441
8708
|
/**
|
|
@@ -8462,7 +8729,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8462
8729
|
* @param this A service to support developer Avatar Editors.
|
|
8463
8730
|
* @param searchParameters An object containing the parameters used for the search.
|
|
8464
8731
|
*
|
|
8465
|
-
* @deprecated
|
|
8732
|
+
* @deprecated SearchCatalogAsync
|
|
8466
8733
|
*/
|
|
8467
8734
|
SearchCatalog(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
|
|
8468
8735
|
/**
|
|
@@ -8622,7 +8889,7 @@ interface BadgeService extends Instance {
|
|
|
8622
8889
|
* @param badgeId The ID of the badge to be awarded.
|
|
8623
8890
|
* @returns Boolean of `true` if the badge was awarded successfully.
|
|
8624
8891
|
*
|
|
8625
|
-
* @deprecated
|
|
8892
|
+
* @deprecated AwardBadgeAsync
|
|
8626
8893
|
*/
|
|
8627
8894
|
AwardBadge(this: BadgeService, userId: number, badgeId: number): boolean;
|
|
8628
8895
|
/**
|
|
@@ -9326,7 +9593,7 @@ interface BasePlayerGui extends Instance {
|
|
|
9326
9593
|
*/
|
|
9327
9594
|
readonly _nominal_BasePlayerGui: unique symbol;
|
|
9328
9595
|
/**
|
|
9329
|
-
* Returns a list of all `GuiObject` instances occupying the given
|
|
9596
|
+
* Returns a list of all `GuiObject` instances occupying the given
|
|
9330
9597
|
*
|
|
9331
9598
|
* - **ThreadSafety**: Unsafe
|
|
9332
9599
|
*
|
|
@@ -9986,6 +10253,8 @@ interface Beam extends Instance {
|
|
|
9986
10253
|
*/
|
|
9987
10254
|
LightInfluence: number;
|
|
9988
10255
|
/**
|
|
10256
|
+
* Determines a multiplier for `Beam.Transparency` that is only visible to the local client.
|
|
10257
|
+
*
|
|
9989
10258
|
* - **ThreadSafety**: ReadSafe
|
|
9990
10259
|
* - **Tags**: Hidden, NotReplicated
|
|
9991
10260
|
*
|
|
@@ -10181,7 +10450,7 @@ interface BodyMover extends Instance {
|
|
|
10181
10450
|
*
|
|
10182
10451
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyAngularVelocity)
|
|
10183
10452
|
*
|
|
10184
|
-
* @deprecated
|
|
10453
|
+
* @deprecated AngularVelocity
|
|
10185
10454
|
*/
|
|
10186
10455
|
interface BodyAngularVelocity extends BodyMover {
|
|
10187
10456
|
/**
|
|
@@ -10226,7 +10495,7 @@ interface BodyAngularVelocity extends BodyMover {
|
|
|
10226
10495
|
*
|
|
10227
10496
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyForce)
|
|
10228
10497
|
*
|
|
10229
|
-
* @deprecated
|
|
10498
|
+
* @deprecated VectorForce
|
|
10230
10499
|
*/
|
|
10231
10500
|
interface BodyForce extends BodyMover {
|
|
10232
10501
|
/**
|
|
@@ -10255,7 +10524,7 @@ interface BodyForce extends BodyMover {
|
|
|
10255
10524
|
*
|
|
10256
10525
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyGyro)
|
|
10257
10526
|
*
|
|
10258
|
-
* @deprecated
|
|
10527
|
+
* @deprecated AlignOrientation
|
|
10259
10528
|
*/
|
|
10260
10529
|
interface BodyGyro extends BodyMover {
|
|
10261
10530
|
/**
|
|
@@ -10308,7 +10577,7 @@ interface BodyGyro extends BodyMover {
|
|
|
10308
10577
|
*
|
|
10309
10578
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyPosition)
|
|
10310
10579
|
*
|
|
10311
|
-
* @deprecated
|
|
10580
|
+
* @deprecated AlignPosition
|
|
10312
10581
|
*/
|
|
10313
10582
|
interface BodyPosition extends BodyMover {
|
|
10314
10583
|
/**
|
|
@@ -10380,7 +10649,7 @@ interface BodyPosition extends BodyMover {
|
|
|
10380
10649
|
*
|
|
10381
10650
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyThrust)
|
|
10382
10651
|
*
|
|
10383
|
-
* @deprecated
|
|
10652
|
+
* @deprecated VectorForce
|
|
10384
10653
|
*/
|
|
10385
10654
|
interface BodyThrust extends BodyMover {
|
|
10386
10655
|
/**
|
|
@@ -10417,7 +10686,7 @@ interface BodyThrust extends BodyMover {
|
|
|
10417
10686
|
*
|
|
10418
10687
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyVelocity)
|
|
10419
10688
|
*
|
|
10420
|
-
* @deprecated
|
|
10689
|
+
* @deprecated LinearVelocity
|
|
10421
10690
|
*/
|
|
10422
10691
|
interface BodyVelocity extends BodyMover {
|
|
10423
10692
|
/**
|
|
@@ -10484,7 +10753,7 @@ interface BodyVelocity extends BodyMover {
|
|
|
10484
10753
|
*
|
|
10485
10754
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion)
|
|
10486
10755
|
*
|
|
10487
|
-
* @deprecated
|
|
10756
|
+
* @deprecated LineForce
|
|
10488
10757
|
*/
|
|
10489
10758
|
interface RocketPropulsion extends BodyMover {
|
|
10490
10759
|
/**
|
|
@@ -10936,7 +11205,7 @@ interface CaptureService extends Instance {
|
|
|
10936
11205
|
*
|
|
10937
11206
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureSaved)
|
|
10938
11207
|
*
|
|
10939
|
-
* @deprecated
|
|
11208
|
+
* @deprecated UserCaptureSaved
|
|
10940
11209
|
*/
|
|
10941
11210
|
readonly CaptureSaved: RBXScriptSignal<(captureInfo: Record<string, unknown>) => void>;
|
|
10942
11211
|
/**
|
|
@@ -11416,7 +11685,7 @@ interface Chat extends Instance {
|
|
|
11416
11685
|
* @param playerToFilterFor Player that the string is being filtered for.
|
|
11417
11686
|
* @returns Filtered string result.
|
|
11418
11687
|
*
|
|
11419
|
-
* @deprecated
|
|
11688
|
+
* @deprecated FilterStringAsync
|
|
11420
11689
|
*/
|
|
11421
11690
|
FilterStringForPlayerAsync(this: Chat, stringToFilter: string, playerToFilterFor: Player): string;
|
|
11422
11691
|
/**
|
|
@@ -11792,6 +12061,13 @@ interface DragDetector extends ClickDetector {
|
|
|
11792
12061
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragContinue)
|
|
11793
12062
|
*/
|
|
11794
12063
|
readonly DragContinue: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
12064
|
+
/**
|
|
12065
|
+
* - **ThreadSafety**: Unsafe
|
|
12066
|
+
* - **Tags**: Hidden
|
|
12067
|
+
*
|
|
12068
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragContinueReplicate)
|
|
12069
|
+
*/
|
|
12070
|
+
readonly DragContinueReplicate: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
11795
12071
|
/**
|
|
11796
12072
|
* Fires when a user stops dragging the object.
|
|
11797
12073
|
*
|
|
@@ -11800,6 +12076,13 @@ interface DragDetector extends ClickDetector {
|
|
|
11800
12076
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragEnd)
|
|
11801
12077
|
*/
|
|
11802
12078
|
readonly DragEnd: RBXScriptSignal<(playerWhoDragged: Player) => void>;
|
|
12079
|
+
/**
|
|
12080
|
+
* - **ThreadSafety**: Unsafe
|
|
12081
|
+
* - **Tags**: Hidden
|
|
12082
|
+
*
|
|
12083
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragEndReplicate)
|
|
12084
|
+
*/
|
|
12085
|
+
readonly DragEndReplicate: RBXScriptSignal<(playerWhoDragged: Player) => void>;
|
|
11803
12086
|
/**
|
|
11804
12087
|
* Fires when a user starts dragging the object.
|
|
11805
12088
|
*
|
|
@@ -11808,6 +12091,20 @@ interface DragDetector extends ClickDetector {
|
|
|
11808
12091
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragStart)
|
|
11809
12092
|
*/
|
|
11810
12093
|
readonly DragStart: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
12094
|
+
/**
|
|
12095
|
+
* - **ThreadSafety**: Unsafe
|
|
12096
|
+
* - **Tags**: Hidden
|
|
12097
|
+
*
|
|
12098
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragStartReplicate)
|
|
12099
|
+
*/
|
|
12100
|
+
readonly DragStartReplicate: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
12101
|
+
/**
|
|
12102
|
+
* - **ThreadSafety**: Unsafe
|
|
12103
|
+
* - **Tags**: Hidden
|
|
12104
|
+
*
|
|
12105
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#RestartPhysicalDragReplicate)
|
|
12106
|
+
*/
|
|
12107
|
+
readonly RestartPhysicalDragReplicate: RBXScriptSignal<(hitPoint: Vector3) => void>;
|
|
11811
12108
|
}
|
|
11812
12109
|
/**
|
|
11813
12110
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -11928,7 +12225,7 @@ interface Collaborator extends Instance {
|
|
|
11928
12225
|
*
|
|
11929
12226
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Collaborator#CollaboratorColor)
|
|
11930
12227
|
*
|
|
11931
|
-
* @deprecated
|
|
12228
|
+
* @deprecated CollaboratorColor3
|
|
11932
12229
|
*/
|
|
11933
12230
|
CollaboratorColor: number;
|
|
11934
12231
|
/**
|
|
@@ -12117,7 +12414,7 @@ interface CollectionService extends Instance {
|
|
|
12117
12414
|
*
|
|
12118
12415
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CollectionService#ItemAdded)
|
|
12119
12416
|
*
|
|
12120
|
-
* @deprecated
|
|
12417
|
+
* @deprecated GetInstanceAddedSignal
|
|
12121
12418
|
*/
|
|
12122
12419
|
readonly ItemAdded: RBXScriptSignal<(instance: Instance) => void>;
|
|
12123
12420
|
/**
|
|
@@ -12130,7 +12427,7 @@ interface CollectionService extends Instance {
|
|
|
12130
12427
|
*
|
|
12131
12428
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CollectionService#ItemRemoved)
|
|
12132
12429
|
*
|
|
12133
|
-
* @deprecated
|
|
12430
|
+
* @deprecated GetInstanceRemovedSignal
|
|
12134
12431
|
*/
|
|
12135
12432
|
readonly ItemRemoved: RBXScriptSignal<(instance: Instance) => void>;
|
|
12136
12433
|
/**
|
|
@@ -13254,7 +13551,7 @@ interface PlaneConstraint extends Constraint {
|
|
|
13254
13551
|
*
|
|
13255
13552
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plane)
|
|
13256
13553
|
*
|
|
13257
|
-
* @deprecated
|
|
13554
|
+
* @deprecated PlaneConstraint
|
|
13258
13555
|
*/
|
|
13259
13556
|
interface Plane extends PlaneConstraint {
|
|
13260
13557
|
/**
|
|
@@ -13927,7 +14224,7 @@ interface TorsionSpringConstraint extends Constraint {
|
|
|
13927
14224
|
*
|
|
13928
14225
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#LimitEnabled)
|
|
13929
14226
|
*
|
|
13930
|
-
* @deprecated
|
|
14227
|
+
* @deprecated LimitsEnabled
|
|
13931
14228
|
*/
|
|
13932
14229
|
LimitEnabled: boolean;
|
|
13933
14230
|
/**
|
|
@@ -14139,7 +14436,7 @@ interface ContentProvider extends Instance {
|
|
|
14139
14436
|
* @param this Service that is used to load content, or assets, into a game.
|
|
14140
14437
|
* @param contentId
|
|
14141
14438
|
*
|
|
14142
|
-
* @deprecated
|
|
14439
|
+
* @deprecated PreloadAsync
|
|
14143
14440
|
*/
|
|
14144
14441
|
Preload(this: ContentProvider, contentId: ContentId): void;
|
|
14145
14442
|
/**
|
|
@@ -14268,7 +14565,7 @@ interface ContextActionService extends Instance {
|
|
|
14268
14565
|
* @param createTouchButton
|
|
14269
14566
|
* @param inputTypes
|
|
14270
14567
|
*
|
|
14271
|
-
* @deprecated
|
|
14568
|
+
* @deprecated BindAction
|
|
14272
14569
|
*/
|
|
14273
14570
|
BindActionToInputTypes(this: ContextActionService, actionName: string, functionToBind: Callback, createTouchButton: boolean, inputTypes: unknown): void;
|
|
14274
14571
|
/**
|
|
@@ -15811,6 +16108,21 @@ interface DesignFoundationsService extends Instance {
|
|
|
15811
16108
|
*/
|
|
15812
16109
|
readonly _nominal_DesignFoundationsService: unique symbol;
|
|
15813
16110
|
}
|
|
16111
|
+
/**
|
|
16112
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
16113
|
+
*
|
|
16114
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DeviceDisplayService)
|
|
16115
|
+
*/
|
|
16116
|
+
interface DeviceDisplayService extends Instance {
|
|
16117
|
+
/**
|
|
16118
|
+
* **DO NOT USE!**
|
|
16119
|
+
*
|
|
16120
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16121
|
+
* @hidden
|
|
16122
|
+
* @deprecated
|
|
16123
|
+
*/
|
|
16124
|
+
readonly _nominal_DeviceDisplayService: unique symbol;
|
|
16125
|
+
}
|
|
15814
16126
|
/**
|
|
15815
16127
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
15816
16128
|
*
|
|
@@ -16280,6 +16592,21 @@ interface DigitsRigDescription extends Instance {
|
|
|
16280
16592
|
*/
|
|
16281
16593
|
SetFingerTip(this: DigitsRigDescription, fingerIndex: number, point: Vector3): void;
|
|
16282
16594
|
}
|
|
16595
|
+
/**
|
|
16596
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
16597
|
+
*
|
|
16598
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DisplayWakeLock)
|
|
16599
|
+
*/
|
|
16600
|
+
interface DisplayWakeLock extends Instance {
|
|
16601
|
+
/**
|
|
16602
|
+
* **DO NOT USE!**
|
|
16603
|
+
*
|
|
16604
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16605
|
+
* @hidden
|
|
16606
|
+
* @deprecated
|
|
16607
|
+
*/
|
|
16608
|
+
readonly _nominal_DisplayWakeLock: unique symbol;
|
|
16609
|
+
}
|
|
16283
16610
|
/**
|
|
16284
16611
|
* A helper object used to create tools that can drag parts.
|
|
16285
16612
|
*
|
|
@@ -16471,6 +16798,21 @@ interface EditableService extends Instance {
|
|
|
16471
16798
|
*/
|
|
16472
16799
|
readonly _nominal_EditableService: unique symbol;
|
|
16473
16800
|
}
|
|
16801
|
+
/**
|
|
16802
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
16803
|
+
*
|
|
16804
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditorSourceService)
|
|
16805
|
+
*/
|
|
16806
|
+
interface EditorSourceService extends Instance {
|
|
16807
|
+
/**
|
|
16808
|
+
* **DO NOT USE!**
|
|
16809
|
+
*
|
|
16810
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
16811
|
+
* @hidden
|
|
16812
|
+
* @deprecated
|
|
16813
|
+
*/
|
|
16814
|
+
readonly _nominal_EditorSourceService: unique symbol;
|
|
16815
|
+
}
|
|
16474
16816
|
/**
|
|
16475
16817
|
* Service providing common encoding, hashing, and compression methods.
|
|
16476
16818
|
*
|
|
@@ -18116,6 +18458,13 @@ interface GlobalDataStore extends Instance {
|
|
|
18116
18458
|
* @deprecated
|
|
18117
18459
|
*/
|
|
18118
18460
|
OnUpdate(this: GlobalDataStore, key: string, callback: Callback): RBXScriptConnection;
|
|
18461
|
+
/**
|
|
18462
|
+
* - **ThreadSafety**: Unsafe
|
|
18463
|
+
* - **Tags**: Yields
|
|
18464
|
+
*
|
|
18465
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GlobalDataStore#BatchGetAsync)
|
|
18466
|
+
*/
|
|
18467
|
+
BatchGetAsync(this: GlobalDataStore, keys: Array<unknown>, options?: object): object;
|
|
18119
18468
|
/**
|
|
18120
18469
|
* Returns the value of a key in a specified data store and a `DataStoreKeyInfo` instance.
|
|
18121
18470
|
*
|
|
@@ -18515,7 +18864,7 @@ interface GuiBase2d extends GuiBase {
|
|
|
18515
18864
|
*
|
|
18516
18865
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#Localize)
|
|
18517
18866
|
*
|
|
18518
|
-
* @deprecated
|
|
18867
|
+
* @deprecated AutoLocalize
|
|
18519
18868
|
*/
|
|
18520
18869
|
Localize: boolean;
|
|
18521
18870
|
/**
|
|
@@ -19427,7 +19776,7 @@ interface TextButton extends GuiButton {
|
|
|
19427
19776
|
*
|
|
19428
19777
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextButton#FontSize)
|
|
19429
19778
|
*
|
|
19430
|
-
* @deprecated
|
|
19779
|
+
* @deprecated TextSize
|
|
19431
19780
|
*/
|
|
19432
19781
|
FontSize: Enum.FontSize;
|
|
19433
19782
|
/**
|
|
@@ -19589,7 +19938,7 @@ interface TextButton extends GuiButton {
|
|
|
19589
19938
|
*
|
|
19590
19939
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextButton#TextWrap)
|
|
19591
19940
|
*
|
|
19592
|
-
* @deprecated
|
|
19941
|
+
* @deprecated TextWrapped
|
|
19593
19942
|
*/
|
|
19594
19943
|
TextWrap: boolean;
|
|
19595
19944
|
/**
|
|
@@ -19796,7 +20145,7 @@ interface TextLabel extends GuiLabel {
|
|
|
19796
20145
|
*
|
|
19797
20146
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextLabel#FontSize)
|
|
19798
20147
|
*
|
|
19799
|
-
* @deprecated
|
|
20148
|
+
* @deprecated TextSize
|
|
19800
20149
|
*/
|
|
19801
20150
|
FontSize: Enum.FontSize;
|
|
19802
20151
|
/**
|
|
@@ -19854,7 +20203,7 @@ interface TextLabel extends GuiLabel {
|
|
|
19854
20203
|
*/
|
|
19855
20204
|
Text: string;
|
|
19856
20205
|
/**
|
|
19857
|
-
* Read-only property which reflects the absolute size of rendered text in
|
|
20206
|
+
* Read-only property which reflects the absolute size of rendered text in
|
|
19858
20207
|
*
|
|
19859
20208
|
* - **ThreadSafety**: ReadSafe
|
|
19860
20209
|
* - **Tags**: NotReplicated
|
|
@@ -19958,11 +20307,11 @@ interface TextLabel extends GuiLabel {
|
|
|
19958
20307
|
*
|
|
19959
20308
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextWrap)
|
|
19960
20309
|
*
|
|
19961
|
-
* @deprecated
|
|
20310
|
+
* @deprecated TextWrapped
|
|
19962
20311
|
*/
|
|
19963
20312
|
TextWrap: boolean;
|
|
19964
20313
|
/**
|
|
19965
|
-
* Determines if text wraps to multiple lines within the `TextLabel`
|
|
20314
|
+
* Determines if text wraps to multiple lines within the `TextLabel`
|
|
19966
20315
|
*
|
|
19967
20316
|
* - **ThreadSafety**: ReadSafe
|
|
19968
20317
|
*
|
|
@@ -20258,7 +20607,7 @@ interface TextBox extends GuiObject {
|
|
|
20258
20607
|
*
|
|
20259
20608
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#FontSize)
|
|
20260
20609
|
*
|
|
20261
|
-
* @deprecated
|
|
20610
|
+
* @deprecated TextSize
|
|
20262
20611
|
*/
|
|
20263
20612
|
FontSize: Enum.FontSize;
|
|
20264
20613
|
/**
|
|
@@ -20453,7 +20802,7 @@ interface TextBox extends GuiObject {
|
|
|
20453
20802
|
*
|
|
20454
20803
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#TextWrap)
|
|
20455
20804
|
*
|
|
20456
|
-
* @deprecated
|
|
20805
|
+
* @deprecated TextWrapped
|
|
20457
20806
|
*/
|
|
20458
20807
|
TextWrap: boolean;
|
|
20459
20808
|
/**
|
|
@@ -21548,7 +21897,7 @@ interface SelectionBox extends InstanceAdornment {
|
|
|
21548
21897
|
*
|
|
21549
21898
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelectionBox#SurfaceColor)
|
|
21550
21899
|
*
|
|
21551
|
-
* @deprecated
|
|
21900
|
+
* @deprecated SurfaceColor3
|
|
21552
21901
|
*/
|
|
21553
21902
|
SurfaceColor: BrickColor;
|
|
21554
21903
|
/**
|
|
@@ -22070,7 +22419,7 @@ interface SelectionSphere extends PVAdornment {
|
|
|
22070
22419
|
*
|
|
22071
22420
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelectionSphere#SurfaceColor)
|
|
22072
22421
|
*
|
|
22073
|
-
* @deprecated
|
|
22422
|
+
* @deprecated SurfaceColor3
|
|
22074
22423
|
*/
|
|
22075
22424
|
SurfaceColor: BrickColor;
|
|
22076
22425
|
/**
|
|
@@ -22714,7 +23063,7 @@ interface GuiService extends Instance {
|
|
|
22714
23063
|
* @param selectionName
|
|
22715
23064
|
* @param selectionParent
|
|
22716
23065
|
*
|
|
22717
|
-
* @deprecated
|
|
23066
|
+
* @deprecated SelectionGroup
|
|
22718
23067
|
*/
|
|
22719
23068
|
AddSelectionParent(this: GuiService, selectionName: string, selectionParent: GuiObject): void;
|
|
22720
23069
|
/**
|
|
@@ -22733,7 +23082,7 @@ interface GuiService extends Instance {
|
|
|
22733
23082
|
* @param selectionName The name of the added selection.
|
|
22734
23083
|
* @param selections The selection(s) added.
|
|
22735
23084
|
*
|
|
22736
|
-
* @deprecated
|
|
23085
|
+
* @deprecated SelectionGroup
|
|
22737
23086
|
*/
|
|
22738
23087
|
AddSelectionTuple(this: GuiService, selectionName: string, selections: Array<GuiObject>): void;
|
|
22739
23088
|
/**
|
|
@@ -22848,7 +23197,7 @@ interface GuiService extends Instance {
|
|
|
22848
23197
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
22849
23198
|
* @param selectionName
|
|
22850
23199
|
*
|
|
22851
|
-
* @deprecated
|
|
23200
|
+
* @deprecated SelectionGroup
|
|
22852
23201
|
*/
|
|
22853
23202
|
RemoveSelectionGroup(this: GuiService, selectionName: string): void;
|
|
22854
23203
|
/**
|
|
@@ -24025,7 +24374,7 @@ interface Humanoid extends Instance {
|
|
|
24025
24374
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
24026
24375
|
* @param assetTypeVerification The asset type verification mode.
|
|
24027
24376
|
*
|
|
24028
|
-
* @deprecated
|
|
24377
|
+
* @deprecated ApplyDescriptionAsync
|
|
24029
24378
|
*/
|
|
24030
24379
|
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
24031
24380
|
/**
|
|
@@ -24053,7 +24402,7 @@ interface Humanoid extends Instance {
|
|
|
24053
24402
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
24054
24403
|
* @param assetTypeVerification The asset type verification mode.
|
|
24055
24404
|
*
|
|
24056
|
-
* @deprecated
|
|
24405
|
+
* @deprecated ApplyDescriptionResetAsync
|
|
24057
24406
|
*/
|
|
24058
24407
|
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
24059
24408
|
/**
|
|
@@ -24081,7 +24430,7 @@ interface Humanoid extends Instance {
|
|
|
24081
24430
|
* @param emoteName name of the emote to play.
|
|
24082
24431
|
* @returns successfully played.
|
|
24083
24432
|
*
|
|
24084
|
-
* @deprecated
|
|
24433
|
+
* @deprecated PlayEmoteAsync
|
|
24085
24434
|
*/
|
|
24086
24435
|
PlayEmote(this: Humanoid, emoteName: string): boolean;
|
|
24087
24436
|
/**
|
|
@@ -25800,6 +26149,13 @@ interface InputAction extends Instance {
|
|
|
25800
26149
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#Enabled)
|
|
25801
26150
|
*/
|
|
25802
26151
|
Enabled: boolean;
|
|
26152
|
+
/**
|
|
26153
|
+
* - **ThreadSafety**: ReadSafe
|
|
26154
|
+
* - **Tags**: NotReplicated
|
|
26155
|
+
*
|
|
26156
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#PreferredBinding)
|
|
26157
|
+
*/
|
|
26158
|
+
readonly PreferredBinding: InputBinding | undefined;
|
|
25803
26159
|
/**
|
|
25804
26160
|
* Specifies what type of input value the action is expecting.
|
|
25805
26161
|
*
|
|
@@ -25888,6 +26244,18 @@ interface InputBinding extends Instance {
|
|
|
25888
26244
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ClampMagnitudeToOne)
|
|
25889
26245
|
*/
|
|
25890
26246
|
ClampMagnitudeToOne: boolean;
|
|
26247
|
+
/**
|
|
26248
|
+
* - **ThreadSafety**: ReadSafe
|
|
26249
|
+
*
|
|
26250
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#DisplayImage)
|
|
26251
|
+
*/
|
|
26252
|
+
DisplayImage: Content;
|
|
26253
|
+
/**
|
|
26254
|
+
* - **ThreadSafety**: ReadSafe
|
|
26255
|
+
*
|
|
26256
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#DisplayName)
|
|
26257
|
+
*/
|
|
26258
|
+
DisplayName: string;
|
|
25891
26259
|
/**
|
|
25892
26260
|
* Specifies an alternate `KeyCode` for dispatching directionally "down" inputs to the parent `InputAction`.
|
|
25893
26261
|
*
|
|
@@ -26241,7 +26609,7 @@ interface InsertService extends Instance {
|
|
|
26241
26609
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetBaseCategories)
|
|
26242
26610
|
* @param this Used to insert assets from the Roblox website.
|
|
26243
26611
|
*
|
|
26244
|
-
* @deprecated
|
|
26612
|
+
* @deprecated GetBaseSets
|
|
26245
26613
|
*/
|
|
26246
26614
|
GetBaseCategories(this: InsertService): Array<unknown>;
|
|
26247
26615
|
/**
|
|
@@ -26287,7 +26655,7 @@ interface InsertService extends Instance {
|
|
|
26287
26655
|
* @param pageNum The page number in the Catalog to return.
|
|
26288
26656
|
* @returns A single table (of returned free decals) wrapped in a table.
|
|
26289
26657
|
*
|
|
26290
|
-
* @deprecated
|
|
26658
|
+
* @deprecated GetFreeDecalsAsync
|
|
26291
26659
|
*/
|
|
26292
26660
|
GetFreeDecals(this: InsertService, searchText: string, pageNum: number): [
|
|
26293
26661
|
Array<FreeSearchResult>
|
|
@@ -26319,7 +26687,7 @@ interface InsertService extends Instance {
|
|
|
26319
26687
|
* @param pageNum The page number in the Catalog to return.
|
|
26320
26688
|
* @returns A single table (of returned free models) wrapped in a table.
|
|
26321
26689
|
*
|
|
26322
|
-
* @deprecated
|
|
26690
|
+
* @deprecated GetFreeModelsAsync
|
|
26323
26691
|
*/
|
|
26324
26692
|
GetFreeModels(this: InsertService, searchText: string, pageNum: number): [
|
|
26325
26693
|
Array<FreeSearchResult>
|
|
@@ -26358,7 +26726,7 @@ interface InsertService extends Instance {
|
|
|
26358
26726
|
* @param this Used to insert assets from the Roblox website.
|
|
26359
26727
|
* @param userId
|
|
26360
26728
|
*
|
|
26361
|
-
* @deprecated
|
|
26729
|
+
* @deprecated GetUserSets
|
|
26362
26730
|
*/
|
|
26363
26731
|
GetUserCategories(this: InsertService, userId: User): Array<unknown>;
|
|
26364
26732
|
/**
|
|
@@ -26399,6 +26767,13 @@ interface InsertService extends Instance {
|
|
|
26399
26767
|
* @param assetVersionId
|
|
26400
26768
|
*/
|
|
26401
26769
|
LoadAssetVersion(this: InsertService, assetVersionId: number): Model;
|
|
26770
|
+
/**
|
|
26771
|
+
* - **ThreadSafety**: Unsafe
|
|
26772
|
+
* - **Tags**: Hidden
|
|
26773
|
+
*
|
|
26774
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#InternalDelete)
|
|
26775
|
+
*/
|
|
26776
|
+
readonly InternalDelete: RBXScriptSignal<(instance: Instance) => void>;
|
|
26402
26777
|
}
|
|
26403
26778
|
/**
|
|
26404
26779
|
* - **Tags**: NotCreatable, Service
|
|
@@ -26462,6 +26837,36 @@ interface InternalMessagingServiceVerifier extends Instance {
|
|
|
26462
26837
|
*/
|
|
26463
26838
|
readonly _nominal_InternalMessagingServiceVerifier: unique symbol;
|
|
26464
26839
|
}
|
|
26840
|
+
/**
|
|
26841
|
+
* - **Tags**: NotReplicated
|
|
26842
|
+
*
|
|
26843
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InternalSyncItem)
|
|
26844
|
+
*/
|
|
26845
|
+
interface InternalSyncItem extends Instance {
|
|
26846
|
+
/**
|
|
26847
|
+
* **DO NOT USE!**
|
|
26848
|
+
*
|
|
26849
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26850
|
+
* @hidden
|
|
26851
|
+
* @deprecated
|
|
26852
|
+
*/
|
|
26853
|
+
readonly _nominal_InternalSyncItem: unique symbol;
|
|
26854
|
+
}
|
|
26855
|
+
/**
|
|
26856
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
26857
|
+
*
|
|
26858
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InternalSyncService)
|
|
26859
|
+
*/
|
|
26860
|
+
interface InternalSyncService extends Instance {
|
|
26861
|
+
/**
|
|
26862
|
+
* **DO NOT USE!**
|
|
26863
|
+
*
|
|
26864
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26865
|
+
* @hidden
|
|
26866
|
+
* @deprecated
|
|
26867
|
+
*/
|
|
26868
|
+
readonly _nominal_InternalSyncService: unique symbol;
|
|
26869
|
+
}
|
|
26465
26870
|
/**
|
|
26466
26871
|
* The base class for joints.
|
|
26467
26872
|
*
|
|
@@ -26560,7 +26965,7 @@ interface DynamicRotate extends JointInstance {
|
|
|
26560
26965
|
*
|
|
26561
26966
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotateP)
|
|
26562
26967
|
*
|
|
26563
|
-
* @deprecated
|
|
26968
|
+
* @deprecated HingeConstraint
|
|
26564
26969
|
*/
|
|
26565
26970
|
interface RotateP extends DynamicRotate {
|
|
26566
26971
|
/**
|
|
@@ -26579,7 +26984,7 @@ interface RotateP extends DynamicRotate {
|
|
|
26579
26984
|
*
|
|
26580
26985
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotateV)
|
|
26581
26986
|
*
|
|
26582
|
-
* @deprecated
|
|
26987
|
+
* @deprecated HingeConstraint
|
|
26583
26988
|
*/
|
|
26584
26989
|
interface RotateV extends DynamicRotate {
|
|
26585
26990
|
/**
|
|
@@ -26600,7 +27005,7 @@ interface RotateV extends DynamicRotate {
|
|
|
26600
27005
|
*
|
|
26601
27006
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Glue)
|
|
26602
27007
|
*
|
|
26603
|
-
* @deprecated
|
|
27008
|
+
* @deprecated WeldConstraint
|
|
26604
27009
|
*/
|
|
26605
27010
|
interface Glue extends JointInstance {
|
|
26606
27011
|
/**
|
|
@@ -26653,7 +27058,7 @@ interface Glue extends JointInstance {
|
|
|
26653
27058
|
*
|
|
26654
27059
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualSurfaceJointInstance)
|
|
26655
27060
|
*
|
|
26656
|
-
* @deprecated
|
|
27061
|
+
* @deprecated WeldConstraint
|
|
26657
27062
|
*/
|
|
26658
27063
|
interface ManualSurfaceJointInstance extends JointInstance {
|
|
26659
27064
|
/**
|
|
@@ -26674,7 +27079,7 @@ interface ManualSurfaceJointInstance extends JointInstance {
|
|
|
26674
27079
|
*
|
|
26675
27080
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualGlue)
|
|
26676
27081
|
*
|
|
26677
|
-
* @deprecated
|
|
27082
|
+
* @deprecated WeldConstraint
|
|
26678
27083
|
*/
|
|
26679
27084
|
interface ManualGlue extends ManualSurfaceJointInstance {
|
|
26680
27085
|
/**
|
|
@@ -26695,7 +27100,7 @@ interface ManualGlue extends ManualSurfaceJointInstance {
|
|
|
26695
27100
|
*
|
|
26696
27101
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualWeld)
|
|
26697
27102
|
*
|
|
26698
|
-
* @deprecated
|
|
27103
|
+
* @deprecated WeldConstraint
|
|
26699
27104
|
*/
|
|
26700
27105
|
interface ManualWeld extends ManualSurfaceJointInstance {
|
|
26701
27106
|
/**
|
|
@@ -26788,7 +27193,7 @@ interface Motor6D extends Motor {
|
|
|
26788
27193
|
*
|
|
26789
27194
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Rotate)
|
|
26790
27195
|
*
|
|
26791
|
-
* @deprecated
|
|
27196
|
+
* @deprecated HingeConstraint
|
|
26792
27197
|
*/
|
|
26793
27198
|
interface Rotate extends JointInstance {
|
|
26794
27199
|
/**
|
|
@@ -26809,7 +27214,7 @@ interface Rotate extends JointInstance {
|
|
|
26809
27214
|
*
|
|
26810
27215
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Snap)
|
|
26811
27216
|
*
|
|
26812
|
-
* @deprecated
|
|
27217
|
+
* @deprecated WeldConstraint
|
|
26813
27218
|
*/
|
|
26814
27219
|
interface Snap extends JointInstance {
|
|
26815
27220
|
/**
|
|
@@ -27114,7 +27519,7 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
27114
27519
|
* @param userId The user ID of the user.
|
|
27115
27520
|
* @returns An `InventoryPages` of animations.
|
|
27116
27521
|
*
|
|
27117
|
-
* @deprecated
|
|
27522
|
+
* @deprecated GetAnimationsAsync
|
|
27118
27523
|
*/
|
|
27119
27524
|
GetAnimations(this: KeyframeSequenceProvider, userId: number): InventoryPages<number>;
|
|
27120
27525
|
/**
|
|
@@ -27749,7 +28154,7 @@ interface LocalizationTable extends Instance {
|
|
|
27749
28154
|
*
|
|
27750
28155
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#DevelopmentLanguage)
|
|
27751
28156
|
*
|
|
27752
|
-
* @deprecated
|
|
28157
|
+
* @deprecated SourceLocaleId
|
|
27753
28158
|
*/
|
|
27754
28159
|
DevelopmentLanguage: string;
|
|
27755
28160
|
/**
|
|
@@ -27762,7 +28167,7 @@ interface LocalizationTable extends Instance {
|
|
|
27762
28167
|
*
|
|
27763
28168
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#Root)
|
|
27764
28169
|
*
|
|
27765
|
-
* @deprecated
|
|
28170
|
+
* @deprecated RootLocalizationTable
|
|
27766
28171
|
*/
|
|
27767
28172
|
Root: Instance | undefined;
|
|
27768
28173
|
/**
|
|
@@ -27782,7 +28187,7 @@ interface LocalizationTable extends Instance {
|
|
|
27782
28187
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetContents)
|
|
27783
28188
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27784
28189
|
*
|
|
27785
|
-
* @deprecated
|
|
28190
|
+
* @deprecated GetEntries
|
|
27786
28191
|
*/
|
|
27787
28192
|
GetContents(this: LocalizationTable): string;
|
|
27788
28193
|
/**
|
|
@@ -27809,7 +28214,7 @@ interface LocalizationTable extends Instance {
|
|
|
27809
28214
|
* @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
28215
|
* @returns Translated string.
|
|
27811
28216
|
*
|
|
27812
|
-
* @deprecated
|
|
28217
|
+
* @deprecated GetTranslator
|
|
27813
28218
|
*/
|
|
27814
28219
|
GetString(this: LocalizationTable, targetLocaleId: string, key: string): string;
|
|
27815
28220
|
/**
|
|
@@ -27860,7 +28265,7 @@ interface LocalizationTable extends Instance {
|
|
|
27860
28265
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27861
28266
|
* @param key
|
|
27862
28267
|
*
|
|
27863
|
-
* @deprecated
|
|
28268
|
+
* @deprecated RemoveEntry
|
|
27864
28269
|
*/
|
|
27865
28270
|
RemoveKey(this: LocalizationTable, key: string): void;
|
|
27866
28271
|
/**
|
|
@@ -27885,7 +28290,7 @@ interface LocalizationTable extends Instance {
|
|
|
27885
28290
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27886
28291
|
* @param contents
|
|
27887
28292
|
*
|
|
27888
|
-
* @deprecated
|
|
28293
|
+
* @deprecated SetEntries
|
|
27889
28294
|
*/
|
|
27890
28295
|
SetContents(this: LocalizationTable, contents: string): void;
|
|
27891
28296
|
/**
|
|
@@ -27910,7 +28315,7 @@ interface LocalizationTable extends Instance {
|
|
|
27910
28315
|
* @param targetLocaleId
|
|
27911
28316
|
* @param text
|
|
27912
28317
|
*
|
|
27913
|
-
* @deprecated
|
|
28318
|
+
* @deprecated SetEntryValue
|
|
27914
28319
|
*/
|
|
27915
28320
|
SetEntry(this: LocalizationTable, key: string, targetLocaleId: string, text: string): void;
|
|
27916
28321
|
/**
|
|
@@ -28168,6 +28573,77 @@ interface LuaSourceContainer extends Instance {
|
|
|
28168
28573
|
*/
|
|
28169
28574
|
readonly _nominal_LuaSourceContainer: unique symbol;
|
|
28170
28575
|
}
|
|
28576
|
+
/**
|
|
28577
|
+
* - **Tags**:
|
|
28578
|
+
*
|
|
28579
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript)
|
|
28580
|
+
*
|
|
28581
|
+
* @deprecated
|
|
28582
|
+
*/
|
|
28583
|
+
interface AuroraScript extends LuaSourceContainer {
|
|
28584
|
+
/**
|
|
28585
|
+
* **DO NOT USE!**
|
|
28586
|
+
*
|
|
28587
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
28588
|
+
* @hidden
|
|
28589
|
+
* @deprecated
|
|
28590
|
+
*/
|
|
28591
|
+
readonly _nominal_AuroraScript: unique symbol;
|
|
28592
|
+
/**
|
|
28593
|
+
* - **ThreadSafety**: ReadSafe
|
|
28594
|
+
*
|
|
28595
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#EnableCulling)
|
|
28596
|
+
*/
|
|
28597
|
+
EnableCulling: boolean;
|
|
28598
|
+
/**
|
|
28599
|
+
* - **ThreadSafety**: ReadSafe
|
|
28600
|
+
*
|
|
28601
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#EnableLOD)
|
|
28602
|
+
*/
|
|
28603
|
+
EnableLOD: boolean;
|
|
28604
|
+
/**
|
|
28605
|
+
* - **ThreadSafety**: ReadSafe
|
|
28606
|
+
*
|
|
28607
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#LODCriticality)
|
|
28608
|
+
*/
|
|
28609
|
+
LODCriticality: number;
|
|
28610
|
+
/**
|
|
28611
|
+
* - **ThreadSafety**: ReadSafe
|
|
28612
|
+
*
|
|
28613
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#Priority)
|
|
28614
|
+
*/
|
|
28615
|
+
Priority: number;
|
|
28616
|
+
/**
|
|
28617
|
+
* - **ThreadSafety**: ReadSafe
|
|
28618
|
+
*
|
|
28619
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#Source)
|
|
28620
|
+
*/
|
|
28621
|
+
Source: ProtectedString;
|
|
28622
|
+
/**
|
|
28623
|
+
* - **ThreadSafety**: Unsafe
|
|
28624
|
+
*
|
|
28625
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#AddTo)
|
|
28626
|
+
*/
|
|
28627
|
+
AddTo(this: AuroraScript, instance: Instance, parameters?: object): void;
|
|
28628
|
+
/**
|
|
28629
|
+
* - **ThreadSafety**: Unsafe
|
|
28630
|
+
*
|
|
28631
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#IsOnInstance)
|
|
28632
|
+
*/
|
|
28633
|
+
IsOnInstance(this: AuroraScript, instance: Instance): boolean;
|
|
28634
|
+
/**
|
|
28635
|
+
* - **ThreadSafety**: Unsafe
|
|
28636
|
+
*
|
|
28637
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#RemoveFrom)
|
|
28638
|
+
*/
|
|
28639
|
+
RemoveFrom(this: AuroraScript, instance: Instance): void;
|
|
28640
|
+
/**
|
|
28641
|
+
* - **ThreadSafety**: Unsafe
|
|
28642
|
+
*
|
|
28643
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#SignalFired)
|
|
28644
|
+
*/
|
|
28645
|
+
SignalFired(this: AuroraScript, instance: Instance, topic: string): RBXScriptSignal;
|
|
28646
|
+
}
|
|
28171
28647
|
/**
|
|
28172
28648
|
* The base class for all script objects which run automatically.
|
|
28173
28649
|
*
|
|
@@ -28540,9 +29016,10 @@ interface MarketplaceService extends Instance {
|
|
|
28540
29016
|
* @param player The user to prompt to purchase items.
|
|
28541
29017
|
* @param lineItems An array of avatar items to be included in the bulk purchase. Each line item contains the following structure:
|
|
28542
29018
|
* ```lua
|
|
28543
|
-
* { Type: MarketplaceProductType, Id: string }
|
|
29019
|
+
* { Type: MarketplaceProductType, Id: string, PurchaseOptions: { {Type: PurchaseOption, Value: number?} }? }
|
|
28544
29020
|
* ``` Each line item contains the following pairs: - `Type`: The corresponding `MarketplaceProductType` (Enum).
|
|
28545
29021
|
* - `Id`: The ID of the asset or bundle.
|
|
29022
|
+
* - `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
29023
|
*
|
|
28547
29024
|
*
|
|
28548
29025
|
* @param options Not available at this time.
|
|
@@ -28593,7 +29070,7 @@ interface MarketplaceService extends Instance {
|
|
|
28593
29070
|
* @param this The service responsible for in-experience transactions.
|
|
28594
29071
|
* @param player The user being prompted to purchase Premium.
|
|
28595
29072
|
*
|
|
28596
|
-
* @deprecated
|
|
29073
|
+
* @deprecated PromptRobloxSubscriptionPurchase
|
|
28597
29074
|
*/
|
|
28598
29075
|
PromptPremiumPurchase(this: MarketplaceService, player: Player): void;
|
|
28599
29076
|
/**
|
|
@@ -28673,7 +29150,7 @@ interface MarketplaceService extends Instance {
|
|
|
28673
29150
|
* @param infoType An `InfoType` enum value specifying the type of information being retrieved.
|
|
28674
29151
|
* @returns A dictionary containing information about the queried item, described in the previous tables.
|
|
28675
29152
|
*
|
|
28676
|
-
* @deprecated
|
|
29153
|
+
* @deprecated GetProductInfoAsync
|
|
28677
29154
|
*/
|
|
28678
29155
|
GetProductInfo(this: MarketplaceService, id: number): AssetProductInfo;
|
|
28679
29156
|
GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Asset>): AssetProductInfo;
|
|
@@ -28780,7 +29257,7 @@ interface MarketplaceService extends Instance {
|
|
|
28780
29257
|
* @param assetId The asset ID for which the given player's inventory is tested.
|
|
28781
29258
|
* @returns Indicates whether the given player's inventory contains the given asset.
|
|
28782
29259
|
*
|
|
28783
|
-
* @deprecated
|
|
29260
|
+
* @deprecated PlayerOwnsAssetAsync
|
|
28784
29261
|
*/
|
|
28785
29262
|
PlayerOwnsAsset(this: MarketplaceService, player: Player, assetId: number): boolean;
|
|
28786
29263
|
/**
|
|
@@ -28810,7 +29287,7 @@ interface MarketplaceService extends Instance {
|
|
|
28810
29287
|
* @param bundleId The bundle ID for which the given player's inventory is tested.
|
|
28811
29288
|
* @returns Indicates whether the given player's inventory contains the given bundle.
|
|
28812
29289
|
*
|
|
28813
|
-
* @deprecated
|
|
29290
|
+
* @deprecated PlayerOwnsBundleAsync
|
|
28814
29291
|
*/
|
|
28815
29292
|
PlayerOwnsBundle(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
28816
29293
|
/**
|
|
@@ -29849,7 +30326,7 @@ interface Mouse extends Instance {
|
|
|
29849
30326
|
*
|
|
29850
30327
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#KeyDown)
|
|
29851
30328
|
*
|
|
29852
|
-
* @deprecated
|
|
30329
|
+
* @deprecated InputBegan
|
|
29853
30330
|
*/
|
|
29854
30331
|
readonly KeyDown: RBXScriptSignal<(key: string) => void>;
|
|
29855
30332
|
/**
|
|
@@ -29862,7 +30339,7 @@ interface Mouse extends Instance {
|
|
|
29862
30339
|
*
|
|
29863
30340
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#KeyUp)
|
|
29864
30341
|
*
|
|
29865
|
-
* @deprecated
|
|
30342
|
+
* @deprecated InputEnded
|
|
29866
30343
|
*/
|
|
29867
30344
|
readonly KeyUp: RBXScriptSignal<(key: string) => void>;
|
|
29868
30345
|
/**
|
|
@@ -30008,7 +30485,7 @@ interface OmniRecommendationsService extends Instance {
|
|
|
30008
30485
|
*
|
|
30009
30486
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1)
|
|
30010
30487
|
*
|
|
30011
|
-
* @deprecated
|
|
30488
|
+
* @deprecated HttpService
|
|
30012
30489
|
*/
|
|
30013
30490
|
interface OpenCloudApiV1 extends Instance {
|
|
30014
30491
|
/**
|
|
@@ -30054,7 +30531,7 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
30054
30531
|
*
|
|
30055
30532
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudService)
|
|
30056
30533
|
*
|
|
30057
|
-
* @deprecated
|
|
30534
|
+
* @deprecated HttpService
|
|
30058
30535
|
*/
|
|
30059
30536
|
interface OpenCloudService extends Instance {
|
|
30060
30537
|
/**
|
|
@@ -30391,7 +30868,7 @@ interface BasePart extends PVInstance {
|
|
|
30391
30868
|
*
|
|
30392
30869
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#CollisionGroupId)
|
|
30393
30870
|
*
|
|
30394
|
-
* @deprecated
|
|
30871
|
+
* @deprecated CollisionGroup
|
|
30395
30872
|
*/
|
|
30396
30873
|
CollisionGroupId: number;
|
|
30397
30874
|
/**
|
|
@@ -30743,7 +31220,7 @@ interface BasePart extends PVInstance {
|
|
|
30743
31220
|
*
|
|
30744
31221
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#RotVelocity)
|
|
30745
31222
|
*
|
|
30746
|
-
* @deprecated
|
|
31223
|
+
* @deprecated AssemblyAngularVelocity
|
|
30747
31224
|
*/
|
|
30748
31225
|
RotVelocity: Vector3;
|
|
30749
31226
|
/**
|
|
@@ -30756,7 +31233,7 @@ interface BasePart extends PVInstance {
|
|
|
30756
31233
|
*/
|
|
30757
31234
|
Rotation: Vector3;
|
|
30758
31235
|
/**
|
|
30759
|
-
* Determines the dimensions of a part (length,
|
|
31236
|
+
* Determines the dimensions of a part (length, height, width).
|
|
30760
31237
|
*
|
|
30761
31238
|
* - **ThreadSafety**: ReadSafe
|
|
30762
31239
|
* - **Tags**: NotReplicated
|
|
@@ -30842,7 +31319,7 @@ interface BasePart extends PVInstance {
|
|
|
30842
31319
|
*
|
|
30843
31320
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#Velocity)
|
|
30844
31321
|
*
|
|
30845
|
-
* @deprecated
|
|
31322
|
+
* @deprecated AssemblyLinearVelocity
|
|
30846
31323
|
*/
|
|
30847
31324
|
Velocity: Vector3;
|
|
30848
31325
|
/**
|
|
@@ -31020,7 +31497,7 @@ interface BasePart extends PVInstance {
|
|
|
31020
31497
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
31021
31498
|
* @returns The base part of an assembly (a collection of parts connected together).
|
|
31022
31499
|
*
|
|
31023
|
-
* @deprecated
|
|
31500
|
+
* @deprecated AssemblyRootPart
|
|
31024
31501
|
*/
|
|
31025
31502
|
GetRootPart(this: BasePart): BasePart;
|
|
31026
31503
|
/**
|
|
@@ -31200,7 +31677,7 @@ interface BasePart extends PVInstance {
|
|
|
31200
31677
|
*
|
|
31201
31678
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#StoppedTouching)
|
|
31202
31679
|
*
|
|
31203
|
-
* @deprecated
|
|
31680
|
+
* @deprecated TouchEnded
|
|
31204
31681
|
*/
|
|
31205
31682
|
readonly StoppedTouching: RBXScriptSignal<(otherPart: BasePart) => void>;
|
|
31206
31683
|
/**
|
|
@@ -31301,6 +31778,20 @@ interface Platform extends Part {
|
|
|
31301
31778
|
* @deprecated
|
|
31302
31779
|
*/
|
|
31303
31780
|
readonly _nominal_Platform: unique symbol;
|
|
31781
|
+
/**
|
|
31782
|
+
* - **ThreadSafety**: Unsafe
|
|
31783
|
+
* - **Tags**: Hidden
|
|
31784
|
+
*
|
|
31785
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Platform#RemoteCreateMotor6D)
|
|
31786
|
+
*/
|
|
31787
|
+
readonly RemoteCreateMotor6D: RBXScriptSignal<(humanoid: Instance) => void>;
|
|
31788
|
+
/**
|
|
31789
|
+
* - **ThreadSafety**: Unsafe
|
|
31790
|
+
* - **Tags**: Hidden
|
|
31791
|
+
*
|
|
31792
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Platform#RemoteDestroyMotor6D)
|
|
31793
|
+
*/
|
|
31794
|
+
readonly RemoteDestroyMotor6D: RBXScriptSignal<() => void>;
|
|
31304
31795
|
}
|
|
31305
31796
|
/**
|
|
31306
31797
|
* 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 +31834,20 @@ interface Seat extends Part {
|
|
|
31343
31834
|
* @param humanoid
|
|
31344
31835
|
*/
|
|
31345
31836
|
Sit(this: Seat, humanoid: Humanoid | undefined): void;
|
|
31837
|
+
/**
|
|
31838
|
+
* - **ThreadSafety**: Unsafe
|
|
31839
|
+
* - **Tags**: Hidden
|
|
31840
|
+
*
|
|
31841
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Seat#RemoteCreateSeatWeld)
|
|
31842
|
+
*/
|
|
31843
|
+
readonly RemoteCreateSeatWeld: RBXScriptSignal<(humanoid: Instance) => void>;
|
|
31844
|
+
/**
|
|
31845
|
+
* - **ThreadSafety**: Unsafe
|
|
31846
|
+
* - **Tags**: Hidden
|
|
31847
|
+
*
|
|
31848
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Seat#RemoteDestroySeatWeld)
|
|
31849
|
+
*/
|
|
31850
|
+
readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
|
|
31346
31851
|
}
|
|
31347
31852
|
/**
|
|
31348
31853
|
* **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 +31939,20 @@ interface SkateboardPlatform extends Part {
|
|
|
31434
31939
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#MoveStateChanged)
|
|
31435
31940
|
*/
|
|
31436
31941
|
readonly MoveStateChanged: RBXScriptSignal<(newState: Enum.MoveState, oldState: Enum.MoveState) => void>;
|
|
31942
|
+
/**
|
|
31943
|
+
* - **ThreadSafety**: Unsafe
|
|
31944
|
+
* - **Tags**: Hidden
|
|
31945
|
+
*
|
|
31946
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#RemoteCreateMotor6D)
|
|
31947
|
+
*/
|
|
31948
|
+
readonly RemoteCreateMotor6D: RBXScriptSignal<(humanoid: Instance) => void>;
|
|
31949
|
+
/**
|
|
31950
|
+
* - **ThreadSafety**: Unsafe
|
|
31951
|
+
* - **Tags**: Hidden
|
|
31952
|
+
*
|
|
31953
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#RemoteDestroyMotor6D)
|
|
31954
|
+
*/
|
|
31955
|
+
readonly RemoteDestroyMotor6D: RBXScriptSignal<() => void>;
|
|
31437
31956
|
/**
|
|
31438
31957
|
* Fired whenever the skateboard is unequipped.
|
|
31439
31958
|
*
|
|
@@ -32408,6 +32927,20 @@ interface VehicleSeat extends BasePart {
|
|
|
32408
32927
|
* @param humanoid The `Humanoid` being forced to sit in the `VehicleSeat`.
|
|
32409
32928
|
*/
|
|
32410
32929
|
Sit(this: VehicleSeat, humanoid: Instance): void;
|
|
32930
|
+
/**
|
|
32931
|
+
* - **ThreadSafety**: Unsafe
|
|
32932
|
+
* - **Tags**: Hidden
|
|
32933
|
+
*
|
|
32934
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#RemoteCreateSeatWeld)
|
|
32935
|
+
*/
|
|
32936
|
+
readonly RemoteCreateSeatWeld: RBXScriptSignal<(humanoid: Instance) => void>;
|
|
32937
|
+
/**
|
|
32938
|
+
* - **ThreadSafety**: Unsafe
|
|
32939
|
+
* - **Tags**: Hidden
|
|
32940
|
+
*
|
|
32941
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#RemoteDestroySeatWeld)
|
|
32942
|
+
*/
|
|
32943
|
+
readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
|
|
32411
32944
|
}
|
|
32412
32945
|
/**
|
|
32413
32946
|
* A class which defines a view of the 3D world.
|
|
@@ -32457,7 +32990,7 @@ interface Camera extends PVInstance {
|
|
|
32457
32990
|
*
|
|
32458
32991
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CoordinateFrame)
|
|
32459
32992
|
*
|
|
32460
|
-
* @deprecated
|
|
32993
|
+
* @deprecated CFrame
|
|
32461
32994
|
*/
|
|
32462
32995
|
CoordinateFrame: CFrame;
|
|
32463
32996
|
/**
|
|
@@ -32744,7 +33277,7 @@ interface Camera extends PVInstance {
|
|
|
32744
33277
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToViewportPoint)
|
|
32745
33278
|
* @param this A class which defines a view of the 3D world.
|
|
32746
33279
|
* @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.
|
|
33280
|
+
* @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
33281
|
* - A boolean indicating if the `worldPoint` is within the bounds of the screen.
|
|
32749
33282
|
*/
|
|
32750
33283
|
WorldToViewportPoint(this: Camera, worldPoint: Vector3): LuaTuple<[
|
|
@@ -32868,7 +33401,7 @@ interface Model extends PVInstance {
|
|
|
32868
33401
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetModelCFrame)
|
|
32869
33402
|
* @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
33403
|
*
|
|
32871
|
-
* @deprecated
|
|
33404
|
+
* @deprecated GetPrimaryPartCFrame
|
|
32872
33405
|
*/
|
|
32873
33406
|
GetModelCFrame(this: Model): CFrame;
|
|
32874
33407
|
/**
|
|
@@ -32882,7 +33415,7 @@ interface Model extends PVInstance {
|
|
|
32882
33415
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetModelSize)
|
|
32883
33416
|
* @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
33417
|
*
|
|
32885
|
-
* @deprecated
|
|
33418
|
+
* @deprecated GetExtentsSize
|
|
32886
33419
|
*/
|
|
32887
33420
|
GetModelSize(this: Model): Vector3;
|
|
32888
33421
|
/**
|
|
@@ -32906,7 +33439,7 @@ interface Model extends PVInstance {
|
|
|
32906
33439
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetPrimaryPartCFrame)
|
|
32907
33440
|
* @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
33441
|
*
|
|
32909
|
-
* @deprecated
|
|
33442
|
+
* @deprecated GetPivot
|
|
32910
33443
|
*/
|
|
32911
33444
|
GetPrimaryPartCFrame(this: Model): CFrame;
|
|
32912
33445
|
/**
|
|
@@ -32964,7 +33497,7 @@ interface Model extends PVInstance {
|
|
|
32964
33497
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#ResetOrientationToIdentity)
|
|
32965
33498
|
* @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
33499
|
*
|
|
32967
|
-
* @deprecated
|
|
33500
|
+
* @deprecated SetPrimaryPartCFrame
|
|
32968
33501
|
*/
|
|
32969
33502
|
ResetOrientationToIdentity(this: Model): void;
|
|
32970
33503
|
/**
|
|
@@ -32988,7 +33521,7 @@ interface Model extends PVInstance {
|
|
|
32988
33521
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#SetIdentityOrientation)
|
|
32989
33522
|
* @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
33523
|
*
|
|
32991
|
-
* @deprecated
|
|
33524
|
+
* @deprecated SetPrimaryPartCFrame
|
|
32992
33525
|
*/
|
|
32993
33526
|
SetIdentityOrientation(this: Model): void;
|
|
32994
33527
|
/**
|
|
@@ -33003,7 +33536,7 @@ interface Model extends PVInstance {
|
|
|
33003
33536
|
* @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
33537
|
* @param cframe The `CFrame` to be set.
|
|
33005
33538
|
*
|
|
33006
|
-
* @deprecated
|
|
33539
|
+
* @deprecated PivotTo
|
|
33007
33540
|
*/
|
|
33008
33541
|
SetPrimaryPartCFrame(this: Model, cframe: CFrame): void;
|
|
33009
33542
|
/**
|
|
@@ -33377,7 +33910,7 @@ interface WorldRoot extends Model {
|
|
|
33377
33910
|
* @param ignoreWater
|
|
33378
33911
|
* @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
33912
|
*
|
|
33380
|
-
* @deprecated
|
|
33913
|
+
* @deprecated Raycast
|
|
33381
33914
|
*/
|
|
33382
33915
|
FindPartOnRay(this: WorldRoot, ray: Ray, ignoreDescendantsInstance?: Instance, terrainCellsAreCubes?: boolean, ignoreWater?: boolean): LuaTuple<[
|
|
33383
33916
|
BasePart | undefined,
|
|
@@ -33401,7 +33934,7 @@ interface WorldRoot extends Model {
|
|
|
33401
33934
|
* @param ignoreWater
|
|
33402
33935
|
* @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
33936
|
*
|
|
33404
|
-
* @deprecated
|
|
33937
|
+
* @deprecated Raycast
|
|
33405
33938
|
*/
|
|
33406
33939
|
FindPartOnRayWithIgnoreList(this: WorldRoot, ray: Ray, ignoreDescendantsTable: Array<Instance>, terrainCellsAreCubes?: boolean, ignoreWater?: boolean): LuaTuple<[
|
|
33407
33940
|
BasePart | undefined,
|
|
@@ -33424,7 +33957,7 @@ interface WorldRoot extends Model {
|
|
|
33424
33957
|
* @param ignoreWater
|
|
33425
33958
|
* @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
33959
|
*
|
|
33427
|
-
* @deprecated
|
|
33960
|
+
* @deprecated Raycast
|
|
33428
33961
|
*/
|
|
33429
33962
|
FindPartOnRayWithWhitelist(this: WorldRoot, ray: Ray, whitelistDescendantsTable: Array<Instance>, ignoreWater?: boolean): LuaTuple<[
|
|
33430
33963
|
BasePart | undefined,
|
|
@@ -33447,7 +33980,7 @@ interface WorldRoot extends Model {
|
|
|
33447
33980
|
* @param maxParts The maximum amount of `BaseParts` to be returned.
|
|
33448
33981
|
* @returns An array of `BaseParts` within the `Region3`.
|
|
33449
33982
|
*
|
|
33450
|
-
* @deprecated
|
|
33983
|
+
* @deprecated GetPartBoundsInBox
|
|
33451
33984
|
*/
|
|
33452
33985
|
FindPartsInRegion3(this: WorldRoot, region: Region3, ignoreDescendantsInstance?: Instance, maxParts?: number): Array<BasePart>;
|
|
33453
33986
|
/**
|
|
@@ -33465,7 +33998,7 @@ interface WorldRoot extends Model {
|
|
|
33465
33998
|
* @param maxParts The maximum number of `BaseParts` to be returned.
|
|
33466
33999
|
* @returns An array of `BaseParts` found within the `Region3`.
|
|
33467
34000
|
*
|
|
33468
|
-
* @deprecated
|
|
34001
|
+
* @deprecated GetPartBoundsInBox
|
|
33469
34002
|
*/
|
|
33470
34003
|
FindPartsInRegion3WithIgnoreList(this: WorldRoot, region: Region3, ignoreDescendantsTable: Array<Instance>, maxParts?: number): Array<BasePart>;
|
|
33471
34004
|
/**
|
|
@@ -33483,7 +34016,7 @@ interface WorldRoot extends Model {
|
|
|
33483
34016
|
* @param maxParts The maximum number of `BaseParts` to be returned.
|
|
33484
34017
|
* @returns An array of `BaseParts` within the `Region3`.
|
|
33485
34018
|
*
|
|
33486
|
-
* @deprecated
|
|
34019
|
+
* @deprecated GetPartBoundsInBox
|
|
33487
34020
|
*/
|
|
33488
34021
|
FindPartsInRegion3WithWhiteList(this: WorldRoot, region: Region3, whitelistDescendantsTable: Array<Instance>, maxParts?: number): Array<BasePart>;
|
|
33489
34022
|
/**
|
|
@@ -33541,7 +34074,7 @@ interface WorldRoot extends Model {
|
|
|
33541
34074
|
* @param ignoreDescendentsInstance An `Instance` to be ignored.
|
|
33542
34075
|
* @returns True if the `Region3` is empty.
|
|
33543
34076
|
*
|
|
33544
|
-
* @deprecated
|
|
34077
|
+
* @deprecated GetPartBoundsInBox
|
|
33545
34078
|
*/
|
|
33546
34079
|
IsRegion3Empty(this: WorldRoot, region: Region3, ignoreDescendentsInstance?: Instance): boolean;
|
|
33547
34080
|
/**
|
|
@@ -33558,7 +34091,7 @@ interface WorldRoot extends Model {
|
|
|
33558
34091
|
* @param ignoreDescendentsTable An array of objects to be ignored.
|
|
33559
34092
|
* @returns True if the `Region3` is empty.
|
|
33560
34093
|
*
|
|
33561
|
-
* @deprecated
|
|
34094
|
+
* @deprecated GetPartBoundsInBox
|
|
33562
34095
|
*/
|
|
33563
34096
|
IsRegion3EmptyWithIgnoreList(this: WorldRoot, region: Region3, ignoreDescendentsTable: Array<Instance>): boolean;
|
|
33564
34097
|
/**
|
|
@@ -34529,7 +35062,7 @@ interface ParticleEmitter extends Instance {
|
|
|
34529
35062
|
*
|
|
34530
35063
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#VelocitySpread)
|
|
34531
35064
|
*
|
|
34532
|
-
* @deprecated
|
|
35065
|
+
* @deprecated SpreadAngle
|
|
34533
35066
|
*/
|
|
34534
35067
|
VelocitySpread: number;
|
|
34535
35068
|
/**
|
|
@@ -34567,6 +35100,20 @@ interface ParticleEmitter extends Instance {
|
|
|
34567
35100
|
* @param particleCount The number of particles to emit.
|
|
34568
35101
|
*/
|
|
34569
35102
|
Emit(this: ParticleEmitter, particleCount?: number): void;
|
|
35103
|
+
/**
|
|
35104
|
+
* - **ThreadSafety**: Unsafe
|
|
35105
|
+
* - **Tags**: Hidden
|
|
35106
|
+
*
|
|
35107
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#OnClearRequested)
|
|
35108
|
+
*/
|
|
35109
|
+
readonly OnClearRequested: RBXScriptSignal<() => void>;
|
|
35110
|
+
/**
|
|
35111
|
+
* - **ThreadSafety**: Unsafe
|
|
35112
|
+
* - **Tags**: Hidden
|
|
35113
|
+
*
|
|
35114
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#OnEmitRequested)
|
|
35115
|
+
*/
|
|
35116
|
+
readonly OnEmitRequested: RBXScriptSignal<(particleCount: number) => void>;
|
|
34570
35117
|
}
|
|
34571
35118
|
/**
|
|
34572
35119
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -34667,7 +35214,7 @@ interface Path extends Instance {
|
|
|
34667
35214
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path#GetPointCoordinates)
|
|
34668
35215
|
* @param this Stores the result of paths created by `PathfindingService:CreatePath()`.
|
|
34669
35216
|
*
|
|
34670
|
-
* @deprecated
|
|
35217
|
+
* @deprecated GetWaypoints
|
|
34671
35218
|
*/
|
|
34672
35219
|
GetPointCoordinates(this: Path): Array<unknown>;
|
|
34673
35220
|
/**
|
|
@@ -34851,7 +35398,7 @@ interface PathfindingService extends Instance {
|
|
|
34851
35398
|
* @param maxDistance
|
|
34852
35399
|
* @returns A `Path` object.
|
|
34853
35400
|
*
|
|
34854
|
-
* @deprecated
|
|
35401
|
+
* @deprecated FindPathAsync
|
|
34855
35402
|
*/
|
|
34856
35403
|
ComputeRawPathAsync(this: PathfindingService, start: Vector3, finish: Vector3, maxDistance: number): Path;
|
|
34857
35404
|
/**
|
|
@@ -34868,7 +35415,7 @@ interface PathfindingService extends Instance {
|
|
|
34868
35415
|
* @param finish
|
|
34869
35416
|
* @param maxDistance
|
|
34870
35417
|
*
|
|
34871
|
-
* @deprecated
|
|
35418
|
+
* @deprecated FindPathAsync
|
|
34872
35419
|
*/
|
|
34873
35420
|
ComputeSmoothPathAsync(this: PathfindingService, start: Vector3, finish: Vector3, maxDistance: number): Path;
|
|
34874
35421
|
/**
|
|
@@ -34972,7 +35519,7 @@ interface PhysicsService extends Instance {
|
|
|
34972
35519
|
* @param name
|
|
34973
35520
|
* @param part
|
|
34974
35521
|
*
|
|
34975
|
-
* @deprecated
|
|
35522
|
+
* @deprecated CollisionGroup
|
|
34976
35523
|
*/
|
|
34977
35524
|
CollisionGroupContainsPart(this: PhysicsService, name: string, part: BasePart): boolean;
|
|
34978
35525
|
/**
|
|
@@ -35010,7 +35557,7 @@ interface PhysicsService extends Instance {
|
|
|
35010
35557
|
* @param this
|
|
35011
35558
|
* @param name
|
|
35012
35559
|
*
|
|
35013
|
-
* @deprecated
|
|
35560
|
+
* @deprecated RegisterCollisionGroup
|
|
35014
35561
|
*/
|
|
35015
35562
|
CreateCollisionGroup(this: PhysicsService, name: string): number;
|
|
35016
35563
|
/**
|
|
@@ -35026,7 +35573,7 @@ interface PhysicsService extends Instance {
|
|
|
35026
35573
|
* @param name The name of the collision group being retrieved.
|
|
35027
35574
|
* @returns The ID of the retrieved collision group, or `nil` if no such group exists.
|
|
35028
35575
|
*
|
|
35029
|
-
* @deprecated
|
|
35576
|
+
* @deprecated CollisionGroup
|
|
35030
35577
|
*/
|
|
35031
35578
|
GetCollisionGroupId(this: PhysicsService, name: string): number;
|
|
35032
35579
|
/**
|
|
@@ -35041,7 +35588,7 @@ interface PhysicsService extends Instance {
|
|
|
35041
35588
|
* @param this
|
|
35042
35589
|
* @param name
|
|
35043
35590
|
*
|
|
35044
|
-
* @deprecated
|
|
35591
|
+
* @deprecated CollisionGroup
|
|
35045
35592
|
*/
|
|
35046
35593
|
GetCollisionGroupName(this: PhysicsService, name: number): string;
|
|
35047
35594
|
/**
|
|
@@ -35055,7 +35602,7 @@ interface PhysicsService extends Instance {
|
|
|
35055
35602
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetCollisionGroups)
|
|
35056
35603
|
* @param this
|
|
35057
35604
|
*
|
|
35058
|
-
* @deprecated
|
|
35605
|
+
* @deprecated GetRegisteredCollisionGroups
|
|
35059
35606
|
*/
|
|
35060
35607
|
GetCollisionGroups(this: PhysicsService): Array<CollisionGroupInfo & {
|
|
35061
35608
|
id: number;
|
|
@@ -35110,7 +35657,7 @@ interface PhysicsService extends Instance {
|
|
|
35110
35657
|
* @param this
|
|
35111
35658
|
* @param name
|
|
35112
35659
|
*
|
|
35113
|
-
* @deprecated
|
|
35660
|
+
* @deprecated UnregisterCollisionGroup
|
|
35114
35661
|
*/
|
|
35115
35662
|
RemoveCollisionGroup(this: PhysicsService, name: string): void;
|
|
35116
35663
|
/**
|
|
@@ -35137,7 +35684,7 @@ interface PhysicsService extends Instance {
|
|
|
35137
35684
|
* @param part The part being set.
|
|
35138
35685
|
* @param name The name of collision group that the part's collision group is being set to.
|
|
35139
35686
|
*
|
|
35140
|
-
* @deprecated
|
|
35687
|
+
* @deprecated CollisionGroup
|
|
35141
35688
|
*/
|
|
35142
35689
|
SetPartCollisionGroup(this: PhysicsService, part: BasePart, name: string): void;
|
|
35143
35690
|
/**
|
|
@@ -35328,7 +35875,7 @@ interface Player extends Instance {
|
|
|
35328
35875
|
*
|
|
35329
35876
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#CharacterAppearance)
|
|
35330
35877
|
*
|
|
35331
|
-
* @deprecated
|
|
35878
|
+
* @deprecated CharacterAppearanceId
|
|
35332
35879
|
*/
|
|
35333
35880
|
CharacterAppearance: string;
|
|
35334
35881
|
/**
|
|
@@ -35595,10 +36142,14 @@ interface Player extends Instance {
|
|
|
35595
36142
|
*/
|
|
35596
36143
|
DistanceFromCharacter(this: Player, point: Vector3): number;
|
|
35597
36144
|
/**
|
|
36145
|
+
* Returns a dictionary containing the player's current camera state.
|
|
36146
|
+
*
|
|
35598
36147
|
* - **ThreadSafety**: Safe
|
|
35599
36148
|
* - **Tags**: CustomLuaState
|
|
35600
36149
|
*
|
|
35601
36150
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetCameraState)
|
|
36151
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
36152
|
+
* @returns A dictionary containing `CFrame`, `FieldOfView`, and `ViewportSize` values.
|
|
35602
36153
|
*/
|
|
35603
36154
|
GetCameraState(this: Player): object;
|
|
35604
36155
|
/**
|
|
@@ -35845,7 +36396,7 @@ interface Player extends Instance {
|
|
|
35845
36396
|
* @param maxFriends The maximum number of online friends to return.
|
|
35846
36397
|
* @returns A dictionary of online friends (see the table above).
|
|
35847
36398
|
*
|
|
35848
|
-
* @deprecated
|
|
36399
|
+
* @deprecated GetFriendsOnlineAsync
|
|
35849
36400
|
*/
|
|
35850
36401
|
GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
|
|
35851
36402
|
/**
|
|
@@ -35882,7 +36433,7 @@ interface Player extends Instance {
|
|
|
35882
36433
|
* @param groupId The `groupId` of the specified group.
|
|
35883
36434
|
* @returns The player's rank in the group.
|
|
35884
36435
|
*
|
|
35885
|
-
* @deprecated
|
|
36436
|
+
* @deprecated GetRankInGroupAsync
|
|
35886
36437
|
*/
|
|
35887
36438
|
GetRankInGroup(this: Player, groupId: number): number;
|
|
35888
36439
|
/**
|
|
@@ -35898,7 +36449,7 @@ interface Player extends Instance {
|
|
|
35898
36449
|
* @param groupId The `groupId` of the specified group.
|
|
35899
36450
|
* @returns The player's rank in the group.
|
|
35900
36451
|
*
|
|
35901
|
-
* @deprecated
|
|
36452
|
+
* @deprecated GetRolesInGroupAsync
|
|
35902
36453
|
*/
|
|
35903
36454
|
GetRankInGroupAsync(this: Player, groupId: number): number;
|
|
35904
36455
|
/**
|
|
@@ -35914,7 +36465,7 @@ interface Player extends Instance {
|
|
|
35914
36465
|
* @param groupId The group ID of the specified group.
|
|
35915
36466
|
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
35916
36467
|
*
|
|
35917
|
-
* @deprecated
|
|
36468
|
+
* @deprecated GetRoleInGroupAsync
|
|
35918
36469
|
*/
|
|
35919
36470
|
GetRoleInGroup(this: Player, groupId: number): string;
|
|
35920
36471
|
/**
|
|
@@ -35930,7 +36481,7 @@ interface Player extends Instance {
|
|
|
35930
36481
|
* @param groupId The group ID of the specified group.
|
|
35931
36482
|
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
35932
36483
|
*
|
|
35933
|
-
* @deprecated
|
|
36484
|
+
* @deprecated GetRolesInGroupAsync
|
|
35934
36485
|
*/
|
|
35935
36486
|
GetRoleInGroupAsync(this: Player, groupId: number): string;
|
|
35936
36487
|
/**
|
|
@@ -35951,7 +36502,7 @@ interface Player extends Instance {
|
|
|
35951
36502
|
/**
|
|
35952
36503
|
* **Deprecated:** This method has been superseded by the `Player:IsFriendsWithAsync()` method which should be used for new work.
|
|
35953
36504
|
*
|
|
35954
|
-
* Checks whether a player is a friend of the user with the given
|
|
36505
|
+
* Checks whether a player is a friend of the user with the given
|
|
35955
36506
|
*
|
|
35956
36507
|
* - **ThreadSafety**: Unsafe
|
|
35957
36508
|
* - **Tags**: Yields
|
|
@@ -35961,7 +36512,7 @@ interface Player extends Instance {
|
|
|
35961
36512
|
* @param userId The `Player.UserId` of the specified player.
|
|
35962
36513
|
* @returns A boolean indicating whether a player is a friend of the specified user.
|
|
35963
36514
|
*
|
|
35964
|
-
* @deprecated
|
|
36515
|
+
* @deprecated IsFriendsWithAsync
|
|
35965
36516
|
*/
|
|
35966
36517
|
IsFriendsWith(this: Player, userId: User): boolean;
|
|
35967
36518
|
/**
|
|
@@ -35989,7 +36540,7 @@ interface Player extends Instance {
|
|
|
35989
36540
|
* @param groupId The group ID of the specified group.
|
|
35990
36541
|
* @returns A boolean indicating whether the player is in the specified group.
|
|
35991
36542
|
*
|
|
35992
|
-
* @deprecated
|
|
36543
|
+
* @deprecated IsInGroupAsync
|
|
35993
36544
|
*/
|
|
35994
36545
|
IsInGroup(this: Player, groupId: number): boolean;
|
|
35995
36546
|
/**
|
|
@@ -36015,7 +36566,7 @@ interface Player extends Instance {
|
|
|
36015
36566
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacter)
|
|
36016
36567
|
* @param this An object that represents a presently connected client to the experience.
|
|
36017
36568
|
*
|
|
36018
|
-
* @deprecated
|
|
36569
|
+
* @deprecated LoadCharacterAsync
|
|
36019
36570
|
*/
|
|
36020
36571
|
LoadCharacter(this: Player): void;
|
|
36021
36572
|
/**
|
|
@@ -36041,7 +36592,7 @@ interface Player extends Instance {
|
|
|
36041
36592
|
* @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
36593
|
* @param assetTypeVerification The asset type verification mode.
|
|
36043
36594
|
*
|
|
36044
|
-
* @deprecated
|
|
36595
|
+
* @deprecated LoadCharacterWithHumanoidDescriptionAsync
|
|
36045
36596
|
*/
|
|
36046
36597
|
LoadCharacterWithHumanoidDescription(this: Player, humanoidDescription: HumanoidDescription): void;
|
|
36047
36598
|
/**
|
|
@@ -36582,7 +37133,7 @@ interface Players extends Instance {
|
|
|
36582
37133
|
*
|
|
36583
37134
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#NumPlayers)
|
|
36584
37135
|
*
|
|
36585
|
-
* @deprecated
|
|
37136
|
+
* @deprecated GetPlayers
|
|
36586
37137
|
*/
|
|
36587
37138
|
readonly NumPlayers: number;
|
|
36588
37139
|
/**
|
|
@@ -36664,7 +37215,7 @@ interface Players extends Instance {
|
|
|
36664
37215
|
* @param assetTypeVerification The asset type verification mode.
|
|
36665
37216
|
* @returns A `Humanoid` character `Model`.
|
|
36666
37217
|
*
|
|
36667
|
-
* @deprecated
|
|
37218
|
+
* @deprecated CreateHumanoidModelFromDescriptionAsync
|
|
36668
37219
|
*/
|
|
36669
37220
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
36670
37221
|
/**
|
|
@@ -36694,7 +37245,7 @@ interface Players extends Instance {
|
|
|
36694
37245
|
* @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
37246
|
* @returns A Humanoid character Model.
|
|
36696
37247
|
*
|
|
36697
|
-
* @deprecated
|
|
37248
|
+
* @deprecated CreateHumanoidModelFromUserIdAsync
|
|
36698
37249
|
*/
|
|
36699
37250
|
CreateHumanoidModelFromUserId(this: Players, userId: User): Model;
|
|
36700
37251
|
/**
|
|
@@ -36772,7 +37323,7 @@ interface Players extends Instance {
|
|
|
36772
37323
|
* @param outfitId The ID of the outfit for which the HumanoidDescription is sought.
|
|
36773
37324
|
* @returns HumanoidDescription initialized with the specification for the passed in outfitId.
|
|
36774
37325
|
*
|
|
36775
|
-
* @deprecated
|
|
37326
|
+
* @deprecated GetHumanoidDescriptionFromOutfitIdAsync
|
|
36776
37327
|
*/
|
|
36777
37328
|
GetHumanoidDescriptionFromOutfitId(this: Players, outfitId: number): HumanoidDescription;
|
|
36778
37329
|
/**
|
|
@@ -36800,7 +37351,7 @@ interface Players extends Instance {
|
|
|
36800
37351
|
* @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
37352
|
* @returns HumanoidDescription initialized with the passed in user's avatar specification.
|
|
36802
37353
|
*
|
|
36803
|
-
* @deprecated
|
|
37354
|
+
* @deprecated GetHumanoidDescriptionFromUserIdAsync
|
|
36804
37355
|
*/
|
|
36805
37356
|
GetHumanoidDescriptionFromUserId(this: Players, userId: User): HumanoidDescription;
|
|
36806
37357
|
/**
|
|
@@ -37031,6 +37582,21 @@ interface PolicyService extends Instance {
|
|
|
37031
37582
|
*/
|
|
37032
37583
|
GetPolicyInfoForPlayerAsync(this: PolicyService, player: Player): PolicyInfo;
|
|
37033
37584
|
}
|
|
37585
|
+
/**
|
|
37586
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
37587
|
+
*
|
|
37588
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PopLatencyService)
|
|
37589
|
+
*/
|
|
37590
|
+
interface PopLatencyService extends Instance {
|
|
37591
|
+
/**
|
|
37592
|
+
* **DO NOT USE!**
|
|
37593
|
+
*
|
|
37594
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
37595
|
+
* @hidden
|
|
37596
|
+
* @deprecated
|
|
37597
|
+
*/
|
|
37598
|
+
readonly _nominal_PopLatencyService: unique symbol;
|
|
37599
|
+
}
|
|
37034
37600
|
/**
|
|
37035
37601
|
* Base class of all 'Pose Instance' objects.
|
|
37036
37602
|
*
|
|
@@ -37836,6 +38402,13 @@ interface RealtimeMedia extends Instance {
|
|
|
37836
38402
|
* @deprecated
|
|
37837
38403
|
*/
|
|
37838
38404
|
readonly _nominal_RealtimeMedia: unique symbol;
|
|
38405
|
+
/**
|
|
38406
|
+
* - **ThreadSafety**: ReadSafe
|
|
38407
|
+
* - **Tags**: NotReplicated
|
|
38408
|
+
*
|
|
38409
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#AudioInputActive)
|
|
38410
|
+
*/
|
|
38411
|
+
readonly AudioInputActive: boolean;
|
|
37839
38412
|
/**
|
|
37840
38413
|
* - **ThreadSafety**: ReadSafe
|
|
37841
38414
|
* - **Tags**: NotReplicated
|
|
@@ -38213,6 +38786,34 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
|
|
|
38213
38786
|
* @returns Values returned from the `OnServerInvoke` callback.
|
|
38214
38787
|
*/
|
|
38215
38788
|
InvokeServer(this: RemoteFunction, ...args: Parameters<T>): ReturnType<T>;
|
|
38789
|
+
/**
|
|
38790
|
+
* - **ThreadSafety**: Unsafe
|
|
38791
|
+
* - **Tags**: Hidden
|
|
38792
|
+
*
|
|
38793
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeClient)
|
|
38794
|
+
*/
|
|
38795
|
+
readonly RemoteOnInvokeClient: RBXScriptSignal<(id: number, arguments: unknown) => void>;
|
|
38796
|
+
/**
|
|
38797
|
+
* - **ThreadSafety**: Unsafe
|
|
38798
|
+
* - **Tags**: Hidden
|
|
38799
|
+
*
|
|
38800
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeError)
|
|
38801
|
+
*/
|
|
38802
|
+
readonly RemoteOnInvokeError: RBXScriptSignal<(id: number, arguments: string) => void>;
|
|
38803
|
+
/**
|
|
38804
|
+
* - **ThreadSafety**: Unsafe
|
|
38805
|
+
* - **Tags**: Hidden
|
|
38806
|
+
*
|
|
38807
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeServer)
|
|
38808
|
+
*/
|
|
38809
|
+
readonly RemoteOnInvokeServer: RBXScriptSignal<(id: number, player: Player, arguments: unknown) => void>;
|
|
38810
|
+
/**
|
|
38811
|
+
* - **ThreadSafety**: Unsafe
|
|
38812
|
+
* - **Tags**: Hidden
|
|
38813
|
+
*
|
|
38814
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeSuccess)
|
|
38815
|
+
*/
|
|
38816
|
+
readonly RemoteOnInvokeSuccess: RBXScriptSignal<(id: number, arguments: unknown) => void>;
|
|
38216
38817
|
/**
|
|
38217
38818
|
* Callback for when the `RemoteFunction` is invoked with `InvokeClient()`.
|
|
38218
38819
|
*
|
|
@@ -38730,12 +39331,6 @@ interface RuntimeContentService extends Instance {
|
|
|
38730
39331
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentFail)
|
|
38731
39332
|
*/
|
|
38732
39333
|
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
39334
|
/**
|
|
38740
39335
|
* - **ThreadSafety**: Unsafe
|
|
38741
39336
|
*
|
|
@@ -39008,7 +39603,7 @@ interface SyncScriptBuilder extends ScriptBuilder {
|
|
|
39008
39603
|
*
|
|
39009
39604
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SyncScriptBuilder#RawBytecode)
|
|
39010
39605
|
*
|
|
39011
|
-
* @deprecated
|
|
39606
|
+
* @deprecated CompileTarget
|
|
39012
39607
|
*/
|
|
39013
39608
|
RawBytecode: boolean;
|
|
39014
39609
|
}
|
|
@@ -39691,13 +40286,6 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39691
40286
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#PrivateServerOwnerId)
|
|
39692
40287
|
*/
|
|
39693
40288
|
readonly PrivateServerOwnerId: number;
|
|
39694
|
-
/**
|
|
39695
|
-
* - **ThreadSafety**: ReadSafe
|
|
39696
|
-
* - **Tags**: NotReplicated
|
|
39697
|
-
*
|
|
39698
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#RunService)
|
|
39699
|
-
*/
|
|
39700
|
-
readonly RunService: RunService | undefined;
|
|
39701
40289
|
/**
|
|
39702
40290
|
* **Deprecated:** This property has been deprecated. Use `DataModel.PrivateServerId` instead.
|
|
39703
40291
|
*
|
|
@@ -39708,7 +40296,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39708
40296
|
*
|
|
39709
40297
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#VIPServerId)
|
|
39710
40298
|
*
|
|
39711
|
-
* @deprecated
|
|
40299
|
+
* @deprecated PrivateServerId
|
|
39712
40300
|
*/
|
|
39713
40301
|
readonly VIPServerId: string;
|
|
39714
40302
|
/**
|
|
@@ -39721,7 +40309,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39721
40309
|
*
|
|
39722
40310
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#VIPServerOwnerId)
|
|
39723
40311
|
*
|
|
39724
|
-
* @deprecated
|
|
40312
|
+
* @deprecated PrivateServerOwnerId
|
|
39725
40313
|
*/
|
|
39726
40314
|
readonly VIPServerOwnerId: number;
|
|
39727
40315
|
/**
|
|
@@ -39733,6 +40321,13 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39733
40321
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#Workspace)
|
|
39734
40322
|
*/
|
|
39735
40323
|
readonly Workspace: Workspace;
|
|
40324
|
+
/**
|
|
40325
|
+
* - **ThreadSafety**: ReadSafe
|
|
40326
|
+
* - **Tags**: NotReplicated
|
|
40327
|
+
*
|
|
40328
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#RunService)
|
|
40329
|
+
*/
|
|
40330
|
+
readonly RunService: RunService | undefined;
|
|
39736
40331
|
/**
|
|
39737
40332
|
* Binds a function to be called before the server shuts down.
|
|
39738
40333
|
*
|
|
@@ -39878,7 +40473,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39878
40473
|
*
|
|
39879
40474
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#OnClose)
|
|
39880
40475
|
*
|
|
39881
|
-
* @deprecated
|
|
40476
|
+
* @deprecated BindToClose
|
|
39882
40477
|
*/
|
|
39883
40478
|
OnClose: (() => unknown) | undefined;
|
|
39884
40479
|
}
|
|
@@ -40506,7 +41101,7 @@ interface SocialService extends Instance {
|
|
|
40506
41101
|
*/
|
|
40507
41102
|
GetUpcomingExperienceEventsAsync(this: SocialService): Array<unknown>;
|
|
40508
41103
|
/**
|
|
40509
|
-
* Prompts the player to submit feedback about the current experience.
|
|
41104
|
+
* Prompts the player to submit feedback or a player support ticket about the current experience.
|
|
40510
41105
|
*
|
|
40511
41106
|
* - **ThreadSafety**: Unsafe
|
|
40512
41107
|
* - **Tags**: Yields
|
|
@@ -40535,7 +41130,7 @@ interface SocialService extends Instance {
|
|
|
40535
41130
|
*
|
|
40536
41131
|
* @returns A tuple containing an `PromptLinkSharingResult` indicating the result of the link sharing prompt.
|
|
40537
41132
|
*
|
|
40538
|
-
* @deprecated
|
|
41133
|
+
* @deprecated PromptLinkSharingAsync
|
|
40539
41134
|
*/
|
|
40540
41135
|
PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
|
|
40541
41136
|
/**
|
|
@@ -40649,7 +41244,7 @@ interface Sound extends Instance {
|
|
|
40649
41244
|
*
|
|
40650
41245
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#EmitterSize)
|
|
40651
41246
|
*
|
|
40652
|
-
* @deprecated
|
|
41247
|
+
* @deprecated RollOffMinDistance
|
|
40653
41248
|
*/
|
|
40654
41249
|
EmitterSize: number;
|
|
40655
41250
|
/**
|
|
@@ -40705,7 +41300,7 @@ interface Sound extends Instance {
|
|
|
40705
41300
|
*
|
|
40706
41301
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#MaxDistance)
|
|
40707
41302
|
*
|
|
40708
|
-
* @deprecated
|
|
41303
|
+
* @deprecated RollOffMaxDistance
|
|
40709
41304
|
*/
|
|
40710
41305
|
MaxDistance: number;
|
|
40711
41306
|
/**
|
|
@@ -40718,7 +41313,7 @@ interface Sound extends Instance {
|
|
|
40718
41313
|
*
|
|
40719
41314
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#MinDistance)
|
|
40720
41315
|
*
|
|
40721
|
-
* @deprecated
|
|
41316
|
+
* @deprecated RollOffMinDistance
|
|
40722
41317
|
*/
|
|
40723
41318
|
MinDistance: number;
|
|
40724
41319
|
/**
|
|
@@ -40731,7 +41326,7 @@ interface Sound extends Instance {
|
|
|
40731
41326
|
*
|
|
40732
41327
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#Pitch)
|
|
40733
41328
|
*
|
|
40734
|
-
* @deprecated
|
|
41329
|
+
* @deprecated PlaybackSpeed
|
|
40735
41330
|
*/
|
|
40736
41331
|
Pitch: number;
|
|
40737
41332
|
/**
|
|
@@ -43508,7 +44103,7 @@ interface TeleportService extends Instance {
|
|
|
43508
44103
|
* @param placeId The `DataModel.PlaceId` of the place the reserved server is being created for.
|
|
43509
44104
|
* @returns The server access code required by `TeleportService:TeleportToPrivateServer()` and the `DataModel.PrivateServerId` for the reserved server.
|
|
43510
44105
|
*
|
|
43511
|
-
* @deprecated
|
|
44106
|
+
* @deprecated ReserveServerAsync
|
|
43512
44107
|
*/
|
|
43513
44108
|
ReserveServer(this: TeleportService, placeId: number): LuaTuple<[
|
|
43514
44109
|
string,
|
|
@@ -43790,7 +44385,7 @@ interface TestService extends Instance {
|
|
|
43790
44385
|
*
|
|
43791
44386
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Is30FpsThrottleEnabled)
|
|
43792
44387
|
*
|
|
43793
|
-
* @deprecated
|
|
44388
|
+
* @deprecated ThrottlePhysicsToRealtime
|
|
43794
44389
|
*/
|
|
43795
44390
|
Is30FpsThrottleEnabled: boolean;
|
|
43796
44391
|
/**
|
|
@@ -45444,7 +46039,7 @@ interface TextService extends Instance {
|
|
|
45444
46039
|
*/
|
|
45445
46040
|
FilterAndTranslateStringAsync(this: TextService, stringToFilter: string, fromUserId: number, targetLocales: Array<unknown>, textContext?: CastsToEnum<Enum.TextFilterContext>): TextFilterTranslatedResult;
|
|
45446
46041
|
/**
|
|
45447
|
-
* Filters a string being received from a user and returns a
|
|
46042
|
+
* Filters a string being received from a user and returns a
|
|
45448
46043
|
*
|
|
45449
46044
|
* - **ThreadSafety**: Unsafe
|
|
45450
46045
|
* - **Tags**: Yields
|
|
@@ -45867,6 +46462,13 @@ interface Trail extends Instance {
|
|
|
45867
46462
|
* @param this Used to create a trail effect between two attachments.
|
|
45868
46463
|
*/
|
|
45869
46464
|
Clear(this: Trail): void;
|
|
46465
|
+
/**
|
|
46466
|
+
* - **ThreadSafety**: Unsafe
|
|
46467
|
+
* - **Tags**: Hidden
|
|
46468
|
+
*
|
|
46469
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Trail#OnClearRequested)
|
|
46470
|
+
*/
|
|
46471
|
+
readonly OnClearRequested: RBXScriptSignal<() => void>;
|
|
45870
46472
|
}
|
|
45871
46473
|
/**
|
|
45872
46474
|
* The role of a Translator is to manufacture/return strings localized for the viewing player.
|
|
@@ -47673,7 +48275,7 @@ interface UserInputService extends Instance {
|
|
|
47673
48275
|
*
|
|
47674
48276
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#ModalEnabled)
|
|
47675
48277
|
*
|
|
47676
|
-
* @deprecated
|
|
48278
|
+
* @deprecated TouchControlsEnabled
|
|
47677
48279
|
*/
|
|
47678
48280
|
ModalEnabled: boolean;
|
|
47679
48281
|
/**
|