@rbxts/types 1.0.532 → 1.0.536
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 +289 -130
- package/include/generated/PluginSecurity.d.ts +20 -16
- package/include/generated/enums.d.ts +85 -9
- package/include/roblox.d.ts +4 -0
- package/package.json +1 -1
|
@@ -23,6 +23,7 @@ interface Services {
|
|
|
23
23
|
ContentProvider: ContentProvider;
|
|
24
24
|
ContextActionService: ContextActionService;
|
|
25
25
|
ControllerService: ControllerService;
|
|
26
|
+
CSGCacheService: CSGCacheService;
|
|
26
27
|
DataStoreService: DataStoreService;
|
|
27
28
|
Debris: Debris;
|
|
28
29
|
DebuggerConnectionManager: DebuggerConnectionManager;
|
|
@@ -51,11 +52,13 @@ interface Services {
|
|
|
51
52
|
MemoryStoreService: MemoryStoreService;
|
|
52
53
|
MessageBusService: MessageBusService;
|
|
53
54
|
MessagingService: MessagingService;
|
|
55
|
+
NewVoiceChatService: NewVoiceChatService;
|
|
54
56
|
PathfindingService: PathfindingService;
|
|
55
57
|
PhysicsService: PhysicsService;
|
|
56
58
|
Players: Players;
|
|
57
59
|
PluginPolicyService: PluginPolicyService;
|
|
58
60
|
PolicyService: PolicyService;
|
|
61
|
+
ProcessInstancePhysicsService: ProcessInstancePhysicsService;
|
|
59
62
|
ProximityPromptService: ProximityPromptService;
|
|
60
63
|
PublishService: PublishService;
|
|
61
64
|
RemoteDebuggerServer: RemoteDebuggerServer;
|
|
@@ -139,6 +142,7 @@ interface CreatableInstances {
|
|
|
139
142
|
ConeHandleAdornment: ConeHandleAdornment;
|
|
140
143
|
Configuration: Configuration;
|
|
141
144
|
CornerWedgePart: CornerWedgePart;
|
|
145
|
+
CurveAnimation: CurveAnimation;
|
|
142
146
|
CylinderHandleAdornment: CylinderHandleAdornment;
|
|
143
147
|
CylinderMesh: CylinderMesh;
|
|
144
148
|
CylindricalConstraint: CylindricalConstraint;
|
|
@@ -204,6 +208,7 @@ interface CreatableInstances {
|
|
|
204
208
|
Part: Part;
|
|
205
209
|
ParticleEmitter: ParticleEmitter;
|
|
206
210
|
PartOperation: PartOperation;
|
|
211
|
+
PathfindingLink: PathfindingLink;
|
|
207
212
|
PathfindingModifier: PathfindingModifier;
|
|
208
213
|
PitchShiftSoundEffect: PitchShiftSoundEffect;
|
|
209
214
|
PointLight: PointLight;
|
|
@@ -220,6 +225,7 @@ interface CreatableInstances {
|
|
|
220
225
|
Rotate: Rotate;
|
|
221
226
|
RotateP: RotateP;
|
|
222
227
|
RotateV: RotateV;
|
|
228
|
+
RotationCurve: RotationCurve;
|
|
223
229
|
ScreenGui: ScreenGui;
|
|
224
230
|
Script: Script;
|
|
225
231
|
ScrollingFrame: ScrollingFrame;
|
|
@@ -348,6 +354,7 @@ interface AbstractInstances {
|
|
|
348
354
|
}
|
|
349
355
|
|
|
350
356
|
interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
357
|
+
AnimationClip: AnimationClip;
|
|
351
358
|
AnimationTrack: AnimationTrack;
|
|
352
359
|
BaseWrap: BaseWrap;
|
|
353
360
|
CatalogPages: CatalogPages;
|
|
@@ -364,6 +371,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
364
371
|
DataStorePages: DataStorePages;
|
|
365
372
|
DataStoreVersionPages: DataStoreVersionPages;
|
|
366
373
|
DebuggerConnection: DebuggerConnection;
|
|
374
|
+
DebuggerLuaResponse: DebuggerLuaResponse;
|
|
367
375
|
DebuggerVariable: DebuggerVariable;
|
|
368
376
|
EmotesPages: EmotesPages;
|
|
369
377
|
FriendPages: FriendPages;
|
|
@@ -397,9 +405,6 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
397
405
|
PlayerScripts: PlayerScripts;
|
|
398
406
|
PluginManagerInterface: PluginManagerInterface;
|
|
399
407
|
PoseBase: PoseBase;
|
|
400
|
-
ScriptRef: ScriptRef;
|
|
401
|
-
ScriptRefId: ScriptRefId;
|
|
402
|
-
ScriptRefPath: ScriptRefPath;
|
|
403
408
|
StackFrame: StackFrame;
|
|
404
409
|
StandardPages: StandardPages;
|
|
405
410
|
StarterCharacterScripts: StarterCharacterScripts;
|
|
@@ -1397,6 +1402,98 @@ interface Animation extends Instance {
|
|
|
1397
1402
|
AnimationId: string;
|
|
1398
1403
|
}
|
|
1399
1404
|
|
|
1405
|
+
interface AnimationClip extends Instance {
|
|
1406
|
+
/**
|
|
1407
|
+
* **DO NOT USE!**
|
|
1408
|
+
*
|
|
1409
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1410
|
+
* @hidden
|
|
1411
|
+
* @deprecated
|
|
1412
|
+
*/
|
|
1413
|
+
readonly _nominal_AnimationClip: unique symbol;
|
|
1414
|
+
Loop: boolean;
|
|
1415
|
+
Priority: Enum.AnimationPriority;
|
|
1416
|
+
}
|
|
1417
|
+
|
|
1418
|
+
interface CurveAnimation extends AnimationClip {
|
|
1419
|
+
/**
|
|
1420
|
+
* **DO NOT USE!**
|
|
1421
|
+
*
|
|
1422
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1423
|
+
* @hidden
|
|
1424
|
+
* @deprecated
|
|
1425
|
+
*/
|
|
1426
|
+
readonly _nominal_CurveAnimation: unique symbol;
|
|
1427
|
+
}
|
|
1428
|
+
|
|
1429
|
+
/** This object stores all the [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)s for an animation, determines if the animation is looped, and determines its priority against other animations.
|
|
1430
|
+
*
|
|
1431
|
+
* What is a Keyframe Sequence?
|
|
1432
|
+
* ----------------------------
|
|
1433
|
+
*
|
|
1434
|
+
* The animation data Roblox uses in the playback of an animation, referenced by the [Animation.AnimationId](https://developer.roblox.com/en-us/api-reference/property/Animation/AnimationId) property, is constructed from a KeyframeSequence. Every animation has a KeyframeSequence associated with it. KeyframeSequences are usually created by the Roblox Animation Editor but can be created through other plugins or even manually. Once uploaded to Roblox, their Content ID is used for the [Animation.AnimationId](https://developer.roblox.com/en-us/api-reference/property/Animation/AnimationId) property.
|
|
1435
|
+
*
|
|
1436
|
+
* Note, in most cases developers do not need to manipulate KeyframeSequences as the animation editor covers most animation functionality. However, in some cases a developer may wish to generate an animation from a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) or build their own plugin.
|
|
1437
|
+
*
|
|
1438
|
+
* KeyframeSequence Properties
|
|
1439
|
+
* ---------------------------
|
|
1440
|
+
*
|
|
1441
|
+
* The priority and looped animation settings are set by `KeyframeSequence/Priority` and `KeyframeSequence/Loop`. Note these can be eventually overwritten by the [AnimationTrack](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack) properties.
|
|
1442
|
+
*
|
|
1443
|
+
* The length of an animation is determined by the last [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) in the sequence, meaning the [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) with the highest [Keyframe.Time](https://developer.roblox.com/en-us/api-reference/property/Keyframe/Time) property.
|
|
1444
|
+
*
|
|
1445
|
+
* KeyframeSequence Structure
|
|
1446
|
+
* --------------------------
|
|
1447
|
+
*
|
|
1448
|
+
* KeyframeSequences are a container that hold [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)s. Keyframes represent a 'key' frame in the animation, that are interpolated between during playback.
|
|
1449
|
+
*
|
|
1450
|
+
* Keyframes contain [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose)s. [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose)s are specific to each [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) being animated and contain the `CFrame` applied to the [Motor6D](https://developer.roblox.com/en-us/api-reference/class/Motor6D) connecting to the part. Poses are named according to the [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) they correspond with. For this reason, animations require distinct part names to play correctly.
|
|
1451
|
+
*
|
|
1452
|
+
* Poses are structured based on joint hierarchy. Each [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose) is parented to the [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose) corresponding to the part it is attached to. In practice, this means the poses branch out from the root part. See below for a visual example.
|
|
1453
|
+
*
|
|
1454
|
+
* 
|
|
1455
|
+
*
|
|
1456
|
+
* Using KeyframeSequences when making animations
|
|
1457
|
+
* ----------------------------------------------
|
|
1458
|
+
*
|
|
1459
|
+
* KeyframeSequences must be first uploaded to Roblox before they can be played. This can be done by right clicking on the KeyframeSequence and clicking 'Save to Roblox'. Alternatively, [Plugin:SaveSelectedToRoblox](https://developer.roblox.com/en-us/api-reference/function/Plugin/SaveSelectedToRoblox) can be used. This will bring up the animation upload window.
|
|
1460
|
+
*
|
|
1461
|
+
* In some cases, a developer may want to preview an Animation before uploading it to the Roblox site. This can be achieved by generating a temporary id using [KeyframeSequenceProvider:RegisterKeyframeSequence](https://developer.roblox.com/en-us/api-reference/function/KeyframeSequenceProvider/RegisterKeyframeSequence). This will generate a hash id that can be used for localized animation testing.
|
|
1462
|
+
*
|
|
1463
|
+
* Obtaining KeyframeSequences
|
|
1464
|
+
* ---------------------------
|
|
1465
|
+
*
|
|
1466
|
+
* In some cases the developer may wish to download the KeyframeSequence corresponding to an existing uploaded Animation. This can be done so using [KeyframeSequenceProvider:GetKeyframeSequenceAsync](https://developer.roblox.com/en-us/api-reference/function/KeyframeSequenceProvider/GetKeyframeSequenceAsync).
|
|
1467
|
+
*/
|
|
1468
|
+
interface KeyframeSequence extends Instance {
|
|
1469
|
+
/**
|
|
1470
|
+
* **DO NOT USE!**
|
|
1471
|
+
*
|
|
1472
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1473
|
+
* @hidden
|
|
1474
|
+
* @deprecated
|
|
1475
|
+
*/
|
|
1476
|
+
readonly _nominal_KeyframeSequence: unique symbol;
|
|
1477
|
+
/**
|
|
1478
|
+
* This function adds a [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) to the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) by parenting it to the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence). It is functionally identical to setting the [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)'s [Instance.Parent](https://developer.roblox.com/en-us/api-reference/property/Instance/Parent) to the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence).
|
|
1479
|
+
*
|
|
1480
|
+
* Note, this function will not error when an instance other than a [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) is given as the keyframe parameter and will parent it successfully.
|
|
1481
|
+
*/
|
|
1482
|
+
AddKeyframe(this: KeyframeSequence, keyframe: Keyframe): void;
|
|
1483
|
+
/**
|
|
1484
|
+
* **GetKeyframes** returns an array that contains all [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)s that have been added to a [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence).
|
|
1485
|
+
*/
|
|
1486
|
+
GetKeyframes(this: KeyframeSequence): Array<Keyframe>;
|
|
1487
|
+
/**
|
|
1488
|
+
* This function removes a [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) from the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) by setting its parent to nil. It is functionally identical to setting the keyframe's parent to nil
|
|
1489
|
+
*
|
|
1490
|
+
* The [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)'s parent is set to nil, but it is not destroyed. This means, provided the keyframe is referenced it can be re-parented later.
|
|
1491
|
+
*
|
|
1492
|
+
* Note, this function will not error when an [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance) other than a [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) is given as the keyframe parameter.
|
|
1493
|
+
*/
|
|
1494
|
+
RemoveKeyframe(this: KeyframeSequence, keyframe: Keyframe): void;
|
|
1495
|
+
}
|
|
1496
|
+
|
|
1400
1497
|
/** An object which allows animations to be loaded and applied to a character or model in place of a [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) when a Humanoid is not needed. Creates an [Animator](https://developer.roblox.com/en-us/api-reference/class/Animator) and loads animations to update [Motor6Ds](https://developer.roblox.com/en-us/api-reference/class/Motor6D) of said character to react in the way that is described within the animation asset referenced by an [Animation](https://developer.roblox.com/en-us/api-reference/class/Animation) object.
|
|
1401
1498
|
*
|
|
1402
1499
|
* Should I load an Animation on the client or server?
|
|
@@ -3940,6 +4037,7 @@ interface Beam extends Instance {
|
|
|
3940
4037
|
* For more information how a [Beam](https://developer.roblox.com/en-us/api-reference/class/Beam) curves, see [Beam.CurveSize1](https://developer.roblox.com/en-us/api-reference/property/Beam/CurveSize1).
|
|
3941
4038
|
*/
|
|
3942
4039
|
Attachment1: Attachment | undefined;
|
|
4040
|
+
Brightness: number;
|
|
3943
4041
|
/**
|
|
3944
4042
|
* Determines the color of the [Beam](https://developer.roblox.com/en-us/api-reference/class/Beam).
|
|
3945
4043
|
*
|
|
@@ -4828,6 +4926,17 @@ interface BulkImportService extends Instance {
|
|
|
4828
4926
|
readonly _nominal_BulkImportService: unique symbol;
|
|
4829
4927
|
}
|
|
4830
4928
|
|
|
4929
|
+
interface CSGCacheService extends Instance {
|
|
4930
|
+
/**
|
|
4931
|
+
* **DO NOT USE!**
|
|
4932
|
+
*
|
|
4933
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
4934
|
+
* @hidden
|
|
4935
|
+
* @deprecated
|
|
4936
|
+
*/
|
|
4937
|
+
readonly _nominal_CSGCacheService: unique symbol;
|
|
4938
|
+
}
|
|
4939
|
+
|
|
4831
4940
|
interface CalloutService extends Instance {
|
|
4832
4941
|
/**
|
|
4833
4942
|
* **DO NOT USE!**
|
|
@@ -8392,6 +8501,17 @@ interface DebuggerConnectionManager extends Instance {
|
|
|
8392
8501
|
readonly _nominal_DebuggerConnectionManager: unique symbol;
|
|
8393
8502
|
}
|
|
8394
8503
|
|
|
8504
|
+
interface DebuggerLuaResponse extends Instance {
|
|
8505
|
+
/**
|
|
8506
|
+
* **DO NOT USE!**
|
|
8507
|
+
*
|
|
8508
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
8509
|
+
* @hidden
|
|
8510
|
+
* @deprecated
|
|
8511
|
+
*/
|
|
8512
|
+
readonly _nominal_DebuggerLuaResponse: unique symbol;
|
|
8513
|
+
}
|
|
8514
|
+
|
|
8395
8515
|
interface DebuggerVariable extends Instance {
|
|
8396
8516
|
/**
|
|
8397
8517
|
* **DO NOT USE!**
|
|
@@ -8648,6 +8768,7 @@ interface DraggerService extends Instance {
|
|
|
8648
8768
|
ShowPivotIndicator: boolean;
|
|
8649
8769
|
}
|
|
8650
8770
|
|
|
8771
|
+
/** A EulerRotation Curve represents a 3D rotation curve, it groups 3 [FloatCurves](https://developer.roblox.com/en-us/api-reference/class/FloatCurve), stored as 3 [FloatCurve](https://developer.roblox.com/en-us/api-reference/class/FloatCurve) children instances. The rotation is decomposed in 3 Euler angles channels that can be accessed via [EulerRotationCurve:X](https://developer.roblox.com/en-us/api-reference/function/EulerRotationCurve/X), [EulerRotationCurve:Y](https://developer.roblox.com/en-us/api-reference/function/EulerRotationCurve/Y), [EulerRotationCurve:Z](https://developer.roblox.com/en-us/api-reference/function/EulerRotationCurve/Z) methods. The 3 axes can be sampled simultaneously via the method [EulerRotationCurve:GetAnglesAtTime](https://developer.roblox.com/en-us/api-reference/function/EulerRotationCurve/GetAnglesAtTime) returning the 3 Euler angles as a Vector3. Similarly, [EulerRotationCurve:GetRotationAtTime](https://developer.roblox.com/en-us/api-reference/function/EulerRotationCurve/GetRotationAtTime) samples all channels simultaneously but returns a CFrame rotated by X, Y, and Z according to the specified rotation order. */
|
|
8651
8772
|
interface EulerRotationCurve extends Instance {
|
|
8652
8773
|
/**
|
|
8653
8774
|
* **DO NOT USE!**
|
|
@@ -8657,11 +8778,23 @@ interface EulerRotationCurve extends Instance {
|
|
|
8657
8778
|
* @deprecated
|
|
8658
8779
|
*/
|
|
8659
8780
|
readonly _nominal_EulerRotationCurve: unique symbol;
|
|
8781
|
+
/**
|
|
8782
|
+
* Euler angles rotation order
|
|
8783
|
+
*/
|
|
8660
8784
|
RotationOrder: Enum.RotationOrder;
|
|
8661
8785
|
GetAnglesAtTime(this: EulerRotationCurve, time: number): unknown;
|
|
8786
|
+
/**
|
|
8787
|
+
* Samples the [EulerRotationCurve](https://developer.roblox.com/en-us/api-reference/class/EulerRotationCurve) at a given time and returns the corresponding rotation. Empty Euler angles channels are interpreted as zero.
|
|
8788
|
+
*/
|
|
8662
8789
|
GetRotationAtTime(this: EulerRotationCurve, time: number): CFrame;
|
|
8663
8790
|
X(this: EulerRotationCurve): FloatCurve;
|
|
8791
|
+
/**
|
|
8792
|
+
* Returns the [FloatCurve](https://developer.roblox.com/en-us/api-reference/class/FloatCurve) controlling the Y channel. It is the first child instance of type [FloatCurve](https://developer.roblox.com/en-us/api-reference/class/FloatCurve) named 'Y'. If none is found an empty [FloatCurve](https://developer.roblox.com/en-us/api-reference/class/FloatCurve) is created.
|
|
8793
|
+
*/
|
|
8664
8794
|
Y(this: EulerRotationCurve): FloatCurve;
|
|
8795
|
+
/**
|
|
8796
|
+
* Returns the [FloatCurve](https://developer.roblox.com/en-us/api-reference/class/FloatCurve) controlling the Z channel. It is the first child instance of type [FloatCurve](https://developer.roblox.com/en-us/api-reference/class/FloatCurve) named `Z`. If none is found an empty [FloatCurve](https://developer.roblox.com/en-us/api-reference/class/FloatCurve) is created.
|
|
8797
|
+
*/
|
|
8665
8798
|
Z(this: EulerRotationCurve): FloatCurve;
|
|
8666
8799
|
}
|
|
8667
8800
|
|
|
@@ -14927,6 +15060,7 @@ interface ImporterGroupSettings extends ImporterBaseSettings {
|
|
|
14927
15060
|
* @deprecated
|
|
14928
15061
|
*/
|
|
14929
15062
|
readonly _nominal_ImporterGroupSettings: unique symbol;
|
|
15063
|
+
ImportAsModelAsset: boolean;
|
|
14930
15064
|
}
|
|
14931
15065
|
|
|
14932
15066
|
interface ImporterJointSettings extends ImporterBaseSettings {
|
|
@@ -14949,7 +15083,16 @@ interface ImporterMeshSettings extends ImporterBaseSettings {
|
|
|
14949
15083
|
* @deprecated
|
|
14950
15084
|
*/
|
|
14951
15085
|
readonly _nominal_ImporterMeshSettings: unique symbol;
|
|
15086
|
+
/**
|
|
15087
|
+
* Tags: ReadOnly, NotReplicated
|
|
15088
|
+
*/
|
|
15089
|
+
readonly Dimensions: Vector3;
|
|
14952
15090
|
DoubleSided: boolean;
|
|
15091
|
+
IgnoreVertexColors: boolean;
|
|
15092
|
+
/**
|
|
15093
|
+
* Tags: ReadOnly, NotReplicated
|
|
15094
|
+
*/
|
|
15095
|
+
readonly PolygonCount: number;
|
|
14953
15096
|
}
|
|
14954
15097
|
|
|
14955
15098
|
interface ImporterRootSettings extends ImporterBaseSettings {
|
|
@@ -14965,6 +15108,7 @@ interface ImporterRootSettings extends ImporterBaseSettings {
|
|
|
14965
15108
|
* Tags: ReadOnly, NotReplicated
|
|
14966
15109
|
*/
|
|
14967
15110
|
readonly FileDimensions: Vector3;
|
|
15111
|
+
ImportAsModelAsset: boolean;
|
|
14968
15112
|
InvertNegativeFaces: boolean;
|
|
14969
15113
|
MergeMeshes: boolean;
|
|
14970
15114
|
/**
|
|
@@ -17384,86 +17528,6 @@ interface KeyframeMarker extends Instance {
|
|
|
17384
17528
|
Value: string;
|
|
17385
17529
|
}
|
|
17386
17530
|
|
|
17387
|
-
/** This object stores all the [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)s for an animation, determines if the animation is looped, and determines its priority against other animations.
|
|
17388
|
-
*
|
|
17389
|
-
* What is a Keyframe Sequence?
|
|
17390
|
-
* ----------------------------
|
|
17391
|
-
*
|
|
17392
|
-
* The animation data Roblox uses in the playback of an animation, referenced by the [Animation.AnimationId](https://developer.roblox.com/en-us/api-reference/property/Animation/AnimationId) property, is constructed from a KeyframeSequence. Every animation has a KeyframeSequence associated with it. KeyframeSequences are usually created by the Roblox Animation Editor but can be created through other plugins or even manually. Once uploaded to Roblox, their Content ID is used for the [Animation.AnimationId](https://developer.roblox.com/en-us/api-reference/property/Animation/AnimationId) property.
|
|
17393
|
-
*
|
|
17394
|
-
* Note, in most cases developers do not need to manipulate KeyframeSequences as the animation editor covers most animation functionality. However, in some cases a developer may wish to generate an animation from a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) or build their own plugin.
|
|
17395
|
-
*
|
|
17396
|
-
* KeyframeSequence Properties
|
|
17397
|
-
* ---------------------------
|
|
17398
|
-
*
|
|
17399
|
-
* The priority and looped animation settings are set by [KeyframeSequence.Priority](https://developer.roblox.com/en-us/api-reference/property/KeyframeSequence/Priority) and [KeyframeSequence.Loop](https://developer.roblox.com/en-us/api-reference/property/KeyframeSequence/Loop). Note these can be eventually overwritten by the [AnimationTrack](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack) properties.
|
|
17400
|
-
*
|
|
17401
|
-
* The length of an animation is determined by the last [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) in the sequence, meaning the [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) with the highest [Keyframe.Time](https://developer.roblox.com/en-us/api-reference/property/Keyframe/Time) property.
|
|
17402
|
-
*
|
|
17403
|
-
* KeyframeSequence Structure
|
|
17404
|
-
* --------------------------
|
|
17405
|
-
*
|
|
17406
|
-
* KeyframeSequences are a container that hold [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)s. Keyframes represent a 'key' frame in the animation, that are interpolated between during playback.
|
|
17407
|
-
*
|
|
17408
|
-
* Keyframes contain [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose)s. [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose)s are specific to each [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) being animated and contain the `CFrame` applied to the [Motor6D](https://developer.roblox.com/en-us/api-reference/class/Motor6D) connecting to the part. Poses are named according to the [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) they correspond with. For this reason, animations require distinct part names to play correctly.
|
|
17409
|
-
*
|
|
17410
|
-
* Poses are structured based on joint hierarchy. Each [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose) is parented to the [Pose](https://developer.roblox.com/en-us/api-reference/class/Pose) corresponding to the part it is attached to. In practice, this means the poses branch out from the root part. See below for a visual example.
|
|
17411
|
-
*
|
|
17412
|
-
* 
|
|
17413
|
-
*
|
|
17414
|
-
* Using KeyframeSequences when making animations
|
|
17415
|
-
* ----------------------------------------------
|
|
17416
|
-
*
|
|
17417
|
-
* KeyframeSequences must be first uploaded to Roblox before they can be played. This can be done by right clicking on the KeyframeSequence and clicking 'Save to Roblox'. Alternatively, [Plugin:SaveSelectedToRoblox](https://developer.roblox.com/en-us/api-reference/function/Plugin/SaveSelectedToRoblox) can be used. This will bring up the animation upload window.
|
|
17418
|
-
*
|
|
17419
|
-
* In some cases, a developer may want to preview an Animation before uploading it to the Roblox site. This can be achieved by generating a temporary id using [KeyframeSequenceProvider:RegisterKeyframeSequence](https://developer.roblox.com/en-us/api-reference/function/KeyframeSequenceProvider/RegisterKeyframeSequence). This will generate a hash id that can be used for localized animation testing.
|
|
17420
|
-
*
|
|
17421
|
-
* Obtaining KeyframeSequences
|
|
17422
|
-
* ---------------------------
|
|
17423
|
-
*
|
|
17424
|
-
* In some cases the developer may wish to download the KeyframeSequence corresponding to an existing uploaded Animation. This can be done so using [KeyframeSequenceProvider:GetKeyframeSequenceAsync](https://developer.roblox.com/en-us/api-reference/function/KeyframeSequenceProvider/GetKeyframeSequenceAsync).
|
|
17425
|
-
*/
|
|
17426
|
-
interface KeyframeSequence extends Instance {
|
|
17427
|
-
/**
|
|
17428
|
-
* **DO NOT USE!**
|
|
17429
|
-
*
|
|
17430
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
17431
|
-
* @hidden
|
|
17432
|
-
* @deprecated
|
|
17433
|
-
*/
|
|
17434
|
-
readonly _nominal_KeyframeSequence: unique symbol;
|
|
17435
|
-
/**
|
|
17436
|
-
* Determines whether the animation created from the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) will be looped. When set to true the animation will continuously repeat each time the animation finishes.
|
|
17437
|
-
*
|
|
17438
|
-
* When an [AnimationTrack](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack) has been created from an [Animation](https://developer.roblox.com/en-us/api-reference/class/Animation), its [AnimationTrack.Looped](https://developer.roblox.com/en-us/api-reference/property/AnimationTrack/Looped) property will default to the original [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) value. Note this value can be overwritten.
|
|
17439
|
-
*/
|
|
17440
|
-
Loop: boolean;
|
|
17441
|
-
/**
|
|
17442
|
-
* Determines the default priority of an animation created from the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence). Depending on what this is set to, playing multiple animations at once will look to this property to figure out which [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) `Poses` should be played over one another.
|
|
17443
|
-
*
|
|
17444
|
-
* When an [AnimationTrack](https://developer.roblox.com/en-us/api-reference/class/AnimationTrack) has been created from an [Animation](https://developer.roblox.com/en-us/api-reference/class/Animation), its [AnimationTrack.Priority](https://developer.roblox.com/en-us/api-reference/property/AnimationTrack/Priority) property will default to the original [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) value. Note this value can be overwritten.
|
|
17445
|
-
*/
|
|
17446
|
-
Priority: Enum.AnimationPriority;
|
|
17447
|
-
/**
|
|
17448
|
-
* This function adds a [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) to the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) by parenting it to the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence). It is functionally identical to setting the [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)'s [Instance.Parent](https://developer.roblox.com/en-us/api-reference/property/Instance/Parent) to the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence).
|
|
17449
|
-
*
|
|
17450
|
-
* Note, this function will not error when an instance other than a [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) is given as the keyframe parameter and will parent it successfully.
|
|
17451
|
-
*/
|
|
17452
|
-
AddKeyframe(this: KeyframeSequence, keyframe: Keyframe): void;
|
|
17453
|
-
/**
|
|
17454
|
-
* **GetKeyframes** returns an array that contains all [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)s that have been added to a [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence).
|
|
17455
|
-
*/
|
|
17456
|
-
GetKeyframes(this: KeyframeSequence): Array<Keyframe>;
|
|
17457
|
-
/**
|
|
17458
|
-
* This function removes a [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) from the [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence) by setting its parent to nil. It is functionally identical to setting the keyframe's parent to nil
|
|
17459
|
-
*
|
|
17460
|
-
* The [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe)'s parent is set to nil, but it is not destroyed. This means, provided the keyframe is referenced it can be re-parented later.
|
|
17461
|
-
*
|
|
17462
|
-
* Note, this function will not error when an [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance) other than a [Keyframe](https://developer.roblox.com/en-us/api-reference/class/Keyframe) is given as the keyframe parameter.
|
|
17463
|
-
*/
|
|
17464
|
-
RemoveKeyframe(this: KeyframeSequence, keyframe: Keyframe): void;
|
|
17465
|
-
}
|
|
17466
|
-
|
|
17467
17531
|
/** The KeyframeSequenceProvider is a service that is used to load and preview [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence)s. It includes a number of functions that are useful when working with [Animation](https://developer.roblox.com/en-us/api-reference/class/Animation)s.
|
|
17468
17532
|
*
|
|
17469
17533
|
* What is a KeyframeSequence?
|
|
@@ -20649,6 +20713,17 @@ interface NetworkMarker extends Instance {
|
|
|
20649
20713
|
readonly Received: RBXScriptSignal<() => void>;
|
|
20650
20714
|
}
|
|
20651
20715
|
|
|
20716
|
+
interface NewVoiceChatService extends Instance {
|
|
20717
|
+
/**
|
|
20718
|
+
* **DO NOT USE!**
|
|
20719
|
+
*
|
|
20720
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
20721
|
+
* @hidden
|
|
20722
|
+
* @deprecated
|
|
20723
|
+
*/
|
|
20724
|
+
readonly _nominal_NewVoiceChatService: unique symbol;
|
|
20725
|
+
}
|
|
20726
|
+
|
|
20652
20727
|
/** The NoCollisionConstraint is an instance used to prevent collisions between two specific parts. Connected [Parts](https://developer.roblox.com/en-us/api-reference/class/BasePart) will have no collision reaction between them, but can still have collisions with the rest of the world. Both parts can still receive touch events.
|
|
20653
20728
|
*
|
|
20654
20729
|
* Using a NoCollisionConstraint will allow you to create and share [Models](https://developer.roblox.com/en-us/api-reference/class/Model) with customized collision filtering. While you can still achieve collision filtering with [Collision Groups](https://developer.roblox.com/articles/Collision-Filtering), you are unable to export that information to a model without adding a script to set them when the game runs.
|
|
@@ -23544,6 +23619,7 @@ interface ParticleEmitter extends Instance {
|
|
|
23544
23619
|
* Acceleration is most often used to apply a gravity effect to particles (try a value of (0, -3, 0) for this). You can also use small values on the X/Z axes to make it look like particles are being blown away by wind. If you emit a bubble particle downwards, you could use an acceleration of (0, 5, 0) to cause the bubbles to decelerate and then float back upwards.
|
|
23545
23620
|
*/
|
|
23546
23621
|
Acceleration: Vector3;
|
|
23622
|
+
Brightness: number;
|
|
23547
23623
|
/**
|
|
23548
23624
|
* The Color property determines the color of all particles active in an emitter's system. The color is applied to the [ParticleEmitter.Texture](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Texture) when rendering, and uses the texture alpha along with the [ParticleEmitter.Transparency](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Transparency). If a particle has a [ParticleEmitter.LightEmission](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/LightEmission) of greater than 0, darker colors will make particles appear more transparent. Below, two default [ParticleEmitter](https://developer.roblox.com/en-us/api-reference/class/ParticleEmitter) are pictured, except the right emitter uses a Color from yellow to cyan.
|
|
23549
23625
|
*
|
|
@@ -23652,6 +23728,10 @@ interface ParticleEmitter extends Instance {
|
|
|
23652
23728
|
* Changes to this value only affect new particles; existing particles will maintain the rotation at which they were originally emitted.
|
|
23653
23729
|
*/
|
|
23654
23730
|
Rotation: NumberRange;
|
|
23731
|
+
Shape: Enum.ParticleEmitterShape;
|
|
23732
|
+
ShapeInOut: Enum.ParticleEmitterShapeInOut;
|
|
23733
|
+
ShapePartial: number;
|
|
23734
|
+
ShapeStyle: Enum.ParticleEmitterShapeStyle;
|
|
23655
23735
|
/**
|
|
23656
23736
|
* The Size property determines the world size in studs of all active particles over their individual lifetimes. This property represents the dimensions of the square [ParticleEmitter.Texture](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Texture) for each particle. It is a [NumberSequence](https://developer.roblox.com/en-us/api-reference/datatype/NumberSequence) that works similar to [ParticleEmitter.Transparency](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Transparency) and [ParticleEmitter.Color](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Color).
|
|
23657
23737
|
*
|
|
@@ -23686,6 +23766,7 @@ interface ParticleEmitter extends Instance {
|
|
|
23686
23766
|
* Setting one axis to 360 will cause particles to emit in all direction in a **circle**. Setting both to 360 will cause particles to emit in all directions in a **sphere**.
|
|
23687
23767
|
*/
|
|
23688
23768
|
SpreadAngle: Vector2;
|
|
23769
|
+
Squash: NumberSequence;
|
|
23689
23770
|
/**
|
|
23690
23771
|
* The Texture property determines the image rendered on particle billboards. The rendered image is influenced by [ParticleEmitter.Color](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Color), [ParticleEmitter.Transparency](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Transparency), [ParticleEmitter.LightInfluence](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/LightInfluence), and [ParticleEmitter.LightEmission](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/LightEmission). Transparent textures work best for particles
|
|
23691
23772
|
*
|
|
@@ -23818,6 +23899,20 @@ interface Path extends Instance {
|
|
|
23818
23899
|
readonly Unblocked: RBXScriptSignal<(unblockedWaypointIdx: number) => void>;
|
|
23819
23900
|
}
|
|
23820
23901
|
|
|
23902
|
+
interface PathfindingLink extends Instance {
|
|
23903
|
+
/**
|
|
23904
|
+
* **DO NOT USE!**
|
|
23905
|
+
*
|
|
23906
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
23907
|
+
* @hidden
|
|
23908
|
+
* @deprecated
|
|
23909
|
+
*/
|
|
23910
|
+
readonly _nominal_PathfindingLink: unique symbol;
|
|
23911
|
+
Attachment0: Attachment | undefined;
|
|
23912
|
+
Attachment1: Attachment | undefined;
|
|
23913
|
+
IsBidirectional: boolean;
|
|
23914
|
+
}
|
|
23915
|
+
|
|
23821
23916
|
/** **Beta Feature** This class is currently a part of the PathfindingModifier beta feature. Eligible developers must enable the feature within Studio and functionality may change.
|
|
23822
23917
|
*
|
|
23823
23918
|
* For a more detailed overview of the [PathfindingService](https://developer.roblox.com/en-us/api-reference/class/PathfindingService) and [PathfindingModifiers](https://developer.roblox.com/en-us/api-reference/class/PathfindingModifier), see the `Articles/Pathfinding|Pathfinding` article.
|
|
@@ -25796,6 +25891,17 @@ interface SunRaysEffect extends PostEffect {
|
|
|
25796
25891
|
Spread: number;
|
|
25797
25892
|
}
|
|
25798
25893
|
|
|
25894
|
+
interface ProcessInstancePhysicsService extends Instance {
|
|
25895
|
+
/**
|
|
25896
|
+
* **DO NOT USE!**
|
|
25897
|
+
*
|
|
25898
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
25899
|
+
* @hidden
|
|
25900
|
+
* @deprecated
|
|
25901
|
+
*/
|
|
25902
|
+
readonly _nominal_ProcessInstancePhysicsService: unique symbol;
|
|
25903
|
+
}
|
|
25904
|
+
|
|
25799
25905
|
/** The ProximityPrompt is an object that allows developers to prompt users to interact with an object in the 3D world, such as opening a door or picking up an item.
|
|
25800
25906
|
*
|
|
25801
25907
|
* ProximityPrompts work when parented to a [Part](https://developer.roblox.com/en-us/api-reference/class/Part), [Model](https://developer.roblox.com/en-us/api-reference/class/Model), or [Attachment](https://developer.roblox.com/en-us/api-reference/class/Attachment) in the workspace.
|
|
@@ -26225,6 +26331,28 @@ interface ReplicatedStorage extends Instance {
|
|
|
26225
26331
|
readonly _nominal_ReplicatedStorage: unique symbol;
|
|
26226
26332
|
}
|
|
26227
26333
|
|
|
26334
|
+
interface RotationCurve extends Instance {
|
|
26335
|
+
/**
|
|
26336
|
+
* **DO NOT USE!**
|
|
26337
|
+
*
|
|
26338
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26339
|
+
* @hidden
|
|
26340
|
+
* @deprecated
|
|
26341
|
+
*/
|
|
26342
|
+
readonly _nominal_RotationCurve: unique symbol;
|
|
26343
|
+
/**
|
|
26344
|
+
* Tags: ReadOnly, NotReplicated
|
|
26345
|
+
*/
|
|
26346
|
+
readonly Length: number;
|
|
26347
|
+
GetKeyAtIndex(this: RotationCurve, index: number): RotationCurveKey;
|
|
26348
|
+
GetKeyIndicesAtTime(this: RotationCurve, time: number): unknown;
|
|
26349
|
+
GetKeys(this: RotationCurve): unknown;
|
|
26350
|
+
GetValueAtTime(this: RotationCurve, time: number): CoordinateFrame?;
|
|
26351
|
+
InsertKey(this: RotationCurve, key: RotationCurveKey): unknown;
|
|
26352
|
+
RemoveKeyAtIndex(this: RotationCurve, startingIndex: number, count?: number): number;
|
|
26353
|
+
SetKeys(this: RotationCurve, keys: Array<any>): number;
|
|
26354
|
+
}
|
|
26355
|
+
|
|
26228
26356
|
/** **RunService** contains methods and events for time-management as well as for managing the context in which a game or script is running. Methods like [IsClient](https://developer.roblox.com/en-us/api-reference/function/RunService/IsClient), [IsServer](https://developer.roblox.com/en-us/api-reference/function/RunService/IsServer), [IsStudio](https://developer.roblox.com/en-us/api-reference/function/RunService/IsStudio), can help you determine under what context code is running. These methods are useful for ModuleScripts that may be required by both client and server scripts. Furthermore, [IsStudio](https://developer.roblox.com/en-us/api-reference/function/RunService/IsStudio) can be used to add special behaviors for in-studio testing.
|
|
26229
26357
|
*
|
|
26230
26358
|
* RunService also houses events that allow your code to adhere to Roblox's frame-by-frame loop, such as [Stepped](https://developer.roblox.com/en-us/api-reference/event/RunService/Stepped), [Heartbeat](https://developer.roblox.com/en-us/api-reference/event/RunService/Heartbeat) and [RenderStepped](https://developer.roblox.com/en-us/api-reference/event/RunService/RenderStepped). Selecting the proper event to use for any case is important, so you should read `articles/Task Scheduler|Task Scheduler` to make an informed decision.
|
|
@@ -26601,39 +26729,6 @@ interface ScriptContext extends Instance {
|
|
|
26601
26729
|
readonly Error: RBXScriptSignal<(message: string, stackTrace: string, script?: LuaSourceContainer) => void>;
|
|
26602
26730
|
}
|
|
26603
26731
|
|
|
26604
|
-
interface ScriptRef extends Instance {
|
|
26605
|
-
/**
|
|
26606
|
-
* **DO NOT USE!**
|
|
26607
|
-
*
|
|
26608
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26609
|
-
* @hidden
|
|
26610
|
-
* @deprecated
|
|
26611
|
-
*/
|
|
26612
|
-
readonly _nominal_ScriptRef: unique symbol;
|
|
26613
|
-
}
|
|
26614
|
-
|
|
26615
|
-
interface ScriptRefId extends ScriptRef {
|
|
26616
|
-
/**
|
|
26617
|
-
* **DO NOT USE!**
|
|
26618
|
-
*
|
|
26619
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26620
|
-
* @hidden
|
|
26621
|
-
* @deprecated
|
|
26622
|
-
*/
|
|
26623
|
-
readonly _nominal_ScriptRefId: unique symbol;
|
|
26624
|
-
}
|
|
26625
|
-
|
|
26626
|
-
interface ScriptRefPath extends ScriptRef {
|
|
26627
|
-
/**
|
|
26628
|
-
* **DO NOT USE!**
|
|
26629
|
-
*
|
|
26630
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26631
|
-
* @hidden
|
|
26632
|
-
* @deprecated
|
|
26633
|
-
*/
|
|
26634
|
-
readonly _nominal_ScriptRefPath: unique symbol;
|
|
26635
|
-
}
|
|
26636
|
-
|
|
26637
26732
|
/** **ServerScriptService** is a container service for [Script](https://developer.roblox.com/en-us/api-reference/class/Script), [ModuleScript](https://developer.roblox.com/en-us/api-reference/class/ModuleScript) and other scripting-related assets that are only meant for server use. The contents are never replicated to player clients at all, which allows for a secure storage of important game logic. Script objects will run if they are within this service and not [Disabled](https://developer.roblox.com/en-us/api-reference/property/BaseScript/Disabled).
|
|
26638
26733
|
*
|
|
26639
26734
|
* This service houses just one property, [LoadStringEnabled](https://developer.roblox.com/en-us/api-reference/property/ServerScriptService/LoadStringEnabled), which determines whether the `loadstring` function in Lua is enabled. It's recommended to keep this disabled for security reasons, as misusing this function can lead to remote code execution vulnerabilities.
|
|
@@ -30112,6 +30207,7 @@ interface Trail extends Instance {
|
|
|
30112
30207
|
* Changing the Attachments of a Trail while a trail is drawing will remove all of the segments the trail has already drawn.
|
|
30113
30208
|
*/
|
|
30114
30209
|
Attachment1: Attachment | undefined;
|
|
30210
|
+
Brightness: number;
|
|
30115
30211
|
/**
|
|
30116
30212
|
* The color of a [Trail](https://developer.roblox.com/en-us/api-reference/class/Trail) can be set with the effect's Color property. This property determines what color the segments of the trail will have through their [Trail.Lifetime](https://developer.roblox.com/en-us/api-reference/property/Trail/Lifetime).
|
|
30117
30213
|
*
|
|
@@ -30180,7 +30276,15 @@ interface Trail extends Instance {
|
|
|
30180
30276
|
*/
|
|
30181
30277
|
LightEmission: number;
|
|
30182
30278
|
/**
|
|
30183
|
-
*
|
|
30279
|
+
* **LightInfluence** determines the factor the light in the environment affects the appearance of the Trail. A value of zero (0) ensures no influence which allows a trail to be visible even in complete darkness.
|
|
30280
|
+
*
|
|
30281
|
+
* Changing this property immediately affects all existing and future segments of the trail.
|
|
30282
|
+
*
|
|
30283
|
+
* See also
|
|
30284
|
+
* --------
|
|
30285
|
+
*
|
|
30286
|
+
* * [LightEmission](https://developer.roblox.com/en-us/api-reference/property/Trail/LightEmission), another Trail property related to light
|
|
30287
|
+
* * [Beam.LightEmission](https://developer.roblox.com/en-us/api-reference/property/Beam/LightEmission), an identical property used by [Beam](https://developer.roblox.com/en-us/api-reference/class/Beam)s
|
|
30184
30288
|
*/
|
|
30185
30289
|
LightInfluence: number;
|
|
30186
30290
|
/**
|
|
@@ -31583,20 +31687,15 @@ interface UserInputService extends Instance {
|
|
|
31583
31687
|
*/
|
|
31584
31688
|
readonly KeyboardEnabled: boolean;
|
|
31585
31689
|
/**
|
|
31586
|
-
*
|
|
31690
|
+
* **ModalEnabled** property determines whether character controls are hidden on [TouchEnabled](https://developer.roblox.com/en-us/api-reference/property/UserInputService/TouchEnabled) devices. By default, this property is _false_ and controls are visible.
|
|
31587
31691
|
*
|
|
31588
31692
|
* 
|
|
31589
31693
|
*
|
|
31590
31694
|
* 
|
|
31591
31695
|
*
|
|
31592
|
-
* This property
|
|
31696
|
+
* This property will only work when used in a [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript) running for the player whose character controls are to be hidden.
|
|
31593
31697
|
*
|
|
31594
31698
|
* Even if mobile controls are hidden for a player on a mobile device, other UserInputService events such as [UserInputService.InputBegan](https://developer.roblox.com/en-us/api-reference/event/UserInputService/InputBegan) and [UserInputService.TouchSwipe](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchSwipe) can still be used to process other forms of user input on mobile devices with an enabled touch screen (see the main UserInputService class page for a full list).
|
|
31595
|
-
*
|
|
31596
|
-
* Since [UserInputService](https://developer.roblox.com/en-us/api-reference/class/UserInputService) only runs client-side, this property will only work when used in a [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript).
|
|
31597
|
-
*
|
|
31598
|
-
* ##See Also
|
|
31599
|
-
* The tutorial on disabling parts of the game interface, found [here](https://www.robloxdev.com/articles/Disabling-Parts-of-Game-Interface), provides excellent documentation on using this property.
|
|
31600
31699
|
* Tags: Deprecated
|
|
31601
31700
|
* @deprecated
|
|
31602
31701
|
*/
|
|
@@ -33560,29 +33659,89 @@ interface VoiceChatService extends Instance {
|
|
|
33560
33659
|
*/
|
|
33561
33660
|
readonly _nominal_VoiceChatService: unique symbol;
|
|
33562
33661
|
/**
|
|
33563
|
-
* Tags:
|
|
33662
|
+
* Tags: Deprecated
|
|
33663
|
+
* @deprecated
|
|
33564
33664
|
*/
|
|
33565
|
-
readonly VoiceChatState: Enum.VoiceChatState;
|
|
33566
|
-
GetAndClearCallFailureMessage(this: VoiceChatService): string;
|
|
33567
33665
|
GetAudioProcessingSettings(this: VoiceChatService): unknown;
|
|
33666
|
+
/**
|
|
33667
|
+
* Tags: Deprecated
|
|
33668
|
+
* @deprecated
|
|
33669
|
+
*/
|
|
33568
33670
|
GetMicDevices(this: VoiceChatService): unknown;
|
|
33671
|
+
/**
|
|
33672
|
+
* Tags: Deprecated
|
|
33673
|
+
* @deprecated
|
|
33674
|
+
*/
|
|
33569
33675
|
GetParticipants(this: VoiceChatService): unknown;
|
|
33676
|
+
/**
|
|
33677
|
+
* Tags: Deprecated
|
|
33678
|
+
* @deprecated
|
|
33679
|
+
*/
|
|
33570
33680
|
GetSpeakerDevices(this: VoiceChatService): unknown;
|
|
33681
|
+
/**
|
|
33682
|
+
* Tags: Deprecated
|
|
33683
|
+
* @deprecated
|
|
33684
|
+
*/
|
|
33571
33685
|
GetVoiceChatApiVersion(this: VoiceChatService): number;
|
|
33686
|
+
/**
|
|
33687
|
+
* Tags: Deprecated
|
|
33688
|
+
* @deprecated
|
|
33689
|
+
*/
|
|
33572
33690
|
GetVoiceChatAvailable(this: VoiceChatService): number;
|
|
33691
|
+
/**
|
|
33692
|
+
* Tags: Deprecated
|
|
33693
|
+
* @deprecated
|
|
33694
|
+
*/
|
|
33573
33695
|
IsPublishPaused(this: VoiceChatService): boolean;
|
|
33696
|
+
/**
|
|
33697
|
+
* Tags: Deprecated
|
|
33698
|
+
* @deprecated
|
|
33699
|
+
*/
|
|
33574
33700
|
IsSubscribePaused(this: VoiceChatService, userId: number): boolean;
|
|
33701
|
+
/**
|
|
33702
|
+
* Tags: Deprecated
|
|
33703
|
+
* @deprecated
|
|
33704
|
+
*/
|
|
33575
33705
|
JoinByGroupId(this: VoiceChatService, groupId: string, isMicMuted?: boolean): boolean;
|
|
33706
|
+
/**
|
|
33707
|
+
* Tags: Deprecated
|
|
33708
|
+
* @deprecated
|
|
33709
|
+
*/
|
|
33576
33710
|
JoinByGroupIdToken(this: VoiceChatService, groupId: string, isMicMuted?: boolean): boolean;
|
|
33711
|
+
/**
|
|
33712
|
+
* Tags: Deprecated
|
|
33713
|
+
* @deprecated
|
|
33714
|
+
*/
|
|
33577
33715
|
Leave(this: VoiceChatService): void;
|
|
33716
|
+
/**
|
|
33717
|
+
* Tags: Deprecated
|
|
33718
|
+
* @deprecated
|
|
33719
|
+
*/
|
|
33578
33720
|
PublishPause(this: VoiceChatService, paused: boolean): boolean;
|
|
33721
|
+
/**
|
|
33722
|
+
* Tags: Deprecated
|
|
33723
|
+
* @deprecated
|
|
33724
|
+
*/
|
|
33579
33725
|
SetMicDevice(this: VoiceChatService, micDeviceName: string, micDeviceGuid: string): void;
|
|
33726
|
+
/**
|
|
33727
|
+
* Tags: Deprecated
|
|
33728
|
+
* @deprecated
|
|
33729
|
+
*/
|
|
33580
33730
|
SetSpeakerDevice(this: VoiceChatService, speakerDeviceName: string, speakerDeviceGuid: string): void;
|
|
33731
|
+
/**
|
|
33732
|
+
* Tags: Deprecated
|
|
33733
|
+
* @deprecated
|
|
33734
|
+
*/
|
|
33581
33735
|
SubscribePause(this: VoiceChatService, userId: number, paused: boolean): boolean;
|
|
33736
|
+
/**
|
|
33737
|
+
* Tags: Deprecated
|
|
33738
|
+
* @deprecated
|
|
33739
|
+
*/
|
|
33582
33740
|
SubscribePauseAll(this: VoiceChatService, paused: boolean): boolean;
|
|
33583
|
-
|
|
33584
|
-
|
|
33585
|
-
|
|
33741
|
+
/**
|
|
33742
|
+
* Tags: Yields
|
|
33743
|
+
*/
|
|
33744
|
+
IsVoiceEnabledForUserIdAsync(this: VoiceChatService, userId: number): boolean;
|
|
33586
33745
|
}
|
|
33587
33746
|
|
|
33588
33747
|
interface VoiceSource extends Instance {
|
|
@@ -124,6 +124,22 @@ interface ABTestService extends Instance {
|
|
|
124
124
|
readonly OnUserABTestLoadingStatusChanged: RBXScriptSignal<(status: Enum.ABTestLoadingStatus, userId: number) => void>;
|
|
125
125
|
}
|
|
126
126
|
|
|
127
|
+
interface KeyframeSequence extends Instance {
|
|
128
|
+
/**
|
|
129
|
+
* **DO NOT USE!**
|
|
130
|
+
*
|
|
131
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
132
|
+
* @hidden
|
|
133
|
+
* @deprecated
|
|
134
|
+
*/
|
|
135
|
+
readonly _nominal_KeyframeSequence: unique symbol;
|
|
136
|
+
/**
|
|
137
|
+
* Contains the hip height of the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) of the model that was used to author this [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence). Default value is 1.35 since that is the hip height set for a standard R15 [character](https://developer.roblox.com/en-us/api-reference/class/Character).
|
|
138
|
+
* Tags: Hidden
|
|
139
|
+
*/
|
|
140
|
+
AuthoredHipHeight: number;
|
|
141
|
+
}
|
|
142
|
+
|
|
127
143
|
interface Animator extends Instance {
|
|
128
144
|
/**
|
|
129
145
|
* **DO NOT USE!**
|
|
@@ -863,22 +879,6 @@ interface InsertService extends Instance {
|
|
|
863
879
|
CreateMeshPartAsync(this: InsertService, meshId: string, collisionFidelity: CastsToEnum<Enum.CollisionFidelity>, renderFidelity: CastsToEnum<Enum.RenderFidelity>): MeshPart;
|
|
864
880
|
}
|
|
865
881
|
|
|
866
|
-
interface KeyframeSequence extends Instance {
|
|
867
|
-
/**
|
|
868
|
-
* **DO NOT USE!**
|
|
869
|
-
*
|
|
870
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
871
|
-
* @hidden
|
|
872
|
-
* @deprecated
|
|
873
|
-
*/
|
|
874
|
-
readonly _nominal_KeyframeSequence: unique symbol;
|
|
875
|
-
/**
|
|
876
|
-
* Contains the hip height of the [Humanoid](https://developer.roblox.com/en-us/api-reference/class/Humanoid) of the model that was used to author this [KeyframeSequence](https://developer.roblox.com/en-us/api-reference/class/KeyframeSequence). Default value is 1.35 since that is the hip height set for a standard R15 [character](https://developer.roblox.com/en-us/api-reference/class/Character).
|
|
877
|
-
* Tags: Hidden
|
|
878
|
-
*/
|
|
879
|
-
AuthoredHipHeight: number;
|
|
880
|
-
}
|
|
881
|
-
|
|
882
882
|
interface KeyframeSequenceProvider extends Instance {
|
|
883
883
|
/**
|
|
884
884
|
* **DO NOT USE!**
|
|
@@ -3385,6 +3385,10 @@ interface StudioData extends Instance {
|
|
|
3385
3385
|
* Tags: Hidden
|
|
3386
3386
|
*/
|
|
3387
3387
|
readonly EnableScriptCollabByDefaultOnLoad: boolean;
|
|
3388
|
+
/**
|
|
3389
|
+
* Tags: Hidden
|
|
3390
|
+
*/
|
|
3391
|
+
readonly EnableTeamCreateStreamingOnLoad: boolean;
|
|
3388
3392
|
/**
|
|
3389
3393
|
* Tags: Hidden, NotReplicated
|
|
3390
3394
|
*/
|
|
@@ -5778,14 +5778,6 @@ declare namespace Enum {
|
|
|
5778
5778
|
|
|
5779
5779
|
export const Automatic: Automatic;
|
|
5780
5780
|
|
|
5781
|
-
export interface Direct3D9 {
|
|
5782
|
-
Name: "Direct3D9";
|
|
5783
|
-
Value: 3;
|
|
5784
|
-
EnumType: EnumType<GraphicsMode>;
|
|
5785
|
-
}
|
|
5786
|
-
|
|
5787
|
-
export const Direct3D9: Direct3D9;
|
|
5788
|
-
|
|
5789
5781
|
export interface Direct3D11 {
|
|
5790
5782
|
Name: "Direct3D11";
|
|
5791
5783
|
Value: 2;
|
|
@@ -5828,7 +5820,7 @@ declare namespace Enum {
|
|
|
5828
5820
|
|
|
5829
5821
|
export function GetEnumItems(this: defined): Array<GraphicsMode>
|
|
5830
5822
|
}
|
|
5831
|
-
export type GraphicsMode = GraphicsMode.Automatic | GraphicsMode.
|
|
5823
|
+
export type GraphicsMode = GraphicsMode.Automatic | GraphicsMode.Direct3D11 | GraphicsMode.OpenGL | GraphicsMode.Metal | GraphicsMode.Vulkan | GraphicsMode.NoGraphics;
|
|
5832
5824
|
export namespace HandlesStyle {
|
|
5833
5825
|
export interface Resize {
|
|
5834
5826
|
Name: "Resize";
|
|
@@ -10149,6 +10141,90 @@ declare namespace Enum {
|
|
|
10149
10141
|
export function GetEnumItems(this: defined): Array<PartType>
|
|
10150
10142
|
}
|
|
10151
10143
|
export type PartType = PartType.Ball | PartType.Block | PartType.Cylinder;
|
|
10144
|
+
export namespace ParticleEmitterShape {
|
|
10145
|
+
export interface Box {
|
|
10146
|
+
Name: "Box";
|
|
10147
|
+
Value: 0;
|
|
10148
|
+
EnumType: EnumType<ParticleEmitterShape>;
|
|
10149
|
+
}
|
|
10150
|
+
|
|
10151
|
+
export const Box: Box;
|
|
10152
|
+
|
|
10153
|
+
export interface Sphere {
|
|
10154
|
+
Name: "Sphere";
|
|
10155
|
+
Value: 1;
|
|
10156
|
+
EnumType: EnumType<ParticleEmitterShape>;
|
|
10157
|
+
}
|
|
10158
|
+
|
|
10159
|
+
export const Sphere: Sphere;
|
|
10160
|
+
|
|
10161
|
+
export interface Cylinder {
|
|
10162
|
+
Name: "Cylinder";
|
|
10163
|
+
Value: 2;
|
|
10164
|
+
EnumType: EnumType<ParticleEmitterShape>;
|
|
10165
|
+
}
|
|
10166
|
+
|
|
10167
|
+
export const Cylinder: Cylinder;
|
|
10168
|
+
|
|
10169
|
+
export interface Disc {
|
|
10170
|
+
Name: "Disc";
|
|
10171
|
+
Value: 3;
|
|
10172
|
+
EnumType: EnumType<ParticleEmitterShape>;
|
|
10173
|
+
}
|
|
10174
|
+
|
|
10175
|
+
export const Disc: Disc;
|
|
10176
|
+
|
|
10177
|
+
export function GetEnumItems(this: defined): Array<ParticleEmitterShape>
|
|
10178
|
+
}
|
|
10179
|
+
export type ParticleEmitterShape = ParticleEmitterShape.Box | ParticleEmitterShape.Sphere | ParticleEmitterShape.Cylinder | ParticleEmitterShape.Disc;
|
|
10180
|
+
export namespace ParticleEmitterShapeInOut {
|
|
10181
|
+
export interface Outward {
|
|
10182
|
+
Name: "Outward";
|
|
10183
|
+
Value: 0;
|
|
10184
|
+
EnumType: EnumType<ParticleEmitterShapeInOut>;
|
|
10185
|
+
}
|
|
10186
|
+
|
|
10187
|
+
export const Outward: Outward;
|
|
10188
|
+
|
|
10189
|
+
export interface Inward {
|
|
10190
|
+
Name: "Inward";
|
|
10191
|
+
Value: 1;
|
|
10192
|
+
EnumType: EnumType<ParticleEmitterShapeInOut>;
|
|
10193
|
+
}
|
|
10194
|
+
|
|
10195
|
+
export const Inward: Inward;
|
|
10196
|
+
|
|
10197
|
+
export interface InAndOut {
|
|
10198
|
+
Name: "InAndOut";
|
|
10199
|
+
Value: 2;
|
|
10200
|
+
EnumType: EnumType<ParticleEmitterShapeInOut>;
|
|
10201
|
+
}
|
|
10202
|
+
|
|
10203
|
+
export const InAndOut: InAndOut;
|
|
10204
|
+
|
|
10205
|
+
export function GetEnumItems(this: defined): Array<ParticleEmitterShapeInOut>
|
|
10206
|
+
}
|
|
10207
|
+
export type ParticleEmitterShapeInOut = ParticleEmitterShapeInOut.Outward | ParticleEmitterShapeInOut.Inward | ParticleEmitterShapeInOut.InAndOut;
|
|
10208
|
+
export namespace ParticleEmitterShapeStyle {
|
|
10209
|
+
export interface Volume {
|
|
10210
|
+
Name: "Volume";
|
|
10211
|
+
Value: 0;
|
|
10212
|
+
EnumType: EnumType<ParticleEmitterShapeStyle>;
|
|
10213
|
+
}
|
|
10214
|
+
|
|
10215
|
+
export const Volume: Volume;
|
|
10216
|
+
|
|
10217
|
+
export interface Surface {
|
|
10218
|
+
Name: "Surface";
|
|
10219
|
+
Value: 1;
|
|
10220
|
+
EnumType: EnumType<ParticleEmitterShapeStyle>;
|
|
10221
|
+
}
|
|
10222
|
+
|
|
10223
|
+
export const Surface: Surface;
|
|
10224
|
+
|
|
10225
|
+
export function GetEnumItems(this: defined): Array<ParticleEmitterShapeStyle>
|
|
10226
|
+
}
|
|
10227
|
+
export type ParticleEmitterShapeStyle = ParticleEmitterShapeStyle.Volume | ParticleEmitterShapeStyle.Surface;
|
|
10152
10228
|
export namespace ParticleOrientation {
|
|
10153
10229
|
export interface FacingCamera {
|
|
10154
10230
|
Name: "FacingCamera";
|
package/include/roblox.d.ts
CHANGED
|
@@ -320,6 +320,10 @@ interface AgentParameters {
|
|
|
320
320
|
AgentHeight?: number;
|
|
321
321
|
/** Sets whether off-mesh links for jumping are allowed. */
|
|
322
322
|
AgentCanJump?: boolean;
|
|
323
|
+
/** Determines the spacing between intermediate waypoints in path. */
|
|
324
|
+
WaypointSpacing?: number;
|
|
325
|
+
/** Table of materials or defined PathfindingModifiers and their "cost" for traversal. Useful for making the agent prefer certain materials/regions over others. */
|
|
326
|
+
Costs?: { [K in Enum.Material["Name"]]?: number } & { [index: string]: number };
|
|
323
327
|
}
|
|
324
328
|
|
|
325
329
|
interface CollisionGroupInfo {
|