@rbxts/types 1.0.684 → 1.0.686
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.
|
@@ -94,6 +94,7 @@ interface Services {
|
|
|
94
94
|
ScriptChangeService: ScriptChangeService;
|
|
95
95
|
ScriptCloneWatcher: ScriptCloneWatcher;
|
|
96
96
|
ScriptCloneWatcherHelper: ScriptCloneWatcherHelper;
|
|
97
|
+
ScriptCommitService: ScriptCommitService;
|
|
97
98
|
ScriptContext: ScriptContext;
|
|
98
99
|
ScriptEditorService: ScriptEditorService;
|
|
99
100
|
ScriptRegistrationService: ScriptRegistrationService;
|
|
@@ -117,6 +118,7 @@ interface Services {
|
|
|
117
118
|
StudioPublishService: StudioPublishService;
|
|
118
119
|
StudioScriptDebugEventListener: StudioScriptDebugEventListener;
|
|
119
120
|
StudioSdkService: StudioSdkService;
|
|
121
|
+
StylingService: StylingService;
|
|
120
122
|
TeamCreateData: TeamCreateData;
|
|
121
123
|
TeamCreatePublishService: TeamCreatePublishService;
|
|
122
124
|
TeamCreateService: TeamCreateService;
|
|
@@ -199,7 +201,6 @@ interface CreatableInstances {
|
|
|
199
201
|
ControllerManager: ControllerManager;
|
|
200
202
|
ControllerPartSensor: ControllerPartSensor;
|
|
201
203
|
CornerWedgePart: CornerWedgePart;
|
|
202
|
-
CSGOptions: CSGOptions;
|
|
203
204
|
CurveAnimation: CurveAnimation;
|
|
204
205
|
CylinderHandleAdornment: CylinderHandleAdornment;
|
|
205
206
|
CylinderMesh: CylinderMesh;
|
|
@@ -213,6 +214,7 @@ interface CreatableInstances {
|
|
|
213
214
|
DialogChoice: DialogChoice;
|
|
214
215
|
DistortionSoundEffect: DistortionSoundEffect;
|
|
215
216
|
DoubleConstrainedValue: DoubleConstrainedValue;
|
|
217
|
+
DragDetector: DragDetector;
|
|
216
218
|
Dragger: Dragger;
|
|
217
219
|
EchoSoundEffect: EchoSoundEffect;
|
|
218
220
|
EqualizerSoundEffect: EqualizerSoundEffect;
|
|
@@ -321,6 +323,10 @@ interface CreatableInstances {
|
|
|
321
323
|
SpringConstraint: SpringConstraint;
|
|
322
324
|
StarterGear: StarterGear;
|
|
323
325
|
StringValue: StringValue;
|
|
326
|
+
StyleDerive: StyleDerive;
|
|
327
|
+
StyleLink: StyleLink;
|
|
328
|
+
StyleRule: StyleRule;
|
|
329
|
+
StyleSheet: StyleSheet;
|
|
324
330
|
SunRaysEffect: SunRaysEffect;
|
|
325
331
|
SurfaceAppearance: SurfaceAppearance;
|
|
326
332
|
SurfaceGui: SurfaceGui;
|
|
@@ -511,6 +517,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
511
517
|
StandardPages: StandardPages;
|
|
512
518
|
StarterCharacterScripts: StarterCharacterScripts;
|
|
513
519
|
StarterPlayerScripts: StarterPlayerScripts;
|
|
520
|
+
StyleBase: StyleBase;
|
|
514
521
|
SurfaceGuiBase: SurfaceGuiBase;
|
|
515
522
|
SyncScriptBuilder: SyncScriptBuilder;
|
|
516
523
|
TeleportAsyncResult: TeleportAsyncResult;
|
|
@@ -518,6 +525,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
518
525
|
TextChatConfigurations: TextChatConfigurations;
|
|
519
526
|
TextChatMessage: TextChatMessage;
|
|
520
527
|
TextFilterResult: TextFilterResult;
|
|
528
|
+
TextFilterTranslatedResult: TextFilterTranslatedResult;
|
|
521
529
|
TextSource: TextSource;
|
|
522
530
|
TextureGuiExperimental: TextureGuiExperimental;
|
|
523
531
|
ThreadState: ThreadState;
|
|
@@ -626,6 +634,7 @@ interface Instance {
|
|
|
626
634
|
* Tags: NotReplicated
|
|
627
635
|
*/
|
|
628
636
|
Parent: Instance | undefined;
|
|
637
|
+
AddTag(this: Instance, tag: string): void;
|
|
629
638
|
/**
|
|
630
639
|
* This function destroys all of an [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)'s children.
|
|
631
640
|
*
|
|
@@ -926,6 +935,8 @@ interface Instance {
|
|
|
926
935
|
this: T,
|
|
927
936
|
propertyName: InstancePropertyNames<T>,
|
|
928
937
|
): RBXScriptSignal<() => void>;
|
|
938
|
+
GetTags(this: Instance): unknown;
|
|
939
|
+
HasTag(this: Instance, tag: string): boolean;
|
|
929
940
|
/**
|
|
930
941
|
* IsA returns true if the [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)'s class is **equivalent to** or a **subclass** of a given class. This function is similar to the **instanceof** operators in other languages, and is a form of [type introspection](https://en.wikipedia.org/wiki/Type_introspection). To ignore class inheritance, test the [ClassName](https://developer.roblox.com/en-us/api-reference/property/Instance/ClassName) property directly instead. For checking native Lua data types (number, string, etc) use the functions `type` and `typeof`.
|
|
931
942
|
*
|
|
@@ -965,6 +976,7 @@ interface Instance {
|
|
|
965
976
|
* See also, [Instance:IsAncestorOf](https://developer.roblox.com/en-us/api-reference/function/Instance/IsAncestorOf).
|
|
966
977
|
*/
|
|
967
978
|
IsDescendantOf(this: Instance, ancestor: Instance): boolean;
|
|
979
|
+
RemoveTag(this: Instance, tag: string): void;
|
|
968
980
|
/**
|
|
969
981
|
* This function sets the attribute with the given name to the given value. If the value given is nil, then the attribute will be removed (since nil is returned by default).
|
|
970
982
|
*
|
|
@@ -1238,11 +1250,6 @@ interface AdPortal extends Instance {
|
|
|
1238
1250
|
* @deprecated
|
|
1239
1251
|
*/
|
|
1240
1252
|
readonly _nominal_AdPortal: unique symbol;
|
|
1241
|
-
/**
|
|
1242
|
-
* Tags: ReadOnly, NotReplicated, Deprecated
|
|
1243
|
-
* @deprecated
|
|
1244
|
-
*/
|
|
1245
|
-
readonly PortalStatus: Enum.AdPortalStatus;
|
|
1246
1253
|
/**
|
|
1247
1254
|
* Tags: ReadOnly, NotReplicated
|
|
1248
1255
|
*/
|
|
@@ -2497,6 +2504,7 @@ interface Attachment extends Instance {
|
|
|
2497
2504
|
* @deprecated
|
|
2498
2505
|
*/
|
|
2499
2506
|
GetAxis(this: Attachment): Vector3;
|
|
2507
|
+
GetConstraints(this: Attachment): Array<Instance>;
|
|
2500
2508
|
/**
|
|
2501
2509
|
* Returns the value of the Attachment's [Attachment.SecondaryAxis](https://developer.roblox.com/en-us/api-reference/property/Attachment/SecondaryAxis).
|
|
2502
2510
|
* Tags: Deprecated, [object Object]
|
|
@@ -5425,17 +5433,6 @@ interface BulkImportService extends Instance {
|
|
|
5425
5433
|
readonly _nominal_BulkImportService: unique symbol;
|
|
5426
5434
|
}
|
|
5427
5435
|
|
|
5428
|
-
interface CSGOptions extends Instance {
|
|
5429
|
-
/**
|
|
5430
|
-
* **DO NOT USE!**
|
|
5431
|
-
*
|
|
5432
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
5433
|
-
* @hidden
|
|
5434
|
-
* @deprecated
|
|
5435
|
-
*/
|
|
5436
|
-
readonly _nominal_CSGOptions: unique symbol;
|
|
5437
|
-
}
|
|
5438
|
-
|
|
5439
5436
|
interface CalloutService extends Instance {
|
|
5440
5437
|
/**
|
|
5441
5438
|
* **DO NOT USE!**
|
|
@@ -5707,6 +5704,7 @@ interface Camera extends Instance {
|
|
|
5707
5704
|
* Tags: ReadOnly, NotReplicated
|
|
5708
5705
|
*/
|
|
5709
5706
|
readonly NearPlaneZ: number;
|
|
5707
|
+
VRTiltAndRollEnabled: boolean;
|
|
5710
5708
|
/**
|
|
5711
5709
|
* ViewportSize describes the dimensions, in pixels, of the client's viewport.
|
|
5712
5710
|
*
|
|
@@ -6506,6 +6504,61 @@ interface ClickDetector extends Instance {
|
|
|
6506
6504
|
readonly RightMouseClick: RBXScriptSignal<(playerWhoClicked: Player) => void>;
|
|
6507
6505
|
}
|
|
6508
6506
|
|
|
6507
|
+
interface DragDetector extends ClickDetector {
|
|
6508
|
+
/**
|
|
6509
|
+
* **DO NOT USE!**
|
|
6510
|
+
*
|
|
6511
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
6512
|
+
* @hidden
|
|
6513
|
+
* @deprecated
|
|
6514
|
+
*/
|
|
6515
|
+
readonly _nominal_DragDetector: unique symbol;
|
|
6516
|
+
ApplyAtCenterOfMass: boolean;
|
|
6517
|
+
/**
|
|
6518
|
+
* Tags: NotReplicated
|
|
6519
|
+
*/
|
|
6520
|
+
Axis: Vector3;
|
|
6521
|
+
DragFrame: CFrame;
|
|
6522
|
+
DragStyle: Enum.DragDetectorDragStyle;
|
|
6523
|
+
Enabled: boolean;
|
|
6524
|
+
GamepadModeSwitchKeyCode: Enum.KeyCode;
|
|
6525
|
+
KeyboardModeSwitchKeyCode: Enum.KeyCode;
|
|
6526
|
+
MaxDragAngle: number;
|
|
6527
|
+
MaxDragTranslation: Vector3;
|
|
6528
|
+
MaxForce: number;
|
|
6529
|
+
MaxTorque: number;
|
|
6530
|
+
MinDragAngle: number;
|
|
6531
|
+
MinDragTranslation: Vector3;
|
|
6532
|
+
Orientation: Vector3;
|
|
6533
|
+
ReferenceInstance: Instance | undefined;
|
|
6534
|
+
ResponseStyle: Enum.DragDetectorResponseStyle;
|
|
6535
|
+
Responsiveness: number;
|
|
6536
|
+
RunLocally: boolean;
|
|
6537
|
+
/**
|
|
6538
|
+
* Tags: NotReplicated
|
|
6539
|
+
*/
|
|
6540
|
+
SecondaryAxis: Vector3;
|
|
6541
|
+
TrackballRadialPullFactor: number;
|
|
6542
|
+
TrackballRollFactor: number;
|
|
6543
|
+
VRSwitchKeyCode: Enum.KeyCode;
|
|
6544
|
+
/**
|
|
6545
|
+
* Tags: NotReplicated
|
|
6546
|
+
*/
|
|
6547
|
+
WorldAxis: Vector3;
|
|
6548
|
+
/**
|
|
6549
|
+
* Tags: NotReplicated
|
|
6550
|
+
*/
|
|
6551
|
+
WorldSecondaryAxis: Vector3;
|
|
6552
|
+
AddConstraintFunction(this: DragDetector, name: string, priority: number, callback: Callback): void;
|
|
6553
|
+
GetReferenceFrame(this: DragDetector): CFrame;
|
|
6554
|
+
RemoveConstraintFunction(this: DragDetector, name: string): void;
|
|
6555
|
+
RestartDrag(this: DragDetector): void;
|
|
6556
|
+
SetDragStyleFunction(this: DragDetector, callback: Callback): void;
|
|
6557
|
+
readonly DragContinue: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
6558
|
+
readonly DragEnd: RBXScriptSignal<(playerWhoDragged: Player) => void>;
|
|
6559
|
+
readonly DragStart: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
6560
|
+
}
|
|
6561
|
+
|
|
6509
6562
|
/** The **Clouds** object renders realistic clouds that drift slowly across the sky. Both cloud cover and density can be adjusted, as well as cloud color to achieve atmospheres like stormy skies, moody sunsets, alien worlds, etc.
|
|
6510
6563
|
*
|
|
6511
6564
|
* See the [Dynamic Clouds](https://developer.roblox.com/articles/dynamic-clouds) article for a summary of properties and expected results.
|
|
@@ -23215,6 +23268,7 @@ interface BasePart extends PVInstance {
|
|
|
23215
23268
|
* * [Network ownership](https://developer.roblox.com/articles/Network-Ownership)
|
|
23216
23269
|
*/
|
|
23217
23270
|
CanSetNetworkOwnership(this: BasePart): LuaTuple<[boolean, string | undefined]>;
|
|
23271
|
+
GetClosestPointOnSurface(this: BasePart, position: Vector3): Vector3;
|
|
23218
23272
|
/**
|
|
23219
23273
|
* Returns a table of parts connected to the the object by any kind of rigid joint.
|
|
23220
23274
|
*
|
|
@@ -24285,6 +24339,7 @@ interface VehicleSeat extends BasePart {
|
|
|
24285
24339
|
readonly Occupant: Humanoid | undefined;
|
|
24286
24340
|
/**
|
|
24287
24341
|
* The direction of movement, tied to the keys A and D. Must be one of 1 (right), 0 (straight), or -1 (left). Will refresh back to 0 unless constantly set.
|
|
24342
|
+
* Tags: NotReplicated
|
|
24288
24343
|
*/
|
|
24289
24344
|
Steer: number;
|
|
24290
24345
|
/**
|
|
@@ -24293,6 +24348,7 @@ interface VehicleSeat extends BasePart {
|
|
|
24293
24348
|
SteerFloat: number;
|
|
24294
24349
|
/**
|
|
24295
24350
|
* The direction of movement, tied to the keys W and S. Must be an integer 1 (forward) 0 (null) or -1 (reverse). Will refresh back to 0 unless constantly set.
|
|
24351
|
+
* Tags: NotReplicated
|
|
24296
24352
|
*/
|
|
24297
24353
|
Throttle: number;
|
|
24298
24354
|
/**
|
|
@@ -24426,6 +24482,7 @@ interface Model extends PVInstance {
|
|
|
24426
24482
|
* @deprecated
|
|
24427
24483
|
*/
|
|
24428
24484
|
GetModelSize(this: Model): Vector3;
|
|
24485
|
+
GetPersistentPlayers(this: Model): Array<Instance>;
|
|
24429
24486
|
/**
|
|
24430
24487
|
* This function has been superseded by [PVInstance:GetPivot](https://developer.roblox.com/en-us/api-reference/function/PVInstance/GetPivot) which acts as a replacement and does not change your code's behavior. Use [PVInstance:GetPivot](https://developer.roblox.com/en-us/api-reference/function/PVInstance/GetPivot) for new work and migrate your existing [Model:GetPrimaryPartCFrame](https://developer.roblox.com/en-us/api-reference/function/Model/GetPrimaryPartCFrame) calls when convenient.
|
|
24431
24488
|
*
|
|
@@ -25910,6 +25967,7 @@ interface ParticleEmitter extends Instance {
|
|
|
25910
25967
|
* @deprecated
|
|
25911
25968
|
*/
|
|
25912
25969
|
VelocitySpread: number;
|
|
25970
|
+
WindAffectsDrag: boolean;
|
|
25913
25971
|
/**
|
|
25914
25972
|
* The ZOffset property determines the forward-backward (Z) render position of particles, in studs. they render at a modified [ParticleEmitter.Size](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Size) such that this property will not affect the screen size of particles. When changed, this property will affects all particles, both current and future particles. Note that this property accepts fractional values; it is not like [GuiObject.ZIndex](https://developer.roblox.com/en-us/api-reference/property/GuiObject/ZIndex) (an integer)
|
|
25915
25973
|
*
|
|
@@ -26591,6 +26649,8 @@ interface Player extends Instance {
|
|
|
26591
26649
|
* When mouse lock is enabled, the player's cursor is locked to the center of the screen. Moving the mouse will orbit the camera around the player's [character](https://developer.roblox.com/en-us/api-reference/property/Player/Character), and character will face the same direction as the [camera](https://developer.roblox.com/en-us/api-reference/class/Camera). It also offsets the camera view just over the right shoulder of the player's character.
|
|
26592
26650
|
*
|
|
26593
26651
|
* Below, the camera is moved left and right first by holding right-click. Then, mouse lock is enabled which changes the mouse to a target reticule, and offsets the camera. The camera is again moved left and right (without holding right click).
|
|
26652
|
+
* Tags: Deprecated
|
|
26653
|
+
* @deprecated
|
|
26594
26654
|
*/
|
|
26595
26655
|
DevEnableMouseLock: boolean;
|
|
26596
26656
|
/**
|
|
@@ -29008,9 +29068,14 @@ interface SyncScriptBuilder extends ScriptBuilder {
|
|
|
29008
29068
|
* @deprecated
|
|
29009
29069
|
*/
|
|
29010
29070
|
readonly _nominal_SyncScriptBuilder: unique symbol;
|
|
29071
|
+
CompileTarget: Enum.CompileTarget;
|
|
29011
29072
|
CoverageInfo: boolean;
|
|
29012
29073
|
DebugInfo: boolean;
|
|
29013
29074
|
PackAsSource: boolean;
|
|
29075
|
+
/**
|
|
29076
|
+
* Tags: Deprecated, [object Object]
|
|
29077
|
+
* @deprecated
|
|
29078
|
+
*/
|
|
29014
29079
|
RawBytecode: boolean;
|
|
29015
29080
|
}
|
|
29016
29081
|
|
|
@@ -29047,6 +29112,17 @@ interface ScriptCloneWatcherHelper extends Instance {
|
|
|
29047
29112
|
readonly _nominal_ScriptCloneWatcherHelper: unique symbol;
|
|
29048
29113
|
}
|
|
29049
29114
|
|
|
29115
|
+
interface ScriptCommitService extends Instance {
|
|
29116
|
+
/**
|
|
29117
|
+
* **DO NOT USE!**
|
|
29118
|
+
*
|
|
29119
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
29120
|
+
* @hidden
|
|
29121
|
+
* @deprecated
|
|
29122
|
+
*/
|
|
29123
|
+
readonly _nominal_ScriptCommitService: unique symbol;
|
|
29124
|
+
}
|
|
29125
|
+
|
|
29050
29126
|
/** This service controls all [BaseScript](https://developer.roblox.com/en-us/api-reference/class/BaseScript) objects. Most of the properties and methods of this service are locked for internal use, however you may use the [ScriptContext.ScriptsDisabled](https://developer.roblox.com/en-us/api-reference/property/ScriptContext/ScriptsDisabled) property to disable all scripts from a thread with normal security access. */
|
|
29051
29127
|
interface ScriptContext extends Instance {
|
|
29052
29128
|
/**
|
|
@@ -29827,6 +29903,7 @@ interface SocialService extends Instance {
|
|
|
29827
29903
|
* Before using this function, you should use the [CanSendGameInviteAsync](https://developer.roblox.com/en-us/api-reference/function/SocialService/CanSendGameInviteAsync) function to determine whether a player can send a game invite, as this can vary depending on the platform or player. After determining that invites are possible for this player, allow the player to opt-in to inviting others. For example, the player clicked on an “Invite Friends” button, shown after `CanSendGameInviteAsync` returned true.\`
|
|
29828
29904
|
*/
|
|
29829
29905
|
PromptGameInvite(this: SocialService, player: Player, experienceInviteOptions?: ExperienceInviteOptions): void;
|
|
29906
|
+
PromptIrisInvite(this: SocialService, player: Player, tag: string): void;
|
|
29830
29907
|
/**
|
|
29831
29908
|
* **CanSendGameInviteAsync** indicates whether the given [Player](https://developer.roblox.com/en-us/api-reference/class/Player) can invite other players to the current game. If they can, it returns true.
|
|
29832
29909
|
*
|
|
@@ -29834,6 +29911,10 @@ interface SocialService extends Instance {
|
|
|
29834
29911
|
* Tags: Yields
|
|
29835
29912
|
*/
|
|
29836
29913
|
CanSendGameInviteAsync(this: SocialService, player: Player, recipientId?: number): boolean;
|
|
29914
|
+
/**
|
|
29915
|
+
* Tags: Yields
|
|
29916
|
+
*/
|
|
29917
|
+
CanSendIrisInviteAsync(this: SocialService, player: Player): boolean;
|
|
29837
29918
|
/**
|
|
29838
29919
|
* This event is a signal invoked when a player has closed the game invite prompt and batches all users and conversation participants into a single array. This prompt can be prompted by the developer or accessed from the SettingsHub menu.
|
|
29839
29920
|
*
|
|
@@ -29859,6 +29940,8 @@ interface SocialService extends Instance {
|
|
|
29859
29940
|
* * [SocialService:CanSendGameInviteAsync](https://developer.roblox.com/en-us/api-reference/function/SocialService/CanSendGameInviteAsync), returns true or false depending on the user
|
|
29860
29941
|
*/
|
|
29861
29942
|
readonly GameInvitePromptClosed: RBXScriptSignal<(senderPlayer: Player, recipientIds: Array<number>) => void>;
|
|
29943
|
+
readonly IrisInvitePromptClosed: RBXScriptSignal<(player: Player) => void>;
|
|
29944
|
+
OnIrisInviteInvoked: (tag: string, irisParticipantIds: Array<any>) => void;
|
|
29862
29945
|
}
|
|
29863
29946
|
|
|
29864
29947
|
/** A [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) is an object that emits sound. See [Adding Sounds](https://developer.roblox.com/en-us/articles/adding-sounds) for more info on how to upload a sound file.
|
|
@@ -31231,6 +31314,8 @@ interface StarterPlayer extends Instance {
|
|
|
31231
31314
|
* Mouselock will lock the player's cursor to the center of the screen. Moving the mouse will rotate the [Camera](https://developer.roblox.com/en-us/api-reference/class/Camera) and [Player](https://developer.roblox.com/en-us/api-reference/class/Player) will move relative to the current rotation of the camera.
|
|
31232
31315
|
*
|
|
31233
31316
|
* This property sets the value of [Player.DevEnableMouseLock](https://developer.roblox.com/en-us/api-reference/property/Player/DevEnableMouseLock).
|
|
31317
|
+
* Tags: Deprecated
|
|
31318
|
+
* @deprecated
|
|
31234
31319
|
*/
|
|
31235
31320
|
EnableMouseLockOption: boolean;
|
|
31236
31321
|
/**
|
|
@@ -31461,6 +31546,77 @@ interface StudioSdkService extends Instance {
|
|
|
31461
31546
|
readonly _nominal_StudioSdkService: unique symbol;
|
|
31462
31547
|
}
|
|
31463
31548
|
|
|
31549
|
+
interface StyleBase extends Instance {
|
|
31550
|
+
/**
|
|
31551
|
+
* **DO NOT USE!**
|
|
31552
|
+
*
|
|
31553
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
31554
|
+
* @hidden
|
|
31555
|
+
* @deprecated
|
|
31556
|
+
*/
|
|
31557
|
+
readonly _nominal_StyleBase: unique symbol;
|
|
31558
|
+
}
|
|
31559
|
+
|
|
31560
|
+
interface StyleRule extends StyleBase {
|
|
31561
|
+
/**
|
|
31562
|
+
* **DO NOT USE!**
|
|
31563
|
+
*
|
|
31564
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
31565
|
+
* @hidden
|
|
31566
|
+
* @deprecated
|
|
31567
|
+
*/
|
|
31568
|
+
readonly _nominal_StyleRule: unique symbol;
|
|
31569
|
+
Selector: string;
|
|
31570
|
+
/**
|
|
31571
|
+
* Tags: ReadOnly, NotReplicated
|
|
31572
|
+
*/
|
|
31573
|
+
readonly SelectorError: string;
|
|
31574
|
+
}
|
|
31575
|
+
|
|
31576
|
+
interface StyleSheet extends StyleBase {
|
|
31577
|
+
/**
|
|
31578
|
+
* **DO NOT USE!**
|
|
31579
|
+
*
|
|
31580
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
31581
|
+
* @hidden
|
|
31582
|
+
* @deprecated
|
|
31583
|
+
*/
|
|
31584
|
+
readonly _nominal_StyleSheet: unique symbol;
|
|
31585
|
+
}
|
|
31586
|
+
|
|
31587
|
+
interface StyleDerive extends Instance {
|
|
31588
|
+
/**
|
|
31589
|
+
* **DO NOT USE!**
|
|
31590
|
+
*
|
|
31591
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
31592
|
+
* @hidden
|
|
31593
|
+
* @deprecated
|
|
31594
|
+
*/
|
|
31595
|
+
readonly _nominal_StyleDerive: unique symbol;
|
|
31596
|
+
}
|
|
31597
|
+
|
|
31598
|
+
interface StyleLink extends Instance {
|
|
31599
|
+
/**
|
|
31600
|
+
* **DO NOT USE!**
|
|
31601
|
+
*
|
|
31602
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
31603
|
+
* @hidden
|
|
31604
|
+
* @deprecated
|
|
31605
|
+
*/
|
|
31606
|
+
readonly _nominal_StyleLink: unique symbol;
|
|
31607
|
+
}
|
|
31608
|
+
|
|
31609
|
+
interface StylingService extends Instance {
|
|
31610
|
+
/**
|
|
31611
|
+
* **DO NOT USE!**
|
|
31612
|
+
*
|
|
31613
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
31614
|
+
* @hidden
|
|
31615
|
+
* @deprecated
|
|
31616
|
+
*/
|
|
31617
|
+
readonly _nominal_StylingService: unique symbol;
|
|
31618
|
+
}
|
|
31619
|
+
|
|
31464
31620
|
/** SurfaceAppearance objects allow developers to override the appearance of a [MeshPart](https://developer.roblox.com/en-us/api-reference/class/MeshPart) with advanced graphics options. Most notably, a SurfaceAppearance can apply a set of PBR textures to a mesh.
|
|
31465
31621
|
*
|
|
31466
31622
|
* PBR is short for Physically Based Rendering, which refers to a common texture format for defining extra physical details in games. Because this format is widely used, it's easy to take meshes and textures made in 3rd party editing software and import them into Roblox. It's also easy to find PBR format content from various 3rd party stores such as [SketchFab](https://sketchfab.com/search?q=pbr%20object&sort_by=-relevance&type=models), [TurboSquid](https://www.turbosquid.com/Search/3D-Models/free/pbr), [CGTrader](http://cgtrader.com/pbr-3d-models?polygons=lt_5k).
|
|
@@ -32841,6 +32997,26 @@ interface TextFilterResult extends Instance {
|
|
|
32841
32997
|
GetNonChatStringForUserAsync(this: TextFilterResult, toUserId: number): string;
|
|
32842
32998
|
}
|
|
32843
32999
|
|
|
33000
|
+
interface TextFilterTranslatedResult extends Instance {
|
|
33001
|
+
/**
|
|
33002
|
+
* **DO NOT USE!**
|
|
33003
|
+
*
|
|
33004
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
33005
|
+
* @hidden
|
|
33006
|
+
* @deprecated
|
|
33007
|
+
*/
|
|
33008
|
+
readonly _nominal_TextFilterTranslatedResult: unique symbol;
|
|
33009
|
+
/**
|
|
33010
|
+
* Tags: ReadOnly, NotReplicated
|
|
33011
|
+
*/
|
|
33012
|
+
readonly SourceLanguage: string;
|
|
33013
|
+
/**
|
|
33014
|
+
* Tags: ReadOnly, NotReplicated
|
|
33015
|
+
*/
|
|
33016
|
+
readonly SourceText: TextFilterResult | undefined;
|
|
33017
|
+
GetTranslations(this: TextFilterTranslatedResult): object;
|
|
33018
|
+
}
|
|
33019
|
+
|
|
32844
33020
|
/** The TextService is a service internally responsible for handling the display of text in the game.
|
|
32845
33021
|
*
|
|
32846
33022
|
* This class has two member functions,
|
|
@@ -32872,6 +33048,10 @@ interface TextService extends Instance {
|
|
|
32872
33048
|
* Developers are recommended to add a pixel of padding to the result to ensure no text is cut off.
|
|
32873
33049
|
*/
|
|
32874
33050
|
GetTextSize(this: TextService, string: string, fontSize: number, font: CastsToEnum<Enum.Font>, frameSize: Vector2): Vector2;
|
|
33051
|
+
/**
|
|
33052
|
+
* Tags: Yields
|
|
33053
|
+
*/
|
|
33054
|
+
FilterAndTranslateStringAsync(this: TextService, stringToFilter: string, fromUserId: number, targetLocales: Array<any>, textContext?: CastsToEnum<Enum.TextFilterContext>): Instance | undefined;
|
|
32875
33055
|
/**
|
|
32876
33056
|
* The FilterStringAsync function filters a string being received from a user, using the [TextService](https://developer.roblox.com/en-us/api-reference/class/TextService), and returns a [TextFilterResult](https://developer.roblox.com/en-us/api-reference/class/TextFilterResult) which can be used to distribute the correctly filtered text accordingly.
|
|
32877
33057
|
*
|
|
@@ -34337,6 +34517,8 @@ interface UserGameSettings extends Instance {
|
|
|
34337
34517
|
ComputerMovementMode: Enum.ComputerMovementMode;
|
|
34338
34518
|
/**
|
|
34339
34519
|
* Toggles whether or not the client can use the Mouse Lock Switch mode.
|
|
34520
|
+
* Tags: Deprecated
|
|
34521
|
+
* @deprecated
|
|
34340
34522
|
*/
|
|
34341
34523
|
ControlMode: Enum.ControlMode;
|
|
34342
34524
|
/**
|
|
@@ -2472,6 +2472,7 @@ interface RenderingTest extends Instance {
|
|
|
2472
2472
|
QualityLevel: number;
|
|
2473
2473
|
ShouldSkip: boolean;
|
|
2474
2474
|
Ticket: string;
|
|
2475
|
+
Timeout: number;
|
|
2475
2476
|
RenderdocTriggerCapture(this: RenderingTest): void;
|
|
2476
2477
|
}
|
|
2477
2478
|
|
|
@@ -3102,7 +3103,6 @@ interface Studio extends Instance {
|
|
|
3102
3103
|
* If set to true, deprecated objects will be shown in the Advanced Objects window, as well as the Object Browser.
|
|
3103
3104
|
*/
|
|
3104
3105
|
DeprecatedObjectsShown: boolean;
|
|
3105
|
-
["Display Team Create toggle when creating a new experience"]: boolean;
|
|
3106
3106
|
["Drag Multiple Parts As Single Part"]: boolean;
|
|
3107
3107
|
["Enable Autocomplete"]: boolean;
|
|
3108
3108
|
["Enable CoreScript Debugger"]: boolean;
|
|
@@ -3115,7 +3115,6 @@ interface Studio extends Instance {
|
|
|
3115
3115
|
* Tags: NotReplicated
|
|
3116
3116
|
*/
|
|
3117
3117
|
["Error Color"]: Color3;
|
|
3118
|
-
["File > New creates a place with Team Create off"]: boolean;
|
|
3119
3118
|
/**
|
|
3120
3119
|
* Tags: NotReplicated
|
|
3121
3120
|
*/
|
|
@@ -291,35 +291,6 @@ declare namespace Enum {
|
|
|
291
291
|
}
|
|
292
292
|
export type ActuatorType = ActuatorType.None | ActuatorType.Motor | ActuatorType.Servo;
|
|
293
293
|
|
|
294
|
-
export namespace AdPortalStatus {
|
|
295
|
-
export interface Invalid extends globalThis.EnumItem {
|
|
296
|
-
Name: "Invalid";
|
|
297
|
-
Value: 0;
|
|
298
|
-
EnumType: typeof globalThis.Enum.AdPortalStatus;
|
|
299
|
-
}
|
|
300
|
-
|
|
301
|
-
export const Invalid: Invalid;
|
|
302
|
-
|
|
303
|
-
export interface Inactive extends globalThis.EnumItem {
|
|
304
|
-
Name: "Inactive";
|
|
305
|
-
Value: 1;
|
|
306
|
-
EnumType: typeof globalThis.Enum.AdPortalStatus;
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
export const Inactive: Inactive;
|
|
310
|
-
|
|
311
|
-
export interface Active extends globalThis.EnumItem {
|
|
312
|
-
Name: "Active";
|
|
313
|
-
Value: 2;
|
|
314
|
-
EnumType: typeof globalThis.Enum.AdPortalStatus;
|
|
315
|
-
}
|
|
316
|
-
|
|
317
|
-
export const Active: Active;
|
|
318
|
-
|
|
319
|
-
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AdPortalStatus>;
|
|
320
|
-
}
|
|
321
|
-
export type AdPortalStatus = AdPortalStatus.Invalid | AdPortalStatus.Inactive | AdPortalStatus.Active;
|
|
322
|
-
|
|
323
294
|
export namespace AdPortalType {
|
|
324
295
|
export interface Forward extends globalThis.EnumItem {
|
|
325
296
|
Name: "Forward";
|
|
@@ -3398,6 +3369,43 @@ declare namespace Enum {
|
|
|
3398
3369
|
}
|
|
3399
3370
|
export type CommandPermission = CommandPermission.Plugin | CommandPermission.LocalUser;
|
|
3400
3371
|
|
|
3372
|
+
export namespace CompileTarget {
|
|
3373
|
+
export interface Client extends globalThis.EnumItem {
|
|
3374
|
+
Name: "Client";
|
|
3375
|
+
Value: 0;
|
|
3376
|
+
EnumType: typeof globalThis.Enum.CompileTarget;
|
|
3377
|
+
}
|
|
3378
|
+
|
|
3379
|
+
export const Client: Client;
|
|
3380
|
+
|
|
3381
|
+
export interface CoreScript extends globalThis.EnumItem {
|
|
3382
|
+
Name: "CoreScript";
|
|
3383
|
+
Value: 1;
|
|
3384
|
+
EnumType: typeof globalThis.Enum.CompileTarget;
|
|
3385
|
+
}
|
|
3386
|
+
|
|
3387
|
+
export const CoreScript: CoreScript;
|
|
3388
|
+
|
|
3389
|
+
export interface Studio extends globalThis.EnumItem {
|
|
3390
|
+
Name: "Studio";
|
|
3391
|
+
Value: 2;
|
|
3392
|
+
EnumType: typeof globalThis.Enum.CompileTarget;
|
|
3393
|
+
}
|
|
3394
|
+
|
|
3395
|
+
export const Studio: Studio;
|
|
3396
|
+
|
|
3397
|
+
export interface CoreScriptRaw extends globalThis.EnumItem {
|
|
3398
|
+
Name: "CoreScriptRaw";
|
|
3399
|
+
Value: 3;
|
|
3400
|
+
EnumType: typeof globalThis.Enum.CompileTarget;
|
|
3401
|
+
}
|
|
3402
|
+
|
|
3403
|
+
export const CoreScriptRaw: CoreScriptRaw;
|
|
3404
|
+
|
|
3405
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.CompileTarget>;
|
|
3406
|
+
}
|
|
3407
|
+
export type CompileTarget = CompileTarget.Client | CompileTarget.CoreScript | CompileTarget.Studio | CompileTarget.CoreScriptRaw;
|
|
3408
|
+
|
|
3401
3409
|
export namespace CompletionItemKind {
|
|
3402
3410
|
export interface Text extends globalThis.EnumItem {
|
|
3403
3411
|
Name: "Text";
|
|
@@ -5442,6 +5450,112 @@ declare namespace Enum {
|
|
|
5442
5450
|
}
|
|
5443
5451
|
export type DraftStatusCode = DraftStatusCode.OK | DraftStatusCode.DraftOutdated | DraftStatusCode.ScriptRemoved | DraftStatusCode.DraftCommitted;
|
|
5444
5452
|
|
|
5453
|
+
export namespace DragDetectorDragStyle {
|
|
5454
|
+
export interface TranslateLine extends globalThis.EnumItem {
|
|
5455
|
+
Name: "TranslateLine";
|
|
5456
|
+
Value: 0;
|
|
5457
|
+
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
|
|
5458
|
+
}
|
|
5459
|
+
|
|
5460
|
+
export const TranslateLine: TranslateLine;
|
|
5461
|
+
|
|
5462
|
+
export interface TranslatePlane extends globalThis.EnumItem {
|
|
5463
|
+
Name: "TranslatePlane";
|
|
5464
|
+
Value: 1;
|
|
5465
|
+
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
|
|
5466
|
+
}
|
|
5467
|
+
|
|
5468
|
+
export const TranslatePlane: TranslatePlane;
|
|
5469
|
+
|
|
5470
|
+
export interface TranslatePlaneOrLine extends globalThis.EnumItem {
|
|
5471
|
+
Name: "TranslatePlaneOrLine";
|
|
5472
|
+
Value: 2;
|
|
5473
|
+
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
|
|
5474
|
+
}
|
|
5475
|
+
|
|
5476
|
+
export const TranslatePlaneOrLine: TranslatePlaneOrLine;
|
|
5477
|
+
|
|
5478
|
+
export interface TranslateLineOrPlane extends globalThis.EnumItem {
|
|
5479
|
+
Name: "TranslateLineOrPlane";
|
|
5480
|
+
Value: 3;
|
|
5481
|
+
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
|
|
5482
|
+
}
|
|
5483
|
+
|
|
5484
|
+
export const TranslateLineOrPlane: TranslateLineOrPlane;
|
|
5485
|
+
|
|
5486
|
+
export interface TranslateViewPlane extends globalThis.EnumItem {
|
|
5487
|
+
Name: "TranslateViewPlane";
|
|
5488
|
+
Value: 4;
|
|
5489
|
+
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
|
|
5490
|
+
}
|
|
5491
|
+
|
|
5492
|
+
export const TranslateViewPlane: TranslateViewPlane;
|
|
5493
|
+
|
|
5494
|
+
export interface RotateAxis extends globalThis.EnumItem {
|
|
5495
|
+
Name: "RotateAxis";
|
|
5496
|
+
Value: 5;
|
|
5497
|
+
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
|
|
5498
|
+
}
|
|
5499
|
+
|
|
5500
|
+
export const RotateAxis: RotateAxis;
|
|
5501
|
+
|
|
5502
|
+
export interface RotateTrackball extends globalThis.EnumItem {
|
|
5503
|
+
Name: "RotateTrackball";
|
|
5504
|
+
Value: 6;
|
|
5505
|
+
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
|
|
5506
|
+
}
|
|
5507
|
+
|
|
5508
|
+
export const RotateTrackball: RotateTrackball;
|
|
5509
|
+
|
|
5510
|
+
export interface Scriptable extends globalThis.EnumItem {
|
|
5511
|
+
Name: "Scriptable";
|
|
5512
|
+
Value: 7;
|
|
5513
|
+
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
|
|
5514
|
+
}
|
|
5515
|
+
|
|
5516
|
+
export const Scriptable: Scriptable;
|
|
5517
|
+
|
|
5518
|
+
export interface BestForDevice extends globalThis.EnumItem {
|
|
5519
|
+
Name: "BestForDevice";
|
|
5520
|
+
Value: 8;
|
|
5521
|
+
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
|
|
5522
|
+
}
|
|
5523
|
+
|
|
5524
|
+
export const BestForDevice: BestForDevice;
|
|
5525
|
+
|
|
5526
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DragDetectorDragStyle>;
|
|
5527
|
+
}
|
|
5528
|
+
export type DragDetectorDragStyle = DragDetectorDragStyle.TranslateLine | DragDetectorDragStyle.TranslatePlane | DragDetectorDragStyle.TranslatePlaneOrLine | DragDetectorDragStyle.TranslateLineOrPlane | DragDetectorDragStyle.TranslateViewPlane | DragDetectorDragStyle.RotateAxis | DragDetectorDragStyle.RotateTrackball | DragDetectorDragStyle.Scriptable | DragDetectorDragStyle.BestForDevice;
|
|
5529
|
+
|
|
5530
|
+
export namespace DragDetectorResponseStyle {
|
|
5531
|
+
export interface Geometric extends globalThis.EnumItem {
|
|
5532
|
+
Name: "Geometric";
|
|
5533
|
+
Value: 0;
|
|
5534
|
+
EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
|
|
5535
|
+
}
|
|
5536
|
+
|
|
5537
|
+
export const Geometric: Geometric;
|
|
5538
|
+
|
|
5539
|
+
export interface Physical extends globalThis.EnumItem {
|
|
5540
|
+
Name: "Physical";
|
|
5541
|
+
Value: 1;
|
|
5542
|
+
EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
|
|
5543
|
+
}
|
|
5544
|
+
|
|
5545
|
+
export const Physical: Physical;
|
|
5546
|
+
|
|
5547
|
+
export interface Custom extends globalThis.EnumItem {
|
|
5548
|
+
Name: "Custom";
|
|
5549
|
+
Value: 2;
|
|
5550
|
+
EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
|
|
5551
|
+
}
|
|
5552
|
+
|
|
5553
|
+
export const Custom: Custom;
|
|
5554
|
+
|
|
5555
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DragDetectorResponseStyle>;
|
|
5556
|
+
}
|
|
5557
|
+
export type DragDetectorResponseStyle = DragDetectorResponseStyle.Geometric | DragDetectorResponseStyle.Physical | DragDetectorResponseStyle.Custom;
|
|
5558
|
+
|
|
5445
5559
|
export namespace DraggerCoordinateSpace {
|
|
5446
5560
|
export interface Object extends globalThis.EnumItem {
|
|
5447
5561
|
Name: "Object";
|
|
@@ -17647,9 +17761,17 @@ declare namespace Enum {
|
|
|
17647
17761
|
|
|
17648
17762
|
export const AudioNoPermission: AudioNoPermission;
|
|
17649
17763
|
|
|
17764
|
+
export interface UnsupportedDevice extends globalThis.EnumItem {
|
|
17765
|
+
Name: "UnsupportedDevice";
|
|
17766
|
+
Value: 10;
|
|
17767
|
+
EnumType: typeof globalThis.Enum.TrackerError;
|
|
17768
|
+
}
|
|
17769
|
+
|
|
17770
|
+
export const UnsupportedDevice: UnsupportedDevice;
|
|
17771
|
+
|
|
17650
17772
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.TrackerError>;
|
|
17651
17773
|
}
|
|
17652
|
-
export type TrackerError = TrackerError.Ok | TrackerError.NoService | TrackerError.InitFailed | TrackerError.NoVideo | TrackerError.VideoError | TrackerError.VideoNoPermission | TrackerError.VideoUnsupported | TrackerError.NoAudio | TrackerError.AudioError | TrackerError.AudioNoPermission;
|
|
17774
|
+
export type TrackerError = TrackerError.Ok | TrackerError.NoService | TrackerError.InitFailed | TrackerError.NoVideo | TrackerError.VideoError | TrackerError.VideoNoPermission | TrackerError.VideoUnsupported | TrackerError.NoAudio | TrackerError.AudioError | TrackerError.AudioNoPermission | TrackerError.UnsupportedDevice;
|
|
17653
17775
|
|
|
17654
17776
|
export namespace TrackerExtrapolationFlagMode {
|
|
17655
17777
|
export interface Auto extends globalThis.EnumItem {
|