@rbxts/types 1.0.918 → 1.0.920

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.
@@ -131,6 +131,7 @@ interface Services {
131
131
  ModerationService: ModerationService;
132
132
  OmniRecommendationsService: OmniRecommendationsService;
133
133
  OpenCloudService: OpenCloudService;
134
+ Packages: Packages;
134
135
  PackageUIService: PackageUIService;
135
136
  PartyEmulatorService: PartyEmulatorService;
136
137
  PatchBundlerFileWatch: PatchBundlerFileWatch;
@@ -178,6 +179,7 @@ interface Services {
178
179
  ScriptCloneWatcherHelper: ScriptCloneWatcherHelper;
179
180
  ScriptCommitService: ScriptCommitService;
180
181
  ScriptContext: ScriptContext;
182
+ ScriptDebuggerService: ScriptDebuggerService;
181
183
  ScriptProfilerService: ScriptProfilerService;
182
184
  ScriptRegistrationService: ScriptRegistrationService;
183
185
  SelectionHighlightManager: SelectionHighlightManager;
@@ -2251,7 +2253,7 @@ interface Instance extends RBXObject {
2251
2253
  */
2252
2254
  Parent: Instance | undefined;
2253
2255
  /**
2254
- * Turns the instance to be a sandboxed container.
2256
+ * When enabled, the instance can only access abilities in its `Capabilities` list.
2255
2257
  *
2256
2258
  * - **ThreadSafety**: ReadSafe
2257
2259
  * - **Tags**: NotReplicated
@@ -2578,7 +2580,7 @@ interface Instance extends RBXObject {
2578
2580
  WaitForChild(this: Instance, childName: string | number): Instance;
2579
2581
  WaitForChild(this: Instance, childName: string | number, timeOut: number): Instance | undefined;
2580
2582
  /**
2581
- * Fires when the `Instance.Parent` property of the object or one of its ancestors is changed.
2583
+ * Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
2582
2584
  *
2583
2585
  * - **ThreadSafety**: Unsafe
2584
2586
  *
@@ -3971,7 +3973,7 @@ interface Animator extends Instance {
3971
3973
  */
3972
3974
  readonly RootMotionWeight: number;
3973
3975
  /**
3974
- * Computes relative velocities between parts and apply them to `Motor6D.Part1`. These relative velocity calculations and assignments happen in the order provided.
3976
+ * Computes relative velocities between parts and applies them to `Motor6D.Part1`.
3975
3977
  *
3976
3978
  * - **ThreadSafety**: Unsafe
3977
3979
  *
@@ -3981,7 +3983,7 @@ interface Animator extends Instance {
3981
3983
  */
3982
3984
  ApplyJointVelocities(this: Animator, motors: Array<Motor6D>): void;
3983
3985
  /**
3984
- * Returns the list of currently playing `AnimationTracks`.
3986
+ * Returns the list of currently active `AnimationTracks`.
3985
3987
  *
3986
3988
  * - **ThreadSafety**: Unsafe
3987
3989
  *
@@ -3990,9 +3992,14 @@ interface Animator extends Instance {
3990
3992
  */
3991
3993
  GetPlayingAnimationTracks(this: Animator): Array<AnimationTrack>;
3992
3994
  /**
3995
+ * Returns an existing `AnimationTrack` on this `Animator` that was loaded from an `Animation` with the given animation ID. Unlike `LoadAnimation()`, this method does not create a new `AnimationTrack` instance.
3996
+ *
3993
3997
  * - **ThreadSafety**: Unsafe
3994
3998
  *
3995
3999
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#GetTrackByAnimationId)
4000
+ * @param this Responsible for the playback and replication of `Animations`.
4001
+ * @param animationId The asset ID of the `Animation` whose loaded track should be retrieved.
4002
+ * @returns The first `AnimationTrack` on this `Animator` that was loaded from the given animation ID, or `nil` if none has been loaded.
3996
4003
  */
3997
4004
  GetTrackByAnimationId(this: Animator, animationId: ContentId): AnimationTrack;
3998
4005
  /**
@@ -4014,7 +4021,7 @@ interface Animator extends Instance {
4014
4021
  */
4015
4022
  RegisterEvaluationParallelCallback(this: Animator, callback: Callback): void;
4016
4023
  /**
4017
- * Fires when the Animator starts playing an AnimationTrack.
4024
+ * Fires when the `Animator` starts playing an `AnimationTrack`.
4018
4025
  *
4019
4026
  * - **ThreadSafety**: Unsafe
4020
4027
  *
@@ -8059,7 +8066,7 @@ interface AvatarCreationService extends Instance {
8059
8066
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptSelectAvatarGenerationImageAsync)
8060
8067
  * @param this A service to support developer avatar creators.
8061
8068
  * @param player The `Player` to prompt for taking a selfie.
8062
- * @returns A string FileId of the selfie.
8069
+ * @returns A string FileId of the selfie on success, or an error string describing the reason for failure.
8063
8070
  */
8064
8071
  PromptSelectAvatarGenerationImageAsync(this: AvatarCreationService, player: Player): string;
8065
8072
  /**
@@ -10935,6 +10942,8 @@ interface CaptureService extends Instance {
10935
10942
  * - **Tags**: Yields
10936
10943
  *
10937
10944
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CheckUploadCaptureStatusAsync)
10945
+ * @param this A service which provides control over screenshot and video capture features.
10946
+ * @param token
10938
10947
  */
10939
10948
  CheckUploadCaptureStatusAsync(this: CaptureService, token: string): unknown;
10940
10949
  /**
@@ -10977,6 +10986,8 @@ interface CaptureService extends Instance {
10977
10986
  * - **Tags**: Yields
10978
10987
  *
10979
10988
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartUploadCaptureAsync)
10989
+ * @param this A service which provides control over screenshot and video capture features.
10990
+ * @param capture
10980
10991
  */
10981
10992
  StartUploadCaptureAsync(this: CaptureService, capture: Capture): unknown;
10982
10993
  /**
@@ -17745,6 +17756,20 @@ interface GenerationService extends Instance {
17745
17756
  * @deprecated
17746
17757
  */
17747
17758
  readonly _nominal_GenerationService: unique symbol;
17759
+ /**
17760
+ * - **ThreadSafety**: Unsafe
17761
+ * - **Tags**: Yields
17762
+ *
17763
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#ConnectAsync)
17764
+ */
17765
+ ConnectAsync(this: GenerationService, sessionId: string, sdp: string, type: string, relay: string): unknown;
17766
+ /**
17767
+ * - **ThreadSafety**: Unsafe
17768
+ * - **Tags**: Yields
17769
+ *
17770
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#DisconnectAsync)
17771
+ */
17772
+ DisconnectAsync(this: GenerationService, sessionId: string): boolean;
17748
17773
  /**
17749
17774
  * Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result.
17750
17775
  *
@@ -17780,6 +17805,20 @@ interface GenerationService extends Instance {
17780
17805
  * - A table containing a UUID and other metadata about the generation.
17781
17806
  */
17782
17807
  GenerateModelAsync(this: GenerationService, inputs: object, schema: object, options?: object): unknown;
17808
+ /**
17809
+ * - **ThreadSafety**: Unsafe
17810
+ * - **Tags**: Yields
17811
+ *
17812
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GetVideoGenSessionAsync)
17813
+ */
17814
+ GetVideoGenSessionAsync(this: GenerationService): unknown;
17815
+ /**
17816
+ * - **ThreadSafety**: Unsafe
17817
+ * - **Tags**: Yields
17818
+ *
17819
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GetVideoGenTriggersAsync)
17820
+ */
17821
+ GetVideoGenTriggersAsync(this: GenerationService, sessionId: string, lookbackSeconds: number): object;
17783
17822
  /**
17784
17823
  * Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`.
17785
17824
  *
@@ -17792,6 +17831,27 @@ interface GenerationService extends Instance {
17792
17831
  * @returns The generated asset, returned as a `Model` with a single `MeshPart` containing an `EditableMesh`.
17793
17832
  */
17794
17833
  LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
17834
+ /**
17835
+ * - **ThreadSafety**: Unsafe
17836
+ * - **Tags**: Yields
17837
+ *
17838
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#StartVideoGenSessionAsync)
17839
+ */
17840
+ StartVideoGenSessionAsync(this: GenerationService, sessionId: string, prompt: string, imageData: string, imageS3Reference: string, triggers: object): boolean;
17841
+ /**
17842
+ * - **ThreadSafety**: Unsafe
17843
+ * - **Tags**: Yields
17844
+ *
17845
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#UpdateVideoGenSessionPromptAsync)
17846
+ */
17847
+ UpdateVideoGenSessionPromptAsync(this: GenerationService, sessionId: string, prompt: string, imageData: string, imageS3Reference: string, mode: string): boolean;
17848
+ /**
17849
+ * - **ThreadSafety**: Unsafe
17850
+ * - **Tags**: Yields
17851
+ *
17852
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#UpdateVideoGenSessionTriggersAsync)
17853
+ */
17854
+ UpdateVideoGenSessionTriggersAsync(this: GenerationService, sessionId: string, triggers: object): boolean;
17795
17855
  }
17796
17856
  /**
17797
17857
  * - **Tags**: NotCreatable, Service
@@ -20598,6 +20658,12 @@ interface VideoFrame extends GuiObject {
20598
20658
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Looped)
20599
20659
  */
20600
20660
  Looped: boolean;
20661
+ /**
20662
+ * - **ThreadSafety**: ReadSafe
20663
+ *
20664
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#MaximumResolution)
20665
+ */
20666
+ MaximumResolution: Enum.VideoSampleSize;
20601
20667
  /**
20602
20668
  * Indicates whether the `VideoFrame.Video` is currently playing. It can be set to start or pause playback.
20603
20669
  *
@@ -23678,9 +23744,12 @@ interface Humanoid extends Instance {
23678
23744
  */
23679
23745
  GetPlayingAnimationTracks(this: Humanoid): Array<AnimationTrack>;
23680
23746
  /**
23747
+ * Returns the humanoid's actual physical velocity relative to the surface it is standing on as a `Vector3` in world-space orientation.
23748
+ *
23681
23749
  * - **ThreadSafety**: Unsafe
23682
23750
  *
23683
23751
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetRelativeVelocityAtFloor)
23752
+ * @param this A special object that gives models the functionality of a character.
23684
23753
  */
23685
23754
  GetRelativeVelocityAtFloor(this: Humanoid): Vector3;
23686
23755
  /**
@@ -28246,6 +28315,18 @@ interface MLService extends Instance {
28246
28315
  * @deprecated
28247
28316
  */
28248
28317
  readonly _nominal_MLService: unique symbol;
28318
+ /**
28319
+ * - **ThreadSafety**: Unsafe
28320
+ *
28321
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MLService#IsPostProcessReady)
28322
+ */
28323
+ IsPostProcessReady(this: MLService): boolean;
28324
+ /**
28325
+ * - **ThreadSafety**: Unsafe
28326
+ *
28327
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MLService#SetPostProcessEnabled)
28328
+ */
28329
+ SetPostProcessEnabled(this: MLService, enabled: boolean): void;
28249
28330
  /**
28250
28331
  * - **ThreadSafety**: Unsafe
28251
28332
  * - **Tags**: Yields
@@ -28255,6 +28336,13 @@ interface MLService extends Instance {
28255
28336
  * @param assetId
28256
28337
  */
28257
28338
  CreateSessionAsync(this: MLService, assetId: string): MLSession;
28339
+ /**
28340
+ * - **ThreadSafety**: Unsafe
28341
+ * - **Tags**: Yields
28342
+ *
28343
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MLService#LoadPostProcessModelAsync)
28344
+ */
28345
+ LoadPostProcessModelAsync(this: MLService, assetId: number): void;
28258
28346
  }
28259
28347
  /**
28260
28348
  * Describes the appearance of a makeup item for the `HumanoidDescription`.
@@ -28398,15 +28486,24 @@ interface MarketplaceService extends Instance {
28398
28486
  */
28399
28487
  readonly _nominal_MarketplaceService: unique symbol;
28400
28488
  /**
28489
+ * Registers a callback to process receipts of a specific type.
28490
+ *
28401
28491
  * - **ThreadSafety**: Unsafe
28402
28492
  *
28403
28493
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#BindReceiptHandler)
28494
+ * @param this The service responsible for in-experience transactions.
28495
+ * @param transactionType The `ReceiptType` indicating which kind of receipt to handle.
28496
+ * @param handler A callback function that receives a receipt info dictionary and must return an `ReceiptDecision` value.
28497
+ * @param filter An optional array of product IDs. When provided, the handler only fires for receipts matching those product IDs. Not supported for `RobuxTransferSender` or `RobuxTransferReceiver` receipt types.
28498
+ * @returns A `RBXScriptConnection` that can be disconnected to unregister the handler.
28404
28499
  */
28405
28500
  BindReceiptHandler(this: MarketplaceService, transactionType: CastsToEnum<Enum.ReceiptType>, handler: Callback, filter?: Array<unknown>): RBXScriptConnection;
28406
28501
  /**
28407
28502
  * - **ThreadSafety**: Unsafe
28408
28503
  *
28409
28504
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#OpenShop)
28505
+ * @param this The service responsible for in-experience transactions.
28506
+ * @param player
28410
28507
  */
28411
28508
  OpenShop(this: MarketplaceService, player: Player): void;
28412
28509
  /**
@@ -28461,6 +28558,8 @@ interface MarketplaceService extends Instance {
28461
28558
  */
28462
28559
  PromptGamePassPurchase(this: MarketplaceService, player: Player, gamePassId: number): void;
28463
28560
  /**
28561
+ * **Deprecated:** This method has been superseded by `PromptRobloxSubscriptionPurchase()`.
28562
+ *
28464
28563
  * Prompts a user to purchase Roblox Premium.
28465
28564
  *
28466
28565
  * - **ThreadSafety**: Unsafe
@@ -28704,10 +28803,17 @@ interface MarketplaceService extends Instance {
28704
28803
  */
28705
28804
  PlayerOwnsBundleAsync(this: MarketplaceService, player: Player, bundleId: number): boolean;
28706
28805
  /**
28806
+ * Initiates a Robux transfer from the sender to another user.
28807
+ *
28707
28808
  * - **ThreadSafety**: Unsafe
28708
28809
  * - **Tags**: Yields
28709
28810
  *
28710
28811
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptRobuxTransferAsync)
28812
+ * @param this The service responsible for in-experience transactions.
28813
+ * @param sender The `Player` initiating the transfer. Must be a valid player currently in the server.
28814
+ * @param receiverUserId The `UserId` of the user who will receive the Robux.
28815
+ * @param amount The amount of Robux to transfer. Must be a positive integer.
28816
+ * @returns A string `transferRequestId` that uniquely identifies this transfer request. Use this ID to correlate with receipts delivered through `BindReceiptHandler`.
28711
28817
  */
28712
28818
  PromptRobuxTransferAsync(this: MarketplaceService, sender: Player, receiverUserId: number, amount: number): string;
28713
28819
  /**
@@ -33582,6 +33688,8 @@ interface Workspace extends WorldRoot {
33582
33688
  */
33583
33689
  DistributedGameTime: number;
33584
33690
  /**
33691
+ * Controls whether parts that fall below `Workspace.FallenPartsDestroyHeight` are automatically destroyed.
33692
+ *
33585
33693
  * - **ThreadSafety**: ReadSafe
33586
33694
  *
33587
33695
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#FallHeightEnabled)
@@ -33612,6 +33720,8 @@ interface Workspace extends WorldRoot {
33612
33720
  */
33613
33721
  Gravity: number;
33614
33722
  /**
33723
+ * The world position at which new objects are placed when inserted from the toolbox.
33724
+ *
33615
33725
  * - **ThreadSafety**: ReadSafe
33616
33726
  * - **Tags**: NotReplicated
33617
33727
  *
@@ -33630,6 +33740,8 @@ interface Workspace extends WorldRoot {
33630
33740
  */
33631
33741
  get InterpolationThrottling(): Enum.InterpolationThrottlingMode;
33632
33742
  /**
33743
+ * Controls whether animation retargeting is enabled for character animations.
33744
+ *
33633
33745
  * - **ThreadSafety**: ReadSafe
33634
33746
  *
33635
33747
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#Retargeting)
@@ -33803,6 +33915,21 @@ interface PackageUIService extends Instance {
33803
33915
  */
33804
33916
  readonly _nominal_PackageUIService: unique symbol;
33805
33917
  }
33918
+ /**
33919
+ * - **Tags**: NotCreatable, Service
33920
+ *
33921
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Packages)
33922
+ */
33923
+ interface Packages extends Instance {
33924
+ /**
33925
+ * **DO NOT USE!**
33926
+ *
33927
+ * This field exists to force TypeScript to recognize this as a nominal type
33928
+ * @hidden
33929
+ * @deprecated
33930
+ */
33931
+ readonly _nominal_Packages: unique symbol;
33932
+ }
33806
33933
  /**
33807
33934
  * An abstract class for pages objects.
33808
33935
  *
@@ -34543,7 +34670,7 @@ interface Path extends Instance {
34543
34670
  */
34544
34671
  readonly _nominal_Path: unique symbol;
34545
34672
  /**
34546
- * The success of the generated `Path`.
34673
+ * The `PathStatus` of the generated `Path`.
34547
34674
  *
34548
34675
  * - **ThreadSafety**: ReadSafe
34549
34676
  * - **Tags**: NotReplicated
@@ -34552,7 +34679,7 @@ interface Path extends Instance {
34552
34679
  */
34553
34680
  readonly Status: Enum.PathStatus;
34554
34681
  /**
34555
- * **Deprecated:** This item has been superseded by `Path:GetWaypoints()` which should be used in all new work instead.
34682
+ * **Deprecated:** This item has been superseded by `GetWaypoints()` which should be used in all new work instead.
34556
34683
  *
34557
34684
  * Returns a table of `Path` instances.
34558
34685
  *
@@ -34654,7 +34781,7 @@ interface PathfindingLink extends Instance {
34654
34781
  */
34655
34782
  IsBidirectional: boolean;
34656
34783
  /**
34657
- * A classifying string to add additional information about the link. This Label is included in the waypoint generated by this link.
34784
+ * A classifying string to add additional information about the link.
34658
34785
  *
34659
34786
  * - **ThreadSafety**: ReadSafe
34660
34787
  *
@@ -34663,7 +34790,7 @@ interface PathfindingLink extends Instance {
34663
34790
  Label: string;
34664
34791
  }
34665
34792
  /**
34666
- * Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using the `PathfindingService`.
34793
+ * Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using `PathfindingService`.
34667
34794
  *
34668
34795
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingModifier)
34669
34796
  */
@@ -34677,7 +34804,7 @@ interface PathfindingModifier extends Instance {
34677
34804
  */
34678
34805
  readonly _nominal_PathfindingModifier: unique symbol;
34679
34806
  /**
34680
- * The name of the navigation area inside or on top of the `Part` volume.
34807
+ * The name of the navigation area inside or on top of the parts enclosed by the modifier.
34681
34808
  *
34682
34809
  * - **ThreadSafety**: ReadSafe
34683
34810
  *
@@ -34727,7 +34854,7 @@ interface PathfindingService extends Instance {
34727
34854
  *
34728
34855
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingService#CreatePath)
34729
34856
  * @param this Used to find logical paths between two points.
34730
- * @param agentParameters Luau table which lets you fine-tune the path for the size of the agent (the humanoid that will move along the path). See above for valid keys, types, and descriptions.
34857
+ * @param agentParameters Lua table which lets you fine-tune the path based on various agent parameters.
34731
34858
  * @returns A `Path` object.
34732
34859
  */
34733
34860
  CreatePath(this: PathfindingService, agentParameters?: AgentParameters): Path;
@@ -35446,6 +35573,12 @@ interface Player extends Instance {
35446
35573
  * @param part The `BasePart` to use as a new replication focus.
35447
35574
  */
35448
35575
  AddReplicationFocus(this: Player, part: BasePart): void;
35576
+ /**
35577
+ * - **ThreadSafety**: Unsafe
35578
+ *
35579
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#ClearCachedAvatarAppearance)
35580
+ */
35581
+ ClearCachedAvatarAppearance(this: Player): void;
35449
35582
  /**
35450
35583
  * Removes all accessories and other character appearance objects from a player's `Character`.
35451
35584
  *
@@ -35724,6 +35857,8 @@ interface Player extends Instance {
35724
35857
  * - **Tags**: Yields
35725
35858
  *
35726
35859
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsWhoPlayedAsync)
35860
+ * @param this An object that represents a presently connected client to the experience.
35861
+ * @returns An array of user IDs.
35727
35862
  */
35728
35863
  GetFriendsWhoPlayedAsync(this: Player): Array<unknown>;
35729
35864
  /**
@@ -36498,7 +36633,7 @@ interface Players extends Instance {
36498
36633
  */
36499
36634
  BanAsync(this: Players, config: BanAsyncConfig): void;
36500
36635
  /**
36501
- * **Deprecated:** This method has been superseded by `CreateHumanoidModelFromDescription()`.
36636
+ * **Deprecated:** This method has been superseded by `CreateHumanoidModelFromDescriptionAsync()`.
36502
36637
  *
36503
36638
  * Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
36504
36639
  *
@@ -37778,6 +37913,18 @@ interface RecommendationService extends Instance {
37778
37913
  * - `DepartureIntent` — The `RecommendationDepartureIntent` indicating the user's intent when leaving a view. For example, `Positive` if the view is considered good.
37779
37914
  */
37780
37915
  LogImpressionEvent(this: RecommendationService, impressionType: CastsToEnum<Enum.RecommendationImpressionType>, itemId: string, tracingId: string, impressionEventDetails?: object): void;
37916
+ /**
37917
+ * - **ThreadSafety**: Unsafe
37918
+ *
37919
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogPreferenceEvent)
37920
+ * @param this A service that provides an interface for you to manage and display personalized content recommendations.
37921
+ * @param preferenceType
37922
+ * @param targetType
37923
+ * @param targetId
37924
+ * @param tracingId
37925
+ * @param itemId
37926
+ */
37927
+ LogPreferenceEvent(this: RecommendationService, preferenceType: CastsToEnum<Enum.RecommendationPreferenceType>, targetType: CastsToEnum<Enum.RecommendationPreferenceTargetType>, targetId: string, tracingId?: string, itemId?: string): void;
37781
37928
  /**
37782
37929
  * - **ThreadSafety**: Unsafe
37783
37930
  * - **Tags**: Yields
@@ -38404,6 +38551,7 @@ interface RunService extends Instance {
38404
38551
  * @param this Service responsible for all runtime activity and progression of time.
38405
38552
  * @param function The function to call. This function will be passed one parameter called `deltaTime` which shows how much time passed between the beginning of the previous simulation step and the beginning of the current simulation step.
38406
38553
  * @param frequency Optional `StepFrequency` value indicating the frequency at which to call the bound function. If not provided, the default frequency will be used.
38554
+ * @param priority Optional priority of the binding as an integer; it determines the order in which bound functions are called within a simulation step. Lower numbers are called first. If two bindings have the same priority, the order between them is unspecified. Defaults to 2000.
38407
38555
  */
38408
38556
  BindToSimulation(this: RunService, callback: Callback, frequency?: CastsToEnum<Enum.StepFrequency>, priority?: number): RBXScriptConnection;
38409
38557
  /**
@@ -38633,6 +38781,8 @@ interface SceneAnalysisService extends Instance {
38633
38781
  * - **Tags**: Yields
38634
38782
  *
38635
38783
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetAnimationMemoryAsync)
38784
+ * @param this
38785
+ * @returns A dictionary tree of loaded animation clip memory, deduplicated by clip.
38636
38786
  */
38637
38787
  GetAnimationMemoryAsync(this: SceneAnalysisService): object;
38638
38788
  /**
@@ -38640,6 +38790,8 @@ interface SceneAnalysisService extends Instance {
38640
38790
  * - **Tags**: Yields
38641
38791
  *
38642
38792
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetAudioMemoryAsync)
38793
+ * @param this
38794
+ * @returns A dictionary tree of loaded audio asset memory, deduplicated by asset ID.
38643
38795
  */
38644
38796
  GetAudioMemoryAsync(this: SceneAnalysisService): object;
38645
38797
  /**
@@ -38647,6 +38799,8 @@ interface SceneAnalysisService extends Instance {
38647
38799
  * - **Tags**: Yields
38648
38800
  *
38649
38801
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetInstanceCompositionAsync)
38802
+ * @param this
38803
+ * @returns A dictionary tree of instance counts grouped by category and class name.
38650
38804
  */
38651
38805
  GetInstanceCompositionAsync(this: SceneAnalysisService): object;
38652
38806
  /**
@@ -38654,6 +38808,8 @@ interface SceneAnalysisService extends Instance {
38654
38808
  * - **Tags**: Yields
38655
38809
  *
38656
38810
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetScriptMemoryAsync)
38811
+ * @param this
38812
+ * @returns A dictionary tree of per-script Luau VM heap memory grouped by service and script type.
38657
38813
  */
38658
38814
  GetScriptMemoryAsync(this: SceneAnalysisService): object;
38659
38815
  /**
@@ -38661,6 +38817,8 @@ interface SceneAnalysisService extends Instance {
38661
38817
  * - **Tags**: Yields
38662
38818
  *
38663
38819
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetTriangleCompositionAsync)
38820
+ * @param this
38821
+ * @returns A dictionary tree of triangle and draw call counts broken down by render pass type.
38664
38822
  */
38665
38823
  GetTriangleCompositionAsync(this: SceneAnalysisService): object;
38666
38824
  /**
@@ -38668,6 +38826,8 @@ interface SceneAnalysisService extends Instance {
38668
38826
  * - **Tags**: Yields
38669
38827
  *
38670
38828
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetUnparentedInstancesAsync)
38829
+ * @param this
38830
+ * @returns A dictionary tree of unparented instances grouped by the host script holding the reference.
38671
38831
  */
38672
38832
  GetUnparentedInstancesAsync(this: SceneAnalysisService): object;
38673
38833
  }
@@ -38922,12 +39082,15 @@ interface ScriptContext extends Instance {
38922
39082
  * - **ThreadSafety**: Unsafe
38923
39083
  *
38924
39084
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#EnableCoverage)
39085
+ * @param this
39086
+ * @param instance
38925
39087
  */
38926
39088
  EnableCoverage(this: ScriptContext, instance: Instance): void;
38927
39089
  /**
38928
39090
  * - **ThreadSafety**: Unsafe
38929
39091
  *
38930
39092
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#GetCoverageStats)
39093
+ * @param this
38931
39094
  */
38932
39095
  GetCoverageStats(this: ScriptContext): Array<unknown>;
38933
39096
  /**
@@ -38939,6 +39102,21 @@ interface ScriptContext extends Instance {
38939
39102
  */
38940
39103
  readonly Error: RBXScriptSignal<(message: string, stackTrace: string, script?: LuaSourceContainer) => void>;
38941
39104
  }
39105
+ /**
39106
+ * - **Tags**: NotCreatable, Service, NotReplicated
39107
+ *
39108
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService)
39109
+ */
39110
+ interface ScriptDebuggerService extends Instance {
39111
+ /**
39112
+ * **DO NOT USE!**
39113
+ *
39114
+ * This field exists to force TypeScript to recognize this as a nominal type
39115
+ * @hidden
39116
+ * @deprecated
39117
+ */
39118
+ readonly _nominal_ScriptDebuggerService: unique symbol;
39119
+ }
38942
39120
  /**
38943
39121
  * - **Tags**: NotCreatable, Service
38944
39122
  *
@@ -39666,6 +39844,12 @@ interface DataModel extends ServiceProvider<Services> {
39666
39844
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#Loaded)
39667
39845
  */
39668
39846
  readonly Loaded: RBXScriptSignal<() => void>;
39847
+ /**
39848
+ * - **ThreadSafety**: Unsafe
39849
+ *
39850
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#ServerLifecycleChanged)
39851
+ */
39852
+ readonly ServerLifecycleChanged: RBXScriptSignal<(serverLifecycleChangedEvent: object) => void>;
39669
39853
  /**
39670
39854
  * **Deprecated:** This function is deprecated. It is recommended to use `DataModel:BindToClose()` instead.
39671
39855
  *
@@ -41319,6 +41503,12 @@ interface SoundService extends Instance {
41319
41503
  * @param sound The `Sound` to be played.
41320
41504
  */
41321
41505
  PlayLocalSound(this: SoundService, sound: Sound): void;
41506
+ /**
41507
+ * - **ThreadSafety**: Unsafe
41508
+ *
41509
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#SetInputDevice)
41510
+ */
41511
+ SetInputDevice(this: SoundService, nameOrInstance: unknown, guidOrPin: string): void;
41322
41512
  /**
41323
41513
  * Sets the listener used by `Sounds`.
41324
41514
  *
@@ -42130,6 +42320,8 @@ interface StudioDeviceEmulatorService extends Instance {
42130
42320
  readonly _nominal_StudioDeviceEmulatorService: unique symbol;
42131
42321
  }
42132
42322
  /**
42323
+ * Service allowing you to control Studio's Device Simulator.
42324
+ *
42133
42325
  * - **Tags**: NotCreatable, Service, NotReplicated
42134
42326
  *
42135
42327
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService)
@@ -42254,12 +42446,15 @@ interface StudioTestService extends Instance {
42254
42446
  * - **ThreadSafety**: Unsafe
42255
42447
  *
42256
42448
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#AddPlayers)
42449
+ * @param this Service allowing plugins to automate and customize Test and Run mode testing.
42450
+ * @param numPlayers
42257
42451
  */
42258
42452
  AddPlayers(this: StudioTestService, numPlayers: number): void;
42259
42453
  /**
42260
42454
  * - **ThreadSafety**: Unsafe
42261
42455
  *
42262
42456
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#CanLeaveTest)
42457
+ * @param this Service allowing plugins to automate and customize Test and Run mode testing.
42263
42458
  */
42264
42459
  CanLeaveTest(this: StudioTestService): boolean;
42265
42460
  /**
@@ -42282,6 +42477,7 @@ interface StudioTestService extends Instance {
42282
42477
  * - **ThreadSafety**: Unsafe
42283
42478
  *
42284
42479
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#LeaveTest)
42480
+ * @param this Service allowing plugins to automate and customize Test and Run mode testing.
42285
42481
  */
42286
42482
  LeaveTest(this: StudioTestService): void;
42287
42483
  }
@@ -42411,9 +42607,13 @@ interface StyleRule extends StyleBase {
42411
42607
  */
42412
42608
  readonly SelectorError: string;
42413
42609
  /**
42610
+ * Returns the default transition applied to all properties of the `StyleRule` that don't have an explicit transition set.
42611
+ *
42414
42612
  * - **ThreadSafety**: Unsafe
42415
42613
  *
42416
42614
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#GetDefaultPropertyTransition)
42615
+ * @param this Defines style properties which override properties on the instances affected by the `Selector` property.
42616
+ * @returns The default transition as a `TweenInfo` or string token, or `nil` if no default transition is set.
42417
42617
  */
42418
42618
  GetDefaultPropertyTransition(this: StyleRule): unknown;
42419
42619
  /**
@@ -42438,16 +42638,23 @@ interface StyleRule extends StyleBase {
42438
42638
  */
42439
42639
  GetProperty(this: StyleRule, name: string): unknown;
42440
42640
  /**
42641
+ * Returns a dictionary of all property transitions set on the `StyleRule`.
42642
+ *
42441
42643
  * - **ThreadSafety**: Unsafe
42442
42644
  *
42443
42645
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#GetPropertyTransitions)
42444
42646
  * @param this Defines style properties which override properties on the instances affected by the `Selector` property.
42647
+ * @returns Dictionary of key-value pairs mapping property names to their transition parameters.
42445
42648
  */
42446
42649
  GetPropertyTransitions(this: StyleRule): object;
42447
42650
  /**
42651
+ * Sets or clears a default transition that applies to all properties of the `StyleRule` that don't have an explicit transition set.
42652
+ *
42448
42653
  * - **ThreadSafety**: Unsafe
42449
42654
  *
42450
42655
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetDefaultPropertyTransition)
42656
+ * @param this Defines style properties which override properties on the instances affected by the `Selector` property.
42657
+ * @param transitionParams Either a `TweenInfo`, a token string defining the default transition timing, or `nil` to remove the default transition.
42451
42658
  */
42452
42659
  SetDefaultPropertyTransition(this: StyleRule, transitionParams: unknown): void;
42453
42660
  /**
@@ -42470,17 +42677,24 @@ interface StyleRule extends StyleBase {
42470
42677
  */
42471
42678
  SetProperty(this: StyleRule, name: string, value: unknown): void;
42472
42679
  /**
42680
+ * Sets or clears the transition for a single property on the `StyleRule`.
42681
+ *
42473
42682
  * - **ThreadSafety**: Unsafe
42474
42683
  *
42475
42684
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetPropertyTransition)
42685
+ * @param this Defines style properties which override properties on the instances affected by the `Selector` property.
42686
+ * @param property String name of the property to set a transition for, for example `"BackgroundColor3"` or `"Size"`.
42687
+ * @param transitionParams A `TweenInfo` or token string defining the transition timing, or `nil` to remove the transition for this property.
42476
42688
  */
42477
42689
  SetPropertyTransition(this: StyleRule, property: string, transitionParams: unknown): void;
42478
42690
  /**
42691
+ * Lets you declare and set transitions for multiple properties of the `StyleRule` at once.
42692
+ *
42479
42693
  * - **ThreadSafety**: Unsafe
42480
42694
  *
42481
42695
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetPropertyTransitions)
42482
42696
  * @param this Defines style properties which override properties on the instances affected by the `Selector` property.
42483
- * @param properties
42697
+ * @param properties Dictionary of property names to transition parameters.
42484
42698
  */
42485
42699
  SetPropertyTransitions(this: StyleRule, properties: object): void;
42486
42700
  }
@@ -43639,6 +43853,8 @@ interface TestService extends Instance {
43639
43853
  * - **ThreadSafety**: Unsafe
43640
43854
  *
43641
43855
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RegisterTest)
43856
+ * @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
43857
+ * @param testOptions
43642
43858
  */
43643
43859
  RegisterTest(this: TestService, testOptions: object): TestCase;
43644
43860
  /**
@@ -43709,6 +43925,13 @@ interface TestService extends Instance {
43709
43925
  * @param name
43710
43926
  */
43711
43927
  isFeatureEnabled(this: TestService, name: string): boolean;
43928
+ /**
43929
+ * - **ThreadSafety**: Unsafe
43930
+ * - **Tags**: Yields
43931
+ *
43932
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#CaptureScreenshotAsync)
43933
+ */
43934
+ CaptureScreenshotAsync(this: TestService, artifactName?: string, options?: object): unknown;
43712
43935
  /**
43713
43936
  * - **ThreadSafety**: Unsafe
43714
43937
  * - **Tags**: Yields
@@ -45929,41 +46152,46 @@ interface UICorner extends UIComponent {
45929
46152
  */
45930
46153
  readonly _nominal_UICorner: unique symbol;
45931
46154
  /**
46155
+ * Determines the radius of the bottom-left corner.
46156
+ *
45932
46157
  * - **ThreadSafety**: ReadSafe
45933
- * - **Tags**: Hidden, NotReplicated
45934
46158
  *
45935
46159
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#BottomLeftRadius)
45936
46160
  */
45937
- set BottomLeftRadius(value: UDim);
46161
+ BottomLeftRadius: UDim;
45938
46162
  /**
46163
+ * Determines the radius of the bottom-right corner.
46164
+ *
45939
46165
  * - **ThreadSafety**: ReadSafe
45940
- * - **Tags**: Hidden, NotReplicated
45941
46166
  *
45942
46167
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#BottomRightRadius)
45943
46168
  */
45944
- set BottomRightRadius(value: UDim);
46169
+ BottomRightRadius: UDim;
45945
46170
  /**
45946
- * Determines the radius of the component.
46171
+ * Sets all four corner radii at once and reads from `TopLeftRadius`.
45947
46172
  *
45948
46173
  * - **ThreadSafety**: ReadSafe
46174
+ * - **Tags**: NotReplicated
45949
46175
  *
45950
46176
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#CornerRadius)
45951
46177
  */
45952
46178
  CornerRadius: UDim;
45953
46179
  /**
46180
+ * Determines the radius of the top-left corner.
46181
+ *
45954
46182
  * - **ThreadSafety**: ReadSafe
45955
- * - **Tags**: Hidden, NotReplicated
45956
46183
  *
45957
46184
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#TopLeftRadius)
45958
46185
  */
45959
- set TopLeftRadius(value: UDim);
46186
+ TopLeftRadius: UDim;
45960
46187
  /**
46188
+ * Determines the radius of the top-right corner.
46189
+ *
45961
46190
  * - **ThreadSafety**: ReadSafe
45962
- * - **Tags**: Hidden, NotReplicated
45963
46191
  *
45964
46192
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#TopRightRadius)
45965
46193
  */
45966
- set TopRightRadius(value: UDim);
46194
+ TopRightRadius: UDim;
45967
46195
  }
45968
46196
  /**
45969
46197
  * Instance which facilitates and encourages interaction with UI elements in an experience.
@@ -46827,6 +47055,8 @@ interface UIScale extends UIComponent {
46827
47055
  Scale: number;
46828
47056
  }
46829
47057
  /**
47058
+ * Renders a shadow below the parent UI instance.
47059
+ *
46830
47060
  * - **Tags**: NotBrowsable
46831
47061
  *
46832
47062
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow)
@@ -46841,36 +47071,48 @@ interface UIShadow extends UIComponent {
46841
47071
  */
46842
47072
  readonly _nominal_UIShadow: unique symbol;
46843
47073
  /**
47074
+ * Determines the shadow's blurriness.
47075
+ *
46844
47076
  * - **ThreadSafety**: ReadSafe
46845
47077
  *
46846
47078
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#BlurRadius)
46847
47079
  */
46848
47080
  BlurRadius: UDim;
46849
47081
  /**
47082
+ * Determines the shadow's color.
47083
+ *
46850
47084
  * - **ThreadSafety**: ReadSafe
46851
47085
  *
46852
47086
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Color)
46853
47087
  */
46854
47088
  Color: Color3;
46855
47089
  /**
47090
+ * Moves the shadow relative to the parent's position.
47091
+ *
46856
47092
  * - **ThreadSafety**: ReadSafe
46857
47093
  *
46858
47094
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Offset)
46859
47095
  */
46860
47096
  Offset: UDim2;
46861
47097
  /**
47098
+ * Expands or shrinks the shadow relative to the parent's size.
47099
+ *
46862
47100
  * - **ThreadSafety**: ReadSafe
46863
47101
  *
46864
47102
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Spread)
46865
47103
  */
46866
47104
  Spread: UDim2;
46867
47105
  /**
47106
+ * Sets the shadow's transparency.
47107
+ *
46868
47108
  * - **ThreadSafety**: ReadSafe
46869
47109
  *
46870
47110
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Transparency)
46871
47111
  */
46872
47112
  Transparency: number;
46873
47113
  /**
47114
+ * Determines the shadow's render order relative to sibling `UIShadow` instances.
47115
+ *
46874
47116
  * - **ThreadSafety**: ReadSafe
46875
47117
  *
46876
47118
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#ZIndex)
@@ -47402,6 +47644,16 @@ interface UserInputService extends Instance {
47402
47644
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#VREnabled)
47403
47645
  */
47404
47646
  readonly VREnabled: boolean;
47647
+ /**
47648
+ * Creates a `VirtualInput` object that a Studio plugin can use to simulate mouse, keyboard, and pointer input.
47649
+ *
47650
+ * - **ThreadSafety**: Unsafe
47651
+ *
47652
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#CreateVirtualInput)
47653
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
47654
+ * @returns A new `VirtualInput` object, or `nil` if the feature is not available.
47655
+ */
47656
+ CreateVirtualInput(this: UserInputService): RBXObject;
47405
47657
  /**
47406
47658
  * Returns whether the given `UserInputType` gamepad supports a button corresponding with the given `KeyCode`.
47407
47659
  *
@@ -48824,6 +49076,12 @@ interface VideoPlayer extends Instance {
48824
49076
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Looping)
48825
49077
  */
48826
49078
  Looping: boolean;
49079
+ /**
49080
+ * - **ThreadSafety**: ReadSafe
49081
+ *
49082
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#MaximumResolution)
49083
+ */
49084
+ MaximumResolution: Enum.VideoSampleSize;
48827
49085
  /**
48828
49086
  * Controls the speed at which the video is played.
48829
49087
  *
@@ -49780,6 +50038,72 @@ interface VirtualInput extends RBXObject {
49780
50038
  * @deprecated
49781
50039
  */
49782
50040
  readonly _nominal_VirtualInput: unique symbol;
50041
+ /**
50042
+ * Injects a keyboard key press or release event.
50043
+ *
50044
+ * - **ThreadSafety**: Unsafe
50045
+ *
50046
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendKey)
50047
+ * @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
50048
+ * @param isPressed Whether to simulate a key press (`true`) or a key release (`false`).
50049
+ * @param keyCode The `KeyCode` of the key to inject.
50050
+ * @param isRepeatedKey Whether this is an auto-repeat event, as occurs when a key is held down. Only valid for text-manipulation keys such as `KeyCode.Backspace`, `KeyCode.Delete`, and the arrow keys. Defaults to `false`.
50051
+ */
50052
+ SendKey(this: VirtualInput, isPressed: boolean, keyCode: CastsToEnum<Enum.KeyCode>, isRepeatedKey?: boolean): void;
50053
+ /**
50054
+ * Injects a mouse button press or release event at the specified screen position.
50055
+ *
50056
+ * - **ThreadSafety**: Unsafe
50057
+ *
50058
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseButton)
50059
+ * @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
50060
+ * @param position The screen-space position in pixels at which to inject the event.
50061
+ * @param button The mouse button to use. Supported values are `UserInputType.MouseButton1`, `UserInputType.MouseButton2`, and `UserInputType.MouseButton3`.
50062
+ * @param isDown Whether to simulate a button press (`true`) or a button release (`false`).
50063
+ * @param repeatCount The consecutive-click count for multi-click detection, such as a double- or triple-click. Defaults to `0`.
50064
+ */
50065
+ SendMouseButton(this: VirtualInput, position: Vector2, button: CastsToEnum<Enum.UserInputType>, isDown: boolean, repeatCount?: number): void;
50066
+ /**
50067
+ * Injects a relative mouse movement event. Only works while the player's cursor is locked.
50068
+ *
50069
+ * - **ThreadSafety**: Unsafe
50070
+ *
50071
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseDelta)
50072
+ * @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
50073
+ * @param positionDelta The relative mouse movement in pixels along each axis.
50074
+ */
50075
+ SendMouseDelta(this: VirtualInput, positionDelta: Vector2): void;
50076
+ /**
50077
+ * Moves the virtual mouse cursor to the specified absolute screen position.
50078
+ *
50079
+ * - **ThreadSafety**: Unsafe
50080
+ *
50081
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMousePosition)
50082
+ * @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
50083
+ * @param position The target screen-space position in pixels.
50084
+ */
50085
+ SendMousePosition(this: VirtualInput, position: Vector2): void;
50086
+ /**
50087
+ * Injects a scroll wheel, trackpad pan, or pinch gesture event at the specified screen position.
50088
+ *
50089
+ * - **ThreadSafety**: Unsafe
50090
+ *
50091
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendPointerAction)
50092
+ * @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
50093
+ * @param position The screen-space position in pixels at which to inject the event.
50094
+ * @param pointerAction A dictionary describing the pointer action to inject. Accepted keys are `Wheel` (number), `Pan` (`Vector2`), and `Pinch` (number). At least one key must have a non-zero value.
50095
+ */
50096
+ SendPointerAction(this: VirtualInput, position: Vector2, pointerAction: object): void;
50097
+ /**
50098
+ * Injects a text input event as if the specified string was typed on a keyboard.
50099
+ *
50100
+ * - **ThreadSafety**: Unsafe
50101
+ *
50102
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendTextInput)
50103
+ * @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
50104
+ * @param text The string to inject as text input.
50105
+ */
50106
+ SendTextInput(this: VirtualInput, text: string): void;
49783
50107
  }
49784
50108
  /**
49785
50109
  * - **Tags**: NotCreatable, NotReplicated