@rbxts/types
Version:
TypeScript typings for the Roblox platform. Partially handwritten and partially automatically generated.
1,075 lines • 1.54 MB
TypeScript
// THIS FILE IS GENERATED AUTOMATICALLY AND SHOULD NOT BE EDITED BY HAND!
/// <reference no-default-lib="true"/>
/// <reference path="../roblox.d.ts" />
// GENERATED ROBLOX ENUMS
type Enums = typeof Enum;
interface EnumItem {
Name: string;
Value: number;
EnumType: Enum;
IsA<T extends Exclude<keyof typeof Enum, "GetEnums">>(name: T): this is (typeof Enum)[T][Exclude<keyof (typeof Enum)[T], "GetEnumItems">];
}
interface Enum {
GetEnumItems(this: Enum): Array<EnumItem>;
FromName(this: Enum, name: string): EnumItem | undefined;
FromValue(this: Enum, value: number): EnumItem | undefined;
}
declare namespace Enum {
export function GetEnums(this: Enums): Array<Enum>;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessModifierType)
*/
export namespace AccessModifierType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessModifierType#Allow)
*/
export interface Allow extends globalThis.EnumItem {
Name: "Allow";
Value: 0;
EnumType: typeof globalThis.Enum.AccessModifierType;
}
export const Allow: Allow;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessModifierType#Deny)
*/
export interface Deny extends globalThis.EnumItem {
Name: "Deny";
Value: 1;
EnumType: typeof globalThis.Enum.AccessModifierType;
}
export const Deny: Deny;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AccessModifierType>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AccessModifierType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AccessModifierType | undefined;
}
export type AccessModifierType = AccessModifierType.Allow | AccessModifierType.Deny;
/**
* A subset of AssetTypes which are relevant to only accessories.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType)
*/
export namespace AccessoryType {
/**
* If the accessory type is not known.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Unknown: Unknown;
/**
* A hat accessory (may be a rigid or layered accessory).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Hat)
*/
export interface Hat extends globalThis.EnumItem {
Name: "Hat";
Value: 1;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Hat: Hat;
/**
* A hair accessory (may be a rigid or layered accessory).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Hair)
*/
export interface Hair extends globalThis.EnumItem {
Name: "Hair";
Value: 2;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Hair: Hair;
/**
* A face accessory (may be a rigid or layered accessory).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Face)
*/
export interface Face extends globalThis.EnumItem {
Name: "Face";
Value: 3;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Face: Face;
/**
* A neck Accessory (may be a rigid or layered accessory).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Neck)
*/
export interface Neck extends globalThis.EnumItem {
Name: "Neck";
Value: 4;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Neck: Neck;
/**
* A shoulder accessory (may be a rigid or layered accessory).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Shoulder)
*/
export interface Shoulder extends globalThis.EnumItem {
Name: "Shoulder";
Value: 5;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Shoulder: Shoulder;
/**
* A front accessory (may be a rigid or layered accessory).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Front)
*/
export interface Front extends globalThis.EnumItem {
Name: "Front";
Value: 6;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Front: Front;
/**
* A back accessory (may be a rigid or layered accessory).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Back)
*/
export interface Back extends globalThis.EnumItem {
Name: "Back";
Value: 7;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Back: Back;
/**
* A waist accessory (may be a rigid or layered accessory).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Waist)
*/
export interface Waist extends globalThis.EnumItem {
Name: "Waist";
Value: 8;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Waist: Waist;
/**
* A layered clothing T-Shirt accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#TShirt)
*/
export interface TShirt extends globalThis.EnumItem {
Name: "TShirt";
Value: 9;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const TShirt: TShirt;
/**
* @deprecated renamed to TShirt
*/
export const TeeShirt: TShirt;
/**
* A layered clothing shirt accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Shirt)
*/
export interface Shirt extends globalThis.EnumItem {
Name: "Shirt";
Value: 10;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Shirt: Shirt;
/**
* A layered clothing pants accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Pants)
*/
export interface Pants extends globalThis.EnumItem {
Name: "Pants";
Value: 11;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Pants: Pants;
/**
* A layered clothing jacket accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Jacket)
*/
export interface Jacket extends globalThis.EnumItem {
Name: "Jacket";
Value: 12;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Jacket: Jacket;
/**
* A layered clothing sweater accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Sweater)
*/
export interface Sweater extends globalThis.EnumItem {
Name: "Sweater";
Value: 13;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Sweater: Sweater;
/**
* A layered clothing shorts accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Shorts)
*/
export interface Shorts extends globalThis.EnumItem {
Name: "Shorts";
Value: 14;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Shorts: Shorts;
/**
* A layered clothing left shoe accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#LeftShoe)
*/
export interface LeftShoe extends globalThis.EnumItem {
Name: "LeftShoe";
Value: 15;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const LeftShoe: LeftShoe;
/**
* A layered clothing right shoe accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#RightShoe)
*/
export interface RightShoe extends globalThis.EnumItem {
Name: "RightShoe";
Value: 16;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const RightShoe: RightShoe;
/**
* A layered clothing dress or skirt accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#DressSkirt)
*/
export interface DressSkirt extends globalThis.EnumItem {
Name: "DressSkirt";
Value: 17;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const DressSkirt: DressSkirt;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Eyebrow)
*/
export interface Eyebrow extends globalThis.EnumItem {
Name: "Eyebrow";
Value: 18;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Eyebrow: Eyebrow;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Eyelash)
*/
export interface Eyelash extends globalThis.EnumItem {
Name: "Eyelash";
Value: 19;
EnumType: typeof globalThis.Enum.AccessoryType;
}
export const Eyelash: Eyelash;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AccessoryType>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AccessoryType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AccessoryType | undefined;
}
export type AccessoryType = AccessoryType.Unknown | AccessoryType.Hat | AccessoryType.Hair | AccessoryType.Face | AccessoryType.Neck | AccessoryType.Shoulder | AccessoryType.Front | AccessoryType.Back | AccessoryType.Waist | AccessoryType.TShirt | AccessoryType.Shirt | AccessoryType.Pants | AccessoryType.Jacket | AccessoryType.Sweater | AccessoryType.Shorts | AccessoryType.LeftShoe | AccessoryType.RightShoe | AccessoryType.DressSkirt | AccessoryType.Eyebrow | AccessoryType.Eyelash;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionOnAutoResumeSync)
*/
export namespace ActionOnAutoResumeSync {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionOnAutoResumeSync#DontResume)
*/
export interface DontResume extends globalThis.EnumItem {
Name: "DontResume";
Value: 0;
EnumType: typeof globalThis.Enum.ActionOnAutoResumeSync;
}
export const DontResume: DontResume;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionOnAutoResumeSync#KeepStudio)
*/
export interface KeepStudio extends globalThis.EnumItem {
Name: "KeepStudio";
Value: 1;
EnumType: typeof globalThis.Enum.ActionOnAutoResumeSync;
}
export const KeepStudio: KeepStudio;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionOnAutoResumeSync#KeepLocal)
*/
export interface KeepLocal extends globalThis.EnumItem {
Name: "KeepLocal";
Value: 2;
EnumType: typeof globalThis.Enum.ActionOnAutoResumeSync;
}
export const KeepLocal: KeepLocal;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ActionOnAutoResumeSync>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ActionOnAutoResumeSync | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ActionOnAutoResumeSync | undefined;
}
export type ActionOnAutoResumeSync = ActionOnAutoResumeSync.DontResume | ActionOnAutoResumeSync.KeepStudio | ActionOnAutoResumeSync.KeepLocal;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionOnStopSync)
*/
export namespace ActionOnStopSync {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionOnStopSync#AlwaysAsk)
*/
export interface AlwaysAsk extends globalThis.EnumItem {
Name: "AlwaysAsk";
Value: 0;
EnumType: typeof globalThis.Enum.ActionOnStopSync;
}
export const AlwaysAsk: AlwaysAsk;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionOnStopSync#KeepLocalFiles)
*/
export interface KeepLocalFiles extends globalThis.EnumItem {
Name: "KeepLocalFiles";
Value: 1;
EnumType: typeof globalThis.Enum.ActionOnStopSync;
}
export const KeepLocalFiles: KeepLocalFiles;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionOnStopSync#DeleteLocalFiles)
*/
export interface DeleteLocalFiles extends globalThis.EnumItem {
Name: "DeleteLocalFiles";
Value: 2;
EnumType: typeof globalThis.Enum.ActionOnStopSync;
}
export const DeleteLocalFiles: DeleteLocalFiles;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ActionOnStopSync>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ActionOnStopSync | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ActionOnStopSync | undefined;
}
export type ActionOnStopSync = ActionOnStopSync.AlwaysAsk | ActionOnStopSync.KeepLocalFiles | ActionOnStopSync.DeleteLocalFiles;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionType)
*/
export namespace ActionType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionType#Nothing)
*/
export interface Nothing extends globalThis.EnumItem {
Name: "Nothing";
Value: 0;
EnumType: typeof globalThis.Enum.ActionType;
}
export const Nothing: Nothing;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionType#Pause)
*/
export interface Pause extends globalThis.EnumItem {
Name: "Pause";
Value: 1;
EnumType: typeof globalThis.Enum.ActionType;
}
export const Pause: Pause;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionType#Lose)
*/
export interface Lose extends globalThis.EnumItem {
Name: "Lose";
Value: 2;
EnumType: typeof globalThis.Enum.ActionType;
}
export const Lose: Lose;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionType#Draw)
*/
export interface Draw extends globalThis.EnumItem {
Name: "Draw";
Value: 3;
EnumType: typeof globalThis.Enum.ActionType;
}
export const Draw: Draw;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionType#Win)
*/
export interface Win extends globalThis.EnumItem {
Name: "Win";
Value: 4;
EnumType: typeof globalThis.Enum.ActionType;
}
export const Win: Win;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ActionType>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ActionType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ActionType | undefined;
}
export type ActionType = ActionType.Nothing | ActionType.Pause | ActionType.Lose | ActionType.Draw | ActionType.Win;
/**
* The CFrame value in which the body mover constraint is expressed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActuatorRelativeTo)
*/
export namespace ActuatorRelativeTo {
/**
* The constraint is expressed relative to Attachment0.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActuatorRelativeTo#Attachment0)
*/
export interface Attachment0 extends globalThis.EnumItem {
Name: "Attachment0";
Value: 0;
EnumType: typeof globalThis.Enum.ActuatorRelativeTo;
}
export const Attachment0: Attachment0;
/**
* The constraint is expressed relative to Attachment1.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActuatorRelativeTo#Attachment1)
*/
export interface Attachment1 extends globalThis.EnumItem {
Name: "Attachment1";
Value: 1;
EnumType: typeof globalThis.Enum.ActuatorRelativeTo;
}
export const Attachment1: Attachment1;
/**
* The constraint is expressed relative to the game world.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActuatorRelativeTo#World)
*/
export interface World extends globalThis.EnumItem {
Name: "World";
Value: 2;
EnumType: typeof globalThis.Enum.ActuatorRelativeTo;
}
export const World: World;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ActuatorRelativeTo>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ActuatorRelativeTo | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ActuatorRelativeTo | undefined;
}
export type ActuatorRelativeTo = ActuatorRelativeTo.Attachment0 | ActuatorRelativeTo.Attachment1 | ActuatorRelativeTo.World;
/**
* The active physics component of the constraint.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActuatorType)
*/
export namespace ActuatorType {
/**
* The motor and servo components are both disabled.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActuatorType#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.ActuatorType;
}
export const None: None;
/**
* The motor component is enabled. Motor properties are active and the actuator will apply continuous force.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActuatorType#Motor)
*/
export interface Motor extends globalThis.EnumItem {
Name: "Motor";
Value: 1;
EnumType: typeof globalThis.Enum.ActuatorType;
}
export const Motor: Motor;
/**
* The servo component is enabled. Servo properties are active and the actuator will apply force to approach the servo's target.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActuatorType#Servo)
*/
export interface Servo extends globalThis.EnumItem {
Name: "Servo";
Value: 2;
EnumType: typeof globalThis.Enum.ActuatorType;
}
export const Servo: Servo;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ActuatorType>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ActuatorType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ActuatorType | undefined;
}
export type ActuatorType = ActuatorType.None | ActuatorType.Motor | ActuatorType.Servo;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult)
*/
export namespace AdAvailabilityResult {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#IsAvailable)
*/
export interface IsAvailable extends globalThis.EnumItem {
Name: "IsAvailable";
Value: 1;
EnumType: typeof globalThis.Enum.AdAvailabilityResult;
}
export const IsAvailable: IsAvailable;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#DeviceIneligible)
*/
export interface DeviceIneligible extends globalThis.EnumItem {
Name: "DeviceIneligible";
Value: 2;
EnumType: typeof globalThis.Enum.AdAvailabilityResult;
}
export const DeviceIneligible: DeviceIneligible;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#ExperienceIneligible)
*/
export interface ExperienceIneligible extends globalThis.EnumItem {
Name: "ExperienceIneligible";
Value: 3;
EnumType: typeof globalThis.Enum.AdAvailabilityResult;
}
export const ExperienceIneligible: ExperienceIneligible;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#InternalError)
*/
export interface InternalError extends globalThis.EnumItem {
Name: "InternalError";
Value: 4;
EnumType: typeof globalThis.Enum.AdAvailabilityResult;
}
export const InternalError: InternalError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#NoFill)
*/
export interface NoFill extends globalThis.EnumItem {
Name: "NoFill";
Value: 5;
EnumType: typeof globalThis.Enum.AdAvailabilityResult;
}
export const NoFill: NoFill;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#PlayerIneligible)
*/
export interface PlayerIneligible extends globalThis.EnumItem {
Name: "PlayerIneligible";
Value: 6;
EnumType: typeof globalThis.Enum.AdAvailabilityResult;
}
export const PlayerIneligible: PlayerIneligible;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#PublisherIneligible)
*/
export interface PublisherIneligible extends globalThis.EnumItem {
Name: "PublisherIneligible";
Value: 7;
EnumType: typeof globalThis.Enum.AdAvailabilityResult;
}
export const PublisherIneligible: PublisherIneligible;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AdAvailabilityResult>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AdAvailabilityResult | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AdAvailabilityResult | undefined;
}
export type AdAvailabilityResult = AdAvailabilityResult.IsAvailable | AdAvailabilityResult.DeviceIneligible | AdAvailabilityResult.ExperienceIneligible | AdAvailabilityResult.InternalError | AdAvailabilityResult.NoFill | AdAvailabilityResult.PlayerIneligible | AdAvailabilityResult.PublisherIneligible;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType)
*/
export namespace AdEventType {
/**
* The event is fired when a click-to-play video ads is being served. This can be used to communicate and promote the reward to users through the UI or signage.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdLoaded)
*/
export interface RewardedAdLoaded extends globalThis.EnumItem {
Name: "RewardedAdLoaded";
Value: 3;
EnumType: typeof globalThis.Enum.AdEventType;
}
export const RewardedAdLoaded: RewardedAdLoaded;
/**
* The event is fired when a user has watched the click-to-play video for a certain time. This can be used to grant the player a reward such as an in-game item or in-game currency. The RewardedAdGrant enum will only be triggered once per ad rotation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdGrant)
*/
export interface RewardedAdGrant extends globalThis.EnumItem {
Name: "RewardedAdGrant";
Value: 4;
EnumType: typeof globalThis.Enum.AdEventType;
}
export const RewardedAdGrant: RewardedAdGrant;
/**
* The event is fired when a click-to-play video ads is rotated out. This can be used to remove any UI or signage that is promoting the reward.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdUnloaded)
*/
export interface RewardedAdUnloaded extends globalThis.EnumItem {
Name: "RewardedAdUnloaded";
Value: 5;
EnumType: typeof globalThis.Enum.AdEventType;
}
export const RewardedAdUnloaded: RewardedAdUnloaded;
/**
* **Deprecated:** This option should not be used for new work.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#VideoLoaded)
*/
export interface VideoLoaded extends globalThis.EnumItem {
Name: "VideoLoaded";
Value: 0;
EnumType: typeof globalThis.Enum.AdEventType;
}
export const VideoLoaded: VideoLoaded;
/**
* **Deprecated:** This option should not be used for new work.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#VideoRemoved)
*/
export interface VideoRemoved extends globalThis.EnumItem {
Name: "VideoRemoved";
Value: 1;
EnumType: typeof globalThis.Enum.AdEventType;
}
export const VideoRemoved: VideoRemoved;
/**
* **Deprecated:** This option should not be used for new work.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#UserCompletedVideo)
*/
export interface UserCompletedVideo extends globalThis.EnumItem {
Name: "UserCompletedVideo";
Value: 2;
EnumType: typeof globalThis.Enum.AdEventType;
}
export const UserCompletedVideo: UserCompletedVideo;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AdEventType>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AdEventType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AdEventType | undefined;
}
export type AdEventType = AdEventType.RewardedAdLoaded | AdEventType.RewardedAdGrant | AdEventType.RewardedAdUnloaded | AdEventType.VideoLoaded | AdEventType.VideoRemoved | AdEventType.UserCompletedVideo;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdFormat)
*/
export namespace AdFormat {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdFormat#RewardedVideo)
*/
export interface RewardedVideo extends globalThis.EnumItem {
Name: "RewardedVideo";
Value: 0;
EnumType: typeof globalThis.Enum.AdFormat;
}
export const RewardedVideo: RewardedVideo;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AdFormat>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AdFormat | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AdFormat | undefined;
}
export type AdFormat = AdFormat.RewardedVideo;
/**
* Describes the form factor of an ad in an `AdGui`. There is currently only one available size.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdShape)
*/
export namespace AdShape {
/**
* The ad has an aspect ratio of 16:9 and a minimum size of 8 by 4.5 studs.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdShape#HorizontalRectangle)
*/
export interface HorizontalRectangle extends globalThis.EnumItem {
Name: "HorizontalRectangle";
Value: 1;
EnumType: typeof globalThis.Enum.AdShape;
}
export const HorizontalRectangle: HorizontalRectangle;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AdShape>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AdShape | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AdShape | undefined;
}
export type AdShape = AdShape.HorizontalRectangle;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod)
*/
export namespace AdTeleportMethod {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#Undefined)
*/
export interface Undefined extends globalThis.EnumItem {
Name: "Undefined";
Value: 0;
EnumType: typeof globalThis.Enum.AdTeleportMethod;
}
export const Undefined: Undefined;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#PortalForward)
*/
export interface PortalForward extends globalThis.EnumItem {
Name: "PortalForward";
Value: 1;
EnumType: typeof globalThis.Enum.AdTeleportMethod;
}
export const PortalForward: PortalForward;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#InGameMenuBackButton)
*/
export interface InGameMenuBackButton extends globalThis.EnumItem {
Name: "InGameMenuBackButton";
Value: 2;
EnumType: typeof globalThis.Enum.AdTeleportMethod;
}
export const InGameMenuBackButton: InGameMenuBackButton;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#UIBackButton)
*/
export interface UIBackButton extends globalThis.EnumItem {
Name: "UIBackButton";
Value: 3;
EnumType: typeof globalThis.Enum.AdTeleportMethod;
}
export const UIBackButton: UIBackButton;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AdTeleportMethod>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AdTeleportMethod | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AdTeleportMethod | undefined;
}
export type AdTeleportMethod = AdTeleportMethod.Undefined | AdTeleportMethod.PortalForward | AdTeleportMethod.InGameMenuBackButton | AdTeleportMethod.UIBackButton;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType)
*/
export namespace AdUIEventType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#AdLabelClicked)
*/
export interface AdLabelClicked extends globalThis.EnumItem {
Name: "AdLabelClicked";
Value: 0;
EnumType: typeof globalThis.Enum.AdUIEventType;
}
export const AdLabelClicked: AdLabelClicked;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#VolumeButtonClicked)
*/
export interface VolumeButtonClicked extends globalThis.EnumItem {
Name: "VolumeButtonClicked";
Value: 1;
EnumType: typeof globalThis.Enum.AdUIEventType;
}
export const VolumeButtonClicked: VolumeButtonClicked;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#FullscreenButtonClicked)
*/
export interface FullscreenButtonClicked extends globalThis.EnumItem {
Name: "FullscreenButtonClicked";
Value: 2;
EnumType: typeof globalThis.Enum.AdUIEventType;
}
export const FullscreenButtonClicked: FullscreenButtonClicked;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PlayButtonClicked)
*/
export interface PlayButtonClicked extends globalThis.EnumItem {
Name: "PlayButtonClicked";
Value: 3;
EnumType: typeof globalThis.Enum.AdUIEventType;
}
export const PlayButtonClicked: PlayButtonClicked;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PauseButtonClicked)
*/
export interface PauseButtonClicked extends globalThis.EnumItem {
Name: "PauseButtonClicked";
Value: 4;
EnumType: typeof globalThis.Enum.AdUIEventType;
}
export const PauseButtonClicked: PauseButtonClicked;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#CloseButtonClicked)
*/
export interface CloseButtonClicked extends globalThis.EnumItem {
Name: "CloseButtonClicked";
Value: 5;
EnumType: typeof globalThis.Enum.AdUIEventType;
}
export const CloseButtonClicked: CloseButtonClicked;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#WhyThisAdClicked)
*/
export interface WhyThisAdClicked extends globalThis.EnumItem {
Name: "WhyThisAdClicked";
Value: 6;
EnumType: typeof globalThis.Enum.AdUIEventType;
}
export const WhyThisAdClicked: WhyThisAdClicked;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PlayEventTriggered)
*/
export interface PlayEventTriggered extends globalThis.EnumItem {
Name: "PlayEventTriggered";
Value: 7;
EnumType: typeof globalThis.Enum.AdUIEventType;
}
export const PlayEventTriggered: PlayEventTriggered;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PauseEventTriggered)
*/
export interface PauseEventTriggered extends globalThis.EnumItem {
Name: "PauseEventTriggered";
Value: 8;
EnumType: typeof globalThis.Enum.AdUIEventType;
}
export const PauseEventTriggered: PauseEventTriggered;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AdUIEventType>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AdUIEventType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AdUIEventType | undefined;
}
export type AdUIEventType = AdUIEventType.AdLabelClicked | AdUIEventType.VolumeButtonClicked | AdUIEventType.FullscreenButtonClicked | AdUIEventType.PlayButtonClicked | AdUIEventType.PauseButtonClicked | AdUIEventType.CloseButtonClicked | AdUIEventType.WhyThisAdClicked | AdUIEventType.PlayEventTriggered | AdUIEventType.PauseEventTriggered;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType)
*/
export namespace AdUIType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.AdUIType;
}
export const None: None;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType#Image)
*/
export interface Image extends globalThis.EnumItem {
Name: "Image";
Value: 1;
EnumType: typeof globalThis.Enum.AdUIType;
}
export const Image: Image;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType#Video)
*/
export interface Video extends globalThis.EnumItem {
Name: "Video";
Value: 2;
EnumType: typeof globalThis.Enum.AdUIType;
}
export const Video: Video;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AdUIType>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AdUIType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AdUIType | undefined;
}
export type AdUIType = AdUIType.None | AdUIType.Image | AdUIType.Video;
/**
* Exposes the status of an immersive ad.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUnitStatus)
*/
export namespace AdUnitStatus {
/**
* The ad unit isn't currently serving an ad and it may be configured incorrectly. An `AdGui` with this status will display its fallback image.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUnitStatus#Inactive)
*/
export interface Inactive extends globalThis.EnumItem {
Name: "Inactive";
Value: 0;
EnumType: typeof globalThis.Enum.AdUnitStatus;
}
export const Inactive: Inactive;
/**
* The ad unit is currently serving an ad. Players will observe sponsored content in an `AdGui` and an `AdPortal` will teleport users that walk through.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUnitStatus#Active)
*/
export interface Active extends globalThis.EnumItem {
Name: "Active";
Value: 1;
EnumType: typeof globalThis.Enum.AdUnitStatus;
}
export const Active: Active;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AdUnitStatus>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AdUnitStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AdUnitStatus | undefined;
}
export type AdUnitStatus = AdUnitStatus.Inactive | AdUnitStatus.Active;
/**
* Culling method used for Adorns.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdornCullingMode)
*/
export namespace AdornCullingMode {
/**
* Automatically culls adornment based on distance.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdornCullingMode#Automatic)
*/
export interface Automatic extends globalThis.EnumItem {
Name: "Automatic";
Value: 0;
EnumType: typeof globalThis.Enum.AdornCullingMode;
}
export const Automatic: Automatic;
/**
* Never culls adornment. Adornment is always visible.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdornCullingMode#Never)
*/
export interface Never extends globalThis.EnumItem {
Name: "Never";
Value: 1;
EnumType: typeof globalThis.Enum.AdornCullingMode;
}
export const Never: Never;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AdornCullingMode>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AdornCullingMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AdornCullingMode | undefined;
}
export type AdornCullingMode = AdornCullingMode.Automatic | AdornCullingMode.Never;
/**
* An enum that specifies how the constraint will attempt to align the body associated with the constraint.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlignType)
*/
export namespace AlignType {
/**
* Aligns the primary axis to be parallel to the axis given by `Constraint.Attachment1`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlignType#PrimaryAxisParallel)
*/
export interface PrimaryAxisParallel extends globalThis.EnumItem {
Name: "PrimaryAxisParallel";
Value: 2;
EnumType: typeof globalThis.Enum.AlignType;
}
export const PrimaryAxisParallel: PrimaryAxisParallel;
/**
* Aligns the primary axis to be perpendicular to the axis given by `Constraint.Attachment1`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlignType#PrimaryAxisPerpendicular)
*/
export interface PrimaryAxisPerpendicular extends globalThis.EnumItem {
Name: "PrimaryAxisPerpendicular";
Value: 3;
EnumType: typeof globalThis.Enum.AlignType;
}
export const PrimaryAxisPerpendicular: PrimaryAxisPerpendicular;
/**
* Aligns the primary axis to look at the point given by `Constraint.Attachment1` or the `AlignOrientation.LookAtPosition`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlignType#PrimaryAxisLookAt)
*/
export interface PrimaryAxisLookAt extends globalThis.EnumItem {
Name: "PrimaryAxisLookAt";
Value: 4;
EnumType: typeof globalThis.Enum.AlignType;
}
export const PrimaryAxisLookAt: PrimaryAxisLookAt;
/**
* Aligns all of the axes of `Constraint.Attachment0` to the axes given by `Constraint.Attachment1` or to the target orientation provided by `AlignOrientation.PrimaryAxis` and `AlignOrientation.SecondaryAxis`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlignType#AllAxes)
*/
export interface AllAxes extends globalThis.EnumItem {
Name: "AllAxes";
Value: 5;
EnumType: typeof globalThis.Enum.AlignType;
}
export const AllAxes: AllAxes;
/**
* **Deprecated:** Use **PrimaryAxisParallel** instead.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlignType#Parallel)
*/
export interface Parallel extends globalThis.EnumItem {
Name: "Parallel";
Value: 0;
EnumType: typeof globalThis.Enum.AlignType;
}
export const Parallel: Parallel;
/**
* **Deprecated:** Use **PrimaryAxisPerpendicular** instead.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlignType#Perpendicular)
*/
export interface Perpendicular extends globalThis.EnumItem {
Name: "Perpendicular";
Value: 1;
EnumType: typeof globalThis.Enum.AlignType;
}
export const Perpendicular: Perpendicular;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AlignType>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AlignType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AlignType | undefined;
}
export type AlignType = AlignType.PrimaryAxisParallel | AlignType.PrimaryAxisPerpendicular | AlignType.PrimaryAxisLookAt | AlignType.AllAxes | AlignType.Parallel | AlignType.Perpendicular;
/**
* Used by `SurfaceAppearance.AlphaMode` to determine how the alpha channel of the `SurfaceAppearance.ColorMap` of a `SurfaceAppearance` is used.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlphaMode)
*/
export namespace AlphaMode {
/**
* Overlays the `ColorMap` on top of the underlying part color based on the map's alpha channel. 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlphaMode#Overlay)
*/
export interface Overlay extends globalThis.EnumItem {
Name: "Overlay";
Value: 0;
EnumType: typeof globalThis.Enum.AlphaMode;
}
export const Overlay: Overlay;
/**
* Uses the `ColorMap` alpha channel to control the transparency of the surface. 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlphaMode#Transparency)
*/
export interface Transparency extends globalThis.EnumItem {
Name: "Transparency";
Value: 1;
EnumType: typeof globalThis.Enum.AlphaMode;
}
export const Transparency: Transparency;
/**
* Uses the `ColorMap` alpha channel to control the amount of `SurfaceAppearance.Color` tinting.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlphaMode#TintMask)
*/
export interface TintMask extends globalThis.EnumItem {
Name: "TintMask";
Value: 2;
EnumType: typeof globalThis.Enum.AlphaMode;
}
export const TintMask: TintMask;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AlphaMode>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AlphaMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AlphaMode | undefined;
}
export type AlphaMode = AlphaMode.Overlay | AlphaMode.Transparency | AlphaMode.TintMask;
/**
* Used to form a dictionary of custom fields to provide breakdowns in Roblox-provided charts.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsCustomFieldKeys)
*/
export namespace AnalyticsCustomFieldKeys {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsCustomFieldKeys#CustomField01)
*/
export interface CustomField01 extends globalThis.EnumItem {
Name: "CustomField01";
Value: 0;
EnumType: typeof globalThis.Enum.AnalyticsCustomFieldKeys;
}
export const CustomField01: CustomField01;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsCustomFieldKeys#CustomField02)
*/
export interface CustomField02 extends globalThis.EnumItem {
Name: "CustomField02";
Value: 1;
EnumType: typeof globalThis.Enum.AnalyticsCustomFieldKeys;
}
export const CustomField02: CustomField02;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsCustomFieldKeys#CustomField03)
*/
export interface CustomField03 extends globalThis.EnumItem {
Name: "CustomField03";
Value: 2;
EnumType: typeof globalThis.Enum.AnalyticsCustomFieldKeys;
}
export const CustomField03: CustomField03;
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AnalyticsCustomFieldKeys>;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnalyticsCustomFieldKeys | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnalyticsCustomFieldKeys | undefined;
}
export type AnalyticsCustomFieldKeys = AnalyticsCustomFieldKeys.CustomField01 | AnalyticsCustomFieldKeys.CustomField02 | AnalyticsCustomFieldKeys.CustomField03;
/**
* [Creator Hub](https://create.roblox.com/docs/