@rbxts/types 1.0.913 → 1.0.915
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 +327 -18
- package/include/generated/PluginSecurity.d.ts +208 -0
- package/include/generated/enums.d.ts +330 -251
- package/package.json +1 -1
|
@@ -145,9 +145,11 @@ interface Services {
|
|
|
145
145
|
PlayerHydrationService: PlayerHydrationService;
|
|
146
146
|
Players: Players;
|
|
147
147
|
PlayerViewService: PlayerViewService;
|
|
148
|
+
PluginConnectionService: PluginConnectionService;
|
|
148
149
|
PluginManagementService: PluginManagementService;
|
|
149
150
|
PluginPolicyService: PluginPolicyService;
|
|
150
151
|
PolicyService: PolicyService;
|
|
152
|
+
ProceduralBehaviorSchedulerService: ProceduralBehaviorSchedulerService;
|
|
151
153
|
ProcessInstancePhysicsService: ProcessInstancePhysicsService;
|
|
152
154
|
ProximityPromptService: ProximityPromptService;
|
|
153
155
|
PublishService: PublishService;
|
|
@@ -380,6 +382,7 @@ interface CreatableInstances {
|
|
|
380
382
|
Folder: Folder;
|
|
381
383
|
ForceField: ForceField;
|
|
382
384
|
Frame: Frame;
|
|
385
|
+
GeneratedFolder: GeneratedFolder;
|
|
383
386
|
GetTextBoundsParams: GetTextBoundsParams;
|
|
384
387
|
Glue: Glue;
|
|
385
388
|
GroundController: GroundController;
|
|
@@ -445,9 +448,11 @@ interface CreatableInstances {
|
|
|
445
448
|
PointLight: PointLight;
|
|
446
449
|
Pose: Pose;
|
|
447
450
|
PrismaticConstraint: PrismaticConstraint;
|
|
451
|
+
ProceduralModel: ProceduralModel;
|
|
448
452
|
ProximityPrompt: ProximityPrompt;
|
|
449
453
|
PyramidHandleAdornment: PyramidHandleAdornment;
|
|
450
454
|
RayValue: RayValue;
|
|
455
|
+
RealtimeMedia: RealtimeMedia;
|
|
451
456
|
RelativeGui: RelativeGui;
|
|
452
457
|
RemoteEvent: RemoteEvent;
|
|
453
458
|
RemoteFunction: RemoteFunction;
|
|
@@ -747,6 +752,7 @@ interface Objects extends Instances {
|
|
|
747
752
|
MLSession: MLSession;
|
|
748
753
|
Object: RBXObject;
|
|
749
754
|
OutputLink: OutputLink;
|
|
755
|
+
PluginConnection: PluginConnection;
|
|
750
756
|
ScreenshotCapture: ScreenshotCapture;
|
|
751
757
|
TerrainIterateOperation: TerrainIterateOperation;
|
|
752
758
|
TerrainModifyOperation: TerrainModifyOperation;
|
|
@@ -754,6 +760,7 @@ interface Objects extends Instances {
|
|
|
754
760
|
TerrainWriteOperation: TerrainWriteOperation;
|
|
755
761
|
VideoCapture: VideoCapture;
|
|
756
762
|
VideoSampler: VideoSampler;
|
|
763
|
+
VirtualInput: VirtualInput;
|
|
757
764
|
VoxelBuffer: VoxelBuffer;
|
|
758
765
|
WebStreamClient: WebStreamClient;
|
|
759
766
|
}
|
|
@@ -2922,7 +2929,7 @@ interface AdService extends Instance {
|
|
|
2922
2929
|
*
|
|
2923
2930
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterDisclosureButton)
|
|
2924
2931
|
*/
|
|
2925
|
-
RegisterDisclosureButton(this: AdService, disclosureButton: GuiButton,
|
|
2932
|
+
RegisterDisclosureButton(this: AdService, disclosureButton: GuiButton, adIntegrationPlacementId: string): void;
|
|
2926
2933
|
/**
|
|
2927
2934
|
* **Deprecated:** `ShowVideoAd` has been decommissioned and is no longer operational.
|
|
2928
2935
|
*
|
|
@@ -4313,10 +4320,16 @@ interface AssetService extends Instance {
|
|
|
4313
4320
|
*/
|
|
4314
4321
|
CreateAssetVersionAsync(this: AssetService, object: RBXObject, assetType: CastsToEnum<Enum.AssetType>, assetId: number, requestParameters?: object): unknown;
|
|
4315
4322
|
/**
|
|
4323
|
+
* Creates ephemeral, `DataModel`-scoped content from the provided content input.
|
|
4324
|
+
*
|
|
4316
4325
|
* - **ThreadSafety**: Unsafe
|
|
4317
4326
|
* - **Tags**: Yields
|
|
4318
4327
|
*
|
|
4319
4328
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateDataModelContentAsync)
|
|
4329
|
+
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4330
|
+
* @param content Reference to the input content. Currently, this only supports `Content` wrapping a `EditableMesh` or `EditableImage`.
|
|
4331
|
+
* @param options Optional dictionary containing configuration controls for the created `DataModel` content. Currently no controls are surfaced and this parameter exists for future functionality.
|
|
4332
|
+
* @returns A tuple containing an `CreateContentResult` indicating the success or failure of the request, and the resulting `DataModel`-scoped `Opaque` `Content`.
|
|
4320
4333
|
*/
|
|
4321
4334
|
CreateDataModelContentAsync(this: AssetService, content: Content, options?: object): unknown;
|
|
4322
4335
|
/**
|
|
@@ -4469,7 +4482,9 @@ interface AssetService extends Instance {
|
|
|
4469
4482
|
* - `Items` — Array of items in the bundle, each with details represented through the following keys:
|
|
4470
4483
|
* - `Id` — Item ID
|
|
4471
4484
|
* - `Name` — Item name
|
|
4472
|
-
* - `Type` — Item type such as `"Asset"`
|
|
4485
|
+
* - `Type` — Item type such as `"Asset"`
|
|
4486
|
+
* - `AssetType` — String representing the `AvatarAssetType`
|
|
4487
|
+
* - `SupportsHeadShapes` — Whether the asset supports head shape swapping. Only present if `AssetType` is `"DynamicHead"`.
|
|
4473
4488
|
*/
|
|
4474
4489
|
GetBundleDetailsAsync(this: AssetService, bundleId: number): BundleInfo;
|
|
4475
4490
|
/**
|
|
@@ -6605,7 +6620,7 @@ interface AudioPlayer extends Instance {
|
|
|
6605
6620
|
*/
|
|
6606
6621
|
AutoPlay: boolean;
|
|
6607
6622
|
/**
|
|
6608
|
-
* Denotes whether this `AudioPlayer` is currently playing.
|
|
6623
|
+
* Denotes whether this `AudioPlayer` is currently playing or planning to play.
|
|
6609
6624
|
*
|
|
6610
6625
|
* - **ThreadSafety**: ReadSafe
|
|
6611
6626
|
*
|
|
@@ -6679,9 +6694,14 @@ interface AudioPlayer extends Instance {
|
|
|
6679
6694
|
*/
|
|
6680
6695
|
Volume: number;
|
|
6681
6696
|
/**
|
|
6697
|
+
* Attempts to cancel a pre-planned future `Play` or `Stop` command.
|
|
6698
|
+
*
|
|
6682
6699
|
* - **ThreadSafety**: Unsafe
|
|
6683
6700
|
*
|
|
6684
6701
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Cancel)
|
|
6702
|
+
* @param this Used to play audio assets.
|
|
6703
|
+
* @param actionId The unique-ID of a pre-planned `Play` or `Stop` command.
|
|
6704
|
+
* @returns Whether the cancellation was successful. Returns false if the action has already occurred, or otherwise does not exist.
|
|
6685
6705
|
*/
|
|
6686
6706
|
Cancel(this: AudioPlayer, actionId?: number): boolean;
|
|
6687
6707
|
/**
|
|
@@ -6722,6 +6742,8 @@ interface AudioPlayer extends Instance {
|
|
|
6722
6742
|
*
|
|
6723
6743
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Play)
|
|
6724
6744
|
* @param this Used to play audio assets.
|
|
6745
|
+
* @param atTime A specific time, based on `GetMixerTime`, that this `AudioPlayer` should begin playing at.
|
|
6746
|
+
* @returns If `atTime` was provided, a unique ID, which can be passed to `Cancel()`.
|
|
6725
6747
|
*/
|
|
6726
6748
|
Play(this: AudioPlayer, atTime?: number): number | undefined;
|
|
6727
6749
|
/**
|
|
@@ -6731,6 +6753,8 @@ interface AudioPlayer extends Instance {
|
|
|
6731
6753
|
*
|
|
6732
6754
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Stop)
|
|
6733
6755
|
* @param this Used to play audio assets.
|
|
6756
|
+
* @param atTime A specific time, based on `GetMixerTime`, that this `AudioPlayer` should stop playing at.
|
|
6757
|
+
* @returns If `atTime` was provided, a unique ID, which can be passed to `Cancel()`.
|
|
6734
6758
|
*/
|
|
6735
6759
|
Stop(this: AudioPlayer, atTime?: number): number | undefined;
|
|
6736
6760
|
/**
|
|
@@ -8224,12 +8248,15 @@ interface AvatarEditorService extends Instance {
|
|
|
8224
8248
|
*/
|
|
8225
8249
|
ConformToAvatarRules(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
|
|
8226
8250
|
/**
|
|
8251
|
+
* Returns a copy of the given `HumanoidDescription` that conforms to the platform Avatar rules.
|
|
8252
|
+
*
|
|
8227
8253
|
* - **ThreadSafety**: Unsafe
|
|
8228
8254
|
* - **Tags**: Yields
|
|
8229
8255
|
*
|
|
8230
8256
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#ConformToAvatarRulesAsync)
|
|
8231
8257
|
* @param this A service to support developer Avatar Editors.
|
|
8232
|
-
* @param humanoidDescription
|
|
8258
|
+
* @param humanoidDescription The `HumanoidDescription` to conform.
|
|
8259
|
+
* @returns A new `HumanoidDescription` that conforms to the platform Avatar rules.
|
|
8233
8260
|
*/
|
|
8234
8261
|
ConformToAvatarRulesAsync(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
|
|
8235
8262
|
/**
|
|
@@ -8321,10 +8348,14 @@ interface AvatarEditorService extends Instance {
|
|
|
8321
8348
|
*/
|
|
8322
8349
|
GetFavoriteAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
|
|
8323
8350
|
/**
|
|
8351
|
+
* Returns an array of head shape names that the `Players.LocalPlayer` owns.
|
|
8352
|
+
*
|
|
8324
8353
|
* - **ThreadSafety**: Unsafe
|
|
8325
8354
|
* - **Tags**: Yields
|
|
8326
8355
|
*
|
|
8327
8356
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetHeadShapesAsync)
|
|
8357
|
+
* @param this A service to support developer Avatar Editors.
|
|
8358
|
+
* @returns An array of strings, each identifying a head shape owned by `Players.LocalPlayer`. Possible values include: `"RobloxClassic"`, `"Blockhead"`, `"Cheeks"`, `"Chiseled"`, `"CoolThing"`, `"EraserHead"`, `"FatHead"`, `"FlatTop"`, `"GoldenKorbloxGeneral"`, `"GoldenMrRobot"`, `"KnightOfChivalry"`, `"KnightOfCourage"`, `"ManHead"`, `"MercilessNinja"`, `"Narrow"`, `"Paragon"`, `"Peabrain"`, `"Perfection"`, `"Roll"`, `"Roundy"`, `"RoxBox"`, `"TheEngineer"`, `"Trim"`, `"WomanHead"`.
|
|
8328
8359
|
*/
|
|
8329
8360
|
GetHeadShapesAsync(this: AvatarEditorService): Array<unknown>;
|
|
8330
8361
|
/**
|
|
@@ -8702,7 +8733,7 @@ interface BadgeService extends Instance {
|
|
|
8702
8733
|
* @param this Provides information on badges and awards them.
|
|
8703
8734
|
* @param userId The `UserId` of the player to check for ownership of the specified badges.
|
|
8704
8735
|
* @param badgeIds The list of IDs of the badges to check ownership of. Maximum length of 10.
|
|
8705
|
-
* @returns The list of badge IDs the given user owns out of the provided badge IDs. Empty if none of the provided badges are owned by the given user. Not guaranteed to be in the same order as the input list.
|
|
8736
|
+
* @returns The list of badge IDs the given user owns out of the provided badge IDs. Empty if none of the provided badges are owned by the given user. Not guaranteed to be in the same order as the input list. Some badge IDs may be omitted if the user with the target `userId` has not recently been in the server and the badge IDs are not associated with the requesting experience.
|
|
8706
8737
|
*/
|
|
8707
8738
|
CheckUserBadgesAsync(this: BadgeService, userId: number, badgeIds: Array<unknown>): Array<unknown>;
|
|
8708
8739
|
/**
|
|
@@ -9271,6 +9302,12 @@ interface RootImportData extends BaseImportData {
|
|
|
9271
9302
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RootImportData#MergeMeshes)
|
|
9272
9303
|
*/
|
|
9273
9304
|
MergeMeshes: boolean;
|
|
9305
|
+
/**
|
|
9306
|
+
* - **ThreadSafety**: ReadSafe
|
|
9307
|
+
*
|
|
9308
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RootImportData#PhysicalConstraintType)
|
|
9309
|
+
*/
|
|
9310
|
+
PhysicalConstraintType: Enum.PhysicalConstraintType;
|
|
9274
9311
|
/**
|
|
9275
9312
|
* - **ThreadSafety**: ReadSafe
|
|
9276
9313
|
* - **Tags**: NotReplicated
|
|
@@ -12729,8 +12766,6 @@ interface AnimationConstraint extends Constraint {
|
|
|
12729
12766
|
*/
|
|
12730
12767
|
readonly _nominal_AnimationConstraint: unique symbol;
|
|
12731
12768
|
/**
|
|
12732
|
-
* **Deprecated:**
|
|
12733
|
-
*
|
|
12734
12769
|
* - **ThreadSafety**: ReadSafe
|
|
12735
12770
|
* - **Tags**: Hidden, NotReplicated
|
|
12736
12771
|
*
|
|
@@ -12740,8 +12775,6 @@ interface AnimationConstraint extends Constraint {
|
|
|
12740
12775
|
*/
|
|
12741
12776
|
readonly C0: CFrame;
|
|
12742
12777
|
/**
|
|
12743
|
-
* **Deprecated:**
|
|
12744
|
-
*
|
|
12745
12778
|
* - **ThreadSafety**: ReadSafe
|
|
12746
12779
|
* - **Tags**: Hidden, NotReplicated
|
|
12747
12780
|
*
|
|
@@ -12775,8 +12808,6 @@ interface AnimationConstraint extends Constraint {
|
|
|
12775
12808
|
*/
|
|
12776
12809
|
MaxTorque: number;
|
|
12777
12810
|
/**
|
|
12778
|
-
* **Deprecated:**
|
|
12779
|
-
*
|
|
12780
12811
|
* - **ThreadSafety**: ReadSafe
|
|
12781
12812
|
* - **Tags**: Hidden, NotReplicated
|
|
12782
12813
|
*
|
|
@@ -12786,8 +12817,6 @@ interface AnimationConstraint extends Constraint {
|
|
|
12786
12817
|
*/
|
|
12787
12818
|
readonly Part0: BasePart | undefined;
|
|
12788
12819
|
/**
|
|
12789
|
-
* **Deprecated:**
|
|
12790
|
-
*
|
|
12791
12820
|
* - **ThreadSafety**: ReadSafe
|
|
12792
12821
|
* - **Tags**: Hidden, NotReplicated
|
|
12793
12822
|
*
|
|
@@ -17528,6 +17557,25 @@ interface Folder extends Instance {
|
|
|
17528
17557
|
*/
|
|
17529
17558
|
readonly _nominal_Folder: unique symbol;
|
|
17530
17559
|
}
|
|
17560
|
+
/**
|
|
17561
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeneratedFolder)
|
|
17562
|
+
*/
|
|
17563
|
+
interface GeneratedFolder extends Folder {
|
|
17564
|
+
/**
|
|
17565
|
+
* **DO NOT USE!**
|
|
17566
|
+
*
|
|
17567
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
17568
|
+
* @hidden
|
|
17569
|
+
* @deprecated
|
|
17570
|
+
*/
|
|
17571
|
+
readonly _nominal_GeneratedFolder: unique symbol;
|
|
17572
|
+
/**
|
|
17573
|
+
* - **ThreadSafety**: Unsafe
|
|
17574
|
+
*
|
|
17575
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeneratedFolder#SetPrimaryPart)
|
|
17576
|
+
*/
|
|
17577
|
+
SetPrimaryPart(this: GeneratedFolder, part: BasePart): void;
|
|
17578
|
+
}
|
|
17531
17579
|
/**
|
|
17532
17580
|
* Protects a `Humanoid` from taking damage dealt through the `Humanoid:TakeDamage()` method and protects `BaseParts` from having their joints broken due to an `Explosion`.
|
|
17533
17581
|
*
|
|
@@ -19059,8 +19107,6 @@ interface GuiButton extends GuiObject {
|
|
|
19059
19107
|
*/
|
|
19060
19108
|
readonly MouseButton2Up: RBXScriptSignal<(x: number, y: number) => void>;
|
|
19061
19109
|
/**
|
|
19062
|
-
* Fires when a right-click is detected on desktop, long press detected on mobile, or triangle / Y activated in UI navigation mode on console. This function is not available yet.
|
|
19063
|
-
*
|
|
19064
19110
|
* - **ThreadSafety**: Unsafe
|
|
19065
19111
|
*
|
|
19066
19112
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#SecondaryActivated)
|
|
@@ -24345,6 +24391,8 @@ interface HumanoidDescription extends Instance {
|
|
|
24345
24391
|
*/
|
|
24346
24392
|
ShouldersAccessory: string;
|
|
24347
24393
|
/**
|
|
24394
|
+
* When `true`, disables facial animations on a Dynamic Head, displaying a static mood pose instead. Defaults to `false`.
|
|
24395
|
+
*
|
|
24348
24396
|
* - **ThreadSafety**: ReadSafe
|
|
24349
24397
|
*
|
|
24350
24398
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#StaticFacialAnimation)
|
|
@@ -27821,6 +27869,13 @@ interface LogService extends Instance {
|
|
|
27821
27869
|
* @param this A service that allows you to read outputted text.
|
|
27822
27870
|
*/
|
|
27823
27871
|
ClearOutput(this: LogService): void;
|
|
27872
|
+
/**
|
|
27873
|
+
* - **ThreadSafety**: Unsafe
|
|
27874
|
+
* - **Tags**: CustomLuaState
|
|
27875
|
+
*
|
|
27876
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Error)
|
|
27877
|
+
*/
|
|
27878
|
+
Error(this: LogService, message: string, context?: object): void;
|
|
27824
27879
|
/**
|
|
27825
27880
|
* Returns a table of tables, each with the message string, message type, and timestamp of a message that the client displays in the output window.
|
|
27826
27881
|
*
|
|
@@ -27830,6 +27885,34 @@ interface LogService extends Instance {
|
|
|
27830
27885
|
* @param this A service that allows you to read outputted text.
|
|
27831
27886
|
*/
|
|
27832
27887
|
GetLogHistory(this: LogService): Array<LogInfo>;
|
|
27888
|
+
/**
|
|
27889
|
+
* - **ThreadSafety**: Unsafe
|
|
27890
|
+
* - **Tags**: CustomLuaState
|
|
27891
|
+
*
|
|
27892
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Info)
|
|
27893
|
+
*/
|
|
27894
|
+
Info(this: LogService, message: string, context?: object): void;
|
|
27895
|
+
/**
|
|
27896
|
+
* - **ThreadSafety**: Unsafe
|
|
27897
|
+
* - **Tags**: CustomLuaState
|
|
27898
|
+
*
|
|
27899
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Log)
|
|
27900
|
+
*/
|
|
27901
|
+
Log(this: LogService, messageType: CastsToEnum<Enum.MessageType>, message: string, context?: object): void;
|
|
27902
|
+
/**
|
|
27903
|
+
* - **ThreadSafety**: Unsafe
|
|
27904
|
+
* - **Tags**: CustomLuaState
|
|
27905
|
+
*
|
|
27906
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Output)
|
|
27907
|
+
*/
|
|
27908
|
+
Output(this: LogService, message: string, context?: object): void;
|
|
27909
|
+
/**
|
|
27910
|
+
* - **ThreadSafety**: Unsafe
|
|
27911
|
+
* - **Tags**: CustomLuaState
|
|
27912
|
+
*
|
|
27913
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Warn)
|
|
27914
|
+
*/
|
|
27915
|
+
Warn(this: LogService, message: string, context?: object): void;
|
|
27833
27916
|
/**
|
|
27834
27917
|
* Fires when the client outputs text.
|
|
27835
27918
|
*
|
|
@@ -27837,7 +27920,7 @@ interface LogService extends Instance {
|
|
|
27837
27920
|
*
|
|
27838
27921
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#MessageOut)
|
|
27839
27922
|
*/
|
|
27840
|
-
readonly MessageOut: RBXScriptSignal<(message: string, messageType: Enum.MessageType) => void>;
|
|
27923
|
+
readonly MessageOut: RBXScriptSignal<(message: string, messageType: Enum.MessageType, context: object) => void>;
|
|
27841
27924
|
}
|
|
27842
27925
|
/**
|
|
27843
27926
|
* The base class for all objects which contain Luau code.
|
|
@@ -28081,6 +28164,8 @@ interface MLService extends Instance {
|
|
|
28081
28164
|
CreateSessionAsync(this: MLService, assetId: string): MLSession;
|
|
28082
28165
|
}
|
|
28083
28166
|
/**
|
|
28167
|
+
* Describes the appearance of a makeup item for the `HumanoidDescription`.
|
|
28168
|
+
*
|
|
28084
28169
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription)
|
|
28085
28170
|
*/
|
|
28086
28171
|
interface MakeupDescription extends Instance {
|
|
@@ -28093,34 +28178,44 @@ interface MakeupDescription extends Instance {
|
|
|
28093
28178
|
*/
|
|
28094
28179
|
readonly _nominal_MakeupDescription: unique symbol;
|
|
28095
28180
|
/**
|
|
28181
|
+
* The asset ID that should be applied when applying this `MakeupDescription`.
|
|
28182
|
+
*
|
|
28096
28183
|
* - **ThreadSafety**: ReadSafe
|
|
28097
28184
|
*
|
|
28098
28185
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#AssetId)
|
|
28099
28186
|
*/
|
|
28100
28187
|
AssetId: number;
|
|
28101
28188
|
/**
|
|
28189
|
+
* A reference to the `Instance` that should be used when applying this `MakeupDescription`.
|
|
28190
|
+
*
|
|
28102
28191
|
* - **ThreadSafety**: ReadSafe
|
|
28103
28192
|
*
|
|
28104
28193
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#Instance)
|
|
28105
28194
|
*/
|
|
28106
28195
|
Instance: Instance | undefined;
|
|
28107
28196
|
/**
|
|
28197
|
+
* The `MakeupType` of the makeup item referred to by this description.
|
|
28198
|
+
*
|
|
28108
28199
|
* - **ThreadSafety**: ReadSafe
|
|
28109
28200
|
*
|
|
28110
28201
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#MakeupType)
|
|
28111
28202
|
*/
|
|
28112
28203
|
MakeupType: Enum.MakeupType;
|
|
28113
28204
|
/**
|
|
28205
|
+
* The layering sort order for the makeup item.
|
|
28206
|
+
*
|
|
28114
28207
|
* - **ThreadSafety**: ReadSafe
|
|
28115
28208
|
*
|
|
28116
28209
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#Order)
|
|
28117
28210
|
*/
|
|
28118
28211
|
Order: number;
|
|
28119
28212
|
/**
|
|
28213
|
+
* Returns the applied makeup `Instance`.
|
|
28214
|
+
*
|
|
28120
28215
|
* - **ThreadSafety**: Unsafe
|
|
28121
28216
|
*
|
|
28122
28217
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#GetAppliedInstance)
|
|
28123
|
-
* @param this
|
|
28218
|
+
* @param this Describes the appearance of a makeup item for the `HumanoidDescription`.
|
|
28124
28219
|
*/
|
|
28125
28220
|
GetAppliedInstance(this: MakeupDescription): Instance | undefined;
|
|
28126
28221
|
}
|
|
@@ -32915,6 +33010,51 @@ interface Tool extends BackpackItem {
|
|
|
32915
33010
|
*/
|
|
32916
33011
|
readonly Unequipped: RBXScriptSignal<() => void>;
|
|
32917
33012
|
}
|
|
33013
|
+
/**
|
|
33014
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel)
|
|
33015
|
+
*/
|
|
33016
|
+
interface ProceduralModel extends Model {
|
|
33017
|
+
/**
|
|
33018
|
+
* **DO NOT USE!**
|
|
33019
|
+
*
|
|
33020
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
33021
|
+
* @hidden
|
|
33022
|
+
* @deprecated
|
|
33023
|
+
*/
|
|
33024
|
+
readonly _nominal_ProceduralModel: unique symbol;
|
|
33025
|
+
/**
|
|
33026
|
+
* - **ThreadSafety**: ReadSafe
|
|
33027
|
+
* - **Tags**: NotReplicated
|
|
33028
|
+
*
|
|
33029
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#GenerationError)
|
|
33030
|
+
*/
|
|
33031
|
+
readonly GenerationError: string;
|
|
33032
|
+
/**
|
|
33033
|
+
* - **ThreadSafety**: ReadSafe
|
|
33034
|
+
*
|
|
33035
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#Generator)
|
|
33036
|
+
*/
|
|
33037
|
+
Generator: ModuleScript | undefined;
|
|
33038
|
+
/**
|
|
33039
|
+
* - **ThreadSafety**: ReadSafe
|
|
33040
|
+
*
|
|
33041
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#Size)
|
|
33042
|
+
*/
|
|
33043
|
+
Size: Vector3;
|
|
33044
|
+
/**
|
|
33045
|
+
* - **ThreadSafety**: Unsafe
|
|
33046
|
+
*
|
|
33047
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#ForceGeneration)
|
|
33048
|
+
*/
|
|
33049
|
+
ForceGeneration(this: ProceduralModel): boolean;
|
|
33050
|
+
/**
|
|
33051
|
+
* - **ThreadSafety**: Unsafe
|
|
33052
|
+
* - **Tags**: Yields
|
|
33053
|
+
*
|
|
33054
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#WaitForGenerationAsync)
|
|
33055
|
+
*/
|
|
33056
|
+
WaitForGenerationAsync(this: ProceduralModel): boolean;
|
|
33057
|
+
}
|
|
32918
33058
|
/**
|
|
32919
33059
|
* Base class for handling physics simulation and 3D spatial queries.
|
|
32920
33060
|
*
|
|
@@ -36467,6 +36607,21 @@ interface PluginCapabilities extends Instance {
|
|
|
36467
36607
|
*/
|
|
36468
36608
|
readonly _nominal_PluginCapabilities: unique symbol;
|
|
36469
36609
|
}
|
|
36610
|
+
/**
|
|
36611
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
36612
|
+
*
|
|
36613
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnectionService)
|
|
36614
|
+
*/
|
|
36615
|
+
interface PluginConnectionService extends Instance {
|
|
36616
|
+
/**
|
|
36617
|
+
* **DO NOT USE!**
|
|
36618
|
+
*
|
|
36619
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
36620
|
+
* @hidden
|
|
36621
|
+
* @deprecated
|
|
36622
|
+
*/
|
|
36623
|
+
readonly _nominal_PluginConnectionService: unique symbol;
|
|
36624
|
+
}
|
|
36470
36625
|
/**
|
|
36471
36626
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
36472
36627
|
*
|
|
@@ -36915,6 +37070,21 @@ interface SunRaysEffect extends PostEffect {
|
|
|
36915
37070
|
*/
|
|
36916
37071
|
Spread: number;
|
|
36917
37072
|
}
|
|
37073
|
+
/**
|
|
37074
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
37075
|
+
*
|
|
37076
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralBehaviorSchedulerService)
|
|
37077
|
+
*/
|
|
37078
|
+
interface ProceduralBehaviorSchedulerService extends Instance {
|
|
37079
|
+
/**
|
|
37080
|
+
* **DO NOT USE!**
|
|
37081
|
+
*
|
|
37082
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
37083
|
+
* @hidden
|
|
37084
|
+
* @deprecated
|
|
37085
|
+
*/
|
|
37086
|
+
readonly _nominal_ProceduralBehaviorSchedulerService: unique symbol;
|
|
37087
|
+
}
|
|
36918
37088
|
/**
|
|
36919
37089
|
* - **Tags**: NotCreatable, Service
|
|
36920
37090
|
*
|
|
@@ -37317,6 +37487,75 @@ interface RTAnimationTracker extends Instance {
|
|
|
37317
37487
|
*/
|
|
37318
37488
|
readonly TrackerPrompt: RBXScriptSignal<(prompt: Enum.TrackerPromptEvent) => void>;
|
|
37319
37489
|
}
|
|
37490
|
+
/**
|
|
37491
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia)
|
|
37492
|
+
*/
|
|
37493
|
+
interface RealtimeMedia extends Instance {
|
|
37494
|
+
/**
|
|
37495
|
+
* **DO NOT USE!**
|
|
37496
|
+
*
|
|
37497
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
37498
|
+
* @hidden
|
|
37499
|
+
* @deprecated
|
|
37500
|
+
*/
|
|
37501
|
+
readonly _nominal_RealtimeMedia: unique symbol;
|
|
37502
|
+
/**
|
|
37503
|
+
* - **ThreadSafety**: ReadSafe
|
|
37504
|
+
* - **Tags**: NotReplicated
|
|
37505
|
+
*
|
|
37506
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#IsConnected)
|
|
37507
|
+
*/
|
|
37508
|
+
readonly IsConnected: boolean;
|
|
37509
|
+
/**
|
|
37510
|
+
* - **ThreadSafety**: Unsafe
|
|
37511
|
+
*
|
|
37512
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#Disconnect)
|
|
37513
|
+
*/
|
|
37514
|
+
Disconnect(this: RealtimeMedia): void;
|
|
37515
|
+
/**
|
|
37516
|
+
* - **ThreadSafety**: Unsafe
|
|
37517
|
+
*
|
|
37518
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#GetConnectedWires)
|
|
37519
|
+
*/
|
|
37520
|
+
GetConnectedWires(this: RealtimeMedia, pin: string): Array<Instance>;
|
|
37521
|
+
/**
|
|
37522
|
+
* - **ThreadSafety**: Unsafe
|
|
37523
|
+
*
|
|
37524
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#GetInputPins)
|
|
37525
|
+
*/
|
|
37526
|
+
GetInputPins(this: RealtimeMedia): Array<unknown>;
|
|
37527
|
+
/**
|
|
37528
|
+
* - **ThreadSafety**: Unsafe
|
|
37529
|
+
*
|
|
37530
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#GetOutputPins)
|
|
37531
|
+
*/
|
|
37532
|
+
GetOutputPins(this: RealtimeMedia): Array<unknown>;
|
|
37533
|
+
/**
|
|
37534
|
+
* - **ThreadSafety**: Unsafe
|
|
37535
|
+
*
|
|
37536
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#SendMessage)
|
|
37537
|
+
*/
|
|
37538
|
+
SendMessage(this: RealtimeMedia, message: string, binary: boolean): boolean;
|
|
37539
|
+
/**
|
|
37540
|
+
* - **ThreadSafety**: Unsafe
|
|
37541
|
+
* - **Tags**: Yields
|
|
37542
|
+
*
|
|
37543
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#ConnectAsync)
|
|
37544
|
+
*/
|
|
37545
|
+
ConnectAsync(this: RealtimeMedia, serverUrl: string, connectParams?: object): boolean;
|
|
37546
|
+
/**
|
|
37547
|
+
* - **ThreadSafety**: Unsafe
|
|
37548
|
+
*
|
|
37549
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#OnMessage)
|
|
37550
|
+
*/
|
|
37551
|
+
readonly OnMessage: RBXScriptSignal<(message: string, binary: boolean) => void>;
|
|
37552
|
+
/**
|
|
37553
|
+
* - **ThreadSafety**: Unsafe
|
|
37554
|
+
*
|
|
37555
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#WiringChanged)
|
|
37556
|
+
*/
|
|
37557
|
+
readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
|
|
37558
|
+
}
|
|
37320
37559
|
/**
|
|
37321
37560
|
* A service that provides an interface for you to manage and display personalized content recommendations.
|
|
37322
37561
|
*
|
|
@@ -38440,6 +38679,18 @@ interface ScriptContext extends Instance {
|
|
|
38440
38679
|
* @deprecated
|
|
38441
38680
|
*/
|
|
38442
38681
|
readonly _nominal_ScriptContext: unique symbol;
|
|
38682
|
+
/**
|
|
38683
|
+
* - **ThreadSafety**: Unsafe
|
|
38684
|
+
*
|
|
38685
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#EnableCoverage)
|
|
38686
|
+
*/
|
|
38687
|
+
EnableCoverage(this: ScriptContext, instance: Instance): void;
|
|
38688
|
+
/**
|
|
38689
|
+
* - **ThreadSafety**: Unsafe
|
|
38690
|
+
*
|
|
38691
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#GetCoverageStats)
|
|
38692
|
+
*/
|
|
38693
|
+
GetCoverageStats(this: ScriptContext): Array<unknown>;
|
|
38443
38694
|
/**
|
|
38444
38695
|
* Fired when an error occurs.
|
|
38445
38696
|
*
|
|
@@ -40798,9 +41049,13 @@ interface SoundService extends Instance {
|
|
|
40798
41049
|
BasePart
|
|
40799
41050
|
]>;
|
|
40800
41051
|
/**
|
|
41052
|
+
* Returns the number of seconds since the audio engine began mixing.
|
|
41053
|
+
*
|
|
40801
41054
|
* - **ThreadSafety**: Unsafe
|
|
40802
41055
|
*
|
|
40803
41056
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#GetMixerTime)
|
|
41057
|
+
* @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.
|
|
41058
|
+
* @returns The number of seconds since the audio engine began mixing. This value is stable, sample-accurate, and monotonically-increasing – intended to be used for scheduling audible changes at precise times.
|
|
40804
41059
|
*/
|
|
40805
41060
|
GetMixerTime(this: SoundService): number;
|
|
40806
41061
|
/**
|
|
@@ -41729,6 +41984,18 @@ interface StudioTestService extends Instance {
|
|
|
41729
41984
|
* @deprecated
|
|
41730
41985
|
*/
|
|
41731
41986
|
readonly _nominal_StudioTestService: unique symbol;
|
|
41987
|
+
/**
|
|
41988
|
+
* - **ThreadSafety**: Unsafe
|
|
41989
|
+
*
|
|
41990
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#AddPlayers)
|
|
41991
|
+
*/
|
|
41992
|
+
AddPlayers(this: StudioTestService, numPlayers: number): void;
|
|
41993
|
+
/**
|
|
41994
|
+
* - **ThreadSafety**: Unsafe
|
|
41995
|
+
*
|
|
41996
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#CanLeaveTest)
|
|
41997
|
+
*/
|
|
41998
|
+
CanLeaveTest(this: StudioTestService): boolean;
|
|
41732
41999
|
/**
|
|
41733
42000
|
* - **ThreadSafety**: Unsafe
|
|
41734
42001
|
*
|
|
@@ -41745,6 +42012,12 @@ interface StudioTestService extends Instance {
|
|
|
41745
42012
|
* @returns Arguments passed to the test, or `nil`.
|
|
41746
42013
|
*/
|
|
41747
42014
|
GetTestArgs(this: StudioTestService): unknown;
|
|
42015
|
+
/**
|
|
42016
|
+
* - **ThreadSafety**: Unsafe
|
|
42017
|
+
*
|
|
42018
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#LeaveTest)
|
|
42019
|
+
*/
|
|
42020
|
+
LeaveTest(this: StudioTestService): void;
|
|
41748
42021
|
}
|
|
41749
42022
|
/**
|
|
41750
42023
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -42164,6 +42437,12 @@ interface SurfaceAppearance extends Instance {
|
|
|
42164
42437
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#NormalMapContent)
|
|
42165
42438
|
*/
|
|
42166
42439
|
get NormalMapContent(): Content;
|
|
42440
|
+
/**
|
|
42441
|
+
* - **ThreadSafety**: ReadSafe
|
|
42442
|
+
*
|
|
42443
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#ResampleMode)
|
|
42444
|
+
*/
|
|
42445
|
+
ResampleMode: Enum.ResamplerMode;
|
|
42167
42446
|
/**
|
|
42168
42447
|
* - **ThreadSafety**: ReadSafe
|
|
42169
42448
|
* - **Tags**: Hidden
|
|
@@ -42628,7 +42907,7 @@ interface TeleportService extends Instance {
|
|
|
42628
42907
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#PromptExperienceDetailsAsync)
|
|
42629
42908
|
* @param this Enables transporting `Players` between places and servers. For more information on how to teleport players between servers, see [Teleport between places](../../../projects/teleport.md).
|
|
42630
42909
|
* @param player The `Player` to be presented the prompt.
|
|
42631
|
-
* @param universeId `DataModel.UniverseId` of the experience to be presented to the `Player
|
|
42910
|
+
* @param universeId `DataModel.UniverseId` of the experience to be presented to the `Player`.
|
|
42632
42911
|
* @returns `PromptExperienceDetailsResult`
|
|
42633
42912
|
*/
|
|
42634
42913
|
PromptExperienceDetailsAsync(this: TeleportService, player: Player, universeId: number): Enum.PromptExperienceDetailsResult;
|
|
@@ -49013,6 +49292,21 @@ interface OutputLink extends RBXObject {
|
|
|
49013
49292
|
*/
|
|
49014
49293
|
readonly _nominal_OutputLink: unique symbol;
|
|
49015
49294
|
}
|
|
49295
|
+
/**
|
|
49296
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
49297
|
+
*
|
|
49298
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnection)
|
|
49299
|
+
*/
|
|
49300
|
+
interface PluginConnection extends RBXObject {
|
|
49301
|
+
/**
|
|
49302
|
+
* **DO NOT USE!**
|
|
49303
|
+
*
|
|
49304
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
49305
|
+
* @hidden
|
|
49306
|
+
* @deprecated
|
|
49307
|
+
*/
|
|
49308
|
+
readonly _nominal_PluginConnection: unique symbol;
|
|
49309
|
+
}
|
|
49016
49310
|
/**
|
|
49017
49311
|
* - **Tags**: NotCreatable, NotReplicated
|
|
49018
49312
|
*
|
|
@@ -49171,6 +49465,21 @@ interface VideoSampler extends RBXObject {
|
|
|
49171
49465
|
*/
|
|
49172
49466
|
GetSamplesAtTimesAsync(this: VideoSampler, times: Array<unknown>): Array<unknown>;
|
|
49173
49467
|
}
|
|
49468
|
+
/**
|
|
49469
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
49470
|
+
*
|
|
49471
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput)
|
|
49472
|
+
*/
|
|
49473
|
+
interface VirtualInput extends RBXObject {
|
|
49474
|
+
/**
|
|
49475
|
+
* **DO NOT USE!**
|
|
49476
|
+
*
|
|
49477
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
49478
|
+
* @hidden
|
|
49479
|
+
* @deprecated
|
|
49480
|
+
*/
|
|
49481
|
+
readonly _nominal_VirtualInput: unique symbol;
|
|
49482
|
+
}
|
|
49174
49483
|
/**
|
|
49175
49484
|
* - **Tags**: NotCreatable, NotReplicated
|
|
49176
49485
|
*
|