@rbxts/types 1.0.685 → 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;
|
|
@@ -322,6 +323,10 @@ interface CreatableInstances {
|
|
|
322
323
|
SpringConstraint: SpringConstraint;
|
|
323
324
|
StarterGear: StarterGear;
|
|
324
325
|
StringValue: StringValue;
|
|
326
|
+
StyleDerive: StyleDerive;
|
|
327
|
+
StyleLink: StyleLink;
|
|
328
|
+
StyleRule: StyleRule;
|
|
329
|
+
StyleSheet: StyleSheet;
|
|
325
330
|
SunRaysEffect: SunRaysEffect;
|
|
326
331
|
SurfaceAppearance: SurfaceAppearance;
|
|
327
332
|
SurfaceGui: SurfaceGui;
|
|
@@ -512,6 +517,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
|
|
|
512
517
|
StandardPages: StandardPages;
|
|
513
518
|
StarterCharacterScripts: StarterCharacterScripts;
|
|
514
519
|
StarterPlayerScripts: StarterPlayerScripts;
|
|
520
|
+
StyleBase: StyleBase;
|
|
515
521
|
SurfaceGuiBase: SurfaceGuiBase;
|
|
516
522
|
SyncScriptBuilder: SyncScriptBuilder;
|
|
517
523
|
TeleportAsyncResult: TeleportAsyncResult;
|
|
@@ -1244,11 +1250,6 @@ interface AdPortal extends Instance {
|
|
|
1244
1250
|
* @deprecated
|
|
1245
1251
|
*/
|
|
1246
1252
|
readonly _nominal_AdPortal: unique symbol;
|
|
1247
|
-
/**
|
|
1248
|
-
* Tags: ReadOnly, NotReplicated, Deprecated
|
|
1249
|
-
* @deprecated
|
|
1250
|
-
*/
|
|
1251
|
-
readonly PortalStatus: Enum.AdPortalStatus;
|
|
1252
1253
|
/**
|
|
1253
1254
|
* Tags: ReadOnly, NotReplicated
|
|
1254
1255
|
*/
|
|
@@ -5432,17 +5433,6 @@ interface BulkImportService extends Instance {
|
|
|
5432
5433
|
readonly _nominal_BulkImportService: unique symbol;
|
|
5433
5434
|
}
|
|
5434
5435
|
|
|
5435
|
-
interface CSGOptions extends Instance {
|
|
5436
|
-
/**
|
|
5437
|
-
* **DO NOT USE!**
|
|
5438
|
-
*
|
|
5439
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
5440
|
-
* @hidden
|
|
5441
|
-
* @deprecated
|
|
5442
|
-
*/
|
|
5443
|
-
readonly _nominal_CSGOptions: unique symbol;
|
|
5444
|
-
}
|
|
5445
|
-
|
|
5446
5436
|
interface CalloutService extends Instance {
|
|
5447
5437
|
/**
|
|
5448
5438
|
* **DO NOT USE!**
|
|
@@ -5714,6 +5704,7 @@ interface Camera extends Instance {
|
|
|
5714
5704
|
* Tags: ReadOnly, NotReplicated
|
|
5715
5705
|
*/
|
|
5716
5706
|
readonly NearPlaneZ: number;
|
|
5707
|
+
VRTiltAndRollEnabled: boolean;
|
|
5717
5708
|
/**
|
|
5718
5709
|
* ViewportSize describes the dimensions, in pixels, of the client's viewport.
|
|
5719
5710
|
*
|
|
@@ -24348,6 +24339,7 @@ interface VehicleSeat extends BasePart {
|
|
|
24348
24339
|
readonly Occupant: Humanoid | undefined;
|
|
24349
24340
|
/**
|
|
24350
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
|
|
24351
24343
|
*/
|
|
24352
24344
|
Steer: number;
|
|
24353
24345
|
/**
|
|
@@ -24356,6 +24348,7 @@ interface VehicleSeat extends BasePart {
|
|
|
24356
24348
|
SteerFloat: number;
|
|
24357
24349
|
/**
|
|
24358
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
|
|
24359
24352
|
*/
|
|
24360
24353
|
Throttle: number;
|
|
24361
24354
|
/**
|
|
@@ -29119,6 +29112,17 @@ interface ScriptCloneWatcherHelper extends Instance {
|
|
|
29119
29112
|
readonly _nominal_ScriptCloneWatcherHelper: unique symbol;
|
|
29120
29113
|
}
|
|
29121
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
|
+
|
|
29122
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. */
|
|
29123
29127
|
interface ScriptContext extends Instance {
|
|
29124
29128
|
/**
|
|
@@ -29899,6 +29903,7 @@ interface SocialService extends Instance {
|
|
|
29899
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.\`
|
|
29900
29904
|
*/
|
|
29901
29905
|
PromptGameInvite(this: SocialService, player: Player, experienceInviteOptions?: ExperienceInviteOptions): void;
|
|
29906
|
+
PromptIrisInvite(this: SocialService, player: Player, tag: string): void;
|
|
29902
29907
|
/**
|
|
29903
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.
|
|
29904
29909
|
*
|
|
@@ -29906,6 +29911,10 @@ interface SocialService extends Instance {
|
|
|
29906
29911
|
* Tags: Yields
|
|
29907
29912
|
*/
|
|
29908
29913
|
CanSendGameInviteAsync(this: SocialService, player: Player, recipientId?: number): boolean;
|
|
29914
|
+
/**
|
|
29915
|
+
* Tags: Yields
|
|
29916
|
+
*/
|
|
29917
|
+
CanSendIrisInviteAsync(this: SocialService, player: Player): boolean;
|
|
29909
29918
|
/**
|
|
29910
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.
|
|
29911
29920
|
*
|
|
@@ -29931,6 +29940,8 @@ interface SocialService extends Instance {
|
|
|
29931
29940
|
* * [SocialService:CanSendGameInviteAsync](https://developer.roblox.com/en-us/api-reference/function/SocialService/CanSendGameInviteAsync), returns true or false depending on the user
|
|
29932
29941
|
*/
|
|
29933
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;
|
|
29934
29945
|
}
|
|
29935
29946
|
|
|
29936
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.
|
|
@@ -31535,6 +31546,77 @@ interface StudioSdkService extends Instance {
|
|
|
31535
31546
|
readonly _nominal_StudioSdkService: unique symbol;
|
|
31536
31547
|
}
|
|
31537
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
|
+
|
|
31538
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.
|
|
31539
31621
|
*
|
|
31540
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).
|
|
@@ -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";
|
|
@@ -17790,9 +17761,17 @@ declare namespace Enum {
|
|
|
17790
17761
|
|
|
17791
17762
|
export const AudioNoPermission: AudioNoPermission;
|
|
17792
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
|
+
|
|
17793
17772
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.TrackerError>;
|
|
17794
17773
|
}
|
|
17795
|
-
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;
|
|
17796
17775
|
|
|
17797
17776
|
export namespace TrackerExtrapolationFlagMode {
|
|
17798
17777
|
export interface Auto extends globalThis.EnumItem {
|