@rbxts/types 1.0.860 → 1.0.862
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 +233 -138
- package/include/generated/PluginSecurity.d.ts +38 -45
- package/include/generated/enums.d.ts +77 -5
- package/package.json +1 -1
|
@@ -37,7 +37,6 @@ interface Services {
|
|
|
37
37
|
CloudCRUDService: CloudCRUDService;
|
|
38
38
|
CollaboratorsService: CollaboratorsService;
|
|
39
39
|
CollectionService: CollectionService;
|
|
40
|
-
CommandService: CommandService;
|
|
41
40
|
CommerceService: CommerceService;
|
|
42
41
|
ConfigService: ConfigService;
|
|
43
42
|
ConfigureServerService: ConfigureServerService;
|
|
@@ -118,6 +117,7 @@ interface Services {
|
|
|
118
117
|
OmniRecommendationsService: OmniRecommendationsService;
|
|
119
118
|
OpenCloudService: OpenCloudService;
|
|
120
119
|
PackageUIService: PackageUIService;
|
|
120
|
+
PartyEmulatorService: PartyEmulatorService;
|
|
121
121
|
PatchBundlerFileWatch: PatchBundlerFileWatch;
|
|
122
122
|
PathfindingService: PathfindingService;
|
|
123
123
|
PerformanceControlService: PerformanceControlService;
|
|
@@ -258,6 +258,7 @@ interface CreatableInstances {
|
|
|
258
258
|
AudioFader: AudioFader;
|
|
259
259
|
AudioFilter: AudioFilter;
|
|
260
260
|
AudioFlanger: AudioFlanger;
|
|
261
|
+
AudioGate: AudioGate;
|
|
261
262
|
AudioLimiter: AudioLimiter;
|
|
262
263
|
AudioListener: AudioListener;
|
|
263
264
|
AudioPitchShifter: AudioPitchShifter;
|
|
@@ -556,7 +557,6 @@ interface Instances extends Services, CreatableInstances {
|
|
|
556
557
|
Clothing: Clothing;
|
|
557
558
|
CloudLocalizationTable: CloudLocalizationTable;
|
|
558
559
|
Collaborator: Collaborator;
|
|
559
|
-
CommandInstance: CommandInstance;
|
|
560
560
|
Constraint: Constraint;
|
|
561
561
|
Controller: Controller;
|
|
562
562
|
ControllerBase: ControllerBase;
|
|
@@ -3247,7 +3247,7 @@ interface AnimationTrack extends Instance {
|
|
|
3247
3247
|
*/
|
|
3248
3248
|
readonly Animation: Animation | undefined;
|
|
3249
3249
|
/**
|
|
3250
|
-
* A read
|
|
3250
|
+
* A read-only property that returns true when the `AnimationTrack` is playing.
|
|
3251
3251
|
*
|
|
3252
3252
|
* - **ThreadSafety**: ReadSafe
|
|
3253
3253
|
* - **Tags**: NotReplicated
|
|
@@ -3256,7 +3256,7 @@ interface AnimationTrack extends Instance {
|
|
|
3256
3256
|
*/
|
|
3257
3257
|
readonly IsPlaying: boolean;
|
|
3258
3258
|
/**
|
|
3259
|
-
* A read
|
|
3259
|
+
* A read-only property that returns the length (in seconds) of an `AnimationTrack`. This will return `0` until the animation has fully loaded and thus may not be immediately available.
|
|
3260
3260
|
*
|
|
3261
3261
|
* - **ThreadSafety**: ReadSafe
|
|
3262
3262
|
* - **Tags**: NotReplicated
|
|
@@ -3281,7 +3281,7 @@ interface AnimationTrack extends Instance {
|
|
|
3281
3281
|
*/
|
|
3282
3282
|
Priority: Enum.AnimationPriority;
|
|
3283
3283
|
/**
|
|
3284
|
-
*
|
|
3284
|
+
* Read-only property that gives the current playback speed of the `AnimationTrack`.
|
|
3285
3285
|
*
|
|
3286
3286
|
* - **ThreadSafety**: ReadSafe
|
|
3287
3287
|
* - **Tags**: NotReplicated
|
|
@@ -3299,7 +3299,7 @@ interface AnimationTrack extends Instance {
|
|
|
3299
3299
|
*/
|
|
3300
3300
|
TimePosition: number;
|
|
3301
3301
|
/**
|
|
3302
|
-
* Read-only property that gives the current weight of the `AnimationTrack`.
|
|
3302
|
+
* Read-only property that gives the current weight of the `AnimationTrack`.
|
|
3303
3303
|
*
|
|
3304
3304
|
* - **ThreadSafety**: ReadSafe
|
|
3305
3305
|
* - **Tags**: NotReplicated
|
|
@@ -3317,7 +3317,7 @@ interface AnimationTrack extends Instance {
|
|
|
3317
3317
|
*/
|
|
3318
3318
|
readonly WeightTarget: number;
|
|
3319
3319
|
/**
|
|
3320
|
-
* Changes the `AnimationTrack.Speed` of an animation. A positive value for speed plays the animation forward, a negative one plays it backwards, and 0 pauses it.
|
|
3320
|
+
* Changes the `AnimationTrack.Speed` of an animation. A positive value for speed plays the animation forward, a negative one plays it backwards, and `0` pauses it.
|
|
3321
3321
|
*
|
|
3322
3322
|
* - **ThreadSafety**: Unsafe
|
|
3323
3323
|
* - **Tags**: CustomLuaState
|
|
@@ -3328,7 +3328,7 @@ interface AnimationTrack extends Instance {
|
|
|
3328
3328
|
*/
|
|
3329
3329
|
AdjustSpeed(this: AnimationTrack, speed?: number): void;
|
|
3330
3330
|
/**
|
|
3331
|
-
* Changes the weight of an animation, with the optional fadeTime parameter determining how long it takes for `AnimationTrack.WeightCurrent` to reach `AnimationTrack.WeightTarget`.
|
|
3331
|
+
* Changes the weight of an animation, with the optional `fadeTime` parameter determining how long it takes for `AnimationTrack.WeightCurrent` to reach `AnimationTrack.WeightTarget`.
|
|
3332
3332
|
*
|
|
3333
3333
|
* - **ThreadSafety**: Unsafe
|
|
3334
3334
|
* - **Tags**: CustomLuaState
|
|
@@ -3377,7 +3377,7 @@ interface AnimationTrack extends Instance {
|
|
|
3377
3377
|
*/
|
|
3378
3378
|
GetTimeOfKeyframe(this: AnimationTrack, keyframeName: string): number;
|
|
3379
3379
|
/**
|
|
3380
|
-
* Plays the `AnimationTrack`. Once called an `AnimationTrack` will play with the specified fadeTime
|
|
3380
|
+
* Plays the `AnimationTrack`. Once called an `AnimationTrack` will play with the specified `fadeTime`, weight and speed.
|
|
3381
3381
|
*
|
|
3382
3382
|
* - **ThreadSafety**: Unsafe
|
|
3383
3383
|
* - **Tags**: CustomLuaState
|
|
@@ -3418,7 +3418,7 @@ interface AnimationTrack extends Instance {
|
|
|
3418
3418
|
*/
|
|
3419
3419
|
readonly DidLoop: RBXScriptSignal<() => void>;
|
|
3420
3420
|
/**
|
|
3421
|
-
* Fires when the `AnimationTrack` is completely done moving anything in the world.
|
|
3421
|
+
* Fires when the `AnimationTrack` is completely done moving anything in the world.
|
|
3422
3422
|
*
|
|
3423
3423
|
* - **ThreadSafety**: Unsafe
|
|
3424
3424
|
*
|
|
@@ -3426,7 +3426,7 @@ interface AnimationTrack extends Instance {
|
|
|
3426
3426
|
*/
|
|
3427
3427
|
readonly Ended: RBXScriptSignal<() => void>;
|
|
3428
3428
|
/**
|
|
3429
|
-
* Fires every time playback of an `AnimationTrack` reaches a `Keyframe` that does not have the default name
|
|
3429
|
+
* Fires every time playback of an `AnimationTrack` reaches a `Keyframe` that does not have the default name of `Keyframe`.
|
|
3430
3430
|
*
|
|
3431
3431
|
* - **ThreadSafety**: Unsafe
|
|
3432
3432
|
*
|
|
@@ -3458,7 +3458,7 @@ interface Animator extends Instance {
|
|
|
3458
3458
|
readonly _nominal_Animator: unique symbol;
|
|
3459
3459
|
/**
|
|
3460
3460
|
* - **ThreadSafety**: Safe
|
|
3461
|
-
* - **Tags**: NotReplicated
|
|
3461
|
+
* - **Tags**: NotReplicated
|
|
3462
3462
|
*
|
|
3463
3463
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#EvaluationThrottled)
|
|
3464
3464
|
*/
|
|
@@ -3751,6 +3751,8 @@ interface AssetService extends Instance {
|
|
|
3751
3751
|
* - **ThreadSafety**: Unsafe
|
|
3752
3752
|
*
|
|
3753
3753
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateSurfaceAppearance)
|
|
3754
|
+
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
3755
|
+
* @param content
|
|
3754
3756
|
*/
|
|
3755
3757
|
CreateSurfaceAppearance(this: AssetService, content: object): SurfaceAppearance;
|
|
3756
3758
|
/**
|
|
@@ -5472,6 +5474,69 @@ interface AudioFocusService extends Instance {
|
|
|
5472
5474
|
*/
|
|
5473
5475
|
readonly _nominal_AudioFocusService: unique symbol;
|
|
5474
5476
|
}
|
|
5477
|
+
/**
|
|
5478
|
+
* - **Tags**: NotBrowsable
|
|
5479
|
+
*
|
|
5480
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate)
|
|
5481
|
+
*/
|
|
5482
|
+
interface AudioGate extends Instance {
|
|
5483
|
+
/**
|
|
5484
|
+
* **DO NOT USE!**
|
|
5485
|
+
*
|
|
5486
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
5487
|
+
* @hidden
|
|
5488
|
+
* @deprecated
|
|
5489
|
+
*/
|
|
5490
|
+
readonly _nominal_AudioGate: unique symbol;
|
|
5491
|
+
/**
|
|
5492
|
+
* - **ThreadSafety**: ReadSafe
|
|
5493
|
+
*
|
|
5494
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Attack)
|
|
5495
|
+
*/
|
|
5496
|
+
Attack: number;
|
|
5497
|
+
/**
|
|
5498
|
+
* - **ThreadSafety**: ReadSafe
|
|
5499
|
+
*
|
|
5500
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Bypass)
|
|
5501
|
+
*/
|
|
5502
|
+
Bypass: boolean;
|
|
5503
|
+
/**
|
|
5504
|
+
* - **ThreadSafety**: ReadSafe
|
|
5505
|
+
*
|
|
5506
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Release)
|
|
5507
|
+
*/
|
|
5508
|
+
Release: number;
|
|
5509
|
+
/**
|
|
5510
|
+
* - **ThreadSafety**: ReadSafe
|
|
5511
|
+
*
|
|
5512
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Threshold)
|
|
5513
|
+
*/
|
|
5514
|
+
Threshold: NumberRange;
|
|
5515
|
+
/**
|
|
5516
|
+
* - **ThreadSafety**: Unsafe
|
|
5517
|
+
*
|
|
5518
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetConnectedWires)
|
|
5519
|
+
*/
|
|
5520
|
+
GetConnectedWires(this: AudioGate, pin: string): Array<Instance>;
|
|
5521
|
+
/**
|
|
5522
|
+
* - **ThreadSafety**: Unsafe
|
|
5523
|
+
*
|
|
5524
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetInputPins)
|
|
5525
|
+
*/
|
|
5526
|
+
GetInputPins(this: AudioGate): Array<unknown>;
|
|
5527
|
+
/**
|
|
5528
|
+
* - **ThreadSafety**: Unsafe
|
|
5529
|
+
*
|
|
5530
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetOutputPins)
|
|
5531
|
+
*/
|
|
5532
|
+
GetOutputPins(this: AudioGate): Array<unknown>;
|
|
5533
|
+
/**
|
|
5534
|
+
* - **ThreadSafety**: Unsafe
|
|
5535
|
+
*
|
|
5536
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#WiringChanged)
|
|
5537
|
+
*/
|
|
5538
|
+
readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
|
|
5539
|
+
}
|
|
5475
5540
|
/**
|
|
5476
5541
|
* Limits how loud audio streams are allowed to be.
|
|
5477
5542
|
*
|
|
@@ -6328,8 +6393,6 @@ interface AudioSpeechToText extends Instance {
|
|
|
6328
6393
|
/**
|
|
6329
6394
|
* Plays text as speech audio.
|
|
6330
6395
|
*
|
|
6331
|
-
* - **Tags**: NotBrowsable
|
|
6332
|
-
*
|
|
6333
6396
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
|
|
6334
6397
|
*/
|
|
6335
6398
|
interface AudioTextToSpeech extends Instance {
|
|
@@ -6541,6 +6604,12 @@ interface AuroraScriptObject extends Instance {
|
|
|
6541
6604
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptObject#LODLevel)
|
|
6542
6605
|
*/
|
|
6543
6606
|
LODLevel: number;
|
|
6607
|
+
/**
|
|
6608
|
+
* - **ThreadSafety**: ReadSafe
|
|
6609
|
+
*
|
|
6610
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptObject#PriorFrameInvoked)
|
|
6611
|
+
*/
|
|
6612
|
+
PriorFrameInvoked: number;
|
|
6544
6613
|
}
|
|
6545
6614
|
/**
|
|
6546
6615
|
* - **Tags**: NotCreatable, Service
|
|
@@ -6635,6 +6704,12 @@ interface AuroraService extends Instance {
|
|
|
6635
6704
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsPredicted)
|
|
6636
6705
|
*/
|
|
6637
6706
|
IsPredicted(this: AuroraService, target: Instance): boolean;
|
|
6707
|
+
/**
|
|
6708
|
+
* - **ThreadSafety**: Unsafe
|
|
6709
|
+
*
|
|
6710
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#PlayInputRecording)
|
|
6711
|
+
*/
|
|
6712
|
+
PlayInputRecording(this: AuroraService): void;
|
|
6638
6713
|
/**
|
|
6639
6714
|
* - **ThreadSafety**: Unsafe
|
|
6640
6715
|
*
|
|
@@ -6653,6 +6728,12 @@ interface AuroraService extends Instance {
|
|
|
6653
6728
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#ShowDebugVisualizer)
|
|
6654
6729
|
*/
|
|
6655
6730
|
ShowDebugVisualizer(this: AuroraService, state: boolean): void;
|
|
6731
|
+
/**
|
|
6732
|
+
* - **ThreadSafety**: Unsafe
|
|
6733
|
+
*
|
|
6734
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StartInputRecording)
|
|
6735
|
+
*/
|
|
6736
|
+
StartInputRecording(this: AuroraService): void;
|
|
6656
6737
|
/**
|
|
6657
6738
|
* - **ThreadSafety**: Unsafe
|
|
6658
6739
|
*
|
|
@@ -6665,6 +6746,12 @@ interface AuroraService extends Instance {
|
|
|
6665
6746
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StepPhysics)
|
|
6666
6747
|
*/
|
|
6667
6748
|
StepPhysics(this: AuroraService, worldSteps: number, parts?: Array<Instance>): void;
|
|
6749
|
+
/**
|
|
6750
|
+
* - **ThreadSafety**: Unsafe
|
|
6751
|
+
*
|
|
6752
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StopInputRecording)
|
|
6753
|
+
*/
|
|
6754
|
+
StopInputRecording(this: AuroraService): void;
|
|
6668
6755
|
/**
|
|
6669
6756
|
* - **ThreadSafety**: Unsafe
|
|
6670
6757
|
*
|
|
@@ -7107,7 +7194,7 @@ interface AvatarEditorService extends Instance {
|
|
|
7107
7194
|
*
|
|
7108
7195
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetFavorite)
|
|
7109
7196
|
* @param this A service to support developer Avatar Editors.
|
|
7110
|
-
* @param itemId The
|
|
7197
|
+
* @param itemId The ID of the specified asset or bundle.
|
|
7111
7198
|
* @param itemType The `AvatarItemType` of the specified asset or bundle.
|
|
7112
7199
|
* @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
|
|
7113
7200
|
*/
|
|
@@ -7168,7 +7255,7 @@ interface AvatarEditorService extends Instance {
|
|
|
7168
7255
|
*/
|
|
7169
7256
|
GetOutfits(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
|
|
7170
7257
|
/**
|
|
7171
|
-
* Returns a list of recommended assets based on a given `AssetType` and asset
|
|
7258
|
+
* Returns a list of recommended assets based on a given `AssetType` and asset ID.
|
|
7172
7259
|
*
|
|
7173
7260
|
* - **ThreadSafety**: Unsafe
|
|
7174
7261
|
* - **Tags**: Yields
|
|
@@ -7176,7 +7263,7 @@ interface AvatarEditorService extends Instance {
|
|
|
7176
7263
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedAssets)
|
|
7177
7264
|
* @param this A service to support developer Avatar Editors.
|
|
7178
7265
|
* @param assetType The type of asset recommendations to retrieve recommendations for. Only affects the response when item based recommendations don't exist for the given `contextAssetId`.
|
|
7179
|
-
* @param contextAssetId The
|
|
7266
|
+
* @param contextAssetId The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.
|
|
7180
7267
|
* @returns A list of recommendations based on the given `AssetType`.
|
|
7181
7268
|
*/
|
|
7182
7269
|
GetRecommendedAssets(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): ReadonlyArray<RecommendedAsset>;
|
|
@@ -10591,57 +10678,6 @@ interface CollectionService extends Instance {
|
|
|
10591
10678
|
*/
|
|
10592
10679
|
readonly TagRemoved: RBXScriptSignal<(tag: string) => void>;
|
|
10593
10680
|
}
|
|
10594
|
-
/**
|
|
10595
|
-
* - **Tags**: NotCreatable, NotReplicated
|
|
10596
|
-
*
|
|
10597
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandInstance)
|
|
10598
|
-
*/
|
|
10599
|
-
interface CommandInstance extends Instance {
|
|
10600
|
-
/**
|
|
10601
|
-
* **DO NOT USE!**
|
|
10602
|
-
*
|
|
10603
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
10604
|
-
* @hidden
|
|
10605
|
-
* @deprecated
|
|
10606
|
-
*/
|
|
10607
|
-
readonly _nominal_CommandInstance: unique symbol;
|
|
10608
|
-
/**
|
|
10609
|
-
* - **ThreadSafety**: ReadSafe
|
|
10610
|
-
* - **Tags**: NotReplicated
|
|
10611
|
-
*
|
|
10612
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandInstance#AllowGUIAccessPoints)
|
|
10613
|
-
*/
|
|
10614
|
-
readonly AllowGUIAccessPoints: boolean;
|
|
10615
|
-
/**
|
|
10616
|
-
* - **ThreadSafety**: ReadSafe
|
|
10617
|
-
* - **Tags**: NotReplicated
|
|
10618
|
-
*
|
|
10619
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandInstance#DisplayName)
|
|
10620
|
-
*/
|
|
10621
|
-
DisplayName: string;
|
|
10622
|
-
/**
|
|
10623
|
-
* - **ThreadSafety**: ReadSafe
|
|
10624
|
-
* - **Tags**: NotReplicated
|
|
10625
|
-
*
|
|
10626
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandInstance#Name)
|
|
10627
|
-
*/
|
|
10628
|
-
readonly Name: string;
|
|
10629
|
-
}
|
|
10630
|
-
/**
|
|
10631
|
-
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
10632
|
-
*
|
|
10633
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandService)
|
|
10634
|
-
*/
|
|
10635
|
-
interface CommandService extends Instance {
|
|
10636
|
-
/**
|
|
10637
|
-
* **DO NOT USE!**
|
|
10638
|
-
*
|
|
10639
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
10640
|
-
* @hidden
|
|
10641
|
-
* @deprecated
|
|
10642
|
-
*/
|
|
10643
|
-
readonly _nominal_CommandService: unique symbol;
|
|
10644
|
-
}
|
|
10645
10681
|
/**
|
|
10646
10682
|
* Supports real-world purchases that you can bundle with digital benefits.
|
|
10647
10683
|
*
|
|
@@ -18315,6 +18351,13 @@ interface VideoFrame extends GuiObject {
|
|
|
18315
18351
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Video)
|
|
18316
18352
|
*/
|
|
18317
18353
|
Video: ContentId;
|
|
18354
|
+
/**
|
|
18355
|
+
* - **ThreadSafety**: ReadSafe
|
|
18356
|
+
* - **Tags**: Hidden
|
|
18357
|
+
*
|
|
18358
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#VideoContent)
|
|
18359
|
+
*/
|
|
18360
|
+
VideoContent: Content;
|
|
18318
18361
|
/**
|
|
18319
18362
|
* Indicates how loud the `VideoFrame.Video` is currently playing back.
|
|
18320
18363
|
*
|
|
@@ -23337,8 +23380,6 @@ interface IncrementalPatchBuilder extends Instance {
|
|
|
23337
23380
|
/**
|
|
23338
23381
|
* Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using `InputBinding`.
|
|
23339
23382
|
*
|
|
23340
|
-
* - **Tags**: NotBrowsable
|
|
23341
|
-
*
|
|
23342
23383
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction)
|
|
23343
23384
|
*/
|
|
23344
23385
|
interface InputAction extends Instance {
|
|
@@ -23414,8 +23455,6 @@ interface InputAction extends Instance {
|
|
|
23414
23455
|
/**
|
|
23415
23456
|
* Defines which hardware binding should trigger the parent `InputAction`.
|
|
23416
23457
|
*
|
|
23417
|
-
* - **Tags**: NotBrowsable
|
|
23418
|
-
*
|
|
23419
23458
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding)
|
|
23420
23459
|
*/
|
|
23421
23460
|
interface InputBinding extends Instance {
|
|
@@ -23527,8 +23566,6 @@ interface InputBinding extends Instance {
|
|
|
23527
23566
|
/**
|
|
23528
23567
|
* Collection of actions which holds related actions and defines how they interact with other contexts/actions.
|
|
23529
23568
|
*
|
|
23530
|
-
* - **Tags**: NotBrowsable
|
|
23531
|
-
*
|
|
23532
23569
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputContext)
|
|
23533
23570
|
*/
|
|
23534
23571
|
interface InputContext extends Instance {
|
|
@@ -25058,7 +25095,7 @@ interface LocalizationService extends Instance {
|
|
|
25058
25095
|
*/
|
|
25059
25096
|
readonly RobloxLocaleId: string;
|
|
25060
25097
|
/**
|
|
25061
|
-
* The locale
|
|
25098
|
+
* The locale ID that the local player has set for their operating system.
|
|
25062
25099
|
*
|
|
25063
25100
|
* - **ThreadSafety**: ReadSafe
|
|
25064
25101
|
* - **Tags**: NotReplicated
|
|
@@ -26003,6 +26040,8 @@ interface MarketplaceService extends Instance {
|
|
|
26003
26040
|
* - **Tags**: Yields
|
|
26004
26041
|
*
|
|
26005
26042
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetUsersPriceLevelsAsync)
|
|
26043
|
+
* @param this The service responsible for in-experience transactions.
|
|
26044
|
+
* @param userIds
|
|
26006
26045
|
*/
|
|
26007
26046
|
GetUsersPriceLevelsAsync(this: MarketplaceService, userIds: Array<unknown>): Array<unknown>;
|
|
26008
26047
|
/**
|
|
@@ -26742,6 +26781,8 @@ interface ModerationService extends Instance {
|
|
|
26742
26781
|
* - **Tags**: Yields
|
|
26743
26782
|
*
|
|
26744
26783
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalCreateReviewableContentAsync)
|
|
26784
|
+
* @param this
|
|
26785
|
+
* @param config
|
|
26745
26786
|
*/
|
|
26746
26787
|
InternalCreateReviewableContentAsync(this: ModerationService, config: object): string;
|
|
26747
26788
|
/**
|
|
@@ -26749,12 +26790,15 @@ interface ModerationService extends Instance {
|
|
|
26749
26790
|
* - **Tags**: Yields
|
|
26750
26791
|
*
|
|
26751
26792
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalRequestReviewableContentReviewAsync)
|
|
26793
|
+
* @param this
|
|
26794
|
+
* @param config
|
|
26752
26795
|
*/
|
|
26753
26796
|
InternalRequestReviewableContentReviewAsync(this: ModerationService, config: object): void;
|
|
26754
26797
|
/**
|
|
26755
26798
|
* - **ThreadSafety**: Unsafe
|
|
26756
26799
|
*
|
|
26757
26800
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalProcessReviewableContentEvent)
|
|
26801
|
+
* @param event
|
|
26758
26802
|
*/
|
|
26759
26803
|
InternalProcessReviewableContentEvent: ((event: object) => boolean) | undefined;
|
|
26760
26804
|
}
|
|
@@ -28053,10 +28097,13 @@ interface BasePart extends PVInstance {
|
|
|
28053
28097
|
* Returns the base part of an assembly of parts.
|
|
28054
28098
|
*
|
|
28055
28099
|
* - **ThreadSafety**: Safe
|
|
28100
|
+
* - **Tags**:
|
|
28056
28101
|
*
|
|
28057
28102
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#GetRootPart)
|
|
28058
28103
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
28059
28104
|
* @returns The base part of an assembly (a collection of parts connected together).
|
|
28105
|
+
*
|
|
28106
|
+
* @deprecated AssemblyRootPart
|
|
28060
28107
|
*/
|
|
28061
28108
|
GetRootPart(this: BasePart): BasePart;
|
|
28062
28109
|
/**
|
|
@@ -30841,7 +30888,7 @@ interface PackageLink extends Instance {
|
|
|
30841
30888
|
*/
|
|
30842
30889
|
get DefaultName(): string;
|
|
30843
30890
|
/**
|
|
30844
|
-
* The
|
|
30891
|
+
* The ID of the asset this package corresponds to.
|
|
30845
30892
|
*
|
|
30846
30893
|
* - **ThreadSafety**: ReadSafe
|
|
30847
30894
|
* - **Tags**: NotReplicated
|
|
@@ -31506,6 +31553,21 @@ interface ParticleEmitter extends Instance {
|
|
|
31506
31553
|
*/
|
|
31507
31554
|
readonly OnEmitRequested: RBXScriptSignal<(particleCount: number) => void>;
|
|
31508
31555
|
}
|
|
31556
|
+
/**
|
|
31557
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
31558
|
+
*
|
|
31559
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartyEmulatorService)
|
|
31560
|
+
*/
|
|
31561
|
+
interface PartyEmulatorService extends Instance {
|
|
31562
|
+
/**
|
|
31563
|
+
* **DO NOT USE!**
|
|
31564
|
+
*
|
|
31565
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
31566
|
+
* @hidden
|
|
31567
|
+
* @deprecated
|
|
31568
|
+
*/
|
|
31569
|
+
readonly _nominal_PartyEmulatorService: unique symbol;
|
|
31570
|
+
}
|
|
31509
31571
|
/**
|
|
31510
31572
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
31511
31573
|
*
|
|
@@ -32150,7 +32212,7 @@ interface PlatformFriendsService extends Instance {
|
|
|
32150
32212
|
readonly _nominal_PlatformFriendsService: unique symbol;
|
|
32151
32213
|
}
|
|
32152
32214
|
/**
|
|
32153
|
-
* An object that represents a presently connected client to the
|
|
32215
|
+
* An object that represents a presently connected client to the experience.
|
|
32154
32216
|
*
|
|
32155
32217
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player)
|
|
32156
32218
|
*/
|
|
@@ -32205,7 +32267,7 @@ interface Player extends Instance {
|
|
|
32205
32267
|
*/
|
|
32206
32268
|
CameraMode: Enum.CameraMode;
|
|
32207
32269
|
/**
|
|
32208
|
-
* Determines whether the character's appearance will be loaded when the player spawns. If false
|
|
32270
|
+
* Determines whether the character's appearance will be loaded when the player spawns. If `false`, the player will spawn with a default appearance.
|
|
32209
32271
|
*
|
|
32210
32272
|
* - **ThreadSafety**: ReadSafe
|
|
32211
32273
|
*
|
|
@@ -32234,7 +32296,7 @@ interface Player extends Instance {
|
|
|
32234
32296
|
*/
|
|
32235
32297
|
CharacterAppearance: string;
|
|
32236
32298
|
/**
|
|
32237
|
-
* Determines the user ID of the account whose character appearance is used for a player's `
|
|
32299
|
+
* Determines the user ID of the account whose character appearance is used for a player's `Character`.
|
|
32238
32300
|
*
|
|
32239
32301
|
* - **ThreadSafety**: ReadSafe
|
|
32240
32302
|
*
|
|
@@ -32276,7 +32338,7 @@ interface Player extends Instance {
|
|
|
32276
32338
|
*/
|
|
32277
32339
|
DevCameraOcclusionMode: Enum.DevCameraOcclusionMode;
|
|
32278
32340
|
/**
|
|
32279
|
-
* Determines player's camera movement mode when using a
|
|
32341
|
+
* Determines player's camera movement mode when using a device with a mouse and keyboard.
|
|
32280
32342
|
*
|
|
32281
32343
|
* - **ThreadSafety**: ReadSafe
|
|
32282
32344
|
*
|
|
@@ -32284,7 +32346,7 @@ interface Player extends Instance {
|
|
|
32284
32346
|
*/
|
|
32285
32347
|
DevComputerCameraMode: Enum.DevComputerCameraMovementMode;
|
|
32286
32348
|
/**
|
|
32287
|
-
* Determines player's character movement mode when using a
|
|
32349
|
+
* Determines player's character movement mode when using a device with a mouse and keyboard.
|
|
32288
32350
|
*
|
|
32289
32351
|
* - **ThreadSafety**: ReadSafe
|
|
32290
32352
|
*
|
|
@@ -32300,7 +32362,7 @@ interface Player extends Instance {
|
|
|
32300
32362
|
*/
|
|
32301
32363
|
DevEnableMouseLock: boolean;
|
|
32302
32364
|
/**
|
|
32303
|
-
* Determines player's camera movement mode when using a touch device.
|
|
32365
|
+
* Determines player's camera movement mode when using a touch-enabled device.
|
|
32304
32366
|
*
|
|
32305
32367
|
* - **ThreadSafety**: ReadSafe
|
|
32306
32368
|
*
|
|
@@ -32308,7 +32370,7 @@ interface Player extends Instance {
|
|
|
32308
32370
|
*/
|
|
32309
32371
|
DevTouchCameraMode: Enum.DevTouchCameraMovementMode;
|
|
32310
32372
|
/**
|
|
32311
|
-
* Determines player's character movement mode when using a touch device.
|
|
32373
|
+
* Determines player's character movement mode when using a touch-enabled device.
|
|
32312
32374
|
*
|
|
32313
32375
|
* - **ThreadSafety**: ReadSafe
|
|
32314
32376
|
*
|
|
@@ -32316,7 +32378,7 @@ interface Player extends Instance {
|
|
|
32316
32378
|
*/
|
|
32317
32379
|
DevTouchMovementMode: Enum.DevTouchMovementMode;
|
|
32318
32380
|
/**
|
|
32319
|
-
* The
|
|
32381
|
+
* The display name of the authenticated user associated with the `Player`.
|
|
32320
32382
|
*
|
|
32321
32383
|
* - **ThreadSafety**: ReadSafe
|
|
32322
32384
|
*
|
|
@@ -32324,7 +32386,7 @@ interface Player extends Instance {
|
|
|
32324
32386
|
*/
|
|
32325
32387
|
DisplayName: string;
|
|
32326
32388
|
/**
|
|
32327
|
-
* Describes the user ID of the player who was followed into
|
|
32389
|
+
* Describes the user ID of the player who was followed into an experience by a player.
|
|
32328
32390
|
*
|
|
32329
32391
|
* - **ThreadSafety**: ReadSafe
|
|
32330
32392
|
* - **Tags**: NotReplicated
|
|
@@ -32341,7 +32403,7 @@ interface Player extends Instance {
|
|
|
32341
32403
|
*/
|
|
32342
32404
|
get GameplayPaused(): boolean;
|
|
32343
32405
|
/**
|
|
32344
|
-
* Indicates if a player has a Verified
|
|
32406
|
+
* Indicates if a player has a **Verified** badge.
|
|
32345
32407
|
*
|
|
32346
32408
|
* - **ThreadSafety**: ReadSafe
|
|
32347
32409
|
*
|
|
@@ -32349,7 +32411,7 @@ interface Player extends Instance {
|
|
|
32349
32411
|
*/
|
|
32350
32412
|
HasVerifiedBadge: boolean;
|
|
32351
32413
|
/**
|
|
32352
|
-
* Sets the distance at which this player will see other
|
|
32414
|
+
* Sets the distance at which this player will see other players' health bars.
|
|
32353
32415
|
*
|
|
32354
32416
|
* - **ThreadSafety**: ReadSafe
|
|
32355
32417
|
*
|
|
@@ -32357,7 +32419,7 @@ interface Player extends Instance {
|
|
|
32357
32419
|
*/
|
|
32358
32420
|
HealthDisplayDistance: number;
|
|
32359
32421
|
/**
|
|
32360
|
-
* This property shows the locale
|
|
32422
|
+
* This property shows the locale ID that the local player has set for their Roblox account.
|
|
32361
32423
|
*
|
|
32362
32424
|
* - **ThreadSafety**: ReadSafe
|
|
32363
32425
|
* - **Tags**: Hidden, NotReplicated
|
|
@@ -32375,7 +32437,7 @@ interface Player extends Instance {
|
|
|
32375
32437
|
*/
|
|
32376
32438
|
readonly MembershipType: Enum.MembershipType;
|
|
32377
32439
|
/**
|
|
32378
|
-
* Sets the distance at which this player will see other
|
|
32440
|
+
* Sets the distance at which this player will see other players' names.
|
|
32379
32441
|
*
|
|
32380
32442
|
* - **ThreadSafety**: ReadSafe
|
|
32381
32443
|
*
|
|
@@ -32416,7 +32478,7 @@ interface Player extends Instance {
|
|
|
32416
32478
|
*/
|
|
32417
32479
|
RespawnLocation: SpawnLocation | undefined;
|
|
32418
32480
|
/**
|
|
32419
|
-
* Determines the Team with which
|
|
32481
|
+
* Determines the `Team` with which the player is associated.
|
|
32420
32482
|
*
|
|
32421
32483
|
* - **ThreadSafety**: ReadSafe
|
|
32422
32484
|
* - **Tags**: NotReplicated
|
|
@@ -32425,7 +32487,7 @@ interface Player extends Instance {
|
|
|
32425
32487
|
*/
|
|
32426
32488
|
Team: Team | undefined;
|
|
32427
32489
|
/**
|
|
32428
|
-
* Determines the Team with which
|
|
32490
|
+
* Determines the `Team` with which the player is associated with according to that team's `Team.TeamColor`.
|
|
32429
32491
|
*
|
|
32430
32492
|
* - **ThreadSafety**: ReadSafe
|
|
32431
32493
|
*
|
|
@@ -32444,26 +32506,26 @@ interface Player extends Instance {
|
|
|
32444
32506
|
* - **ThreadSafety**: Unsafe
|
|
32445
32507
|
*
|
|
32446
32508
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#AddReplicationFocus)
|
|
32447
|
-
* @param this An object that represents a presently connected client to the
|
|
32509
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32448
32510
|
* @param part
|
|
32449
32511
|
*/
|
|
32450
32512
|
AddReplicationFocus(this: Player, part: BasePart): void;
|
|
32451
32513
|
/**
|
|
32452
|
-
* Removes all accessories and other character appearance objects from a player's Character
|
|
32514
|
+
* Removes all accessories and other character appearance objects from a player's `Character`.
|
|
32453
32515
|
*
|
|
32454
32516
|
* - **ThreadSafety**: Unsafe
|
|
32455
32517
|
*
|
|
32456
32518
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#ClearCharacterAppearance)
|
|
32457
|
-
* @param this An object that represents a presently connected client to the
|
|
32519
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32458
32520
|
*/
|
|
32459
32521
|
ClearCharacterAppearance(this: Player): void;
|
|
32460
32522
|
/**
|
|
32461
|
-
* Returns the distance between the character's head and the given Vector3
|
|
32523
|
+
* Returns the distance between the character's head and the given `Vector3`, or `0` if the player has no character.
|
|
32462
32524
|
*
|
|
32463
32525
|
* - **ThreadSafety**: Unsafe
|
|
32464
32526
|
*
|
|
32465
32527
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#DistanceFromCharacter)
|
|
32466
|
-
* @param this An object that represents a presently connected client to the
|
|
32528
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32467
32529
|
* @param point The location from which player's distance to is being measured.
|
|
32468
32530
|
* @returns The distance in studs between the player and the location.
|
|
32469
32531
|
*/
|
|
@@ -32475,13 +32537,13 @@ interface Player extends Instance {
|
|
|
32475
32537
|
*/
|
|
32476
32538
|
GetData(this: Player): PlayerData;
|
|
32477
32539
|
/**
|
|
32478
|
-
* Returns a dictionary containing information describing how the
|
|
32540
|
+
* Returns a dictionary containing information describing how the player joins the experience.
|
|
32479
32541
|
*
|
|
32480
32542
|
* - **ThreadSafety**: Unsafe
|
|
32481
32543
|
* - **Tags**: CustomLuaState
|
|
32482
32544
|
*
|
|
32483
32545
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetJoinData)
|
|
32484
|
-
* @param this An object that represents a presently connected client to the
|
|
32546
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32485
32547
|
* @returns A dictionary containing PlaceId and UserId values (see table in description).
|
|
32486
32548
|
*/
|
|
32487
32549
|
GetJoinData(this: Player): PlayerJoinInfo;
|
|
@@ -32491,7 +32553,7 @@ interface Player extends Instance {
|
|
|
32491
32553
|
* - **ThreadSafety**: Unsafe
|
|
32492
32554
|
*
|
|
32493
32555
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetMouse)
|
|
32494
|
-
* @param this An object that represents a presently connected client to the
|
|
32556
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32495
32557
|
*/
|
|
32496
32558
|
GetMouse(this: Player): PlayerMouse;
|
|
32497
32559
|
/**
|
|
@@ -32500,7 +32562,7 @@ interface Player extends Instance {
|
|
|
32500
32562
|
* - **ThreadSafety**: Safe
|
|
32501
32563
|
*
|
|
32502
32564
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetNetworkPing)
|
|
32503
|
-
* @param this An object that represents a presently connected client to the
|
|
32565
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32504
32566
|
*/
|
|
32505
32567
|
GetNetworkPing(this: Player): number;
|
|
32506
32568
|
/**
|
|
@@ -32509,7 +32571,7 @@ interface Player extends Instance {
|
|
|
32509
32571
|
* - **ThreadSafety**: Unsafe
|
|
32510
32572
|
*
|
|
32511
32573
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#HasAppearanceLoaded)
|
|
32512
|
-
* @param this An object that represents a presently connected client to the
|
|
32574
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32513
32575
|
* @returns A boolean indicating whether or not the appearance of the player's character has loaded.
|
|
32514
32576
|
*/
|
|
32515
32577
|
HasAppearanceLoaded(this: Player): boolean;
|
|
@@ -32519,17 +32581,17 @@ interface Player extends Instance {
|
|
|
32519
32581
|
* - **ThreadSafety**: Unsafe
|
|
32520
32582
|
*
|
|
32521
32583
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsVerified)
|
|
32522
|
-
* @param this An object that represents a presently connected client to the
|
|
32584
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32523
32585
|
* @returns A boolean indicating whether the player is verified.
|
|
32524
32586
|
*/
|
|
32525
32587
|
IsVerified(this: Player): boolean;
|
|
32526
32588
|
/**
|
|
32527
|
-
* Forcibly disconnect a player from the
|
|
32589
|
+
* Forcibly disconnect a player from the experience, optionally providing a message.
|
|
32528
32590
|
*
|
|
32529
32591
|
* - **ThreadSafety**: Unsafe
|
|
32530
32592
|
*
|
|
32531
32593
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#Kick)
|
|
32532
|
-
* @param this An object that represents a presently connected client to the
|
|
32594
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32533
32595
|
* @param message The message to show the user upon kicking.
|
|
32534
32596
|
*/
|
|
32535
32597
|
Kick(this: Player, message?: string): void;
|
|
@@ -32542,7 +32604,7 @@ interface Player extends Instance {
|
|
|
32542
32604
|
* - **Tags**:
|
|
32543
32605
|
*
|
|
32544
32606
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadBoolean)
|
|
32545
|
-
* @param this An object that represents a presently connected client to the
|
|
32607
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32546
32608
|
* @param key
|
|
32547
32609
|
*
|
|
32548
32610
|
* @deprecated
|
|
@@ -32557,7 +32619,7 @@ interface Player extends Instance {
|
|
|
32557
32619
|
* - **Tags**:
|
|
32558
32620
|
*
|
|
32559
32621
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterAppearance)
|
|
32560
|
-
* @param this An object that represents a presently connected client to the
|
|
32622
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32561
32623
|
* @param assetInstance An instance of the asset being loaded, which can be obtained using the `InsertService:LoadAsset()` function.
|
|
32562
32624
|
*
|
|
32563
32625
|
* @deprecated
|
|
@@ -32572,7 +32634,7 @@ interface Player extends Instance {
|
|
|
32572
32634
|
* - **Tags**:
|
|
32573
32635
|
*
|
|
32574
32636
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadInstance)
|
|
32575
|
-
* @param this An object that represents a presently connected client to the
|
|
32637
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32576
32638
|
* @param key
|
|
32577
32639
|
*
|
|
32578
32640
|
* @deprecated
|
|
@@ -32587,7 +32649,7 @@ interface Player extends Instance {
|
|
|
32587
32649
|
* - **Tags**:
|
|
32588
32650
|
*
|
|
32589
32651
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadNumber)
|
|
32590
|
-
* @param this An object that represents a presently connected client to the
|
|
32652
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32591
32653
|
* @param key
|
|
32592
32654
|
*
|
|
32593
32655
|
* @deprecated
|
|
@@ -32602,7 +32664,7 @@ interface Player extends Instance {
|
|
|
32602
32664
|
* - **Tags**:
|
|
32603
32665
|
*
|
|
32604
32666
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadString)
|
|
32605
|
-
* @param this An object that represents a presently connected client to the
|
|
32667
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32606
32668
|
* @param key
|
|
32607
32669
|
*
|
|
32608
32670
|
* @deprecated
|
|
@@ -32614,7 +32676,7 @@ interface Player extends Instance {
|
|
|
32614
32676
|
* - **ThreadSafety**: Unsafe
|
|
32615
32677
|
*
|
|
32616
32678
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#Move)
|
|
32617
|
-
* @param this An object that represents a presently connected client to the
|
|
32679
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32618
32680
|
* @param walkDirection The Vector3 direction that the player should move.
|
|
32619
32681
|
* @param relativeToCamera A boolean indicating whether the player should move relative to the player's camera.
|
|
32620
32682
|
*/
|
|
@@ -32623,7 +32685,7 @@ interface Player extends Instance {
|
|
|
32623
32685
|
* - **ThreadSafety**: Unsafe
|
|
32624
32686
|
*
|
|
32625
32687
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#RemoveReplicationFocus)
|
|
32626
|
-
* @param this An object that represents a presently connected client to the
|
|
32688
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32627
32689
|
* @param part
|
|
32628
32690
|
*/
|
|
32629
32691
|
RemoveReplicationFocus(this: Player, part: BasePart): void;
|
|
@@ -32636,7 +32698,7 @@ interface Player extends Instance {
|
|
|
32636
32698
|
* - **Tags**:
|
|
32637
32699
|
*
|
|
32638
32700
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveBoolean)
|
|
32639
|
-
* @param this An object that represents a presently connected client to the
|
|
32701
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32640
32702
|
* @param key
|
|
32641
32703
|
* @param value
|
|
32642
32704
|
*
|
|
@@ -32652,7 +32714,7 @@ interface Player extends Instance {
|
|
|
32652
32714
|
* - **Tags**:
|
|
32653
32715
|
*
|
|
32654
32716
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveInstance)
|
|
32655
|
-
* @param this An object that represents a presently connected client to the
|
|
32717
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32656
32718
|
* @param key
|
|
32657
32719
|
* @param value
|
|
32658
32720
|
*
|
|
@@ -32668,7 +32730,7 @@ interface Player extends Instance {
|
|
|
32668
32730
|
* - **Tags**:
|
|
32669
32731
|
*
|
|
32670
32732
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveNumber)
|
|
32671
|
-
* @param this An object that represents a presently connected client to the
|
|
32733
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32672
32734
|
* @param key
|
|
32673
32735
|
* @param value
|
|
32674
32736
|
*
|
|
@@ -32684,7 +32746,7 @@ interface Player extends Instance {
|
|
|
32684
32746
|
* - **Tags**:
|
|
32685
32747
|
*
|
|
32686
32748
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveString)
|
|
32687
|
-
* @param this An object that represents a presently connected client to the
|
|
32749
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32688
32750
|
* @param key
|
|
32689
32751
|
* @param value
|
|
32690
32752
|
*
|
|
@@ -32698,33 +32760,33 @@ interface Player extends Instance {
|
|
|
32698
32760
|
* - **Tags**: Yields
|
|
32699
32761
|
*
|
|
32700
32762
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnline)
|
|
32701
|
-
* @param this An object that represents a presently connected client to the
|
|
32763
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32702
32764
|
* @param maxFriends The maximum number of online friends to return.
|
|
32703
32765
|
* @returns A dictionary of online friends (see the table above).
|
|
32704
32766
|
*/
|
|
32705
32767
|
GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
|
|
32706
32768
|
/**
|
|
32707
|
-
* Returns the player's rank in the group as an integer
|
|
32769
|
+
* Returns the player's rank in the group as an integer.
|
|
32708
32770
|
*
|
|
32709
32771
|
* - **ThreadSafety**: Unsafe
|
|
32710
32772
|
* - **Tags**: Yields
|
|
32711
32773
|
*
|
|
32712
32774
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRankInGroup)
|
|
32713
|
-
* @param this An object that represents a presently connected client to the
|
|
32775
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32714
32776
|
* @param groupId The `groupId` of the specified group.
|
|
32715
32777
|
* @returns The player's rank in the group.
|
|
32716
32778
|
*/
|
|
32717
32779
|
GetRankInGroup(this: Player, groupId: number): number;
|
|
32718
32780
|
/**
|
|
32719
|
-
* Returns the player's role in the group as a string, or
|
|
32781
|
+
* Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
|
|
32720
32782
|
*
|
|
32721
32783
|
* - **ThreadSafety**: Unsafe
|
|
32722
32784
|
* - **Tags**: Yields
|
|
32723
32785
|
*
|
|
32724
32786
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRoleInGroup)
|
|
32725
|
-
* @param this An object that represents a presently connected client to the
|
|
32726
|
-
* @param groupId The
|
|
32727
|
-
* @returns The player's role in the specified group, or
|
|
32787
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32788
|
+
* @param groupId The group ID of the specified group.
|
|
32789
|
+
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
32728
32790
|
*/
|
|
32729
32791
|
GetRoleInGroup(this: Player, groupId: number): string;
|
|
32730
32792
|
/**
|
|
@@ -32736,7 +32798,7 @@ interface Player extends Instance {
|
|
|
32736
32798
|
* - **Tags**: Yields
|
|
32737
32799
|
*
|
|
32738
32800
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsBestFriendsWith)
|
|
32739
|
-
* @param this An object that represents a presently connected client to the
|
|
32801
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32740
32802
|
* @param userId
|
|
32741
32803
|
*
|
|
32742
32804
|
* @deprecated
|
|
@@ -32749,7 +32811,7 @@ interface Player extends Instance {
|
|
|
32749
32811
|
* - **Tags**: Yields
|
|
32750
32812
|
*
|
|
32751
32813
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWith)
|
|
32752
|
-
* @param this An object that represents a presently connected client to the
|
|
32814
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32753
32815
|
* @param userId The `Player.UserId` of the specified player.
|
|
32754
32816
|
* @returns A boolean indicating whether a player is a friend of the specified user.
|
|
32755
32817
|
*/
|
|
@@ -32761,8 +32823,8 @@ interface Player extends Instance {
|
|
|
32761
32823
|
* - **Tags**: Yields
|
|
32762
32824
|
*
|
|
32763
32825
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsInGroup)
|
|
32764
|
-
* @param this An object that represents a presently connected client to the
|
|
32765
|
-
* @param groupId The
|
|
32826
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32827
|
+
* @param groupId The group ID of the specified group.
|
|
32766
32828
|
* @returns A boolean indicating whether the player is in the specified group.
|
|
32767
32829
|
*/
|
|
32768
32830
|
IsInGroup(this: Player, groupId: number): boolean;
|
|
@@ -32773,17 +32835,17 @@ interface Player extends Instance {
|
|
|
32773
32835
|
* - **Tags**: Yields
|
|
32774
32836
|
*
|
|
32775
32837
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacter)
|
|
32776
|
-
* @param this An object that represents a presently connected client to the
|
|
32838
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32777
32839
|
*/
|
|
32778
32840
|
LoadCharacter(this: Player): void;
|
|
32779
32841
|
/**
|
|
32780
|
-
* Spawns
|
|
32842
|
+
* Spawns a player character with everything equipped in the passed in `HumanoidDescription`.
|
|
32781
32843
|
*
|
|
32782
32844
|
* - **ThreadSafety**: Unsafe
|
|
32783
32845
|
* - **Tags**: Yields
|
|
32784
32846
|
*
|
|
32785
32847
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterWithHumanoidDescription)
|
|
32786
|
-
* @param this An object that represents a presently connected client to the
|
|
32848
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32787
32849
|
* @param humanoidDescription A `HumanoidDescription` containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character.
|
|
32788
32850
|
*/
|
|
32789
32851
|
LoadCharacterWithHumanoidDescription(this: Player, humanoidDescription: HumanoidDescription): void;
|
|
@@ -32794,7 +32856,7 @@ interface Player extends Instance {
|
|
|
32794
32856
|
* - **Tags**: Yields
|
|
32795
32857
|
*
|
|
32796
32858
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#RequestStreamAroundAsync)
|
|
32797
|
-
* @param this An object that represents a presently connected client to the
|
|
32859
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32798
32860
|
* @param position World location where streaming is requested.
|
|
32799
32861
|
* @param timeOut Optional timeout for the request, the maximum duration that the engine attempts to stream regions around the `position` parameter before abandoning the request. If you don't specify a value, the timeout is effectively infinite. However, if the client is low on memory, the engine abandons all streaming requests, even those that are still within the timeout duration.
|
|
32800
32862
|
*/
|
|
@@ -32808,13 +32870,13 @@ interface Player extends Instance {
|
|
|
32808
32870
|
* - **Tags**: Yields
|
|
32809
32871
|
*
|
|
32810
32872
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#WaitForDataReady)
|
|
32811
|
-
* @param this An object that represents a presently connected client to the
|
|
32873
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
32812
32874
|
*
|
|
32813
32875
|
* @deprecated
|
|
32814
32876
|
*/
|
|
32815
32877
|
WaitForDataReady(this: Player): boolean;
|
|
32816
32878
|
/**
|
|
32817
|
-
*
|
|
32879
|
+
* Fires when a player's character spawns or respawns.
|
|
32818
32880
|
*
|
|
32819
32881
|
* - **ThreadSafety**: Unsafe
|
|
32820
32882
|
*
|
|
@@ -32822,7 +32884,7 @@ interface Player extends Instance {
|
|
|
32822
32884
|
*/
|
|
32823
32885
|
readonly CharacterAdded: RBXScriptSignal<(character: Model) => void>;
|
|
32824
32886
|
/**
|
|
32825
|
-
* Fires when the full appearance of a `
|
|
32887
|
+
* Fires when the full appearance of a `Character` has been inserted.
|
|
32826
32888
|
*
|
|
32827
32889
|
* - **ThreadSafety**: Unsafe
|
|
32828
32890
|
*
|
|
@@ -32830,7 +32892,7 @@ interface Player extends Instance {
|
|
|
32830
32892
|
*/
|
|
32831
32893
|
readonly CharacterAppearanceLoaded: RBXScriptSignal<(character: Model) => void>;
|
|
32832
32894
|
/**
|
|
32833
|
-
*
|
|
32895
|
+
* Fires right before a player's character is removed.
|
|
32834
32896
|
*
|
|
32835
32897
|
* - **ThreadSafety**: Unsafe
|
|
32836
32898
|
*
|
|
@@ -32838,7 +32900,7 @@ interface Player extends Instance {
|
|
|
32838
32900
|
*/
|
|
32839
32901
|
readonly CharacterRemoving: RBXScriptSignal<(character: Model) => void>;
|
|
32840
32902
|
/**
|
|
32841
|
-
* Fires when a player chats in
|
|
32903
|
+
* Fires when a player chats in experience using Roblox's provided chat bar.
|
|
32842
32904
|
*
|
|
32843
32905
|
* - **ThreadSafety**: Unsafe
|
|
32844
32906
|
*
|
|
@@ -32846,7 +32908,7 @@ interface Player extends Instance {
|
|
|
32846
32908
|
*/
|
|
32847
32909
|
readonly Chatted: RBXScriptSignal<(message: string, recipient?: Player) => void>;
|
|
32848
32910
|
/**
|
|
32849
|
-
* This event fires approximately two minutes after the
|
|
32911
|
+
* This event fires approximately two minutes after the engine classifies the player as idle. Time is the number of seconds that have elapsed since that point.
|
|
32850
32912
|
*
|
|
32851
32913
|
* - **ThreadSafety**: Unsafe
|
|
32852
32914
|
*
|
|
@@ -32854,7 +32916,7 @@ interface Player extends Instance {
|
|
|
32854
32916
|
*/
|
|
32855
32917
|
readonly Idled: RBXScriptSignal<(time: number) => void>;
|
|
32856
32918
|
/**
|
|
32857
|
-
*
|
|
32919
|
+
* Fires when the teleport state of a player changes.
|
|
32858
32920
|
*
|
|
32859
32921
|
* - **ThreadSafety**: Unsafe
|
|
32860
32922
|
*
|
|
@@ -33463,7 +33525,7 @@ interface Players extends Instance {
|
|
|
33463
33525
|
*
|
|
33464
33526
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromOutfitId)
|
|
33465
33527
|
* @param this A service that contains presently connected `Player` objects.
|
|
33466
|
-
* @param outfitId The
|
|
33528
|
+
* @param outfitId The ID of the outfit for which the HumanoidDescription is sought.
|
|
33467
33529
|
* @returns HumanoidDescription initialized with the specification for the passed in outfitId.
|
|
33468
33530
|
*/
|
|
33469
33531
|
GetHumanoidDescriptionFromOutfitId(this: Players, outfitId: number): HumanoidDescription;
|
|
@@ -34416,12 +34478,22 @@ interface RecommendationService extends Instance {
|
|
|
34416
34478
|
* - **ThreadSafety**: Unsafe
|
|
34417
34479
|
*
|
|
34418
34480
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogActionEvent)
|
|
34481
|
+
* @param this
|
|
34482
|
+
* @param actionType
|
|
34483
|
+
* @param itemId
|
|
34484
|
+
* @param tracingId
|
|
34485
|
+
* @param actionEventDetails
|
|
34419
34486
|
*/
|
|
34420
34487
|
LogActionEvent(this: RecommendationService, actionType: CastsToEnum<Enum.RecommendationActionType>, itemId: string, tracingId: string, actionEventDetails?: object): void;
|
|
34421
34488
|
/**
|
|
34422
34489
|
* - **ThreadSafety**: Unsafe
|
|
34423
34490
|
*
|
|
34424
34491
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogImpressionEvent)
|
|
34492
|
+
* @param this
|
|
34493
|
+
* @param impressionType
|
|
34494
|
+
* @param itemId
|
|
34495
|
+
* @param tracingId
|
|
34496
|
+
* @param impressionEventDetails
|
|
34425
34497
|
*/
|
|
34426
34498
|
LogImpressionEvent(this: RecommendationService, impressionType: CastsToEnum<Enum.RecommendationImpressionType>, itemId: string, tracingId: string, impressionEventDetails?: object): void;
|
|
34427
34499
|
/**
|
|
@@ -34429,6 +34501,8 @@ interface RecommendationService extends Instance {
|
|
|
34429
34501
|
* - **Tags**: Yields
|
|
34430
34502
|
*
|
|
34431
34503
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#GenerateItemListAsync)
|
|
34504
|
+
* @param this
|
|
34505
|
+
* @param generateRecommendationItemListRequest
|
|
34432
34506
|
*/
|
|
34433
34507
|
GenerateItemListAsync(this: RecommendationService, generateRecommendationItemListRequest: object): RecommendationPages;
|
|
34434
34508
|
/**
|
|
@@ -34436,6 +34510,8 @@ interface RecommendationService extends Instance {
|
|
|
34436
34510
|
* - **Tags**: Yields
|
|
34437
34511
|
*
|
|
34438
34512
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RegisterItemAsync)
|
|
34513
|
+
* @param this
|
|
34514
|
+
* @param registerRecommendationItemsRequest
|
|
34439
34515
|
*/
|
|
34440
34516
|
RegisterItemAsync(this: RecommendationService, registerRecommendationItemsRequest: object): object;
|
|
34441
34517
|
/**
|
|
@@ -34443,6 +34519,8 @@ interface RecommendationService extends Instance {
|
|
|
34443
34519
|
* - **Tags**: Yields
|
|
34444
34520
|
*
|
|
34445
34521
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RemoveItemAsync)
|
|
34522
|
+
* @param this
|
|
34523
|
+
* @param itemId
|
|
34446
34524
|
*/
|
|
34447
34525
|
RemoveItemAsync(this: RecommendationService, itemId: string): void;
|
|
34448
34526
|
/**
|
|
@@ -34450,6 +34528,8 @@ interface RecommendationService extends Instance {
|
|
|
34450
34528
|
* - **Tags**: Yields
|
|
34451
34529
|
*
|
|
34452
34530
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#UpdateItemAsync)
|
|
34531
|
+
* @param this
|
|
34532
|
+
* @param updateRecommendationItemRequest
|
|
34453
34533
|
*/
|
|
34454
34534
|
UpdateItemAsync(this: RecommendationService, updateRecommendationItemRequest: object): void;
|
|
34455
34535
|
}
|
|
@@ -36475,6 +36555,13 @@ interface SocialService extends Instance {
|
|
|
36475
36555
|
* @returns An array of dictionaries representing the members of the specified party who are currently in the experience.
|
|
36476
36556
|
*/
|
|
36477
36557
|
GetPartyAsync(this: SocialService, partyId: string): Array<unknown>;
|
|
36558
|
+
/**
|
|
36559
|
+
* - **ThreadSafety**: Unsafe
|
|
36560
|
+
* - **Tags**: Yields
|
|
36561
|
+
*
|
|
36562
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharing)
|
|
36563
|
+
*/
|
|
36564
|
+
PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
|
|
36478
36565
|
/**
|
|
36479
36566
|
* Prompts the local `Player` with a prompt to change their RSVP status to the given event.
|
|
36480
36567
|
*
|
|
@@ -36511,6 +36598,12 @@ interface SocialService extends Instance {
|
|
|
36511
36598
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PhoneBookPromptClosed)
|
|
36512
36599
|
*/
|
|
36513
36600
|
readonly PhoneBookPromptClosed: RBXScriptSignal<(player: Player) => void>;
|
|
36601
|
+
/**
|
|
36602
|
+
* - **ThreadSafety**: Unsafe
|
|
36603
|
+
*
|
|
36604
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#ShareSheetClosed)
|
|
36605
|
+
*/
|
|
36606
|
+
readonly ShareSheetClosed: RBXScriptSignal<(player: Player) => void>;
|
|
36514
36607
|
/**
|
|
36515
36608
|
* Callback for when a call is placed from the phone book.
|
|
36516
36609
|
*
|
|
@@ -39442,6 +39535,8 @@ interface TestService extends Instance {
|
|
|
39442
39535
|
* - **ThreadSafety**: Unsafe
|
|
39443
39536
|
*
|
|
39444
39537
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#TakeSnapshot)
|
|
39538
|
+
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
39539
|
+
* @param snapshotname
|
|
39445
39540
|
*/
|
|
39446
39541
|
TakeSnapshot(this: TestService, snapshotname: string): void;
|
|
39447
39542
|
/**
|