@rbxts/types 1.0.798 → 1.0.800
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.
|
@@ -113,7 +113,6 @@ interface Services {
|
|
|
113
113
|
PluginPolicyService: PluginPolicyService;
|
|
114
114
|
PolicyService: PolicyService;
|
|
115
115
|
ProcessInstancePhysicsService: ProcessInstancePhysicsService;
|
|
116
|
-
ProjectFolderService: ProjectFolderService;
|
|
117
116
|
ProximityPromptService: ProximityPromptService;
|
|
118
117
|
PublishService: PublishService;
|
|
119
118
|
ReflectionService: ReflectionService;
|
|
@@ -305,6 +304,7 @@ interface CreatableInstances {
|
|
|
305
304
|
Glue: Glue;
|
|
306
305
|
GroundController: GroundController;
|
|
307
306
|
Handles: Handles;
|
|
307
|
+
HapticEffect: HapticEffect;
|
|
308
308
|
Hat: Hat;
|
|
309
309
|
HiddenSurfaceRemovalAsset: HiddenSurfaceRemovalAsset;
|
|
310
310
|
Highlight: Highlight;
|
|
@@ -3195,6 +3195,14 @@ interface AvatarCreationService extends Instance {
|
|
|
3195
3195
|
* Tags: Yields
|
|
3196
3196
|
*/
|
|
3197
3197
|
CreateAvatarGenerationSessionAsync(this: AvatarCreationService, player: Player): AvatarGenerationSession;
|
|
3198
|
+
/**
|
|
3199
|
+
* Tags: Yields
|
|
3200
|
+
*/
|
|
3201
|
+
GenerateAvatarModelAsync(this: AvatarCreationService, player: Player, previewJobId: string, options: object, progressCallback: Callback): string;
|
|
3202
|
+
/**
|
|
3203
|
+
* Tags: Yields
|
|
3204
|
+
*/
|
|
3205
|
+
GenerateAvatarPreviewAsync(this: AvatarCreationService, player: Player, textPrompt: string, options: object, progressCallback: Callback): string;
|
|
3198
3206
|
/**
|
|
3199
3207
|
* Tags: Yields
|
|
3200
3208
|
*/
|
|
@@ -15930,6 +15938,21 @@ interface GuiService extends Instance {
|
|
|
15930
15938
|
readonly MenuOpened: RBXScriptSignal<() => void>;
|
|
15931
15939
|
}
|
|
15932
15940
|
|
|
15941
|
+
interface HapticEffect extends Instance {
|
|
15942
|
+
/**
|
|
15943
|
+
* **DO NOT USE!**
|
|
15944
|
+
*
|
|
15945
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
15946
|
+
* @hidden
|
|
15947
|
+
* @deprecated
|
|
15948
|
+
*/
|
|
15949
|
+
readonly _nominal_HapticEffect: unique symbol;
|
|
15950
|
+
Looped: boolean;
|
|
15951
|
+
Type: Enum.HapticEffectType;
|
|
15952
|
+
Play(this: HapticEffect): void;
|
|
15953
|
+
Stop(this: HapticEffect): void;
|
|
15954
|
+
}
|
|
15955
|
+
|
|
15933
15956
|
/** The _Xbox One_ controller and some other USB gamepad controllers have motors built in to provide haptic feedback. Adding rumbles and vibrations can greatly enhance a game's experience and provide subtle feedback that is hard to convey through visuals or audio. */
|
|
15934
15957
|
interface HapticService extends Instance {
|
|
15935
15958
|
/**
|
|
@@ -26852,7 +26875,7 @@ interface WorldRoot extends Model {
|
|
|
26852
26875
|
direction: Vector3,
|
|
26853
26876
|
raycastParams?: RaycastParams,
|
|
26854
26877
|
): RaycastResult | undefined;
|
|
26855
|
-
Shapecast(this: WorldRoot, part: BasePart, direction: Vector3, params?: RaycastParams): RaycastResult;
|
|
26878
|
+
Shapecast(this: WorldRoot, part: BasePart, direction: Vector3, params?: RaycastParams): RaycastResult | undefined;
|
|
26856
26879
|
Spherecast(
|
|
26857
26880
|
this: WorldRoot,
|
|
26858
26881
|
position: Vector3,
|
|
@@ -30026,17 +30049,6 @@ interface ProcessInstancePhysicsService extends Instance {
|
|
|
30026
30049
|
readonly _nominal_ProcessInstancePhysicsService: unique symbol;
|
|
30027
30050
|
}
|
|
30028
30051
|
|
|
30029
|
-
interface ProjectFolderService extends Instance {
|
|
30030
|
-
/**
|
|
30031
|
-
* **DO NOT USE!**
|
|
30032
|
-
*
|
|
30033
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
30034
|
-
* @hidden
|
|
30035
|
-
* @deprecated
|
|
30036
|
-
*/
|
|
30037
|
-
readonly _nominal_ProjectFolderService: unique symbol;
|
|
30038
|
-
}
|
|
30039
|
-
|
|
30040
30052
|
/** The ProximityPrompt is an object that allows developers to prompt users to interact with an object in the 3D world, such as opening a door or picking up an item.
|
|
30041
30053
|
*
|
|
30042
30054
|
* ProximityPrompts work when parented to a [Part](https://developer.roblox.com/en-us/api-reference/class/Part), [Model](https://developer.roblox.com/en-us/api-reference/class/Model), or [Attachment](https://developer.roblox.com/en-us/api-reference/class/Attachment) in the workspace.
|
|
@@ -38405,6 +38417,7 @@ interface VRService extends Instance {
|
|
|
38405
38417
|
readonly _nominal_VRService: unique symbol;
|
|
38406
38418
|
AutomaticScaling: Enum.VRScaling;
|
|
38407
38419
|
AvatarGestures: boolean;
|
|
38420
|
+
ControllerModels: Enum.VRControllerModelMode;
|
|
38408
38421
|
FadeOutViewOnCollision: boolean;
|
|
38409
38422
|
/**
|
|
38410
38423
|
* The GuiInputUserCFrame property describes what [UserCFrame](https://developer.roblox.com/en-us/api-reference/enum/UserCFrame) is responsible for input in VR. For instance, if a VR headset is responsible, the value of this property will be UserCFrame.Head.
|
|
@@ -38416,6 +38429,7 @@ interface VRService extends Instance {
|
|
|
38416
38429
|
* Tags: NotReplicated
|
|
38417
38430
|
*/
|
|
38418
38431
|
GuiInputUserCFrame: Enum.UserCFrame;
|
|
38432
|
+
LaserPointer: Enum.VRLaserPointerMode;
|
|
38419
38433
|
/**
|
|
38420
38434
|
* Tags: NotReplicated
|
|
38421
38435
|
*/
|
|
@@ -3907,7 +3907,7 @@ interface StudioService extends Instance {
|
|
|
3907
3907
|
* Returns the studio user's userId if they're logged in, otherwise returns 0.
|
|
3908
3908
|
*/
|
|
3909
3909
|
GetUserId(this: StudioService): number;
|
|
3910
|
-
GizmoRaycast(this: StudioService, origin: Vector3, direction: Vector3, raycastParams?: RaycastParams): RaycastResult;
|
|
3910
|
+
GizmoRaycast(this: StudioService, origin: Vector3, direction: Vector3, raycastParams?: RaycastParams): RaycastResult | undefined;
|
|
3911
3911
|
/**
|
|
3912
3912
|
* This function prompts the current Studio user to select one file, which will then be loaded as a [File](https://developer.roblox.com/en-us/api-reference/class/File).
|
|
3913
3913
|
*
|
|
@@ -2637,13 +2637,13 @@ declare namespace Enum {
|
|
|
2637
2637
|
|
|
2638
2638
|
export const None: None;
|
|
2639
2639
|
|
|
2640
|
-
export interface
|
|
2641
|
-
Name: "
|
|
2640
|
+
export interface Unknown extends globalThis.EnumItem {
|
|
2641
|
+
Name: "Unknown";
|
|
2642
2642
|
Value: 1;
|
|
2643
2643
|
EnumType: typeof globalThis.Enum.AvatarGenerationError;
|
|
2644
2644
|
}
|
|
2645
2645
|
|
|
2646
|
-
export const
|
|
2646
|
+
export const Unknown: Unknown;
|
|
2647
2647
|
|
|
2648
2648
|
export interface DownloadFailed extends globalThis.EnumItem {
|
|
2649
2649
|
Name: "DownloadFailed";
|
|
@@ -2669,17 +2669,25 @@ declare namespace Enum {
|
|
|
2669
2669
|
|
|
2670
2670
|
export const Offensive: Offensive;
|
|
2671
2671
|
|
|
2672
|
-
export interface
|
|
2673
|
-
Name: "
|
|
2672
|
+
export interface Timeout extends globalThis.EnumItem {
|
|
2673
|
+
Name: "Timeout";
|
|
2674
2674
|
Value: 5;
|
|
2675
2675
|
EnumType: typeof globalThis.Enum.AvatarGenerationError;
|
|
2676
2676
|
}
|
|
2677
2677
|
|
|
2678
|
-
export const
|
|
2678
|
+
export const Timeout: Timeout;
|
|
2679
|
+
|
|
2680
|
+
export interface JobNotFound extends globalThis.EnumItem {
|
|
2681
|
+
Name: "JobNotFound";
|
|
2682
|
+
Value: 6;
|
|
2683
|
+
EnumType: typeof globalThis.Enum.AvatarGenerationError;
|
|
2684
|
+
}
|
|
2685
|
+
|
|
2686
|
+
export const JobNotFound: JobNotFound;
|
|
2679
2687
|
|
|
2680
2688
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AvatarGenerationError>;
|
|
2681
2689
|
}
|
|
2682
|
-
export type AvatarGenerationError = AvatarGenerationError.None | AvatarGenerationError.
|
|
2690
|
+
export type AvatarGenerationError = AvatarGenerationError.None | AvatarGenerationError.Unknown | AvatarGenerationError.DownloadFailed | AvatarGenerationError.Canceled | AvatarGenerationError.Offensive | AvatarGenerationError.Timeout | AvatarGenerationError.JobNotFound;
|
|
2683
2691
|
|
|
2684
2692
|
export namespace AvatarGenerationJobStatus {
|
|
2685
2693
|
export interface NotStarted extends globalThis.EnumItem {
|
|
@@ -6444,6 +6452,35 @@ declare namespace Enum {
|
|
|
6444
6452
|
}
|
|
6445
6453
|
export type DeviceFeatureType = DeviceFeatureType.DeviceCapture;
|
|
6446
6454
|
|
|
6455
|
+
export namespace DeviceLevel {
|
|
6456
|
+
export interface Low extends globalThis.EnumItem {
|
|
6457
|
+
Name: "Low";
|
|
6458
|
+
Value: 0;
|
|
6459
|
+
EnumType: typeof globalThis.Enum.DeviceLevel;
|
|
6460
|
+
}
|
|
6461
|
+
|
|
6462
|
+
export const Low: Low;
|
|
6463
|
+
|
|
6464
|
+
export interface Medium extends globalThis.EnumItem {
|
|
6465
|
+
Name: "Medium";
|
|
6466
|
+
Value: 1;
|
|
6467
|
+
EnumType: typeof globalThis.Enum.DeviceLevel;
|
|
6468
|
+
}
|
|
6469
|
+
|
|
6470
|
+
export const Medium: Medium;
|
|
6471
|
+
|
|
6472
|
+
export interface High extends globalThis.EnumItem {
|
|
6473
|
+
Name: "High";
|
|
6474
|
+
Value: 2;
|
|
6475
|
+
EnumType: typeof globalThis.Enum.DeviceLevel;
|
|
6476
|
+
}
|
|
6477
|
+
|
|
6478
|
+
export const High: High;
|
|
6479
|
+
|
|
6480
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DeviceLevel>;
|
|
6481
|
+
}
|
|
6482
|
+
export type DeviceLevel = DeviceLevel.Low | DeviceLevel.Medium | DeviceLevel.High;
|
|
6483
|
+
|
|
6447
6484
|
export namespace DeviceType {
|
|
6448
6485
|
export interface Unknown extends globalThis.EnumItem {
|
|
6449
6486
|
Name: "Unknown";
|
|
@@ -8635,6 +8672,51 @@ declare namespace Enum {
|
|
|
8635
8672
|
}
|
|
8636
8673
|
export type HandlesStyle = HandlesStyle.Resize | HandlesStyle.Movement;
|
|
8637
8674
|
|
|
8675
|
+
export namespace HapticEffectType {
|
|
8676
|
+
export interface UIHover extends globalThis.EnumItem {
|
|
8677
|
+
Name: "UIHover";
|
|
8678
|
+
Value: 0;
|
|
8679
|
+
EnumType: typeof globalThis.Enum.HapticEffectType;
|
|
8680
|
+
}
|
|
8681
|
+
|
|
8682
|
+
export const UIHover: UIHover;
|
|
8683
|
+
|
|
8684
|
+
export interface UIClick extends globalThis.EnumItem {
|
|
8685
|
+
Name: "UIClick";
|
|
8686
|
+
Value: 1;
|
|
8687
|
+
EnumType: typeof globalThis.Enum.HapticEffectType;
|
|
8688
|
+
}
|
|
8689
|
+
|
|
8690
|
+
export const UIClick: UIClick;
|
|
8691
|
+
|
|
8692
|
+
export interface UINotification extends globalThis.EnumItem {
|
|
8693
|
+
Name: "UINotification";
|
|
8694
|
+
Value: 2;
|
|
8695
|
+
EnumType: typeof globalThis.Enum.HapticEffectType;
|
|
8696
|
+
}
|
|
8697
|
+
|
|
8698
|
+
export const UINotification: UINotification;
|
|
8699
|
+
|
|
8700
|
+
export interface GameplayExplosion extends globalThis.EnumItem {
|
|
8701
|
+
Name: "GameplayExplosion";
|
|
8702
|
+
Value: 3;
|
|
8703
|
+
EnumType: typeof globalThis.Enum.HapticEffectType;
|
|
8704
|
+
}
|
|
8705
|
+
|
|
8706
|
+
export const GameplayExplosion: GameplayExplosion;
|
|
8707
|
+
|
|
8708
|
+
export interface GameplayCollision extends globalThis.EnumItem {
|
|
8709
|
+
Name: "GameplayCollision";
|
|
8710
|
+
Value: 4;
|
|
8711
|
+
EnumType: typeof globalThis.Enum.HapticEffectType;
|
|
8712
|
+
}
|
|
8713
|
+
|
|
8714
|
+
export const GameplayCollision: GameplayCollision;
|
|
8715
|
+
|
|
8716
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.HapticEffectType>;
|
|
8717
|
+
}
|
|
8718
|
+
export type HapticEffectType = HapticEffectType.UIHover | HapticEffectType.UIClick | HapticEffectType.UINotification | HapticEffectType.GameplayExplosion | HapticEffectType.GameplayCollision;
|
|
8719
|
+
|
|
8638
8720
|
export namespace HighlightDepthMode {
|
|
8639
8721
|
export interface AlwaysOnTop extends globalThis.EnumItem {
|
|
8640
8722
|
Name: "AlwaysOnTop";
|
|
@@ -14484,9 +14566,17 @@ declare namespace Enum {
|
|
|
14484
14566
|
|
|
14485
14567
|
export const PS5: PS5;
|
|
14486
14568
|
|
|
14569
|
+
export interface MetaOS extends globalThis.EnumItem {
|
|
14570
|
+
Name: "MetaOS";
|
|
14571
|
+
Value: 20;
|
|
14572
|
+
EnumType: typeof globalThis.Enum.Platform;
|
|
14573
|
+
}
|
|
14574
|
+
|
|
14575
|
+
export const MetaOS: MetaOS;
|
|
14576
|
+
|
|
14487
14577
|
export interface None extends globalThis.EnumItem {
|
|
14488
14578
|
Name: "None";
|
|
14489
|
-
Value:
|
|
14579
|
+
Value: 21;
|
|
14490
14580
|
EnumType: typeof globalThis.Enum.Platform;
|
|
14491
14581
|
}
|
|
14492
14582
|
|
|
@@ -14494,7 +14584,7 @@ declare namespace Enum {
|
|
|
14494
14584
|
|
|
14495
14585
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.Platform>;
|
|
14496
14586
|
}
|
|
14497
|
-
export type Platform = Platform.Windows | Platform.OSX | Platform.IOS | Platform.Android | Platform.XBoxOne | Platform.PS4 | Platform.PS3 | Platform.XBox360 | Platform.WiiU | Platform.NX | Platform.Ouya | Platform.AndroidTV | Platform.Chromecast | Platform.Linux | Platform.SteamOS | Platform.WebOS | Platform.DOS | Platform.BeOS | Platform.UWP | Platform.PS5 | Platform.None;
|
|
14587
|
+
export type Platform = Platform.Windows | Platform.OSX | Platform.IOS | Platform.Android | Platform.XBoxOne | Platform.PS4 | Platform.PS3 | Platform.XBox360 | Platform.WiiU | Platform.NX | Platform.Ouya | Platform.AndroidTV | Platform.Chromecast | Platform.Linux | Platform.SteamOS | Platform.WebOS | Platform.DOS | Platform.BeOS | Platform.UWP | Platform.PS5 | Platform.MetaOS | Platform.None;
|
|
14498
14588
|
|
|
14499
14589
|
export namespace PlaybackState {
|
|
14500
14590
|
export interface Begin extends globalThis.EnumItem {
|
|
@@ -21711,6 +21801,101 @@ declare namespace Enum {
|
|
|
21711
21801
|
}
|
|
21712
21802
|
export type VRComfortSetting = VRComfortSetting.Comfort | VRComfortSetting.Normal | VRComfortSetting.Expert | VRComfortSetting.Custom;
|
|
21713
21803
|
|
|
21804
|
+
export namespace VRControllerModelMode {
|
|
21805
|
+
export interface Disabled extends globalThis.EnumItem {
|
|
21806
|
+
Name: "Disabled";
|
|
21807
|
+
Value: 0;
|
|
21808
|
+
EnumType: typeof globalThis.Enum.VRControllerModelMode;
|
|
21809
|
+
}
|
|
21810
|
+
|
|
21811
|
+
export const Disabled: Disabled;
|
|
21812
|
+
|
|
21813
|
+
export interface Transparent extends globalThis.EnumItem {
|
|
21814
|
+
Name: "Transparent";
|
|
21815
|
+
Value: 1;
|
|
21816
|
+
EnumType: typeof globalThis.Enum.VRControllerModelMode;
|
|
21817
|
+
}
|
|
21818
|
+
|
|
21819
|
+
export const Transparent: Transparent;
|
|
21820
|
+
|
|
21821
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.VRControllerModelMode>;
|
|
21822
|
+
}
|
|
21823
|
+
export type VRControllerModelMode = VRControllerModelMode.Disabled | VRControllerModelMode.Transparent;
|
|
21824
|
+
|
|
21825
|
+
export namespace VRDeviceType {
|
|
21826
|
+
export interface Unknown extends globalThis.EnumItem {
|
|
21827
|
+
Name: "Unknown";
|
|
21828
|
+
Value: 0;
|
|
21829
|
+
EnumType: typeof globalThis.Enum.VRDeviceType;
|
|
21830
|
+
}
|
|
21831
|
+
|
|
21832
|
+
export const Unknown: Unknown;
|
|
21833
|
+
|
|
21834
|
+
export interface OculusRift extends globalThis.EnumItem {
|
|
21835
|
+
Name: "OculusRift";
|
|
21836
|
+
Value: 1;
|
|
21837
|
+
EnumType: typeof globalThis.Enum.VRDeviceType;
|
|
21838
|
+
}
|
|
21839
|
+
|
|
21840
|
+
export const OculusRift: OculusRift;
|
|
21841
|
+
|
|
21842
|
+
export interface HTCVive extends globalThis.EnumItem {
|
|
21843
|
+
Name: "HTCVive";
|
|
21844
|
+
Value: 2;
|
|
21845
|
+
EnumType: typeof globalThis.Enum.VRDeviceType;
|
|
21846
|
+
}
|
|
21847
|
+
|
|
21848
|
+
export const HTCVive: HTCVive;
|
|
21849
|
+
|
|
21850
|
+
export interface ValveIndex extends globalThis.EnumItem {
|
|
21851
|
+
Name: "ValveIndex";
|
|
21852
|
+
Value: 3;
|
|
21853
|
+
EnumType: typeof globalThis.Enum.VRDeviceType;
|
|
21854
|
+
}
|
|
21855
|
+
|
|
21856
|
+
export const ValveIndex: ValveIndex;
|
|
21857
|
+
|
|
21858
|
+
export interface OculusQuest extends globalThis.EnumItem {
|
|
21859
|
+
Name: "OculusQuest";
|
|
21860
|
+
Value: 4;
|
|
21861
|
+
EnumType: typeof globalThis.Enum.VRDeviceType;
|
|
21862
|
+
}
|
|
21863
|
+
|
|
21864
|
+
export const OculusQuest: OculusQuest;
|
|
21865
|
+
|
|
21866
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.VRDeviceType>;
|
|
21867
|
+
}
|
|
21868
|
+
export type VRDeviceType = VRDeviceType.Unknown | VRDeviceType.OculusRift | VRDeviceType.HTCVive | VRDeviceType.ValveIndex | VRDeviceType.OculusQuest;
|
|
21869
|
+
|
|
21870
|
+
export namespace VRLaserPointerMode {
|
|
21871
|
+
export interface Disabled extends globalThis.EnumItem {
|
|
21872
|
+
Name: "Disabled";
|
|
21873
|
+
Value: 0;
|
|
21874
|
+
EnumType: typeof globalThis.Enum.VRLaserPointerMode;
|
|
21875
|
+
}
|
|
21876
|
+
|
|
21877
|
+
export const Disabled: Disabled;
|
|
21878
|
+
|
|
21879
|
+
export interface Pointer extends globalThis.EnumItem {
|
|
21880
|
+
Name: "Pointer";
|
|
21881
|
+
Value: 1;
|
|
21882
|
+
EnumType: typeof globalThis.Enum.VRLaserPointerMode;
|
|
21883
|
+
}
|
|
21884
|
+
|
|
21885
|
+
export const Pointer: Pointer;
|
|
21886
|
+
|
|
21887
|
+
export interface DualPointer extends globalThis.EnumItem {
|
|
21888
|
+
Name: "DualPointer";
|
|
21889
|
+
Value: 2;
|
|
21890
|
+
EnumType: typeof globalThis.Enum.VRLaserPointerMode;
|
|
21891
|
+
}
|
|
21892
|
+
|
|
21893
|
+
export const DualPointer: DualPointer;
|
|
21894
|
+
|
|
21895
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.VRLaserPointerMode>;
|
|
21896
|
+
}
|
|
21897
|
+
export type VRLaserPointerMode = VRLaserPointerMode.Disabled | VRLaserPointerMode.Pointer | VRLaserPointerMode.DualPointer;
|
|
21898
|
+
|
|
21714
21899
|
export namespace VRSafetyBubbleMode {
|
|
21715
21900
|
export interface NoOne extends globalThis.EnumItem {
|
|
21716
21901
|
Name: "NoOne";
|