@rbxts/types 1.0.947 → 1.0.948
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 +1339 -232
- package/include/generated/PluginSecurity.d.ts +137 -480
- package/include/generated/enums.d.ts +769 -118
- package/package.json +1 -1
|
@@ -35,6 +35,7 @@ interface Services {
|
|
|
35
35
|
BugReporterService: BugReporterService;
|
|
36
36
|
BulkImportService: BulkImportService;
|
|
37
37
|
CacheableContentProvider: CacheableContentProvider;
|
|
38
|
+
CallingService: CallingService;
|
|
38
39
|
CalloutService: CalloutService;
|
|
39
40
|
CaptureService: CaptureService;
|
|
40
41
|
ChangeHistoryStreamingService: ChangeHistoryStreamingService;
|
|
@@ -269,6 +270,7 @@ interface Services {
|
|
|
269
270
|
WebViewService: WebViewService;
|
|
270
271
|
WindowProtocolService: WindowProtocolService;
|
|
271
272
|
Workspace: Workspace;
|
|
273
|
+
WrapContentProvider: WrapContentProvider;
|
|
272
274
|
WrapDeformMeshProvider: WrapDeformMeshProvider;
|
|
273
275
|
}
|
|
274
276
|
interface CreatableInstances {
|
|
@@ -369,6 +371,7 @@ interface CreatableInstances {
|
|
|
369
371
|
Configuration: Configuration;
|
|
370
372
|
ControllerManager: ControllerManager;
|
|
371
373
|
ControllerPartSensor: ControllerPartSensor;
|
|
374
|
+
ControlState: ControlState;
|
|
372
375
|
CornerWedgePart: CornerWedgePart;
|
|
373
376
|
CurveAnimation: CurveAnimation;
|
|
374
377
|
CustomLog: CustomLog;
|
|
@@ -468,7 +471,6 @@ interface CreatableInstances {
|
|
|
468
471
|
PitchShiftSoundEffect: PitchShiftSoundEffect;
|
|
469
472
|
Plane: Plane;
|
|
470
473
|
PlaneConstraint: PlaneConstraint;
|
|
471
|
-
PlayerControlState: PlayerControlState;
|
|
472
474
|
PluginCapabilities: PluginCapabilities;
|
|
473
475
|
PointLight: PointLight;
|
|
474
476
|
Pose: Pose;
|
|
@@ -888,6 +890,8 @@ interface Capture extends RBXObject {
|
|
|
888
890
|
*/
|
|
889
891
|
readonly _nominal_Capture: unique symbol;
|
|
890
892
|
/**
|
|
893
|
+
* The date and time at which the capture was taken.
|
|
894
|
+
*
|
|
891
895
|
* - **ThreadSafety**: ReadSafe
|
|
892
896
|
* - **Tags**: NotReplicated
|
|
893
897
|
*
|
|
@@ -895,6 +899,8 @@ interface Capture extends RBXObject {
|
|
|
895
899
|
*/
|
|
896
900
|
readonly CaptureTime: DateTime;
|
|
897
901
|
/**
|
|
902
|
+
* Indicates whether the capture is a screenshot or a video.
|
|
903
|
+
*
|
|
898
904
|
* - **ThreadSafety**: ReadSafe
|
|
899
905
|
* - **Tags**: NotReplicated
|
|
900
906
|
*
|
|
@@ -902,6 +908,8 @@ interface Capture extends RBXObject {
|
|
|
902
908
|
*/
|
|
903
909
|
readonly CaptureType: Enum.CaptureType;
|
|
904
910
|
/**
|
|
911
|
+
* A temporary local identifier for the capture's stored file.
|
|
912
|
+
*
|
|
905
913
|
* - **ThreadSafety**: ReadSafe
|
|
906
914
|
* - **Tags**: NotReplicated
|
|
907
915
|
*
|
|
@@ -909,6 +917,8 @@ interface Capture extends RBXObject {
|
|
|
909
917
|
*/
|
|
910
918
|
readonly LocalId: string;
|
|
911
919
|
/**
|
|
920
|
+
* The ID of the place in which the capture was taken.
|
|
921
|
+
*
|
|
912
922
|
* - **ThreadSafety**: ReadSafe
|
|
913
923
|
* - **Tags**: NotReplicated
|
|
914
924
|
*
|
|
@@ -916,6 +926,8 @@ interface Capture extends RBXObject {
|
|
|
916
926
|
*/
|
|
917
927
|
readonly SourcePlaceId: number;
|
|
918
928
|
/**
|
|
929
|
+
* The ID of the experience in which the capture was taken.
|
|
930
|
+
*
|
|
919
931
|
* - **ThreadSafety**: ReadSafe
|
|
920
932
|
* - **Tags**: NotReplicated
|
|
921
933
|
*
|
|
@@ -3111,7 +3123,7 @@ interface AdService extends Instance {
|
|
|
3111
3123
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#CreateAdRewardFromDevProductId)
|
|
3112
3124
|
* @param this The service responsible for in-experience advertising.
|
|
3113
3125
|
* @param devProductId The ID of the developer product you want to grant as a reward.
|
|
3114
|
-
* @returns An `AdReward` configured as a developer
|
|
3126
|
+
* @returns An `AdReward` configured as a developer product reward for the specified product.
|
|
3115
3127
|
*/
|
|
3116
3128
|
CreateAdRewardFromDevProductId(this: AdService, devProductId: number): AdReward;
|
|
3117
3129
|
/**
|
|
@@ -3152,7 +3164,7 @@ interface AdService extends Instance {
|
|
|
3152
3164
|
*
|
|
3153
3165
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#UnregisterAdOpportunity)
|
|
3154
3166
|
* @param this The service responsible for in-experience advertising.
|
|
3155
|
-
* @param instance The instance to stop tracking. This should be an instance that you previously passed to `RegisterAdOpportunityAsync`.
|
|
3167
|
+
* @param instance The instance to stop tracking. This should be an instance that you previously passed to `RegisterAdOpportunityAsync()`.
|
|
3156
3168
|
*/
|
|
3157
3169
|
UnregisterAdOpportunity(this: AdService, instance: Instance): void;
|
|
3158
3170
|
/**
|
|
@@ -3497,6 +3509,8 @@ interface Animation extends Instance {
|
|
|
3497
3509
|
*/
|
|
3498
3510
|
readonly _nominal_Animation: unique symbol;
|
|
3499
3511
|
/**
|
|
3512
|
+
* A reference to the animation asset associated with this `Animation`.
|
|
3513
|
+
*
|
|
3500
3514
|
* - **ThreadSafety**: ReadSafe
|
|
3501
3515
|
*
|
|
3502
3516
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animation#AnimationContent)
|
|
@@ -3528,7 +3542,7 @@ interface AnimationClip extends Instance {
|
|
|
3528
3542
|
*/
|
|
3529
3543
|
readonly _nominal_AnimationClip: unique symbol;
|
|
3530
3544
|
/**
|
|
3531
|
-
*
|
|
3545
|
+
* The length in seconds of this clip. Returns `0` until the animation has fully loaded.
|
|
3532
3546
|
*
|
|
3533
3547
|
* - **ThreadSafety**: ReadSafe
|
|
3534
3548
|
* - **Tags**: NotReplicated
|
|
@@ -3705,12 +3719,15 @@ interface AnimationClipProvider extends Instance {
|
|
|
3705
3719
|
*/
|
|
3706
3720
|
GetAnimationsAsync(this: AnimationClipProvider, userId: User): Instance | undefined;
|
|
3707
3721
|
/**
|
|
3722
|
+
* Returns a `ClipEvaluator` for the `AnimationClip` at the given content ID, loaded asynchronously.
|
|
3723
|
+
*
|
|
3708
3724
|
* - **ThreadSafety**: Unsafe
|
|
3709
3725
|
* - **Tags**: Yields
|
|
3710
3726
|
*
|
|
3711
3727
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetClipEvaluatorAsync)
|
|
3712
3728
|
* @param this Provides functions to load and preview `AnimationClips`.
|
|
3713
|
-
* @param assetId
|
|
3729
|
+
* @param assetId The content ID of the animation to load.
|
|
3730
|
+
* @returns A `ClipEvaluator` that can sample the loaded `AnimationClip`.
|
|
3714
3731
|
*/
|
|
3715
3732
|
GetClipEvaluatorAsync(this: AnimationClipProvider, assetId: ContentId): ClipEvaluator;
|
|
3716
3733
|
}
|
|
@@ -3803,6 +3820,8 @@ interface AnimationFromVideoCreatorStudioService extends Instance {
|
|
|
3803
3820
|
readonly _nominal_AnimationFromVideoCreatorStudioService: unique symbol;
|
|
3804
3821
|
}
|
|
3805
3822
|
/**
|
|
3823
|
+
* A single node within an animation graph, connected to other nodes through named input pins.
|
|
3824
|
+
*
|
|
3806
3825
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition)
|
|
3807
3826
|
*/
|
|
3808
3827
|
interface AnimationNodeDefinition extends Instance {
|
|
@@ -3815,6 +3834,8 @@ interface AnimationNodeDefinition extends Instance {
|
|
|
3815
3834
|
*/
|
|
3816
3835
|
readonly _nominal_AnimationNodeDefinition: unique symbol;
|
|
3817
3836
|
/**
|
|
3837
|
+
* The kind of node this definition represents within its animation graph.
|
|
3838
|
+
*
|
|
3818
3839
|
* - **ThreadSafety**: ReadSafe
|
|
3819
3840
|
*
|
|
3820
3841
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#NodeType)
|
|
@@ -3826,7 +3847,7 @@ interface AnimationNodeDefinition extends Instance {
|
|
|
3826
3847
|
* - **ThreadSafety**: Unsafe
|
|
3827
3848
|
*
|
|
3828
3849
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#AddInputPin)
|
|
3829
|
-
* @param this
|
|
3850
|
+
* @param this A single node within an animation graph, connected to other nodes through named input pins.
|
|
3830
3851
|
* @param pin Name of the input pin to append. Should match the `Name` of the corresponding `ObjectValue` wiring child.
|
|
3831
3852
|
*/
|
|
3832
3853
|
AddInputPin(this: AnimationNodeDefinition, pin: string): void;
|
|
@@ -3836,7 +3857,7 @@ interface AnimationNodeDefinition extends Instance {
|
|
|
3836
3857
|
* - **ThreadSafety**: Unsafe
|
|
3837
3858
|
*
|
|
3838
3859
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#GetOrderedInputPinNames)
|
|
3839
|
-
* @param this
|
|
3860
|
+
* @param this A single node within an animation graph, connected to other nodes through named input pins.
|
|
3840
3861
|
* @returns The ordered list of input pin names.
|
|
3841
3862
|
*/
|
|
3842
3863
|
GetOrderedInputPinNames(this: AnimationNodeDefinition): Array<unknown>;
|
|
@@ -3846,7 +3867,7 @@ interface AnimationNodeDefinition extends Instance {
|
|
|
3846
3867
|
* - **ThreadSafety**: Unsafe
|
|
3847
3868
|
*
|
|
3848
3869
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#RemoveInputPin)
|
|
3849
|
-
* @param this
|
|
3870
|
+
* @param this A single node within an animation graph, connected to other nodes through named input pins.
|
|
3850
3871
|
* @param pin Name of the input pin to remove. Only the first pin matching this name is removed.
|
|
3851
3872
|
*/
|
|
3852
3873
|
RemoveInputPin(this: AnimationNodeDefinition, pin: string): void;
|
|
@@ -3856,7 +3877,7 @@ interface AnimationNodeDefinition extends Instance {
|
|
|
3856
3877
|
* - **ThreadSafety**: Unsafe
|
|
3857
3878
|
*
|
|
3858
3879
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#SetOrderedInputPinNames)
|
|
3859
|
-
* @param this
|
|
3880
|
+
* @param this A single node within an animation graph, connected to other nodes through named input pins.
|
|
3860
3881
|
* @param pins The new ordered list of input pin names, replacing the existing list.
|
|
3861
3882
|
*/
|
|
3862
3883
|
SetOrderedInputPinNames(this: AnimationNodeDefinition, pins: Array<unknown>): void;
|
|
@@ -4250,6 +4271,7 @@ interface Animator extends Instance {
|
|
|
4250
4271
|
*
|
|
4251
4272
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#GetPlayingAnimationTracks)
|
|
4252
4273
|
* @param this Responsible for the playback and replication of `Animations`.
|
|
4274
|
+
* @returns An array of currently active `AnimationTracks` on this `Animator`, including tracks that are fading out.
|
|
4253
4275
|
*/
|
|
4254
4276
|
GetPlayingAnimationTracks(this: Animator): Array<AnimationTrack>;
|
|
4255
4277
|
/**
|
|
@@ -4271,6 +4293,7 @@ interface Animator extends Instance {
|
|
|
4271
4293
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#LoadAnimation)
|
|
4272
4294
|
* @param this Responsible for the playback and replication of `Animations`.
|
|
4273
4295
|
* @param animation The `Animation` to be used.
|
|
4296
|
+
* @returns A new `AnimationTrack` linked to the given `Animation`.
|
|
4274
4297
|
*/
|
|
4275
4298
|
LoadAnimation(this: Animator, animation: Animation): AnimationTrack;
|
|
4276
4299
|
/**
|
|
@@ -4863,19 +4886,12 @@ interface AssetService extends Instance {
|
|
|
4863
4886
|
*/
|
|
4864
4887
|
LoadAssetAsync(this: AssetService, assetId: number): Instance | undefined;
|
|
4865
4888
|
/**
|
|
4866
|
-
* Allows in-experience asset creation for users by prompting a publish dialog.
|
|
4867
|
-
*
|
|
4868
4889
|
* - **ThreadSafety**: Unsafe
|
|
4869
4890
|
* - **Tags**: Yields
|
|
4870
4891
|
*
|
|
4871
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#
|
|
4872
|
-
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4873
|
-
* @param player The user who submits an asset creation.
|
|
4874
|
-
* @param instance The asset to be created. Currently can't contain scripts or nest non-public assets.
|
|
4875
|
-
* @param assetType The asset type. Currently can only be `AssetType.Model`.
|
|
4876
|
-
* @returns The `PromptCreateAssetResult` and asset ID pair if successful.
|
|
4892
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#PromptCreatePlatformContentAsync)
|
|
4877
4893
|
*/
|
|
4878
|
-
|
|
4894
|
+
PromptCreatePlatformContentAsync(this: AssetService, player: Player, object: RBXObject, assetType: CastsToEnum<Enum.AssetType>): unknown;
|
|
4879
4895
|
/**
|
|
4880
4896
|
* Prompts the specified player to select and upload a video, which is then converted into an `AnimationClip`.
|
|
4881
4897
|
*
|
|
@@ -8716,7 +8732,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8716
8732
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptCreateOutfit)
|
|
8717
8733
|
* @param this A service to support developer Avatar Editors.
|
|
8718
8734
|
* @param outfit The `Outfit` that the player will be prompted to created.
|
|
8719
|
-
* @param rigType The `
|
|
8735
|
+
* @param rigType The `HumanoidRigType` that the outfit will be created for if the player confirms the prompt.
|
|
8720
8736
|
* @param outfitOptions Reserved for future options. Must be empty or omitted.
|
|
8721
8737
|
* @param outfitType Optional `OutfitType`. Only `Avatar` and `Makeup` values are accepted. When omitted, the type is inferred from the description.
|
|
8722
8738
|
*/
|
|
@@ -8742,14 +8758,14 @@ interface AvatarEditorService extends Instance {
|
|
|
8742
8758
|
*/
|
|
8743
8759
|
PromptRenameOutfit(this: AvatarEditorService, outfitId: number): void;
|
|
8744
8760
|
/**
|
|
8745
|
-
* Prompts the `Players.LocalPlayer` to update their avatar based on the given `HumanoidDescription` and `
|
|
8761
|
+
* Prompts the `Players.LocalPlayer` to update their avatar based on the given `HumanoidDescription` and `HumanoidRigType` of R6 or R15.
|
|
8746
8762
|
*
|
|
8747
8763
|
* - **ThreadSafety**: Unsafe
|
|
8748
8764
|
*
|
|
8749
8765
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptSaveAvatar)
|
|
8750
8766
|
* @param this A service to support developer Avatar Editors.
|
|
8751
8767
|
* @param humanoidDescription The given `HumanoidDescription` being prompted to save.
|
|
8752
|
-
* @param rigType The `
|
|
8768
|
+
* @param rigType The `HumanoidRigType` that the avatar will be saved for if the player confirms the prompt.
|
|
8753
8769
|
*/
|
|
8754
8770
|
PromptSaveAvatar(this: AvatarEditorService, humanoidDescription: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): void;
|
|
8755
8771
|
/**
|
|
@@ -8772,8 +8788,8 @@ interface AvatarEditorService extends Instance {
|
|
|
8772
8788
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptUpdateOutfit)
|
|
8773
8789
|
* @param this A service to support developer Avatar Editors.
|
|
8774
8790
|
* @param outfitId The outfitId of the outfit to update.
|
|
8775
|
-
* @param updatedOutfit A HumanoidDescription that represents the new outfit data.
|
|
8776
|
-
* @param rigType The HumanoidRigType to update the outfit to.
|
|
8791
|
+
* @param updatedOutfit A `HumanoidDescription` that represents the new outfit data.
|
|
8792
|
+
* @param rigType The `HumanoidRigType` to update the outfit to.
|
|
8777
8793
|
*/
|
|
8778
8794
|
PromptUpdateOutfit(this: AvatarEditorService, outfitId: number, updatedOutfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): void;
|
|
8779
8795
|
/**
|
|
@@ -10623,6 +10639,20 @@ interface WrapTarget extends BaseWrap {
|
|
|
10623
10639
|
* @deprecated
|
|
10624
10640
|
*/
|
|
10625
10641
|
get Stiffness(): number;
|
|
10642
|
+
/**
|
|
10643
|
+
* - **ThreadSafety**: Unsafe
|
|
10644
|
+
* - **Tags**: Yields
|
|
10645
|
+
*
|
|
10646
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTarget#CreateTextureInCageSpaceAsync)
|
|
10647
|
+
*/
|
|
10648
|
+
CreateTextureInCageSpaceAsync(this: WrapTarget, texture: EditableImage, options?: object): EditableImage;
|
|
10649
|
+
/**
|
|
10650
|
+
* - **ThreadSafety**: Unsafe
|
|
10651
|
+
* - **Tags**: Yields
|
|
10652
|
+
*
|
|
10653
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTarget#CreateTextureInTargetSpaceAsync)
|
|
10654
|
+
*/
|
|
10655
|
+
CreateTextureInTargetSpaceAsync(this: WrapTarget, texture: EditableImage, wrapTextureTransfer: WrapTextureTransfer): EditableImage;
|
|
10626
10656
|
}
|
|
10627
10657
|
/**
|
|
10628
10658
|
* Connects two `Attachments` by drawing a texture between them.
|
|
@@ -11498,6 +11528,36 @@ interface SlimContentProvider extends CacheableContentProvider {
|
|
|
11498
11528
|
*/
|
|
11499
11529
|
readonly _nominal_SlimContentProvider: unique symbol;
|
|
11500
11530
|
}
|
|
11531
|
+
/**
|
|
11532
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11533
|
+
*
|
|
11534
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapContentProvider)
|
|
11535
|
+
*/
|
|
11536
|
+
interface WrapContentProvider extends CacheableContentProvider {
|
|
11537
|
+
/**
|
|
11538
|
+
* **DO NOT USE!**
|
|
11539
|
+
*
|
|
11540
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
11541
|
+
* @hidden
|
|
11542
|
+
* @deprecated
|
|
11543
|
+
*/
|
|
11544
|
+
readonly _nominal_WrapContentProvider: unique symbol;
|
|
11545
|
+
}
|
|
11546
|
+
/**
|
|
11547
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11548
|
+
*
|
|
11549
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CallingService)
|
|
11550
|
+
*/
|
|
11551
|
+
interface CallingService extends Instance {
|
|
11552
|
+
/**
|
|
11553
|
+
* **DO NOT USE!**
|
|
11554
|
+
*
|
|
11555
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
11556
|
+
* @hidden
|
|
11557
|
+
* @deprecated
|
|
11558
|
+
*/
|
|
11559
|
+
readonly _nominal_CallingService: unique symbol;
|
|
11560
|
+
}
|
|
11501
11561
|
/**
|
|
11502
11562
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11503
11563
|
*
|
|
@@ -11590,12 +11650,15 @@ interface CaptureService extends Instance {
|
|
|
11590
11650
|
*/
|
|
11591
11651
|
TakeScreenshotCaptureAsync(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
|
|
11592
11652
|
/**
|
|
11653
|
+
* Polls the status of an in-progress capture upload started by `StartUploadCaptureAsync()`.
|
|
11654
|
+
*
|
|
11593
11655
|
* - **ThreadSafety**: Unsafe
|
|
11594
11656
|
* - **Tags**: Yields
|
|
11595
11657
|
*
|
|
11596
11658
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CheckUploadCaptureStatusAsync)
|
|
11597
11659
|
* @param this A service which provides control over screenshot and video capture features.
|
|
11598
|
-
* @param token
|
|
11660
|
+
* @param token The token returned by `StartUploadCaptureAsync()` that identifies the in-progress upload.
|
|
11661
|
+
* @returns Tuple of (result: `UploadCaptureResult`, assetId: `number`)
|
|
11599
11662
|
*/
|
|
11600
11663
|
CheckUploadCaptureStatusAsync(this: CaptureService, token: string): unknown;
|
|
11601
11664
|
/**
|
|
@@ -11613,6 +11676,8 @@ interface CaptureService extends Instance {
|
|
|
11613
11676
|
*/
|
|
11614
11677
|
InternalGetStartPlaceIdAsync(this: CaptureService, universeId: number): number;
|
|
11615
11678
|
/**
|
|
11679
|
+
* Prompts the user for permission to access their local capture gallery.
|
|
11680
|
+
*
|
|
11616
11681
|
* - **ThreadSafety**: Unsafe
|
|
11617
11682
|
* - **Tags**: Yields
|
|
11618
11683
|
*
|
|
@@ -11623,6 +11688,8 @@ interface CaptureService extends Instance {
|
|
|
11623
11688
|
*/
|
|
11624
11689
|
PromptCaptureGalleryPermissionAsync(this: CaptureService, captureGalleryPermission: CastsToEnum<Enum.CaptureGalleryPermission>): boolean;
|
|
11625
11690
|
/**
|
|
11691
|
+
* Returns a paginated list of captures from the user's gallery.
|
|
11692
|
+
*
|
|
11626
11693
|
* - **ThreadSafety**: Unsafe
|
|
11627
11694
|
* - **Tags**: Yields
|
|
11628
11695
|
*
|
|
@@ -11634,12 +11701,15 @@ interface CaptureService extends Instance {
|
|
|
11634
11701
|
*/
|
|
11635
11702
|
ReadCapturesFromGalleryAsync(this: CaptureService, captureTypeFilters?: Array<unknown>, readFromAllEligibleExperiences?: boolean): unknown;
|
|
11636
11703
|
/**
|
|
11704
|
+
* Begins uploading a capture to the asset system and returns a token used to poll the upload's status.
|
|
11705
|
+
*
|
|
11637
11706
|
* - **ThreadSafety**: Unsafe
|
|
11638
11707
|
* - **Tags**: Yields
|
|
11639
11708
|
*
|
|
11640
11709
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartUploadCaptureAsync)
|
|
11641
11710
|
* @param this A service which provides control over screenshot and video capture features.
|
|
11642
|
-
* @param capture
|
|
11711
|
+
* @param capture The `Capture` to upload.
|
|
11712
|
+
* @returns Tuple of (result: `UploadCaptureResult`, token: `string`)
|
|
11643
11713
|
*/
|
|
11644
11714
|
StartUploadCaptureAsync(this: CaptureService, capture: Capture): unknown;
|
|
11645
11715
|
/**
|
|
@@ -11651,10 +11721,13 @@ interface CaptureService extends Instance {
|
|
|
11651
11721
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartVideoCaptureAsync)
|
|
11652
11722
|
* @param this A service which provides control over screenshot and video capture features.
|
|
11653
11723
|
* @param onCaptureReady A callback function that is called on video capture completion with a `VideoCaptureResult` and, if successful, a `VideoCapture`.
|
|
11654
|
-
* @param captureParams
|
|
11724
|
+
* @param captureParams A dictionary of optional parameters that modify capture behavior. Currently non-operational.
|
|
11725
|
+
* @returns A `VideoCaptureStartedResult` indicating whether the video recording started successfully.
|
|
11655
11726
|
*/
|
|
11656
11727
|
StartVideoCaptureAsync(this: CaptureService, onCaptureReady: Callback, captureParams?: object): Enum.VideoCaptureStartedResult;
|
|
11657
11728
|
/**
|
|
11729
|
+
* Uploads a capture to the asset system and returns the result and asset ID.
|
|
11730
|
+
*
|
|
11658
11731
|
* - **ThreadSafety**: Unsafe
|
|
11659
11732
|
* - **Tags**: Yields
|
|
11660
11733
|
*
|
|
@@ -11683,6 +11756,8 @@ interface CaptureService extends Instance {
|
|
|
11683
11756
|
/**
|
|
11684
11757
|
* **Deprecated:** This event has been superseded by the `UserCaptureSaved` event.
|
|
11685
11758
|
*
|
|
11759
|
+
* Fires when a screenshot capture is saved to the user's gallery.
|
|
11760
|
+
*
|
|
11686
11761
|
* - **ThreadSafety**: Unsafe
|
|
11687
11762
|
* - **Tags**:
|
|
11688
11763
|
*
|
|
@@ -12978,7 +13053,7 @@ interface CommerceService extends Instance {
|
|
|
12978
13053
|
*
|
|
12979
13054
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService#PromptCommerceProductPurchase)
|
|
12980
13055
|
* @param this Supports real-world purchases that you can bundle with digital benefits.
|
|
12981
|
-
* @param user The `Player` to prompt with the purchase flow. When called from a
|
|
13056
|
+
* @param user The `Player` to prompt with the purchase flow. When called from a client script, this must be the local player.
|
|
12982
13057
|
* @param commerceProductId The identifier of the commerce product to purchase, either the numeric ID or the full `COM-`-prefixed form.
|
|
12983
13058
|
*/
|
|
12984
13059
|
PromptCommerceProductPurchase(this: CommerceService, user: Player, commerceProductId: string): void;
|
|
@@ -12989,7 +13064,7 @@ interface CommerceService extends Instance {
|
|
|
12989
13064
|
*
|
|
12990
13065
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService#PromptRealWorldCommerceBrowser)
|
|
12991
13066
|
* @param this Supports real-world purchases that you can bundle with digital benefits.
|
|
12992
|
-
* @param player The `Player` for whom the browser opens. When called from a
|
|
13067
|
+
* @param player The `Player` for whom the browser opens. When called from a client script, this must be the local player.
|
|
12993
13068
|
* @param url The real-world commerce URL to open. The URL must be on the commerce allowlist, or the request is ignored.
|
|
12994
13069
|
*/
|
|
12995
13070
|
PromptRealWorldCommerceBrowser(this: CommerceService, player: Player, url: string): void;
|
|
@@ -13054,6 +13129,7 @@ interface CompositeValueCurve extends Instance {
|
|
|
13054
13129
|
*
|
|
13055
13130
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#GetComponentCurves)
|
|
13056
13131
|
* @param this An animation curve that groups child `FloatCurves` which each animate a different component of a non-unary value.
|
|
13132
|
+
* @returns An array of the child `FloatCurve` instances that drive the components of the animated value, in the order listed at the top of this page. Any expected child curve that does not yet exist is created as an empty `FloatCurve` and included in the result.
|
|
13057
13133
|
*/
|
|
13058
13134
|
GetComponentCurves(this: CompositeValueCurve): Array<Instance>;
|
|
13059
13135
|
/**
|
|
@@ -14934,14 +15010,18 @@ interface ContentProvider extends Instance {
|
|
|
14934
15010
|
*
|
|
14935
15011
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContentProvider#GetAssetFetchStatusChangedSignal)
|
|
14936
15012
|
* @param this Service that is used to load content, or assets, into a game.
|
|
14937
|
-
* @param contentId
|
|
15013
|
+
* @param contentId The ID of the content to monitor for fetch status changes.
|
|
15014
|
+
* @returns An `RBXScriptSignal` that fires when the `AssetFetchStatus` of the given content changes.
|
|
14938
15015
|
*/
|
|
14939
15016
|
GetAssetFetchStatusChangedSignal(this: ContentProvider, contentId: ContentId): RBXScriptSignal;
|
|
14940
15017
|
/**
|
|
15018
|
+
* Returns an array of the asset IDs that currently have a registered encryption key.
|
|
15019
|
+
*
|
|
14941
15020
|
* - **ThreadSafety**: Unsafe
|
|
14942
15021
|
*
|
|
14943
15022
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContentProvider#ListEncryptedAssets)
|
|
14944
15023
|
* @param this Service that is used to load content, or assets, into a game.
|
|
15024
|
+
* @returns An array of the asset IDs that currently have an encryption key registered on this `ContentProvider`.
|
|
14945
15025
|
*/
|
|
14946
15026
|
ListEncryptedAssets(this: ContentProvider): Array<unknown>;
|
|
14947
15027
|
/**
|
|
@@ -14954,46 +15034,56 @@ interface ContentProvider extends Instance {
|
|
|
14954
15034
|
*
|
|
14955
15035
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContentProvider#Preload)
|
|
14956
15036
|
* @param this Service that is used to load content, or assets, into a game.
|
|
14957
|
-
* @param contentId
|
|
15037
|
+
* @param contentId The content URL of the asset to preload.
|
|
14958
15038
|
*
|
|
14959
15039
|
* @deprecated PreloadAsync
|
|
14960
15040
|
*/
|
|
14961
15041
|
Preload(this: ContentProvider, contentId: ContentId): void;
|
|
14962
15042
|
/**
|
|
15043
|
+
* Registers a fallback encryption key used to decrypt any encrypted asset that doesn't have its own key registered.
|
|
15044
|
+
*
|
|
14963
15045
|
* - **ThreadSafety**: Unsafe
|
|
14964
15046
|
*
|
|
14965
15047
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContentProvider#RegisterDefaultEncryptionKey)
|
|
14966
15048
|
* @param this Service that is used to load content, or assets, into a game.
|
|
14967
|
-
* @param encryptionKey
|
|
15049
|
+
* @param encryptionKey The key to use as the default for decrypting encrypted assets.
|
|
14968
15050
|
*/
|
|
14969
15051
|
RegisterDefaultEncryptionKey(this: ContentProvider, encryptionKey: string): void;
|
|
14970
15052
|
/**
|
|
15053
|
+
* Decrypts the provided session key and registers the result as the default encryption key.
|
|
15054
|
+
*
|
|
14971
15055
|
* - **ThreadSafety**: Unsafe
|
|
14972
15056
|
*
|
|
14973
15057
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContentProvider#RegisterDefaultSessionKey)
|
|
14974
15058
|
* @param this Service that is used to load content, or assets, into a game.
|
|
14975
|
-
* @param sessionKey
|
|
15059
|
+
* @param sessionKey The session-encrypted key to decrypt and register as the default encryption key.
|
|
14976
15060
|
*/
|
|
14977
15061
|
RegisterDefaultSessionKey(this: ContentProvider, sessionKey: string): void;
|
|
14978
15062
|
/**
|
|
15063
|
+
* Registers an encryption key used to decrypt a specific encrypted asset.
|
|
15064
|
+
*
|
|
14979
15065
|
* - **ThreadSafety**: Unsafe
|
|
14980
15066
|
*
|
|
14981
15067
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContentProvider#RegisterEncryptedAsset)
|
|
14982
15068
|
* @param this Service that is used to load content, or assets, into a game.
|
|
14983
|
-
* @param assetId
|
|
14984
|
-
* @param encryptionKey
|
|
15069
|
+
* @param assetId The asset to associate the encryption key with.
|
|
15070
|
+
* @param encryptionKey The key used to decrypt the specified asset.
|
|
14985
15071
|
*/
|
|
14986
15072
|
RegisterEncryptedAsset(this: ContentProvider, assetId: ContentId, encryptionKey: string): void;
|
|
14987
15073
|
/**
|
|
15074
|
+
* Decrypts the provided session key and registers it as the encryption key for a specific asset.
|
|
15075
|
+
*
|
|
14988
15076
|
* - **ThreadSafety**: Unsafe
|
|
14989
15077
|
*
|
|
14990
15078
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContentProvider#RegisterSessionEncryptedAsset)
|
|
14991
15079
|
* @param this Service that is used to load content, or assets, into a game.
|
|
14992
|
-
* @param contentId
|
|
14993
|
-
* @param sessionKey
|
|
15080
|
+
* @param contentId The asset to associate the decrypted key with.
|
|
15081
|
+
* @param sessionKey The session-encrypted key to decrypt and register for the specified asset.
|
|
14994
15082
|
*/
|
|
14995
15083
|
RegisterSessionEncryptedAsset(this: ContentProvider, contentId: ContentId, sessionKey: string): void;
|
|
14996
15084
|
/**
|
|
15085
|
+
* Clears the default encryption key previously set on the `ContentProvider`.
|
|
15086
|
+
*
|
|
14997
15087
|
* - **ThreadSafety**: Unsafe
|
|
14998
15088
|
*
|
|
14999
15089
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContentProvider#UnregisterDefaultEncryptionKey)
|
|
@@ -15001,11 +15091,13 @@ interface ContentProvider extends Instance {
|
|
|
15001
15091
|
*/
|
|
15002
15092
|
UnregisterDefaultEncryptionKey(this: ContentProvider): void;
|
|
15003
15093
|
/**
|
|
15094
|
+
* Removes the encryption key registered for a specific asset.
|
|
15095
|
+
*
|
|
15004
15096
|
* - **ThreadSafety**: Unsafe
|
|
15005
15097
|
*
|
|
15006
15098
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContentProvider#UnregisterEncryptedAsset)
|
|
15007
15099
|
* @param this Service that is used to load content, or assets, into a game.
|
|
15008
|
-
* @param assetId
|
|
15100
|
+
* @param assetId The asset whose registered encryption key should be removed.
|
|
15009
15101
|
*/
|
|
15010
15102
|
UnregisterEncryptedAsset(this: ContentProvider, assetId: ContentId): void;
|
|
15011
15103
|
/**
|
|
@@ -15021,6 +15113,8 @@ interface ContentProvider extends Instance {
|
|
|
15021
15113
|
*/
|
|
15022
15114
|
PreloadAsync(this: ContentProvider, contentIdList: Array<Instance | string>, callback?: (contentId: string, status: Enum.AssetFetchStatus) => void): void;
|
|
15023
15115
|
/**
|
|
15116
|
+
* Fires when the `ContentProvider` fails to fetch an asset, passing the asset's ID.
|
|
15117
|
+
*
|
|
15024
15118
|
* - **ThreadSafety**: Unsafe
|
|
15025
15119
|
*
|
|
15026
15120
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContentProvider#AssetFetchFailed)
|
|
@@ -15233,6 +15327,111 @@ interface ContextActionService extends Instance {
|
|
|
15233
15327
|
*/
|
|
15234
15328
|
readonly LocalToolUnequipped: RBXScriptSignal<(toolUnequipped: Instance) => void>;
|
|
15235
15329
|
}
|
|
15330
|
+
/**
|
|
15331
|
+
* - **Tags**: NotBrowsable
|
|
15332
|
+
*
|
|
15333
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState)
|
|
15334
|
+
*/
|
|
15335
|
+
interface ControlState extends Instance {
|
|
15336
|
+
/**
|
|
15337
|
+
* **DO NOT USE!**
|
|
15338
|
+
*
|
|
15339
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
15340
|
+
* @hidden
|
|
15341
|
+
* @deprecated
|
|
15342
|
+
*/
|
|
15343
|
+
readonly _nominal_ControlState: unique symbol;
|
|
15344
|
+
/**
|
|
15345
|
+
* - **ThreadSafety**: ReadSafe
|
|
15346
|
+
*
|
|
15347
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#Owner)
|
|
15348
|
+
*/
|
|
15349
|
+
Owner: Player | undefined;
|
|
15350
|
+
/**
|
|
15351
|
+
* - **ThreadSafety**: Unsafe
|
|
15352
|
+
*
|
|
15353
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#AddBoolField)
|
|
15354
|
+
*/
|
|
15355
|
+
AddBoolField(this: ControlState, name: string, defaultValue?: boolean): void;
|
|
15356
|
+
/**
|
|
15357
|
+
* - **ThreadSafety**: Unsafe
|
|
15358
|
+
*
|
|
15359
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#AddCFrameField)
|
|
15360
|
+
*/
|
|
15361
|
+
AddCFrameField(this: ControlState, name: string, defaultValue?: CFrame): void;
|
|
15362
|
+
/**
|
|
15363
|
+
* - **ThreadSafety**: Unsafe
|
|
15364
|
+
*
|
|
15365
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#AddInstanceField)
|
|
15366
|
+
*/
|
|
15367
|
+
AddInstanceField(this: ControlState, name: string): void;
|
|
15368
|
+
/**
|
|
15369
|
+
* - **ThreadSafety**: Unsafe
|
|
15370
|
+
*
|
|
15371
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#AddIntField)
|
|
15372
|
+
*/
|
|
15373
|
+
AddIntField(this: ControlState, name: string, defaultValue?: number, min?: number, max?: number): void;
|
|
15374
|
+
/**
|
|
15375
|
+
* - **ThreadSafety**: Unsafe
|
|
15376
|
+
*
|
|
15377
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#AddNumberField)
|
|
15378
|
+
*/
|
|
15379
|
+
AddNumberField(this: ControlState, name: string, defaultValue?: number, min?: number, max?: number): void;
|
|
15380
|
+
/**
|
|
15381
|
+
* - **ThreadSafety**: Unsafe
|
|
15382
|
+
*
|
|
15383
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#AddUnitVector3Field)
|
|
15384
|
+
*/
|
|
15385
|
+
AddUnitVector3Field(this: ControlState, name: string, defaultValue?: Vector3): void;
|
|
15386
|
+
/**
|
|
15387
|
+
* - **ThreadSafety**: Unsafe
|
|
15388
|
+
*
|
|
15389
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#AddVector2Field)
|
|
15390
|
+
*/
|
|
15391
|
+
AddVector2Field(this: ControlState, name: string, defaultValue?: Vector2, maxMagnitude?: number): void;
|
|
15392
|
+
/**
|
|
15393
|
+
* - **ThreadSafety**: Unsafe
|
|
15394
|
+
*
|
|
15395
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#AddVector3Field)
|
|
15396
|
+
*/
|
|
15397
|
+
AddVector3Field(this: ControlState, name: string, defaultValue?: Vector3, maxMagnitude?: number): void;
|
|
15398
|
+
/**
|
|
15399
|
+
* - **ThreadSafety**: Unsafe
|
|
15400
|
+
*
|
|
15401
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#GetChangedState)
|
|
15402
|
+
*/
|
|
15403
|
+
GetChangedState(this: ControlState, prev?: CastsToEnum<Enum.StateReferenceFrame>, next?: CastsToEnum<Enum.StateReferenceFrame>): object;
|
|
15404
|
+
/**
|
|
15405
|
+
* - **ThreadSafety**: Unsafe
|
|
15406
|
+
*
|
|
15407
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#GetReplicationWeight)
|
|
15408
|
+
*/
|
|
15409
|
+
GetReplicationWeight(this: ControlState): number;
|
|
15410
|
+
/**
|
|
15411
|
+
* - **ThreadSafety**: Unsafe
|
|
15412
|
+
*
|
|
15413
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#GetState)
|
|
15414
|
+
*/
|
|
15415
|
+
GetState(this: ControlState, ref?: CastsToEnum<Enum.StateReferenceFrame>): object;
|
|
15416
|
+
/**
|
|
15417
|
+
* - **ThreadSafety**: Unsafe
|
|
15418
|
+
*
|
|
15419
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#SetField)
|
|
15420
|
+
*/
|
|
15421
|
+
SetField(this: ControlState, name: string, value: unknown): void;
|
|
15422
|
+
/**
|
|
15423
|
+
* - **ThreadSafety**: Unsafe
|
|
15424
|
+
*
|
|
15425
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#UpdateFields)
|
|
15426
|
+
*/
|
|
15427
|
+
UpdateFields(this: ControlState, state: object): void;
|
|
15428
|
+
/**
|
|
15429
|
+
* - **ThreadSafety**: Unsafe
|
|
15430
|
+
*
|
|
15431
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControlState#OnStateChanged)
|
|
15432
|
+
*/
|
|
15433
|
+
readonly OnStateChanged: RBXScriptSignal<() => void>;
|
|
15434
|
+
}
|
|
15236
15435
|
/**
|
|
15237
15436
|
* The base class for controller objects, such as the `HumanoidController` object.
|
|
15238
15437
|
*
|
|
@@ -15776,6 +15975,8 @@ interface ControllerService extends Instance {
|
|
|
15776
15975
|
readonly _nominal_ControllerService: unique symbol;
|
|
15777
15976
|
}
|
|
15778
15977
|
/**
|
|
15978
|
+
* Service that groups the configuration objects controlling Roblox's built-in `CoreGui` elements.
|
|
15979
|
+
*
|
|
15779
15980
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
15780
15981
|
*
|
|
15781
15982
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CoreGuiConfiguration)
|
|
@@ -15790,18 +15991,24 @@ interface CoreGuiConfiguration extends Instance {
|
|
|
15790
15991
|
*/
|
|
15791
15992
|
readonly _nominal_CoreGuiConfiguration: unique symbol;
|
|
15792
15993
|
/**
|
|
15994
|
+
* References the `CapturesViewConfiguration` object that controls the built-in captures view.
|
|
15995
|
+
*
|
|
15793
15996
|
* - **ThreadSafety**: ReadSafe
|
|
15794
15997
|
*
|
|
15795
15998
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CoreGuiConfiguration#CapturesViewConfiguration)
|
|
15796
15999
|
*/
|
|
15797
16000
|
CapturesViewConfiguration: CapturesViewConfiguration | undefined;
|
|
15798
16001
|
/**
|
|
16002
|
+
* References the `PlayerListConfiguration` object that controls the built-in player list.
|
|
16003
|
+
*
|
|
15799
16004
|
* - **ThreadSafety**: ReadSafe
|
|
15800
16005
|
*
|
|
15801
16006
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CoreGuiConfiguration#PlayerListConfiguration)
|
|
15802
16007
|
*/
|
|
15803
16008
|
PlayerListConfiguration: PlayerListConfiguration | undefined;
|
|
15804
16009
|
/**
|
|
16010
|
+
* References the `SelfViewConfiguration` object that controls the built-in self view.
|
|
16011
|
+
*
|
|
15805
16012
|
* - **ThreadSafety**: ReadSafe
|
|
15806
16013
|
*
|
|
15807
16014
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CoreGuiConfiguration#SelfViewConfiguration)
|
|
@@ -16877,283 +17084,375 @@ interface DigitsRigDescription extends Instance {
|
|
|
16877
17084
|
*/
|
|
16878
17085
|
readonly _nominal_DigitsRigDescription: unique symbol;
|
|
16879
17086
|
/**
|
|
17087
|
+
* The instance mapped to the proximal (first) phalanx of the index finger.
|
|
17088
|
+
*
|
|
16880
17089
|
* - **ThreadSafety**: ReadSafe
|
|
16881
17090
|
*
|
|
16882
17091
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Index1)
|
|
16883
17092
|
*/
|
|
16884
17093
|
Index1: Instance | undefined;
|
|
16885
17094
|
/**
|
|
17095
|
+
* CFrame applied to `Index1` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17096
|
+
*
|
|
16886
17097
|
* - **ThreadSafety**: ReadSafe
|
|
16887
17098
|
*
|
|
16888
17099
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Index1TposeAdjustment)
|
|
16889
17100
|
*/
|
|
16890
17101
|
Index1TposeAdjustment: CFrame;
|
|
16891
17102
|
/**
|
|
17103
|
+
* The instance mapped to the medial (second) phalanx of the index finger.
|
|
17104
|
+
*
|
|
16892
17105
|
* - **ThreadSafety**: ReadSafe
|
|
16893
17106
|
*
|
|
16894
17107
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Index2)
|
|
16895
17108
|
*/
|
|
16896
17109
|
Index2: Instance | undefined;
|
|
16897
17110
|
/**
|
|
17111
|
+
* CFrame applied to `Index2` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17112
|
+
*
|
|
16898
17113
|
* - **ThreadSafety**: ReadSafe
|
|
16899
17114
|
*
|
|
16900
17115
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Index2TposeAdjustment)
|
|
16901
17116
|
*/
|
|
16902
17117
|
Index2TposeAdjustment: CFrame;
|
|
16903
17118
|
/**
|
|
17119
|
+
* The instance mapped to the distal (third) phalanx of the index finger.
|
|
17120
|
+
*
|
|
16904
17121
|
* - **ThreadSafety**: ReadSafe
|
|
16905
17122
|
*
|
|
16906
17123
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Index3)
|
|
16907
17124
|
*/
|
|
16908
17125
|
Index3: Instance | undefined;
|
|
16909
17126
|
/**
|
|
17127
|
+
* CFrame applied to `Index3` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17128
|
+
*
|
|
16910
17129
|
* - **ThreadSafety**: ReadSafe
|
|
16911
17130
|
*
|
|
16912
17131
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Index3TposeAdjustment)
|
|
16913
17132
|
*/
|
|
16914
17133
|
Index3TposeAdjustment: CFrame;
|
|
16915
17134
|
/**
|
|
17135
|
+
* Motion range vector for the index finger used by the finger solver.
|
|
17136
|
+
*
|
|
16916
17137
|
* - **ThreadSafety**: ReadSafe
|
|
16917
17138
|
*
|
|
16918
17139
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#IndexRange)
|
|
16919
17140
|
*/
|
|
16920
17141
|
IndexRange: Vector3;
|
|
16921
17142
|
/**
|
|
17143
|
+
* Size of the index finger used by the finger solver to preserve contacts.
|
|
17144
|
+
*
|
|
16922
17145
|
* - **ThreadSafety**: ReadSafe
|
|
16923
17146
|
*
|
|
16924
17147
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#IndexSize)
|
|
16925
17148
|
*/
|
|
16926
17149
|
IndexSize: number;
|
|
16927
17150
|
/**
|
|
17151
|
+
* The instance mapped to the proximal (first) phalanx of the middle finger.
|
|
17152
|
+
*
|
|
16928
17153
|
* - **ThreadSafety**: ReadSafe
|
|
16929
17154
|
*
|
|
16930
17155
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Middle1)
|
|
16931
17156
|
*/
|
|
16932
17157
|
Middle1: Instance | undefined;
|
|
16933
17158
|
/**
|
|
17159
|
+
* CFrame applied to Middle1 to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17160
|
+
*
|
|
16934
17161
|
* - **ThreadSafety**: ReadSafe
|
|
16935
17162
|
*
|
|
16936
17163
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Middle1TposeAdjustment)
|
|
16937
17164
|
*/
|
|
16938
17165
|
Middle1TposeAdjustment: CFrame;
|
|
16939
17166
|
/**
|
|
17167
|
+
* The instance mapped to the medial (second) phalanx of the middle finger.
|
|
17168
|
+
*
|
|
16940
17169
|
* - **ThreadSafety**: ReadSafe
|
|
16941
17170
|
*
|
|
16942
17171
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Middle2)
|
|
16943
17172
|
*/
|
|
16944
17173
|
Middle2: Instance | undefined;
|
|
16945
17174
|
/**
|
|
17175
|
+
* CFrame applied to `Middle2` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17176
|
+
*
|
|
16946
17177
|
* - **ThreadSafety**: ReadSafe
|
|
16947
17178
|
*
|
|
16948
17179
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Middle2TposeAdjustment)
|
|
16949
17180
|
*/
|
|
16950
17181
|
Middle2TposeAdjustment: CFrame;
|
|
16951
17182
|
/**
|
|
17183
|
+
* The instance mapped to the distal (third) phalanx of the middle finger.
|
|
17184
|
+
*
|
|
16952
17185
|
* - **ThreadSafety**: ReadSafe
|
|
16953
17186
|
*
|
|
16954
17187
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Middle3)
|
|
16955
17188
|
*/
|
|
16956
17189
|
Middle3: Instance | undefined;
|
|
16957
17190
|
/**
|
|
17191
|
+
* CFrame applied to `Middle3` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17192
|
+
*
|
|
16958
17193
|
* - **ThreadSafety**: ReadSafe
|
|
16959
17194
|
*
|
|
16960
17195
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Middle3TposeAdjustment)
|
|
16961
17196
|
*/
|
|
16962
17197
|
Middle3TposeAdjustment: CFrame;
|
|
16963
17198
|
/**
|
|
17199
|
+
* Motion range vector for the middle finger used by the finger solver.
|
|
17200
|
+
*
|
|
16964
17201
|
* - **ThreadSafety**: ReadSafe
|
|
16965
17202
|
*
|
|
16966
17203
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#MiddleRange)
|
|
16967
17204
|
*/
|
|
16968
17205
|
MiddleRange: Vector3;
|
|
16969
17206
|
/**
|
|
17207
|
+
* Scale factor for the middle finger used by the scalable-property system.
|
|
17208
|
+
*
|
|
16970
17209
|
* - **ThreadSafety**: ReadSafe
|
|
16971
17210
|
*
|
|
16972
17211
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#MiddleSize)
|
|
16973
17212
|
*/
|
|
16974
17213
|
MiddleSize: number;
|
|
16975
17214
|
/**
|
|
17215
|
+
* The instance mapped to the proximal (first) phalanx of the pinky finger.
|
|
17216
|
+
*
|
|
16976
17217
|
* - **ThreadSafety**: ReadSafe
|
|
16977
17218
|
*
|
|
16978
17219
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Pinky1)
|
|
16979
17220
|
*/
|
|
16980
17221
|
Pinky1: Instance | undefined;
|
|
16981
17222
|
/**
|
|
17223
|
+
* CFrame applied to `Pinky1` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17224
|
+
*
|
|
16982
17225
|
* - **ThreadSafety**: ReadSafe
|
|
16983
17226
|
*
|
|
16984
17227
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Pinky1TposeAdjustment)
|
|
16985
17228
|
*/
|
|
16986
17229
|
Pinky1TposeAdjustment: CFrame;
|
|
16987
17230
|
/**
|
|
17231
|
+
* The instance mapped to the medial (second) phalanx of the pinky finger.
|
|
17232
|
+
*
|
|
16988
17233
|
* - **ThreadSafety**: ReadSafe
|
|
16989
17234
|
*
|
|
16990
17235
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Pinky2)
|
|
16991
17236
|
*/
|
|
16992
17237
|
Pinky2: Instance | undefined;
|
|
16993
17238
|
/**
|
|
17239
|
+
* CFrame applied to Pinky2 to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17240
|
+
*
|
|
16994
17241
|
* - **ThreadSafety**: ReadSafe
|
|
16995
17242
|
*
|
|
16996
17243
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Pinky2TposeAdjustment)
|
|
16997
17244
|
*/
|
|
16998
17245
|
Pinky2TposeAdjustment: CFrame;
|
|
16999
17246
|
/**
|
|
17247
|
+
* The instance mapped to the distal (third) phalanx of the pinky finger.
|
|
17248
|
+
*
|
|
17000
17249
|
* - **ThreadSafety**: ReadSafe
|
|
17001
17250
|
*
|
|
17002
17251
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Pinky3)
|
|
17003
17252
|
*/
|
|
17004
17253
|
Pinky3: Instance | undefined;
|
|
17005
17254
|
/**
|
|
17255
|
+
* CFrame applied to `Pinky3` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17256
|
+
*
|
|
17006
17257
|
* - **ThreadSafety**: ReadSafe
|
|
17007
17258
|
*
|
|
17008
17259
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Pinky3TposeAdjustment)
|
|
17009
17260
|
*/
|
|
17010
17261
|
Pinky3TposeAdjustment: CFrame;
|
|
17011
17262
|
/**
|
|
17263
|
+
* Motion range vector for the pinky finger used by the finger solver.
|
|
17264
|
+
*
|
|
17012
17265
|
* - **ThreadSafety**: ReadSafe
|
|
17013
17266
|
*
|
|
17014
17267
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#PinkyRange)
|
|
17015
17268
|
*/
|
|
17016
17269
|
PinkyRange: Vector3;
|
|
17017
17270
|
/**
|
|
17271
|
+
* Scale factor for the pinky finger used by the scalable-property system.
|
|
17272
|
+
*
|
|
17018
17273
|
* - **ThreadSafety**: ReadSafe
|
|
17019
17274
|
*
|
|
17020
17275
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#PinkySize)
|
|
17021
17276
|
*/
|
|
17022
17277
|
PinkySize: number;
|
|
17023
17278
|
/**
|
|
17279
|
+
* The instance mapped to the proximal (first) phalanx of the ring finger.
|
|
17280
|
+
*
|
|
17024
17281
|
* - **ThreadSafety**: ReadSafe
|
|
17025
17282
|
*
|
|
17026
17283
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Ring1)
|
|
17027
17284
|
*/
|
|
17028
17285
|
Ring1: Instance | undefined;
|
|
17029
17286
|
/**
|
|
17287
|
+
* CFrame applied to `Ring1` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17288
|
+
*
|
|
17030
17289
|
* - **ThreadSafety**: ReadSafe
|
|
17031
17290
|
*
|
|
17032
17291
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Ring1TposeAdjustment)
|
|
17033
17292
|
*/
|
|
17034
17293
|
Ring1TposeAdjustment: CFrame;
|
|
17035
17294
|
/**
|
|
17295
|
+
* The instance mapped to the medial (second) phalanx of the ring finger.
|
|
17296
|
+
*
|
|
17036
17297
|
* - **ThreadSafety**: ReadSafe
|
|
17037
17298
|
*
|
|
17038
17299
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Ring2)
|
|
17039
17300
|
*/
|
|
17040
17301
|
Ring2: Instance | undefined;
|
|
17041
17302
|
/**
|
|
17303
|
+
* CFrame applied to `Ring2` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17304
|
+
*
|
|
17042
17305
|
* - **ThreadSafety**: ReadSafe
|
|
17043
17306
|
*
|
|
17044
17307
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Ring2TposeAdjustment)
|
|
17045
17308
|
*/
|
|
17046
17309
|
Ring2TposeAdjustment: CFrame;
|
|
17047
17310
|
/**
|
|
17311
|
+
* The instance mapped to the distal (third) phalanx of the ring finger.
|
|
17312
|
+
*
|
|
17048
17313
|
* - **ThreadSafety**: ReadSafe
|
|
17049
17314
|
*
|
|
17050
17315
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Ring3)
|
|
17051
17316
|
*/
|
|
17052
17317
|
Ring3: Instance | undefined;
|
|
17053
17318
|
/**
|
|
17319
|
+
* CFrame applied to `Ring3` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17320
|
+
*
|
|
17054
17321
|
* - **ThreadSafety**: ReadSafe
|
|
17055
17322
|
*
|
|
17056
17323
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Ring3TposeAdjustment)
|
|
17057
17324
|
*/
|
|
17058
17325
|
Ring3TposeAdjustment: CFrame;
|
|
17059
17326
|
/**
|
|
17327
|
+
* Motion range vector for the ring finger used by the finger solver.
|
|
17328
|
+
*
|
|
17060
17329
|
* - **ThreadSafety**: ReadSafe
|
|
17061
17330
|
*
|
|
17062
17331
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#RingRange)
|
|
17063
17332
|
*/
|
|
17064
17333
|
RingRange: Vector3;
|
|
17065
17334
|
/**
|
|
17335
|
+
* Scale factor for the ring finger used by the scalable-property system.
|
|
17336
|
+
*
|
|
17066
17337
|
* - **ThreadSafety**: ReadSafe
|
|
17067
17338
|
*
|
|
17068
17339
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#RingSize)
|
|
17069
17340
|
*/
|
|
17070
17341
|
RingSize: number;
|
|
17071
17342
|
/**
|
|
17343
|
+
* Which hand this description belongs to: `None`, `Left`, or `Right`.
|
|
17344
|
+
*
|
|
17072
17345
|
* - **ThreadSafety**: ReadSafe
|
|
17073
17346
|
*
|
|
17074
17347
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Side)
|
|
17075
17348
|
*/
|
|
17076
17349
|
Side: Enum.DigitsRigDescriptionSide;
|
|
17077
17350
|
/**
|
|
17351
|
+
* The instance mapped to the proximal (first) phalanx of the thumb.
|
|
17352
|
+
*
|
|
17078
17353
|
* - **ThreadSafety**: ReadSafe
|
|
17079
17354
|
*
|
|
17080
17355
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Thumb1)
|
|
17081
17356
|
*/
|
|
17082
17357
|
Thumb1: Instance | undefined;
|
|
17083
17358
|
/**
|
|
17359
|
+
* CFrame applied to `Thumb1` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17360
|
+
*
|
|
17084
17361
|
* - **ThreadSafety**: ReadSafe
|
|
17085
17362
|
*
|
|
17086
17363
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Thumb1TposeAdjustment)
|
|
17087
17364
|
*/
|
|
17088
17365
|
Thumb1TposeAdjustment: CFrame;
|
|
17089
17366
|
/**
|
|
17367
|
+
* The instance mapped to the medial (second) phalanx of the thumb.
|
|
17368
|
+
*
|
|
17090
17369
|
* - **ThreadSafety**: ReadSafe
|
|
17091
17370
|
*
|
|
17092
17371
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Thumb2)
|
|
17093
17372
|
*/
|
|
17094
17373
|
Thumb2: Instance | undefined;
|
|
17095
17374
|
/**
|
|
17375
|
+
* CFrame applied to `Thumb2` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17376
|
+
*
|
|
17096
17377
|
* - **ThreadSafety**: ReadSafe
|
|
17097
17378
|
*
|
|
17098
17379
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Thumb2TposeAdjustment)
|
|
17099
17380
|
*/
|
|
17100
17381
|
Thumb2TposeAdjustment: CFrame;
|
|
17101
17382
|
/**
|
|
17383
|
+
* The instance mapped to the distal (third) phalanx of the thumb.
|
|
17384
|
+
*
|
|
17102
17385
|
* - **ThreadSafety**: ReadSafe
|
|
17103
17386
|
*
|
|
17104
17387
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Thumb3)
|
|
17105
17388
|
*/
|
|
17106
17389
|
Thumb3: Instance | undefined;
|
|
17107
17390
|
/**
|
|
17391
|
+
* CFrame applied to `Thumb3` to normalize the joint into its canonical T-pose orientation before retargeting or solving.
|
|
17392
|
+
*
|
|
17108
17393
|
* - **ThreadSafety**: ReadSafe
|
|
17109
17394
|
*
|
|
17110
17395
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#Thumb3TposeAdjustment)
|
|
17111
17396
|
*/
|
|
17112
17397
|
Thumb3TposeAdjustment: CFrame;
|
|
17113
17398
|
/**
|
|
17399
|
+
* Motion range vector for the thumb used by the finger solver.
|
|
17400
|
+
*
|
|
17114
17401
|
* - **ThreadSafety**: ReadSafe
|
|
17115
17402
|
*
|
|
17116
17403
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#ThumbRange)
|
|
17117
17404
|
*/
|
|
17118
17405
|
ThumbRange: Vector3;
|
|
17119
17406
|
/**
|
|
17407
|
+
* Scale factor for the thumb used by the scalable-property system.
|
|
17408
|
+
*
|
|
17120
17409
|
* - **ThreadSafety**: ReadSafe
|
|
17121
17410
|
*
|
|
17122
17411
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#ThumbSize)
|
|
17123
17412
|
*/
|
|
17124
17413
|
ThumbSize: number;
|
|
17125
17414
|
/**
|
|
17415
|
+
* Returns the current forward-kinematics control vector for the specified finger.
|
|
17416
|
+
*
|
|
17126
17417
|
* - **ThreadSafety**: Unsafe
|
|
17127
17418
|
*
|
|
17128
17419
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#GetFingerControl)
|
|
17129
17420
|
* @param this Maps the 15 phalanx joints of one hand (5 fingers, 3 joints each) and exposes forward- and inverse-kinematics helpers for controlling finger poses at runtime.
|
|
17130
|
-
* @param fingerIndex
|
|
17421
|
+
* @param fingerIndex 1-based index of the finger to query (1 = Thumb, 2 = Index, 3 = Middle, 4 = Ring, 5 = Pinky).
|
|
17422
|
+
* @returns The control `Vector3` whose X is extension [0, 1], Y is lateral rotation [-1, 1], and Z is axial rotation [-1, 1].
|
|
17131
17423
|
*/
|
|
17132
17424
|
GetFingerControl(this: DigitsRigDescription, fingerIndex: number): Vector3;
|
|
17133
17425
|
/**
|
|
17426
|
+
* Returns the world-space position of the fingertip for the specified finger.
|
|
17427
|
+
*
|
|
17134
17428
|
* - **ThreadSafety**: Unsafe
|
|
17135
17429
|
*
|
|
17136
17430
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#GetFingerTip)
|
|
17137
17431
|
* @param this Maps the 15 phalanx joints of one hand (5 fingers, 3 joints each) and exposes forward- and inverse-kinematics helpers for controlling finger poses at runtime.
|
|
17138
|
-
* @param fingerIndex
|
|
17432
|
+
* @param fingerIndex 1-based index of the finger to query (1 = Thumb, 2 = Index, 3 = Middle, 4 = Ring, 5 = Pinky).
|
|
17433
|
+
* @returns The world-space `Vector3` position of the fingertip. Currently always returns `Vector3.zero`.
|
|
17139
17434
|
*/
|
|
17140
17435
|
GetFingerTip(this: DigitsRigDescription, fingerIndex: number): Vector3;
|
|
17141
17436
|
/**
|
|
17437
|
+
* Drives the three-joint chain of the specified finger using forward kinematics.
|
|
17438
|
+
*
|
|
17142
17439
|
* - **ThreadSafety**: Unsafe
|
|
17143
17440
|
*
|
|
17144
17441
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#SetFingerControl)
|
|
17145
17442
|
* @param this Maps the 15 phalanx joints of one hand (5 fingers, 3 joints each) and exposes forward- and inverse-kinematics helpers for controlling finger poses at runtime.
|
|
17146
|
-
* @param fingerIndex
|
|
17147
|
-
* @param control
|
|
17443
|
+
* @param fingerIndex 1-based index of the finger to drive (1 = Thumb, 2 = Index, 3 = Middle, 4 = Ring, 5 = Pinky).
|
|
17444
|
+
* @param control A `Vector3` whose X sets extension [0, 1], Y sets lateral rotation [-1, 1], and Z sets axial rotation [-1, 1]; each component is clamped before application.
|
|
17148
17445
|
*/
|
|
17149
17446
|
SetFingerControl(this: DigitsRigDescription, fingerIndex: number, control: Vector3): void;
|
|
17150
17447
|
/**
|
|
17448
|
+
* Moves the fingertip of the specified finger toward a world-space target using inverse kinematics.
|
|
17449
|
+
*
|
|
17151
17450
|
* - **ThreadSafety**: Unsafe
|
|
17152
17451
|
*
|
|
17153
17452
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DigitsRigDescription#SetFingerTip)
|
|
17154
17453
|
* @param this Maps the 15 phalanx joints of one hand (5 fingers, 3 joints each) and exposes forward- and inverse-kinematics helpers for controlling finger poses at runtime.
|
|
17155
|
-
* @param fingerIndex
|
|
17156
|
-
* @param point
|
|
17454
|
+
* @param fingerIndex 1-based index of the finger to solve (1 = Thumb, 2 = Index, 3 = Middle, 4 = Ring, 5 = Pinky).
|
|
17455
|
+
* @param point World-space `Vector3` target position for the fingertip.
|
|
17157
17456
|
*/
|
|
17158
17457
|
SetFingerTip(this: DigitsRigDescription, fingerIndex: number, point: Vector3): void;
|
|
17159
17458
|
}
|
|
@@ -17539,7 +17838,8 @@ interface EulerRotationCurve extends Instance {
|
|
|
17539
17838
|
*
|
|
17540
17839
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve#GetAnglesAtTime)
|
|
17541
17840
|
* @param this Represents a 3D rotation curve through a group of three `FloatCurves`.
|
|
17542
|
-
* @param time
|
|
17841
|
+
* @param time The time, in seconds, at which to sample the three channel curves.
|
|
17842
|
+
* @returns An array of three values holding the sampled `X`, `Y`, and `Z` Euler angles; any channel whose curve is missing or has no key at `time` is returned as `nil`.
|
|
17543
17843
|
*/
|
|
17544
17844
|
GetAnglesAtTime(this: EulerRotationCurve, time: number): Array<unknown>;
|
|
17545
17845
|
/**
|
|
@@ -17549,7 +17849,8 @@ interface EulerRotationCurve extends Instance {
|
|
|
17549
17849
|
*
|
|
17550
17850
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve#GetRotationAtTime)
|
|
17551
17851
|
* @param this Represents a 3D rotation curve through a group of three `FloatCurves`.
|
|
17552
|
-
* @param time
|
|
17852
|
+
* @param time The time, in seconds, at which to sample the curve.
|
|
17853
|
+
* @returns A `CFrame` whose rotation is composed from the `X`, `Y`, and `Z` Euler angles sampled at `time`, applied in the order given by `EulerRotationCurve.RotationOrder`; empty channels are treated as zero.
|
|
17553
17854
|
*/
|
|
17554
17855
|
GetRotationAtTime(this: EulerRotationCurve, time: number): CFrame;
|
|
17555
17856
|
/**
|
|
@@ -17559,6 +17860,7 @@ interface EulerRotationCurve extends Instance {
|
|
|
17559
17860
|
*
|
|
17560
17861
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve#X)
|
|
17561
17862
|
* @param this Represents a 3D rotation curve through a group of three `FloatCurves`.
|
|
17863
|
+
* @returns The `FloatCurve` controlling the `X` Euler angle channel.
|
|
17562
17864
|
*/
|
|
17563
17865
|
X(this: EulerRotationCurve): FloatCurve;
|
|
17564
17866
|
/**
|
|
@@ -17568,6 +17870,7 @@ interface EulerRotationCurve extends Instance {
|
|
|
17568
17870
|
*
|
|
17569
17871
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve#Y)
|
|
17570
17872
|
* @param this Represents a 3D rotation curve through a group of three `FloatCurves`.
|
|
17873
|
+
* @returns The `FloatCurve` controlling the `Y` Euler angle channel.
|
|
17571
17874
|
*/
|
|
17572
17875
|
Y(this: EulerRotationCurve): FloatCurve;
|
|
17573
17876
|
/**
|
|
@@ -17577,6 +17880,7 @@ interface EulerRotationCurve extends Instance {
|
|
|
17577
17880
|
*
|
|
17578
17881
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve#Z)
|
|
17579
17882
|
* @param this Represents a 3D rotation curve through a group of three `FloatCurves`.
|
|
17883
|
+
* @returns The `FloatCurve` controlling the `Z` Euler angle channel.
|
|
17580
17884
|
*/
|
|
17581
17885
|
Z(this: EulerRotationCurve): FloatCurve;
|
|
17582
17886
|
}
|
|
@@ -17932,6 +18236,456 @@ interface FaceControls extends Instance {
|
|
|
17932
18236
|
* @deprecated
|
|
17933
18237
|
*/
|
|
17934
18238
|
readonly _nominal_FaceControls: unique symbol;
|
|
18239
|
+
/**
|
|
18240
|
+
* Raises the chin up; moves the lower lip upwards.
|
|
18241
|
+
*
|
|
18242
|
+
* - **ThreadSafety**: ReadSafe
|
|
18243
|
+
* - **Tags**: NotReplicated
|
|
18244
|
+
*
|
|
18245
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#ChinRaiser)
|
|
18246
|
+
*/
|
|
18247
|
+
ChinRaiser: number;
|
|
18248
|
+
/**
|
|
18249
|
+
* Moves the upper lip when ChinRaiser is engaged and touching the upper lip.
|
|
18250
|
+
*
|
|
18251
|
+
* - **ThreadSafety**: ReadSafe
|
|
18252
|
+
* - **Tags**: NotReplicated
|
|
18253
|
+
*
|
|
18254
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#ChinRaiserUpperLip)
|
|
18255
|
+
*/
|
|
18256
|
+
ChinRaiserUpperLip: number;
|
|
18257
|
+
/**
|
|
18258
|
+
* Brings the left and right brows inward together.
|
|
18259
|
+
*
|
|
18260
|
+
* - **ThreadSafety**: ReadSafe
|
|
18261
|
+
* - **Tags**: NotReplicated
|
|
18262
|
+
*
|
|
18263
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#Corrugator)
|
|
18264
|
+
*/
|
|
18265
|
+
Corrugator: number;
|
|
18266
|
+
/**
|
|
18267
|
+
* Moves gaze down. This is a required pose for avatars.
|
|
18268
|
+
*
|
|
18269
|
+
* - **ThreadSafety**: ReadSafe
|
|
18270
|
+
* - **Tags**: NotReplicated
|
|
18271
|
+
*
|
|
18272
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#EyesLookDown)
|
|
18273
|
+
*/
|
|
18274
|
+
EyesLookDown: number;
|
|
18275
|
+
/**
|
|
18276
|
+
* Moves gaze left. This is a required pose for avatars.
|
|
18277
|
+
*
|
|
18278
|
+
* - **ThreadSafety**: ReadSafe
|
|
18279
|
+
* - **Tags**: NotReplicated
|
|
18280
|
+
*
|
|
18281
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#EyesLookLeft)
|
|
18282
|
+
*/
|
|
18283
|
+
EyesLookLeft: number;
|
|
18284
|
+
/**
|
|
18285
|
+
* Moves gaze right. This is a required pose for avatars.
|
|
18286
|
+
*
|
|
18287
|
+
* - **ThreadSafety**: ReadSafe
|
|
18288
|
+
* - **Tags**: NotReplicated
|
|
18289
|
+
*
|
|
18290
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#EyesLookRight)
|
|
18291
|
+
*/
|
|
18292
|
+
EyesLookRight: number;
|
|
18293
|
+
/**
|
|
18294
|
+
* Moves gaze up. This is a required pose for avatars.
|
|
18295
|
+
*
|
|
18296
|
+
* - **ThreadSafety**: ReadSafe
|
|
18297
|
+
* - **Tags**: NotReplicated
|
|
18298
|
+
*
|
|
18299
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#EyesLookUp)
|
|
18300
|
+
*/
|
|
18301
|
+
EyesLookUp: number;
|
|
18302
|
+
/**
|
|
18303
|
+
* Also known as lip tightener; brings the corners of the mouth inward and pressing the lips back against the teeth.
|
|
18304
|
+
*
|
|
18305
|
+
* - **ThreadSafety**: ReadSafe
|
|
18306
|
+
* - **Tags**: NotReplicated
|
|
18307
|
+
*
|
|
18308
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#FlatPucker)
|
|
18309
|
+
*/
|
|
18310
|
+
FlatPucker: number;
|
|
18311
|
+
/**
|
|
18312
|
+
* Makes a 'O' shape with the mouth.
|
|
18313
|
+
*
|
|
18314
|
+
* - **ThreadSafety**: ReadSafe
|
|
18315
|
+
* - **Tags**: NotReplicated
|
|
18316
|
+
*
|
|
18317
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#Funneler)
|
|
18318
|
+
*/
|
|
18319
|
+
Funneler: number;
|
|
18320
|
+
/**
|
|
18321
|
+
* Lowers the jaw downward opening the mouth. This is a required pose for avatars.
|
|
18322
|
+
*
|
|
18323
|
+
* - **ThreadSafety**: ReadSafe
|
|
18324
|
+
* - **Tags**: NotReplicated
|
|
18325
|
+
*
|
|
18326
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#JawDrop)
|
|
18327
|
+
*/
|
|
18328
|
+
JawDrop: number;
|
|
18329
|
+
/**
|
|
18330
|
+
* Moves mouth and jaw to the left (character left).
|
|
18331
|
+
*
|
|
18332
|
+
* - **ThreadSafety**: ReadSafe
|
|
18333
|
+
* - **Tags**: NotReplicated
|
|
18334
|
+
*
|
|
18335
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#JawLeft)
|
|
18336
|
+
*/
|
|
18337
|
+
JawLeft: number;
|
|
18338
|
+
/**
|
|
18339
|
+
* Moves mouth and jaw to the right (character right).
|
|
18340
|
+
*
|
|
18341
|
+
* - **ThreadSafety**: ReadSafe
|
|
18342
|
+
* - **Tags**: NotReplicated
|
|
18343
|
+
*
|
|
18344
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#JawRight)
|
|
18345
|
+
*/
|
|
18346
|
+
JawRight: number;
|
|
18347
|
+
/**
|
|
18348
|
+
* Lowers the left brow down.
|
|
18349
|
+
*
|
|
18350
|
+
* - **ThreadSafety**: ReadSafe
|
|
18351
|
+
* - **Tags**: NotReplicated
|
|
18352
|
+
*
|
|
18353
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftBrowLowerer)
|
|
18354
|
+
*/
|
|
18355
|
+
LeftBrowLowerer: number;
|
|
18356
|
+
/**
|
|
18357
|
+
* Puffs up the left cheek.
|
|
18358
|
+
*
|
|
18359
|
+
* - **ThreadSafety**: ReadSafe
|
|
18360
|
+
* - **Tags**: NotReplicated
|
|
18361
|
+
*
|
|
18362
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftCheekPuff)
|
|
18363
|
+
*/
|
|
18364
|
+
LeftCheekPuff: number;
|
|
18365
|
+
/**
|
|
18366
|
+
* Squints the left eye.
|
|
18367
|
+
*
|
|
18368
|
+
* - **ThreadSafety**: ReadSafe
|
|
18369
|
+
* - **Tags**: NotReplicated
|
|
18370
|
+
*
|
|
18371
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftCheekRaiser)
|
|
18372
|
+
*/
|
|
18373
|
+
LeftCheekRaiser: number;
|
|
18374
|
+
/**
|
|
18375
|
+
* Moves the corners of the mouth back in Z.
|
|
18376
|
+
*
|
|
18377
|
+
* - **ThreadSafety**: ReadSafe
|
|
18378
|
+
* - **Tags**: NotReplicated
|
|
18379
|
+
*
|
|
18380
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftDimpler)
|
|
18381
|
+
*/
|
|
18382
|
+
LeftDimpler: number;
|
|
18383
|
+
/**
|
|
18384
|
+
* Closes the left eyelid. This is a required pose for avatars.
|
|
18385
|
+
*
|
|
18386
|
+
* - **ThreadSafety**: ReadSafe
|
|
18387
|
+
* - **Tags**: NotReplicated
|
|
18388
|
+
*
|
|
18389
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftEyeClosed)
|
|
18390
|
+
*/
|
|
18391
|
+
LeftEyeClosed: number;
|
|
18392
|
+
/**
|
|
18393
|
+
* Raises the left eyelid upwards to reveal more of the eye white above the iris.
|
|
18394
|
+
*
|
|
18395
|
+
* - **ThreadSafety**: ReadSafe
|
|
18396
|
+
* - **Tags**: NotReplicated
|
|
18397
|
+
*
|
|
18398
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftEyeUpperLidRaiser)
|
|
18399
|
+
*/
|
|
18400
|
+
LeftEyeUpperLidRaiser: number;
|
|
18401
|
+
/**
|
|
18402
|
+
* Raises the interior half of the left brow upwards.
|
|
18403
|
+
*
|
|
18404
|
+
* - **ThreadSafety**: ReadSafe
|
|
18405
|
+
* - **Tags**: NotReplicated
|
|
18406
|
+
*
|
|
18407
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftInnerBrowRaiser)
|
|
18408
|
+
*/
|
|
18409
|
+
LeftInnerBrowRaiser: number;
|
|
18410
|
+
/**
|
|
18411
|
+
* Lowers the corners of the mouth downwards in a frown.
|
|
18412
|
+
*
|
|
18413
|
+
* - **ThreadSafety**: ReadSafe
|
|
18414
|
+
* - **Tags**: NotReplicated
|
|
18415
|
+
*
|
|
18416
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftLipCornerDown)
|
|
18417
|
+
*/
|
|
18418
|
+
LeftLipCornerDown: number;
|
|
18419
|
+
/**
|
|
18420
|
+
* Raises the corners of the mouth upwards in a smile. This is a required pose for avatars.
|
|
18421
|
+
*
|
|
18422
|
+
* - **ThreadSafety**: ReadSafe
|
|
18423
|
+
* - **Tags**: NotReplicated
|
|
18424
|
+
*
|
|
18425
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftLipCornerPuller)
|
|
18426
|
+
*/
|
|
18427
|
+
LeftLipCornerPuller: number;
|
|
18428
|
+
/**
|
|
18429
|
+
* Stretches the corners of the mouth apart. This is a required pose for avatars.
|
|
18430
|
+
*
|
|
18431
|
+
* - **ThreadSafety**: ReadSafe
|
|
18432
|
+
* - **Tags**: NotReplicated
|
|
18433
|
+
*
|
|
18434
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftLipStretcher)
|
|
18435
|
+
*/
|
|
18436
|
+
LeftLipStretcher: number;
|
|
18437
|
+
/**
|
|
18438
|
+
* Lowers the lower lip down away from the upper lip revealing the lower teeth. This is a required pose for avatars.
|
|
18439
|
+
*
|
|
18440
|
+
* - **ThreadSafety**: ReadSafe
|
|
18441
|
+
* - **Tags**: NotReplicated
|
|
18442
|
+
*
|
|
18443
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftLowerLipDepressor)
|
|
18444
|
+
*/
|
|
18445
|
+
LeftLowerLipDepressor: number;
|
|
18446
|
+
/**
|
|
18447
|
+
* Raise the left nostril, pulls the brow down slightly, and wrinkles on the side of the nose.
|
|
18448
|
+
*
|
|
18449
|
+
* - **ThreadSafety**: ReadSafe
|
|
18450
|
+
* - **Tags**: NotReplicated
|
|
18451
|
+
*
|
|
18452
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftNoseWrinkler)
|
|
18453
|
+
*/
|
|
18454
|
+
LeftNoseWrinkler: number;
|
|
18455
|
+
/**
|
|
18456
|
+
* Raises the outer part of the left brow upwards.
|
|
18457
|
+
*
|
|
18458
|
+
* - **ThreadSafety**: ReadSafe
|
|
18459
|
+
* - **Tags**: NotReplicated
|
|
18460
|
+
*
|
|
18461
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftOuterBrowRaiser)
|
|
18462
|
+
*/
|
|
18463
|
+
LeftOuterBrowRaiser: number;
|
|
18464
|
+
/**
|
|
18465
|
+
* Raises the left upper lip away from the lower lip revealing the upper teeth. This is a required pose for avatars.
|
|
18466
|
+
*
|
|
18467
|
+
* - **ThreadSafety**: ReadSafe
|
|
18468
|
+
* - **Tags**: NotReplicated
|
|
18469
|
+
*
|
|
18470
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftUpperLipRaiser)
|
|
18471
|
+
*/
|
|
18472
|
+
LeftUpperLipRaiser: number;
|
|
18473
|
+
/**
|
|
18474
|
+
* Presses the lips together.
|
|
18475
|
+
*
|
|
18476
|
+
* - **ThreadSafety**: ReadSafe
|
|
18477
|
+
* - **Tags**: NotReplicated
|
|
18478
|
+
*
|
|
18479
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LipPresser)
|
|
18480
|
+
*/
|
|
18481
|
+
LipPresser: number;
|
|
18482
|
+
/**
|
|
18483
|
+
* Brings the lips together relative to JawDrop. This is a required pose for avatars.
|
|
18484
|
+
*
|
|
18485
|
+
* - **ThreadSafety**: ReadSafe
|
|
18486
|
+
* - **Tags**: NotReplicated
|
|
18487
|
+
*
|
|
18488
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LipsTogether)
|
|
18489
|
+
*/
|
|
18490
|
+
LipsTogether: number;
|
|
18491
|
+
/**
|
|
18492
|
+
* Rolls the lower lip up over the teeth.
|
|
18493
|
+
*
|
|
18494
|
+
* - **ThreadSafety**: ReadSafe
|
|
18495
|
+
* - **Tags**: NotReplicated
|
|
18496
|
+
*
|
|
18497
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#LowerLipSuck)
|
|
18498
|
+
*/
|
|
18499
|
+
LowerLipSuck: number;
|
|
18500
|
+
/**
|
|
18501
|
+
* Moves the mouth left.
|
|
18502
|
+
*
|
|
18503
|
+
* - **ThreadSafety**: ReadSafe
|
|
18504
|
+
* - **Tags**: NotReplicated
|
|
18505
|
+
*
|
|
18506
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#MouthLeft)
|
|
18507
|
+
*/
|
|
18508
|
+
MouthLeft: number;
|
|
18509
|
+
/**
|
|
18510
|
+
* Moves the mouth right.
|
|
18511
|
+
*
|
|
18512
|
+
* - **ThreadSafety**: ReadSafe
|
|
18513
|
+
* - **Tags**: NotReplicated
|
|
18514
|
+
*
|
|
18515
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#MouthRight)
|
|
18516
|
+
*/
|
|
18517
|
+
MouthRight: number;
|
|
18518
|
+
/**
|
|
18519
|
+
* Makes a kiss-like shape with the mouth. This is a required pose for avatars.
|
|
18520
|
+
*
|
|
18521
|
+
* - **ThreadSafety**: ReadSafe
|
|
18522
|
+
* - **Tags**: NotReplicated
|
|
18523
|
+
*
|
|
18524
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#Pucker)
|
|
18525
|
+
*/
|
|
18526
|
+
Pucker: number;
|
|
18527
|
+
/**
|
|
18528
|
+
* Lowers the right brow down.
|
|
18529
|
+
*
|
|
18530
|
+
* - **ThreadSafety**: ReadSafe
|
|
18531
|
+
* - **Tags**: NotReplicated
|
|
18532
|
+
*
|
|
18533
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightBrowLowerer)
|
|
18534
|
+
*/
|
|
18535
|
+
RightBrowLowerer: number;
|
|
18536
|
+
/**
|
|
18537
|
+
* Puffs up the right cheek.
|
|
18538
|
+
*
|
|
18539
|
+
* - **ThreadSafety**: ReadSafe
|
|
18540
|
+
* - **Tags**: NotReplicated
|
|
18541
|
+
*
|
|
18542
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightCheekPuff)
|
|
18543
|
+
*/
|
|
18544
|
+
RightCheekPuff: number;
|
|
18545
|
+
/**
|
|
18546
|
+
* Squints the right eye.
|
|
18547
|
+
*
|
|
18548
|
+
* - **ThreadSafety**: ReadSafe
|
|
18549
|
+
* - **Tags**: NotReplicated
|
|
18550
|
+
*
|
|
18551
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightCheekRaiser)
|
|
18552
|
+
*/
|
|
18553
|
+
RightCheekRaiser: number;
|
|
18554
|
+
/**
|
|
18555
|
+
* Moves the corners of the mouth back in Z.
|
|
18556
|
+
*
|
|
18557
|
+
* - **ThreadSafety**: ReadSafe
|
|
18558
|
+
* - **Tags**: NotReplicated
|
|
18559
|
+
*
|
|
18560
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightDimpler)
|
|
18561
|
+
*/
|
|
18562
|
+
RightDimpler: number;
|
|
18563
|
+
/**
|
|
18564
|
+
* Closes the right eyelid. This is a required pose for avatars.
|
|
18565
|
+
*
|
|
18566
|
+
* - **ThreadSafety**: ReadSafe
|
|
18567
|
+
* - **Tags**: NotReplicated
|
|
18568
|
+
*
|
|
18569
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightEyeClosed)
|
|
18570
|
+
*/
|
|
18571
|
+
RightEyeClosed: number;
|
|
18572
|
+
/**
|
|
18573
|
+
* Raises the right eyelid upwards to reveal more of the eye white above the iris.
|
|
18574
|
+
*
|
|
18575
|
+
* - **ThreadSafety**: ReadSafe
|
|
18576
|
+
* - **Tags**: NotReplicated
|
|
18577
|
+
*
|
|
18578
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightEyeUpperLidRaiser)
|
|
18579
|
+
*/
|
|
18580
|
+
RightEyeUpperLidRaiser: number;
|
|
18581
|
+
/**
|
|
18582
|
+
* Raises the interior half of the right brow upwards.
|
|
18583
|
+
*
|
|
18584
|
+
* - **ThreadSafety**: ReadSafe
|
|
18585
|
+
* - **Tags**: NotReplicated
|
|
18586
|
+
*
|
|
18587
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightInnerBrowRaiser)
|
|
18588
|
+
*/
|
|
18589
|
+
RightInnerBrowRaiser: number;
|
|
18590
|
+
/**
|
|
18591
|
+
* Lowers the corners of the mouth downwards in a frown.
|
|
18592
|
+
*
|
|
18593
|
+
* - **ThreadSafety**: ReadSafe
|
|
18594
|
+
* - **Tags**: NotReplicated
|
|
18595
|
+
*
|
|
18596
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightLipCornerDown)
|
|
18597
|
+
*/
|
|
18598
|
+
RightLipCornerDown: number;
|
|
18599
|
+
/**
|
|
18600
|
+
* Raises the corners of the mouth upwards in a smile. This is a required pose for avatars.
|
|
18601
|
+
*
|
|
18602
|
+
* - **ThreadSafety**: ReadSafe
|
|
18603
|
+
* - **Tags**: NotReplicated
|
|
18604
|
+
*
|
|
18605
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightLipCornerPuller)
|
|
18606
|
+
*/
|
|
18607
|
+
RightLipCornerPuller: number;
|
|
18608
|
+
/**
|
|
18609
|
+
* Stretches the corners of the mouth apart. This is a required pose for avatars.
|
|
18610
|
+
*
|
|
18611
|
+
* - **ThreadSafety**: ReadSafe
|
|
18612
|
+
* - **Tags**: NotReplicated
|
|
18613
|
+
*
|
|
18614
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightLipStretcher)
|
|
18615
|
+
*/
|
|
18616
|
+
RightLipStretcher: number;
|
|
18617
|
+
/**
|
|
18618
|
+
* Lowers the lower lip down away from the upper lip revealing the lower teeth. This is a required pose for avatars.
|
|
18619
|
+
*
|
|
18620
|
+
* - **ThreadSafety**: ReadSafe
|
|
18621
|
+
* - **Tags**: NotReplicated
|
|
18622
|
+
*
|
|
18623
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightLowerLipDepressor)
|
|
18624
|
+
*/
|
|
18625
|
+
RightLowerLipDepressor: number;
|
|
18626
|
+
/**
|
|
18627
|
+
* Raises the right nostril, pulls the brow down slightly, and wrinkles on the side of the nose.
|
|
18628
|
+
*
|
|
18629
|
+
* - **ThreadSafety**: ReadSafe
|
|
18630
|
+
* - **Tags**: NotReplicated
|
|
18631
|
+
*
|
|
18632
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightNoseWrinkler)
|
|
18633
|
+
*/
|
|
18634
|
+
RightNoseWrinkler: number;
|
|
18635
|
+
/**
|
|
18636
|
+
* Raises the outer part of the right brow upwards.
|
|
18637
|
+
*
|
|
18638
|
+
* - **ThreadSafety**: ReadSafe
|
|
18639
|
+
* - **Tags**: NotReplicated
|
|
18640
|
+
*
|
|
18641
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightOuterBrowRaiser)
|
|
18642
|
+
*/
|
|
18643
|
+
RightOuterBrowRaiser: number;
|
|
18644
|
+
/**
|
|
18645
|
+
* Raises the right upper lip away from the lower lip revealing the upper teeth. This is a required pose for avatars.
|
|
18646
|
+
*
|
|
18647
|
+
* - **ThreadSafety**: ReadSafe
|
|
18648
|
+
* - **Tags**: NotReplicated
|
|
18649
|
+
*
|
|
18650
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightUpperLipRaiser)
|
|
18651
|
+
*/
|
|
18652
|
+
RightUpperLipRaiser: number;
|
|
18653
|
+
/**
|
|
18654
|
+
* Bends the tongue down.
|
|
18655
|
+
*
|
|
18656
|
+
* - **ThreadSafety**: ReadSafe
|
|
18657
|
+
* - **Tags**: NotReplicated
|
|
18658
|
+
*
|
|
18659
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#TongueDown)
|
|
18660
|
+
*/
|
|
18661
|
+
TongueDown: number;
|
|
18662
|
+
/**
|
|
18663
|
+
* Extends the tip of the tongue out of the mouth.
|
|
18664
|
+
*
|
|
18665
|
+
* - **ThreadSafety**: ReadSafe
|
|
18666
|
+
* - **Tags**: NotReplicated
|
|
18667
|
+
*
|
|
18668
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#TongueOut)
|
|
18669
|
+
*/
|
|
18670
|
+
TongueOut: number;
|
|
18671
|
+
/**
|
|
18672
|
+
* Bends the tongue up.
|
|
18673
|
+
*
|
|
18674
|
+
* - **ThreadSafety**: ReadSafe
|
|
18675
|
+
* - **Tags**: NotReplicated
|
|
18676
|
+
*
|
|
18677
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#TongueUp)
|
|
18678
|
+
*/
|
|
18679
|
+
TongueUp: number;
|
|
18680
|
+
/**
|
|
18681
|
+
* Rolls the upper lip around the teeth.
|
|
18682
|
+
*
|
|
18683
|
+
* - **ThreadSafety**: ReadSafe
|
|
18684
|
+
* - **Tags**: NotReplicated
|
|
18685
|
+
*
|
|
18686
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FaceControls#UpperLipSuck)
|
|
18687
|
+
*/
|
|
18688
|
+
UpperLipSuck: number;
|
|
17935
18689
|
}
|
|
17936
18690
|
/**
|
|
17937
18691
|
* An abstract class from which the `Decal` and `Texture` classes inherit.
|
|
@@ -18486,7 +19240,8 @@ interface FloatCurve extends Instance {
|
|
|
18486
19240
|
*
|
|
18487
19241
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FloatCurve#GetKeyAtIndex)
|
|
18488
19242
|
* @param this A sorted list of time-value pairs that define a curve. Used to animate a single numerical value.
|
|
18489
|
-
* @param index
|
|
19243
|
+
* @param index One-based index of the key to retrieve.
|
|
19244
|
+
* @returns Copy of the `FloatCurveKey` stored at `index`.
|
|
18490
19245
|
*/
|
|
18491
19246
|
GetKeyAtIndex(this: FloatCurve, index: number): FloatCurveKey;
|
|
18492
19247
|
/**
|
|
@@ -18496,7 +19251,8 @@ interface FloatCurve extends Instance {
|
|
|
18496
19251
|
*
|
|
18497
19252
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FloatCurve#GetKeyIndicesAtTime)
|
|
18498
19253
|
* @param this A sorted list of time-value pairs that define a curve. Used to animate a single numerical value.
|
|
18499
|
-
* @param time
|
|
19254
|
+
* @param time Time value to locate within the curve's sorted keys.
|
|
19255
|
+
* @returns Array of two one-based indices that bracket `time`: the last key at or before `time` and the first key at or after it.
|
|
18500
19256
|
*/
|
|
18501
19257
|
GetKeyIndicesAtTime(this: FloatCurve, time: number): [
|
|
18502
19258
|
before: number,
|
|
@@ -18597,7 +19353,7 @@ interface GeneratedFolder extends Folder {
|
|
|
18597
19353
|
*
|
|
18598
19354
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeneratedFolder#SetPrimaryPart)
|
|
18599
19355
|
* @param this A container that stores `ProceduralModel` generation results.
|
|
18600
|
-
* @param part
|
|
19356
|
+
* @param part The `BasePart` inside this `GeneratedFolder` to designate as the `PrimaryPart` of the resulting `ProceduralModel`.
|
|
18601
19357
|
*/
|
|
18602
19358
|
SetPrimaryPart(this: GeneratedFolder, part: BasePart): void;
|
|
18603
19359
|
}
|
|
@@ -18798,10 +19554,17 @@ interface GenerationService extends Instance {
|
|
|
18798
19554
|
*/
|
|
18799
19555
|
LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
|
|
18800
19556
|
/**
|
|
19557
|
+
* Segments an existing `MeshPart` into multiple named parts according to a provided schema, returning a `Model` organized by the schema groups.
|
|
19558
|
+
*
|
|
18801
19559
|
* - **ThreadSafety**: Unsafe
|
|
18802
19560
|
* - **Tags**: Yields
|
|
18803
19561
|
*
|
|
18804
19562
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#SegmentMeshAsync)
|
|
19563
|
+
* @param this Service that allows developers to generate 3D objects from text prompts.
|
|
19564
|
+
* @param meshPart The `MeshPart` to segment. Must contain mesh geometry (either an `EditableMesh` or a published mesh asset the caller has edit permission for).
|
|
19565
|
+
* @param schema A table specifying how to segment the mesh. Provide exactly one of `PredefinedSchema` (a string such as `"Car5"` or `"Body1"`) or `SchemaDefinition` (a table with a `Groups` array of part-name strings defining the segmentation structure).
|
|
19566
|
+
* @param options Has no effect.
|
|
19567
|
+
* @returns A tuple containing a `Model` whose children are organized according to the specified schema (each group as a child `Model` with a `MeshPart` inside), and a table with a `UUID` key holding the backend job identifier.
|
|
18805
19568
|
*/
|
|
18806
19569
|
SegmentMeshAsync(this: GenerationService, meshPart: MeshPart, schema: object, options?: object): unknown;
|
|
18807
19570
|
/**
|
|
@@ -18894,9 +19657,9 @@ interface GeometryService extends Instance {
|
|
|
18894
19657
|
/**
|
|
18895
19658
|
* - **ThreadSafety**: Unsafe
|
|
18896
19659
|
*
|
|
18897
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeometryService#
|
|
19660
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeometryService#CreateBasicMeshPart)
|
|
18898
19661
|
*/
|
|
18899
|
-
|
|
19662
|
+
CreateBasicMeshPart(this: GeometryService, shape: CastsToEnum<Enum.BasicMeshPartShape>, options?: object): MeshPart;
|
|
18900
19663
|
/**
|
|
18901
19664
|
* Provides an array of positions which can easily be passed into `FragmentAsync` to perform simple types of destruction.
|
|
18902
19665
|
*
|
|
@@ -19712,6 +20475,7 @@ interface GuiObject extends GuiBase2d {
|
|
|
19712
20475
|
* Controls whether, and how, the `GuiObject` sinks input that occurs over it.
|
|
19713
20476
|
*
|
|
19714
20477
|
* - **ThreadSafety**: ReadSafe
|
|
20478
|
+
* - **Tags**: NotReplicated
|
|
19715
20479
|
*
|
|
19716
20480
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiObject#InputSink)
|
|
19717
20481
|
*/
|
|
@@ -21340,6 +22104,8 @@ interface TextBox extends GuiObject {
|
|
|
21340
22104
|
*/
|
|
21341
22105
|
ClearTextOnFocus: boolean;
|
|
21342
22106
|
/**
|
|
22107
|
+
* A copy of `TextBox.Text` that contains exactly what is being rendered by the `TextBox`.
|
|
22108
|
+
*
|
|
21343
22109
|
* - **ThreadSafety**: ReadSafe
|
|
21344
22110
|
* - **Tags**: NotReplicated
|
|
21345
22111
|
*
|
|
@@ -21409,12 +22175,16 @@ interface TextBox extends GuiObject {
|
|
|
21409
22175
|
*/
|
|
21410
22176
|
MultiLine: boolean;
|
|
21411
22177
|
/**
|
|
22178
|
+
* Applies OpenType typographic features to the text rendered by the `TextBox`.
|
|
22179
|
+
*
|
|
21412
22180
|
* - **ThreadSafety**: ReadSafe
|
|
21413
22181
|
*
|
|
21414
22182
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#OpenTypeFeatures)
|
|
21415
22183
|
*/
|
|
21416
22184
|
OpenTypeFeatures: string;
|
|
21417
22185
|
/**
|
|
22186
|
+
* Read-only property that describes why the `TextBox.OpenTypeFeatures` string could not be applied.
|
|
22187
|
+
*
|
|
21418
22188
|
* - **ThreadSafety**: ReadSafe
|
|
21419
22189
|
* - **Tags**: NotReplicated
|
|
21420
22190
|
*
|
|
@@ -21498,6 +22268,8 @@ interface TextBox extends GuiObject {
|
|
|
21498
22268
|
*/
|
|
21499
22269
|
TextColor3: Color3;
|
|
21500
22270
|
/**
|
|
22271
|
+
* Direction in which the text is rendered.
|
|
22272
|
+
*
|
|
21501
22273
|
* - **ThreadSafety**: ReadSafe
|
|
21502
22274
|
*
|
|
21503
22275
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#TextDirection)
|
|
@@ -21613,12 +22385,13 @@ interface TextBox extends GuiObject {
|
|
|
21613
22385
|
*/
|
|
21614
22386
|
CaptureFocus(this: TextBox): void;
|
|
21615
22387
|
/**
|
|
21616
|
-
*
|
|
22388
|
+
* Whether the TextBox currently has focus.
|
|
21617
22389
|
*
|
|
21618
22390
|
* - **ThreadSafety**: Unsafe
|
|
21619
22391
|
*
|
|
21620
22392
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#IsFocused)
|
|
21621
22393
|
* @param this A 2D user interface element that displays player-editable text.
|
|
22394
|
+
* @returns Returns `true` if the `TextBox` is focused or `false` if it is not.
|
|
21622
22395
|
*/
|
|
21623
22396
|
IsFocused(this: TextBox): boolean;
|
|
21624
22397
|
/**
|
|
@@ -21628,7 +22401,7 @@ interface TextBox extends GuiObject {
|
|
|
21628
22401
|
*
|
|
21629
22402
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#ReleaseFocus)
|
|
21630
22403
|
* @param this A 2D user interface element that displays player-editable text.
|
|
21631
|
-
* @param submitted
|
|
22404
|
+
* @param submitted Whether the `TextBox.FocusLost` event's `enterPressed` parameter reports `true`, as if the player pressed Enter to submit text. Defaults to `false`.
|
|
21632
22405
|
*/
|
|
21633
22406
|
ReleaseFocus(this: TextBox, submitted?: boolean): void;
|
|
21634
22407
|
/**
|
|
@@ -21670,12 +22443,24 @@ interface TextChannelWindow extends GuiObject {
|
|
|
21670
22443
|
* @deprecated
|
|
21671
22444
|
*/
|
|
21672
22445
|
readonly _nominal_TextChannelWindow: unique symbol;
|
|
22446
|
+
/**
|
|
22447
|
+
* - **ThreadSafety**: ReadSafe
|
|
22448
|
+
*
|
|
22449
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChannelWindow#FontFace)
|
|
22450
|
+
*/
|
|
22451
|
+
FontFace: Font;
|
|
21673
22452
|
/**
|
|
21674
22453
|
* - **ThreadSafety**: ReadSafe
|
|
21675
22454
|
*
|
|
21676
22455
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChannelWindow#Target)
|
|
21677
22456
|
*/
|
|
21678
22457
|
Target: TextChannel | undefined;
|
|
22458
|
+
/**
|
|
22459
|
+
* - **ThreadSafety**: ReadSafe
|
|
22460
|
+
*
|
|
22461
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChannelWindow#UseDefaultFont)
|
|
22462
|
+
*/
|
|
22463
|
+
UseDefaultFont: boolean;
|
|
21679
22464
|
}
|
|
21680
22465
|
/**
|
|
21681
22466
|
* A GUI object that displays video content from a connected `VideoPlayer`.
|
|
@@ -22851,6 +23636,8 @@ interface BoxHandleAdornment extends HandleAdornment {
|
|
|
22851
23636
|
*/
|
|
22852
23637
|
readonly _nominal_BoxHandleAdornment: unique symbol;
|
|
22853
23638
|
/**
|
|
23639
|
+
* Determines how the box adornment is shaded and whether it draws through geometry that would otherwise occlude it.
|
|
23640
|
+
*
|
|
22854
23641
|
* - **ThreadSafety**: ReadSafe
|
|
22855
23642
|
*
|
|
22856
23643
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BoxHandleAdornment#Shading)
|
|
@@ -22888,6 +23675,8 @@ interface ConeHandleAdornment extends HandleAdornment {
|
|
|
22888
23675
|
*/
|
|
22889
23676
|
Height: number;
|
|
22890
23677
|
/**
|
|
23678
|
+
* Determines whether the cone is drawn as a hollow shell rather than a solid, capped cone.
|
|
23679
|
+
*
|
|
22891
23680
|
* - **ThreadSafety**: ReadSafe
|
|
22892
23681
|
*
|
|
22893
23682
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConeHandleAdornment#Hollow)
|
|
@@ -22902,6 +23691,8 @@ interface ConeHandleAdornment extends HandleAdornment {
|
|
|
22902
23691
|
*/
|
|
22903
23692
|
Radius: number;
|
|
22904
23693
|
/**
|
|
23694
|
+
* Determines how the cone adornment is shaded and whether it draws through geometry that would otherwise occlude it.
|
|
23695
|
+
*
|
|
22905
23696
|
* - **ThreadSafety**: ReadSafe
|
|
22906
23697
|
*
|
|
22907
23698
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConeHandleAdornment#Shading)
|
|
@@ -22955,6 +23746,8 @@ interface CylinderHandleAdornment extends HandleAdornment {
|
|
|
22955
23746
|
*/
|
|
22956
23747
|
Radius: number;
|
|
22957
23748
|
/**
|
|
23749
|
+
* Determines how the cylinder adornment is shaded and whether it draws through geometry that would otherwise occlude it.
|
|
23750
|
+
*
|
|
22958
23751
|
* - **ThreadSafety**: ReadSafe
|
|
22959
23752
|
*
|
|
22960
23753
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CylinderHandleAdornment#Shading)
|
|
@@ -22984,6 +23777,8 @@ interface ImageHandleAdornment extends HandleAdornment {
|
|
|
22984
23777
|
*/
|
|
22985
23778
|
Image: ContentId;
|
|
22986
23779
|
/**
|
|
23780
|
+
* The image content displayed by this adornment.
|
|
23781
|
+
*
|
|
22987
23782
|
* - **ThreadSafety**: ReadSafe
|
|
22988
23783
|
*
|
|
22989
23784
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageHandleAdornment#ImageContent)
|
|
@@ -23052,6 +23847,8 @@ interface PyramidHandleAdornment extends HandleAdornment {
|
|
|
23052
23847
|
*/
|
|
23053
23848
|
Height: number;
|
|
23054
23849
|
/**
|
|
23850
|
+
* The `AdornShading` mode that controls shading and whether the pyramid draws through occluding geometry.
|
|
23851
|
+
*
|
|
23055
23852
|
* - **ThreadSafety**: ReadSafe
|
|
23056
23853
|
*
|
|
23057
23854
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PyramidHandleAdornment#Shading)
|
|
@@ -23097,6 +23894,8 @@ interface SphereHandleAdornment extends HandleAdornment {
|
|
|
23097
23894
|
*/
|
|
23098
23895
|
Radius: number;
|
|
23099
23896
|
/**
|
|
23897
|
+
* Determines how the sphere adornment is shaded and whether it draws through geometry that would otherwise occlude it.
|
|
23898
|
+
*
|
|
23100
23899
|
* - **ThreadSafety**: ReadSafe
|
|
23101
23900
|
*
|
|
23102
23901
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SphereHandleAdornment#Shading)
|
|
@@ -23525,6 +24324,8 @@ interface SelectionPointLasso extends SelectionLasso {
|
|
|
23525
24324
|
Point: Vector3;
|
|
23526
24325
|
}
|
|
23527
24326
|
/**
|
|
24327
|
+
* Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
24328
|
+
*
|
|
23528
24329
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D)
|
|
23529
24330
|
*/
|
|
23530
24331
|
interface Path2D extends GuiBase {
|
|
@@ -23582,7 +24383,8 @@ interface Path2D extends GuiBase {
|
|
|
23582
24383
|
* - **ThreadSafety**: Unsafe
|
|
23583
24384
|
*
|
|
23584
24385
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#GetBoundingRect)
|
|
23585
|
-
* @param this
|
|
24386
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
24387
|
+
* @returns The `Rect` bounding box that encloses the path, expanded by its rendered thickness.
|
|
23586
24388
|
*/
|
|
23587
24389
|
GetBoundingRect(this: Path2D): Rect;
|
|
23588
24390
|
/**
|
|
@@ -23591,8 +24393,8 @@ interface Path2D extends GuiBase {
|
|
|
23591
24393
|
* - **ThreadSafety**: Unsafe
|
|
23592
24394
|
*
|
|
23593
24395
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#GetControlPoint)
|
|
23594
|
-
* @param this
|
|
23595
|
-
* @param index
|
|
24396
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
24397
|
+
* @param index The 1-based index of the control point to return.
|
|
23596
24398
|
* @returns The control point at the given index.
|
|
23597
24399
|
*/
|
|
23598
24400
|
GetControlPoint(this: Path2D, index: number): Path2DControlPoint;
|
|
@@ -23602,7 +24404,7 @@ interface Path2D extends GuiBase {
|
|
|
23602
24404
|
* - **ThreadSafety**: Unsafe
|
|
23603
24405
|
*
|
|
23604
24406
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#GetControlPoints)
|
|
23605
|
-
* @param this
|
|
24407
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
23606
24408
|
* @returns Table of all the `Path2DControlPoints`.
|
|
23607
24409
|
*/
|
|
23608
24410
|
GetControlPoints(this: Path2D): Array<unknown>;
|
|
@@ -23612,7 +24414,8 @@ interface Path2D extends GuiBase {
|
|
|
23612
24414
|
* - **ThreadSafety**: Unsafe
|
|
23613
24415
|
*
|
|
23614
24416
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#GetLength)
|
|
23615
|
-
* @param this
|
|
24417
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
24418
|
+
* @returns The total length of the path.
|
|
23616
24419
|
*/
|
|
23617
24420
|
GetLength(this: Path2D): number;
|
|
23618
24421
|
/**
|
|
@@ -23621,7 +24424,8 @@ interface Path2D extends GuiBase {
|
|
|
23621
24424
|
* - **ThreadSafety**: Unsafe
|
|
23622
24425
|
*
|
|
23623
24426
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#GetMaxControlPoints)
|
|
23624
|
-
* @param this
|
|
24427
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
24428
|
+
* @returns The maximum number of control points a `Path2D` supports.
|
|
23625
24429
|
*/
|
|
23626
24430
|
GetMaxControlPoints(this: Path2D): number;
|
|
23627
24431
|
/**
|
|
@@ -23630,7 +24434,7 @@ interface Path2D extends GuiBase {
|
|
|
23630
24434
|
* - **ThreadSafety**: Unsafe
|
|
23631
24435
|
*
|
|
23632
24436
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#GetPositionOnCurve)
|
|
23633
|
-
* @param this
|
|
24437
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
23634
24438
|
* @param t The value to query the `Path2D` at.
|
|
23635
24439
|
* @returns The position in parameter space.
|
|
23636
24440
|
*/
|
|
@@ -23641,7 +24445,7 @@ interface Path2D extends GuiBase {
|
|
|
23641
24445
|
* - **ThreadSafety**: Unsafe
|
|
23642
24446
|
*
|
|
23643
24447
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#GetPositionOnCurveArcLength)
|
|
23644
|
-
* @param this
|
|
24448
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
23645
24449
|
* @param t The value to query the Path2D at.
|
|
23646
24450
|
* @returns The position in arc length space.
|
|
23647
24451
|
*/
|
|
@@ -23652,8 +24456,9 @@ interface Path2D extends GuiBase {
|
|
|
23652
24456
|
* - **ThreadSafety**: Unsafe
|
|
23653
24457
|
*
|
|
23654
24458
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#GetTangentOnCurve)
|
|
23655
|
-
* @param this
|
|
24459
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
23656
24460
|
* @param t The value to query the `Path2D` at.
|
|
24461
|
+
* @returns The tangent in parameter space.
|
|
23657
24462
|
*/
|
|
23658
24463
|
GetTangentOnCurve(this: Path2D, t: number): Vector2;
|
|
23659
24464
|
/**
|
|
@@ -23662,7 +24467,7 @@ interface Path2D extends GuiBase {
|
|
|
23662
24467
|
* - **ThreadSafety**: Unsafe
|
|
23663
24468
|
*
|
|
23664
24469
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#GetTangentOnCurveArcLength)
|
|
23665
|
-
* @param this
|
|
24470
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
23666
24471
|
* @param t The value to query the `Path2D` at.
|
|
23667
24472
|
* @returns The tangent in arc length space.
|
|
23668
24473
|
*/
|
|
@@ -23673,7 +24478,7 @@ interface Path2D extends GuiBase {
|
|
|
23673
24478
|
* - **ThreadSafety**: Unsafe
|
|
23674
24479
|
*
|
|
23675
24480
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#InsertControlPoint)
|
|
23676
|
-
* @param this
|
|
24481
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
23677
24482
|
* @param index The index to insert at.
|
|
23678
24483
|
* @param point The control point to insert.
|
|
23679
24484
|
*/
|
|
@@ -23684,7 +24489,7 @@ interface Path2D extends GuiBase {
|
|
|
23684
24489
|
* - **ThreadSafety**: Unsafe
|
|
23685
24490
|
*
|
|
23686
24491
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#RemoveControlPoint)
|
|
23687
|
-
* @param this
|
|
24492
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
23688
24493
|
* @param index The index to remove at.
|
|
23689
24494
|
*/
|
|
23690
24495
|
RemoveControlPoint(this: Path2D, index: number): void;
|
|
@@ -23694,7 +24499,7 @@ interface Path2D extends GuiBase {
|
|
|
23694
24499
|
* - **ThreadSafety**: Unsafe
|
|
23695
24500
|
*
|
|
23696
24501
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#SetControlPoints)
|
|
23697
|
-
* @param this
|
|
24502
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
23698
24503
|
* @param controlPoints The new list of control points to set.
|
|
23699
24504
|
*/
|
|
23700
24505
|
SetControlPoints(this: Path2D, controlPoints: Array<unknown>): void;
|
|
@@ -23704,9 +24509,9 @@ interface Path2D extends GuiBase {
|
|
|
23704
24509
|
* - **ThreadSafety**: Unsafe
|
|
23705
24510
|
*
|
|
23706
24511
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path2D#UpdateControlPoint)
|
|
23707
|
-
* @param this
|
|
24512
|
+
* @param this Represents a 2D cubic spline path that renders a stroked curve under any `GuiObject`.
|
|
23708
24513
|
* @param index The control point index to update.
|
|
23709
|
-
* @param point
|
|
24514
|
+
* @param point The new `Path2DControlPoint` value to store at the index.
|
|
23710
24515
|
*/
|
|
23711
24516
|
UpdateControlPoint(this: Path2D, index: number, point: Path2DControlPoint): void;
|
|
23712
24517
|
/**
|
|
@@ -23865,8 +24670,8 @@ interface GuiService extends Instance {
|
|
|
23865
24670
|
*
|
|
23866
24671
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#AddSelectionParent)
|
|
23867
24672
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
23868
|
-
* @param selectionName
|
|
23869
|
-
* @param selectionParent
|
|
24673
|
+
* @param selectionName A unique name identifying this selection group.
|
|
24674
|
+
* @param selectionParent The `GuiObject` whose selectable descendants form the navigation group.
|
|
23870
24675
|
*
|
|
23871
24676
|
* @deprecated SelectionGroup
|
|
23872
24677
|
*/
|
|
@@ -23900,11 +24705,14 @@ interface GuiService extends Instance {
|
|
|
23900
24705
|
*/
|
|
23901
24706
|
CloseInspectMenu(this: GuiService): void;
|
|
23902
24707
|
/**
|
|
24708
|
+
* Dismisses a notification previously shown by `SendNotification()`.
|
|
24709
|
+
*
|
|
23903
24710
|
* - **ThreadSafety**: Unsafe
|
|
23904
24711
|
*
|
|
23905
24712
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#DismissNotification)
|
|
23906
24713
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
23907
|
-
* @param notificationId
|
|
24714
|
+
* @param notificationId The identifier returned by `SendNotification()` for the notification to dismiss.
|
|
24715
|
+
* @returns `true` if a matching notification was found and dismissed; `false` if no active notification has the given `notificationId`.
|
|
23908
24716
|
*/
|
|
23909
24717
|
DismissNotification(this: GuiService, notificationId: string): boolean;
|
|
23910
24718
|
/**
|
|
@@ -23947,7 +24755,8 @@ interface GuiService extends Instance {
|
|
|
23947
24755
|
*
|
|
23948
24756
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetInsetArea)
|
|
23949
24757
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
23950
|
-
* @param screenInsets
|
|
24758
|
+
* @param screenInsets The `ScreenInsets` value indicating which inset area to query.
|
|
24759
|
+
* @returns A `Rect` of the usable region for the specified `ScreenInsets` area.
|
|
23951
24760
|
*/
|
|
23952
24761
|
GetInsetArea(this: GuiService, screenInsets: CastsToEnum<Enum.ScreenInsets>): Rect;
|
|
23953
24762
|
/**
|
|
@@ -23988,6 +24797,7 @@ interface GuiService extends Instance {
|
|
|
23988
24797
|
*
|
|
23989
24798
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#IsTenFootInterface)
|
|
23990
24799
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
24800
|
+
* @returns `true` if the client is using the ten foot interface (console UI mode); `false` otherwise.
|
|
23991
24801
|
*/
|
|
23992
24802
|
IsTenFootInterface(this: GuiService): boolean;
|
|
23993
24803
|
/**
|
|
@@ -24000,7 +24810,7 @@ interface GuiService extends Instance {
|
|
|
24000
24810
|
*
|
|
24001
24811
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#RemoveSelectionGroup)
|
|
24002
24812
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
24003
|
-
* @param selectionName
|
|
24813
|
+
* @param selectionName The name of the selection group to remove.
|
|
24004
24814
|
*
|
|
24005
24815
|
* @deprecated SelectionGroup
|
|
24006
24816
|
*/
|
|
@@ -24016,11 +24826,14 @@ interface GuiService extends Instance {
|
|
|
24016
24826
|
*/
|
|
24017
24827
|
Select(this: GuiService, selectionParent: Instance): void;
|
|
24018
24828
|
/**
|
|
24829
|
+
* Displays a notification described by `notificationInfo` and returns a unique identifier for it.
|
|
24830
|
+
*
|
|
24019
24831
|
* - **ThreadSafety**: Unsafe
|
|
24020
24832
|
*
|
|
24021
24833
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SendNotification)
|
|
24022
24834
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
24023
|
-
* @param notificationInfo
|
|
24835
|
+
* @param notificationInfo A dictionary describing the notification. Recognized fields are `Title` (string), `Text` (string), `Icon` (string), `Buttons` (an array of button tables, each with a `Text` string, a `ButtonType` `NotificationButtonType` value, and an `OnActivated` callback), and `OnDisplay`/`OnDismiss` callback functions.
|
|
24836
|
+
* @returns A unique identifier string for the notification, which can be passed to `DismissNotification()`. Returns an empty string if the notification could not be queued.
|
|
24024
24837
|
*/
|
|
24025
24838
|
SendNotification(this: GuiService, notificationInfo: object): string;
|
|
24026
24839
|
/**
|
|
@@ -24030,7 +24843,7 @@ interface GuiService extends Instance {
|
|
|
24030
24843
|
*
|
|
24031
24844
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SetEmotesMenuOpen)
|
|
24032
24845
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
24033
|
-
* @param isOpen
|
|
24846
|
+
* @param isOpen Whether to open (`true`) or close (`false`) the emotes menu.
|
|
24034
24847
|
*/
|
|
24035
24848
|
SetEmotesMenuOpen(this: GuiService, isOpen: boolean): void;
|
|
24036
24849
|
/**
|
|
@@ -25963,666 +26776,888 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25963
26776
|
*/
|
|
25964
26777
|
readonly _nominal_HumanoidRigDescription: unique symbol;
|
|
25965
26778
|
/**
|
|
26779
|
+
* The chest joint instance in the rig hierarchy.
|
|
26780
|
+
*
|
|
25966
26781
|
* - **ThreadSafety**: ReadSafe
|
|
25967
26782
|
*
|
|
25968
26783
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Chest)
|
|
25969
26784
|
*/
|
|
25970
26785
|
Chest: Instance | undefined;
|
|
25971
26786
|
/**
|
|
26787
|
+
* Maximum rotation limit per axis for the chest joint.
|
|
26788
|
+
*
|
|
25972
26789
|
* - **ThreadSafety**: ReadSafe
|
|
25973
26790
|
*
|
|
25974
26791
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#ChestRangeMax)
|
|
25975
26792
|
*/
|
|
25976
26793
|
ChestRangeMax: Vector3;
|
|
25977
26794
|
/**
|
|
26795
|
+
* Minimum rotation limit per axis for the chest joint.
|
|
26796
|
+
*
|
|
25978
26797
|
* - **ThreadSafety**: ReadSafe
|
|
25979
26798
|
*
|
|
25980
26799
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#ChestRangeMin)
|
|
25981
26800
|
*/
|
|
25982
26801
|
ChestRangeMin: Vector3;
|
|
25983
26802
|
/**
|
|
26803
|
+
* Volume sphere diameter for the chest joint.
|
|
26804
|
+
*
|
|
25984
26805
|
* - **ThreadSafety**: ReadSafe
|
|
25985
26806
|
*
|
|
25986
26807
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#ChestSize)
|
|
25987
26808
|
*/
|
|
25988
26809
|
ChestSize: number;
|
|
25989
26810
|
/**
|
|
26811
|
+
* T-pose alignment transform for the chest joint.
|
|
26812
|
+
*
|
|
25990
26813
|
* - **ThreadSafety**: ReadSafe
|
|
25991
26814
|
*
|
|
25992
26815
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#ChestTposeAdjustment)
|
|
25993
26816
|
*/
|
|
25994
26817
|
ChestTposeAdjustment: CFrame;
|
|
25995
26818
|
/**
|
|
26819
|
+
* The head base joint instance in the rig hierarchy.
|
|
26820
|
+
*
|
|
25996
26821
|
* - **ThreadSafety**: ReadSafe
|
|
25997
26822
|
*
|
|
25998
26823
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBase)
|
|
25999
26824
|
*/
|
|
26000
26825
|
HeadBase: Instance | undefined;
|
|
26001
26826
|
/**
|
|
26827
|
+
* Maximum rotation limit per axis for the head base joint.
|
|
26828
|
+
*
|
|
26002
26829
|
* - **ThreadSafety**: ReadSafe
|
|
26003
26830
|
*
|
|
26004
26831
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseRangeMax)
|
|
26005
26832
|
*/
|
|
26006
26833
|
HeadBaseRangeMax: Vector3;
|
|
26007
26834
|
/**
|
|
26835
|
+
* Minimum rotation limit per axis for the head base joint.
|
|
26836
|
+
*
|
|
26008
26837
|
* - **ThreadSafety**: ReadSafe
|
|
26009
26838
|
*
|
|
26010
26839
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseRangeMin)
|
|
26011
26840
|
*/
|
|
26012
26841
|
HeadBaseRangeMin: Vector3;
|
|
26013
26842
|
/**
|
|
26843
|
+
* Volume sphere diameter for the head base joint.
|
|
26844
|
+
*
|
|
26014
26845
|
* - **ThreadSafety**: ReadSafe
|
|
26015
26846
|
*
|
|
26016
26847
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseSize)
|
|
26017
26848
|
*/
|
|
26018
26849
|
HeadBaseSize: number;
|
|
26019
26850
|
/**
|
|
26851
|
+
* T-pose alignment transform for the head base joint.
|
|
26852
|
+
*
|
|
26020
26853
|
* - **ThreadSafety**: ReadSafe
|
|
26021
26854
|
*
|
|
26022
26855
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseTposeAdjustment)
|
|
26023
26856
|
*/
|
|
26024
26857
|
HeadBaseTposeAdjustment: CFrame;
|
|
26025
26858
|
/**
|
|
26859
|
+
* The left ankle joint instance in the rig hierarchy.
|
|
26860
|
+
*
|
|
26026
26861
|
* - **ThreadSafety**: ReadSafe
|
|
26027
26862
|
*
|
|
26028
26863
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftAnkle)
|
|
26029
26864
|
*/
|
|
26030
26865
|
LeftAnkle: Instance | undefined;
|
|
26031
26866
|
/**
|
|
26867
|
+
* Maximum rotation limit per axis for the left ankle joint.
|
|
26868
|
+
*
|
|
26032
26869
|
* - **ThreadSafety**: ReadSafe
|
|
26033
26870
|
*
|
|
26034
26871
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftAnkleRangeMax)
|
|
26035
26872
|
*/
|
|
26036
26873
|
LeftAnkleRangeMax: Vector3;
|
|
26037
26874
|
/**
|
|
26875
|
+
* Minimum rotation limit per axis for the left ankle joint.
|
|
26876
|
+
*
|
|
26038
26877
|
* - **ThreadSafety**: ReadSafe
|
|
26039
26878
|
*
|
|
26040
26879
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftAnkleRangeMin)
|
|
26041
26880
|
*/
|
|
26042
26881
|
LeftAnkleRangeMin: Vector3;
|
|
26043
26882
|
/**
|
|
26883
|
+
* Volume sphere diameter for the left ankle joint.
|
|
26884
|
+
*
|
|
26044
26885
|
* - **ThreadSafety**: ReadSafe
|
|
26045
26886
|
*
|
|
26046
26887
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftAnkleSize)
|
|
26047
26888
|
*/
|
|
26048
26889
|
LeftAnkleSize: number;
|
|
26049
26890
|
/**
|
|
26891
|
+
* T-pose alignment transform for the left ankle joint.
|
|
26892
|
+
*
|
|
26050
26893
|
* - **ThreadSafety**: ReadSafe
|
|
26051
26894
|
*
|
|
26052
26895
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftAnkleTposeAdjustment)
|
|
26053
26896
|
*/
|
|
26054
26897
|
LeftAnkleTposeAdjustment: CFrame;
|
|
26055
26898
|
/**
|
|
26899
|
+
* The left clavicle joint instance in the rig hierarchy.
|
|
26900
|
+
*
|
|
26056
26901
|
* - **ThreadSafety**: ReadSafe
|
|
26057
26902
|
*
|
|
26058
26903
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftClavicle)
|
|
26059
26904
|
*/
|
|
26060
26905
|
LeftClavicle: Instance | undefined;
|
|
26061
26906
|
/**
|
|
26907
|
+
* Maximum rotation limit per axis for the left clavicle joint.
|
|
26908
|
+
*
|
|
26062
26909
|
* - **ThreadSafety**: ReadSafe
|
|
26063
26910
|
*
|
|
26064
26911
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftClavicleRangeMax)
|
|
26065
26912
|
*/
|
|
26066
26913
|
LeftClavicleRangeMax: Vector3;
|
|
26067
26914
|
/**
|
|
26915
|
+
* Minimum rotation limit per axis for the left clavicle joint.
|
|
26916
|
+
*
|
|
26068
26917
|
* - **ThreadSafety**: ReadSafe
|
|
26069
26918
|
*
|
|
26070
26919
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftClavicleRangeMin)
|
|
26071
26920
|
*/
|
|
26072
26921
|
LeftClavicleRangeMin: Vector3;
|
|
26073
26922
|
/**
|
|
26923
|
+
* Volume sphere diameter for the left clavicle joint.
|
|
26924
|
+
*
|
|
26074
26925
|
* - **ThreadSafety**: ReadSafe
|
|
26075
26926
|
*
|
|
26076
26927
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftClavicleSize)
|
|
26077
26928
|
*/
|
|
26078
26929
|
LeftClavicleSize: number;
|
|
26079
26930
|
/**
|
|
26931
|
+
* T-pose alignment transform for the left clavicle joint.
|
|
26932
|
+
*
|
|
26080
26933
|
* - **ThreadSafety**: ReadSafe
|
|
26081
26934
|
*
|
|
26082
26935
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftClavicleTposeAdjustment)
|
|
26083
26936
|
*/
|
|
26084
26937
|
LeftClavicleTposeAdjustment: CFrame;
|
|
26085
26938
|
/**
|
|
26939
|
+
* The left elbow joint instance in the rig hierarchy.
|
|
26940
|
+
*
|
|
26086
26941
|
* - **ThreadSafety**: ReadSafe
|
|
26087
26942
|
*
|
|
26088
26943
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftElbow)
|
|
26089
26944
|
*/
|
|
26090
26945
|
LeftElbow: Instance | undefined;
|
|
26091
26946
|
/**
|
|
26947
|
+
* Maximum rotation limit per axis for the left elbow joint.
|
|
26948
|
+
*
|
|
26092
26949
|
* - **ThreadSafety**: ReadSafe
|
|
26093
26950
|
*
|
|
26094
26951
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftElbowRangeMax)
|
|
26095
26952
|
*/
|
|
26096
26953
|
LeftElbowRangeMax: Vector3;
|
|
26097
26954
|
/**
|
|
26955
|
+
* Minimum rotation limit per axis for the left elbow joint.
|
|
26956
|
+
*
|
|
26098
26957
|
* - **ThreadSafety**: ReadSafe
|
|
26099
26958
|
*
|
|
26100
26959
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftElbowRangeMin)
|
|
26101
26960
|
*/
|
|
26102
26961
|
LeftElbowRangeMin: Vector3;
|
|
26103
26962
|
/**
|
|
26963
|
+
* Volume sphere diameter for the left elbow joint.
|
|
26964
|
+
*
|
|
26104
26965
|
* - **ThreadSafety**: ReadSafe
|
|
26105
26966
|
*
|
|
26106
26967
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftElbowSize)
|
|
26107
26968
|
*/
|
|
26108
26969
|
LeftElbowSize: number;
|
|
26109
26970
|
/**
|
|
26971
|
+
* T-pose alignment transform for the left elbow joint.
|
|
26972
|
+
*
|
|
26110
26973
|
* - **ThreadSafety**: ReadSafe
|
|
26111
26974
|
*
|
|
26112
26975
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftElbowTposeAdjustment)
|
|
26113
26976
|
*/
|
|
26114
26977
|
LeftElbowTposeAdjustment: CFrame;
|
|
26115
26978
|
/**
|
|
26979
|
+
* The left hip joint instance in the rig hierarchy.
|
|
26980
|
+
*
|
|
26116
26981
|
* - **ThreadSafety**: ReadSafe
|
|
26117
26982
|
*
|
|
26118
26983
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftHip)
|
|
26119
26984
|
*/
|
|
26120
26985
|
LeftHip: Instance | undefined;
|
|
26121
26986
|
/**
|
|
26987
|
+
* Maximum rotation limit per axis for the left hip joint.
|
|
26988
|
+
*
|
|
26122
26989
|
* - **ThreadSafety**: ReadSafe
|
|
26123
26990
|
*
|
|
26124
26991
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftHipRangeMax)
|
|
26125
26992
|
*/
|
|
26126
26993
|
LeftHipRangeMax: Vector3;
|
|
26127
26994
|
/**
|
|
26995
|
+
* Minimum rotation limit per axis for the left hip joint.
|
|
26996
|
+
*
|
|
26128
26997
|
* - **ThreadSafety**: ReadSafe
|
|
26129
26998
|
*
|
|
26130
26999
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftHipRangeMin)
|
|
26131
27000
|
*/
|
|
26132
27001
|
LeftHipRangeMin: Vector3;
|
|
26133
27002
|
/**
|
|
27003
|
+
* Volume sphere diameter for the left hip joint.
|
|
27004
|
+
*
|
|
26134
27005
|
* - **ThreadSafety**: ReadSafe
|
|
26135
27006
|
*
|
|
26136
27007
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftHipSize)
|
|
26137
27008
|
*/
|
|
26138
27009
|
LeftHipSize: number;
|
|
26139
27010
|
/**
|
|
27011
|
+
* T-pose alignment transform for the left hip joint.
|
|
27012
|
+
*
|
|
26140
27013
|
* - **ThreadSafety**: ReadSafe
|
|
26141
27014
|
*
|
|
26142
27015
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftHipTposeAdjustment)
|
|
26143
27016
|
*/
|
|
26144
27017
|
LeftHipTposeAdjustment: CFrame;
|
|
26145
27018
|
/**
|
|
27019
|
+
* The left knee joint instance in the rig hierarchy.
|
|
27020
|
+
*
|
|
26146
27021
|
* - **ThreadSafety**: ReadSafe
|
|
26147
27022
|
*
|
|
26148
27023
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftKnee)
|
|
26149
27024
|
*/
|
|
26150
27025
|
LeftKnee: Instance | undefined;
|
|
26151
27026
|
/**
|
|
27027
|
+
* Maximum rotation limit per axis for the left knee joint.
|
|
27028
|
+
*
|
|
26152
27029
|
* - **ThreadSafety**: ReadSafe
|
|
26153
27030
|
*
|
|
26154
27031
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftKneeRangeMax)
|
|
26155
27032
|
*/
|
|
26156
27033
|
LeftKneeRangeMax: Vector3;
|
|
26157
27034
|
/**
|
|
27035
|
+
* Minimum rotation limit per axis for the left knee joint.
|
|
27036
|
+
*
|
|
26158
27037
|
* - **ThreadSafety**: ReadSafe
|
|
26159
27038
|
*
|
|
26160
27039
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftKneeRangeMin)
|
|
26161
27040
|
*/
|
|
26162
27041
|
LeftKneeRangeMin: Vector3;
|
|
26163
27042
|
/**
|
|
27043
|
+
* Volume sphere diameter for the left knee joint.
|
|
27044
|
+
*
|
|
26164
27045
|
* - **ThreadSafety**: ReadSafe
|
|
26165
27046
|
*
|
|
26166
27047
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftKneeSize)
|
|
26167
27048
|
*/
|
|
26168
27049
|
LeftKneeSize: number;
|
|
26169
27050
|
/**
|
|
27051
|
+
* T-pose alignment transform for the left knee joint.
|
|
27052
|
+
*
|
|
26170
27053
|
* - **ThreadSafety**: ReadSafe
|
|
26171
27054
|
*
|
|
26172
27055
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftKneeTposeAdjustment)
|
|
26173
27056
|
*/
|
|
26174
27057
|
LeftKneeTposeAdjustment: CFrame;
|
|
26175
27058
|
/**
|
|
27059
|
+
* The left shoulder joint instance in the rig hierarchy.
|
|
27060
|
+
*
|
|
26176
27061
|
* - **ThreadSafety**: ReadSafe
|
|
26177
27062
|
*
|
|
26178
27063
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftShoulder)
|
|
26179
27064
|
*/
|
|
26180
27065
|
LeftShoulder: Instance | undefined;
|
|
26181
27066
|
/**
|
|
27067
|
+
* Maximum rotation limit per axis for the left shoulder joint.
|
|
27068
|
+
*
|
|
26182
27069
|
* - **ThreadSafety**: ReadSafe
|
|
26183
27070
|
*
|
|
26184
27071
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftShoulderRangeMax)
|
|
26185
27072
|
*/
|
|
26186
27073
|
LeftShoulderRangeMax: Vector3;
|
|
26187
27074
|
/**
|
|
27075
|
+
* Minimum rotation limit per axis for the left shoulder joint.
|
|
27076
|
+
*
|
|
26188
27077
|
* - **ThreadSafety**: ReadSafe
|
|
26189
27078
|
*
|
|
26190
27079
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftShoulderRangeMin)
|
|
26191
27080
|
*/
|
|
26192
27081
|
LeftShoulderRangeMin: Vector3;
|
|
26193
27082
|
/**
|
|
27083
|
+
* Volume sphere diameter for the left shoulder joint.
|
|
27084
|
+
*
|
|
26194
27085
|
* - **ThreadSafety**: ReadSafe
|
|
26195
27086
|
*
|
|
26196
27087
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftShoulderSize)
|
|
26197
27088
|
*/
|
|
26198
27089
|
LeftShoulderSize: number;
|
|
26199
27090
|
/**
|
|
27091
|
+
* T-pose alignment transform for the left shoulder joint.
|
|
27092
|
+
*
|
|
26200
27093
|
* - **ThreadSafety**: ReadSafe
|
|
26201
27094
|
*
|
|
26202
27095
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftShoulderTposeAdjustment)
|
|
26203
27096
|
*/
|
|
26204
27097
|
LeftShoulderTposeAdjustment: CFrame;
|
|
26205
27098
|
/**
|
|
27099
|
+
* The left toe base joint instance in the rig hierarchy.
|
|
27100
|
+
*
|
|
26206
27101
|
* - **ThreadSafety**: ReadSafe
|
|
26207
27102
|
*
|
|
26208
27103
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToeBase)
|
|
26209
27104
|
*/
|
|
26210
27105
|
LeftToeBase: Instance | undefined;
|
|
26211
27106
|
/**
|
|
27107
|
+
* Maximum rotation limit per axis for the left toe base joint.
|
|
27108
|
+
*
|
|
26212
27109
|
* - **ThreadSafety**: ReadSafe
|
|
26213
27110
|
*
|
|
26214
27111
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToeBaseRangeMax)
|
|
26215
27112
|
*/
|
|
26216
27113
|
LeftToeBaseRangeMax: Vector3;
|
|
26217
27114
|
/**
|
|
27115
|
+
* Minimum rotation limit per axis for the left toe base joint.
|
|
27116
|
+
*
|
|
26218
27117
|
* - **ThreadSafety**: ReadSafe
|
|
26219
27118
|
*
|
|
26220
27119
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToeBaseRangeMin)
|
|
26221
27120
|
*/
|
|
26222
27121
|
LeftToeBaseRangeMin: Vector3;
|
|
26223
27122
|
/**
|
|
27123
|
+
* Volume sphere diameter for the left toe base joint.
|
|
27124
|
+
*
|
|
26224
27125
|
* - **ThreadSafety**: ReadSafe
|
|
26225
27126
|
*
|
|
26226
27127
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToeBaseSize)
|
|
26227
27128
|
*/
|
|
26228
27129
|
LeftToeBaseSize: number;
|
|
26229
27130
|
/**
|
|
27131
|
+
* T-pose alignment transform for the left toe base joint.
|
|
27132
|
+
*
|
|
26230
27133
|
* - **ThreadSafety**: ReadSafe
|
|
26231
27134
|
*
|
|
26232
27135
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToeBaseTposeAdjustment)
|
|
26233
27136
|
*/
|
|
26234
27137
|
LeftToeBaseTposeAdjustment: CFrame;
|
|
26235
27138
|
/**
|
|
27139
|
+
* The left wrist joint instance in the rig hierarchy.
|
|
27140
|
+
*
|
|
26236
27141
|
* - **ThreadSafety**: ReadSafe
|
|
26237
27142
|
*
|
|
26238
27143
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftWrist)
|
|
26239
27144
|
*/
|
|
26240
27145
|
LeftWrist: Instance | undefined;
|
|
26241
27146
|
/**
|
|
27147
|
+
* Maximum rotation limit per axis for the left wrist joint.
|
|
27148
|
+
*
|
|
26242
27149
|
* - **ThreadSafety**: ReadSafe
|
|
26243
27150
|
*
|
|
26244
27151
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftWristRangeMax)
|
|
26245
27152
|
*/
|
|
26246
27153
|
LeftWristRangeMax: Vector3;
|
|
26247
27154
|
/**
|
|
27155
|
+
* Minimum rotation limit per axis for the left wrist joint.
|
|
27156
|
+
*
|
|
26248
27157
|
* - **ThreadSafety**: ReadSafe
|
|
26249
27158
|
*
|
|
26250
27159
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftWristRangeMin)
|
|
26251
27160
|
*/
|
|
26252
27161
|
LeftWristRangeMin: Vector3;
|
|
26253
27162
|
/**
|
|
27163
|
+
* Volume sphere diameter for the left wrist joint.
|
|
27164
|
+
*
|
|
26254
27165
|
* - **ThreadSafety**: ReadSafe
|
|
26255
27166
|
*
|
|
26256
27167
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftWristSize)
|
|
26257
27168
|
*/
|
|
26258
27169
|
LeftWristSize: number;
|
|
26259
27170
|
/**
|
|
27171
|
+
* T-pose alignment transform for the left wrist joint.
|
|
27172
|
+
*
|
|
26260
27173
|
* - **ThreadSafety**: ReadSafe
|
|
26261
27174
|
*
|
|
26262
27175
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftWristTposeAdjustment)
|
|
26263
27176
|
*/
|
|
26264
27177
|
LeftWristTposeAdjustment: CFrame;
|
|
26265
27178
|
/**
|
|
27179
|
+
* The neck joint instance in the rig hierarchy.
|
|
27180
|
+
*
|
|
26266
27181
|
* - **ThreadSafety**: ReadSafe
|
|
26267
27182
|
*
|
|
26268
27183
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Neck)
|
|
26269
27184
|
*/
|
|
26270
27185
|
Neck: Instance | undefined;
|
|
26271
27186
|
/**
|
|
27187
|
+
* Maximum rotation limit per axis for the neck joint.
|
|
27188
|
+
*
|
|
26272
27189
|
* - **ThreadSafety**: ReadSafe
|
|
26273
27190
|
*
|
|
26274
27191
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#NeckRangeMax)
|
|
26275
27192
|
*/
|
|
26276
27193
|
NeckRangeMax: Vector3;
|
|
26277
27194
|
/**
|
|
27195
|
+
* Minimum rotation limit per axis for the neck joint.
|
|
27196
|
+
*
|
|
26278
27197
|
* - **ThreadSafety**: ReadSafe
|
|
26279
27198
|
*
|
|
26280
27199
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#NeckRangeMin)
|
|
26281
27200
|
*/
|
|
26282
27201
|
NeckRangeMin: Vector3;
|
|
26283
27202
|
/**
|
|
27203
|
+
* Volume sphere diameter for the neck joint.
|
|
27204
|
+
*
|
|
26284
27205
|
* - **ThreadSafety**: ReadSafe
|
|
26285
27206
|
*
|
|
26286
27207
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#NeckSize)
|
|
26287
27208
|
*/
|
|
26288
27209
|
NeckSize: number;
|
|
26289
27210
|
/**
|
|
27211
|
+
* T-pose alignment transform for the neck joint.
|
|
27212
|
+
*
|
|
26290
27213
|
* - **ThreadSafety**: ReadSafe
|
|
26291
27214
|
*
|
|
26292
27215
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#NeckTposeAdjustment)
|
|
26293
27216
|
*/
|
|
26294
27217
|
NeckTposeAdjustment: CFrame;
|
|
26295
27218
|
/**
|
|
27219
|
+
* The right ankle joint instance in the rig hierarchy.
|
|
27220
|
+
*
|
|
26296
27221
|
* - **ThreadSafety**: ReadSafe
|
|
26297
27222
|
*
|
|
26298
27223
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightAnkle)
|
|
26299
27224
|
*/
|
|
26300
27225
|
RightAnkle: Instance | undefined;
|
|
26301
27226
|
/**
|
|
27227
|
+
* Maximum rotation limit per axis for the right ankle joint.
|
|
27228
|
+
*
|
|
26302
27229
|
* - **ThreadSafety**: ReadSafe
|
|
26303
27230
|
*
|
|
26304
27231
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightAnkleRangeMax)
|
|
26305
27232
|
*/
|
|
26306
27233
|
RightAnkleRangeMax: Vector3;
|
|
26307
27234
|
/**
|
|
27235
|
+
* Minimum rotation limit per axis for the right ankle joint.
|
|
27236
|
+
*
|
|
26308
27237
|
* - **ThreadSafety**: ReadSafe
|
|
26309
27238
|
*
|
|
26310
27239
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightAnkleRangeMin)
|
|
26311
27240
|
*/
|
|
26312
27241
|
RightAnkleRangeMin: Vector3;
|
|
26313
27242
|
/**
|
|
27243
|
+
* Volume sphere diameter for the right ankle joint.
|
|
27244
|
+
*
|
|
26314
27245
|
* - **ThreadSafety**: ReadSafe
|
|
26315
27246
|
*
|
|
26316
27247
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightAnkleSize)
|
|
26317
27248
|
*/
|
|
26318
27249
|
RightAnkleSize: number;
|
|
26319
27250
|
/**
|
|
27251
|
+
* T-pose alignment transform for the right ankle joint.
|
|
27252
|
+
*
|
|
26320
27253
|
* - **ThreadSafety**: ReadSafe
|
|
26321
27254
|
*
|
|
26322
27255
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightAnkleTposeAdjustment)
|
|
26323
27256
|
*/
|
|
26324
27257
|
RightAnkleTposeAdjustment: CFrame;
|
|
26325
27258
|
/**
|
|
27259
|
+
* The right clavicle joint instance in the rig hierarchy.
|
|
27260
|
+
*
|
|
26326
27261
|
* - **ThreadSafety**: ReadSafe
|
|
26327
27262
|
*
|
|
26328
27263
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightClavicle)
|
|
26329
27264
|
*/
|
|
26330
27265
|
RightClavicle: Instance | undefined;
|
|
26331
27266
|
/**
|
|
27267
|
+
* Maximum rotation limit per axis for the right clavicle joint.
|
|
27268
|
+
*
|
|
26332
27269
|
* - **ThreadSafety**: ReadSafe
|
|
26333
27270
|
*
|
|
26334
27271
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightClavicleRangeMax)
|
|
26335
27272
|
*/
|
|
26336
27273
|
RightClavicleRangeMax: Vector3;
|
|
26337
27274
|
/**
|
|
27275
|
+
* Minimum rotation limit per axis for the right clavicle joint.
|
|
27276
|
+
*
|
|
26338
27277
|
* - **ThreadSafety**: ReadSafe
|
|
26339
27278
|
*
|
|
26340
27279
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightClavicleRangeMin)
|
|
26341
27280
|
*/
|
|
26342
27281
|
RightClavicleRangeMin: Vector3;
|
|
26343
27282
|
/**
|
|
27283
|
+
* Volume sphere diameter for the right clavicle joint.
|
|
27284
|
+
*
|
|
26344
27285
|
* - **ThreadSafety**: ReadSafe
|
|
26345
27286
|
*
|
|
26346
27287
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightClavicleSize)
|
|
26347
27288
|
*/
|
|
26348
27289
|
RightClavicleSize: number;
|
|
26349
27290
|
/**
|
|
27291
|
+
* T-pose alignment transform for the right clavicle joint.
|
|
27292
|
+
*
|
|
26350
27293
|
* - **ThreadSafety**: ReadSafe
|
|
26351
27294
|
*
|
|
26352
27295
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightClavicleTposeAdjustment)
|
|
26353
27296
|
*/
|
|
26354
27297
|
RightClavicleTposeAdjustment: CFrame;
|
|
26355
27298
|
/**
|
|
27299
|
+
* The right elbow joint instance in the rig hierarchy.
|
|
27300
|
+
*
|
|
26356
27301
|
* - **ThreadSafety**: ReadSafe
|
|
26357
27302
|
*
|
|
26358
27303
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightElbow)
|
|
26359
27304
|
*/
|
|
26360
27305
|
RightElbow: Instance | undefined;
|
|
26361
27306
|
/**
|
|
27307
|
+
* Maximum rotation limit per axis for the right elbow joint.
|
|
27308
|
+
*
|
|
26362
27309
|
* - **ThreadSafety**: ReadSafe
|
|
26363
27310
|
*
|
|
26364
27311
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightElbowRangeMax)
|
|
26365
27312
|
*/
|
|
26366
27313
|
RightElbowRangeMax: Vector3;
|
|
26367
27314
|
/**
|
|
27315
|
+
* Minimum rotation limit per axis for the right elbow joint.
|
|
27316
|
+
*
|
|
26368
27317
|
* - **ThreadSafety**: ReadSafe
|
|
26369
27318
|
*
|
|
26370
27319
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightElbowRangeMin)
|
|
26371
27320
|
*/
|
|
26372
27321
|
RightElbowRangeMin: Vector3;
|
|
26373
27322
|
/**
|
|
27323
|
+
* Volume sphere diameter for the right elbow joint.
|
|
27324
|
+
*
|
|
26374
27325
|
* - **ThreadSafety**: ReadSafe
|
|
26375
27326
|
*
|
|
26376
27327
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightElbowSize)
|
|
26377
27328
|
*/
|
|
26378
27329
|
RightElbowSize: number;
|
|
26379
27330
|
/**
|
|
27331
|
+
* T-pose alignment transform for the right elbow joint.
|
|
27332
|
+
*
|
|
26380
27333
|
* - **ThreadSafety**: ReadSafe
|
|
26381
27334
|
*
|
|
26382
27335
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightElbowTposeAdjustment)
|
|
26383
27336
|
*/
|
|
26384
27337
|
RightElbowTposeAdjustment: CFrame;
|
|
26385
27338
|
/**
|
|
27339
|
+
* The right hip joint instance in the rig hierarchy.
|
|
27340
|
+
*
|
|
26386
27341
|
* - **ThreadSafety**: ReadSafe
|
|
26387
27342
|
*
|
|
26388
27343
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightHip)
|
|
26389
27344
|
*/
|
|
26390
27345
|
RightHip: Instance | undefined;
|
|
26391
27346
|
/**
|
|
27347
|
+
* Maximum rotation limit per axis for the right hip joint.
|
|
27348
|
+
*
|
|
26392
27349
|
* - **ThreadSafety**: ReadSafe
|
|
26393
27350
|
*
|
|
26394
27351
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightHipRangeMax)
|
|
26395
27352
|
*/
|
|
26396
27353
|
RightHipRangeMax: Vector3;
|
|
26397
27354
|
/**
|
|
27355
|
+
* Minimum rotation limit per axis for the right hip joint.
|
|
27356
|
+
*
|
|
26398
27357
|
* - **ThreadSafety**: ReadSafe
|
|
26399
27358
|
*
|
|
26400
27359
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightHipRangeMin)
|
|
26401
27360
|
*/
|
|
26402
27361
|
RightHipRangeMin: Vector3;
|
|
26403
27362
|
/**
|
|
27363
|
+
* Volume sphere diameter for the right hip joint.
|
|
27364
|
+
*
|
|
26404
27365
|
* - **ThreadSafety**: ReadSafe
|
|
26405
27366
|
*
|
|
26406
27367
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightHipSize)
|
|
26407
27368
|
*/
|
|
26408
27369
|
RightHipSize: number;
|
|
26409
27370
|
/**
|
|
27371
|
+
* T-pose alignment transform for the right hip joint.
|
|
27372
|
+
*
|
|
26410
27373
|
* - **ThreadSafety**: ReadSafe
|
|
26411
27374
|
*
|
|
26412
27375
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightHipTposeAdjustment)
|
|
26413
27376
|
*/
|
|
26414
27377
|
RightHipTposeAdjustment: CFrame;
|
|
26415
27378
|
/**
|
|
27379
|
+
* The right knee joint instance in the rig hierarchy.
|
|
27380
|
+
*
|
|
26416
27381
|
* - **ThreadSafety**: ReadSafe
|
|
26417
27382
|
*
|
|
26418
27383
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightKnee)
|
|
26419
27384
|
*/
|
|
26420
27385
|
RightKnee: Instance | undefined;
|
|
26421
27386
|
/**
|
|
27387
|
+
* Maximum rotation limit per axis for the right knee joint.
|
|
27388
|
+
*
|
|
26422
27389
|
* - **ThreadSafety**: ReadSafe
|
|
26423
27390
|
*
|
|
26424
27391
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightKneeRangeMax)
|
|
26425
27392
|
*/
|
|
26426
27393
|
RightKneeRangeMax: Vector3;
|
|
26427
27394
|
/**
|
|
27395
|
+
* Minimum rotation limit per axis for the right knee joint.
|
|
27396
|
+
*
|
|
26428
27397
|
* - **ThreadSafety**: ReadSafe
|
|
26429
27398
|
*
|
|
26430
27399
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightKneeRangeMin)
|
|
26431
27400
|
*/
|
|
26432
27401
|
RightKneeRangeMin: Vector3;
|
|
26433
27402
|
/**
|
|
27403
|
+
* Volume sphere diameter for the right knee joint.
|
|
27404
|
+
*
|
|
26434
27405
|
* - **ThreadSafety**: ReadSafe
|
|
26435
27406
|
*
|
|
26436
27407
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightKneeSize)
|
|
26437
27408
|
*/
|
|
26438
27409
|
RightKneeSize: number;
|
|
26439
27410
|
/**
|
|
27411
|
+
* T-pose alignment transform for the right knee joint.
|
|
27412
|
+
*
|
|
26440
27413
|
* - **ThreadSafety**: ReadSafe
|
|
26441
27414
|
*
|
|
26442
27415
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightKneeTposeAdjustment)
|
|
26443
27416
|
*/
|
|
26444
27417
|
RightKneeTposeAdjustment: CFrame;
|
|
26445
27418
|
/**
|
|
27419
|
+
* The right shoulder joint instance in the rig hierarchy.
|
|
27420
|
+
*
|
|
26446
27421
|
* - **ThreadSafety**: ReadSafe
|
|
26447
27422
|
*
|
|
26448
27423
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightShoulder)
|
|
26449
27424
|
*/
|
|
26450
27425
|
RightShoulder: Instance | undefined;
|
|
26451
27426
|
/**
|
|
27427
|
+
* Maximum rotation limit per axis for the right shoulder joint.
|
|
27428
|
+
*
|
|
26452
27429
|
* - **ThreadSafety**: ReadSafe
|
|
26453
27430
|
*
|
|
26454
27431
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightShoulderRangeMax)
|
|
26455
27432
|
*/
|
|
26456
27433
|
RightShoulderRangeMax: Vector3;
|
|
26457
27434
|
/**
|
|
27435
|
+
* Minimum rotation limit per axis for the right shoulder joint.
|
|
27436
|
+
*
|
|
26458
27437
|
* - **ThreadSafety**: ReadSafe
|
|
26459
27438
|
*
|
|
26460
27439
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightShoulderRangeMin)
|
|
26461
27440
|
*/
|
|
26462
27441
|
RightShoulderRangeMin: Vector3;
|
|
26463
27442
|
/**
|
|
27443
|
+
* Volume sphere diameter for the right shoulder joint.
|
|
27444
|
+
*
|
|
26464
27445
|
* - **ThreadSafety**: ReadSafe
|
|
26465
27446
|
*
|
|
26466
27447
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightShoulderSize)
|
|
26467
27448
|
*/
|
|
26468
27449
|
RightShoulderSize: number;
|
|
26469
27450
|
/**
|
|
27451
|
+
* T-pose alignment transform for the right shoulder joint.
|
|
27452
|
+
*
|
|
26470
27453
|
* - **ThreadSafety**: ReadSafe
|
|
26471
27454
|
*
|
|
26472
27455
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightShoulderTposeAdjustment)
|
|
26473
27456
|
*/
|
|
26474
27457
|
RightShoulderTposeAdjustment: CFrame;
|
|
26475
27458
|
/**
|
|
27459
|
+
* The right toe base joint instance in the rig hierarchy.
|
|
27460
|
+
*
|
|
26476
27461
|
* - **ThreadSafety**: ReadSafe
|
|
26477
27462
|
*
|
|
26478
27463
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToeBase)
|
|
26479
27464
|
*/
|
|
26480
27465
|
RightToeBase: Instance | undefined;
|
|
26481
27466
|
/**
|
|
27467
|
+
* Maximum rotation limit per axis for the right toe base joint.
|
|
27468
|
+
*
|
|
26482
27469
|
* - **ThreadSafety**: ReadSafe
|
|
26483
27470
|
*
|
|
26484
27471
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToeBaseRangeMax)
|
|
26485
27472
|
*/
|
|
26486
27473
|
RightToeBaseRangeMax: Vector3;
|
|
26487
27474
|
/**
|
|
27475
|
+
* Minimum rotation limit per axis for the right toe base joint.
|
|
27476
|
+
*
|
|
26488
27477
|
* - **ThreadSafety**: ReadSafe
|
|
26489
27478
|
*
|
|
26490
27479
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToeBaseRangeMin)
|
|
26491
27480
|
*/
|
|
26492
27481
|
RightToeBaseRangeMin: Vector3;
|
|
26493
27482
|
/**
|
|
27483
|
+
* Volume sphere diameter for the right toe base joint.
|
|
27484
|
+
*
|
|
26494
27485
|
* - **ThreadSafety**: ReadSafe
|
|
26495
27486
|
*
|
|
26496
27487
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToeBaseSize)
|
|
26497
27488
|
*/
|
|
26498
27489
|
RightToeBaseSize: number;
|
|
26499
27490
|
/**
|
|
27491
|
+
* T-pose alignment transform for the right toe base joint.
|
|
27492
|
+
*
|
|
26500
27493
|
* - **ThreadSafety**: ReadSafe
|
|
26501
27494
|
*
|
|
26502
27495
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToeBaseTposeAdjustment)
|
|
26503
27496
|
*/
|
|
26504
27497
|
RightToeBaseTposeAdjustment: CFrame;
|
|
26505
27498
|
/**
|
|
27499
|
+
* The right wrist joint instance in the rig hierarchy.
|
|
27500
|
+
*
|
|
26506
27501
|
* - **ThreadSafety**: ReadSafe
|
|
26507
27502
|
*
|
|
26508
27503
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightWrist)
|
|
26509
27504
|
*/
|
|
26510
27505
|
RightWrist: Instance | undefined;
|
|
26511
27506
|
/**
|
|
27507
|
+
* Maximum rotation limit per axis for the right wrist joint.
|
|
27508
|
+
*
|
|
26512
27509
|
* - **ThreadSafety**: ReadSafe
|
|
26513
27510
|
*
|
|
26514
27511
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightWristRangeMax)
|
|
26515
27512
|
*/
|
|
26516
27513
|
RightWristRangeMax: Vector3;
|
|
26517
27514
|
/**
|
|
27515
|
+
* Minimum rotation limit per axis for the right wrist joint.
|
|
27516
|
+
*
|
|
26518
27517
|
* - **ThreadSafety**: ReadSafe
|
|
26519
27518
|
*
|
|
26520
27519
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightWristRangeMin)
|
|
26521
27520
|
*/
|
|
26522
27521
|
RightWristRangeMin: Vector3;
|
|
26523
27522
|
/**
|
|
27523
|
+
* Volume sphere diameter for the right wrist joint.
|
|
27524
|
+
*
|
|
26524
27525
|
* - **ThreadSafety**: ReadSafe
|
|
26525
27526
|
*
|
|
26526
27527
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightWristSize)
|
|
26527
27528
|
*/
|
|
26528
27529
|
RightWristSize: number;
|
|
26529
27530
|
/**
|
|
27531
|
+
* T-pose alignment transform for the right wrist joint.
|
|
27532
|
+
*
|
|
26530
27533
|
* - **ThreadSafety**: ReadSafe
|
|
26531
27534
|
*
|
|
26532
27535
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightWristTposeAdjustment)
|
|
26533
27536
|
*/
|
|
26534
27537
|
RightWristTposeAdjustment: CFrame;
|
|
26535
27538
|
/**
|
|
27539
|
+
* The root joint instance in the rig hierarchy.
|
|
27540
|
+
*
|
|
26536
27541
|
* - **ThreadSafety**: ReadSafe
|
|
26537
27542
|
*
|
|
26538
27543
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Root)
|
|
26539
27544
|
*/
|
|
26540
27545
|
Root: Instance | undefined;
|
|
26541
27546
|
/**
|
|
27547
|
+
* Maximum rotation limit per axis for the root joint.
|
|
27548
|
+
*
|
|
26542
27549
|
* - **ThreadSafety**: ReadSafe
|
|
26543
27550
|
*
|
|
26544
27551
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RootRangeMax)
|
|
26545
27552
|
*/
|
|
26546
27553
|
RootRangeMax: Vector3;
|
|
26547
27554
|
/**
|
|
27555
|
+
* Minimum rotation limit per axis for the root joint.
|
|
27556
|
+
*
|
|
26548
27557
|
* - **ThreadSafety**: ReadSafe
|
|
26549
27558
|
*
|
|
26550
27559
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RootRangeMin)
|
|
26551
27560
|
*/
|
|
26552
27561
|
RootRangeMin: Vector3;
|
|
26553
27562
|
/**
|
|
27563
|
+
* Volume sphere diameter for the root joint.
|
|
27564
|
+
*
|
|
26554
27565
|
* - **ThreadSafety**: ReadSafe
|
|
26555
27566
|
*
|
|
26556
27567
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RootSize)
|
|
26557
27568
|
*/
|
|
26558
27569
|
RootSize: number;
|
|
26559
27570
|
/**
|
|
27571
|
+
* T-pose alignment transform for the root joint.
|
|
27572
|
+
*
|
|
26560
27573
|
* - **ThreadSafety**: ReadSafe
|
|
26561
27574
|
*
|
|
26562
27575
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RootTposeAdjustment)
|
|
26563
27576
|
*/
|
|
26564
27577
|
RootTposeAdjustment: CFrame;
|
|
26565
27578
|
/**
|
|
27579
|
+
* The spine joint instance in the rig hierarchy.
|
|
27580
|
+
*
|
|
26566
27581
|
* - **ThreadSafety**: ReadSafe
|
|
26567
27582
|
*
|
|
26568
27583
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Spine)
|
|
26569
27584
|
*/
|
|
26570
27585
|
Spine: Instance | undefined;
|
|
26571
27586
|
/**
|
|
27587
|
+
* Maximum rotation limit per axis for the spine joint.
|
|
27588
|
+
*
|
|
26572
27589
|
* - **ThreadSafety**: ReadSafe
|
|
26573
27590
|
*
|
|
26574
27591
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#SpineRangeMax)
|
|
26575
27592
|
*/
|
|
26576
27593
|
SpineRangeMax: Vector3;
|
|
26577
27594
|
/**
|
|
27595
|
+
* Minimum rotation limit per axis for the spine joint.
|
|
27596
|
+
*
|
|
26578
27597
|
* - **ThreadSafety**: ReadSafe
|
|
26579
27598
|
*
|
|
26580
27599
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#SpineRangeMin)
|
|
26581
27600
|
*/
|
|
26582
27601
|
SpineRangeMin: Vector3;
|
|
26583
27602
|
/**
|
|
27603
|
+
* Volume sphere diameter for the spine joint.
|
|
27604
|
+
*
|
|
26584
27605
|
* - **ThreadSafety**: ReadSafe
|
|
26585
27606
|
*
|
|
26586
27607
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#SpineSize)
|
|
26587
27608
|
*/
|
|
26588
27609
|
SpineSize: number;
|
|
26589
27610
|
/**
|
|
27611
|
+
* T-pose alignment transform for the spine joint.
|
|
27612
|
+
*
|
|
26590
27613
|
* - **ThreadSafety**: ReadSafe
|
|
26591
27614
|
*
|
|
26592
27615
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#SpineTposeAdjustment)
|
|
26593
27616
|
*/
|
|
26594
27617
|
SpineTposeAdjustment: CFrame;
|
|
26595
27618
|
/**
|
|
27619
|
+
* The waist joint instance in the rig hierarchy.
|
|
27620
|
+
*
|
|
26596
27621
|
* - **ThreadSafety**: ReadSafe
|
|
26597
27622
|
*
|
|
26598
27623
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Waist)
|
|
26599
27624
|
*/
|
|
26600
27625
|
Waist: Instance | undefined;
|
|
26601
27626
|
/**
|
|
27627
|
+
* Maximum rotation limit per axis for the waist joint.
|
|
27628
|
+
*
|
|
26602
27629
|
* - **ThreadSafety**: ReadSafe
|
|
26603
27630
|
*
|
|
26604
27631
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#WaistRangeMax)
|
|
26605
27632
|
*/
|
|
26606
27633
|
WaistRangeMax: Vector3;
|
|
26607
27634
|
/**
|
|
27635
|
+
* Minimum rotation limit per axis for the waist joint.
|
|
27636
|
+
*
|
|
26608
27637
|
* - **ThreadSafety**: ReadSafe
|
|
26609
27638
|
*
|
|
26610
27639
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#WaistRangeMin)
|
|
26611
27640
|
*/
|
|
26612
27641
|
WaistRangeMin: Vector3;
|
|
26613
27642
|
/**
|
|
27643
|
+
* Volume sphere diameter for the waist joint.
|
|
27644
|
+
*
|
|
26614
27645
|
* - **ThreadSafety**: ReadSafe
|
|
26615
27646
|
*
|
|
26616
27647
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#WaistSize)
|
|
26617
27648
|
*/
|
|
26618
27649
|
WaistSize: number;
|
|
26619
27650
|
/**
|
|
27651
|
+
* T-pose alignment transform for the waist joint.
|
|
27652
|
+
*
|
|
26620
27653
|
* - **ThreadSafety**: ReadSafe
|
|
26621
27654
|
*
|
|
26622
27655
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#WaistTposeAdjustment)
|
|
26623
27656
|
*/
|
|
26624
27657
|
WaistTposeAdjustment: CFrame;
|
|
26625
27658
|
/**
|
|
27659
|
+
* Returns the joint instance associated with the given name string.
|
|
27660
|
+
*
|
|
26626
27661
|
* - **ThreadSafety**: Safe
|
|
26627
27662
|
*
|
|
26628
27663
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointFromName)
|
|
@@ -26632,6 +27667,8 @@ interface HumanoidRigDescription extends Instance {
|
|
|
26632
27667
|
*/
|
|
26633
27668
|
GetJointFromName(this: HumanoidRigDescription, name: string): Instance | undefined;
|
|
26634
27669
|
/**
|
|
27670
|
+
* Returns the full set of 22 standard joint names in hierarchy order.
|
|
27671
|
+
*
|
|
26635
27672
|
* - **ThreadSafety**: Safe
|
|
26636
27673
|
*
|
|
26637
27674
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointNames)
|
|
@@ -26640,6 +27677,8 @@ interface HumanoidRigDescription extends Instance {
|
|
|
26640
27677
|
*/
|
|
26641
27678
|
GetJointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
26642
27679
|
/**
|
|
27680
|
+
* Returns the 15 joint names used by R15 rigs.
|
|
27681
|
+
*
|
|
26643
27682
|
* - **ThreadSafety**: Safe
|
|
26644
27683
|
*
|
|
26645
27684
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR15JointNames)
|
|
@@ -26648,6 +27687,8 @@ interface HumanoidRigDescription extends Instance {
|
|
|
26648
27687
|
*/
|
|
26649
27688
|
GetR15JointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
26650
27689
|
/**
|
|
27690
|
+
* Returns the 6 joint names used by R6 rigs.
|
|
27691
|
+
*
|
|
26651
27692
|
* - **ThreadSafety**: Safe
|
|
26652
27693
|
*
|
|
26653
27694
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR6JointNames)
|
|
@@ -26759,47 +27800,65 @@ interface IKControl extends Instance {
|
|
|
26759
27800
|
*/
|
|
26760
27801
|
Weight: number;
|
|
26761
27802
|
/**
|
|
27803
|
+
* Returns the number of segments in the IK chain between the `ChainRoot` and the `EndEffector`.
|
|
27804
|
+
*
|
|
26762
27805
|
* - **ThreadSafety**: Unsafe
|
|
26763
27806
|
*
|
|
26764
27807
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IKControl#GetChainCount)
|
|
26765
27808
|
* @param this Specifies a control to generate a procedural animation pose using Inverse Kinematics.
|
|
27809
|
+
* @returns The number of segments in the chain, or `0` if the chain isn't valid.
|
|
26766
27810
|
*/
|
|
26767
27811
|
GetChainCount(this: IKControl): number;
|
|
26768
27812
|
/**
|
|
27813
|
+
* Returns the total length, in studs, of the IK chain between the `ChainRoot` and the `EndEffector`.
|
|
27814
|
+
*
|
|
26769
27815
|
* - **ThreadSafety**: Unsafe
|
|
26770
27816
|
*
|
|
26771
27817
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IKControl#GetChainLength)
|
|
26772
27818
|
* @param this Specifies a control to generate a procedural animation pose using Inverse Kinematics.
|
|
27819
|
+
* @returns The combined length of the chain in studs, or `0` if the chain isn't valid.
|
|
26773
27820
|
*/
|
|
26774
27821
|
GetChainLength(this: IKControl): number;
|
|
26775
27822
|
/**
|
|
27823
|
+
* Returns the `CFrame` of the chain node at the given index, relative to its parent node in the chain.
|
|
27824
|
+
*
|
|
26776
27825
|
* - **ThreadSafety**: Unsafe
|
|
26777
27826
|
*
|
|
26778
27827
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IKControl#GetNodeLocalCFrame)
|
|
26779
27828
|
* @param this Specifies a control to generate a procedural animation pose using Inverse Kinematics.
|
|
26780
|
-
* @param index
|
|
27829
|
+
* @param index The 1-based position of the node in the chain, from `1` (the `ChainRoot`) up to `GetChainCount()` plus `1` (the `EndEffector`).
|
|
27830
|
+
* @returns The node's `CFrame` in the local space of its parent node, or the identity `CFrame` if the index is out of range or the chain hasn't been solved.
|
|
26781
27831
|
*/
|
|
26782
27832
|
GetNodeLocalCFrame(this: IKControl, index: number): CFrame;
|
|
26783
27833
|
/**
|
|
27834
|
+
* Returns the world-space `CFrame` of the chain node at the given index.
|
|
27835
|
+
*
|
|
26784
27836
|
* - **ThreadSafety**: Unsafe
|
|
26785
27837
|
*
|
|
26786
27838
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IKControl#GetNodeWorldCFrame)
|
|
26787
27839
|
* @param this Specifies a control to generate a procedural animation pose using Inverse Kinematics.
|
|
26788
|
-
* @param index
|
|
27840
|
+
* @param index The 1-based position of the node in the chain, from `1` (the `ChainRoot`) up to `GetChainCount()` plus `1` (the `EndEffector`).
|
|
27841
|
+
* @returns The node's world-space `CFrame`, or the identity `CFrame` if the index is out of range or the chain hasn't been solved.
|
|
26789
27842
|
*/
|
|
26790
27843
|
GetNodeWorldCFrame(this: IKControl, index: number): CFrame;
|
|
26791
27844
|
/**
|
|
27845
|
+
* Returns the world-space target `CFrame` the solver aims for before `SmoothTime` smoothing is applied.
|
|
27846
|
+
*
|
|
26792
27847
|
* - **ThreadSafety**: Unsafe
|
|
26793
27848
|
*
|
|
26794
27849
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IKControl#GetRawFinalTarget)
|
|
26795
27850
|
* @param this Specifies a control to generate a procedural animation pose using Inverse Kinematics.
|
|
27851
|
+
* @returns The final target `CFrame`, in world space, before smoothing.
|
|
26796
27852
|
*/
|
|
26797
27853
|
GetRawFinalTarget(this: IKControl): CFrame;
|
|
26798
27854
|
/**
|
|
27855
|
+
* Returns the world-space target `CFrame` the solver aims for after `SmoothTime` smoothing is applied.
|
|
27856
|
+
*
|
|
26799
27857
|
* - **ThreadSafety**: Unsafe
|
|
26800
27858
|
*
|
|
26801
27859
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IKControl#GetSmoothedFinalTarget)
|
|
26802
27860
|
* @param this Specifies a control to generate a procedural animation pose using Inverse Kinematics.
|
|
27861
|
+
* @returns The final target `CFrame`, in world space, after smoothing.
|
|
26803
27862
|
*/
|
|
26804
27863
|
GetSmoothedFinalTarget(this: IKControl): CFrame;
|
|
26805
27864
|
}
|
|
@@ -29383,6 +30442,7 @@ interface LogService extends Instance {
|
|
|
29383
30442
|
*
|
|
29384
30443
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#GetLogHistory)
|
|
29385
30444
|
* @param this A service that allows you to read outputted text.
|
|
30445
|
+
* @returns An array of tables, each containing `message` (string), `messageType` (`MessageType`), `timestamp` (number, in seconds), and optionally `context` (dictionary) for entries logged with structured context.
|
|
29386
30446
|
*/
|
|
29387
30447
|
GetLogHistory(this: LogService): Array<LogInfo>;
|
|
29388
30448
|
/**
|
|
@@ -29720,6 +30780,8 @@ interface MLModelDeliveryService extends Instance {
|
|
|
29720
30780
|
readonly _nominal_MLModelDeliveryService: unique symbol;
|
|
29721
30781
|
}
|
|
29722
30782
|
/**
|
|
30783
|
+
* A service that runs in-engine machine learning inference by loading model bundles and creating inference sessions.
|
|
30784
|
+
*
|
|
29723
30785
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
29724
30786
|
*
|
|
29725
30787
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MLService)
|
|
@@ -29746,12 +30808,15 @@ interface MLService extends Instance {
|
|
|
29746
30808
|
*/
|
|
29747
30809
|
SetPostProcessEnabled(this: MLService, enabled: boolean): void;
|
|
29748
30810
|
/**
|
|
30811
|
+
* Creates an `MLSession` for the model bundle identified by the given asset ID.
|
|
30812
|
+
*
|
|
29749
30813
|
* - **ThreadSafety**: Unsafe
|
|
29750
30814
|
* - **Tags**: Yields
|
|
29751
30815
|
*
|
|
29752
30816
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MLService#CreateSessionAsync)
|
|
29753
|
-
* @param this
|
|
29754
|
-
* @param assetId
|
|
30817
|
+
* @param this A service that runs in-engine machine learning inference by loading model bundles and creating inference sessions.
|
|
30818
|
+
* @param assetId The asset ID of the model bundle to load.
|
|
30819
|
+
* @returns An `MLSession` created from the loaded model bundle.
|
|
29755
30820
|
*/
|
|
29756
30821
|
CreateSessionAsync(this: MLService, assetId: string): MLSession;
|
|
29757
30822
|
/**
|
|
@@ -29849,7 +30914,7 @@ interface MarkerCurve extends Instance {
|
|
|
29849
30914
|
*
|
|
29850
30915
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarkerCurve#GetMarkerAtIndex)
|
|
29851
30916
|
* @param this Represents a list of strings markers in chronological order.
|
|
29852
|
-
* @param index
|
|
30917
|
+
* @param index One-based index of the marker to retrieve, ordered chronologically. Must be within range or the call throws.
|
|
29853
30918
|
* @returns A table containing the time and value of the marker at the provided index.
|
|
29854
30919
|
*/
|
|
29855
30920
|
GetMarkerAtIndex(this: MarkerCurve, index: number): object;
|
|
@@ -31023,6 +32088,8 @@ interface MetaBreakpointManager extends Instance {
|
|
|
31023
32088
|
readonly _nominal_MetaBreakpointManager: unique symbol;
|
|
31024
32089
|
}
|
|
31025
32090
|
/**
|
|
32091
|
+
* A service that connects the engine's MicroProfiler to the data model, feeding context into profile dumps and letting privileged scripts capture them to disk.
|
|
32092
|
+
*
|
|
31026
32093
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
31027
32094
|
*
|
|
31028
32095
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService)
|
|
@@ -31037,26 +32104,52 @@ interface MicroProfilerService extends Instance {
|
|
|
31037
32104
|
*/
|
|
31038
32105
|
readonly _nominal_MicroProfilerService: unique symbol;
|
|
31039
32106
|
/**
|
|
32107
|
+
* Reads profiling capture data from a slot into a provided Luau buffer.
|
|
32108
|
+
*
|
|
31040
32109
|
* - **ThreadSafety**: Unsafe
|
|
31041
32110
|
* - **Tags**: CustomLuaState
|
|
31042
32111
|
*
|
|
31043
32112
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#GetDataInRange)
|
|
32113
|
+
* @param this A service that connects the engine's MicroProfiler to the data model, feeding context into profile dumps and letting privileged scripts capture them to disk.
|
|
32114
|
+
* @param slotId
|
|
32115
|
+
* @param offset
|
|
32116
|
+
* @param size
|
|
32117
|
+
* @param destBuffer
|
|
32118
|
+
* @param destBufferOffset
|
|
32119
|
+
* @returns The number of bytes actually copied into `destBuffer` starting at `destBufferOffset`. Returns `0` if the read fails.
|
|
31044
32120
|
*/
|
|
31045
32121
|
GetDataInRange(this: MicroProfilerService, slotId: number, offset: number, size: number, destBuffer: buffer, destBufferOffset: number): number;
|
|
31046
32122
|
/**
|
|
32123
|
+
* Returns the total byte count of profiling data stored in a slot.
|
|
32124
|
+
*
|
|
31047
32125
|
* - **ThreadSafety**: Unsafe
|
|
31048
32126
|
*
|
|
31049
32127
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#GetDataSize)
|
|
32128
|
+
* @param this A service that connects the engine's MicroProfiler to the data model, feeding context into profile dumps and letting privileged scripts capture them to disk.
|
|
32129
|
+
* @param slotId
|
|
32130
|
+
* @returns The total size, in bytes, of the profiling data available in the slot. Returns `0` when no data is available.
|
|
31050
32131
|
*/
|
|
31051
32132
|
GetDataSize(this: MicroProfilerService, slotId: number): number;
|
|
31052
32133
|
/**
|
|
32134
|
+
* Dispatches a binary command to the MicroProfiler control channel and writes the response into a buffer.
|
|
32135
|
+
*
|
|
31053
32136
|
* - **ThreadSafety**: Unsafe
|
|
31054
32137
|
* - **Tags**: CustomLuaState
|
|
31055
32138
|
*
|
|
31056
32139
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#ProcessCommand)
|
|
32140
|
+
* @param this A service that connects the engine's MicroProfiler to the data model, feeding context into profile dumps and letting privileged scripts capture them to disk.
|
|
32141
|
+
* @param cmdBuf
|
|
32142
|
+
* @param cmdOffset
|
|
32143
|
+
* @param cmdSize
|
|
32144
|
+
* @param respBuf
|
|
32145
|
+
* @param respOffset
|
|
32146
|
+
* @param respSize
|
|
32147
|
+
* @returns The number of bytes written into `respBuf` as the command response. Returns `0` if the command is not run.
|
|
31057
32148
|
*/
|
|
31058
32149
|
ProcessCommand(this: MicroProfilerService, cmdBuf: buffer, cmdOffset: number, cmdSize: number, respBuf: buffer, respOffset: number, respSize: number): number;
|
|
31059
32150
|
/**
|
|
32151
|
+
* Fires when profiling data in a slot has changed since the last frame.
|
|
32152
|
+
*
|
|
31060
32153
|
* - **ThreadSafety**: Unsafe
|
|
31061
32154
|
*
|
|
31062
32155
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#DataChanged)
|
|
@@ -31064,6 +32157,8 @@ interface MicroProfilerService extends Instance {
|
|
|
31064
32157
|
readonly DataChanged: RBXScriptSignal<(slotId: number, flags: number) => void>;
|
|
31065
32158
|
}
|
|
31066
32159
|
/**
|
|
32160
|
+
* Server-side service for submitting player captures to content moderation review and receiving the results asynchronously.
|
|
32161
|
+
*
|
|
31067
32162
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
31068
32163
|
*
|
|
31069
32164
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService)
|
|
@@ -31078,29 +32173,38 @@ interface ModerationService extends Instance {
|
|
|
31078
32173
|
*/
|
|
31079
32174
|
readonly _nominal_ModerationService: unique symbol;
|
|
31080
32175
|
/**
|
|
32176
|
+
* Registers a server-side processor, ordered by `priority`, that is invoked for each moderation review event on reviewable content.
|
|
32177
|
+
*
|
|
31081
32178
|
* - **ThreadSafety**: Unsafe
|
|
31082
32179
|
*
|
|
31083
32180
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#BindReviewableContentEventProcessor)
|
|
31084
|
-
* @param this
|
|
31085
|
-
* @param priority
|
|
31086
|
-
* @param callback
|
|
32181
|
+
* @param this Server-side service for submitting player captures to content moderation review and receiving the results asynchronously.
|
|
32182
|
+
* @param priority Determines the order in which this processor is invoked relative to other bound processors.
|
|
32183
|
+
* @param callback The function invoked for each reviewable-content event. It receives a table describing the event and should return `true` to acknowledge the event or `false` to leave it for redelivery.
|
|
32184
|
+
* @returns A connection that can be disconnected to unregister the processor.
|
|
31087
32185
|
*/
|
|
31088
32186
|
BindReviewableContentEventProcessor(this: ModerationService, priority: number, callback: Callback): RBXScriptConnection;
|
|
31089
32187
|
/**
|
|
32188
|
+
* Returns an opaque key that identifies a screenshot or video capture for use with `CreateReviewableContentAsync()`.
|
|
32189
|
+
*
|
|
31090
32190
|
* - **ThreadSafety**: Unsafe
|
|
31091
32191
|
*
|
|
31092
32192
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentKey)
|
|
31093
|
-
* @param this
|
|
31094
|
-
* @param content
|
|
32193
|
+
* @param this Server-side service for submitting player captures to content moderation review and receiving the results asynchronously.
|
|
32194
|
+
* @param content A `Content` referring to a screenshot or video capture (a temporary URI from `CaptureService:CaptureScreenshot()`, a `ScreenshotCapture`, or a `VideoCapture`).
|
|
32195
|
+
* @returns An opaque content key identifying the capture.
|
|
31095
32196
|
*/
|
|
31096
32197
|
CreateReviewableContentKey(this: ModerationService, content: Content): string;
|
|
31097
32198
|
/**
|
|
32199
|
+
* Registers user-generated captures for moderation review and triggers the owning clients to upload them, returning the reviewable-content ID.
|
|
32200
|
+
*
|
|
31098
32201
|
* - **ThreadSafety**: Unsafe
|
|
31099
32202
|
* - **Tags**: Yields
|
|
31100
32203
|
*
|
|
31101
32204
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentAsync)
|
|
31102
|
-
* @param this
|
|
31103
|
-
* @param config
|
|
32205
|
+
* @param this Server-side service for submitting player captures to content moderation review and receiving the results asynchronously.
|
|
32206
|
+
* @param config A table of parameters describing the content to review, including an optional `Id`, an optional `Ref`, and a `Content` list of image or video items.
|
|
32207
|
+
* @returns The ID of the created reviewable content.
|
|
31104
32208
|
*/
|
|
31105
32209
|
CreateReviewableContentAsync(this: ModerationService, config: object): string;
|
|
31106
32210
|
/**
|
|
@@ -31108,8 +32212,6 @@ interface ModerationService extends Instance {
|
|
|
31108
32212
|
* - **Tags**: Yields
|
|
31109
32213
|
*
|
|
31110
32214
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalRequestReviewableContentReviewAsync)
|
|
31111
|
-
* @param this
|
|
31112
|
-
* @param config
|
|
31113
32215
|
*/
|
|
31114
32216
|
InternalRequestReviewableContentReviewAsync(this: ModerationService, config: object): void;
|
|
31115
32217
|
}
|
|
@@ -31439,6 +32541,8 @@ interface OmniRecommendationsService extends Instance {
|
|
|
31439
32541
|
/**
|
|
31440
32542
|
* **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
31441
32543
|
*
|
|
32544
|
+
* Deprecated Open Cloud API surface for in-experience cloud operations such as user notifications.
|
|
32545
|
+
*
|
|
31442
32546
|
* - **Tags**: NotCreatable, NotReplicated
|
|
31443
32547
|
*
|
|
31444
32548
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1)
|
|
@@ -31457,12 +32561,17 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
31457
32561
|
/**
|
|
31458
32562
|
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
31459
32563
|
*
|
|
32564
|
+
* Creates and returns an `OpenCloudModel` container for a registered model type name.
|
|
32565
|
+
*
|
|
31460
32566
|
* - **ThreadSafety**: Unsafe
|
|
31461
32567
|
* - **Tags**: CustomLuaState
|
|
31462
32568
|
*
|
|
31463
32569
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1#CreateModel)
|
|
31464
32570
|
* @param this **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
31465
|
-
*
|
|
32571
|
+
*
|
|
32572
|
+
* Deprecated Open Cloud API surface for in-experience cloud operations such as user notifications.
|
|
32573
|
+
* @param name The registered model type name (for example, `"UserNotification"`).
|
|
32574
|
+
* @returns An `OpenCloudModel` container wrapping a typed model instance.
|
|
31466
32575
|
*
|
|
31467
32576
|
* @deprecated
|
|
31468
32577
|
*/
|
|
@@ -31470,13 +32579,18 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
31470
32579
|
/**
|
|
31471
32580
|
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
31472
32581
|
*
|
|
32582
|
+
* Deprecated method that attempted to send a user notification via Open Cloud; always errors.
|
|
32583
|
+
*
|
|
31473
32584
|
* - **ThreadSafety**: Unsafe
|
|
31474
32585
|
* - **Tags**: Yields
|
|
31475
32586
|
*
|
|
31476
32587
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1#CreateUserNotificationAsync)
|
|
31477
32588
|
* @param this **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
31478
|
-
*
|
|
31479
|
-
*
|
|
32589
|
+
*
|
|
32590
|
+
* Deprecated Open Cloud API surface for in-experience cloud operations such as user notifications.
|
|
32591
|
+
* @param user The target user identifier.
|
|
32592
|
+
* @param userNotification An `OpenCloudModel` container (from `OpenCloudApiV1:CreateModel()`) populated with notification payload fields.
|
|
32593
|
+
* @returns Unused; the call always errors.
|
|
31480
32594
|
*
|
|
31481
32595
|
* @deprecated
|
|
31482
32596
|
*/
|
|
@@ -31485,6 +32599,8 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
31485
32599
|
/**
|
|
31486
32600
|
* **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
31487
32601
|
*
|
|
32602
|
+
* Deprecated. Do not use for new work; prefer `HttpService` for in-experience HTTP requests.
|
|
32603
|
+
*
|
|
31488
32604
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
31489
32605
|
*
|
|
31490
32606
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudService)
|
|
@@ -31503,27 +32619,36 @@ interface OpenCloudService extends Instance {
|
|
|
31503
32619
|
/**
|
|
31504
32620
|
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
31505
32621
|
*
|
|
32622
|
+
* Returns an `OpenCloudApiV1` object. Always raises an error.
|
|
32623
|
+
*
|
|
31506
32624
|
* - **ThreadSafety**: Unsafe
|
|
31507
32625
|
* - **Tags**:
|
|
31508
32626
|
*
|
|
31509
32627
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudService#GetApiV1)
|
|
31510
32628
|
* @param this **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
31511
32629
|
*
|
|
32630
|
+
* Deprecated. Do not use for new work; prefer `HttpService` for in-experience HTTP requests.
|
|
32631
|
+
*
|
|
31512
32632
|
* @deprecated
|
|
31513
32633
|
*/
|
|
31514
32634
|
GetApiV1(this: OpenCloudService): OpenCloudApiV1;
|
|
31515
32635
|
/**
|
|
31516
32636
|
* **Deprecated:** This method is deprecated. Do not use it for new work.
|
|
31517
32637
|
*
|
|
32638
|
+
* Deprecated. Dispatches a named Open Cloud call and returns its result.
|
|
32639
|
+
*
|
|
31518
32640
|
* - **ThreadSafety**: Unsafe
|
|
31519
32641
|
* - **Tags**: Yields
|
|
31520
32642
|
*
|
|
31521
32643
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudService#InvokeAsync)
|
|
31522
32644
|
* @param this **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
31523
|
-
*
|
|
31524
|
-
*
|
|
31525
|
-
* @param
|
|
31526
|
-
* @param
|
|
32645
|
+
*
|
|
32646
|
+
* Deprecated. Do not use for new work; prefer `HttpService` for in-experience HTTP requests.
|
|
32647
|
+
* @param version API version string identifying the call surface.
|
|
32648
|
+
* @param methodName Name of the Open Cloud method to invoke.
|
|
32649
|
+
* @param arguments A dictionary of arguments forwarded with the call.
|
|
32650
|
+
* @param headers Optional request headers dictionary.
|
|
32651
|
+
* @returns A dictionary containing the response.
|
|
31527
32652
|
*
|
|
31528
32653
|
* @deprecated
|
|
31529
32654
|
*/
|
|
@@ -34820,10 +35945,13 @@ interface ProceduralModel extends Model {
|
|
|
34820
35945
|
*/
|
|
34821
35946
|
Size: Vector3;
|
|
34822
35947
|
/**
|
|
35948
|
+
* Immediately runs any pending generation instead of waiting for the scheduled regeneration.
|
|
35949
|
+
*
|
|
34823
35950
|
* - **ThreadSafety**: Unsafe
|
|
34824
35951
|
*
|
|
34825
35952
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#ForceGeneration)
|
|
34826
35953
|
* @param this Procedural models support edit-time procedural generation. Instead of manually constructing model content, a procedural model generates its contents automatically in response to parameter changes.
|
|
35954
|
+
* @returns Whether the `ProceduralModel` is up to date after the call: `true` if generation completed successfully or nothing needed to be regenerated, `false` otherwise.
|
|
34827
35955
|
*/
|
|
34828
35956
|
ForceGeneration(this: ProceduralModel): boolean;
|
|
34829
35957
|
/**
|
|
@@ -34881,14 +36009,14 @@ interface WorldRoot extends Model {
|
|
|
34881
36009
|
*/
|
|
34882
36010
|
Blockcast(this: WorldRoot, cframe: CFrame, size: Vector3, direction: Vector3, raycastParams?: RaycastParams): RaycastResult | undefined;
|
|
34883
36011
|
/**
|
|
34884
|
-
* Moves
|
|
36012
|
+
* Moves an array of `BaseParts` to an array of `CFrames`.
|
|
34885
36013
|
*
|
|
34886
36014
|
* - **ThreadSafety**: Unsafe
|
|
34887
36015
|
*
|
|
34888
36016
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#BulkMoveTo)
|
|
34889
36017
|
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
34890
|
-
* @param partList
|
|
34891
|
-
* @param cframeList
|
|
36018
|
+
* @param partList An array of `BaseParts` to be moved. Each entry is matched by index to the corresponding entry in `cframeList`.
|
|
36019
|
+
* @param cframeList An array of `CFrames` that the parts will be moved to, matched by index to `partList`. Both arrays must be the same length.
|
|
34892
36020
|
* @param eventMode An `BulkMoveMode` enum specifying which `Changed` events fire during the move. Default is `FireAllEvents`.
|
|
34893
36021
|
*/
|
|
34894
36022
|
BulkMoveTo(this: WorldRoot, partList: Array<Instance>, cframeList: Array<unknown>, eventMode?: CastsToEnum<Enum.BulkMoveMode>): void;
|
|
@@ -36285,6 +37413,7 @@ interface Path extends Instance {
|
|
|
36285
37413
|
*
|
|
36286
37414
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path#GetPointCoordinates)
|
|
36287
37415
|
* @param this Stores the result of paths created by `PathfindingService:CreatePath()`.
|
|
37416
|
+
* @returns An array of `Vector3` positions for each waypoint in the path.
|
|
36288
37417
|
*
|
|
36289
37418
|
* @deprecated GetWaypoints
|
|
36290
37419
|
*/
|
|
@@ -36307,7 +37436,8 @@ interface Path extends Instance {
|
|
|
36307
37436
|
*
|
|
36308
37437
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path#CheckOcclusionAsync)
|
|
36309
37438
|
* @param this Stores the result of paths created by `PathfindingService:CreatePath()`.
|
|
36310
|
-
* @param start
|
|
37439
|
+
* @param start The 1-based index of the waypoint from which to begin checking for occlusion.
|
|
37440
|
+
* @returns The 1-based index of the first blocked waypoint starting from `start`, or `-1` if the path is not blocked.
|
|
36311
37441
|
*/
|
|
36312
37442
|
CheckOcclusionAsync(this: Path, start: number): number;
|
|
36313
37443
|
/**
|
|
@@ -36460,6 +37590,8 @@ interface PathfindingService extends Instance {
|
|
|
36460
37590
|
*/
|
|
36461
37591
|
EmptyCutoff: number;
|
|
36462
37592
|
/**
|
|
37593
|
+
* Creates a `Path` object based on the given agent parameters.
|
|
37594
|
+
*
|
|
36463
37595
|
* - **ThreadSafety**: Unsafe
|
|
36464
37596
|
*
|
|
36465
37597
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingService#CreatePath)
|
|
@@ -37822,111 +38954,6 @@ interface Player extends Instance {
|
|
|
37822
38954
|
readonly OnTeleport: RBXScriptSignal<(teleportState: Enum.TeleportState, placeId: number, spawnName: string) => void>;
|
|
37823
38955
|
readonly Name: string;
|
|
37824
38956
|
}
|
|
37825
|
-
/**
|
|
37826
|
-
* - **Tags**: NotBrowsable
|
|
37827
|
-
*
|
|
37828
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState)
|
|
37829
|
-
*/
|
|
37830
|
-
interface PlayerControlState extends Instance {
|
|
37831
|
-
/**
|
|
37832
|
-
* **DO NOT USE!**
|
|
37833
|
-
*
|
|
37834
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
37835
|
-
* @hidden
|
|
37836
|
-
* @deprecated
|
|
37837
|
-
*/
|
|
37838
|
-
readonly _nominal_PlayerControlState: unique symbol;
|
|
37839
|
-
/**
|
|
37840
|
-
* - **ThreadSafety**: ReadSafe
|
|
37841
|
-
*
|
|
37842
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#Owner)
|
|
37843
|
-
*/
|
|
37844
|
-
Owner: Player | undefined;
|
|
37845
|
-
/**
|
|
37846
|
-
* - **ThreadSafety**: Unsafe
|
|
37847
|
-
*
|
|
37848
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddBoolField)
|
|
37849
|
-
*/
|
|
37850
|
-
AddBoolField(this: PlayerControlState, name: string, defaultValue?: boolean): void;
|
|
37851
|
-
/**
|
|
37852
|
-
* - **ThreadSafety**: Unsafe
|
|
37853
|
-
*
|
|
37854
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddCFrameField)
|
|
37855
|
-
*/
|
|
37856
|
-
AddCFrameField(this: PlayerControlState, name: string, defaultValue?: CFrame): void;
|
|
37857
|
-
/**
|
|
37858
|
-
* - **ThreadSafety**: Unsafe
|
|
37859
|
-
*
|
|
37860
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddInstanceField)
|
|
37861
|
-
*/
|
|
37862
|
-
AddInstanceField(this: PlayerControlState, name: string): void;
|
|
37863
|
-
/**
|
|
37864
|
-
* - **ThreadSafety**: Unsafe
|
|
37865
|
-
*
|
|
37866
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddIntField)
|
|
37867
|
-
*/
|
|
37868
|
-
AddIntField(this: PlayerControlState, name: string, defaultValue?: number, min?: number, max?: number): void;
|
|
37869
|
-
/**
|
|
37870
|
-
* - **ThreadSafety**: Unsafe
|
|
37871
|
-
*
|
|
37872
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddNumberField)
|
|
37873
|
-
*/
|
|
37874
|
-
AddNumberField(this: PlayerControlState, name: string, defaultValue?: number, min?: number, max?: number): void;
|
|
37875
|
-
/**
|
|
37876
|
-
* - **ThreadSafety**: Unsafe
|
|
37877
|
-
*
|
|
37878
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddUnitVector3Field)
|
|
37879
|
-
*/
|
|
37880
|
-
AddUnitVector3Field(this: PlayerControlState, name: string, defaultValue?: Vector3): void;
|
|
37881
|
-
/**
|
|
37882
|
-
* - **ThreadSafety**: Unsafe
|
|
37883
|
-
*
|
|
37884
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddVector2Field)
|
|
37885
|
-
*/
|
|
37886
|
-
AddVector2Field(this: PlayerControlState, name: string, defaultValue?: Vector2, maxMagnitude?: number): void;
|
|
37887
|
-
/**
|
|
37888
|
-
* - **ThreadSafety**: Unsafe
|
|
37889
|
-
*
|
|
37890
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddVector3Field)
|
|
37891
|
-
*/
|
|
37892
|
-
AddVector3Field(this: PlayerControlState, name: string, defaultValue?: Vector3, maxMagnitude?: number): void;
|
|
37893
|
-
/**
|
|
37894
|
-
* - **ThreadSafety**: Unsafe
|
|
37895
|
-
*
|
|
37896
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#GetChangedState)
|
|
37897
|
-
*/
|
|
37898
|
-
GetChangedState(this: PlayerControlState, prev?: CastsToEnum<Enum.StateReferenceFrame>, next?: CastsToEnum<Enum.StateReferenceFrame>): object;
|
|
37899
|
-
/**
|
|
37900
|
-
* - **ThreadSafety**: Unsafe
|
|
37901
|
-
*
|
|
37902
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#GetReplicationWeight)
|
|
37903
|
-
*/
|
|
37904
|
-
GetReplicationWeight(this: PlayerControlState): number;
|
|
37905
|
-
/**
|
|
37906
|
-
* - **ThreadSafety**: Unsafe
|
|
37907
|
-
*
|
|
37908
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#GetState)
|
|
37909
|
-
*/
|
|
37910
|
-
GetState(this: PlayerControlState, ref?: CastsToEnum<Enum.StateReferenceFrame>): object;
|
|
37911
|
-
/**
|
|
37912
|
-
* - **ThreadSafety**: Unsafe
|
|
37913
|
-
*
|
|
37914
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#SetField)
|
|
37915
|
-
*/
|
|
37916
|
-
SetField(this: PlayerControlState, name: string, value: unknown): void;
|
|
37917
|
-
/**
|
|
37918
|
-
* - **ThreadSafety**: Unsafe
|
|
37919
|
-
*
|
|
37920
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#UpdateFields)
|
|
37921
|
-
*/
|
|
37922
|
-
UpdateFields(this: PlayerControlState, state: object): void;
|
|
37923
|
-
/**
|
|
37924
|
-
* - **ThreadSafety**: Unsafe
|
|
37925
|
-
*
|
|
37926
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#OnStateChanged)
|
|
37927
|
-
*/
|
|
37928
|
-
readonly OnStateChanged: RBXScriptSignal<() => void>;
|
|
37929
|
-
}
|
|
37930
38957
|
/**
|
|
37931
38958
|
* - **Tags**: NotCreatable, NotReplicated
|
|
37932
38959
|
*
|
|
@@ -39764,6 +40791,8 @@ interface RecommendationService extends Instance {
|
|
|
39764
40791
|
*/
|
|
39765
40792
|
readonly _nominal_RecommendationService: unique symbol;
|
|
39766
40793
|
/**
|
|
40794
|
+
* Logs a user action, such as a reaction or play, taken on a recommended item.
|
|
40795
|
+
*
|
|
39767
40796
|
* - **ThreadSafety**: Unsafe
|
|
39768
40797
|
*
|
|
39769
40798
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogActionEvent)
|
|
@@ -39778,6 +40807,8 @@ interface RecommendationService extends Instance {
|
|
|
39778
40807
|
*/
|
|
39779
40808
|
LogActionEvent(this: RecommendationService, actionType: CastsToEnum<Enum.RecommendationActionType>, itemId: string, tracingId: string, actionEventDetails?: object): void;
|
|
39780
40809
|
/**
|
|
40810
|
+
* Logs an impression event, such as a user viewing a recommended item.
|
|
40811
|
+
*
|
|
39781
40812
|
* - **ThreadSafety**: Unsafe
|
|
39782
40813
|
*
|
|
39783
40814
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogImpressionEvent)
|
|
@@ -39792,6 +40823,8 @@ interface RecommendationService extends Instance {
|
|
|
39792
40823
|
*/
|
|
39793
40824
|
LogImpressionEvent(this: RecommendationService, impressionType: CastsToEnum<Enum.RecommendationImpressionType>, itemId: string, tracingId: string, impressionEventDetails?: object): void;
|
|
39794
40825
|
/**
|
|
40826
|
+
* Logs a user preference signal, such as follow or mute, toward a user, universe, or custom content tag.
|
|
40827
|
+
*
|
|
39795
40828
|
* - **ThreadSafety**: Unsafe
|
|
39796
40829
|
*
|
|
39797
40830
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogPreferenceEvent)
|
|
@@ -39804,6 +40837,8 @@ interface RecommendationService extends Instance {
|
|
|
39804
40837
|
*/
|
|
39805
40838
|
LogPreferenceEvent(this: RecommendationService, preferenceType: CastsToEnum<Enum.RecommendationPreferenceType>, targetType: CastsToEnum<Enum.RecommendationPreferenceTargetType>, targetId: string, tracingId?: string, itemId?: string): void;
|
|
39806
40839
|
/**
|
|
40840
|
+
* Returns a paginated list of personalized recommendation items for the specified request configuration.
|
|
40841
|
+
*
|
|
39807
40842
|
* - **ThreadSafety**: Unsafe
|
|
39808
40843
|
* - **Tags**: Yields
|
|
39809
40844
|
*
|
|
@@ -39812,11 +40847,16 @@ interface RecommendationService extends Instance {
|
|
|
39812
40847
|
* @param generateRecommendationItemListRequest A dictionary containing the following fields: - `ConfigName` — A unique ID for the specific configuration. This determines how the candidates are ranked.
|
|
39813
40848
|
* - `LocationId` — A developer-defined string that specifies the location where the recommendation is used, such as `"For_you"` or `"Lobby"`. This parameter will not affect the items returned, and it can help you track the performance of multiple recommendation features within your experience. Recommendation metrics for each individual location will be displayed in the Creator Hub. `LocationId` **must** be a string and cannot be `"Other"` or `"other"` as these values are reserved by the Creator Hub.
|
|
39814
40849
|
* - `PageSize` — The number of items returned for each page.
|
|
39815
|
-
* - `BoostCustomTags` — A list of string tags. Any item with this tag will be boosted in ranking.
|
|
40850
|
+
* - `BoostCustomTags` — A list of string tags. Any item with this tag will be boosted in ranking. Supports boosting one tag.
|
|
39816
40851
|
* - `CustomContexts` — A table of key-value pairs used to pass in additional context data for ranking. For example, `UserId` for a Server script.
|
|
40852
|
+
*
|
|
40853
|
+
*
|
|
40854
|
+
* @returns A `RecommendationPages` object containing the paginated list of recommended items for the given request configuration.
|
|
39817
40855
|
*/
|
|
39818
40856
|
GenerateItemListAsync(this: RecommendationService, generateRecommendationItemListRequest: object): RecommendationPages;
|
|
39819
40857
|
/**
|
|
40858
|
+
* Retrieves a single registered recommendation item by its `ItemId`.
|
|
40859
|
+
*
|
|
39820
40860
|
* - **ThreadSafety**: Unsafe
|
|
39821
40861
|
* - **Tags**: Yields
|
|
39822
40862
|
*
|
|
@@ -39833,6 +40873,8 @@ interface RecommendationService extends Instance {
|
|
|
39833
40873
|
*/
|
|
39834
40874
|
GetRecommendationItemAsync(this: RecommendationService, itemId: string): object;
|
|
39835
40875
|
/**
|
|
40876
|
+
* Registers a new item on the server so it can be included in recommendations, returning the generated `ItemId` and `ReferenceId`.
|
|
40877
|
+
*
|
|
39836
40878
|
* - **ThreadSafety**: Unsafe
|
|
39837
40879
|
* - **Tags**: Yields
|
|
39838
40880
|
*
|
|
@@ -39851,6 +40893,8 @@ interface RecommendationService extends Instance {
|
|
|
39851
40893
|
*/
|
|
39852
40894
|
RegisterItemAsync(this: RecommendationService, player: Player, registerRecommendationItemsRequest: object): object;
|
|
39853
40895
|
/**
|
|
40896
|
+
* Removes a registered item from the recommendation system by its `ItemId`.
|
|
40897
|
+
*
|
|
39854
40898
|
* - **ThreadSafety**: Unsafe
|
|
39855
40899
|
* - **Tags**: Yields
|
|
39856
40900
|
*
|
|
@@ -39860,6 +40904,8 @@ interface RecommendationService extends Instance {
|
|
|
39860
40904
|
*/
|
|
39861
40905
|
RemoveItemAsync(this: RecommendationService, itemId: string): void;
|
|
39862
40906
|
/**
|
|
40907
|
+
* Updates the mutable attributes of an existing recommendation item.
|
|
40908
|
+
*
|
|
39863
40909
|
* - **ThreadSafety**: Unsafe
|
|
39864
40910
|
* - **Tags**: Yields
|
|
39865
40911
|
*
|
|
@@ -40331,7 +41377,8 @@ interface RotationCurve extends Instance {
|
|
|
40331
41377
|
*
|
|
40332
41378
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotationCurve#GetKeyAtIndex)
|
|
40333
41379
|
* @param this Represents a sequence of rotations and the interpolation curve between them.
|
|
40334
|
-
* @param index
|
|
41380
|
+
* @param index Index of the key to return.
|
|
41381
|
+
* @returns Copy of the `RotationCurveKey` stored at `index`.
|
|
40335
41382
|
*/
|
|
40336
41383
|
GetKeyAtIndex(this: RotationCurve, index: number): RotationCurveKey;
|
|
40337
41384
|
/**
|
|
@@ -40341,7 +41388,8 @@ interface RotationCurve extends Instance {
|
|
|
40341
41388
|
*
|
|
40342
41389
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotationCurve#GetKeyIndicesAtTime)
|
|
40343
41390
|
* @param this Represents a sequence of rotations and the interpolation curve between them.
|
|
40344
|
-
* @param time
|
|
41391
|
+
* @param time Time to look up within the curve.
|
|
41392
|
+
* @returns Array with the indices of the keys that bracket `time`.
|
|
40345
41393
|
*/
|
|
40346
41394
|
GetKeyIndicesAtTime(this: RotationCurve, time: number): Array<unknown>;
|
|
40347
41395
|
/**
|
|
@@ -40764,6 +41812,8 @@ interface ScreenshotHud extends Instance {
|
|
|
40764
41812
|
*/
|
|
40765
41813
|
CameraButtonIcon: ContentId;
|
|
40766
41814
|
/**
|
|
41815
|
+
* The image content used as the icon for the camera button.
|
|
41816
|
+
*
|
|
40767
41817
|
* - **ThreadSafety**: ReadSafe
|
|
40768
41818
|
*
|
|
40769
41819
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#CameraButtonIconContent)
|
|
@@ -40807,12 +41857,16 @@ interface ScreenshotHud extends Instance {
|
|
|
40807
41857
|
*/
|
|
40808
41858
|
ExperienceNameOverlayEnabled: boolean;
|
|
40809
41859
|
/**
|
|
41860
|
+
* Whether Roblox's core GUI is hidden while a screenshot is captured.
|
|
41861
|
+
*
|
|
40810
41862
|
* - **ThreadSafety**: ReadSafe
|
|
40811
41863
|
*
|
|
40812
41864
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#HideCoreGuiForCaptures)
|
|
40813
41865
|
*/
|
|
40814
41866
|
HideCoreGuiForCaptures: boolean;
|
|
40815
41867
|
/**
|
|
41868
|
+
* Whether the local player's GUI is hidden while a screenshot is captured.
|
|
41869
|
+
*
|
|
40816
41870
|
* - **ThreadSafety**: ReadSafe
|
|
40817
41871
|
*
|
|
40818
41872
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#HidePlayerGuiForCaptures)
|
|
@@ -40834,7 +41888,7 @@ interface ScreenshotHud extends Instance {
|
|
|
40834
41888
|
/**
|
|
40835
41889
|
* **Deprecated:** This property is deprecated. Do not use it for new work.
|
|
40836
41890
|
*
|
|
40837
|
-
*
|
|
41891
|
+
* Has no effect.
|
|
40838
41892
|
*
|
|
40839
41893
|
* - **ThreadSafety**: ReadSafe
|
|
40840
41894
|
* - **Tags**: Hidden
|
|
@@ -40907,7 +41961,7 @@ interface SyncScriptBuilder extends ScriptBuilder {
|
|
|
40907
41961
|
*/
|
|
40908
41962
|
PackAsSource: boolean;
|
|
40909
41963
|
/**
|
|
40910
|
-
* **Deprecated:**
|
|
41964
|
+
* **Deprecated:**
|
|
40911
41965
|
*
|
|
40912
41966
|
* - **ThreadSafety**: ReadSafe
|
|
40913
41967
|
* - **Tags**:
|
|
@@ -41383,6 +42437,8 @@ interface FluidForceSensor extends SensorBase {
|
|
|
41383
42437
|
EvaluateAsync(this: FluidForceSensor, linearVelocity: Vector3, angularVelocity: Vector3, cframe: CFrame): unknown;
|
|
41384
42438
|
}
|
|
41385
42439
|
/**
|
|
42440
|
+
* Serializes and deserializes `instances` to and from the `.rbxm` format.
|
|
42441
|
+
*
|
|
41386
42442
|
* - **Tags**: NotCreatable, Service
|
|
41387
42443
|
*
|
|
41388
42444
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SerializationService)
|
|
@@ -41403,8 +42459,9 @@ interface SerializationService extends Instance {
|
|
|
41403
42459
|
* - **Tags**: Yields
|
|
41404
42460
|
*
|
|
41405
42461
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SerializationService#DeserializeInstancesAsync)
|
|
41406
|
-
* @param this
|
|
41407
|
-
* @param buffer
|
|
42462
|
+
* @param this Serializes and deserializes `instances` to and from the `.rbxm` format.
|
|
42463
|
+
* @param buffer A `buffer` containing the `.rbxm` content to deserialize.
|
|
42464
|
+
* @returns A list of the `instances` reconstructed from the buffer's `.rbxm` content.
|
|
41408
42465
|
*/
|
|
41409
42466
|
DeserializeInstancesAsync(this: SerializationService, buffer: buffer): Array<Instance>;
|
|
41410
42467
|
/**
|
|
@@ -41414,8 +42471,9 @@ interface SerializationService extends Instance {
|
|
|
41414
42471
|
* - **Tags**: Yields
|
|
41415
42472
|
*
|
|
41416
42473
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SerializationService#SerializeInstancesAsync)
|
|
41417
|
-
* @param this
|
|
41418
|
-
* @param inputInstances
|
|
42474
|
+
* @param this Serializes and deserializes `instances` to and from the `.rbxm` format.
|
|
42475
|
+
* @param inputInstances The list of `instances` to serialize.
|
|
42476
|
+
* @returns A `buffer` containing the `.rbxm` content of the serialized instances.
|
|
41419
42477
|
*/
|
|
41420
42478
|
SerializeInstancesAsync(this: SerializationService, inputInstances: Array<Instance>): buffer;
|
|
41421
42479
|
}
|
|
@@ -41663,6 +42721,8 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
41663
42721
|
*/
|
|
41664
42722
|
readonly VIPServerOwnerId: number;
|
|
41665
42723
|
/**
|
|
42724
|
+
* A reference to the `RunService` service.
|
|
42725
|
+
*
|
|
41666
42726
|
* - **ThreadSafety**: ReadSafe
|
|
41667
42727
|
* - **Tags**: NotReplicated
|
|
41668
42728
|
*
|
|
@@ -42340,7 +43400,7 @@ interface SocialService extends Instance {
|
|
|
42340
43400
|
*
|
|
42341
43401
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#GetPlayersByPartyId)
|
|
42342
43402
|
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
42343
|
-
* @param partyId
|
|
43403
|
+
* @param partyId The unique identifier of the party to filter players by, corresponding to a `Player.PartyId` value.
|
|
42344
43404
|
* @returns A table of `Player` objects whose `Player.PartyId` property matches the passed `partyId`.
|
|
42345
43405
|
*/
|
|
42346
43406
|
GetPlayersByPartyId(this: SocialService, partyId: string): Array<Instance>;
|
|
@@ -42442,7 +43502,7 @@ interface SocialService extends Instance {
|
|
|
42442
43502
|
*
|
|
42443
43503
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#GetPartyAsync)
|
|
42444
43504
|
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
42445
|
-
* @param partyId
|
|
43505
|
+
* @param partyId The unique identifier of the party to retrieve member data for, corresponding to a `Player.PartyId` value.
|
|
42446
43506
|
* @returns An array of dictionaries representing the members of the specified party who are currently in the experience.
|
|
42447
43507
|
*/
|
|
42448
43508
|
GetPartyAsync(this: SocialService, partyId: string): Array<unknown>;
|
|
@@ -42491,6 +43551,8 @@ interface SocialService extends Instance {
|
|
|
42491
43551
|
*/
|
|
42492
43552
|
PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
|
|
42493
43553
|
/**
|
|
43554
|
+
* Generates an expiring share link and prompts the given `Player` with the platform share sheet.
|
|
43555
|
+
*
|
|
42494
43556
|
* - **ThreadSafety**: Unsafe
|
|
42495
43557
|
* - **Tags**: Yields
|
|
42496
43558
|
*
|
|
@@ -42545,6 +43607,8 @@ interface SocialService extends Instance {
|
|
|
42545
43607
|
*/
|
|
42546
43608
|
readonly PhoneBookPromptClosed: RBXScriptSignal<(player: Player) => void>;
|
|
42547
43609
|
/**
|
|
43610
|
+
* Fires when the player closes the share sheet opened by `PromptLinkSharingAsync()`.
|
|
43611
|
+
*
|
|
42548
43612
|
* - **ThreadSafety**: Unsafe
|
|
42549
43613
|
*
|
|
42550
43614
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#ShareSheetClosed)
|
|
@@ -44371,6 +45435,8 @@ interface StudioCameraService extends Instance {
|
|
|
44371
45435
|
readonly _nominal_StudioCameraService: unique symbol;
|
|
44372
45436
|
}
|
|
44373
45437
|
/**
|
|
45438
|
+
* A Studio-only service that lets plugins capture screenshots of the active place's 3D viewport.
|
|
45439
|
+
*
|
|
44374
45440
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
44375
45441
|
*
|
|
44376
45442
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCaptureService)
|
|
@@ -44463,6 +45529,8 @@ interface StudioPublishService extends Instance {
|
|
|
44463
45529
|
readonly _nominal_StudioPublishService: unique symbol;
|
|
44464
45530
|
}
|
|
44465
45531
|
/**
|
|
45532
|
+
* Represents a single screenshot captured from Studio, exposing the resulting image buffer and the parameters the capture was taken with.
|
|
45533
|
+
*
|
|
44466
45534
|
* - **Tags**: NotCreatable, NotReplicated
|
|
44467
45535
|
*
|
|
44468
45536
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioScreenshotCapture)
|
|
@@ -44524,21 +45592,28 @@ interface StudioTestService extends Instance {
|
|
|
44524
45592
|
*/
|
|
44525
45593
|
readonly _nominal_StudioTestService: unique symbol;
|
|
44526
45594
|
/**
|
|
45595
|
+
* Adds additional simulated clients to the running multiplayer test session.
|
|
45596
|
+
*
|
|
44527
45597
|
* - **ThreadSafety**: Unsafe
|
|
44528
45598
|
*
|
|
44529
45599
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#AddPlayers)
|
|
44530
45600
|
* @param this Service allowing plugins to automate and customize Test and Run mode testing.
|
|
44531
|
-
* @param numPlayers
|
|
45601
|
+
* @param numPlayers The number of additional client DataModels to add. Must be between 1 and 8.
|
|
44532
45602
|
*/
|
|
44533
45603
|
AddPlayers(this: StudioTestService, numPlayers: number): void;
|
|
44534
45604
|
/**
|
|
45605
|
+
* Returns whether the calling client DataModel can disconnect from the test.
|
|
45606
|
+
*
|
|
44535
45607
|
* - **ThreadSafety**: Unsafe
|
|
44536
45608
|
*
|
|
44537
45609
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#CanLeaveTest)
|
|
44538
45610
|
* @param this Service allowing plugins to automate and customize Test and Run mode testing.
|
|
45611
|
+
* @returns `true` if the client can leave, `false` otherwise.
|
|
44539
45612
|
*/
|
|
44540
45613
|
CanLeaveTest(this: StudioTestService): boolean;
|
|
44541
45614
|
/**
|
|
45615
|
+
* Ends the current Studio test session from the server DataModel.
|
|
45616
|
+
*
|
|
44542
45617
|
* - **ThreadSafety**: Unsafe
|
|
44543
45618
|
*
|
|
44544
45619
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#EndTest)
|
|
@@ -44547,6 +45622,8 @@ interface StudioTestService extends Instance {
|
|
|
44547
45622
|
*/
|
|
44548
45623
|
EndTest(this: StudioTestService, value: unknown): void;
|
|
44549
45624
|
/**
|
|
45625
|
+
* Returns the argument passed to the method that started the current test session.
|
|
45626
|
+
*
|
|
44550
45627
|
* - **ThreadSafety**: Unsafe
|
|
44551
45628
|
*
|
|
44552
45629
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#GetTestArgs)
|
|
@@ -44555,6 +45632,8 @@ interface StudioTestService extends Instance {
|
|
|
44555
45632
|
*/
|
|
44556
45633
|
GetTestArgs(this: StudioTestService): unknown;
|
|
44557
45634
|
/**
|
|
45635
|
+
* Disconnects the calling client from the active multiplayer test.
|
|
45636
|
+
*
|
|
44558
45637
|
* - **ThreadSafety**: Unsafe
|
|
44559
45638
|
*
|
|
44560
45639
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#LeaveTest)
|
|
@@ -46162,6 +47241,8 @@ interface TestService extends Instance {
|
|
|
46162
47241
|
readonly ServerCollectResult: RBXScriptSignal<(text: string, script: Instance, line: number) => void>;
|
|
46163
47242
|
}
|
|
46164
47243
|
/**
|
|
47244
|
+
* A service that manages a user's `TextBox` state during gameplay.
|
|
47245
|
+
*
|
|
46165
47246
|
* - **Tags**: NotCreatable, Service
|
|
46166
47247
|
*
|
|
46167
47248
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBoxService)
|
|
@@ -46218,7 +47299,7 @@ interface TextChannel extends Instance {
|
|
|
46218
47299
|
*
|
|
46219
47300
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChannel#SetDirectChatRequester)
|
|
46220
47301
|
* @param this Represents a text chat channel.
|
|
46221
|
-
* @param requester
|
|
47302
|
+
* @param requester The `Player` whose direct-message permissions gate the channel; only users who can send direct messages to this player are delivered messages on the channel.
|
|
46222
47303
|
*/
|
|
46223
47304
|
SetDirectChatRequester(this: TextChannel, requester: Player): void;
|
|
46224
47305
|
/**
|
|
@@ -46281,6 +47362,7 @@ interface TextChannel extends Instance {
|
|
|
46281
47362
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChannel#ShouldDeliverCallback)
|
|
46282
47363
|
* @param message The message being sent, which also contains the sender of the message.
|
|
46283
47364
|
* @param textSource The `TextSource` of the user who will be receiving the message.
|
|
47365
|
+
* @returns A truthy value (such as `true`, `1`, or a non-empty string) to deliver the message to the given client, or a falsy value (including `nil`) to withhold it from that client.
|
|
46284
47366
|
*/
|
|
46285
47367
|
ShouldDeliverCallback: (message: TextChatMessage, textSource: TextSource) => boolean;
|
|
46286
47368
|
}
|
|
@@ -46299,6 +47381,8 @@ interface TextChatCommand extends Instance {
|
|
|
46299
47381
|
*/
|
|
46300
47382
|
readonly _nominal_TextChatCommand: unique symbol;
|
|
46301
47383
|
/**
|
|
47384
|
+
* Determines whether the `TextChatCommand` is shown as a suggestion in the chat autocomplete menu.
|
|
47385
|
+
*
|
|
46302
47386
|
* - **ThreadSafety**: ReadSafe
|
|
46303
47387
|
*
|
|
46304
47388
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatCommand#AutocompleteVisible)
|
|
@@ -46900,6 +47984,7 @@ interface ChatWindowConfiguration extends TextChatConfigurations {
|
|
|
46900
47984
|
*
|
|
46901
47985
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#DeriveNewMessageProperties)
|
|
46902
47986
|
* @param this Configures properties of the default chat window.
|
|
47987
|
+
* @returns A new `ChatWindowMessageProperties` instance whose values you can modify and return from a `TextChatService.OnChatWindowAdded` callback to customize how individual messages appear in the chat window.
|
|
46903
47988
|
*/
|
|
46904
47989
|
DeriveNewMessageProperties(this: ChatWindowConfiguration): ChatWindowMessageProperties;
|
|
46905
47990
|
}
|
|
@@ -46920,12 +48005,16 @@ interface TextChatMessage extends Instance {
|
|
|
46920
48005
|
*/
|
|
46921
48006
|
readonly _nominal_TextChatMessage: unique symbol;
|
|
46922
48007
|
/**
|
|
48008
|
+
* A reference to the `BubbleChatMessageProperties` that overrides the appearance of this message's chat bubble.
|
|
48009
|
+
*
|
|
46923
48010
|
* - **ThreadSafety**: ReadSafe
|
|
46924
48011
|
*
|
|
46925
48012
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#BubbleChatMessageProperties)
|
|
46926
48013
|
*/
|
|
46927
48014
|
BubbleChatMessageProperties: BubbleChatMessageProperties | undefined;
|
|
46928
48015
|
/**
|
|
48016
|
+
* A reference to the `ChatWindowMessageProperties` that overrides the appearance of this message in the chat window.
|
|
48017
|
+
*
|
|
46929
48018
|
* - **ThreadSafety**: ReadSafe
|
|
46930
48019
|
*
|
|
46931
48020
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#ChatWindowMessageProperties)
|
|
@@ -47044,6 +48133,8 @@ interface TextChatMessageProperties extends Instance {
|
|
|
47044
48133
|
Translation: string;
|
|
47045
48134
|
}
|
|
47046
48135
|
/**
|
|
48136
|
+
* Overrides `BubbleChatConfiguration` properties for an individual bubble chat message.
|
|
48137
|
+
*
|
|
47047
48138
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BubbleChatMessageProperties)
|
|
47048
48139
|
*/
|
|
47049
48140
|
interface BubbleChatMessageProperties extends TextChatMessageProperties {
|
|
@@ -47080,6 +48171,8 @@ interface BubbleChatMessageProperties extends TextChatMessageProperties {
|
|
|
47080
48171
|
*/
|
|
47081
48172
|
FontFace: Font;
|
|
47082
48173
|
/**
|
|
48174
|
+
* Determines whether the tail at the bottom of the chat bubble is visible.
|
|
48175
|
+
*
|
|
47083
48176
|
* - **ThreadSafety**: ReadSafe
|
|
47084
48177
|
*
|
|
47085
48178
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BubbleChatMessageProperties#TailVisible)
|
|
@@ -47103,6 +48196,8 @@ interface BubbleChatMessageProperties extends TextChatMessageProperties {
|
|
|
47103
48196
|
TextSize: number;
|
|
47104
48197
|
}
|
|
47105
48198
|
/**
|
|
48199
|
+
* Customizes the appearance of an individual text chat message displayed in the chat window.
|
|
48200
|
+
*
|
|
47106
48201
|
* - **Tags**: NotCreatable
|
|
47107
48202
|
*
|
|
47108
48203
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChatWindowMessageProperties)
|
|
@@ -47233,7 +48328,8 @@ interface TextChatService extends Instance {
|
|
|
47233
48328
|
*
|
|
47234
48329
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatService#CanUserChatAsync)
|
|
47235
48330
|
* @param this A service handling in-experience text chat.
|
|
47236
|
-
* @param userId
|
|
48331
|
+
* @param userId The `Player.UserId` of the user whose chat permission is being checked.
|
|
48332
|
+
* @returns A boolean indicating whether the user has permission to chat.
|
|
47237
48333
|
*/
|
|
47238
48334
|
CanUserChatAsync(this: TextChatService, userId: User): boolean;
|
|
47239
48335
|
/**
|
|
@@ -47244,8 +48340,9 @@ interface TextChatService extends Instance {
|
|
|
47244
48340
|
*
|
|
47245
48341
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatService#CanUsersChatAsync)
|
|
47246
48342
|
* @param this A service handling in-experience text chat.
|
|
47247
|
-
* @param userIdFrom
|
|
47248
|
-
* @param userIdTo
|
|
48343
|
+
* @param userIdFrom The `Player.UserId` of the potential message sender.
|
|
48344
|
+
* @param userIdTo The `Player.UserId` of the potential message receiver.
|
|
48345
|
+
* @returns A boolean indicating whether the two users can exchange messages.
|
|
47249
48346
|
*/
|
|
47250
48347
|
CanUsersChatAsync(this: TextChatService, userIdFrom: User, userIdTo: User): boolean;
|
|
47251
48348
|
/**
|
|
@@ -48171,7 +49268,7 @@ interface TweenService extends Instance {
|
|
|
48171
49268
|
/**
|
|
48172
49269
|
* Calculates a new alpha given an `EasingStyle` and `EasingDirection`.
|
|
48173
49270
|
*
|
|
48174
|
-
* - **ThreadSafety**:
|
|
49271
|
+
* - **ThreadSafety**: Safe
|
|
48175
49272
|
*
|
|
48176
49273
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TweenService#GetValue)
|
|
48177
49274
|
* @param this Used to create `Tweens` which interpolate, or tween, the properties of instances.
|
|
@@ -51119,7 +52216,7 @@ interface Vector3Value extends ValueBase {
|
|
|
51119
52216
|
readonly Changed: RBXScriptSignal<(value: Vector3) => void>;
|
|
51120
52217
|
}
|
|
51121
52218
|
/**
|
|
51122
|
-
* A sorted list of time-value pairs that define a curve. Used to animate
|
|
52219
|
+
* A sorted list of time-value pairs that define a curve. Used to animate any type of value.
|
|
51123
52220
|
*
|
|
51124
52221
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve)
|
|
51125
52222
|
*/
|
|
@@ -51156,8 +52253,9 @@ interface ValueCurve extends Instance {
|
|
|
51156
52253
|
* - **ThreadSafety**: Unsafe
|
|
51157
52254
|
*
|
|
51158
52255
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeyAtIndex)
|
|
51159
|
-
* @param this A sorted list of time-value pairs that define a curve. Used to animate
|
|
52256
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate any type of value.
|
|
51160
52257
|
* @param index The index in the existing set of keys held by this `ValueCurve`.
|
|
52258
|
+
* @returns A copy of the `ValueCurveKey` stored at the given `index`.
|
|
51161
52259
|
*/
|
|
51162
52260
|
GetKeyAtIndex(this: ValueCurve, index: number): ValueCurveKey;
|
|
51163
52261
|
/**
|
|
@@ -51166,8 +52264,9 @@ interface ValueCurve extends Instance {
|
|
|
51166
52264
|
* - **ThreadSafety**: Unsafe
|
|
51167
52265
|
*
|
|
51168
52266
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeyIndicesAtTime)
|
|
51169
|
-
* @param this A sorted list of time-value pairs that define a curve. Used to animate
|
|
52267
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate any type of value.
|
|
51170
52268
|
* @param time A time during the animation. Inputs will be clamped between `0` and the time of the last key held by this `ValueCurve`.
|
|
52269
|
+
* @returns An array of two indices bracketing `time`: the index of the last key at or before `time`, and the index of the first key at or after `time`.
|
|
51171
52270
|
*/
|
|
51172
52271
|
GetKeyIndicesAtTime(this: ValueCurve, time: number): Array<unknown>;
|
|
51173
52272
|
/**
|
|
@@ -51176,7 +52275,7 @@ interface ValueCurve extends Instance {
|
|
|
51176
52275
|
* - **ThreadSafety**: Unsafe
|
|
51177
52276
|
*
|
|
51178
52277
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeys)
|
|
51179
|
-
* @param this A sorted list of time-value pairs that define a curve. Used to animate
|
|
52278
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate any type of value.
|
|
51180
52279
|
* @returns Array of `ValueCurveKeys`.
|
|
51181
52280
|
*/
|
|
51182
52281
|
GetKeys(this: ValueCurve): Array<unknown>;
|
|
@@ -51186,7 +52285,7 @@ interface ValueCurve extends Instance {
|
|
|
51186
52285
|
* - **ThreadSafety**: Unsafe
|
|
51187
52286
|
*
|
|
51188
52287
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetValueAtTime)
|
|
51189
|
-
* @param this A sorted list of time-value pairs that define a curve. Used to animate
|
|
52288
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate any type of value.
|
|
51190
52289
|
* @param time Time at which to sample the curve.
|
|
51191
52290
|
* @returns Value of the curve at the requested `time`.
|
|
51192
52291
|
*/
|
|
@@ -51197,7 +52296,7 @@ interface ValueCurve extends Instance {
|
|
|
51197
52296
|
* - **ThreadSafety**: Unsafe
|
|
51198
52297
|
*
|
|
51199
52298
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#InsertKey)
|
|
51200
|
-
* @param this A sorted list of time-value pairs that define a curve. Used to animate
|
|
52299
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate any type of value.
|
|
51201
52300
|
* @param key `ValueCurveKey` to insert.
|
|
51202
52301
|
* @returns (see description)
|
|
51203
52302
|
*/
|
|
@@ -51208,7 +52307,7 @@ interface ValueCurve extends Instance {
|
|
|
51208
52307
|
* - **ThreadSafety**: Unsafe
|
|
51209
52308
|
*
|
|
51210
52309
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#InsertKeyValue)
|
|
51211
|
-
* @param this A sorted list of time-value pairs that define a curve. Used to animate
|
|
52310
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate any type of value.
|
|
51212
52311
|
* @param time Time at which to insert the new `ValueCurveKey`. - type: number
|
|
51213
52312
|
* @param value Value of the inserted `ValueCurveKey`. - type: any
|
|
51214
52313
|
* @param Interpolation Interpolation mode of the inserted `ValueCurveKey`. - type: KeyInterpolationMode
|
|
@@ -51221,7 +52320,7 @@ interface ValueCurve extends Instance {
|
|
|
51221
52320
|
* - **ThreadSafety**: Unsafe
|
|
51222
52321
|
*
|
|
51223
52322
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#RemoveKeyAtIndex)
|
|
51224
|
-
* @param this A sorted list of time-value pairs that define a curve. Used to animate
|
|
52323
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate any type of value.
|
|
51225
52324
|
* @param startingIndex Starting index from which to remove keys.
|
|
51226
52325
|
* @param count Number of keys to remove.
|
|
51227
52326
|
* @returns Number of keys removed.
|
|
@@ -51233,7 +52332,7 @@ interface ValueCurve extends Instance {
|
|
|
51233
52332
|
* - **ThreadSafety**: Unsafe
|
|
51234
52333
|
*
|
|
51235
52334
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ValueCurve#SetKeys)
|
|
51236
|
-
* @param this A sorted list of time-value pairs that define a curve. Used to animate
|
|
52335
|
+
* @param this A sorted list of time-value pairs that define a curve. Used to animate any type of value.
|
|
51237
52336
|
* @param keys Array of `ValueCurveKeys`.
|
|
51238
52337
|
* @returns Number of keys inserted.
|
|
51239
52338
|
*/
|
|
@@ -51275,6 +52374,7 @@ interface Vector3Curve extends Instance {
|
|
|
51275
52374
|
*
|
|
51276
52375
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Vector3Curve#X)
|
|
51277
52376
|
* @param this Represents a 3D vector curve, grouping three `FloatCurve` instances.
|
|
52377
|
+
* @returns The `FloatCurve` controlling the X channel, or a newly created empty `FloatCurve` if none exists yet.
|
|
51278
52378
|
*/
|
|
51279
52379
|
X(this: Vector3Curve): FloatCurve;
|
|
51280
52380
|
/**
|
|
@@ -51284,6 +52384,7 @@ interface Vector3Curve extends Instance {
|
|
|
51284
52384
|
*
|
|
51285
52385
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Vector3Curve#Y)
|
|
51286
52386
|
* @param this Represents a 3D vector curve, grouping three `FloatCurve` instances.
|
|
52387
|
+
* @returns The `FloatCurve` controlling the Y channel, or a newly created empty `FloatCurve` if none exists yet.
|
|
51287
52388
|
*/
|
|
51288
52389
|
Y(this: Vector3Curve): FloatCurve;
|
|
51289
52390
|
/**
|
|
@@ -51293,6 +52394,7 @@ interface Vector3Curve extends Instance {
|
|
|
51293
52394
|
*
|
|
51294
52395
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Vector3Curve#Z)
|
|
51295
52396
|
* @param this Represents a 3D vector curve, grouping three `FloatCurve` instances.
|
|
52397
|
+
* @returns The `FloatCurve` controlling the Z channel, or a newly created empty `FloatCurve` if none exists yet.
|
|
51296
52398
|
*/
|
|
51297
52399
|
Z(this: Vector3Curve): FloatCurve;
|
|
51298
52400
|
}
|
|
@@ -52230,6 +53332,8 @@ interface LuauExpression extends RBXObject {
|
|
|
52230
53332
|
readonly _nominal_LuauExpression: unique symbol;
|
|
52231
53333
|
}
|
|
52232
53334
|
/**
|
|
53335
|
+
* A machine-learning inference session that wraps a single loaded model and runs it through `MLSession:ForwardAsync()`.
|
|
53336
|
+
*
|
|
52233
53337
|
* - **Tags**: NotCreatable, NotReplicated
|
|
52234
53338
|
*
|
|
52235
53339
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MLSession)
|
|
@@ -52244,12 +53348,15 @@ interface MLSession extends RBXObject {
|
|
|
52244
53348
|
*/
|
|
52245
53349
|
readonly _nominal_MLSession: unique symbol;
|
|
52246
53350
|
/**
|
|
53351
|
+
* Runs the session's model on the given input and asynchronously returns the model's output.
|
|
53352
|
+
*
|
|
52247
53353
|
* - **ThreadSafety**: Unsafe
|
|
52248
53354
|
* - **Tags**: Yields
|
|
52249
53355
|
*
|
|
52250
53356
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MLSession#ForwardAsync)
|
|
52251
|
-
* @param this
|
|
52252
|
-
* @param data
|
|
53357
|
+
* @param this A machine-learning inference session that wraps a single loaded model and runs it through `MLSession:ForwardAsync()`.
|
|
53358
|
+
* @param data A dictionary mapping each of the model's input names to that input's tensor, given as a nested array of numbers matching the input's shape.
|
|
53359
|
+
* @returns A dictionary mapping each of the model's output names to that output's tensor, given as a nested array of numbers matching the output's shape.
|
|
52253
53360
|
*/
|
|
52254
53361
|
ForwardAsync(this: MLSession, data: object): object;
|
|
52255
53362
|
}
|