@rbxts/types 1.0.939 → 1.0.940
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 +206 -40
- package/include/generated/PluginSecurity.d.ts +99 -5
- package/include/generated/enums.d.ts +468 -10
- package/package.json +1 -1
|
@@ -121,6 +121,7 @@ interface Services {
|
|
|
121
121
|
LodDataService: LodDataService;
|
|
122
122
|
LogReporterService: LogReporterService;
|
|
123
123
|
LogService: LogService;
|
|
124
|
+
LuauExpressionService: LuauExpressionService;
|
|
124
125
|
LuauScriptAnalyzerService: LuauScriptAnalyzerService;
|
|
125
126
|
MarketplaceService: MarketplaceService;
|
|
126
127
|
MatchmakingService: MatchmakingService;
|
|
@@ -143,6 +144,7 @@ interface Services {
|
|
|
143
144
|
PathfindingService: PathfindingService;
|
|
144
145
|
PerformanceControlService: PerformanceControlService;
|
|
145
146
|
PhysicsService: PhysicsService;
|
|
147
|
+
PinShortcutService: PinShortcutService;
|
|
146
148
|
PlaceAssetIdsService: PlaceAssetIdsService;
|
|
147
149
|
PlacesService: PlacesService;
|
|
148
150
|
PlaceStatsService: PlaceStatsService;
|
|
@@ -170,6 +172,7 @@ interface Services {
|
|
|
170
172
|
RemoteDebuggerServer: RemoteDebuggerServer;
|
|
171
173
|
ReplicatedFirst: ReplicatedFirst;
|
|
172
174
|
ReplicatedStorage: ReplicatedStorage;
|
|
175
|
+
RequestOrchestratorService: RequestOrchestratorService;
|
|
173
176
|
RibbonNotificationService: RibbonNotificationService;
|
|
174
177
|
RobloxServerStorage: RobloxServerStorage;
|
|
175
178
|
RolloutValidationService: RolloutValidationService;
|
|
@@ -261,6 +264,7 @@ interface Services {
|
|
|
261
264
|
VRStatusService: VRStatusService;
|
|
262
265
|
WebSocketService: WebSocketService;
|
|
263
266
|
WebViewService: WebViewService;
|
|
267
|
+
WindowProtocolService: WindowProtocolService;
|
|
264
268
|
Workspace: Workspace;
|
|
265
269
|
WrapDeformMeshProvider: WrapDeformMeshProvider;
|
|
266
270
|
}
|
|
@@ -453,6 +457,7 @@ interface CreatableInstances {
|
|
|
453
457
|
ParticleEmitter: ParticleEmitter;
|
|
454
458
|
PartOperation: PartOperation;
|
|
455
459
|
Path2D: Path2D;
|
|
460
|
+
Path3D: Path3D;
|
|
456
461
|
PathfindingLink: PathfindingLink;
|
|
457
462
|
PathfindingModifier: PathfindingModifier;
|
|
458
463
|
PitchShiftSoundEffect: PitchShiftSoundEffect;
|
|
@@ -764,6 +769,7 @@ interface Objects extends Instances {
|
|
|
764
769
|
EditableImage: EditableImage;
|
|
765
770
|
EditableMesh: EditableMesh;
|
|
766
771
|
ExecutedRemoteCommand: ExecutedRemoteCommand;
|
|
772
|
+
LuauExpression: LuauExpression;
|
|
767
773
|
MLSession: MLSession;
|
|
768
774
|
Object: RBXObject;
|
|
769
775
|
OutputLink: OutputLink;
|
|
@@ -1519,7 +1525,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1519
1525
|
*/
|
|
1520
1526
|
GetFaces(this: EditableMesh): Array<unknown>;
|
|
1521
1527
|
/**
|
|
1522
|
-
* **Deprecated:**
|
|
1528
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
1523
1529
|
*
|
|
1524
1530
|
* Returns a list of faces that use a given attribute ID.
|
|
1525
1531
|
*
|
|
@@ -1792,7 +1798,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1792
1798
|
*/
|
|
1793
1799
|
GetVertices(this: EditableMesh): Array<number>;
|
|
1794
1800
|
/**
|
|
1795
|
-
* **Deprecated:**
|
|
1801
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
1796
1802
|
*
|
|
1797
1803
|
* Returns a list of vertices that use a given attribute ID.
|
|
1798
1804
|
*
|
|
@@ -3120,7 +3126,7 @@ interface AnalyticsService extends Instance {
|
|
|
3120
3126
|
[index: string]: string;
|
|
3121
3127
|
}, customData?: unknown): void;
|
|
3122
3128
|
/**
|
|
3123
|
-
* **Deprecated:**
|
|
3129
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
3124
3130
|
*
|
|
3125
3131
|
* Fire a log event used to track errors and warnings experienced by players.
|
|
3126
3132
|
*
|
|
@@ -3846,33 +3852,36 @@ interface AnimationTrack extends Instance {
|
|
|
3846
3852
|
*/
|
|
3847
3853
|
GetMarkerReachedSignal(this: AnimationTrack, name: string): RBXScriptSignal<(param?: string) => void>;
|
|
3848
3854
|
/**
|
|
3855
|
+
* Returns the value of a parameter on the animation graph by key. Returns nil if the parameter has not been set.
|
|
3856
|
+
*
|
|
3849
3857
|
* - **ThreadSafety**: Unsafe
|
|
3850
3858
|
*
|
|
3851
3859
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameter)
|
|
3852
3860
|
* @param this Controls the playback of an animation on an `Animator`.
|
|
3853
|
-
* @param key
|
|
3861
|
+
* @param key The name of the parameter to retrieve.
|
|
3862
|
+
* @returns The current value of the parameter, or nil if not set.
|
|
3854
3863
|
*/
|
|
3855
3864
|
GetParameter(this: AnimationTrack, key: string): unknown;
|
|
3856
3865
|
/**
|
|
3866
|
+
* Returns a dictionary of parameter values initially set as instance attributes on the `AnimationGraphDefinition` instance used to build the animation graph inside this track.
|
|
3867
|
+
*
|
|
3857
3868
|
* - **ThreadSafety**: Unsafe
|
|
3858
3869
|
*
|
|
3859
3870
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameterDefaults)
|
|
3860
3871
|
* @param this Controls the playback of an animation on an `Animator`.
|
|
3872
|
+
* @returns A dictionary mapping parameter names to their default values. Returns an empty dictionary if the animation is not an animation graph.
|
|
3861
3873
|
*/
|
|
3862
3874
|
GetParameterDefaults(this: AnimationTrack): object;
|
|
3863
3875
|
/**
|
|
3864
3876
|
* - **ThreadSafety**: Unsafe
|
|
3865
3877
|
*
|
|
3866
3878
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetInstance)
|
|
3867
|
-
* @param this Controls the playback of an animation on an `Animator`.
|
|
3868
|
-
* @param name
|
|
3869
3879
|
*/
|
|
3870
3880
|
GetTargetInstance(this: AnimationTrack, name: string): Instance | undefined;
|
|
3871
3881
|
/**
|
|
3872
3882
|
* - **ThreadSafety**: Unsafe
|
|
3873
3883
|
*
|
|
3874
3884
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetNames)
|
|
3875
|
-
* @param this Controls the playback of an animation on an `Animator`.
|
|
3876
3885
|
*/
|
|
3877
3886
|
GetTargetNames(this: AnimationTrack): Array<unknown>;
|
|
3878
3887
|
/**
|
|
@@ -3900,21 +3909,20 @@ interface AnimationTrack extends Instance {
|
|
|
3900
3909
|
*/
|
|
3901
3910
|
Play(this: AnimationTrack, fadeTime?: number, weight?: number, speed?: number): void;
|
|
3902
3911
|
/**
|
|
3912
|
+
* Sets a parameter value on the animation graph, driving animation graph node inputs.
|
|
3913
|
+
*
|
|
3903
3914
|
* - **ThreadSafety**: Unsafe
|
|
3904
3915
|
*
|
|
3905
3916
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetParameter)
|
|
3906
3917
|
* @param this Controls the playback of an animation on an `Animator`.
|
|
3907
|
-
* @param key
|
|
3908
|
-
* @param value
|
|
3918
|
+
* @param key The name of the parameter to set.
|
|
3919
|
+
* @param value The value to assign to the parameter. Non-finite numeric values are sanitized to 0.
|
|
3909
3920
|
*/
|
|
3910
3921
|
SetParameter(this: AnimationTrack, key: string, value: unknown): void;
|
|
3911
3922
|
/**
|
|
3912
3923
|
* - **ThreadSafety**: Unsafe
|
|
3913
3924
|
*
|
|
3914
3925
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetTargetInstance)
|
|
3915
|
-
* @param this Controls the playback of an animation on an `Animator`.
|
|
3916
|
-
* @param name
|
|
3917
|
-
* @param target
|
|
3918
3926
|
*/
|
|
3919
3927
|
SetTargetInstance(this: AnimationTrack, name: string, target: Instance): void;
|
|
3920
3928
|
/**
|
|
@@ -4487,7 +4495,7 @@ interface AssetService extends Instance {
|
|
|
4487
4495
|
*/
|
|
4488
4496
|
CreateSurfaceAppearanceAsync(this: AssetService, content: object): SurfaceAppearance;
|
|
4489
4497
|
/**
|
|
4490
|
-
* **Deprecated:**
|
|
4498
|
+
* **Deprecated:** Use `GetAssetIdsForPackageAsync()` instead.
|
|
4491
4499
|
*
|
|
4492
4500
|
* Returns an array of asset IDs that are contained in a specified package.
|
|
4493
4501
|
*
|
|
@@ -4629,7 +4637,7 @@ interface AssetService extends Instance {
|
|
|
4629
4637
|
*/
|
|
4630
4638
|
SavePlaceAsync(this: AssetService, requestParameters?: object): void;
|
|
4631
4639
|
/**
|
|
4632
|
-
* **Deprecated:**
|
|
4640
|
+
* **Deprecated:** Use `SearchAudioAsync()` instead.
|
|
4633
4641
|
*
|
|
4634
4642
|
* Finds audio assets matching a variety of search criteria.
|
|
4635
4643
|
*
|
|
@@ -5759,6 +5767,18 @@ interface AudioEmitter extends Instance {
|
|
|
5759
5767
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DiffractionEnabled)
|
|
5760
5768
|
*/
|
|
5761
5769
|
DiffractionEnabled: Enum.SimulationMode;
|
|
5770
|
+
/**
|
|
5771
|
+
* - **ThreadSafety**: ReadSafe
|
|
5772
|
+
*
|
|
5773
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DistanceAttenuationBounds)
|
|
5774
|
+
*/
|
|
5775
|
+
DistanceAttenuationBounds: NumberRange;
|
|
5776
|
+
/**
|
|
5777
|
+
* - **ThreadSafety**: ReadSafe
|
|
5778
|
+
*
|
|
5779
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DistanceAttenuationMode)
|
|
5780
|
+
*/
|
|
5781
|
+
DistanceAttenuationMode: Enum.DistanceAttenuationMode;
|
|
5762
5782
|
/**
|
|
5763
5783
|
* - **ThreadSafety**: ReadSafe
|
|
5764
5784
|
*
|
|
@@ -7261,7 +7281,7 @@ interface AudioSearchParams extends Instance {
|
|
|
7261
7281
|
*/
|
|
7262
7282
|
AudioSubType: Enum.AudioSubType;
|
|
7263
7283
|
/**
|
|
7264
|
-
* **Deprecated:**
|
|
7284
|
+
* **Deprecated:** Use `AudioSubType` instead.
|
|
7265
7285
|
*
|
|
7266
7286
|
* The subtype of the audio asset.
|
|
7267
7287
|
*
|
|
@@ -7365,15 +7385,23 @@ interface AudioSpeechToText extends Instance {
|
|
|
7365
7385
|
*/
|
|
7366
7386
|
GetConnectedWires(this: AudioSpeechToText, pin: string): Array<Instance>;
|
|
7367
7387
|
/**
|
|
7388
|
+
* Gets the list of pins that a `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
7389
|
+
*
|
|
7368
7390
|
* - **ThreadSafety**: Unsafe
|
|
7369
7391
|
*
|
|
7370
7392
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetInputPins)
|
|
7393
|
+
* @param this Converts spoken audio into text.
|
|
7394
|
+
* @returns An array of strings representing valid pin names.
|
|
7371
7395
|
*/
|
|
7372
7396
|
GetInputPins(this: AudioSpeechToText): Array<unknown>;
|
|
7373
7397
|
/**
|
|
7398
|
+
* Gets the list of pins that a `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
7399
|
+
*
|
|
7374
7400
|
* - **ThreadSafety**: Unsafe
|
|
7375
7401
|
*
|
|
7376
7402
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetOutputPins)
|
|
7403
|
+
* @param this Converts spoken audio into text.
|
|
7404
|
+
* @returns An array of strings representing valid pin names.
|
|
7377
7405
|
*/
|
|
7378
7406
|
GetOutputPins(this: AudioSpeechToText): Array<unknown>;
|
|
7379
7407
|
/**
|
|
@@ -7501,15 +7529,23 @@ interface AudioTextToSpeech extends Instance {
|
|
|
7501
7529
|
*/
|
|
7502
7530
|
GetConnectedWires(this: AudioTextToSpeech, pin: string): Array<Instance>;
|
|
7503
7531
|
/**
|
|
7532
|
+
* Gets the list of pins that a `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
7533
|
+
*
|
|
7504
7534
|
* - **ThreadSafety**: Unsafe
|
|
7505
7535
|
*
|
|
7506
7536
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetInputPins)
|
|
7537
|
+
* @param this Plays text as speech audio.
|
|
7538
|
+
* @returns An array of strings representing valid pin names.
|
|
7507
7539
|
*/
|
|
7508
7540
|
GetInputPins(this: AudioTextToSpeech): Array<unknown>;
|
|
7509
7541
|
/**
|
|
7542
|
+
* Gets the list of pins that a `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
7543
|
+
*
|
|
7510
7544
|
* - **ThreadSafety**: Unsafe
|
|
7511
7545
|
*
|
|
7512
7546
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetOutputPins)
|
|
7547
|
+
* @param this Plays text as speech audio.
|
|
7548
|
+
* @returns An array of strings representing valid pin names.
|
|
7513
7549
|
*/
|
|
7514
7550
|
GetOutputPins(this: AudioTextToSpeech): Array<unknown>;
|
|
7515
7551
|
/**
|
|
@@ -8223,7 +8259,7 @@ interface AvatarCreationService extends Instance {
|
|
|
8223
8259
|
* @param this A service to support developer avatar creators.
|
|
8224
8260
|
* @param player The `Player` validation is completed for.
|
|
8225
8261
|
* @param accessory The instance validation is run on.
|
|
8226
|
-
* @param accessoryType `AccessoryType` the instance is expected to be.
|
|
8262
|
+
* @param accessoryType The `AccessoryType` the instance is expected to be.
|
|
8227
8263
|
* @returns A tuple containing, in order: - A boolean indicating if validation was successful for the accessory.
|
|
8228
8264
|
* - An optional table of strings. This includes failure reasons if validation was unsuccessful; otherwise `nil` if validation was successful.
|
|
8229
8265
|
*/
|
|
@@ -8537,7 +8573,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8537
8573
|
*
|
|
8538
8574
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetHeadShapesAsync)
|
|
8539
8575
|
* @param this A service to support developer Avatar Editors.
|
|
8540
|
-
* @returns An array of strings, each identifying a head shape owned by `Players.LocalPlayer`. Possible values include: `"
|
|
8576
|
+
* @returns An array of strings, each identifying a head shape owned by `Players.LocalPlayer`. Possible values include: `"Blockhead"`, `"Cheeks"`, `"Chiseled"`, `"ClassicFemaleV2"`, `"ClassicMaleV2"`, `"CoolThing"`, `"Default"`, `"EraserHead"`, `"FatHead"`, `"FlatTop"`, `"GoldenKorbloxGeneral"`, `"GoldenMrRobot"`, `"KnightOfChivalry"`, `"KnightOfCourage"`, `"ManHead"`, `"MercilessNinja"`, `"MrToilet"`, `"Narrow"`, `"NeoClassicFemaleV2"`, `"NeoClassicMaleV2"`, `"Paragon"`, `"Peabrain"`, `"Perfection"`, `"RobloxClassic"`, `"Roll"`, `"Roundy"`, `"RoxBox"`, `"StrongJaw"`, `"TheEngineer"`, `"Trim"`, `"WomanHead"`.
|
|
8541
8577
|
*/
|
|
8542
8578
|
GetHeadShapesAsync(this: AvatarEditorService): Array<unknown>;
|
|
8543
8579
|
/**
|
|
@@ -8876,7 +8912,7 @@ interface BadgeService extends Instance {
|
|
|
8876
8912
|
*/
|
|
8877
8913
|
readonly _nominal_BadgeService: unique symbol;
|
|
8878
8914
|
/**
|
|
8879
|
-
* **Deprecated:**
|
|
8915
|
+
* **Deprecated:** Use `AwardBadgeAsync()` instead.
|
|
8880
8916
|
*
|
|
8881
8917
|
* Award a badge to a player given the ID of each.
|
|
8882
8918
|
*
|
|
@@ -8930,6 +8966,13 @@ interface BadgeService extends Instance {
|
|
|
8930
8966
|
* @returns A dictionary of information about the specified badge.
|
|
8931
8967
|
*/
|
|
8932
8968
|
GetBadgeInfoAsync(this: BadgeService, badgeId: number): BadgeInfo;
|
|
8969
|
+
/**
|
|
8970
|
+
* - **ThreadSafety**: Unsafe
|
|
8971
|
+
* - **Tags**: Yields
|
|
8972
|
+
*
|
|
8973
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BadgeService#GetUserBadgesAsync)
|
|
8974
|
+
*/
|
|
8975
|
+
GetUserBadgesAsync(this: BadgeService, userId: User, badgeIds: Array<unknown>): Array<unknown>;
|
|
8933
8976
|
/**
|
|
8934
8977
|
* **Deprecated:** This function is deprecated. Do not use it for new work. Instead, it can be checked by calling BadgeService:GetBadgeInfoAsync() and checking the IsEnabled field.
|
|
8935
8978
|
*
|
|
@@ -18166,6 +18209,13 @@ interface GenerationService extends Instance {
|
|
|
18166
18209
|
* @returns The generated asset, returned as a `Model` with a single `MeshPart` containing an `EditableMesh`.
|
|
18167
18210
|
*/
|
|
18168
18211
|
LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
|
|
18212
|
+
/**
|
|
18213
|
+
* - **ThreadSafety**: Unsafe
|
|
18214
|
+
* - **Tags**: Yields
|
|
18215
|
+
*
|
|
18216
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#SegmentMeshAsync)
|
|
18217
|
+
*/
|
|
18218
|
+
SegmentMeshAsync(this: GenerationService, meshPart: MeshPart, schema: object, options?: object): unknown;
|
|
18169
18219
|
/**
|
|
18170
18220
|
* - **ThreadSafety**: Unsafe
|
|
18171
18221
|
* - **Tags**: Yields
|
|
@@ -18609,7 +18659,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
18609
18659
|
*/
|
|
18610
18660
|
ListVersionsAsync(this: DataStore, key: string, sortDirection?: CastsToEnum<Enum.SortDirection>, minDate?: number, maxDate?: number, pageSize?: number): DataStoreVersionPages;
|
|
18611
18661
|
/**
|
|
18612
|
-
* **Deprecated:**
|
|
18662
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
18613
18663
|
*
|
|
18614
18664
|
* Permanently deletes the specified version of a key.
|
|
18615
18665
|
*
|
|
@@ -19400,7 +19450,7 @@ interface GuiObject extends GuiBase2d {
|
|
|
19400
19450
|
readonly TouchTap: RBXScriptSignal<(touchPositions: Array<Vector2>) => void>;
|
|
19401
19451
|
}
|
|
19402
19452
|
/**
|
|
19403
|
-
* Blends descendants as a group with color/transparency.
|
|
19453
|
+
* Blends descendants as a flattened group with an optional color/transparency modification.
|
|
19404
19454
|
*
|
|
19405
19455
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CanvasGroup)
|
|
19406
19456
|
*/
|
|
@@ -19414,7 +19464,7 @@ interface CanvasGroup extends GuiObject {
|
|
|
19414
19464
|
*/
|
|
19415
19465
|
readonly _nominal_CanvasGroup: unique symbol;
|
|
19416
19466
|
/**
|
|
19417
|
-
* Color tint that applies to
|
|
19467
|
+
* Color tint that applies to the rendered group.
|
|
19418
19468
|
*
|
|
19419
19469
|
* - **ThreadSafety**: ReadSafe
|
|
19420
19470
|
*
|
|
@@ -19422,7 +19472,7 @@ interface CanvasGroup extends GuiObject {
|
|
|
19422
19472
|
*/
|
|
19423
19473
|
GroupColor3: Color3;
|
|
19424
19474
|
/**
|
|
19425
|
-
* Transparency that applies to
|
|
19475
|
+
* Transparency that applies to the rendered group.
|
|
19426
19476
|
*
|
|
19427
19477
|
* - **ThreadSafety**: ReadSafe
|
|
19428
19478
|
*
|
|
@@ -26150,6 +26200,8 @@ interface InputAction extends Instance {
|
|
|
26150
26200
|
*/
|
|
26151
26201
|
Enabled: boolean;
|
|
26152
26202
|
/**
|
|
26203
|
+
* The `InputBinding` best matching the player's current input device.
|
|
26204
|
+
*
|
|
26153
26205
|
* - **ThreadSafety**: ReadSafe
|
|
26154
26206
|
* - **Tags**: NotReplicated
|
|
26155
26207
|
*
|
|
@@ -26245,12 +26297,16 @@ interface InputBinding extends Instance {
|
|
|
26245
26297
|
*/
|
|
26246
26298
|
ClampMagnitudeToOne: boolean;
|
|
26247
26299
|
/**
|
|
26300
|
+
* Custom image asset to display for this binding.
|
|
26301
|
+
*
|
|
26248
26302
|
* - **ThreadSafety**: ReadSafe
|
|
26249
26303
|
*
|
|
26250
26304
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#DisplayImage)
|
|
26251
26305
|
*/
|
|
26252
26306
|
DisplayImage: Content;
|
|
26253
26307
|
/**
|
|
26308
|
+
* Custom display text for this binding.
|
|
26309
|
+
*
|
|
26254
26310
|
* - **ThreadSafety**: ReadSafe
|
|
26255
26311
|
*
|
|
26256
26312
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#DisplayName)
|
|
@@ -26642,7 +26698,7 @@ interface InsertService extends Instance {
|
|
|
26642
26698
|
*/
|
|
26643
26699
|
GetCollection(this: InsertService, categoryId: number): Array<CollectionInfo>;
|
|
26644
26700
|
/**
|
|
26645
|
-
* **Deprecated:**
|
|
26701
|
+
* **Deprecated:** Use `GetFreeDecalsAsync()` instead.
|
|
26646
26702
|
*
|
|
26647
26703
|
* Retrieves a list of free Decals from the Catalog.
|
|
26648
26704
|
*
|
|
@@ -26674,7 +26730,7 @@ interface InsertService extends Instance {
|
|
|
26674
26730
|
*/
|
|
26675
26731
|
GetFreeDecalsAsync(this: InsertService, searchText: string, pageNum: number): Array<unknown>;
|
|
26676
26732
|
/**
|
|
26677
|
-
* **Deprecated:**
|
|
26733
|
+
* **Deprecated:** Use `GetFreeModelsAsync()` instead.
|
|
26678
26734
|
*
|
|
26679
26735
|
* Retrieves a list of Free Models from the Catalog.
|
|
26680
26736
|
*
|
|
@@ -28773,6 +28829,21 @@ interface ModuleScript extends LuaSourceContainer {
|
|
|
28773
28829
|
*/
|
|
28774
28830
|
Source: ProtectedString;
|
|
28775
28831
|
}
|
|
28832
|
+
/**
|
|
28833
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
28834
|
+
*
|
|
28835
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LuauExpressionService)
|
|
28836
|
+
*/
|
|
28837
|
+
interface LuauExpressionService extends Instance {
|
|
28838
|
+
/**
|
|
28839
|
+
* **DO NOT USE!**
|
|
28840
|
+
*
|
|
28841
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
28842
|
+
* @hidden
|
|
28843
|
+
* @deprecated
|
|
28844
|
+
*/
|
|
28845
|
+
readonly _nominal_LuauExpressionService: unique symbol;
|
|
28846
|
+
}
|
|
28776
28847
|
/**
|
|
28777
28848
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
28778
28849
|
*
|
|
@@ -30497,7 +30568,7 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
30497
30568
|
*/
|
|
30498
30569
|
readonly _nominal_OpenCloudApiV1: unique symbol;
|
|
30499
30570
|
/**
|
|
30500
|
-
* **Deprecated:**
|
|
30571
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30501
30572
|
*
|
|
30502
30573
|
* - **ThreadSafety**: Unsafe
|
|
30503
30574
|
* - **Tags**: CustomLuaState
|
|
@@ -30510,7 +30581,7 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
30510
30581
|
*/
|
|
30511
30582
|
CreateModel(this: OpenCloudApiV1, name: string): OpenCloudModel;
|
|
30512
30583
|
/**
|
|
30513
|
-
* **Deprecated:**
|
|
30584
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30514
30585
|
*
|
|
30515
30586
|
* - **ThreadSafety**: Unsafe
|
|
30516
30587
|
* - **Tags**: Yields
|
|
@@ -30543,7 +30614,7 @@ interface OpenCloudService extends Instance {
|
|
|
30543
30614
|
*/
|
|
30544
30615
|
readonly _nominal_OpenCloudService: unique symbol;
|
|
30545
30616
|
/**
|
|
30546
|
-
* **Deprecated:**
|
|
30617
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30547
30618
|
*
|
|
30548
30619
|
* - **ThreadSafety**: Unsafe
|
|
30549
30620
|
* - **Tags**:
|
|
@@ -30555,7 +30626,7 @@ interface OpenCloudService extends Instance {
|
|
|
30555
30626
|
*/
|
|
30556
30627
|
GetApiV1(this: OpenCloudService): OpenCloudApiV1;
|
|
30557
30628
|
/**
|
|
30558
|
-
* **Deprecated:**
|
|
30629
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30559
30630
|
*
|
|
30560
30631
|
* - **ThreadSafety**: Unsafe
|
|
30561
30632
|
* - **Tags**: Yields
|
|
@@ -33078,7 +33149,7 @@ interface Camera extends PVInstance {
|
|
|
33078
33149
|
*/
|
|
33079
33150
|
readonly ViewportSize: Vector2;
|
|
33080
33151
|
/**
|
|
33081
|
-
* **Deprecated:**
|
|
33152
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
33082
33153
|
*
|
|
33083
33154
|
* Returns how much the `Camera` needs to be pushed towards its `Focus` in order to make sure there is no obstructions between the `Focus` and `CFrame`.
|
|
33084
33155
|
*
|
|
@@ -34904,6 +34975,8 @@ interface ParticleEmitter extends Instance {
|
|
|
34904
34975
|
*/
|
|
34905
34976
|
LightInfluence: number;
|
|
34906
34977
|
/**
|
|
34978
|
+
* Determines a multiplier for `ParticleEmitter.Transparency` that is only visible to the local client.
|
|
34979
|
+
*
|
|
34907
34980
|
* - **ThreadSafety**: ReadSafe
|
|
34908
34981
|
* - **Tags**: Hidden, NotReplicated
|
|
34909
34982
|
*
|
|
@@ -35267,6 +35340,19 @@ interface Path extends Instance {
|
|
|
35267
35340
|
*/
|
|
35268
35341
|
readonly Unblocked: RBXScriptSignal<(unblockedWaypointIdx: number) => void>;
|
|
35269
35342
|
}
|
|
35343
|
+
/**
|
|
35344
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path3D)
|
|
35345
|
+
*/
|
|
35346
|
+
interface Path3D extends Instance {
|
|
35347
|
+
/**
|
|
35348
|
+
* **DO NOT USE!**
|
|
35349
|
+
*
|
|
35350
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
35351
|
+
* @hidden
|
|
35352
|
+
* @deprecated
|
|
35353
|
+
*/
|
|
35354
|
+
readonly _nominal_Path3D: unique symbol;
|
|
35355
|
+
}
|
|
35270
35356
|
/**
|
|
35271
35357
|
* Connects two locations which otherwise by default are unconnected.
|
|
35272
35358
|
*
|
|
@@ -35698,6 +35784,21 @@ interface PhysicsService extends Instance {
|
|
|
35698
35784
|
*/
|
|
35699
35785
|
UnregisterCollisionGroup(this: PhysicsService, name: string): void;
|
|
35700
35786
|
}
|
|
35787
|
+
/**
|
|
35788
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
35789
|
+
*
|
|
35790
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PinShortcutService)
|
|
35791
|
+
*/
|
|
35792
|
+
interface PinShortcutService extends Instance {
|
|
35793
|
+
/**
|
|
35794
|
+
* **DO NOT USE!**
|
|
35795
|
+
*
|
|
35796
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
35797
|
+
* @hidden
|
|
35798
|
+
* @deprecated
|
|
35799
|
+
*/
|
|
35800
|
+
readonly _nominal_PinShortcutService: unique symbol;
|
|
35801
|
+
}
|
|
35701
35802
|
/**
|
|
35702
35803
|
* - **Tags**: NotCreatable, Service
|
|
35703
35804
|
*
|
|
@@ -36233,7 +36334,7 @@ interface Player extends Instance {
|
|
|
36233
36334
|
*/
|
|
36234
36335
|
LoadBoolean(this: Player, key: string): boolean;
|
|
36235
36336
|
/**
|
|
36236
|
-
* **Deprecated:**
|
|
36337
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
36237
36338
|
*
|
|
36238
36339
|
* Places the given instance either in the player's character, head, or StarterGear based on the instance's class.
|
|
36239
36340
|
*
|
|
@@ -37273,7 +37374,7 @@ interface Players extends Instance {
|
|
|
37273
37374
|
*/
|
|
37274
37375
|
GetBanHistoryAsync(this: Players, userId: User): BanHistoryPages;
|
|
37275
37376
|
/**
|
|
37276
|
-
* **Deprecated:**
|
|
37377
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
37277
37378
|
*
|
|
37278
37379
|
* Returns a `Model` containing the assets which the player is wearing, excluding gear.
|
|
37279
37380
|
*
|
|
@@ -38879,6 +38980,21 @@ interface ReplicatedStorage extends Instance {
|
|
|
38879
38980
|
*/
|
|
38880
38981
|
readonly _nominal_ReplicatedStorage: unique symbol;
|
|
38881
38982
|
}
|
|
38983
|
+
/**
|
|
38984
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
38985
|
+
*
|
|
38986
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RequestOrchestratorService)
|
|
38987
|
+
*/
|
|
38988
|
+
interface RequestOrchestratorService extends Instance {
|
|
38989
|
+
/**
|
|
38990
|
+
* **DO NOT USE!**
|
|
38991
|
+
*
|
|
38992
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
38993
|
+
* @hidden
|
|
38994
|
+
* @deprecated
|
|
38995
|
+
*/
|
|
38996
|
+
readonly _nominal_RequestOrchestratorService: unique symbol;
|
|
38997
|
+
}
|
|
38882
38998
|
/**
|
|
38883
38999
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
38884
39000
|
*
|
|
@@ -39483,7 +39599,7 @@ interface ScreenshotHud extends Instance {
|
|
|
39483
39599
|
*/
|
|
39484
39600
|
CloseWhenScreenshotTaken: boolean;
|
|
39485
39601
|
/**
|
|
39486
|
-
* **Deprecated:**
|
|
39602
|
+
* **Deprecated:** This property is deprecated. Do not use it for new work.
|
|
39487
39603
|
*
|
|
39488
39604
|
* Whether the experience name in the overlay is enabled.
|
|
39489
39605
|
*
|
|
@@ -39508,7 +39624,7 @@ interface ScreenshotHud extends Instance {
|
|
|
39508
39624
|
*/
|
|
39509
39625
|
HidePlayerGuiForCaptures: boolean;
|
|
39510
39626
|
/**
|
|
39511
|
-
* **Deprecated:**
|
|
39627
|
+
* **Deprecated:** This property is deprecated. Do not use it for new work.
|
|
39512
39628
|
*
|
|
39513
39629
|
* `Font` used for the experience name in the overlay.
|
|
39514
39630
|
*
|
|
@@ -39521,7 +39637,7 @@ interface ScreenshotHud extends Instance {
|
|
|
39521
39637
|
*/
|
|
39522
39638
|
OverlayFont: Enum.Font;
|
|
39523
39639
|
/**
|
|
39524
|
-
* **Deprecated:**
|
|
39640
|
+
* **Deprecated:** This property is deprecated. Do not use it for new work.
|
|
39525
39641
|
*
|
|
39526
39642
|
* Currently disabled with no effect.
|
|
39527
39643
|
*
|
|
@@ -41112,7 +41228,7 @@ interface SocialService extends Instance {
|
|
|
41112
41228
|
*/
|
|
41113
41229
|
PromptFeedbackSubmissionAsync(this: SocialService, options?: object): void;
|
|
41114
41230
|
/**
|
|
41115
|
-
* **Deprecated:**
|
|
41231
|
+
* **Deprecated:** Use `PromptLinkSharingAsync()` instead.
|
|
41116
41232
|
*
|
|
41117
41233
|
* - **ThreadSafety**: Unsafe
|
|
41118
41234
|
* - **Tags**: Yields
|
|
@@ -42638,7 +42754,7 @@ interface Stats extends Instance {
|
|
|
42638
42754
|
*/
|
|
42639
42755
|
readonly HeartbeatTime: number;
|
|
42640
42756
|
/**
|
|
42641
|
-
* **Deprecated:**
|
|
42757
|
+
* **Deprecated:** Use `Stats.HeartbeatTime` instead.
|
|
42642
42758
|
*
|
|
42643
42759
|
* A measurement of the total amount of time it takes long it takes for Roblox to update all of its task scheduler jobs, in milliseconds.
|
|
42644
42760
|
*
|
|
@@ -42705,7 +42821,7 @@ interface Stats extends Instance {
|
|
|
42705
42821
|
*/
|
|
42706
42822
|
readonly PhysicsStepTime: number;
|
|
42707
42823
|
/**
|
|
42708
|
-
* **Deprecated:**
|
|
42824
|
+
* **Deprecated:** Use `Stats.PhysicsStepTime` instead.
|
|
42709
42825
|
*
|
|
42710
42826
|
* A measurement of how long it takes for the physics engine to update its current state, in milliseconds. If this value is high, then it means the game instance is under stress from the physics simulations taking place.
|
|
42711
42827
|
*
|
|
@@ -44091,7 +44207,7 @@ interface TeleportService extends Instance {
|
|
|
44091
44207
|
*/
|
|
44092
44208
|
PromptExperienceDetailsAsync(this: TeleportService, player: Player, universeId: number): Enum.PromptExperienceDetailsResult;
|
|
44093
44209
|
/**
|
|
44094
|
-
* **Deprecated:**
|
|
44210
|
+
* **Deprecated:** Use `ReserveServerAsync()` instead.
|
|
44095
44211
|
*
|
|
44096
44212
|
* Returns an access code that can be used to teleport players to a reserved server, along with the `DataModel.PrivateServerId` for it.
|
|
44097
44213
|
*
|
|
@@ -44307,6 +44423,12 @@ interface TestCase extends Instance {
|
|
|
44307
44423
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#Assert)
|
|
44308
44424
|
*/
|
|
44309
44425
|
Assert(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44426
|
+
/**
|
|
44427
|
+
* - **ThreadSafety**: Unsafe
|
|
44428
|
+
*
|
|
44429
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#AssertLegacy)
|
|
44430
|
+
*/
|
|
44431
|
+
AssertLegacy(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44310
44432
|
/**
|
|
44311
44433
|
* - **ThreadSafety**: Unsafe
|
|
44312
44434
|
*
|
|
@@ -44325,6 +44447,12 @@ interface TestCase extends Instance {
|
|
|
44325
44447
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#Require)
|
|
44326
44448
|
*/
|
|
44327
44449
|
Require(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44450
|
+
/**
|
|
44451
|
+
* - **ThreadSafety**: Unsafe
|
|
44452
|
+
*
|
|
44453
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#RequireLegacy)
|
|
44454
|
+
*/
|
|
44455
|
+
RequireLegacy(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44328
44456
|
}
|
|
44329
44457
|
/**
|
|
44330
44458
|
* A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
@@ -44544,6 +44672,12 @@ interface TestService extends Instance {
|
|
|
44544
44672
|
* @param testOptions
|
|
44545
44673
|
*/
|
|
44546
44674
|
RegisterTest(this: TestService, testOptions: object): TestCase;
|
|
44675
|
+
/**
|
|
44676
|
+
* - **ThreadSafety**: Unsafe
|
|
44677
|
+
*
|
|
44678
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RegisterTestLegacy)
|
|
44679
|
+
*/
|
|
44680
|
+
RegisterTestLegacy(this: TestService, testOptions: object): TestCase;
|
|
44547
44681
|
/**
|
|
44548
44682
|
* Prints whether a condition is true along with a description string.
|
|
44549
44683
|
*
|
|
@@ -46385,6 +46519,8 @@ interface Trail extends Instance {
|
|
|
46385
46519
|
*/
|
|
46386
46520
|
LightInfluence: number;
|
|
46387
46521
|
/**
|
|
46522
|
+
* Determines a multiplier for `Trail.Transparency` that is only visible to the local client.
|
|
46523
|
+
*
|
|
46388
46524
|
* - **ThreadSafety**: ReadSafe
|
|
46389
46525
|
* - **Tags**: Hidden, NotReplicated
|
|
46390
46526
|
*
|
|
@@ -48584,7 +48720,7 @@ interface UserInputService extends Instance {
|
|
|
48584
48720
|
*/
|
|
48585
48721
|
GetSupportedGamepadKeyCodes(this: UserInputService, gamepadNum: CastsToEnum<Enum.UserInputType>): Array<Enum.KeyCode>;
|
|
48586
48722
|
/**
|
|
48587
|
-
* **Deprecated:**
|
|
48723
|
+
* **Deprecated:** Use `VRService:GetUserCFrame()` instead.
|
|
48588
48724
|
*
|
|
48589
48725
|
* Returns a `CFrame` describing the position and orientation of a specified virtual reality device.
|
|
48590
48726
|
*
|
|
@@ -48857,7 +48993,7 @@ interface UserInputService extends Instance {
|
|
|
48857
48993
|
*/
|
|
48858
48994
|
readonly TouchTapInWorld: RBXScriptSignal<(position: Vector2, processedByUI: boolean) => void>;
|
|
48859
48995
|
/**
|
|
48860
|
-
* **Deprecated:**
|
|
48996
|
+
* **Deprecated:** Use `VRService.UserCFrameChanged` instead.
|
|
48861
48997
|
*
|
|
48862
48998
|
* Fires when the `CFrame` of a specified Virtual Reality device changes.
|
|
48863
48999
|
*
|
|
@@ -50453,6 +50589,21 @@ interface WeldConstraint extends Instance {
|
|
|
50453
50589
|
*/
|
|
50454
50590
|
Part1: BasePart | undefined;
|
|
50455
50591
|
}
|
|
50592
|
+
/**
|
|
50593
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
50594
|
+
*
|
|
50595
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WindowProtocolService)
|
|
50596
|
+
*/
|
|
50597
|
+
interface WindowProtocolService extends Instance {
|
|
50598
|
+
/**
|
|
50599
|
+
* **DO NOT USE!**
|
|
50600
|
+
*
|
|
50601
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
50602
|
+
* @hidden
|
|
50603
|
+
* @deprecated
|
|
50604
|
+
*/
|
|
50605
|
+
readonly _nominal_WindowProtocolService: unique symbol;
|
|
50606
|
+
}
|
|
50456
50607
|
/**
|
|
50457
50608
|
* Connects one or more `Instances` to form a processing graph of their streams. At the moment, only audio streams are supported, but this may expand in the future.
|
|
50458
50609
|
*
|
|
@@ -50563,6 +50714,21 @@ interface WrapTextureTransfer extends Instance {
|
|
|
50563
50714
|
*/
|
|
50564
50715
|
UVMinBound: Vector2;
|
|
50565
50716
|
}
|
|
50717
|
+
/**
|
|
50718
|
+
* - **Tags**: NotCreatable
|
|
50719
|
+
*
|
|
50720
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LuauExpression)
|
|
50721
|
+
*/
|
|
50722
|
+
interface LuauExpression extends RBXObject {
|
|
50723
|
+
/**
|
|
50724
|
+
* **DO NOT USE!**
|
|
50725
|
+
*
|
|
50726
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
50727
|
+
* @hidden
|
|
50728
|
+
* @deprecated
|
|
50729
|
+
*/
|
|
50730
|
+
readonly _nominal_LuauExpression: unique symbol;
|
|
50731
|
+
}
|
|
50566
50732
|
/**
|
|
50567
50733
|
* - **Tags**: NotCreatable, NotReplicated
|
|
50568
50734
|
*
|