@rbxts/types 1.0.840 → 1.0.842
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 +406 -86
- package/include/generated/PluginSecurity.d.ts +70 -4
- package/include/generated/enums.d.ts +241 -45
- package/package.json +1 -1
|
@@ -103,6 +103,7 @@ interface Services {
|
|
|
103
103
|
LSPFileSyncService: LSPFileSyncService;
|
|
104
104
|
LuauScriptAnalyzerService: LuauScriptAnalyzerService;
|
|
105
105
|
MarketplaceService: MarketplaceService;
|
|
106
|
+
MatchmakingService: MatchmakingService;
|
|
106
107
|
MaterialGenerationService: MaterialGenerationService;
|
|
107
108
|
MaterialService: MaterialService;
|
|
108
109
|
MemoryStoreService: MemoryStoreService;
|
|
@@ -223,6 +224,7 @@ interface Services {
|
|
|
223
224
|
VoiceChatService: VoiceChatService;
|
|
224
225
|
VRService: VRService;
|
|
225
226
|
VRStatusService: VRStatusService;
|
|
227
|
+
WebSocketService: WebSocketService;
|
|
226
228
|
WebViewService: WebViewService;
|
|
227
229
|
Workspace: Workspace;
|
|
228
230
|
}
|
|
@@ -267,6 +269,7 @@ interface CreatableInstances {
|
|
|
267
269
|
AudioPlayer: AudioPlayer;
|
|
268
270
|
AudioReverb: AudioReverb;
|
|
269
271
|
AudioSearchParams: AudioSearchParams;
|
|
272
|
+
AudioTextToSpeech: AudioTextToSpeech;
|
|
270
273
|
AuroraScript: AuroraScript;
|
|
271
274
|
Backpack: Backpack;
|
|
272
275
|
BallSocketConstraint: BallSocketConstraint;
|
|
@@ -714,6 +717,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
714
717
|
UserGameSettings: UserGameSettings;
|
|
715
718
|
UserSettings: UserSettings;
|
|
716
719
|
ValueBase: ValueBase;
|
|
720
|
+
WebSocketClient: WebSocketClient;
|
|
717
721
|
WorldRoot: WorldRoot;
|
|
718
722
|
}
|
|
719
723
|
interface Objects extends Instances {
|
|
@@ -806,7 +810,7 @@ interface EditableMesh extends RBXObject {
|
|
|
806
810
|
readonly _nominal_EditableMesh: unique symbol;
|
|
807
811
|
}
|
|
808
812
|
/**
|
|
809
|
-
* Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
813
|
+
* `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
810
814
|
*
|
|
811
815
|
* - **Tags**: NotCreatable, NotBrowsable
|
|
812
816
|
*
|
|
@@ -837,7 +841,7 @@ interface Instance extends RBXObject {
|
|
|
837
841
|
* - **Tags**: NotBrowsable
|
|
838
842
|
*
|
|
839
843
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetDebugId)
|
|
840
|
-
* @param this Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
844
|
+
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
841
845
|
* @param scopeLength The scope length.
|
|
842
846
|
* @returns The Debug ID string.
|
|
843
847
|
*/
|
|
@@ -1760,6 +1764,21 @@ interface AudioSearchParams extends Instance {
|
|
|
1760
1764
|
*/
|
|
1761
1765
|
readonly _nominal_AudioSearchParams: unique symbol;
|
|
1762
1766
|
}
|
|
1767
|
+
/**
|
|
1768
|
+
* - **Tags**: NotBrowsable
|
|
1769
|
+
*
|
|
1770
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
|
|
1771
|
+
*/
|
|
1772
|
+
interface AudioTextToSpeech extends Instance {
|
|
1773
|
+
/**
|
|
1774
|
+
* **DO NOT USE!**
|
|
1775
|
+
*
|
|
1776
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1777
|
+
* @hidden
|
|
1778
|
+
* @deprecated
|
|
1779
|
+
*/
|
|
1780
|
+
readonly _nominal_AudioTextToSpeech: unique symbol;
|
|
1781
|
+
}
|
|
1763
1782
|
/**
|
|
1764
1783
|
* - **Tags**: NotCreatable, Service
|
|
1765
1784
|
*
|
|
@@ -2169,7 +2188,6 @@ interface BaseWrap extends Instance {
|
|
|
2169
2188
|
readonly _nominal_BaseWrap: unique symbol;
|
|
2170
2189
|
/**
|
|
2171
2190
|
* - **ThreadSafety**: ReadSafe
|
|
2172
|
-
* - **Tags**: Hidden
|
|
2173
2191
|
*
|
|
2174
2192
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseWrap#CageMeshContent)
|
|
2175
2193
|
*/
|
|
@@ -2238,7 +2256,6 @@ interface WrapLayer extends BaseWrap {
|
|
|
2238
2256
|
set BindOffset(value: CFrame);
|
|
2239
2257
|
/**
|
|
2240
2258
|
* - **ThreadSafety**: ReadSafe
|
|
2241
|
-
* - **Tags**: Hidden
|
|
2242
2259
|
*
|
|
2243
2260
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ReferenceMeshContent)
|
|
2244
2261
|
*/
|
|
@@ -6288,6 +6305,8 @@ interface GuiService extends Instance {
|
|
|
6288
6305
|
readonly _nominal_GuiService: unique symbol;
|
|
6289
6306
|
}
|
|
6290
6307
|
/**
|
|
6308
|
+
* - **Tags**: NotBrowsable
|
|
6309
|
+
*
|
|
6291
6310
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect)
|
|
6292
6311
|
*/
|
|
6293
6312
|
interface HapticEffect extends Instance {
|
|
@@ -7515,6 +7534,21 @@ interface MarketplaceService extends Instance {
|
|
|
7515
7534
|
*/
|
|
7516
7535
|
readonly _nominal_MarketplaceService: unique symbol;
|
|
7517
7536
|
}
|
|
7537
|
+
/**
|
|
7538
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
7539
|
+
*
|
|
7540
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService)
|
|
7541
|
+
*/
|
|
7542
|
+
interface MatchmakingService extends Instance {
|
|
7543
|
+
/**
|
|
7544
|
+
* **DO NOT USE!**
|
|
7545
|
+
*
|
|
7546
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
7547
|
+
* @hidden
|
|
7548
|
+
* @deprecated
|
|
7549
|
+
*/
|
|
7550
|
+
readonly _nominal_MatchmakingService: unique symbol;
|
|
7551
|
+
}
|
|
7518
7552
|
/**
|
|
7519
7553
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
7520
7554
|
*
|
|
@@ -11931,6 +11965,8 @@ interface SoundService extends Instance {
|
|
|
11931
11965
|
*/
|
|
11932
11966
|
set CharacterSoundsUseNewApi(value: Enum.RolloutState);
|
|
11933
11967
|
/**
|
|
11968
|
+
* Determines where (if anywhere) to place an `AudioListener` by default.
|
|
11969
|
+
*
|
|
11934
11970
|
* - **ThreadSafety**: ReadSafe
|
|
11935
11971
|
*
|
|
11936
11972
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#DefaultListenerLocation)
|
|
@@ -14350,6 +14386,36 @@ interface VoiceChatService extends Instance {
|
|
|
14350
14386
|
*/
|
|
14351
14387
|
UseAudioApi: Enum.AudioApiRollout;
|
|
14352
14388
|
}
|
|
14389
|
+
/**
|
|
14390
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
14391
|
+
*
|
|
14392
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient)
|
|
14393
|
+
*/
|
|
14394
|
+
interface WebSocketClient extends Instance {
|
|
14395
|
+
/**
|
|
14396
|
+
* **DO NOT USE!**
|
|
14397
|
+
*
|
|
14398
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
14399
|
+
* @hidden
|
|
14400
|
+
* @deprecated
|
|
14401
|
+
*/
|
|
14402
|
+
readonly _nominal_WebSocketClient: unique symbol;
|
|
14403
|
+
}
|
|
14404
|
+
/**
|
|
14405
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
14406
|
+
*
|
|
14407
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketService)
|
|
14408
|
+
*/
|
|
14409
|
+
interface WebSocketService extends Instance {
|
|
14410
|
+
/**
|
|
14411
|
+
* **DO NOT USE!**
|
|
14412
|
+
*
|
|
14413
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
14414
|
+
* @hidden
|
|
14415
|
+
* @deprecated
|
|
14416
|
+
*/
|
|
14417
|
+
readonly _nominal_WebSocketService: unique symbol;
|
|
14418
|
+
}
|
|
14353
14419
|
/**
|
|
14354
14420
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
14355
14421
|
*
|
|
@@ -981,11 +981,20 @@ declare namespace Enum {
|
|
|
981
981
|
EnumType: typeof globalThis.Enum.AlphaMode;
|
|
982
982
|
}
|
|
983
983
|
export const Transparency: Transparency;
|
|
984
|
+
/**
|
|
985
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlphaMode#TintMask)
|
|
986
|
+
*/
|
|
987
|
+
export interface TintMask extends globalThis.EnumItem {
|
|
988
|
+
Name: "TintMask";
|
|
989
|
+
Value: 2;
|
|
990
|
+
EnumType: typeof globalThis.Enum.AlphaMode;
|
|
991
|
+
}
|
|
992
|
+
export const TintMask: TintMask;
|
|
984
993
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AlphaMode>;
|
|
985
994
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AlphaMode | undefined;
|
|
986
995
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AlphaMode | undefined;
|
|
987
996
|
}
|
|
988
|
-
export type AlphaMode = AlphaMode.Overlay | AlphaMode.Transparency;
|
|
997
|
+
export type AlphaMode = AlphaMode.Overlay | AlphaMode.Transparency | AlphaMode.TintMask;
|
|
989
998
|
/**
|
|
990
999
|
* Used to form a dictionary of custom fields to provide breakdowns in Roblox-provided charts.
|
|
991
1000
|
*
|
|
@@ -1672,11 +1681,20 @@ declare namespace Enum {
|
|
|
1672
1681
|
EnumType: typeof globalThis.Enum.AnnotationRequestResult;
|
|
1673
1682
|
}
|
|
1674
1683
|
export const ErrorNotFound: ErrorNotFound;
|
|
1684
|
+
/**
|
|
1685
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestResult#ErrorModerated)
|
|
1686
|
+
*/
|
|
1687
|
+
export interface ErrorModerated extends globalThis.EnumItem {
|
|
1688
|
+
Name: "ErrorModerated";
|
|
1689
|
+
Value: 3;
|
|
1690
|
+
EnumType: typeof globalThis.Enum.AnnotationRequestResult;
|
|
1691
|
+
}
|
|
1692
|
+
export const ErrorModerated: ErrorModerated;
|
|
1675
1693
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AnnotationRequestResult>;
|
|
1676
1694
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnnotationRequestResult | undefined;
|
|
1677
1695
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnnotationRequestResult | undefined;
|
|
1678
1696
|
}
|
|
1679
|
-
export type AnnotationRequestResult = AnnotationRequestResult.Success | AnnotationRequestResult.ErrorInternalFailure | AnnotationRequestResult.ErrorNotFound;
|
|
1697
|
+
export type AnnotationRequestResult = AnnotationRequestResult.Success | AnnotationRequestResult.ErrorInternalFailure | AnnotationRequestResult.ErrorNotFound | AnnotationRequestResult.ErrorModerated;
|
|
1680
1698
|
/**
|
|
1681
1699
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType)
|
|
1682
1700
|
*/
|
|
@@ -5112,42 +5130,6 @@ declare namespace Enum {
|
|
|
5112
5130
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CameraType | undefined;
|
|
5113
5131
|
}
|
|
5114
5132
|
export type CameraType = CameraType.Fixed | CameraType.Attach | CameraType.Watch | CameraType.Track | CameraType.Follow | CameraType.Custom | CameraType.Scriptable | CameraType.Orbital;
|
|
5115
|
-
/**
|
|
5116
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureUIHideMode)
|
|
5117
|
-
*/
|
|
5118
|
-
export namespace CaptureUIHideMode {
|
|
5119
|
-
/**
|
|
5120
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureUIHideMode#All)
|
|
5121
|
-
*/
|
|
5122
|
-
export interface All extends globalThis.EnumItem {
|
|
5123
|
-
Name: "All";
|
|
5124
|
-
Value: 0;
|
|
5125
|
-
EnumType: typeof globalThis.Enum.CaptureUIHideMode;
|
|
5126
|
-
}
|
|
5127
|
-
export const All: All;
|
|
5128
|
-
/**
|
|
5129
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureUIHideMode#None)
|
|
5130
|
-
*/
|
|
5131
|
-
export interface None extends globalThis.EnumItem {
|
|
5132
|
-
Name: "None";
|
|
5133
|
-
Value: 1;
|
|
5134
|
-
EnumType: typeof globalThis.Enum.CaptureUIHideMode;
|
|
5135
|
-
}
|
|
5136
|
-
export const None: None;
|
|
5137
|
-
/**
|
|
5138
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureUIHideMode#Core)
|
|
5139
|
-
*/
|
|
5140
|
-
export interface Core extends globalThis.EnumItem {
|
|
5141
|
-
Name: "Core";
|
|
5142
|
-
Value: 2;
|
|
5143
|
-
EnumType: typeof globalThis.Enum.CaptureUIHideMode;
|
|
5144
|
-
}
|
|
5145
|
-
export const Core: Core;
|
|
5146
|
-
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.CaptureUIHideMode>;
|
|
5147
|
-
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CaptureUIHideMode | undefined;
|
|
5148
|
-
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CaptureUIHideMode | undefined;
|
|
5149
|
-
}
|
|
5150
|
-
export type CaptureUIHideMode = CaptureUIHideMode.All | CaptureUIHideMode.None | CaptureUIHideMode.Core;
|
|
5151
5133
|
/**
|
|
5152
5134
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter)
|
|
5153
5135
|
*/
|
|
@@ -17102,6 +17084,8 @@ declare namespace Enum {
|
|
|
17102
17084
|
}
|
|
17103
17085
|
export const Thumbstick2: Thumbstick2;
|
|
17104
17086
|
/**
|
|
17087
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17088
|
+
*
|
|
17105
17089
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseLeftButton)
|
|
17106
17090
|
*/
|
|
17107
17091
|
export interface MouseLeftButton extends globalThis.EnumItem {
|
|
@@ -17111,6 +17095,8 @@ declare namespace Enum {
|
|
|
17111
17095
|
}
|
|
17112
17096
|
export const MouseLeftButton: MouseLeftButton;
|
|
17113
17097
|
/**
|
|
17098
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17099
|
+
*
|
|
17114
17100
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseRightButton)
|
|
17115
17101
|
*/
|
|
17116
17102
|
export interface MouseRightButton extends globalThis.EnumItem {
|
|
@@ -17120,6 +17106,8 @@ declare namespace Enum {
|
|
|
17120
17106
|
}
|
|
17121
17107
|
export const MouseRightButton: MouseRightButton;
|
|
17122
17108
|
/**
|
|
17109
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17110
|
+
*
|
|
17123
17111
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseMiddleButton)
|
|
17124
17112
|
*/
|
|
17125
17113
|
export interface MouseMiddleButton extends globalThis.EnumItem {
|
|
@@ -17129,6 +17117,8 @@ declare namespace Enum {
|
|
|
17129
17117
|
}
|
|
17130
17118
|
export const MouseMiddleButton: MouseMiddleButton;
|
|
17131
17119
|
/**
|
|
17120
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17121
|
+
*
|
|
17132
17122
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseBackButton)
|
|
17133
17123
|
*/
|
|
17134
17124
|
export interface MouseBackButton extends globalThis.EnumItem {
|
|
@@ -17138,6 +17128,8 @@ declare namespace Enum {
|
|
|
17138
17128
|
}
|
|
17139
17129
|
export const MouseBackButton: MouseBackButton;
|
|
17140
17130
|
/**
|
|
17131
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17132
|
+
*
|
|
17141
17133
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseNoButton)
|
|
17142
17134
|
*/
|
|
17143
17135
|
export interface MouseNoButton extends globalThis.EnumItem {
|
|
@@ -17147,6 +17139,8 @@ declare namespace Enum {
|
|
|
17147
17139
|
}
|
|
17148
17140
|
export const MouseNoButton: MouseNoButton;
|
|
17149
17141
|
/**
|
|
17142
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17143
|
+
*
|
|
17150
17144
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseX)
|
|
17151
17145
|
*/
|
|
17152
17146
|
export interface MouseX extends globalThis.EnumItem {
|
|
@@ -17156,6 +17150,8 @@ declare namespace Enum {
|
|
|
17156
17150
|
}
|
|
17157
17151
|
export const MouseX: MouseX;
|
|
17158
17152
|
/**
|
|
17153
|
+
* **Deprecated:** This enum is deprecated and flagged for removal.
|
|
17154
|
+
*
|
|
17159
17155
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseY)
|
|
17160
17156
|
*/
|
|
17161
17157
|
export interface MouseY extends globalThis.EnumItem {
|
|
@@ -17681,11 +17677,13 @@ declare namespace Enum {
|
|
|
17681
17677
|
}
|
|
17682
17678
|
export type ListDisplayMode = ListDisplayMode.Horizontal | ListDisplayMode.Vertical;
|
|
17683
17679
|
/**
|
|
17680
|
+
* Enum used with `SoundService.DefaultListenerLocation` to determine where an `AudioListener` is placed by default.
|
|
17681
|
+
*
|
|
17684
17682
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerLocation)
|
|
17685
17683
|
*/
|
|
17686
17684
|
export namespace ListenerLocation {
|
|
17687
17685
|
/**
|
|
17688
|
-
*
|
|
17686
|
+
* Behavior depends on the value of `VoiceChatService.EnableDefaultVoice` and `VoiceChatService.UseAudioApi`. When using the default voice setup with the audio API, this behaves similarly to `Camera`.
|
|
17689
17687
|
*
|
|
17690
17688
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#Default)
|
|
17691
17689
|
*/
|
|
@@ -17696,7 +17694,7 @@ declare namespace Enum {
|
|
|
17696
17694
|
}
|
|
17697
17695
|
export const Default: Default;
|
|
17698
17696
|
/**
|
|
17699
|
-
* No `
|
|
17697
|
+
* No `AudioListener` will be created by default, but they can be created separately by scripts.
|
|
17700
17698
|
*
|
|
17701
17699
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#None)
|
|
17702
17700
|
*/
|
|
@@ -17707,7 +17705,13 @@ declare namespace Enum {
|
|
|
17707
17705
|
}
|
|
17708
17706
|
export const None: None;
|
|
17709
17707
|
/**
|
|
17710
|
-
* An `
|
|
17708
|
+
* All of the following, resulting in the world being heard from the position of your character while matching the orientation of your camera. - An `Attachment` will be created and parented to the `PrimaryPart` of the local player's `Character` model.
|
|
17709
|
+
* - An `AudioListener` will be created and parented to the `Attachment`.
|
|
17710
|
+
* - An `AudioDeviceOutput` will be created and parented to `SoundService`.
|
|
17711
|
+
* - A `Wire` will be created and parented to the previously-created `AudioListener`. The wire's `SourceInstance` will be set to the previously-created `AudioListener` and its `TargetInstance` will be set to the previously-created `AudioDeviceOutput`.
|
|
17712
|
+
* - The previously-created `Attachment` will be updated once per frame to face the same direction as `Workspace.CurrentCamera`.
|
|
17713
|
+
*
|
|
17714
|
+
*
|
|
17711
17715
|
*
|
|
17712
17716
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#Character)
|
|
17713
17717
|
*/
|
|
@@ -17718,7 +17722,11 @@ declare namespace Enum {
|
|
|
17718
17722
|
}
|
|
17719
17723
|
export const Character: Character;
|
|
17720
17724
|
/**
|
|
17721
|
-
* An `AudioListener` will be created and parented to
|
|
17725
|
+
* All of the following, resulting in the world being heard from the perspective (postition and orientation) of the camera. - An `AudioListener` will be created and parented to `Workspace.CurrentCamera`.
|
|
17726
|
+
* - An `AudioDeviceOutput` will be created and parented to `SoundService`.
|
|
17727
|
+
* - A `Wire` will be created and parented to the previously-created `AudioListener`. The wire's `SourceInstance` will be set to the previously-created `AudioListener` and its `TargetInstance` will be set to the previously-created `AudioDeviceOutput`.
|
|
17728
|
+
*
|
|
17729
|
+
*
|
|
17722
17730
|
*
|
|
17723
17731
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#Camera)
|
|
17724
17732
|
*/
|
|
@@ -18244,10 +18252,14 @@ declare namespace Enum {
|
|
|
18244
18252
|
}
|
|
18245
18253
|
export type MarkupKind = MarkupKind.PlainText | MarkupKind.Markdown;
|
|
18246
18254
|
/**
|
|
18255
|
+
* Used with `DataModel.MatchmakingType` to represent how players in the server are handled by matchmaking.
|
|
18256
|
+
*
|
|
18247
18257
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MatchmakingType)
|
|
18248
18258
|
*/
|
|
18249
18259
|
export namespace MatchmakingType {
|
|
18250
18260
|
/**
|
|
18261
|
+
* Includes desktop, mobile, cross-play enabled players, etc.
|
|
18262
|
+
*
|
|
18251
18263
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MatchmakingType#Default)
|
|
18252
18264
|
*/
|
|
18253
18265
|
export interface Default extends globalThis.EnumItem {
|
|
@@ -18257,6 +18269,8 @@ declare namespace Enum {
|
|
|
18257
18269
|
}
|
|
18258
18270
|
export const Default: Default;
|
|
18259
18271
|
/**
|
|
18272
|
+
* Xbox players with cross-play disabled.
|
|
18273
|
+
*
|
|
18260
18274
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MatchmakingType#XboxOnly)
|
|
18261
18275
|
*/
|
|
18262
18276
|
export interface XboxOnly extends globalThis.EnumItem {
|
|
@@ -18266,6 +18280,8 @@ declare namespace Enum {
|
|
|
18266
18280
|
}
|
|
18267
18281
|
export const XboxOnly: XboxOnly;
|
|
18268
18282
|
/**
|
|
18283
|
+
* PlayStation players with cross-play disabled.
|
|
18284
|
+
*
|
|
18269
18285
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MatchmakingType#PlayStationOnly)
|
|
18270
18286
|
*/
|
|
18271
18287
|
export interface PlayStationOnly extends globalThis.EnumItem {
|
|
@@ -21437,12 +21453,21 @@ declare namespace Enum {
|
|
|
21437
21453
|
EnumType: typeof globalThis.Enum.PlayerDataErrorState;
|
|
21438
21454
|
}
|
|
21439
21455
|
export const FlushFailed: FlushFailed;
|
|
21456
|
+
/**
|
|
21457
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PlayerDataErrorState#ReleaseFailed)
|
|
21458
|
+
*/
|
|
21459
|
+
export interface ReleaseFailed extends globalThis.EnumItem {
|
|
21460
|
+
Name: "ReleaseFailed";
|
|
21461
|
+
Value: 2;
|
|
21462
|
+
EnumType: typeof globalThis.Enum.PlayerDataErrorState;
|
|
21463
|
+
}
|
|
21464
|
+
export const ReleaseFailed: ReleaseFailed;
|
|
21440
21465
|
/**
|
|
21441
21466
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PlayerDataErrorState#None)
|
|
21442
21467
|
*/
|
|
21443
21468
|
export interface None extends globalThis.EnumItem {
|
|
21444
21469
|
Name: "None";
|
|
21445
|
-
Value:
|
|
21470
|
+
Value: 3;
|
|
21446
21471
|
EnumType: typeof globalThis.Enum.PlayerDataErrorState;
|
|
21447
21472
|
}
|
|
21448
21473
|
export const None: None;
|
|
@@ -21450,7 +21475,7 @@ declare namespace Enum {
|
|
|
21450
21475
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.PlayerDataErrorState | undefined;
|
|
21451
21476
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PlayerDataErrorState | undefined;
|
|
21452
21477
|
}
|
|
21453
|
-
export type PlayerDataErrorState = PlayerDataErrorState.LoadFailed | PlayerDataErrorState.FlushFailed | PlayerDataErrorState.None;
|
|
21478
|
+
export type PlayerDataErrorState = PlayerDataErrorState.LoadFailed | PlayerDataErrorState.FlushFailed | PlayerDataErrorState.ReleaseFailed | PlayerDataErrorState.None;
|
|
21454
21479
|
/**
|
|
21455
21480
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PlayerDataLoadFailureBehavior)
|
|
21456
21481
|
*/
|
|
@@ -24791,11 +24816,20 @@ declare namespace Enum {
|
|
|
24791
24816
|
EnumType: typeof globalThis.Enum.SecurityCapability;
|
|
24792
24817
|
}
|
|
24793
24818
|
export const LegacySound: LegacySound;
|
|
24819
|
+
/**
|
|
24820
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Players)
|
|
24821
|
+
*/
|
|
24822
|
+
export interface Players extends globalThis.EnumItem {
|
|
24823
|
+
Name: "Players";
|
|
24824
|
+
Value: 21;
|
|
24825
|
+
EnumType: typeof globalThis.Enum.SecurityCapability;
|
|
24826
|
+
}
|
|
24827
|
+
export const Players: Players;
|
|
24794
24828
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.SecurityCapability>;
|
|
24795
24829
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.SecurityCapability | undefined;
|
|
24796
24830
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.SecurityCapability | undefined;
|
|
24797
24831
|
}
|
|
24798
|
-
export type SecurityCapability = SecurityCapability.RunClientScript | SecurityCapability.RunServerScript | SecurityCapability.AccessOutsideWrite | SecurityCapability.AssetRequire | SecurityCapability.LoadString | SecurityCapability.ScriptGlobals | SecurityCapability.CreateInstances | SecurityCapability.Basic | SecurityCapability.Audio | SecurityCapability.DataStore | SecurityCapability.Network | SecurityCapability.Physics | SecurityCapability.UI | SecurityCapability.CSG | SecurityCapability.Chat | SecurityCapability.Animation | SecurityCapability.Avatar | SecurityCapability.Input | SecurityCapability.Environment | SecurityCapability.RemoteEvent | SecurityCapability.LegacySound;
|
|
24832
|
+
export type SecurityCapability = SecurityCapability.RunClientScript | SecurityCapability.RunServerScript | SecurityCapability.AccessOutsideWrite | SecurityCapability.AssetRequire | SecurityCapability.LoadString | SecurityCapability.ScriptGlobals | SecurityCapability.CreateInstances | SecurityCapability.Basic | SecurityCapability.Audio | SecurityCapability.DataStore | SecurityCapability.Network | SecurityCapability.Physics | SecurityCapability.UI | SecurityCapability.CSG | SecurityCapability.Chat | SecurityCapability.Animation | SecurityCapability.Avatar | SecurityCapability.Input | SecurityCapability.Environment | SecurityCapability.RemoteEvent | SecurityCapability.LegacySound | SecurityCapability.Players;
|
|
24799
24833
|
/**
|
|
24800
24834
|
* Customization options for gamepad selection when `GuiBase2d.SelectionGroup` is true.
|
|
24801
24835
|
*
|
|
@@ -25518,6 +25552,87 @@ declare namespace Enum {
|
|
|
25518
25552
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.StartCorner | undefined;
|
|
25519
25553
|
}
|
|
25520
25554
|
export type StartCorner = StartCorner.TopLeft | StartCorner.TopRight | StartCorner.BottomLeft | StartCorner.BottomRight;
|
|
25555
|
+
/**
|
|
25556
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType)
|
|
25557
|
+
*/
|
|
25558
|
+
export namespace StateObjectFieldType {
|
|
25559
|
+
/**
|
|
25560
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Boolean)
|
|
25561
|
+
*/
|
|
25562
|
+
export interface Boolean extends globalThis.EnumItem {
|
|
25563
|
+
Name: "Boolean";
|
|
25564
|
+
Value: 0;
|
|
25565
|
+
EnumType: typeof globalThis.Enum.StateObjectFieldType;
|
|
25566
|
+
}
|
|
25567
|
+
export const Boolean: Boolean;
|
|
25568
|
+
/**
|
|
25569
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#CFrame)
|
|
25570
|
+
*/
|
|
25571
|
+
export interface CFrame extends globalThis.EnumItem {
|
|
25572
|
+
Name: "CFrame";
|
|
25573
|
+
Value: 1;
|
|
25574
|
+
EnumType: typeof globalThis.Enum.StateObjectFieldType;
|
|
25575
|
+
}
|
|
25576
|
+
export const CFrame: CFrame;
|
|
25577
|
+
/**
|
|
25578
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Float)
|
|
25579
|
+
*/
|
|
25580
|
+
export interface Float extends globalThis.EnumItem {
|
|
25581
|
+
Name: "Float";
|
|
25582
|
+
Value: 2;
|
|
25583
|
+
EnumType: typeof globalThis.Enum.StateObjectFieldType;
|
|
25584
|
+
}
|
|
25585
|
+
export const Float: Float;
|
|
25586
|
+
/**
|
|
25587
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Instance)
|
|
25588
|
+
*/
|
|
25589
|
+
export interface Instance extends globalThis.EnumItem {
|
|
25590
|
+
Name: "Instance";
|
|
25591
|
+
Value: 3;
|
|
25592
|
+
EnumType: typeof globalThis.Enum.StateObjectFieldType;
|
|
25593
|
+
}
|
|
25594
|
+
export const Instance: Instance;
|
|
25595
|
+
/**
|
|
25596
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Random)
|
|
25597
|
+
*/
|
|
25598
|
+
export interface Random extends globalThis.EnumItem {
|
|
25599
|
+
Name: "Random";
|
|
25600
|
+
Value: 4;
|
|
25601
|
+
EnumType: typeof globalThis.Enum.StateObjectFieldType;
|
|
25602
|
+
}
|
|
25603
|
+
export const Random: Random;
|
|
25604
|
+
/**
|
|
25605
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Vector2)
|
|
25606
|
+
*/
|
|
25607
|
+
export interface Vector2 extends globalThis.EnumItem {
|
|
25608
|
+
Name: "Vector2";
|
|
25609
|
+
Value: 5;
|
|
25610
|
+
EnumType: typeof globalThis.Enum.StateObjectFieldType;
|
|
25611
|
+
}
|
|
25612
|
+
export const Vector2: Vector2;
|
|
25613
|
+
/**
|
|
25614
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Vector3)
|
|
25615
|
+
*/
|
|
25616
|
+
export interface Vector3 extends globalThis.EnumItem {
|
|
25617
|
+
Name: "Vector3";
|
|
25618
|
+
Value: 6;
|
|
25619
|
+
EnumType: typeof globalThis.Enum.StateObjectFieldType;
|
|
25620
|
+
}
|
|
25621
|
+
export const Vector3: Vector3;
|
|
25622
|
+
/**
|
|
25623
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#INVALID)
|
|
25624
|
+
*/
|
|
25625
|
+
export interface INVALID extends globalThis.EnumItem {
|
|
25626
|
+
Name: "INVALID";
|
|
25627
|
+
Value: 7;
|
|
25628
|
+
EnumType: typeof globalThis.Enum.StateObjectFieldType;
|
|
25629
|
+
}
|
|
25630
|
+
export const INVALID: INVALID;
|
|
25631
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.StateObjectFieldType>;
|
|
25632
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.StateObjectFieldType | undefined;
|
|
25633
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.StateObjectFieldType | undefined;
|
|
25634
|
+
}
|
|
25635
|
+
export type StateObjectFieldType = StateObjectFieldType.Boolean | StateObjectFieldType.CFrame | StateObjectFieldType.Float | StateObjectFieldType.Instance | StateObjectFieldType.Random | StateObjectFieldType.Vector2 | StateObjectFieldType.Vector3 | StateObjectFieldType.INVALID;
|
|
25521
25636
|
/**
|
|
25522
25637
|
* **Deprecated:** This enum is deprecated as it was only used by deprecated methods and events. It should not be used in new work.
|
|
25523
25638
|
*
|
|
@@ -30233,6 +30348,42 @@ declare namespace Enum {
|
|
|
30233
30348
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.TweenStatus | undefined;
|
|
30234
30349
|
}
|
|
30235
30350
|
export type TweenStatus = TweenStatus.Canceled | TweenStatus.Completed;
|
|
30351
|
+
/**
|
|
30352
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UICaptureMode)
|
|
30353
|
+
*/
|
|
30354
|
+
export namespace UICaptureMode {
|
|
30355
|
+
/**
|
|
30356
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UICaptureMode#All)
|
|
30357
|
+
*/
|
|
30358
|
+
export interface All extends globalThis.EnumItem {
|
|
30359
|
+
Name: "All";
|
|
30360
|
+
Value: 0;
|
|
30361
|
+
EnumType: typeof globalThis.Enum.UICaptureMode;
|
|
30362
|
+
}
|
|
30363
|
+
export const All: All;
|
|
30364
|
+
/**
|
|
30365
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UICaptureMode#None)
|
|
30366
|
+
*/
|
|
30367
|
+
export interface None extends globalThis.EnumItem {
|
|
30368
|
+
Name: "None";
|
|
30369
|
+
Value: 1;
|
|
30370
|
+
EnumType: typeof globalThis.Enum.UICaptureMode;
|
|
30371
|
+
}
|
|
30372
|
+
export const None: None;
|
|
30373
|
+
/**
|
|
30374
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UICaptureMode#PlayerGui)
|
|
30375
|
+
*/
|
|
30376
|
+
export interface PlayerGui extends globalThis.EnumItem {
|
|
30377
|
+
Name: "PlayerGui";
|
|
30378
|
+
Value: 2;
|
|
30379
|
+
EnumType: typeof globalThis.Enum.UICaptureMode;
|
|
30380
|
+
}
|
|
30381
|
+
export const PlayerGui: PlayerGui;
|
|
30382
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.UICaptureMode>;
|
|
30383
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.UICaptureMode | undefined;
|
|
30384
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.UICaptureMode | undefined;
|
|
30385
|
+
}
|
|
30386
|
+
export type UICaptureMode = UICaptureMode.All | UICaptureMode.None | UICaptureMode.PlayerGui;
|
|
30236
30387
|
/**
|
|
30237
30388
|
* Used with `UIDragDetector` to determine bounding behavior of the dragged UI object when `UIDragDetector.BoundingUI` is set.
|
|
30238
30389
|
*
|
|
@@ -32277,6 +32428,51 @@ declare namespace Enum {
|
|
|
32277
32428
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.WaterForce | undefined;
|
|
32278
32429
|
}
|
|
32279
32430
|
export type WaterForce = WaterForce.None | WaterForce.Small | WaterForce.Medium | WaterForce.Strong | WaterForce.Max;
|
|
32431
|
+
/**
|
|
32432
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebSocketState)
|
|
32433
|
+
*/
|
|
32434
|
+
export namespace WebSocketState {
|
|
32435
|
+
/**
|
|
32436
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Connecting)
|
|
32437
|
+
*/
|
|
32438
|
+
export interface Connecting extends globalThis.EnumItem {
|
|
32439
|
+
Name: "Connecting";
|
|
32440
|
+
Value: 0;
|
|
32441
|
+
EnumType: typeof globalThis.Enum.WebSocketState;
|
|
32442
|
+
}
|
|
32443
|
+
export const Connecting: Connecting;
|
|
32444
|
+
/**
|
|
32445
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Open)
|
|
32446
|
+
*/
|
|
32447
|
+
export interface Open extends globalThis.EnumItem {
|
|
32448
|
+
Name: "Open";
|
|
32449
|
+
Value: 1;
|
|
32450
|
+
EnumType: typeof globalThis.Enum.WebSocketState;
|
|
32451
|
+
}
|
|
32452
|
+
export const Open: Open;
|
|
32453
|
+
/**
|
|
32454
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Closing)
|
|
32455
|
+
*/
|
|
32456
|
+
export interface Closing extends globalThis.EnumItem {
|
|
32457
|
+
Name: "Closing";
|
|
32458
|
+
Value: 2;
|
|
32459
|
+
EnumType: typeof globalThis.Enum.WebSocketState;
|
|
32460
|
+
}
|
|
32461
|
+
export const Closing: Closing;
|
|
32462
|
+
/**
|
|
32463
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Closed)
|
|
32464
|
+
*/
|
|
32465
|
+
export interface Closed extends globalThis.EnumItem {
|
|
32466
|
+
Name: "Closed";
|
|
32467
|
+
Value: 3;
|
|
32468
|
+
EnumType: typeof globalThis.Enum.WebSocketState;
|
|
32469
|
+
}
|
|
32470
|
+
export const Closed: Closed;
|
|
32471
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.WebSocketState>;
|
|
32472
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.WebSocketState | undefined;
|
|
32473
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.WebSocketState | undefined;
|
|
32474
|
+
}
|
|
32475
|
+
export type WebSocketState = WebSocketState.Connecting | WebSocketState.Open | WebSocketState.Closing | WebSocketState.Closed;
|
|
32280
32476
|
/**
|
|
32281
32477
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WeldConstraintPreserve)
|
|
32282
32478
|
*/
|