@rbxts/types 1.0.832 → 1.0.834
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.
|
@@ -176,6 +176,7 @@ interface Services {
|
|
|
176
176
|
StreamingService: StreamingService;
|
|
177
177
|
Studio: Studio;
|
|
178
178
|
StudioAssetService: StudioAssetService;
|
|
179
|
+
StudioCameraService: StudioCameraService;
|
|
179
180
|
StudioData: StudioData;
|
|
180
181
|
StudioDeviceEmulatorService: StudioDeviceEmulatorService;
|
|
181
182
|
StudioPublishService: StudioPublishService;
|
|
@@ -205,6 +206,7 @@ interface Services {
|
|
|
205
206
|
TweenService: TweenService;
|
|
206
207
|
UGCAvatarService: UGCAvatarService;
|
|
207
208
|
UIDragDetectorService: UIDragDetectorService;
|
|
209
|
+
UniqueIdLookupService: UniqueIdLookupService;
|
|
208
210
|
UnvalidatedAssetService: UnvalidatedAssetService;
|
|
209
211
|
UserInputService: UserInputService;
|
|
210
212
|
UserService: UserService;
|
|
@@ -242,6 +244,8 @@ interface CreatableInstances {
|
|
|
242
244
|
AtmosphereSensor: AtmosphereSensor;
|
|
243
245
|
Attachment: Attachment;
|
|
244
246
|
AudioAnalyzer: AudioAnalyzer;
|
|
247
|
+
AudioChannelMixer: AudioChannelMixer;
|
|
248
|
+
AudioChannelSplitter: AudioChannelSplitter;
|
|
245
249
|
AudioChorus: AudioChorus;
|
|
246
250
|
AudioCompressor: AudioCompressor;
|
|
247
251
|
AudioDeviceInput: AudioDeviceInput;
|
|
@@ -1408,6 +1412,36 @@ interface AudioAnalyzer extends Instance {
|
|
|
1408
1412
|
*/
|
|
1409
1413
|
readonly _nominal_AudioAnalyzer: unique symbol;
|
|
1410
1414
|
}
|
|
1415
|
+
/**
|
|
1416
|
+
* - **Tags**: NotBrowsable
|
|
1417
|
+
*
|
|
1418
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer)
|
|
1419
|
+
*/
|
|
1420
|
+
interface AudioChannelMixer extends Instance {
|
|
1421
|
+
/**
|
|
1422
|
+
* **DO NOT USE!**
|
|
1423
|
+
*
|
|
1424
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1425
|
+
* @hidden
|
|
1426
|
+
* @deprecated
|
|
1427
|
+
*/
|
|
1428
|
+
readonly _nominal_AudioChannelMixer: unique symbol;
|
|
1429
|
+
}
|
|
1430
|
+
/**
|
|
1431
|
+
* - **Tags**: NotBrowsable
|
|
1432
|
+
*
|
|
1433
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter)
|
|
1434
|
+
*/
|
|
1435
|
+
interface AudioChannelSplitter extends Instance {
|
|
1436
|
+
/**
|
|
1437
|
+
* **DO NOT USE!**
|
|
1438
|
+
*
|
|
1439
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1440
|
+
* @hidden
|
|
1441
|
+
* @deprecated
|
|
1442
|
+
*/
|
|
1443
|
+
readonly _nominal_AudioChannelSplitter: unique symbol;
|
|
1444
|
+
}
|
|
1411
1445
|
/**
|
|
1412
1446
|
* Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices.
|
|
1413
1447
|
*
|
|
@@ -5486,6 +5520,8 @@ interface RelativeGui extends GuiObject {
|
|
|
5486
5520
|
readonly _nominal_RelativeGui: unique symbol;
|
|
5487
5521
|
}
|
|
5488
5522
|
/**
|
|
5523
|
+
* `ScrollingFrame` is a special `Frame` type with built-in scrolling interactivity and different ways to customize how the scrolling works.
|
|
5524
|
+
*
|
|
5489
5525
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame)
|
|
5490
5526
|
*/
|
|
5491
5527
|
interface ScrollingFrame extends GuiObject {
|
|
@@ -5529,7 +5565,7 @@ interface VideoFrame extends GuiObject {
|
|
|
5529
5565
|
readonly _nominal_VideoFrame: unique symbol;
|
|
5530
5566
|
}
|
|
5531
5567
|
/**
|
|
5532
|
-
* `GuiObject` that
|
|
5568
|
+
* `GuiObject` that renders 3D objects inside its bounds.
|
|
5533
5569
|
*
|
|
5534
5570
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ViewportFrame)
|
|
5535
5571
|
*/
|
|
@@ -6151,7 +6187,7 @@ interface HapticEffect extends Instance {
|
|
|
6151
6187
|
readonly _nominal_HapticEffect: unique symbol;
|
|
6152
6188
|
}
|
|
6153
6189
|
/**
|
|
6154
|
-
* Provides haptic feedback to
|
|
6190
|
+
* Provides haptic feedback to controllers and devices.
|
|
6155
6191
|
*
|
|
6156
6192
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
6157
6193
|
*
|
|
@@ -11945,6 +11981,21 @@ interface StudioCallout extends Instance {
|
|
|
11945
11981
|
*/
|
|
11946
11982
|
readonly _nominal_StudioCallout: unique symbol;
|
|
11947
11983
|
}
|
|
11984
|
+
/**
|
|
11985
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11986
|
+
*
|
|
11987
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCameraService)
|
|
11988
|
+
*/
|
|
11989
|
+
interface StudioCameraService extends Instance {
|
|
11990
|
+
/**
|
|
11991
|
+
* **DO NOT USE!**
|
|
11992
|
+
*
|
|
11993
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
11994
|
+
* @hidden
|
|
11995
|
+
* @deprecated
|
|
11996
|
+
*/
|
|
11997
|
+
readonly _nominal_StudioCameraService: unique symbol;
|
|
11998
|
+
}
|
|
11948
11999
|
/**
|
|
11949
12000
|
* - **Tags**: NotCreatable, Service
|
|
11950
12001
|
*
|
|
@@ -13446,6 +13497,21 @@ interface UIDragDetectorService extends Instance {
|
|
|
13446
13497
|
*/
|
|
13447
13498
|
readonly _nominal_UIDragDetectorService: unique symbol;
|
|
13448
13499
|
}
|
|
13500
|
+
/**
|
|
13501
|
+
* - **Tags**: NotCreatable, Service
|
|
13502
|
+
*
|
|
13503
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UniqueIdLookupService)
|
|
13504
|
+
*/
|
|
13505
|
+
interface UniqueIdLookupService extends Instance {
|
|
13506
|
+
/**
|
|
13507
|
+
* **DO NOT USE!**
|
|
13508
|
+
*
|
|
13509
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
13510
|
+
* @hidden
|
|
13511
|
+
* @deprecated
|
|
13512
|
+
*/
|
|
13513
|
+
readonly _nominal_UniqueIdLookupService: unique symbol;
|
|
13514
|
+
}
|
|
13449
13515
|
/**
|
|
13450
13516
|
* - **Tags**: NotCreatable, Service
|
|
13451
13517
|
*
|
|
@@ -2898,6 +2898,78 @@ declare namespace Enum {
|
|
|
2898
2898
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AudioApiRollout | undefined;
|
|
2899
2899
|
}
|
|
2900
2900
|
export type AudioApiRollout = AudioApiRollout.Disabled | AudioApiRollout.Automatic | AudioApiRollout.Enabled;
|
|
2901
|
+
/**
|
|
2902
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout)
|
|
2903
|
+
*/
|
|
2904
|
+
export namespace AudioChannelLayout {
|
|
2905
|
+
/**
|
|
2906
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Mono)
|
|
2907
|
+
*/
|
|
2908
|
+
export interface Mono extends globalThis.EnumItem {
|
|
2909
|
+
Name: "Mono";
|
|
2910
|
+
Value: 0;
|
|
2911
|
+
EnumType: typeof globalThis.Enum.AudioChannelLayout;
|
|
2912
|
+
}
|
|
2913
|
+
export const Mono: Mono;
|
|
2914
|
+
/**
|
|
2915
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Stereo)
|
|
2916
|
+
*/
|
|
2917
|
+
export interface Stereo extends globalThis.EnumItem {
|
|
2918
|
+
Name: "Stereo";
|
|
2919
|
+
Value: 1;
|
|
2920
|
+
EnumType: typeof globalThis.Enum.AudioChannelLayout;
|
|
2921
|
+
}
|
|
2922
|
+
export const Stereo: Stereo;
|
|
2923
|
+
/**
|
|
2924
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Quad)
|
|
2925
|
+
*/
|
|
2926
|
+
export interface Quad extends globalThis.EnumItem {
|
|
2927
|
+
Name: "Quad";
|
|
2928
|
+
Value: 2;
|
|
2929
|
+
EnumType: typeof globalThis.Enum.AudioChannelLayout;
|
|
2930
|
+
}
|
|
2931
|
+
export const Quad: Quad;
|
|
2932
|
+
/**
|
|
2933
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_5)
|
|
2934
|
+
*/
|
|
2935
|
+
export interface Surround_5 extends globalThis.EnumItem {
|
|
2936
|
+
Name: "Surround_5";
|
|
2937
|
+
Value: 3;
|
|
2938
|
+
EnumType: typeof globalThis.Enum.AudioChannelLayout;
|
|
2939
|
+
}
|
|
2940
|
+
export const Surround_5: Surround_5;
|
|
2941
|
+
/**
|
|
2942
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_5_1)
|
|
2943
|
+
*/
|
|
2944
|
+
export interface Surround_5_1 extends globalThis.EnumItem {
|
|
2945
|
+
Name: "Surround_5_1";
|
|
2946
|
+
Value: 4;
|
|
2947
|
+
EnumType: typeof globalThis.Enum.AudioChannelLayout;
|
|
2948
|
+
}
|
|
2949
|
+
export const Surround_5_1: Surround_5_1;
|
|
2950
|
+
/**
|
|
2951
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_7_1)
|
|
2952
|
+
*/
|
|
2953
|
+
export interface Surround_7_1 extends globalThis.EnumItem {
|
|
2954
|
+
Name: "Surround_7_1";
|
|
2955
|
+
Value: 5;
|
|
2956
|
+
EnumType: typeof globalThis.Enum.AudioChannelLayout;
|
|
2957
|
+
}
|
|
2958
|
+
export const Surround_7_1: Surround_7_1;
|
|
2959
|
+
/**
|
|
2960
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_7_1_4)
|
|
2961
|
+
*/
|
|
2962
|
+
export interface Surround_7_1_4 extends globalThis.EnumItem {
|
|
2963
|
+
Name: "Surround_7_1_4";
|
|
2964
|
+
Value: 6;
|
|
2965
|
+
EnumType: typeof globalThis.Enum.AudioChannelLayout;
|
|
2966
|
+
}
|
|
2967
|
+
export const Surround_7_1_4: Surround_7_1_4;
|
|
2968
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AudioChannelLayout>;
|
|
2969
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AudioChannelLayout | undefined;
|
|
2970
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AudioChannelLayout | undefined;
|
|
2971
|
+
}
|
|
2972
|
+
export type AudioChannelLayout = AudioChannelLayout.Mono | AudioChannelLayout.Stereo | AudioChannelLayout.Quad | AudioChannelLayout.Surround_5 | AudioChannelLayout.Surround_5_1 | AudioChannelLayout.Surround_7_1 | AudioChannelLayout.Surround_7_1_4;
|
|
2901
2973
|
/**
|
|
2902
2974
|
* Filter types used for `AudioFilter` instances.
|
|
2903
2975
|
*
|
|
@@ -7152,6 +7224,15 @@ declare namespace Enum {
|
|
|
7152
7224
|
EnumType: typeof globalThis.Enum.ConnectionError;
|
|
7153
7225
|
}
|
|
7154
7226
|
export const ServerEmpty: ServerEmpty;
|
|
7227
|
+
/**
|
|
7228
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PhantomFreeze)
|
|
7229
|
+
*/
|
|
7230
|
+
export interface PhantomFreeze extends globalThis.EnumItem {
|
|
7231
|
+
Name: "PhantomFreeze";
|
|
7232
|
+
Value: 303;
|
|
7233
|
+
EnumType: typeof globalThis.Enum.ConnectionError;
|
|
7234
|
+
}
|
|
7235
|
+
export const PhantomFreeze: PhantomFreeze;
|
|
7155
7236
|
/**
|
|
7156
7237
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchErrors)
|
|
7157
7238
|
*/
|
|
@@ -7381,7 +7462,7 @@ declare namespace Enum {
|
|
|
7381
7462
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ConnectionError | undefined;
|
|
7382
7463
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ConnectionError | undefined;
|
|
7383
7464
|
}
|
|
7384
|
-
export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.DisconnectPrivateServerKickout | ConnectionError.DisconnectModeratedGame | ConnectionError.ServerShutdown | ConnectionError.ReplicatorTimeout | ConnectionError.PlayerRemoved | ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave | ConnectionError.DisconnectRomarkEndOfTest | ConnectionError.DisconnectCollaboratorPermissionRevoked | ConnectionError.DisconnectCollaboratorUnderage | ConnectionError.NetworkInternal | ConnectionError.NetworkSend | ConnectionError.NetworkTimeout | ConnectionError.NetworkMisbehavior | ConnectionError.NetworkSecurity | ConnectionError.ReplacementReady | ConnectionError.ServerEmpty | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchUserPrivacyUnauthorized | ConnectionError.PlacelaunchCreatorBan | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
|
|
7465
|
+
export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.DisconnectPrivateServerKickout | ConnectionError.DisconnectModeratedGame | ConnectionError.ServerShutdown | ConnectionError.ReplicatorTimeout | ConnectionError.PlayerRemoved | ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave | ConnectionError.DisconnectRomarkEndOfTest | ConnectionError.DisconnectCollaboratorPermissionRevoked | ConnectionError.DisconnectCollaboratorUnderage | ConnectionError.NetworkInternal | ConnectionError.NetworkSend | ConnectionError.NetworkTimeout | ConnectionError.NetworkMisbehavior | ConnectionError.NetworkSecurity | ConnectionError.ReplacementReady | ConnectionError.ServerEmpty | ConnectionError.PhantomFreeze | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchUserPrivacyUnauthorized | ConnectionError.PlacelaunchCreatorBan | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
|
|
7385
7466
|
/**
|
|
7386
7467
|
* Used to determine the connection state of the client to the game server.
|
|
7387
7468
|
*
|
|
@@ -9785,13 +9866,13 @@ declare namespace Enum {
|
|
|
9785
9866
|
}
|
|
9786
9867
|
export type EditableStatus = EditableStatus.Unknown | EditableStatus.Allowed | EditableStatus.Disallowed;
|
|
9787
9868
|
/**
|
|
9788
|
-
* This enum is used by `ScrollingFrame.ElasticBehavior` to
|
|
9869
|
+
* This enum is used by `ScrollingFrame.ElasticBehavior` to control when elastic scrolling is active on touch‑enabled devices.
|
|
9789
9870
|
*
|
|
9790
9871
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior)
|
|
9791
9872
|
*/
|
|
9792
9873
|
export namespace ElasticBehavior {
|
|
9793
9874
|
/**
|
|
9794
|
-
*
|
|
9875
|
+
* Scrolling is elastic when there is content to be scrolled to.
|
|
9795
9876
|
*
|
|
9796
9877
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior#WhenScrollable)
|
|
9797
9878
|
*/
|
|
@@ -9802,7 +9883,7 @@ declare namespace Enum {
|
|
|
9802
9883
|
}
|
|
9803
9884
|
export const WhenScrollable: WhenScrollable;
|
|
9804
9885
|
/**
|
|
9805
|
-
*
|
|
9886
|
+
* Scrolling is always elastic, even when there isn't content available to scroll to.
|
|
9806
9887
|
*
|
|
9807
9888
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior#Always)
|
|
9808
9889
|
*/
|
|
@@ -9813,7 +9894,7 @@ declare namespace Enum {
|
|
|
9813
9894
|
}
|
|
9814
9895
|
export const Always: Always;
|
|
9815
9896
|
/**
|
|
9816
|
-
*
|
|
9897
|
+
* Scrolling is never elastic and the canvas will never scroll beyond its bounds.
|
|
9817
9898
|
*
|
|
9818
9899
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior#Never)
|
|
9819
9900
|
*/
|
|
@@ -24200,13 +24281,13 @@ declare namespace Enum {
|
|
|
24200
24281
|
}
|
|
24201
24282
|
export type ScreenOrientation = ScreenOrientation.LandscapeLeft | ScreenOrientation.LandscapeRight | ScreenOrientation.LandscapeSensor | ScreenOrientation.Portrait | ScreenOrientation.Sensor;
|
|
24202
24283
|
/**
|
|
24203
|
-
*
|
|
24284
|
+
* This enum is used with `ScrollingFrame.HorizontalScrollBarInset` and `ScrollingFrame.VerticalScrollBarInset` to indicate whether the canvas should be inset by `ScrollBarThickness` for the respective scroll bar.
|
|
24204
24285
|
*
|
|
24205
24286
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScrollBarInset)
|
|
24206
24287
|
*/
|
|
24207
24288
|
export namespace ScrollBarInset {
|
|
24208
24289
|
/**
|
|
24209
|
-
* The
|
|
24290
|
+
* The canvas will never be inset for the respective scroll bar.
|
|
24210
24291
|
*
|
|
24211
24292
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScrollBarInset#None)
|
|
24212
24293
|
*/
|
|
@@ -24217,7 +24298,7 @@ declare namespace Enum {
|
|
|
24217
24298
|
}
|
|
24218
24299
|
export const None: None;
|
|
24219
24300
|
/**
|
|
24220
|
-
* The
|
|
24301
|
+
* The canvas will only be inset if the respective scroll bar is showing.
|
|
24221
24302
|
*
|
|
24222
24303
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScrollBarInset#ScrollBar)
|
|
24223
24304
|
*/
|
|
@@ -24228,7 +24309,7 @@ declare namespace Enum {
|
|
|
24228
24309
|
}
|
|
24229
24310
|
export const ScrollBar: ScrollBar;
|
|
24230
24311
|
/**
|
|
24231
|
-
* The
|
|
24312
|
+
* The canvas will always be inset for the respective scroll bar, regardless of whether that scroll bar is showing.
|
|
24232
24313
|
*
|
|
24233
24314
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScrollBarInset#Always)
|
|
24234
24315
|
*/
|
|
@@ -24244,13 +24325,13 @@ declare namespace Enum {
|
|
|
24244
24325
|
}
|
|
24245
24326
|
export type ScrollBarInset = ScrollBarInset.None | ScrollBarInset.ScrollBar | ScrollBarInset.Always;
|
|
24246
24327
|
/**
|
|
24247
|
-
* This enum is used by `ScrollingFrame.ScrollingDirection` to specify the direction scrolling is allowed.
|
|
24328
|
+
* This enum is used by `ScrollingFrame.ScrollingDirection` to specify the direction(s) in which scrolling is allowed.
|
|
24248
24329
|
*
|
|
24249
24330
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScrollingDirection)
|
|
24250
24331
|
*/
|
|
24251
24332
|
export namespace ScrollingDirection {
|
|
24252
24333
|
/**
|
|
24253
|
-
*
|
|
24334
|
+
* The canvas can only be scrolled along the **X** axis.
|
|
24254
24335
|
*
|
|
24255
24336
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScrollingDirection#X)
|
|
24256
24337
|
*/
|
|
@@ -24261,7 +24342,7 @@ declare namespace Enum {
|
|
|
24261
24342
|
}
|
|
24262
24343
|
export const X: X;
|
|
24263
24344
|
/**
|
|
24264
|
-
*
|
|
24345
|
+
* The canvas can only be scrolled along the **Y** axis.
|
|
24265
24346
|
*
|
|
24266
24347
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScrollingDirection#Y)
|
|
24267
24348
|
*/
|
|
@@ -24272,7 +24353,7 @@ declare namespace Enum {
|
|
|
24272
24353
|
}
|
|
24273
24354
|
export const Y: Y;
|
|
24274
24355
|
/**
|
|
24275
|
-
*
|
|
24356
|
+
* The canvas can be scrolled along both the **X** and **Y** axes.
|
|
24276
24357
|
*
|
|
24277
24358
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScrollingDirection#XY)
|
|
24278
24359
|
*/
|
|
@@ -31233,7 +31314,7 @@ declare namespace Enum {
|
|
|
31233
31314
|
}
|
|
31234
31315
|
export type VerticalAlignment = VerticalAlignment.Center | VerticalAlignment.Top | VerticalAlignment.Bottom;
|
|
31235
31316
|
/**
|
|
31236
|
-
*
|
|
31317
|
+
* This enum is used for `ScrollingFrame.VerticalScrollBarPosition` to indicate vertical scroll bar positioning.
|
|
31237
31318
|
*
|
|
31238
31319
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/VerticalScrollBarPosition)
|
|
31239
31320
|
*/
|