@rbxts/types 1.0.939 → 1.0.941
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 +421 -44
- package/include/generated/PluginSecurity.d.ts +113 -5
- package/include/generated/enums.d.ts +632 -21
- 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
|
}
|
|
@@ -416,6 +420,7 @@ interface CreatableInstances {
|
|
|
416
420
|
ImageHandleAdornment: ImageHandleAdornment;
|
|
417
421
|
ImageLabel: ImageLabel;
|
|
418
422
|
InputAction: InputAction;
|
|
423
|
+
InputActionLabel: InputActionLabel;
|
|
419
424
|
InputBinding: InputBinding;
|
|
420
425
|
InputContext: InputContext;
|
|
421
426
|
IntConstrainedValue: IntConstrainedValue;
|
|
@@ -453,6 +458,7 @@ interface CreatableInstances {
|
|
|
453
458
|
ParticleEmitter: ParticleEmitter;
|
|
454
459
|
PartOperation: PartOperation;
|
|
455
460
|
Path2D: Path2D;
|
|
461
|
+
Path3D: Path3D;
|
|
456
462
|
PathfindingLink: PathfindingLink;
|
|
457
463
|
PathfindingModifier: PathfindingModifier;
|
|
458
464
|
PitchShiftSoundEffect: PitchShiftSoundEffect;
|
|
@@ -764,6 +770,7 @@ interface Objects extends Instances {
|
|
|
764
770
|
EditableImage: EditableImage;
|
|
765
771
|
EditableMesh: EditableMesh;
|
|
766
772
|
ExecutedRemoteCommand: ExecutedRemoteCommand;
|
|
773
|
+
LuauExpression: LuauExpression;
|
|
767
774
|
MLSession: MLSession;
|
|
768
775
|
Object: RBXObject;
|
|
769
776
|
OutputLink: OutputLink;
|
|
@@ -1277,6 +1284,69 @@ interface EditableMesh extends RBXObject {
|
|
|
1277
1284
|
* @returns Stable vertex ID of the new vertex.
|
|
1278
1285
|
*/
|
|
1279
1286
|
AddVertex(this: EditableMesh, p: Vector3): number;
|
|
1287
|
+
/**
|
|
1288
|
+
* - **ThreadSafety**: Unsafe
|
|
1289
|
+
* - **Tags**: CustomLuaState
|
|
1290
|
+
*
|
|
1291
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchAdd)
|
|
1292
|
+
*/
|
|
1293
|
+
BatchAdd(this: EditableMesh, attr: CastsToEnum<Enum.MeshAttribute>, data: Array<unknown>): Array<unknown>;
|
|
1294
|
+
/**
|
|
1295
|
+
* - **ThreadSafety**: Unsafe
|
|
1296
|
+
* - **Tags**: CustomLuaState
|
|
1297
|
+
*
|
|
1298
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetFaceAttributes)
|
|
1299
|
+
*/
|
|
1300
|
+
BatchGetFaceAttributes(this: EditableMesh, attr: CastsToEnum<Enum.MeshAttribute>, faceIds: Array<unknown>): Array<unknown>;
|
|
1301
|
+
/**
|
|
1302
|
+
* - **ThreadSafety**: Unsafe
|
|
1303
|
+
* - **Tags**: CustomLuaState
|
|
1304
|
+
*
|
|
1305
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetValues)
|
|
1306
|
+
*/
|
|
1307
|
+
BatchGetValues(this: EditableMesh, ids: Array<unknown>): unknown;
|
|
1308
|
+
/**
|
|
1309
|
+
* - **ThreadSafety**: Unsafe
|
|
1310
|
+
* - **Tags**: CustomLuaState
|
|
1311
|
+
*
|
|
1312
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetVertexAttributes)
|
|
1313
|
+
*/
|
|
1314
|
+
BatchGetVertexAttributes(this: EditableMesh, attr: CastsToEnum<Enum.MeshAttribute>, vertexIds: Array<unknown>): Array<unknown>;
|
|
1315
|
+
/**
|
|
1316
|
+
* - **ThreadSafety**: Unsafe
|
|
1317
|
+
* - **Tags**: CustomLuaState
|
|
1318
|
+
*
|
|
1319
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetVertexFaceAttributes)
|
|
1320
|
+
*/
|
|
1321
|
+
BatchGetVertexFaceAttributes(this: EditableMesh, attr: CastsToEnum<Enum.MeshAttribute>, vertexIds: Array<unknown>, faceIds: Array<unknown>): Array<unknown>;
|
|
1322
|
+
/**
|
|
1323
|
+
* - **ThreadSafety**: Unsafe
|
|
1324
|
+
* - **Tags**: CustomLuaState
|
|
1325
|
+
*
|
|
1326
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchRemove)
|
|
1327
|
+
*/
|
|
1328
|
+
BatchRemove(this: EditableMesh, ids: Array<unknown>): void;
|
|
1329
|
+
/**
|
|
1330
|
+
* - **ThreadSafety**: Unsafe
|
|
1331
|
+
* - **Tags**: CustomLuaState
|
|
1332
|
+
*
|
|
1333
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchSetFaceAttributes)
|
|
1334
|
+
*/
|
|
1335
|
+
BatchSetFaceAttributes(this: EditableMesh, faceIds: Array<unknown>, attrIdArrays: Array<unknown>): void;
|
|
1336
|
+
/**
|
|
1337
|
+
* - **ThreadSafety**: Unsafe
|
|
1338
|
+
* - **Tags**: CustomLuaState
|
|
1339
|
+
*
|
|
1340
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchSetValues)
|
|
1341
|
+
*/
|
|
1342
|
+
BatchSetValues(this: EditableMesh, ids: Array<unknown>, values: Array<unknown>): void;
|
|
1343
|
+
/**
|
|
1344
|
+
* - **ThreadSafety**: Unsafe
|
|
1345
|
+
* - **Tags**: CustomLuaState
|
|
1346
|
+
*
|
|
1347
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchSetVertexFaceAttributes)
|
|
1348
|
+
*/
|
|
1349
|
+
BatchSetVertexFaceAttributes(this: EditableMesh, vertexIds: Array<unknown>, faceIds: Array<unknown>, attrIds: Array<unknown>): void;
|
|
1280
1350
|
/**
|
|
1281
1351
|
* - **ThreadSafety**: Unsafe
|
|
1282
1352
|
* - **Tags**: NotBrowsable
|
|
@@ -1519,7 +1589,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1519
1589
|
*/
|
|
1520
1590
|
GetFaces(this: EditableMesh): Array<unknown>;
|
|
1521
1591
|
/**
|
|
1522
|
-
* **Deprecated:**
|
|
1592
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
1523
1593
|
*
|
|
1524
1594
|
* Returns a list of faces that use a given attribute ID.
|
|
1525
1595
|
*
|
|
@@ -1792,7 +1862,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1792
1862
|
*/
|
|
1793
1863
|
GetVertices(this: EditableMesh): Array<number>;
|
|
1794
1864
|
/**
|
|
1795
|
-
* **Deprecated:**
|
|
1865
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
1796
1866
|
*
|
|
1797
1867
|
* Returns a list of vertices that use a given attribute ID.
|
|
1798
1868
|
*
|
|
@@ -3120,7 +3190,7 @@ interface AnalyticsService extends Instance {
|
|
|
3120
3190
|
[index: string]: string;
|
|
3121
3191
|
}, customData?: unknown): void;
|
|
3122
3192
|
/**
|
|
3123
|
-
* **Deprecated:**
|
|
3193
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
3124
3194
|
*
|
|
3125
3195
|
* Fire a log event used to track errors and warnings experienced by players.
|
|
3126
3196
|
*
|
|
@@ -3846,33 +3916,36 @@ interface AnimationTrack extends Instance {
|
|
|
3846
3916
|
*/
|
|
3847
3917
|
GetMarkerReachedSignal(this: AnimationTrack, name: string): RBXScriptSignal<(param?: string) => void>;
|
|
3848
3918
|
/**
|
|
3919
|
+
* Returns the value of a parameter on the animation graph by key. Returns nil if the parameter has not been set.
|
|
3920
|
+
*
|
|
3849
3921
|
* - **ThreadSafety**: Unsafe
|
|
3850
3922
|
*
|
|
3851
3923
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameter)
|
|
3852
3924
|
* @param this Controls the playback of an animation on an `Animator`.
|
|
3853
|
-
* @param key
|
|
3925
|
+
* @param key The name of the parameter to retrieve.
|
|
3926
|
+
* @returns The current value of the parameter, or nil if not set.
|
|
3854
3927
|
*/
|
|
3855
3928
|
GetParameter(this: AnimationTrack, key: string): unknown;
|
|
3856
3929
|
/**
|
|
3930
|
+
* Returns a dictionary of parameter values initially set as instance attributes on the `AnimationGraphDefinition` instance used to build the animation graph inside this track.
|
|
3931
|
+
*
|
|
3857
3932
|
* - **ThreadSafety**: Unsafe
|
|
3858
3933
|
*
|
|
3859
3934
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameterDefaults)
|
|
3860
3935
|
* @param this Controls the playback of an animation on an `Animator`.
|
|
3936
|
+
* @returns A dictionary mapping parameter names to their default values. Returns an empty dictionary if the animation is not an animation graph.
|
|
3861
3937
|
*/
|
|
3862
3938
|
GetParameterDefaults(this: AnimationTrack): object;
|
|
3863
3939
|
/**
|
|
3864
3940
|
* - **ThreadSafety**: Unsafe
|
|
3865
3941
|
*
|
|
3866
3942
|
* [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
3943
|
*/
|
|
3870
3944
|
GetTargetInstance(this: AnimationTrack, name: string): Instance | undefined;
|
|
3871
3945
|
/**
|
|
3872
3946
|
* - **ThreadSafety**: Unsafe
|
|
3873
3947
|
*
|
|
3874
3948
|
* [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
3949
|
*/
|
|
3877
3950
|
GetTargetNames(this: AnimationTrack): Array<unknown>;
|
|
3878
3951
|
/**
|
|
@@ -3900,21 +3973,20 @@ interface AnimationTrack extends Instance {
|
|
|
3900
3973
|
*/
|
|
3901
3974
|
Play(this: AnimationTrack, fadeTime?: number, weight?: number, speed?: number): void;
|
|
3902
3975
|
/**
|
|
3976
|
+
* Sets a parameter value on the animation graph, driving animation graph node inputs.
|
|
3977
|
+
*
|
|
3903
3978
|
* - **ThreadSafety**: Unsafe
|
|
3904
3979
|
*
|
|
3905
3980
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetParameter)
|
|
3906
3981
|
* @param this Controls the playback of an animation on an `Animator`.
|
|
3907
|
-
* @param key
|
|
3908
|
-
* @param value
|
|
3982
|
+
* @param key The name of the parameter to set.
|
|
3983
|
+
* @param value The value to assign to the parameter. Non-finite numeric values are sanitized to 0.
|
|
3909
3984
|
*/
|
|
3910
3985
|
SetParameter(this: AnimationTrack, key: string, value: unknown): void;
|
|
3911
3986
|
/**
|
|
3912
3987
|
* - **ThreadSafety**: Unsafe
|
|
3913
3988
|
*
|
|
3914
3989
|
* [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
3990
|
*/
|
|
3919
3991
|
SetTargetInstance(this: AnimationTrack, name: string, target: Instance): void;
|
|
3920
3992
|
/**
|
|
@@ -3976,6 +4048,8 @@ interface Animator extends Instance {
|
|
|
3976
4048
|
*/
|
|
3977
4049
|
readonly _nominal_Animator: unique symbol;
|
|
3978
4050
|
/**
|
|
4051
|
+
* Indicates whether animation evaluation was throttled (skipped) this frame for this `Animator`.
|
|
4052
|
+
*
|
|
3979
4053
|
* - **ThreadSafety**: Safe
|
|
3980
4054
|
* - **Tags**: NotReplicated
|
|
3981
4055
|
*
|
|
@@ -3983,6 +4057,8 @@ interface Animator extends Instance {
|
|
|
3983
4057
|
*/
|
|
3984
4058
|
readonly EvaluationThrottled: boolean;
|
|
3985
4059
|
/**
|
|
4060
|
+
* Controls whether animation LOD throttling is allowed for this `Animator`. When set to `false`, animations always evaluate at full fidelity.
|
|
4061
|
+
*
|
|
3986
4062
|
* - **ThreadSafety**: ReadSafe
|
|
3987
4063
|
*
|
|
3988
4064
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#PreferLodEnabled)
|
|
@@ -4009,7 +4085,7 @@ interface Animator extends Instance {
|
|
|
4009
4085
|
*
|
|
4010
4086
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#ApplyJointVelocities)
|
|
4011
4087
|
* @param this Responsible for the playback and replication of `Animations`.
|
|
4012
|
-
* @param motors
|
|
4088
|
+
* @param motors An array of `Motor6D` instances to compute and apply velocities for.
|
|
4013
4089
|
*/
|
|
4014
4090
|
ApplyJointVelocities(this: Animator, motors: Array<Motor6D>): void;
|
|
4015
4091
|
/**
|
|
@@ -4046,8 +4122,6 @@ interface Animator extends Instance {
|
|
|
4046
4122
|
* - **ThreadSafety**: Unsafe
|
|
4047
4123
|
*
|
|
4048
4124
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#RegisterEvaluationParallelCallback)
|
|
4049
|
-
* @param this Responsible for the playback and replication of `Animations`.
|
|
4050
|
-
* @param callback
|
|
4051
4125
|
*/
|
|
4052
4126
|
RegisterEvaluationParallelCallback(this: Animator, callback: Callback): void;
|
|
4053
4127
|
/**
|
|
@@ -4487,7 +4561,7 @@ interface AssetService extends Instance {
|
|
|
4487
4561
|
*/
|
|
4488
4562
|
CreateSurfaceAppearanceAsync(this: AssetService, content: object): SurfaceAppearance;
|
|
4489
4563
|
/**
|
|
4490
|
-
* **Deprecated:**
|
|
4564
|
+
* **Deprecated:** Use `GetAssetIdsForPackageAsync()` instead.
|
|
4491
4565
|
*
|
|
4492
4566
|
* Returns an array of asset IDs that are contained in a specified package.
|
|
4493
4567
|
*
|
|
@@ -4629,7 +4703,7 @@ interface AssetService extends Instance {
|
|
|
4629
4703
|
*/
|
|
4630
4704
|
SavePlaceAsync(this: AssetService, requestParameters?: object): void;
|
|
4631
4705
|
/**
|
|
4632
|
-
* **Deprecated:**
|
|
4706
|
+
* **Deprecated:** Use `SearchAudioAsync()` instead.
|
|
4633
4707
|
*
|
|
4634
4708
|
* Finds audio assets matching a variety of search criteria.
|
|
4635
4709
|
*
|
|
@@ -5759,6 +5833,18 @@ interface AudioEmitter extends Instance {
|
|
|
5759
5833
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DiffractionEnabled)
|
|
5760
5834
|
*/
|
|
5761
5835
|
DiffractionEnabled: Enum.SimulationMode;
|
|
5836
|
+
/**
|
|
5837
|
+
* - **ThreadSafety**: ReadSafe
|
|
5838
|
+
*
|
|
5839
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DistanceAttenuationBounds)
|
|
5840
|
+
*/
|
|
5841
|
+
DistanceAttenuationBounds: NumberRange;
|
|
5842
|
+
/**
|
|
5843
|
+
* - **ThreadSafety**: ReadSafe
|
|
5844
|
+
*
|
|
5845
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DistanceAttenuationMode)
|
|
5846
|
+
*/
|
|
5847
|
+
DistanceAttenuationMode: Enum.DistanceAttenuationMode;
|
|
5762
5848
|
/**
|
|
5763
5849
|
* - **ThreadSafety**: ReadSafe
|
|
5764
5850
|
*
|
|
@@ -7261,7 +7347,7 @@ interface AudioSearchParams extends Instance {
|
|
|
7261
7347
|
*/
|
|
7262
7348
|
AudioSubType: Enum.AudioSubType;
|
|
7263
7349
|
/**
|
|
7264
|
-
* **Deprecated:**
|
|
7350
|
+
* **Deprecated:** Use `AudioSubType` instead.
|
|
7265
7351
|
*
|
|
7266
7352
|
* The subtype of the audio asset.
|
|
7267
7353
|
*
|
|
@@ -7365,15 +7451,23 @@ interface AudioSpeechToText extends Instance {
|
|
|
7365
7451
|
*/
|
|
7366
7452
|
GetConnectedWires(this: AudioSpeechToText, pin: string): Array<Instance>;
|
|
7367
7453
|
/**
|
|
7454
|
+
* Gets the list of pins that a `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
7455
|
+
*
|
|
7368
7456
|
* - **ThreadSafety**: Unsafe
|
|
7369
7457
|
*
|
|
7370
7458
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetInputPins)
|
|
7459
|
+
* @param this Converts spoken audio into text.
|
|
7460
|
+
* @returns An array of strings representing valid pin names.
|
|
7371
7461
|
*/
|
|
7372
7462
|
GetInputPins(this: AudioSpeechToText): Array<unknown>;
|
|
7373
7463
|
/**
|
|
7464
|
+
* Gets the list of pins that a `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
7465
|
+
*
|
|
7374
7466
|
* - **ThreadSafety**: Unsafe
|
|
7375
7467
|
*
|
|
7376
7468
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetOutputPins)
|
|
7469
|
+
* @param this Converts spoken audio into text.
|
|
7470
|
+
* @returns An array of strings representing valid pin names.
|
|
7377
7471
|
*/
|
|
7378
7472
|
GetOutputPins(this: AudioSpeechToText): Array<unknown>;
|
|
7379
7473
|
/**
|
|
@@ -7501,15 +7595,23 @@ interface AudioTextToSpeech extends Instance {
|
|
|
7501
7595
|
*/
|
|
7502
7596
|
GetConnectedWires(this: AudioTextToSpeech, pin: string): Array<Instance>;
|
|
7503
7597
|
/**
|
|
7598
|
+
* Gets the list of pins that a `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
7599
|
+
*
|
|
7504
7600
|
* - **ThreadSafety**: Unsafe
|
|
7505
7601
|
*
|
|
7506
7602
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetInputPins)
|
|
7603
|
+
* @param this Plays text as speech audio.
|
|
7604
|
+
* @returns An array of strings representing valid pin names.
|
|
7507
7605
|
*/
|
|
7508
7606
|
GetInputPins(this: AudioTextToSpeech): Array<unknown>;
|
|
7509
7607
|
/**
|
|
7608
|
+
* Gets the list of pins that a `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
7609
|
+
*
|
|
7510
7610
|
* - **ThreadSafety**: Unsafe
|
|
7511
7611
|
*
|
|
7512
7612
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetOutputPins)
|
|
7613
|
+
* @param this Plays text as speech audio.
|
|
7614
|
+
* @returns An array of strings representing valid pin names.
|
|
7513
7615
|
*/
|
|
7514
7616
|
GetOutputPins(this: AudioTextToSpeech): Array<unknown>;
|
|
7515
7617
|
/**
|
|
@@ -8223,7 +8325,7 @@ interface AvatarCreationService extends Instance {
|
|
|
8223
8325
|
* @param this A service to support developer avatar creators.
|
|
8224
8326
|
* @param player The `Player` validation is completed for.
|
|
8225
8327
|
* @param accessory The instance validation is run on.
|
|
8226
|
-
* @param accessoryType `AccessoryType` the instance is expected to be.
|
|
8328
|
+
* @param accessoryType The `AccessoryType` the instance is expected to be.
|
|
8227
8329
|
* @returns A tuple containing, in order: - A boolean indicating if validation was successful for the accessory.
|
|
8228
8330
|
* - An optional table of strings. This includes failure reasons if validation was unsuccessful; otherwise `nil` if validation was successful.
|
|
8229
8331
|
*/
|
|
@@ -8273,6 +8375,12 @@ interface AvatarCreationService extends Instance {
|
|
|
8273
8375
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AvatarModerationCompleted)
|
|
8274
8376
|
*/
|
|
8275
8377
|
readonly AvatarModerationCompleted: RBXScriptSignal<(outfitId: number, moderationStatus: Enum.ModerationStatus) => void>;
|
|
8378
|
+
/**
|
|
8379
|
+
* - **ThreadSafety**: Unsafe
|
|
8380
|
+
*
|
|
8381
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AvatarOutfitModerationCompleted)
|
|
8382
|
+
*/
|
|
8383
|
+
readonly AvatarOutfitModerationCompleted: RBXScriptSignal<(outfitId: number, moderationStatus: Enum.ModerationStatus, outfitType: Enum.OutfitType) => void>;
|
|
8276
8384
|
}
|
|
8277
8385
|
/**
|
|
8278
8386
|
* A service to support developer Avatar Editors.
|
|
@@ -8537,7 +8645,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8537
8645
|
*
|
|
8538
8646
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetHeadShapesAsync)
|
|
8539
8647
|
* @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: `"
|
|
8648
|
+
* @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
8649
|
*/
|
|
8542
8650
|
GetHeadShapesAsync(this: AvatarEditorService): Array<unknown>;
|
|
8543
8651
|
/**
|
|
@@ -8876,7 +8984,7 @@ interface BadgeService extends Instance {
|
|
|
8876
8984
|
*/
|
|
8877
8985
|
readonly _nominal_BadgeService: unique symbol;
|
|
8878
8986
|
/**
|
|
8879
|
-
* **Deprecated:**
|
|
8987
|
+
* **Deprecated:** Use `AwardBadgeAsync()` instead.
|
|
8880
8988
|
*
|
|
8881
8989
|
* Award a badge to a player given the ID of each.
|
|
8882
8990
|
*
|
|
@@ -8930,6 +9038,13 @@ interface BadgeService extends Instance {
|
|
|
8930
9038
|
* @returns A dictionary of information about the specified badge.
|
|
8931
9039
|
*/
|
|
8932
9040
|
GetBadgeInfoAsync(this: BadgeService, badgeId: number): BadgeInfo;
|
|
9041
|
+
/**
|
|
9042
|
+
* - **ThreadSafety**: Unsafe
|
|
9043
|
+
* - **Tags**: Yields
|
|
9044
|
+
*
|
|
9045
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BadgeService#GetUserBadgesAsync)
|
|
9046
|
+
*/
|
|
9047
|
+
GetUserBadgesAsync(this: BadgeService, userId: User, badgeIds: Array<unknown>): Array<unknown>;
|
|
8933
9048
|
/**
|
|
8934
9049
|
* **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
9050
|
*
|
|
@@ -9221,12 +9336,24 @@ interface MaterialImportData extends BaseImportData {
|
|
|
9221
9336
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#DiffuseFilePath)
|
|
9222
9337
|
*/
|
|
9223
9338
|
DiffuseFilePath: string;
|
|
9339
|
+
/**
|
|
9340
|
+
* - **ThreadSafety**: ReadSafe
|
|
9341
|
+
*
|
|
9342
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#DiffuseVersionedAssetId)
|
|
9343
|
+
*/
|
|
9344
|
+
DiffuseVersionedAssetId: number;
|
|
9224
9345
|
/**
|
|
9225
9346
|
* - **ThreadSafety**: ReadSafe
|
|
9226
9347
|
*
|
|
9227
9348
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#EmissiveFilePath)
|
|
9228
9349
|
*/
|
|
9229
9350
|
EmissiveFilePath: string;
|
|
9351
|
+
/**
|
|
9352
|
+
* - **ThreadSafety**: ReadSafe
|
|
9353
|
+
*
|
|
9354
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#EmissiveVersionedAssetId)
|
|
9355
|
+
*/
|
|
9356
|
+
EmissiveVersionedAssetId: number;
|
|
9230
9357
|
/**
|
|
9231
9358
|
* - **ThreadSafety**: ReadSafe
|
|
9232
9359
|
* - **Tags**: NotReplicated
|
|
@@ -9240,18 +9367,36 @@ interface MaterialImportData extends BaseImportData {
|
|
|
9240
9367
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#MetalnessFilePath)
|
|
9241
9368
|
*/
|
|
9242
9369
|
MetalnessFilePath: string;
|
|
9370
|
+
/**
|
|
9371
|
+
* - **ThreadSafety**: ReadSafe
|
|
9372
|
+
*
|
|
9373
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#MetalnessVersionedAssetId)
|
|
9374
|
+
*/
|
|
9375
|
+
MetalnessVersionedAssetId: number;
|
|
9243
9376
|
/**
|
|
9244
9377
|
* - **ThreadSafety**: ReadSafe
|
|
9245
9378
|
*
|
|
9246
9379
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#NormalFilePath)
|
|
9247
9380
|
*/
|
|
9248
9381
|
NormalFilePath: string;
|
|
9382
|
+
/**
|
|
9383
|
+
* - **ThreadSafety**: ReadSafe
|
|
9384
|
+
*
|
|
9385
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#NormalVersionedAssetId)
|
|
9386
|
+
*/
|
|
9387
|
+
NormalVersionedAssetId: number;
|
|
9249
9388
|
/**
|
|
9250
9389
|
* - **ThreadSafety**: ReadSafe
|
|
9251
9390
|
*
|
|
9252
9391
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#RoughnessFilePath)
|
|
9253
9392
|
*/
|
|
9254
9393
|
RoughnessFilePath: string;
|
|
9394
|
+
/**
|
|
9395
|
+
* - **ThreadSafety**: ReadSafe
|
|
9396
|
+
*
|
|
9397
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialImportData#RoughnessVersionedAssetId)
|
|
9398
|
+
*/
|
|
9399
|
+
RoughnessVersionedAssetId: number;
|
|
9255
9400
|
}
|
|
9256
9401
|
/**
|
|
9257
9402
|
* - **Tags**: NotCreatable, NotReplicated
|
|
@@ -9396,6 +9541,12 @@ interface MeshImportData extends BaseImportData {
|
|
|
9396
9541
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MeshImportData#UseImportedPivot)
|
|
9397
9542
|
*/
|
|
9398
9543
|
UseImportedPivot: boolean;
|
|
9544
|
+
/**
|
|
9545
|
+
* - **ThreadSafety**: ReadSafe
|
|
9546
|
+
*
|
|
9547
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MeshImportData#VersionedAssetId)
|
|
9548
|
+
*/
|
|
9549
|
+
VersionedAssetId: number;
|
|
9399
9550
|
}
|
|
9400
9551
|
/**
|
|
9401
9552
|
* - **Tags**: NotCreatable, NotReplicated
|
|
@@ -18166,6 +18317,13 @@ interface GenerationService extends Instance {
|
|
|
18166
18317
|
* @returns The generated asset, returned as a `Model` with a single `MeshPart` containing an `EditableMesh`.
|
|
18167
18318
|
*/
|
|
18168
18319
|
LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
|
|
18320
|
+
/**
|
|
18321
|
+
* - **ThreadSafety**: Unsafe
|
|
18322
|
+
* - **Tags**: Yields
|
|
18323
|
+
*
|
|
18324
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#SegmentMeshAsync)
|
|
18325
|
+
*/
|
|
18326
|
+
SegmentMeshAsync(this: GenerationService, meshPart: MeshPart, schema: object, options?: object): unknown;
|
|
18169
18327
|
/**
|
|
18170
18328
|
* - **ThreadSafety**: Unsafe
|
|
18171
18329
|
* - **Tags**: Yields
|
|
@@ -18609,7 +18767,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
18609
18767
|
*/
|
|
18610
18768
|
ListVersionsAsync(this: DataStore, key: string, sortDirection?: CastsToEnum<Enum.SortDirection>, minDate?: number, maxDate?: number, pageSize?: number): DataStoreVersionPages;
|
|
18611
18769
|
/**
|
|
18612
|
-
* **Deprecated:**
|
|
18770
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
18613
18771
|
*
|
|
18614
18772
|
* Permanently deletes the specified version of a key.
|
|
18615
18773
|
*
|
|
@@ -19400,7 +19558,7 @@ interface GuiObject extends GuiBase2d {
|
|
|
19400
19558
|
readonly TouchTap: RBXScriptSignal<(touchPositions: Array<Vector2>) => void>;
|
|
19401
19559
|
}
|
|
19402
19560
|
/**
|
|
19403
|
-
* Blends descendants as a group with color/transparency.
|
|
19561
|
+
* Blends descendants as a flattened group with an optional color/transparency modification.
|
|
19404
19562
|
*
|
|
19405
19563
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CanvasGroup)
|
|
19406
19564
|
*/
|
|
@@ -19414,7 +19572,7 @@ interface CanvasGroup extends GuiObject {
|
|
|
19414
19572
|
*/
|
|
19415
19573
|
readonly _nominal_CanvasGroup: unique symbol;
|
|
19416
19574
|
/**
|
|
19417
|
-
* Color tint that applies to
|
|
19575
|
+
* Color tint that applies to the rendered group.
|
|
19418
19576
|
*
|
|
19419
19577
|
* - **ThreadSafety**: ReadSafe
|
|
19420
19578
|
*
|
|
@@ -19422,7 +19580,7 @@ interface CanvasGroup extends GuiObject {
|
|
|
19422
19580
|
*/
|
|
19423
19581
|
GroupColor3: Color3;
|
|
19424
19582
|
/**
|
|
19425
|
-
* Transparency that applies to
|
|
19583
|
+
* Transparency that applies to the rendered group.
|
|
19426
19584
|
*
|
|
19427
19585
|
* - **ThreadSafety**: ReadSafe
|
|
19428
19586
|
*
|
|
@@ -20335,6 +20493,93 @@ interface TextLabel extends GuiLabel {
|
|
|
20335
20493
|
*/
|
|
20336
20494
|
TextYAlignment: Enum.TextYAlignment;
|
|
20337
20495
|
}
|
|
20496
|
+
/**
|
|
20497
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel)
|
|
20498
|
+
*/
|
|
20499
|
+
interface InputActionLabel extends GuiObject {
|
|
20500
|
+
/**
|
|
20501
|
+
* **DO NOT USE!**
|
|
20502
|
+
*
|
|
20503
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
20504
|
+
* @hidden
|
|
20505
|
+
* @deprecated
|
|
20506
|
+
*/
|
|
20507
|
+
readonly _nominal_InputActionLabel: unique symbol;
|
|
20508
|
+
/**
|
|
20509
|
+
* - **ThreadSafety**: ReadSafe
|
|
20510
|
+
*
|
|
20511
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#FontFace)
|
|
20512
|
+
*/
|
|
20513
|
+
FontFace: Font;
|
|
20514
|
+
/**
|
|
20515
|
+
* - **ThreadSafety**: ReadSafe
|
|
20516
|
+
*
|
|
20517
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#ImageColor3)
|
|
20518
|
+
*/
|
|
20519
|
+
ImageColor3: Color3;
|
|
20520
|
+
/**
|
|
20521
|
+
* - **ThreadSafety**: ReadSafe
|
|
20522
|
+
*
|
|
20523
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#ImageTransparency)
|
|
20524
|
+
*/
|
|
20525
|
+
ImageTransparency: number;
|
|
20526
|
+
/**
|
|
20527
|
+
* - **ThreadSafety**: ReadSafe
|
|
20528
|
+
*
|
|
20529
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#InputAction)
|
|
20530
|
+
*/
|
|
20531
|
+
InputAction: InputAction | undefined;
|
|
20532
|
+
/**
|
|
20533
|
+
* - **ThreadSafety**: ReadSafe
|
|
20534
|
+
* - **Tags**: NotReplicated
|
|
20535
|
+
*
|
|
20536
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#ResolvedImageContent)
|
|
20537
|
+
*/
|
|
20538
|
+
readonly ResolvedImageContent: Content;
|
|
20539
|
+
/**
|
|
20540
|
+
* - **ThreadSafety**: ReadSafe
|
|
20541
|
+
* - **Tags**: NotReplicated
|
|
20542
|
+
*
|
|
20543
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#ResolvedText)
|
|
20544
|
+
*/
|
|
20545
|
+
readonly ResolvedText: string;
|
|
20546
|
+
/**
|
|
20547
|
+
* - **ThreadSafety**: ReadSafe
|
|
20548
|
+
*
|
|
20549
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#TextColor3)
|
|
20550
|
+
*/
|
|
20551
|
+
TextColor3: Color3;
|
|
20552
|
+
/**
|
|
20553
|
+
* - **ThreadSafety**: ReadSafe
|
|
20554
|
+
*
|
|
20555
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#TextSize)
|
|
20556
|
+
*/
|
|
20557
|
+
TextSize: number;
|
|
20558
|
+
/**
|
|
20559
|
+
* - **ThreadSafety**: ReadSafe
|
|
20560
|
+
*
|
|
20561
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#TextTransparency)
|
|
20562
|
+
*/
|
|
20563
|
+
TextTransparency: number;
|
|
20564
|
+
/**
|
|
20565
|
+
* - **ThreadSafety**: ReadSafe
|
|
20566
|
+
*
|
|
20567
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#TextWrapped)
|
|
20568
|
+
*/
|
|
20569
|
+
TextWrapped: boolean;
|
|
20570
|
+
/**
|
|
20571
|
+
* - **ThreadSafety**: ReadSafe
|
|
20572
|
+
*
|
|
20573
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#TextXAlignment)
|
|
20574
|
+
*/
|
|
20575
|
+
TextXAlignment: Enum.TextXAlignment;
|
|
20576
|
+
/**
|
|
20577
|
+
* - **ThreadSafety**: ReadSafe
|
|
20578
|
+
*
|
|
20579
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputActionLabel#TextYAlignment)
|
|
20580
|
+
*/
|
|
20581
|
+
TextYAlignment: Enum.TextYAlignment;
|
|
20582
|
+
}
|
|
20338
20583
|
/**
|
|
20339
20584
|
* - **Tags**: NotReplicated
|
|
20340
20585
|
*
|
|
@@ -26150,6 +26395,8 @@ interface InputAction extends Instance {
|
|
|
26150
26395
|
*/
|
|
26151
26396
|
Enabled: boolean;
|
|
26152
26397
|
/**
|
|
26398
|
+
* The `InputBinding` best matching the player's current input device.
|
|
26399
|
+
*
|
|
26153
26400
|
* - **ThreadSafety**: ReadSafe
|
|
26154
26401
|
* - **Tags**: NotReplicated
|
|
26155
26402
|
*
|
|
@@ -26245,12 +26492,16 @@ interface InputBinding extends Instance {
|
|
|
26245
26492
|
*/
|
|
26246
26493
|
ClampMagnitudeToOne: boolean;
|
|
26247
26494
|
/**
|
|
26495
|
+
* Custom image asset to display for this binding.
|
|
26496
|
+
*
|
|
26248
26497
|
* - **ThreadSafety**: ReadSafe
|
|
26249
26498
|
*
|
|
26250
26499
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#DisplayImage)
|
|
26251
26500
|
*/
|
|
26252
26501
|
DisplayImage: Content;
|
|
26253
26502
|
/**
|
|
26503
|
+
* Custom display text for this binding.
|
|
26504
|
+
*
|
|
26254
26505
|
* - **ThreadSafety**: ReadSafe
|
|
26255
26506
|
*
|
|
26256
26507
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#DisplayName)
|
|
@@ -26642,7 +26893,7 @@ interface InsertService extends Instance {
|
|
|
26642
26893
|
*/
|
|
26643
26894
|
GetCollection(this: InsertService, categoryId: number): Array<CollectionInfo>;
|
|
26644
26895
|
/**
|
|
26645
|
-
* **Deprecated:**
|
|
26896
|
+
* **Deprecated:** Use `GetFreeDecalsAsync()` instead.
|
|
26646
26897
|
*
|
|
26647
26898
|
* Retrieves a list of free Decals from the Catalog.
|
|
26648
26899
|
*
|
|
@@ -26674,7 +26925,7 @@ interface InsertService extends Instance {
|
|
|
26674
26925
|
*/
|
|
26675
26926
|
GetFreeDecalsAsync(this: InsertService, searchText: string, pageNum: number): Array<unknown>;
|
|
26676
26927
|
/**
|
|
26677
|
-
* **Deprecated:**
|
|
26928
|
+
* **Deprecated:** Use `GetFreeModelsAsync()` instead.
|
|
26678
26929
|
*
|
|
26679
26930
|
* Retrieves a list of Free Models from the Catalog.
|
|
26680
26931
|
*
|
|
@@ -28773,6 +29024,21 @@ interface ModuleScript extends LuaSourceContainer {
|
|
|
28773
29024
|
*/
|
|
28774
29025
|
Source: ProtectedString;
|
|
28775
29026
|
}
|
|
29027
|
+
/**
|
|
29028
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
29029
|
+
*
|
|
29030
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LuauExpressionService)
|
|
29031
|
+
*/
|
|
29032
|
+
interface LuauExpressionService extends Instance {
|
|
29033
|
+
/**
|
|
29034
|
+
* **DO NOT USE!**
|
|
29035
|
+
*
|
|
29036
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
29037
|
+
* @hidden
|
|
29038
|
+
* @deprecated
|
|
29039
|
+
*/
|
|
29040
|
+
readonly _nominal_LuauExpressionService: unique symbol;
|
|
29041
|
+
}
|
|
28776
29042
|
/**
|
|
28777
29043
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
28778
29044
|
*
|
|
@@ -30497,7 +30763,7 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
30497
30763
|
*/
|
|
30498
30764
|
readonly _nominal_OpenCloudApiV1: unique symbol;
|
|
30499
30765
|
/**
|
|
30500
|
-
* **Deprecated:**
|
|
30766
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30501
30767
|
*
|
|
30502
30768
|
* - **ThreadSafety**: Unsafe
|
|
30503
30769
|
* - **Tags**: CustomLuaState
|
|
@@ -30510,7 +30776,7 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
30510
30776
|
*/
|
|
30511
30777
|
CreateModel(this: OpenCloudApiV1, name: string): OpenCloudModel;
|
|
30512
30778
|
/**
|
|
30513
|
-
* **Deprecated:**
|
|
30779
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30514
30780
|
*
|
|
30515
30781
|
* - **ThreadSafety**: Unsafe
|
|
30516
30782
|
* - **Tags**: Yields
|
|
@@ -30543,7 +30809,7 @@ interface OpenCloudService extends Instance {
|
|
|
30543
30809
|
*/
|
|
30544
30810
|
readonly _nominal_OpenCloudService: unique symbol;
|
|
30545
30811
|
/**
|
|
30546
|
-
* **Deprecated:**
|
|
30812
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30547
30813
|
*
|
|
30548
30814
|
* - **ThreadSafety**: Unsafe
|
|
30549
30815
|
* - **Tags**:
|
|
@@ -30555,7 +30821,7 @@ interface OpenCloudService extends Instance {
|
|
|
30555
30821
|
*/
|
|
30556
30822
|
GetApiV1(this: OpenCloudService): OpenCloudApiV1;
|
|
30557
30823
|
/**
|
|
30558
|
-
* **Deprecated:**
|
|
30824
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
30559
30825
|
*
|
|
30560
30826
|
* - **ThreadSafety**: Unsafe
|
|
30561
30827
|
* - **Tags**: Yields
|
|
@@ -33078,7 +33344,7 @@ interface Camera extends PVInstance {
|
|
|
33078
33344
|
*/
|
|
33079
33345
|
readonly ViewportSize: Vector2;
|
|
33080
33346
|
/**
|
|
33081
|
-
* **Deprecated:**
|
|
33347
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
33082
33348
|
*
|
|
33083
33349
|
* 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
33350
|
*
|
|
@@ -34904,6 +35170,8 @@ interface ParticleEmitter extends Instance {
|
|
|
34904
35170
|
*/
|
|
34905
35171
|
LightInfluence: number;
|
|
34906
35172
|
/**
|
|
35173
|
+
* Determines a multiplier for `ParticleEmitter.Transparency` that is only visible to the local client.
|
|
35174
|
+
*
|
|
34907
35175
|
* - **ThreadSafety**: ReadSafe
|
|
34908
35176
|
* - **Tags**: Hidden, NotReplicated
|
|
34909
35177
|
*
|
|
@@ -35267,6 +35535,19 @@ interface Path extends Instance {
|
|
|
35267
35535
|
*/
|
|
35268
35536
|
readonly Unblocked: RBXScriptSignal<(unblockedWaypointIdx: number) => void>;
|
|
35269
35537
|
}
|
|
35538
|
+
/**
|
|
35539
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path3D)
|
|
35540
|
+
*/
|
|
35541
|
+
interface Path3D extends Instance {
|
|
35542
|
+
/**
|
|
35543
|
+
* **DO NOT USE!**
|
|
35544
|
+
*
|
|
35545
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
35546
|
+
* @hidden
|
|
35547
|
+
* @deprecated
|
|
35548
|
+
*/
|
|
35549
|
+
readonly _nominal_Path3D: unique symbol;
|
|
35550
|
+
}
|
|
35270
35551
|
/**
|
|
35271
35552
|
* Connects two locations which otherwise by default are unconnected.
|
|
35272
35553
|
*
|
|
@@ -35698,6 +35979,21 @@ interface PhysicsService extends Instance {
|
|
|
35698
35979
|
*/
|
|
35699
35980
|
UnregisterCollisionGroup(this: PhysicsService, name: string): void;
|
|
35700
35981
|
}
|
|
35982
|
+
/**
|
|
35983
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
35984
|
+
*
|
|
35985
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PinShortcutService)
|
|
35986
|
+
*/
|
|
35987
|
+
interface PinShortcutService extends Instance {
|
|
35988
|
+
/**
|
|
35989
|
+
* **DO NOT USE!**
|
|
35990
|
+
*
|
|
35991
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
35992
|
+
* @hidden
|
|
35993
|
+
* @deprecated
|
|
35994
|
+
*/
|
|
35995
|
+
readonly _nominal_PinShortcutService: unique symbol;
|
|
35996
|
+
}
|
|
35701
35997
|
/**
|
|
35702
35998
|
* - **Tags**: NotCreatable, Service
|
|
35703
35999
|
*
|
|
@@ -36233,7 +36529,7 @@ interface Player extends Instance {
|
|
|
36233
36529
|
*/
|
|
36234
36530
|
LoadBoolean(this: Player, key: string): boolean;
|
|
36235
36531
|
/**
|
|
36236
|
-
* **Deprecated:**
|
|
36532
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
36237
36533
|
*
|
|
36238
36534
|
* Places the given instance either in the player's character, head, or StarterGear based on the instance's class.
|
|
36239
36535
|
*
|
|
@@ -37273,7 +37569,7 @@ interface Players extends Instance {
|
|
|
37273
37569
|
*/
|
|
37274
37570
|
GetBanHistoryAsync(this: Players, userId: User): BanHistoryPages;
|
|
37275
37571
|
/**
|
|
37276
|
-
* **Deprecated:**
|
|
37572
|
+
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
37277
37573
|
*
|
|
37278
37574
|
* Returns a `Model` containing the assets which the player is wearing, excluding gear.
|
|
37279
37575
|
*
|
|
@@ -38879,6 +39175,21 @@ interface ReplicatedStorage extends Instance {
|
|
|
38879
39175
|
*/
|
|
38880
39176
|
readonly _nominal_ReplicatedStorage: unique symbol;
|
|
38881
39177
|
}
|
|
39178
|
+
/**
|
|
39179
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
39180
|
+
*
|
|
39181
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RequestOrchestratorService)
|
|
39182
|
+
*/
|
|
39183
|
+
interface RequestOrchestratorService extends Instance {
|
|
39184
|
+
/**
|
|
39185
|
+
* **DO NOT USE!**
|
|
39186
|
+
*
|
|
39187
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
39188
|
+
* @hidden
|
|
39189
|
+
* @deprecated
|
|
39190
|
+
*/
|
|
39191
|
+
readonly _nominal_RequestOrchestratorService: unique symbol;
|
|
39192
|
+
}
|
|
38882
39193
|
/**
|
|
38883
39194
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
38884
39195
|
*
|
|
@@ -39483,7 +39794,7 @@ interface ScreenshotHud extends Instance {
|
|
|
39483
39794
|
*/
|
|
39484
39795
|
CloseWhenScreenshotTaken: boolean;
|
|
39485
39796
|
/**
|
|
39486
|
-
* **Deprecated:**
|
|
39797
|
+
* **Deprecated:** This property is deprecated. Do not use it for new work.
|
|
39487
39798
|
*
|
|
39488
39799
|
* Whether the experience name in the overlay is enabled.
|
|
39489
39800
|
*
|
|
@@ -39508,7 +39819,7 @@ interface ScreenshotHud extends Instance {
|
|
|
39508
39819
|
*/
|
|
39509
39820
|
HidePlayerGuiForCaptures: boolean;
|
|
39510
39821
|
/**
|
|
39511
|
-
* **Deprecated:**
|
|
39822
|
+
* **Deprecated:** This property is deprecated. Do not use it for new work.
|
|
39512
39823
|
*
|
|
39513
39824
|
* `Font` used for the experience name in the overlay.
|
|
39514
39825
|
*
|
|
@@ -39521,7 +39832,7 @@ interface ScreenshotHud extends Instance {
|
|
|
39521
39832
|
*/
|
|
39522
39833
|
OverlayFont: Enum.Font;
|
|
39523
39834
|
/**
|
|
39524
|
-
* **Deprecated:**
|
|
39835
|
+
* **Deprecated:** This property is deprecated. Do not use it for new work.
|
|
39525
39836
|
*
|
|
39526
39837
|
* Currently disabled with no effect.
|
|
39527
39838
|
*
|
|
@@ -41112,7 +41423,7 @@ interface SocialService extends Instance {
|
|
|
41112
41423
|
*/
|
|
41113
41424
|
PromptFeedbackSubmissionAsync(this: SocialService, options?: object): void;
|
|
41114
41425
|
/**
|
|
41115
|
-
* **Deprecated:**
|
|
41426
|
+
* **Deprecated:** Use `PromptLinkSharingAsync()` instead.
|
|
41116
41427
|
*
|
|
41117
41428
|
* - **ThreadSafety**: Unsafe
|
|
41118
41429
|
* - **Tags**: Yields
|
|
@@ -42638,7 +42949,7 @@ interface Stats extends Instance {
|
|
|
42638
42949
|
*/
|
|
42639
42950
|
readonly HeartbeatTime: number;
|
|
42640
42951
|
/**
|
|
42641
|
-
* **Deprecated:**
|
|
42952
|
+
* **Deprecated:** Use `Stats.HeartbeatTime` instead.
|
|
42642
42953
|
*
|
|
42643
42954
|
* 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
42955
|
*
|
|
@@ -42705,7 +43016,7 @@ interface Stats extends Instance {
|
|
|
42705
43016
|
*/
|
|
42706
43017
|
readonly PhysicsStepTime: number;
|
|
42707
43018
|
/**
|
|
42708
|
-
* **Deprecated:**
|
|
43019
|
+
* **Deprecated:** Use `Stats.PhysicsStepTime` instead.
|
|
42709
43020
|
*
|
|
42710
43021
|
* 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
43022
|
*
|
|
@@ -44091,7 +44402,7 @@ interface TeleportService extends Instance {
|
|
|
44091
44402
|
*/
|
|
44092
44403
|
PromptExperienceDetailsAsync(this: TeleportService, player: Player, universeId: number): Enum.PromptExperienceDetailsResult;
|
|
44093
44404
|
/**
|
|
44094
|
-
* **Deprecated:**
|
|
44405
|
+
* **Deprecated:** Use `ReserveServerAsync()` instead.
|
|
44095
44406
|
*
|
|
44096
44407
|
* Returns an access code that can be used to teleport players to a reserved server, along with the `DataModel.PrivateServerId` for it.
|
|
44097
44408
|
*
|
|
@@ -44307,6 +44618,12 @@ interface TestCase extends Instance {
|
|
|
44307
44618
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#Assert)
|
|
44308
44619
|
*/
|
|
44309
44620
|
Assert(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44621
|
+
/**
|
|
44622
|
+
* - **ThreadSafety**: Unsafe
|
|
44623
|
+
*
|
|
44624
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#AssertLegacy)
|
|
44625
|
+
*/
|
|
44626
|
+
AssertLegacy(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44310
44627
|
/**
|
|
44311
44628
|
* - **ThreadSafety**: Unsafe
|
|
44312
44629
|
*
|
|
@@ -44325,6 +44642,12 @@ interface TestCase extends Instance {
|
|
|
44325
44642
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#Require)
|
|
44326
44643
|
*/
|
|
44327
44644
|
Require(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44645
|
+
/**
|
|
44646
|
+
* - **ThreadSafety**: Unsafe
|
|
44647
|
+
*
|
|
44648
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestCase#RequireLegacy)
|
|
44649
|
+
*/
|
|
44650
|
+
RequireLegacy(this: TestCase, condition: boolean, message?: string, source?: Instance, line?: number): void;
|
|
44328
44651
|
}
|
|
44329
44652
|
/**
|
|
44330
44653
|
* 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 +44867,12 @@ interface TestService extends Instance {
|
|
|
44544
44867
|
* @param testOptions
|
|
44545
44868
|
*/
|
|
44546
44869
|
RegisterTest(this: TestService, testOptions: object): TestCase;
|
|
44870
|
+
/**
|
|
44871
|
+
* - **ThreadSafety**: Unsafe
|
|
44872
|
+
*
|
|
44873
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RegisterTestLegacy)
|
|
44874
|
+
*/
|
|
44875
|
+
RegisterTestLegacy(this: TestService, testOptions: object): TestCase;
|
|
44547
44876
|
/**
|
|
44548
44877
|
* Prints whether a condition is true along with a description string.
|
|
44549
44878
|
*
|
|
@@ -44631,13 +44960,20 @@ interface TestService extends Instance {
|
|
|
44631
44960
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#CaptureScreenshotAsync)
|
|
44632
44961
|
*/
|
|
44633
44962
|
CaptureScreenshotAsync(this: TestService, artifactName?: string, options?: object): unknown;
|
|
44963
|
+
/**
|
|
44964
|
+
* - **ThreadSafety**: Unsafe
|
|
44965
|
+
* - **Tags**: Yields
|
|
44966
|
+
*
|
|
44967
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#FetchTestControlsAsync)
|
|
44968
|
+
*/
|
|
44969
|
+
FetchTestControlsAsync(this: TestService, category: string): unknown;
|
|
44634
44970
|
/**
|
|
44635
44971
|
* - **ThreadSafety**: Unsafe
|
|
44636
44972
|
* - **Tags**: Yields
|
|
44637
44973
|
*
|
|
44638
44974
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RequestValidationAsync)
|
|
44639
44975
|
*/
|
|
44640
|
-
RequestValidationAsync(this: TestService, artifactType: string, artifactName: string): unknown;
|
|
44976
|
+
RequestValidationAsync(this: TestService, artifactType: string, artifactName: string, timeoutSeconds?: number): unknown;
|
|
44641
44977
|
/**
|
|
44642
44978
|
* - **ThreadSafety**: Unsafe
|
|
44643
44979
|
* - **Tags**: Yields
|
|
@@ -46385,6 +46721,8 @@ interface Trail extends Instance {
|
|
|
46385
46721
|
*/
|
|
46386
46722
|
LightInfluence: number;
|
|
46387
46723
|
/**
|
|
46724
|
+
* Determines a multiplier for `Trail.Transparency` that is only visible to the local client.
|
|
46725
|
+
*
|
|
46388
46726
|
* - **ThreadSafety**: ReadSafe
|
|
46389
46727
|
* - **Tags**: Hidden, NotReplicated
|
|
46390
46728
|
*
|
|
@@ -47269,12 +47607,14 @@ interface UIGradient extends UIComponent {
|
|
|
47269
47607
|
Rotation: number;
|
|
47270
47608
|
/**
|
|
47271
47609
|
* - **ThreadSafety**: ReadSafe
|
|
47610
|
+
* - **Tags**: NotBrowsable
|
|
47272
47611
|
*
|
|
47273
47612
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#Scale)
|
|
47274
47613
|
*/
|
|
47275
47614
|
Scale: number;
|
|
47276
47615
|
/**
|
|
47277
47616
|
* - **ThreadSafety**: ReadSafe
|
|
47617
|
+
* - **Tags**: NotBrowsable
|
|
47278
47618
|
*
|
|
47279
47619
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#TileMode)
|
|
47280
47620
|
*/
|
|
@@ -47289,6 +47629,7 @@ interface UIGradient extends UIComponent {
|
|
|
47289
47629
|
Transparency: NumberSequence;
|
|
47290
47630
|
/**
|
|
47291
47631
|
* - **ThreadSafety**: ReadSafe
|
|
47632
|
+
* - **Tags**: NotBrowsable
|
|
47292
47633
|
*
|
|
47293
47634
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#Type)
|
|
47294
47635
|
*/
|
|
@@ -47829,6 +48170,12 @@ interface UIShadow extends UIComponent {
|
|
|
47829
48170
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Enabled)
|
|
47830
48171
|
*/
|
|
47831
48172
|
Enabled: boolean;
|
|
48173
|
+
/**
|
|
48174
|
+
* - **ThreadSafety**: ReadSafe
|
|
48175
|
+
*
|
|
48176
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Mode)
|
|
48177
|
+
*/
|
|
48178
|
+
Mode: Enum.ApplyShadowMode;
|
|
47832
48179
|
/**
|
|
47833
48180
|
* Moves the shadow relative to the parent's position.
|
|
47834
48181
|
*
|
|
@@ -48584,7 +48931,7 @@ interface UserInputService extends Instance {
|
|
|
48584
48931
|
*/
|
|
48585
48932
|
GetSupportedGamepadKeyCodes(this: UserInputService, gamepadNum: CastsToEnum<Enum.UserInputType>): Array<Enum.KeyCode>;
|
|
48586
48933
|
/**
|
|
48587
|
-
* **Deprecated:**
|
|
48934
|
+
* **Deprecated:** Use `VRService:GetUserCFrame()` instead.
|
|
48588
48935
|
*
|
|
48589
48936
|
* Returns a `CFrame` describing the position and orientation of a specified virtual reality device.
|
|
48590
48937
|
*
|
|
@@ -48857,7 +49204,7 @@ interface UserInputService extends Instance {
|
|
|
48857
49204
|
*/
|
|
48858
49205
|
readonly TouchTapInWorld: RBXScriptSignal<(position: Vector2, processedByUI: boolean) => void>;
|
|
48859
49206
|
/**
|
|
48860
|
-
* **Deprecated:**
|
|
49207
|
+
* **Deprecated:** Use `VRService.UserCFrameChanged` instead.
|
|
48861
49208
|
*
|
|
48862
49209
|
* Fires when the `CFrame` of a specified Virtual Reality device changes.
|
|
48863
49210
|
*
|
|
@@ -50453,6 +50800,21 @@ interface WeldConstraint extends Instance {
|
|
|
50453
50800
|
*/
|
|
50454
50801
|
Part1: BasePart | undefined;
|
|
50455
50802
|
}
|
|
50803
|
+
/**
|
|
50804
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
50805
|
+
*
|
|
50806
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WindowProtocolService)
|
|
50807
|
+
*/
|
|
50808
|
+
interface WindowProtocolService extends Instance {
|
|
50809
|
+
/**
|
|
50810
|
+
* **DO NOT USE!**
|
|
50811
|
+
*
|
|
50812
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
50813
|
+
* @hidden
|
|
50814
|
+
* @deprecated
|
|
50815
|
+
*/
|
|
50816
|
+
readonly _nominal_WindowProtocolService: unique symbol;
|
|
50817
|
+
}
|
|
50456
50818
|
/**
|
|
50457
50819
|
* 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
50820
|
*
|
|
@@ -50563,6 +50925,21 @@ interface WrapTextureTransfer extends Instance {
|
|
|
50563
50925
|
*/
|
|
50564
50926
|
UVMinBound: Vector2;
|
|
50565
50927
|
}
|
|
50928
|
+
/**
|
|
50929
|
+
* - **Tags**: NotCreatable
|
|
50930
|
+
*
|
|
50931
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LuauExpression)
|
|
50932
|
+
*/
|
|
50933
|
+
interface LuauExpression extends RBXObject {
|
|
50934
|
+
/**
|
|
50935
|
+
* **DO NOT USE!**
|
|
50936
|
+
*
|
|
50937
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
50938
|
+
* @hidden
|
|
50939
|
+
* @deprecated
|
|
50940
|
+
*/
|
|
50941
|
+
readonly _nominal_LuauExpression: unique symbol;
|
|
50942
|
+
}
|
|
50566
50943
|
/**
|
|
50567
50944
|
* - **Tags**: NotCreatable, NotReplicated
|
|
50568
50945
|
*
|