@rbxts/types 1.0.895 → 1.0.901
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/README.md +2 -0
- package/include/generated/None.d.ts +898 -51
- package/include/generated/PluginSecurity.d.ts +252 -23
- package/include/generated/enums.d.ts +198 -37
- package/package.json +1 -1
|
@@ -98,6 +98,7 @@ interface Services {
|
|
|
98
98
|
IncrementalPatchBuilder: IncrementalPatchBuilder;
|
|
99
99
|
InsertService: InsertService;
|
|
100
100
|
InstanceExtensionsService: InstanceExtensionsService;
|
|
101
|
+
InstanceFileSyncService: InstanceFileSyncService;
|
|
101
102
|
InternalSyncService: InternalSyncService;
|
|
102
103
|
IXPService: IXPService;
|
|
103
104
|
JointsService: JointsService;
|
|
@@ -191,7 +192,9 @@ interface Services {
|
|
|
191
192
|
SessionCheckService: SessionCheckService;
|
|
192
193
|
SessionService: SessionService;
|
|
193
194
|
SharedTableRegistry: SharedTableRegistry;
|
|
195
|
+
SlimAnimationReplicationService: SlimAnimationReplicationService;
|
|
194
196
|
SlimContentProvider: SlimContentProvider;
|
|
197
|
+
SlimReplicationService: SlimReplicationService;
|
|
195
198
|
SlimService: SlimService;
|
|
196
199
|
SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService;
|
|
197
200
|
SnippetService: SnippetService;
|
|
@@ -728,6 +731,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
728
731
|
ServerReplicator: ServerReplicator;
|
|
729
732
|
ServiceProvider: ServiceProvider;
|
|
730
733
|
SlidingBallConstraint: SlidingBallConstraint;
|
|
734
|
+
SlimAnimationDataEntity: SlimAnimationDataEntity;
|
|
731
735
|
SoundEffect: SoundEffect;
|
|
732
736
|
StackFrame: StackFrame;
|
|
733
737
|
StandardPages: StandardPages;
|
|
@@ -870,6 +874,8 @@ interface VideoCapture extends Capture {
|
|
|
870
874
|
readonly _nominal_VideoCapture: unique symbol;
|
|
871
875
|
}
|
|
872
876
|
/**
|
|
877
|
+
* A snapshot of configuration values at a given version. Can be player-specific.
|
|
878
|
+
*
|
|
873
879
|
* - **Tags**: NotCreatable, NotReplicated
|
|
874
880
|
*
|
|
875
881
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot)
|
|
@@ -2977,7 +2983,7 @@ interface CaptureService extends Instance {
|
|
|
2977
2983
|
readonly _nominal_CaptureService: unique symbol;
|
|
2978
2984
|
}
|
|
2979
2985
|
/**
|
|
2980
|
-
*
|
|
2986
|
+
* **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
|
|
2981
2987
|
*
|
|
2982
2988
|
* - **Tags**: NotCreatable, Service
|
|
2983
2989
|
*
|
|
@@ -2998,8 +3004,8 @@ interface ChangeHistoryService extends Instance {
|
|
|
2998
3004
|
* - **ThreadSafety**: Unsafe
|
|
2999
3005
|
*
|
|
3000
3006
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#FinishRecording)
|
|
3001
|
-
* @param this
|
|
3002
|
-
* @param identifier
|
|
3007
|
+
* @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
|
|
3008
|
+
* @param identifier Identifies the recording from the previous call to `TryBeginRecording()`. If the operation is `ChangeHistoryService.FinishRecordingOperation.Cancel`, this value is ignored, and the recording is determined by context.
|
|
3003
3009
|
* @param operation Specifies the operation to take.
|
|
3004
3010
|
* @param finalOptions Optional table of values to pass to `OnFinishRecording`.
|
|
3005
3011
|
*/
|
|
@@ -3010,7 +3016,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3010
3016
|
* - **ThreadSafety**: Unsafe
|
|
3011
3017
|
*
|
|
3012
3018
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#GetCanRedo)
|
|
3013
|
-
* @param this
|
|
3019
|
+
* @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
|
|
3014
3020
|
*/
|
|
3015
3021
|
GetCanRedo(this: ChangeHistoryService): unknown;
|
|
3016
3022
|
/**
|
|
@@ -3019,14 +3025,14 @@ interface ChangeHistoryService extends Instance {
|
|
|
3019
3025
|
* - **ThreadSafety**: Unsafe
|
|
3020
3026
|
*
|
|
3021
3027
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#GetCanUndo)
|
|
3022
|
-
* @param this
|
|
3028
|
+
* @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
|
|
3023
3029
|
*/
|
|
3024
3030
|
GetCanUndo(this: ChangeHistoryService): unknown;
|
|
3025
3031
|
/**
|
|
3026
3032
|
* - **ThreadSafety**: Unsafe
|
|
3027
3033
|
*
|
|
3028
3034
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#IsRecordingInProgress)
|
|
3029
|
-
* @param this
|
|
3035
|
+
* @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
|
|
3030
3036
|
* @param identifier
|
|
3031
3037
|
*/
|
|
3032
3038
|
IsRecordingInProgress(this: ChangeHistoryService, identifier?: string): boolean;
|
|
@@ -3036,7 +3042,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3036
3042
|
* - **ThreadSafety**: Unsafe
|
|
3037
3043
|
*
|
|
3038
3044
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#Redo)
|
|
3039
|
-
* @param this
|
|
3045
|
+
* @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
|
|
3040
3046
|
*/
|
|
3041
3047
|
Redo(this: ChangeHistoryService): void;
|
|
3042
3048
|
/**
|
|
@@ -3045,16 +3051,16 @@ interface ChangeHistoryService extends Instance {
|
|
|
3045
3051
|
* - **ThreadSafety**: Unsafe
|
|
3046
3052
|
*
|
|
3047
3053
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#ResetWaypoints)
|
|
3048
|
-
* @param this
|
|
3054
|
+
* @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
|
|
3049
3055
|
*/
|
|
3050
3056
|
ResetWaypoints(this: ChangeHistoryService): void;
|
|
3051
3057
|
/**
|
|
3052
|
-
* Sets whether or not
|
|
3058
|
+
* Sets whether or not the ChangeHistoryService is enabled.
|
|
3053
3059
|
*
|
|
3054
3060
|
* - **ThreadSafety**: Unsafe
|
|
3055
3061
|
*
|
|
3056
3062
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#SetEnabled)
|
|
3057
|
-
* @param this
|
|
3063
|
+
* @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
|
|
3058
3064
|
* @param state
|
|
3059
3065
|
*/
|
|
3060
3066
|
SetEnabled(this: ChangeHistoryService, state: boolean): void;
|
|
@@ -3064,7 +3070,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3064
3070
|
* - **ThreadSafety**: Unsafe
|
|
3065
3071
|
*
|
|
3066
3072
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#SetWaypoint)
|
|
3067
|
-
* @param this
|
|
3073
|
+
* @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
|
|
3068
3074
|
* @param name
|
|
3069
3075
|
*/
|
|
3070
3076
|
SetWaypoint(this: ChangeHistoryService, name: string): void;
|
|
@@ -3074,7 +3080,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3074
3080
|
* - **ThreadSafety**: Unsafe
|
|
3075
3081
|
*
|
|
3076
3082
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#TryBeginRecording)
|
|
3077
|
-
* @param this
|
|
3083
|
+
* @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
|
|
3078
3084
|
* @param name Name of the action being performed suitable for logging and coding purposes.
|
|
3079
3085
|
* @param displayName Name of the action being performed to display to the user.
|
|
3080
3086
|
*/
|
|
@@ -3085,7 +3091,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3085
3091
|
* - **ThreadSafety**: Unsafe
|
|
3086
3092
|
*
|
|
3087
3093
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#Undo)
|
|
3088
|
-
* @param this
|
|
3094
|
+
* @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
|
|
3089
3095
|
*/
|
|
3090
3096
|
Undo(this: ChangeHistoryService): void;
|
|
3091
3097
|
/**
|
|
@@ -3105,7 +3111,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3105
3111
|
*/
|
|
3106
3112
|
readonly OnRecordingStarted: RBXScriptSignal<(name: string, displayName?: string) => void>;
|
|
3107
3113
|
/**
|
|
3108
|
-
* Fired when the user reverses the undo command.
|
|
3114
|
+
* Fired when the user reverses the undo command. Waypoint describes the type action that has been redone.
|
|
3109
3115
|
*
|
|
3110
3116
|
* - **ThreadSafety**: Unsafe
|
|
3111
3117
|
*
|
|
@@ -3113,7 +3119,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3113
3119
|
*/
|
|
3114
3120
|
readonly OnRedo: RBXScriptSignal<(waypoint: string) => void>;
|
|
3115
3121
|
/**
|
|
3116
|
-
* Fired when the user undoes an action in studio.
|
|
3122
|
+
* Fired when the user undoes an action in studio. Waypoint describes the type action that has been undone.
|
|
3117
3123
|
*
|
|
3118
3124
|
* - **ThreadSafety**: Unsafe
|
|
3119
3125
|
*
|
|
@@ -3402,6 +3408,8 @@ interface CommerceService extends Instance {
|
|
|
3402
3408
|
readonly _nominal_CommerceService: unique symbol;
|
|
3403
3409
|
}
|
|
3404
3410
|
/**
|
|
3411
|
+
* An animation curve that groups child `FloatCurves` which each animate a different component of a non-unary value.
|
|
3412
|
+
*
|
|
3405
3413
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve)
|
|
3406
3414
|
*/
|
|
3407
3415
|
interface CompositeValueCurve extends Instance {
|
|
@@ -3415,6 +3423,8 @@ interface CompositeValueCurve extends Instance {
|
|
|
3415
3423
|
readonly _nominal_CompositeValueCurve: unique symbol;
|
|
3416
3424
|
}
|
|
3417
3425
|
/**
|
|
3426
|
+
* A game service that gives access to in-experience configuration with updates in real time.
|
|
3427
|
+
*
|
|
3418
3428
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
3419
3429
|
*
|
|
3420
3430
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService)
|
|
@@ -3539,6 +3549,8 @@ interface AngularVelocity extends Constraint {
|
|
|
3539
3549
|
/**
|
|
3540
3550
|
* Aligns two `BaseParts` with an animate-able kinematic or force-based joint.
|
|
3541
3551
|
*
|
|
3552
|
+
* - **Tags**: NotBrowsable
|
|
3553
|
+
*
|
|
3542
3554
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint)
|
|
3543
3555
|
*/
|
|
3544
3556
|
interface AnimationConstraint extends Constraint {
|
|
@@ -6985,8 +6997,6 @@ interface HumanoidDescription extends Instance {
|
|
|
6985
6997
|
readonly _nominal_HumanoidDescription: unique symbol;
|
|
6986
6998
|
}
|
|
6987
6999
|
/**
|
|
6988
|
-
* - **Tags**: NotBrowsable
|
|
6989
|
-
*
|
|
6990
7000
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription)
|
|
6991
7001
|
*/
|
|
6992
7002
|
interface HumanoidRigDescription extends Instance {
|
|
@@ -7198,6 +7208,45 @@ interface InstanceExtensionsService extends Instance {
|
|
|
7198
7208
|
*/
|
|
7199
7209
|
readonly _nominal_InstanceExtensionsService: unique symbol;
|
|
7200
7210
|
}
|
|
7211
|
+
/**
|
|
7212
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
7213
|
+
*
|
|
7214
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService)
|
|
7215
|
+
*/
|
|
7216
|
+
interface InstanceFileSyncService extends Instance {
|
|
7217
|
+
/**
|
|
7218
|
+
* **DO NOT USE!**
|
|
7219
|
+
*
|
|
7220
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
7221
|
+
* @hidden
|
|
7222
|
+
* @deprecated
|
|
7223
|
+
*/
|
|
7224
|
+
readonly _nominal_InstanceFileSyncService: unique symbol;
|
|
7225
|
+
/**
|
|
7226
|
+
* - **ThreadSafety**: Unsafe
|
|
7227
|
+
*
|
|
7228
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#GetAllInstances)
|
|
7229
|
+
*/
|
|
7230
|
+
GetAllInstances(this: InstanceFileSyncService): Array<Instance>;
|
|
7231
|
+
/**
|
|
7232
|
+
* - **ThreadSafety**: Unsafe
|
|
7233
|
+
*
|
|
7234
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#GetStatus)
|
|
7235
|
+
*/
|
|
7236
|
+
GetStatus(this: InstanceFileSyncService, instance: Instance): Enum.InstanceFileSyncStatus;
|
|
7237
|
+
/**
|
|
7238
|
+
* - **ThreadSafety**: Unsafe
|
|
7239
|
+
*
|
|
7240
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#GetSyncedInstance)
|
|
7241
|
+
*/
|
|
7242
|
+
GetSyncedInstance(this: InstanceFileSyncService, filePath: string): Instance | undefined;
|
|
7243
|
+
/**
|
|
7244
|
+
* - **ThreadSafety**: Unsafe
|
|
7245
|
+
*
|
|
7246
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#StatusChanged)
|
|
7247
|
+
*/
|
|
7248
|
+
readonly StatusChanged: RBXScriptSignal<(instance: Instance, status: Enum.InstanceFileSyncStatus) => void>;
|
|
7249
|
+
}
|
|
7201
7250
|
/**
|
|
7202
7251
|
* - **Tags**: NotReplicated
|
|
7203
7252
|
*
|
|
@@ -8039,6 +8088,8 @@ interface MLService extends Instance {
|
|
|
8039
8088
|
readonly _nominal_MLService: unique symbol;
|
|
8040
8089
|
}
|
|
8041
8090
|
/**
|
|
8091
|
+
* - **Tags**: NotBrowsable
|
|
8092
|
+
*
|
|
8042
8093
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription)
|
|
8043
8094
|
*/
|
|
8044
8095
|
interface MakeupDescription extends Instance {
|
|
@@ -10419,6 +10470,8 @@ interface Plugin extends Instance {
|
|
|
10419
10470
|
*/
|
|
10420
10471
|
Union(this: Plugin, objects: Array<BasePart>): UnionOperation;
|
|
10421
10472
|
/**
|
|
10473
|
+
* **Deprecated:**
|
|
10474
|
+
*
|
|
10422
10475
|
* Creates a `DockWidgetPluginGui` given a `DockWidgetPluginGuiInfo`.
|
|
10423
10476
|
*
|
|
10424
10477
|
* - **ThreadSafety**: Unsafe
|
|
@@ -10428,9 +10481,25 @@ interface Plugin extends Instance {
|
|
|
10428
10481
|
* @param this
|
|
10429
10482
|
* @param pluginGuiId A unique and consistent identifier used to storing the widget's dock state and other internal details.
|
|
10430
10483
|
* @param dockWidgetPluginGuiInfo Describes the `DockWidgetPluginGui` to create (initial state, size, etc).
|
|
10484
|
+
*
|
|
10485
|
+
* @deprecated CreateDockWidgetPluginGuiAsync
|
|
10431
10486
|
*/
|
|
10432
10487
|
CreateDockWidgetPluginGui(this: Plugin, pluginGuiId: string, dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo): DockWidgetPluginGui;
|
|
10433
10488
|
/**
|
|
10489
|
+
* Creates a `DockWidgetPluginGui` given a `DockWidgetPluginGuiInfo`.
|
|
10490
|
+
*
|
|
10491
|
+
* - **ThreadSafety**: Unsafe
|
|
10492
|
+
* - **Tags**: Yields
|
|
10493
|
+
*
|
|
10494
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateDockWidgetPluginGuiAsync)
|
|
10495
|
+
* @param this
|
|
10496
|
+
* @param pluginGuiId A unique and consistent identifier used to storing the widget's dock state and other internal details.
|
|
10497
|
+
* @param dockWidgetPluginGuiInfo Describes the `DockWidgetPluginGui` to create (initial state, size, etc).
|
|
10498
|
+
*/
|
|
10499
|
+
CreateDockWidgetPluginGuiAsync(this: Plugin, pluginGuiId: string, dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo): DockWidgetPluginGui;
|
|
10500
|
+
/**
|
|
10501
|
+
* **Deprecated:**
|
|
10502
|
+
*
|
|
10434
10503
|
* Prompts the user to open a .fbx animation file that can be loaded onto the `rigModel`, then proceeds to insert the animation as a `KeyframeSequence` in the `Workspace`.
|
|
10435
10504
|
*
|
|
10436
10505
|
* - **ThreadSafety**: Unsafe
|
|
@@ -10440,9 +10509,25 @@ interface Plugin extends Instance {
|
|
|
10440
10509
|
* @param this
|
|
10441
10510
|
* @param rigModel
|
|
10442
10511
|
* @param isR15
|
|
10512
|
+
*
|
|
10513
|
+
* @deprecated ImportFbxAnimationAsync
|
|
10443
10514
|
*/
|
|
10444
10515
|
ImportFbxAnimation(this: Plugin, rigModel: Instance, isR15?: boolean): Instance | undefined;
|
|
10445
10516
|
/**
|
|
10517
|
+
* Prompts the user to open a .fbx animation file that can be loaded onto the `rigModel`, then proceeds to insert the animation as a `KeyframeSequence` in the `Workspace`.
|
|
10518
|
+
*
|
|
10519
|
+
* - **ThreadSafety**: Unsafe
|
|
10520
|
+
* - **Tags**: Yields
|
|
10521
|
+
*
|
|
10522
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxAnimationAsync)
|
|
10523
|
+
* @param this
|
|
10524
|
+
* @param rigModel
|
|
10525
|
+
* @param isR15
|
|
10526
|
+
*/
|
|
10527
|
+
ImportFbxAnimationAsync(this: Plugin, rigModel: Instance, isR15?: boolean): Instance | undefined;
|
|
10528
|
+
/**
|
|
10529
|
+
* **Deprecated:**
|
|
10530
|
+
*
|
|
10446
10531
|
* Prompts the user to open a .fbx file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the `Workspace`.
|
|
10447
10532
|
*
|
|
10448
10533
|
* - **ThreadSafety**: Unsafe
|
|
@@ -10451,8 +10536,21 @@ interface Plugin extends Instance {
|
|
|
10451
10536
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxRig)
|
|
10452
10537
|
* @param this
|
|
10453
10538
|
* @param isR15
|
|
10539
|
+
*
|
|
10540
|
+
* @deprecated ImportFbxRigAsync
|
|
10454
10541
|
*/
|
|
10455
10542
|
ImportFbxRig(this: Plugin, isR15?: boolean): Model;
|
|
10543
|
+
/**
|
|
10544
|
+
* Prompts the user to open a .fbx file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the `Workspace`.
|
|
10545
|
+
*
|
|
10546
|
+
* - **ThreadSafety**: Unsafe
|
|
10547
|
+
* - **Tags**: Yields
|
|
10548
|
+
*
|
|
10549
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxRigAsync)
|
|
10550
|
+
* @param this
|
|
10551
|
+
* @param isR15
|
|
10552
|
+
*/
|
|
10553
|
+
ImportFbxRigAsync(this: Plugin, isR15?: boolean): Instance | undefined;
|
|
10456
10554
|
/**
|
|
10457
10555
|
* Opens a window in Roblox Studio, which prompts the user to select an asset based on the `assetType` specified. Returns what assetId was selected, or -1 if the window was closed.
|
|
10458
10556
|
*
|
|
@@ -10465,6 +10563,19 @@ interface Plugin extends Instance {
|
|
|
10465
10563
|
*/
|
|
10466
10564
|
PromptForExistingAssetId(this: Plugin, assetType: string): number;
|
|
10467
10565
|
/**
|
|
10566
|
+
* Opens a window in Roblox Studio, which prompts the user to select an asset based on the `assetType` specified. Returns what assetId was selected, or -1 if the window was closed.
|
|
10567
|
+
*
|
|
10568
|
+
* - **ThreadSafety**: Unsafe
|
|
10569
|
+
* - **Tags**: Yields
|
|
10570
|
+
*
|
|
10571
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptForExistingAssetIdAsync)
|
|
10572
|
+
* @param this
|
|
10573
|
+
* @param assetType
|
|
10574
|
+
*/
|
|
10575
|
+
PromptForExistingAssetIdAsync(this: Plugin, assetType: string): number;
|
|
10576
|
+
/**
|
|
10577
|
+
* **Deprecated:**
|
|
10578
|
+
*
|
|
10468
10579
|
* Prompts the user to save their current selection with the specified file name. Returns true if the user did save the file.
|
|
10469
10580
|
*
|
|
10470
10581
|
* - **ThreadSafety**: Unsafe
|
|
@@ -10473,8 +10584,21 @@ interface Plugin extends Instance {
|
|
|
10473
10584
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptSaveSelection)
|
|
10474
10585
|
* @param this
|
|
10475
10586
|
* @param suggestedFileName
|
|
10587
|
+
*
|
|
10588
|
+
* @deprecated PromptSaveSelectionAsync
|
|
10476
10589
|
*/
|
|
10477
10590
|
PromptSaveSelection(this: Plugin, suggestedFileName?: string): boolean;
|
|
10591
|
+
/**
|
|
10592
|
+
* Prompts the user to save their current selection with the specified file name. Returns true if the user did save the file.
|
|
10593
|
+
*
|
|
10594
|
+
* - **ThreadSafety**: Unsafe
|
|
10595
|
+
* - **Tags**: Yields
|
|
10596
|
+
*
|
|
10597
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptSaveSelectionAsync)
|
|
10598
|
+
* @param this
|
|
10599
|
+
* @param suggestedFileName
|
|
10600
|
+
*/
|
|
10601
|
+
PromptSaveSelectionAsync(this: Plugin, suggestedFileName?: string): boolean;
|
|
10478
10602
|
/**
|
|
10479
10603
|
* Fired when the plugin is deactivated.
|
|
10480
10604
|
*
|
|
@@ -12422,6 +12546,51 @@ interface Sky extends Instance {
|
|
|
12422
12546
|
*/
|
|
12423
12547
|
readonly _nominal_Sky: unique symbol;
|
|
12424
12548
|
}
|
|
12549
|
+
/**
|
|
12550
|
+
* - **Tags**: NotCreatable
|
|
12551
|
+
*
|
|
12552
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimAnimationDataEntity)
|
|
12553
|
+
*/
|
|
12554
|
+
interface SlimAnimationDataEntity extends Instance {
|
|
12555
|
+
/**
|
|
12556
|
+
* **DO NOT USE!**
|
|
12557
|
+
*
|
|
12558
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
12559
|
+
* @hidden
|
|
12560
|
+
* @deprecated
|
|
12561
|
+
*/
|
|
12562
|
+
readonly _nominal_SlimAnimationDataEntity: unique symbol;
|
|
12563
|
+
}
|
|
12564
|
+
/**
|
|
12565
|
+
* - **Tags**: NotCreatable, Service
|
|
12566
|
+
*
|
|
12567
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimAnimationReplicationService)
|
|
12568
|
+
*/
|
|
12569
|
+
interface SlimAnimationReplicationService extends Instance {
|
|
12570
|
+
/**
|
|
12571
|
+
* **DO NOT USE!**
|
|
12572
|
+
*
|
|
12573
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
12574
|
+
* @hidden
|
|
12575
|
+
* @deprecated
|
|
12576
|
+
*/
|
|
12577
|
+
readonly _nominal_SlimAnimationReplicationService: unique symbol;
|
|
12578
|
+
}
|
|
12579
|
+
/**
|
|
12580
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
12581
|
+
*
|
|
12582
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimReplicationService)
|
|
12583
|
+
*/
|
|
12584
|
+
interface SlimReplicationService extends Instance {
|
|
12585
|
+
/**
|
|
12586
|
+
* **DO NOT USE!**
|
|
12587
|
+
*
|
|
12588
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
12589
|
+
* @hidden
|
|
12590
|
+
* @deprecated
|
|
12591
|
+
*/
|
|
12592
|
+
readonly _nominal_SlimReplicationService: unique symbol;
|
|
12593
|
+
}
|
|
12425
12594
|
/**
|
|
12426
12595
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
12427
12596
|
*
|
|
@@ -12727,7 +12896,7 @@ interface SoundGroup extends Instance {
|
|
|
12727
12896
|
readonly _nominal_SoundGroup: unique symbol;
|
|
12728
12897
|
}
|
|
12729
12898
|
/**
|
|
12730
|
-
* A service that determines various aspects of how `Sounds` play in the experience.
|
|
12899
|
+
* A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
|
|
12731
12900
|
*
|
|
12732
12901
|
* - **Tags**: NotCreatable, Service
|
|
12733
12902
|
*
|
|
@@ -12743,6 +12912,8 @@ interface SoundService extends Instance {
|
|
|
12743
12912
|
*/
|
|
12744
12913
|
readonly _nominal_SoundService: unique symbol;
|
|
12745
12914
|
/**
|
|
12915
|
+
* Determines whether the default character sounds will use instances in the advanced audio system vs. `Sounds`.
|
|
12916
|
+
*
|
|
12746
12917
|
* - **ThreadSafety**: ReadSafe
|
|
12747
12918
|
*
|
|
12748
12919
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#CharacterSoundsUseNewApi)
|
|
@@ -12757,19 +12928,23 @@ interface SoundService extends Instance {
|
|
|
12757
12928
|
*/
|
|
12758
12929
|
DefaultListenerLocation: Enum.ListenerLocation;
|
|
12759
12930
|
/**
|
|
12931
|
+
* Opens the attenuation curve editor in Studio for the provided `AudioEmitter` or `AudioListener` instances.
|
|
12932
|
+
*
|
|
12760
12933
|
* - **ThreadSafety**: Unsafe
|
|
12761
12934
|
*
|
|
12762
12935
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#OpenAttenuationCurveEditor)
|
|
12763
|
-
* @param this A service that determines various aspects of how `Sounds` play in the experience.
|
|
12764
|
-
* @param selectedCurveObjects
|
|
12936
|
+
* @param this A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
|
|
12937
|
+
* @param selectedCurveObjects A list of `AudioEmitters` or `AudioListeners`.
|
|
12765
12938
|
*/
|
|
12766
12939
|
OpenAttenuationCurveEditor(this: SoundService, selectedCurveObjects: Array<Instance>): void;
|
|
12767
12940
|
/**
|
|
12941
|
+
* Opens the directional curve editor in Studio for the provided `AudioEmitter` or `AudioListener` instances.
|
|
12942
|
+
*
|
|
12768
12943
|
* - **ThreadSafety**: Unsafe
|
|
12769
12944
|
*
|
|
12770
12945
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#OpenDirectionalCurveEditor)
|
|
12771
|
-
* @param this A service that determines various aspects of how `Sounds` play in the experience.
|
|
12772
|
-
* @param selectedCurveObjects
|
|
12946
|
+
* @param this A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
|
|
12947
|
+
* @param selectedCurveObjects A list of `AudioEmitters` or `AudioListeners`.
|
|
12773
12948
|
*/
|
|
12774
12949
|
OpenDirectionalCurveEditor(this: SoundService, selectedCurveObjects: Array<Instance>): void;
|
|
12775
12950
|
}
|
|
@@ -13317,6 +13492,8 @@ interface StudioService extends Instance {
|
|
|
13317
13492
|
*/
|
|
13318
13493
|
GizmoRaycast(this: StudioService, origin: Vector3, direction: Vector3, raycastParams?: RaycastParams): RaycastResult | undefined;
|
|
13319
13494
|
/**
|
|
13495
|
+
* **Deprecated:**
|
|
13496
|
+
*
|
|
13320
13497
|
* Prompts the current Studio user to select one file to add as a `File`.
|
|
13321
13498
|
*
|
|
13322
13499
|
* - **ThreadSafety**: Unsafe
|
|
@@ -13326,9 +13503,25 @@ interface StudioService extends Instance {
|
|
|
13326
13503
|
* @param this Provides access to configuration of Roblox Studio and allows importing files from the user's file system.
|
|
13327
13504
|
* @param fileTypeFilter A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only a JPG or PNG file to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.
|
|
13328
13505
|
* @returns The imported `File`. Returns `nil` if no files were selected, or if the selected file was too large (FileSize greater than 100 megabytes).
|
|
13506
|
+
*
|
|
13507
|
+
* @deprecated PromptImportFileAsync
|
|
13329
13508
|
*/
|
|
13330
13509
|
PromptImportFile(this: StudioService, fileTypeFilter?: Array<unknown>): Instance | undefined;
|
|
13331
13510
|
/**
|
|
13511
|
+
* Prompts the current Studio user to select one file to add as a `File`.
|
|
13512
|
+
*
|
|
13513
|
+
* - **ThreadSafety**: Unsafe
|
|
13514
|
+
* - **Tags**: Yields
|
|
13515
|
+
*
|
|
13516
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioService#PromptImportFileAsync)
|
|
13517
|
+
* @param this Provides access to configuration of Roblox Studio and allows importing files from the user's file system.
|
|
13518
|
+
* @param fileTypeFilter A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only a JPG or PNG file to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.
|
|
13519
|
+
* @returns The imported `File`. Returns `nil` if no files were selected, or if the selected file was too large (FileSize greater than 100 megabytes).
|
|
13520
|
+
*/
|
|
13521
|
+
PromptImportFileAsync(this: StudioService, fileTypeFilter?: Array<unknown>): Instance | undefined;
|
|
13522
|
+
/**
|
|
13523
|
+
* **Deprecated:**
|
|
13524
|
+
*
|
|
13332
13525
|
* Prompts the current Studio user to select files to add as `Files`.
|
|
13333
13526
|
*
|
|
13334
13527
|
* - **ThreadSafety**: Unsafe
|
|
@@ -13338,10 +13531,26 @@ interface StudioService extends Instance {
|
|
|
13338
13531
|
* @param this Provides access to configuration of Roblox Studio and allows importing files from the user's file system.
|
|
13339
13532
|
* @param fileTypeFilter A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only JPG and PNG files to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.
|
|
13340
13533
|
* @returns The imported `Files`. Returns an empty list if no files were selected. Returns `nil` if the user selected one or more files that were too large (FileSize greater than 100 megabytes).
|
|
13534
|
+
*
|
|
13535
|
+
* @deprecated PromptImportFilesAsync
|
|
13341
13536
|
*/
|
|
13342
13537
|
PromptImportFiles(this: StudioService, fileTypeFilter?: Array<unknown>): Array<Instance>;
|
|
13538
|
+
/**
|
|
13539
|
+
* Prompts the current Studio user to select files to add as `Files`.
|
|
13540
|
+
*
|
|
13541
|
+
* - **ThreadSafety**: Unsafe
|
|
13542
|
+
* - **Tags**: Yields
|
|
13543
|
+
*
|
|
13544
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioService#PromptImportFilesAsync)
|
|
13545
|
+
* @param this Provides access to configuration of Roblox Studio and allows importing files from the user's file system.
|
|
13546
|
+
* @param fileTypeFilter A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only JPG and PNG files to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.
|
|
13547
|
+
* @returns The imported `Files`. Returns an empty list if no files were selected. Returns `nil` if the user selected one or more files that were too large (FileSize greater than 100 megabytes).
|
|
13548
|
+
*/
|
|
13549
|
+
PromptImportFilesAsync(this: StudioService, fileTypeFilter?: Array<unknown>): Array<Instance>;
|
|
13343
13550
|
}
|
|
13344
13551
|
/**
|
|
13552
|
+
* Service allowing plugins to automate and customize Test and Run mode testing.
|
|
13553
|
+
*
|
|
13345
13554
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
13346
13555
|
*
|
|
13347
13556
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService)
|
|
@@ -13360,6 +13569,9 @@ interface StudioTestService extends Instance {
|
|
|
13360
13569
|
* - **Tags**: Yields
|
|
13361
13570
|
*
|
|
13362
13571
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#ExecutePlayModeAsync)
|
|
13572
|
+
* @param this Service allowing plugins to automate and customize Test and Run mode testing.
|
|
13573
|
+
* @param args Argument passed to the test session, or `nil`.
|
|
13574
|
+
* @returns Value passed from `StudioTestService:EndTest()`, or `nil`.
|
|
13363
13575
|
*/
|
|
13364
13576
|
ExecutePlayModeAsync(this: StudioTestService, args: unknown): unknown;
|
|
13365
13577
|
/**
|
|
@@ -13367,6 +13579,9 @@ interface StudioTestService extends Instance {
|
|
|
13367
13579
|
* - **Tags**: Yields
|
|
13368
13580
|
*
|
|
13369
13581
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#ExecuteRunModeAsync)
|
|
13582
|
+
* @param this Service allowing plugins to automate and customize Test and Run mode testing.
|
|
13583
|
+
* @param args Argument passed to the test session, or `nil`.
|
|
13584
|
+
* @returns Value passed from `StudioTestService:EndTest()`, or `nil`.
|
|
13370
13585
|
*/
|
|
13371
13586
|
ExecuteRunModeAsync(this: StudioTestService, args: unknown): unknown;
|
|
13372
13587
|
}
|
|
@@ -13951,6 +14166,8 @@ interface TestService extends Instance {
|
|
|
13951
14166
|
*/
|
|
13952
14167
|
readonly _nominal_TestService: unique symbol;
|
|
13953
14168
|
/**
|
|
14169
|
+
* **Deprecated:**
|
|
14170
|
+
*
|
|
13954
14171
|
* Runs scripts which are parented to TestService.
|
|
13955
14172
|
*
|
|
13956
14173
|
* - **ThreadSafety**: Unsafe
|
|
@@ -13958,8 +14175,20 @@ interface TestService extends Instance {
|
|
|
13958
14175
|
*
|
|
13959
14176
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Run)
|
|
13960
14177
|
* @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.
|
|
14178
|
+
*
|
|
14179
|
+
* @deprecated RunAsync
|
|
13961
14180
|
*/
|
|
13962
14181
|
Run(this: TestService): void;
|
|
14182
|
+
/**
|
|
14183
|
+
* Runs scripts which are parented to TestService.
|
|
14184
|
+
*
|
|
14185
|
+
* - **ThreadSafety**: Unsafe
|
|
14186
|
+
* - **Tags**: Yields
|
|
14187
|
+
*
|
|
14188
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RunAsync)
|
|
14189
|
+
* @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.
|
|
14190
|
+
*/
|
|
14191
|
+
RunAsync(this: TestService): void;
|
|
13963
14192
|
}
|
|
13964
14193
|
/**
|
|
13965
14194
|
* - **Tags**: NotCreatable, Service
|
|
@@ -14092,7 +14321,7 @@ interface ChatWindowConfiguration extends TextChatConfigurations {
|
|
|
14092
14321
|
readonly _nominal_ChatWindowConfiguration: unique symbol;
|
|
14093
14322
|
}
|
|
14094
14323
|
/**
|
|
14095
|
-
*
|
|
14324
|
+
* A data object representing a text chat message.
|
|
14096
14325
|
*
|
|
14097
14326
|
* - **Tags**: NotCreatable
|
|
14098
14327
|
*
|