@rbxts/types 1.0.945 → 1.0.947

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.
@@ -588,6 +588,8 @@ declare namespace Enum {
588
588
  }
589
589
  export type ActuatorType = ActuatorType.None | ActuatorType.Motor | ActuatorType.Servo;
590
590
  /**
591
+ * Indicates whether an ad is available or the reason it cannot be shown.
592
+ *
591
593
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult)
592
594
  */
593
595
  export namespace AdAvailabilityResult {
@@ -749,11 +751,13 @@ declare namespace Enum {
749
751
  }
750
752
  export type AdEventType = AdEventType.VideoLoaded | AdEventType.VideoRemoved | AdEventType.UserCompletedVideo | AdEventType.RewardedAdLoaded | AdEventType.RewardedAdGrant | AdEventType.RewardedAdUnloaded;
751
753
  /**
754
+ * Specifies the format of an ad used with `AdService` methods.
755
+ *
752
756
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdFormat)
753
757
  */
754
758
  export namespace AdFormat {
755
759
  /**
756
- * The format of the rewarded video ad.
760
+ * A full-screen video ad that plays to completion and rewards the viewer, used as the `adFormat` argument for `AdService` methods.
757
761
  *
758
762
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdFormat#RewardedVideo)
759
763
  */
@@ -791,10 +795,14 @@ declare namespace Enum {
791
795
  }
792
796
  export type AdShape = AdShape.HorizontalRectangle;
793
797
  /**
798
+ * Describes the method by which a player teleports during an immersive ad portal flow.
799
+ *
794
800
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod)
795
801
  */
796
802
  export namespace AdTeleportMethod {
797
803
  /**
804
+ * Default uninitialized sentinel value indicating that no teleport method has been determined yet.
805
+ *
798
806
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#Undefined)
799
807
  */
800
808
  export interface Undefined extends globalThis.EnumItem {
@@ -804,6 +812,8 @@ declare namespace Enum {
804
812
  }
805
813
  export const Undefined: Undefined;
806
814
  /**
815
+ * The player teleported forward to the advertiser's destination experience by walking into an `AdPortal`.
816
+ *
807
817
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#PortalForward)
808
818
  */
809
819
  export interface PortalForward extends globalThis.EnumItem {
@@ -813,6 +823,8 @@ declare namespace Enum {
813
823
  }
814
824
  export const PortalForward: PortalForward;
815
825
  /**
826
+ * The player initiated a return teleport to the publisher's experience by pressing the back button in the in-game menu.
827
+ *
816
828
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#InGameMenuBackButton)
817
829
  */
818
830
  export interface InGameMenuBackButton extends globalThis.EnumItem {
@@ -822,6 +834,8 @@ declare namespace Enum {
822
834
  }
823
835
  export const InGameMenuBackButton: InGameMenuBackButton;
824
836
  /**
837
+ * The player initiated a return teleport to the publisher's experience by pressing a back button rendered in the ad destination's UI overlay.
838
+ *
825
839
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#UIBackButton)
826
840
  */
827
841
  export interface UIBackButton extends globalThis.EnumItem {
@@ -836,10 +850,14 @@ declare namespace Enum {
836
850
  }
837
851
  export type AdTeleportMethod = AdTeleportMethod.Undefined | AdTeleportMethod.PortalForward | AdTeleportMethod.InGameMenuBackButton | AdTeleportMethod.UIBackButton;
838
852
  /**
853
+ * Describes the type of user-interaction or system event that occurred on the immersive ad UI overlay of an `AdGui`.
854
+ *
839
855
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType)
840
856
  */
841
857
  export namespace AdUIEventType {
842
858
  /**
859
+ * The player clicked the "Sponsored" label on the ad overlay, which opens the ad disclosure prompt showing advertiser and payer information.
860
+ *
843
861
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#AdLabelClicked)
844
862
  */
845
863
  export interface AdLabelClicked extends globalThis.EnumItem {
@@ -849,6 +867,8 @@ declare namespace Enum {
849
867
  }
850
868
  export const AdLabelClicked: AdLabelClicked;
851
869
  /**
870
+ * The player clicked the volume toggle button on the ad overlay, which mutes or unmutes the video ad audio.
871
+ *
852
872
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#VolumeButtonClicked)
853
873
  */
854
874
  export interface VolumeButtonClicked extends globalThis.EnumItem {
@@ -858,6 +878,8 @@ declare namespace Enum {
858
878
  }
859
879
  export const VolumeButtonClicked: VolumeButtonClicked;
860
880
  /**
881
+ * The player clicked the fullscreen toggle button, which smoothly zooms the camera to a centered view of the ad surface and enables audio.
882
+ *
861
883
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#FullscreenButtonClicked)
862
884
  */
863
885
  export interface FullscreenButtonClicked extends globalThis.EnumItem {
@@ -867,6 +889,8 @@ declare namespace Enum {
867
889
  }
868
890
  export const FullscreenButtonClicked: FullscreenButtonClicked;
869
891
  /**
892
+ * The player clicked the play button on the ad overlay. If the ad is already in fullscreen, playback resumes; otherwise it enters fullscreen mode which also starts (or resumes) the video.
893
+ *
870
894
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PlayButtonClicked)
871
895
  */
872
896
  export interface PlayButtonClicked extends globalThis.EnumItem {
@@ -876,6 +900,8 @@ declare namespace Enum {
876
900
  }
877
901
  export const PlayButtonClicked: PlayButtonClicked;
878
902
  /**
903
+ * The player clicked the pause button while a video ad is playing in fullscreen mode, which pauses video playback.
904
+ *
879
905
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PauseButtonClicked)
880
906
  */
881
907
  export interface PauseButtonClicked extends globalThis.EnumItem {
@@ -885,6 +911,8 @@ declare namespace Enum {
885
911
  }
886
912
  export const PauseButtonClicked: PauseButtonClicked;
887
913
  /**
914
+ * The player clicked the close button on the fullscreen video ad view, which exits fullscreen mode and returns to the normal camera position.
915
+ *
888
916
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#CloseButtonClicked)
889
917
  */
890
918
  export interface CloseButtonClicked extends globalThis.EnumItem {
@@ -894,6 +922,8 @@ declare namespace Enum {
894
922
  }
895
923
  export const CloseButtonClicked: CloseButtonClicked;
896
924
  /**
925
+ * The player clicked the "Why this ad?" link, which displays the EUDSA (European Digital Services Act) disclosure prompt showing the advertiser and payer names for the current ad creative.
926
+ *
897
927
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#WhyThisAdClicked)
898
928
  */
899
929
  export interface WhyThisAdClicked extends globalThis.EnumItem {
@@ -903,6 +933,8 @@ declare namespace Enum {
903
933
  }
904
934
  export const WhyThisAdClicked: WhyThisAdClicked;
905
935
  /**
936
+ * A system-initiated play/resume event that clears the force-pause state set by `PauseEventTriggered` and resumes video playback if the stream is open.
937
+ *
906
938
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PlayEventTriggered)
907
939
  */
908
940
  export interface PlayEventTriggered extends globalThis.EnumItem {
@@ -912,6 +944,8 @@ declare namespace Enum {
912
944
  }
913
945
  export const PlayEventTriggered: PlayEventTriggered;
914
946
  /**
947
+ * A system-initiated pause event, used when the engine needs to force-pause the video (for example, when a dropdown menu opens over the ad). Prevents viewability-based auto-play from resuming playback until a corresponding `PlayEventTriggered` clears that pause.
948
+ *
915
949
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PauseEventTriggered)
916
950
  */
917
951
  export interface PauseEventTriggered extends globalThis.EnumItem {
@@ -926,10 +960,14 @@ declare namespace Enum {
926
960
  }
927
961
  export type AdUIEventType = AdUIEventType.AdLabelClicked | AdUIEventType.VolumeButtonClicked | AdUIEventType.FullscreenButtonClicked | AdUIEventType.PlayButtonClicked | AdUIEventType.PauseButtonClicked | AdUIEventType.CloseButtonClicked | AdUIEventType.WhyThisAdClicked | AdUIEventType.PlayEventTriggered | AdUIEventType.PauseEventTriggered;
928
962
  /**
963
+ * Describes the type of ad creative currently rendered by an `AdGui`.
964
+ *
929
965
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType)
930
966
  */
931
967
  export namespace AdUIType {
932
968
  /**
969
+ * The `AdGui` has no ad creative loaded and is not rendering ad content.
970
+ *
933
971
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType#None)
934
972
  */
935
973
  export interface None extends globalThis.EnumItem {
@@ -939,6 +977,8 @@ declare namespace Enum {
939
977
  }
940
978
  export const None: None;
941
979
  /**
980
+ * The `AdGui` is rendering a static image ad creative.
981
+ *
942
982
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType#Image)
943
983
  */
944
984
  export interface Image extends globalThis.EnumItem {
@@ -948,6 +988,8 @@ declare namespace Enum {
948
988
  }
949
989
  export const Image: Image;
950
990
  /**
991
+ * The `AdGui` is rendering a video ad creative.
992
+ *
951
993
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType#Video)
952
994
  */
953
995
  export interface Video extends globalThis.EnumItem {
@@ -1904,6 +1946,33 @@ declare namespace Enum {
1904
1946
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodeTransitionType | undefined;
1905
1947
  }
1906
1948
  export type AnimationNodeTransitionType = AnimationNodeTransitionType.CrossFade | AnimationNodeTransitionType.InertialBlend | AnimationNodeTransitionType.DeadBlend;
1949
+ /**
1950
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionWhen)
1951
+ */
1952
+ export namespace AnimationNodeTransitionWhen {
1953
+ /**
1954
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionWhen#Finished)
1955
+ */
1956
+ export interface Finished extends globalThis.EnumItem {
1957
+ Name: "Finished";
1958
+ Value: 0;
1959
+ EnumType: typeof globalThis.Enum.AnimationNodeTransitionWhen;
1960
+ }
1961
+ export const Finished: Finished;
1962
+ /**
1963
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionWhen#BeforeFinished)
1964
+ */
1965
+ export interface BeforeFinished extends globalThis.EnumItem {
1966
+ Name: "BeforeFinished";
1967
+ Value: 1;
1968
+ EnumType: typeof globalThis.Enum.AnimationNodeTransitionWhen;
1969
+ }
1970
+ export const BeforeFinished: BeforeFinished;
1971
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AnimationNodeTransitionWhen>;
1972
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodeTransitionWhen | undefined;
1973
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodeTransitionWhen | undefined;
1974
+ }
1975
+ export type AnimationNodeTransitionWhen = AnimationNodeTransitionWhen.Finished | AnimationNodeTransitionWhen.BeforeFinished;
1907
1976
  /**
1908
1977
  * Specifies the type of an animation graph node, determining how it processes or combines animation data.
1909
1978
  *
@@ -8236,21 +8305,19 @@ declare namespace Enum {
8236
8305
  }
8237
8306
  export const PreciseConvexDecomposition: PreciseConvexDecomposition;
8238
8307
  /**
8239
- * Collision model that supports precision scaling of convex decomposition fidelity.
8240
- *
8241
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Scalable)
8308
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Tunable)
8242
8309
  */
8243
- export interface Scalable extends globalThis.EnumItem {
8244
- Name: "Scalable";
8310
+ export interface Tunable extends globalThis.EnumItem {
8311
+ Name: "Tunable";
8245
8312
  Value: 4;
8246
8313
  EnumType: typeof globalThis.Enum.CollisionFidelity;
8247
8314
  }
8248
- export const Scalable: Scalable;
8315
+ export const Tunable: Tunable;
8249
8316
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.CollisionFidelity>;
8250
8317
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CollisionFidelity | undefined;
8251
8318
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CollisionFidelity | undefined;
8252
8319
  }
8253
- export type CollisionFidelity = CollisionFidelity.Default | CollisionFidelity.Hull | CollisionFidelity.Box | CollisionFidelity.PreciseConvexDecomposition | CollisionFidelity.Scalable;
8320
+ export type CollisionFidelity = CollisionFidelity.Default | CollisionFidelity.Hull | CollisionFidelity.Box | CollisionFidelity.PreciseConvexDecomposition | CollisionFidelity.Tunable;
8254
8321
  /**
8255
8322
  * Specifies the minimum security permission level required to invoke a Studio command.
8256
8323
  *
@@ -16599,11 +16666,20 @@ declare namespace Enum {
16599
16666
  EnumType: typeof globalThis.Enum.GenerateMomentTextResult;
16600
16667
  }
16601
16668
  export const Failed: Failed;
16669
+ /**
16670
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GenerateMomentTextResult#Filtered)
16671
+ */
16672
+ export interface Filtered extends globalThis.EnumItem {
16673
+ Name: "Filtered";
16674
+ Value: 3;
16675
+ EnumType: typeof globalThis.Enum.GenerateMomentTextResult;
16676
+ }
16677
+ export const Filtered: Filtered;
16602
16678
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.GenerateMomentTextResult>;
16603
16679
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.GenerateMomentTextResult | undefined;
16604
16680
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.GenerateMomentTextResult | undefined;
16605
16681
  }
16606
- export type GenerateMomentTextResult = GenerateMomentTextResult.Success | GenerateMomentTextResult.Pending | GenerateMomentTextResult.Failed;
16682
+ export type GenerateMomentTextResult = GenerateMomentTextResult.Success | GenerateMomentTextResult.Pending | GenerateMomentTextResult.Failed | GenerateMomentTextResult.Filtered;
16607
16683
  /**
16608
16684
  * **Deprecated:**
16609
16685
  *
@@ -32982,10 +33058,14 @@ declare namespace Enum {
32982
33058
  }
32983
33059
  export type ScrollingDirection = ScrollingDirection.X | ScrollingDirection.Y | ScrollingDirection.XY;
32984
33060
  /**
33061
+ * Identifies a specific permission capability that a sandboxed script container may grant or restrict.
33062
+ *
32985
33063
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability)
32986
33064
  */
32987
33065
  export namespace SecurityCapability {
32988
33066
  /**
33067
+ * Indicates that a script container is permitted to execute scripts on the client (`LocalScript`).
33068
+ *
32989
33069
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RunClientScript)
32990
33070
  */
32991
33071
  export interface RunClientScript extends globalThis.EnumItem {
@@ -32995,6 +33075,8 @@ declare namespace Enum {
32995
33075
  }
32996
33076
  export const RunClientScript: RunClientScript;
32997
33077
  /**
33078
+ * Indicates that a script container is permitted to execute scripts on the server (`Script`).
33079
+ *
32998
33080
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RunServerScript)
32999
33081
  */
33000
33082
  export interface RunServerScript extends globalThis.EnumItem {
@@ -33004,6 +33086,8 @@ declare namespace Enum {
33004
33086
  }
33005
33087
  export const RunServerScript: RunServerScript;
33006
33088
  /**
33089
+ * Grants a script read-write access to instances that live outside its sandboxed container.
33090
+ *
33007
33091
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AccessOutsideWrite)
33008
33092
  */
33009
33093
  export interface AccessOutsideWrite extends globalThis.EnumItem {
@@ -33013,7 +33097,9 @@ declare namespace Enum {
33013
33097
  }
33014
33098
  export const AccessOutsideWrite: AccessOutsideWrite;
33015
33099
  /**
33016
- * **Deprecated:**
33100
+ * **Deprecated:** Use `SecurityCapability.LoadUnownedAsset` instead.
33101
+ *
33102
+ * Deprecated. Use `SecurityCapability.LoadUnownedAsset` instead.
33017
33103
  *
33018
33104
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AssetRequire)
33019
33105
  */
@@ -33024,6 +33110,8 @@ declare namespace Enum {
33024
33110
  }
33025
33111
  export const AssetRequire: AssetRequire;
33026
33112
  /**
33113
+ * Allows a script to use the `loadstring()` Luau built-in to compile and execute a string as code.
33114
+ *
33027
33115
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LoadString)
33028
33116
  */
33029
33117
  export interface LoadString extends globalThis.EnumItem {
@@ -33033,6 +33121,8 @@ declare namespace Enum {
33033
33121
  }
33034
33122
  export const LoadString: LoadString;
33035
33123
  /**
33124
+ * Allows a script to access the `shared` and `_G` shared global variable tables.
33125
+ *
33036
33126
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#ScriptGlobals)
33037
33127
  */
33038
33128
  export interface ScriptGlobals extends globalThis.EnumItem {
@@ -33042,6 +33132,8 @@ declare namespace Enum {
33042
33132
  }
33043
33133
  export const ScriptGlobals: ScriptGlobals;
33044
33134
  /**
33135
+ * Allows a script to create new `Instance` objects using `new()`.
33136
+ *
33045
33137
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#CreateInstances)
33046
33138
  */
33047
33139
  export interface CreateInstances extends globalThis.EnumItem {
@@ -33051,6 +33143,8 @@ declare namespace Enum {
33051
33143
  }
33052
33144
  export const CreateInstances: CreateInstances;
33053
33145
  /**
33146
+ * Guards access to a broad set of general-purpose engine APIs that do not belong to a more specific capability category.
33147
+ *
33054
33148
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Basic)
33055
33149
  */
33056
33150
  export interface Basic extends globalThis.EnumItem {
@@ -33060,6 +33154,8 @@ declare namespace Enum {
33060
33154
  }
33061
33155
  export const Basic: Basic;
33062
33156
  /**
33157
+ * Guards access to audio engine APIs such as `Sound`, `AudioPlayer`, and related classes.
33158
+ *
33063
33159
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Audio)
33064
33160
  */
33065
33161
  export interface Audio extends globalThis.EnumItem {
@@ -33069,6 +33165,8 @@ declare namespace Enum {
33069
33165
  }
33070
33166
  export const Audio: Audio;
33071
33167
  /**
33168
+ * Guards access to data store APIs such as `DataStoreService` and its associated objects.
33169
+ *
33072
33170
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#DataStore)
33073
33171
  */
33074
33172
  export interface DataStore extends globalThis.EnumItem {
@@ -33078,6 +33176,8 @@ declare namespace Enum {
33078
33176
  }
33079
33177
  export const DataStore: DataStore;
33080
33178
  /**
33179
+ * Guards access to low-level networking APIs such as `HttpService`.
33180
+ *
33081
33181
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Network)
33082
33182
  */
33083
33183
  export interface Network extends globalThis.EnumItem {
@@ -33087,6 +33187,8 @@ declare namespace Enum {
33087
33187
  }
33088
33188
  export const Network: Network;
33089
33189
  /**
33190
+ * Guards access to physics engine APIs such as `Constraint` classes and `BasePart` physics properties.
33191
+ *
33090
33192
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Physics)
33091
33193
  */
33092
33194
  export interface Physics extends globalThis.EnumItem {
@@ -33096,6 +33198,8 @@ declare namespace Enum {
33096
33198
  }
33097
33199
  export const Physics: Physics;
33098
33200
  /**
33201
+ * Guards access to UI engine APIs such as `ScreenGui`, `Frame`, and other `GuiObject` classes.
33202
+ *
33099
33203
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#UI)
33100
33204
  */
33101
33205
  export interface UI extends globalThis.EnumItem {
@@ -33105,6 +33209,8 @@ declare namespace Enum {
33105
33209
  }
33106
33210
  export const UI: UI;
33107
33211
  /**
33212
+ * Guards access to Constructive Solid Geometry (CSG) APIs such as `UnionOperation` and `NegateOperation`.
33213
+ *
33108
33214
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#CSG)
33109
33215
  */
33110
33216
  export interface CSG extends globalThis.EnumItem {
@@ -33114,6 +33220,8 @@ declare namespace Enum {
33114
33220
  }
33115
33221
  export const CSG: CSG;
33116
33222
  /**
33223
+ * Guards access to chat engine APIs such as `TextChatService` and related chat classes.
33224
+ *
33117
33225
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Chat)
33118
33226
  */
33119
33227
  export interface Chat extends globalThis.EnumItem {
@@ -33123,6 +33231,8 @@ declare namespace Enum {
33123
33231
  }
33124
33232
  export const Chat: Chat;
33125
33233
  /**
33234
+ * Guards access to animation engine APIs such as `AnimationController` and related classes.
33235
+ *
33126
33236
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Animation)
33127
33237
  */
33128
33238
  export interface Animation extends globalThis.EnumItem {
@@ -33132,7 +33242,9 @@ declare namespace Enum {
33132
33242
  }
33133
33243
  export const Animation: Animation;
33134
33244
  /**
33135
- * **Deprecated:**
33245
+ * **Deprecated:** Use `SecurityCapability.AvatarAppearance` instead.
33246
+ *
33247
+ * Deprecated. Use `SecurityCapability.AvatarAppearance` instead.
33136
33248
  *
33137
33249
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Avatar)
33138
33250
  */
@@ -33143,6 +33255,8 @@ declare namespace Enum {
33143
33255
  }
33144
33256
  export const Avatar: Avatar;
33145
33257
  /**
33258
+ * Guards access to user input APIs such as `UserInputService` and `ContextActionService`.
33259
+ *
33146
33260
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Input)
33147
33261
  */
33148
33262
  export interface Input extends globalThis.EnumItem {
@@ -33152,6 +33266,8 @@ declare namespace Enum {
33152
33266
  }
33153
33267
  export const Input: Input;
33154
33268
  /**
33269
+ * Guards access to environment and world-setting APIs such as `Lighting` and `Atmosphere`.
33270
+ *
33155
33271
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Environment)
33156
33272
  */
33157
33273
  export interface Environment extends globalThis.EnumItem {
@@ -33161,6 +33277,8 @@ declare namespace Enum {
33161
33277
  }
33162
33278
  export const Environment: Environment;
33163
33279
  /**
33280
+ * Guards access to remote event and function APIs such as `RemoteEvent` and `RemoteFunction`.
33281
+ *
33164
33282
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RemoteEvent)
33165
33283
  */
33166
33284
  export interface RemoteEvent extends globalThis.EnumItem {
@@ -33170,6 +33288,8 @@ declare namespace Enum {
33170
33288
  }
33171
33289
  export const RemoteEvent: RemoteEvent;
33172
33290
  /**
33291
+ * Guards access to the legacy `Sound` and pre-`VoiceChatService.UseAudioApi` sound stack APIs.
33292
+ *
33173
33293
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LegacySound)
33174
33294
  */
33175
33295
  export interface LegacySound extends globalThis.EnumItem {
@@ -33179,6 +33299,8 @@ declare namespace Enum {
33179
33299
  }
33180
33300
  export const LegacySound: LegacySound;
33181
33301
  /**
33302
+ * Guards access to `Players` service APIs that query or manage connected players.
33303
+ *
33182
33304
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Players)
33183
33305
  */
33184
33306
  export interface Players extends globalThis.EnumItem {
@@ -33188,6 +33310,8 @@ declare namespace Enum {
33188
33310
  }
33189
33311
  export const Players: Players;
33190
33312
  /**
33313
+ * Guards access to the `Capabilities` and `Sandboxed` properties that configure script sandboxing.
33314
+ *
33191
33315
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#CapabilityControl)
33192
33316
  */
33193
33317
  export interface CapabilityControl extends globalThis.EnumItem {
@@ -33197,6 +33321,8 @@ declare namespace Enum {
33197
33321
  }
33198
33322
  export const CapabilityControl: CapabilityControl;
33199
33323
  /**
33324
+ * Mirrors the legacy `Plugin` permission level, granting access to Studio plugin APIs.
33325
+ *
33200
33326
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Plugin)
33201
33327
  */
33202
33328
  export interface Plugin extends globalThis.EnumItem {
@@ -33206,6 +33332,8 @@ declare namespace Enum {
33206
33332
  }
33207
33333
  export const Plugin: Plugin;
33208
33334
  /**
33335
+ * Mirrors the legacy `LocalUser` permission level, granting access to IDE-only and Studio-level APIs.
33336
+ *
33209
33337
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LocalUser)
33210
33338
  */
33211
33339
  export interface LocalUser extends globalThis.EnumItem {
@@ -33215,6 +33343,8 @@ declare namespace Enum {
33215
33343
  }
33216
33344
  export const LocalUser: LocalUser;
33217
33345
  /**
33346
+ * Mirrors the legacy `WritePlayer` permission level, granting the ability to modify player identity properties such as name and `UserId`.
33347
+ *
33218
33348
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#WritePlayer)
33219
33349
  */
33220
33350
  export interface WritePlayer extends globalThis.EnumItem {
@@ -33224,6 +33354,8 @@ declare namespace Enum {
33224
33354
  }
33225
33355
  export const WritePlayer: WritePlayer;
33226
33356
  /**
33357
+ * Mirrors the legacy `RobloxScript` permission level, granting access to `CoreScript` APIs.
33358
+ *
33227
33359
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RobloxScript)
33228
33360
  */
33229
33361
  export interface RobloxScript extends globalThis.EnumItem {
@@ -33233,6 +33365,8 @@ declare namespace Enum {
33233
33365
  }
33234
33366
  export const RobloxScript: RobloxScript;
33235
33367
  /**
33368
+ * Mirrors the legacy `RobloxEngine` permission level, granting access to internal engine-level APIs.
33369
+ *
33236
33370
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RobloxEngine)
33237
33371
  */
33238
33372
  export interface RobloxEngine extends globalThis.EnumItem {
@@ -33242,6 +33376,8 @@ declare namespace Enum {
33242
33376
  }
33243
33377
  export const RobloxEngine: RobloxEngine;
33244
33378
  /**
33379
+ * The default capability assigned to API members that have not been explicitly assigned to any other capability category.
33380
+ *
33245
33381
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Unassigned)
33246
33382
  */
33247
33383
  export interface Unassigned extends globalThis.EnumItem {
@@ -33251,6 +33387,8 @@ declare namespace Enum {
33251
33387
  }
33252
33388
  export const Unassigned: Unassigned;
33253
33389
  /**
33390
+ * Restricts access to non-sensitive APIs that are intentionally kept internal.
33391
+ *
33254
33392
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#InternalTest)
33255
33393
  */
33256
33394
  export interface InternalTest extends globalThis.EnumItem {
@@ -33260,6 +33398,8 @@ declare namespace Enum {
33260
33398
  }
33261
33399
  export const InternalTest: InternalTest;
33262
33400
  /**
33401
+ * Restricts access to APIs callable only from Studio plugin or Open Cloud Luau execution sessions.
33402
+ *
33263
33403
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#PluginOrOpenCloud)
33264
33404
  */
33265
33405
  export interface PluginOrOpenCloud extends globalThis.EnumItem {
@@ -33269,6 +33409,8 @@ declare namespace Enum {
33269
33409
  }
33270
33410
  export const PluginOrOpenCloud: PluginOrOpenCloud;
33271
33411
  /**
33412
+ * Restricts access to APIs that may only be called from Studio Assistant execution contexts.
33413
+ *
33272
33414
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Assistant)
33273
33415
  */
33274
33416
  export interface Assistant extends globalThis.EnumItem {
@@ -33278,6 +33420,8 @@ declare namespace Enum {
33278
33420
  }
33279
33421
  export const Assistant: Assistant;
33280
33422
  /**
33423
+ * Restricts access to APIs that are executable only from Studio's `RemoteCommandService` in Team Create sessions.
33424
+ *
33281
33425
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RemoteCommand)
33282
33426
  */
33283
33427
  export interface RemoteCommand extends globalThis.EnumItem {
@@ -33287,6 +33431,8 @@ declare namespace Enum {
33287
33431
  }
33288
33432
  export const RemoteCommand: RemoteCommand;
33289
33433
  /**
33434
+ * Guards access to APIs that read or query asset metadata from the Roblox catalog.
33435
+ *
33290
33436
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AssetRead)
33291
33437
  */
33292
33438
  export interface AssetRead extends globalThis.EnumItem {
@@ -33296,6 +33442,8 @@ declare namespace Enum {
33296
33442
  }
33297
33443
  export const AssetRead: AssetRead;
33298
33444
  /**
33445
+ * Guards access to asset management APIs such as `ContentProvider:PreloadAsync()` and encryption-key registration.
33446
+ *
33299
33447
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AssetManagement)
33300
33448
  */
33301
33449
  export interface AssetManagement extends globalThis.EnumItem {
@@ -33305,6 +33453,8 @@ declare namespace Enum {
33305
33453
  }
33306
33454
  export const AssetManagement: AssetManagement;
33307
33455
  /**
33456
+ * Guards access to procedural and AI-driven content generation APIs such as `EditableMesh` and `AvatarCreationService`.
33457
+ *
33308
33458
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#DynamicGeneration)
33309
33459
  */
33310
33460
  export interface DynamicGeneration extends globalThis.EnumItem {
@@ -33314,6 +33464,8 @@ declare namespace Enum {
33314
33464
  }
33315
33465
  export const DynamicGeneration: DynamicGeneration;
33316
33466
  /**
33467
+ * Guards access to platform-level avatar editing APIs provided by `AvatarEditorService`.
33468
+ *
33317
33469
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#PlatformAvatarEditing)
33318
33470
  */
33319
33471
  export interface PlatformAvatarEditing extends globalThis.EnumItem {
@@ -33323,6 +33475,8 @@ declare namespace Enum {
33323
33475
  }
33324
33476
  export const PlatformAvatarEditing: PlatformAvatarEditing;
33325
33477
  /**
33478
+ * Guards access to APIs that create or update published Roblox assets.
33479
+ *
33326
33480
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AssetCreateUpdate)
33327
33481
  */
33328
33482
  export interface AssetCreateUpdate extends globalThis.EnumItem {
@@ -33332,6 +33486,8 @@ declare namespace Enum {
33332
33486
  }
33333
33487
  export const AssetCreateUpdate: AssetCreateUpdate;
33334
33488
  /**
33489
+ * Guards access to `CaptureService` APIs that take screenshots and record video.
33490
+ *
33335
33491
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Capture)
33336
33492
  */
33337
33493
  export interface Capture extends globalThis.EnumItem {
@@ -33341,6 +33497,8 @@ declare namespace Enum {
33341
33497
  }
33342
33498
  export const Capture: Capture;
33343
33499
  /**
33500
+ * Guards access to sensitive user input APIs such as those that can read raw keyboard or mouse data beyond normal game input.
33501
+ *
33344
33502
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#SensitiveInput)
33345
33503
  */
33346
33504
  export interface SensitiveInput extends globalThis.EnumItem {
@@ -33350,6 +33508,8 @@ declare namespace Enum {
33350
33508
  }
33351
33509
  export const SensitiveInput: SensitiveInput;
33352
33510
  /**
33511
+ * Guards access to in-experience purchase and monetization APIs such as `MarketplaceService`.
33512
+ *
33353
33513
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Monetization)
33354
33514
  */
33355
33515
  export interface Monetization extends globalThis.EnumItem {
@@ -33359,6 +33519,8 @@ declare namespace Enum {
33359
33519
  }
33360
33520
  export const Monetization: Monetization;
33361
33521
  /**
33522
+ * Allows a script to load assets that are owned by the experience's creator using `InsertService` or `require()`.
33523
+ *
33362
33524
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LoadOwnedAsset)
33363
33525
  */
33364
33526
  export interface LoadOwnedAsset extends globalThis.EnumItem {
@@ -33368,6 +33530,8 @@ declare namespace Enum {
33368
33530
  }
33369
33531
  export const LoadOwnedAsset: LoadOwnedAsset;
33370
33532
  /**
33533
+ * Guards access to social APIs such as `SocialService`, `FriendPages`, and `ExperienceInviteOptions`.
33534
+ *
33371
33535
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Social)
33372
33536
  */
33373
33537
  export interface Social extends globalThis.EnumItem {
@@ -33377,6 +33541,8 @@ declare namespace Enum {
33377
33541
  }
33378
33542
  export const Social: Social;
33379
33543
  /**
33544
+ * Guards access to server-to-server messaging APIs such as `MessagingService`.
33545
+ *
33380
33546
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#ServerCommunication)
33381
33547
  */
33382
33548
  export interface ServerCommunication extends globalThis.EnumItem {
@@ -33386,6 +33552,8 @@ declare namespace Enum {
33386
33552
  }
33387
33553
  export const ServerCommunication: ServerCommunication;
33388
33554
  /**
33555
+ * Guards access to `LogService` and logging-related APIs.
33556
+ *
33389
33557
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Logging)
33390
33558
  */
33391
33559
  export interface Logging extends globalThis.EnumItem {
@@ -33395,6 +33563,8 @@ declare namespace Enum {
33395
33563
  }
33396
33564
  export const Logging: Logging;
33397
33565
  /**
33566
+ * Guards access to APIs that initiate external (non-Roblox) purchase prompts.
33567
+ *
33398
33568
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#PromptExternalPurchase)
33399
33569
  */
33400
33570
  export interface PromptExternalPurchase extends globalThis.EnumItem {
@@ -33404,6 +33574,8 @@ declare namespace Enum {
33404
33574
  }
33405
33575
  export const PromptExternalPurchase: PromptExternalPurchase;
33406
33576
  /**
33577
+ * Guards access to group-related APIs such as `GroupService`.
33578
+ *
33407
33579
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Groups)
33408
33580
  */
33409
33581
  export interface Groups extends globalThis.EnumItem {
@@ -33413,6 +33585,8 @@ declare namespace Enum {
33413
33585
  }
33414
33586
  export const Groups: Groups;
33415
33587
  /**
33588
+ * Guards access to teleportation APIs such as `TeleportService`, `TeleportOptions`, and `TeleportAsyncResult`.
33589
+ *
33416
33590
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Teleport)
33417
33591
  */
33418
33592
  export interface Teleport extends globalThis.EnumItem {
@@ -33422,6 +33596,8 @@ declare namespace Enum {
33422
33596
  }
33423
33597
  export const Teleport: Teleport;
33424
33598
  /**
33599
+ * Guards access to moderation and player-consequence APIs such as `Players:BanAsync()` and `ModerationService`.
33600
+ *
33425
33601
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Consequences)
33426
33602
  */
33427
33603
  export interface Consequences extends globalThis.EnumItem {
@@ -33431,6 +33607,8 @@ declare namespace Enum {
33431
33607
  }
33432
33608
  export const Consequences: Consequences;
33433
33609
  /**
33610
+ * Guards access to `MaterialService`, `MaterialVariant`, and custom material APIs.
33611
+ *
33434
33612
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Material)
33435
33613
  */
33436
33614
  export interface Material extends globalThis.EnumItem {
@@ -33440,6 +33618,8 @@ declare namespace Enum {
33440
33618
  }
33441
33619
  export const Material: Material;
33442
33620
  /**
33621
+ * Guards access to APIs that control avatar locomotion and behavior at runtime.
33622
+ *
33443
33623
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AvatarBehavior)
33444
33624
  */
33445
33625
  export interface AvatarBehavior extends globalThis.EnumItem {
@@ -33449,6 +33629,8 @@ declare namespace Enum {
33449
33629
  }
33450
33630
  export const AvatarBehavior: AvatarBehavior;
33451
33631
  /**
33632
+ * Guards access to APIs that read or modify avatar appearance, such as `HumanoidDescription`.
33633
+ *
33452
33634
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AvatarAppearance)
33453
33635
  */
33454
33636
  export interface AvatarAppearance extends globalThis.EnumItem {
@@ -33458,6 +33640,8 @@ declare namespace Enum {
33458
33640
  }
33459
33641
  export const AvatarAppearance: AvatarAppearance;
33460
33642
  /**
33643
+ * Allows a script to `require()` asset IDs or call `InsertService:LoadAsset()` for assets not owned by the creator.
33644
+ *
33461
33645
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LoadUnownedAsset)
33462
33646
  */
33463
33647
  export interface LoadUnownedAsset extends globalThis.EnumItem {
@@ -33838,6 +34022,8 @@ declare namespace Enum {
33838
34022
  }
33839
34023
  export type Severity = Severity.Error | Severity.Warning | Severity.Information | Severity.Hint;
33840
34024
  /**
34025
+ * Result codes returned by `AdService:ShowRewardedVideoAdAsync()` indicating whether a rewarded video ad completed successfully or why it did not.
34026
+ *
33841
34027
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult)
33842
34028
  */
33843
34029
  export namespace ShowAdResult {
@@ -33897,6 +34083,8 @@ declare namespace Enum {
33897
34083
  }
33898
34084
  export const ShowInterrupted: ShowInterrupted;
33899
34085
  /**
34086
+ * The device does not have sufficient video memory available to display the ad.
34087
+ *
33900
34088
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#InsufficientMemory)
33901
34089
  */
33902
34090
  export interface InsufficientMemory extends globalThis.EnumItem {
@@ -34166,7 +34354,7 @@ declare namespace Enum {
34166
34354
  }
34167
34355
  export const NoHash: NoHash;
34168
34356
  /**
34169
- * The model's property set has not been uploaded to the content-delivery network. Shown as orange in the debug tint overlay.
34357
+ * The model has not been uploaded to the content-delivery network. Shown as orange in the debug tint overlay.
34170
34358
  *
34171
34359
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SlimTranscoderStatus#NotUploaded)
34172
34360
  */
@@ -34177,7 +34365,7 @@ declare namespace Enum {
34177
34365
  }
34178
34366
  export const NotUploaded: NotUploaded;
34179
34367
  /**
34180
- * The property set has been uploaded to the content-delivery network but has not yet been transcoded into SLIM assets. Shown as yellow in the debug tint overlay.
34368
+ * The model has been uploaded to the content-delivery network but has not yet been transcoded into SLIM assets. Shown as yellow in the debug tint overlay.
34181
34369
  *
34182
34370
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SlimTranscoderStatus#Uploaded)
34183
34371
  */