// THIS FILE IS GENERATED AUTOMATICALLY AND SHOULD NOT BE EDITED BY HAND!
///
///
// GENERATED ROBLOX ENUMS
type Enums = typeof Enum;
interface EnumItem {
Name: string;
Value: number;
EnumType: Enum;
IsA>(name: T): this is (typeof Enum)[T][Exclude];
}
interface Enum {
GetEnumItems(this: Enum): Array;
FromName(this: Enum, name: string): EnumItem | undefined;
FromValue(this: Enum, value: number): EnumItem | undefined;
}
declare namespace Enum {
export function GetEnums(this: Enums): Array;
/**
* Determines whether an `AudioDeviceInput` user ID access list acts as an allow-list or a deny-list.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AccessModifierType)
*/
export namespace AccessModifierType {
/**
* User IDs in the access list are permitted to hear the `AudioDeviceInput` - all other users are blocked.
*
* [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;
/**
* User IDs in the access list are blocked from hearing the `AudioDeviceInput` - all other users are permitted.
*
* [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;
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;
/**
* A layered accessory for avatar eyebrows.
*
* [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;
/**
* A layered accessory for avatar eyelashes.
*
* [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;
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;
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;
/**
* Specifies how Roblox Studio handles local files when file sync stops.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionOnStopSync)
*/
export namespace ActionOnStopSync {
/**
* Prompts before deleting local files when file sync stops.
*
* [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;
/**
* Keeps local files when file sync stops.
*
* [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;
/**
* Deletes local files when file sync stops.
*
* [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;
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;
/**
* Describes the outcome of a game action, such as winning, losing, or drawing.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActionType)
*/
export namespace ActionType {
/**
* No specific game action occurred.
*
* [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;
/**
* The game or round was paused.
*
* [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;
/**
* The player lost the game or round.
*
* [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;
/**
* The game or round ended in a draw with no winner.
*
* [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;
/**
* The player won the game or round.
*
* [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;
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;
/**
* Describes a player's payer status bucket for the current experience.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActivePayerStatus)
*/
export namespace ActivePayerStatus {
/**
* Segment data is unavailable.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActivePayerStatus#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.ActivePayerStatus;
}
export const Unknown: Unknown;
/**
* The player has not made a qualifying purchase in the experience.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActivePayerStatus#Never)
*/
export interface Never extends globalThis.EnumItem {
Name: "Never";
Value: 1;
EnumType: typeof globalThis.Enum.ActivePayerStatus;
}
export const Never: Never;
/**
* The player has previously spent in the experience but is not currently an active payer.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActivePayerStatus#Lapsed)
*/
export interface Lapsed extends globalThis.EnumItem {
Name: "Lapsed";
Value: 2;
EnumType: typeof globalThis.Enum.ActivePayerStatus;
}
export const Lapsed: Lapsed;
/**
* The player is in the casual payer bucket for the experience.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActivePayerStatus#Casual50Percent)
*/
export interface Casual50Percent extends globalThis.EnumItem {
Name: "Casual50Percent";
Value: 3;
EnumType: typeof globalThis.Enum.ActivePayerStatus;
}
export const Casual50Percent: Casual50Percent;
/**
* The player is in the intermediate payer bucket for the experience.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActivePayerStatus#Intermediate35Percent)
*/
export interface Intermediate35Percent extends globalThis.EnumItem {
Name: "Intermediate35Percent";
Value: 4;
EnumType: typeof globalThis.Enum.ActivePayerStatus;
}
export const Intermediate35Percent: Intermediate35Percent;
/**
* The player is in the top payer bucket for the experience.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActivePayerStatus#Top15Percent)
*/
export interface Top15Percent extends globalThis.EnumItem {
Name: "Top15Percent";
Value: 5;
EnumType: typeof globalThis.Enum.ActivePayerStatus;
}
export const Top15Percent: Top15Percent;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ActivePayerStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ActivePayerStatus | undefined;
}
export type ActivePayerStatus = ActivePayerStatus.Unknown | ActivePayerStatus.Never | ActivePayerStatus.Lapsed | ActivePayerStatus.Casual50Percent | ActivePayerStatus.Intermediate35Percent | ActivePayerStatus.Top15Percent;
/**
* Determines the coordinate frame in which a mover constraint's directional properties are expressed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ActuatorRelativeTo)
*/
export namespace ActuatorRelativeTo {
/**
* The directional property is interpreted in the local coordinate frame of `Attachment0`, rotating with its parent part.
*
* [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 directional property is interpreted in the local coordinate frame of `Attachment1`, rotating with its parent part.
*
* [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 directional property is interpreted in world-space coordinates, remaining constant regardless of part orientation.
*
* [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;
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;
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;
/**
* Indicates whether an ad is available or the reason it cannot be shown.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult)
*/
export namespace AdAvailabilityResult {
/**
* An ad is available to show the user.
*
* [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;
/**
* The device is ineligible to receive ads.
*
* [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;
/**
* The experience is ineligible to receive ads. Check if its eligibility has been revoked.
*
* [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;
/**
* An unspecified internal error occurred. Try fetching the ad again.
*
* [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;
/**
* There are no ads available to fill your ad request. You might have hit the ad frequency limit.
*
* [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;
/**
* The user is ineligible to receive ads during this session. The user might be under 13 or located in a blocked region.
*
* [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;
/**
* The publisher is ineligible to receive ads because they have not met the publisher eligibility requirements.
*
* [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;
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 {
/**
* [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;
/**
* [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;
/**
* [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;
/**
* [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;
/**
* [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;
/**
* [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;
export function GetEnumItems(this: globalThis.Enum): Array;
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.VideoLoaded | AdEventType.VideoRemoved | AdEventType.UserCompletedVideo | AdEventType.RewardedAdLoaded | AdEventType.RewardedAdGrant | AdEventType.RewardedAdUnloaded;
/**
* Specifies the format of an ad used with `AdService` methods.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdFormat)
*/
export namespace AdFormat {
/**
* A full-screen video ad that plays to completion and rewards the viewer, used as the `adFormat` argument for `AdService` methods.
*
* [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;
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;
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;
/**
* Describes the method by which a player teleports during an immersive ad portal flow.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod)
*/
export namespace AdTeleportMethod {
/**
* Default uninitialized sentinel value indicating that no teleport method has been determined yet.
*
* [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;
/**
* The player teleported forward to the advertiser's destination experience by walking into an `AdPortal`.
*
* [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;
/**
* The player initiated a return teleport to the publisher's experience by pressing the back button in the in-game menu.
*
* [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;
/**
* The player initiated a return teleport to the publisher's experience by pressing a back button rendered in the ad destination's UI overlay.
*
* [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;
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;
/**
* Describes the type of user-interaction or system event that occurred on the immersive ad UI overlay of an `AdGui`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType)
*/
export namespace AdUIEventType {
/**
* The player clicked the "Sponsored" label on the ad overlay, which opens the ad disclosure prompt showing advertiser and payer information.
*
* [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;
/**
* The player clicked the volume toggle button on the ad overlay, which mutes or unmutes the video ad audio.
*
* [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;
/**
* The player clicked the fullscreen toggle button, which smoothly zooms the camera to a centered view of the ad surface and enables audio.
*
* [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;
/**
* 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.
*
* [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;
/**
* The player clicked the pause button while a video ad is playing in fullscreen mode, which pauses video playback.
*
* [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;
/**
* The player clicked the close button on the fullscreen video ad view, which exits fullscreen mode and returns to the normal camera position.
*
* [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;
/**
* 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.
*
* [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;
/**
* A system-initiated play/resume event that clears the force-pause state and resumes video playback if the stream is open.
*
* [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;
/**
* 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 system event clears that pause.
*
* [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;
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;
/**
* Describes the type of ad creative currently rendered by an `AdGui`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType)
*/
export namespace AdUIType {
/**
* The `AdGui` has no ad creative loaded and is not rendering ad content.
*
* [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;
/**
* The `AdGui` is rendering a static image ad creative.
*
* [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;
/**
* The `AdGui` is rendering a video ad creative.
*
* [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;
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;
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 adornments.
*
* [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;
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;
/**
* Determines the shading material and render pass used to draw a handle adornment.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdornShading)
*/
export namespace AdornShading {
/**
* Draws the adornment unlit and occluded by scene geometry like an ordinary world object.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdornShading#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.AdornShading;
}
export const Default: Default;
/**
* Draws the adornment lit by scene lighting and occluded by scene geometry.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdornShading#Shaded)
*/
export interface Shaded extends globalThis.EnumItem {
Name: "Shaded";
Value: 1;
EnumType: typeof globalThis.Enum.AdornShading;
}
export const Shaded: Shaded;
/**
* Draws the adornment unlit and visible through geometry that would otherwise occlude it.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdornShading#XRay)
*/
export interface XRay extends globalThis.EnumItem {
Name: "XRay";
Value: 2;
EnumType: typeof globalThis.Enum.AdornShading;
}
export const XRay: XRay;
/**
* Draws the adornment lit by scene lighting and visible through geometry that would otherwise occlude it.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdornShading#XRayShaded)
*/
export interface XRayShaded extends globalThis.EnumItem {
Name: "XRayShaded";
Value: 3;
EnumType: typeof globalThis.Enum.AdornShading;
}
export const XRayShaded: XRayShaded;
/**
* Draws the adornment unlit on top of all other geometry with no depth testing.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdornShading#AlwaysOnTop)
*/
export interface AlwaysOnTop extends globalThis.EnumItem {
Name: "AlwaysOnTop";
Value: 4;
EnumType: typeof globalThis.Enum.AdornShading;
}
export const AlwaysOnTop: AlwaysOnTop;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AdornShading | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AdornShading | undefined;
}
export type AdornShading = AdornShading.Default | AdornShading.Shaded | AdornShading.XRay | AdornShading.XRayShaded | AdornShading.AlwaysOnTop;
/**
* Indicates whether a player has completed age verification.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AgeCheckStatus)
*/
export namespace AgeCheckStatus {
/**
* The player has not yet completed age verification.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AgeCheckStatus#Unchecked)
*/
export interface Unchecked extends globalThis.EnumItem {
Name: "Unchecked";
Value: 0;
EnumType: typeof globalThis.Enum.AgeCheckStatus;
}
export const Unchecked: Unchecked;
/**
* The player has successfully completed age verification.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AgeCheckStatus#Checked)
*/
export interface Checked extends globalThis.EnumItem {
Name: "Checked";
Value: 1;
EnumType: typeof globalThis.Enum.AgeCheckStatus;
}
export const Checked: Checked;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AgeCheckStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AgeCheckStatus | undefined;
}
export type AgeCheckStatus = AgeCheckStatus.Unchecked | AgeCheckStatus.Checked;
/**
* 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 {
/**
* **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;
/**
* 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;
export function GetEnumItems(this: globalThis.Enum): Array;
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.Parallel | AlignType.Perpendicular | AlignType.PrimaryAxisParallel | AlignType.PrimaryAxisPerpendicular | AlignType.PrimaryAxisLookAt | AlignType.AllAxes;
/**
* 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;
/**
* Ignores the `ColorMap` alpha channel and assumes an opacity value of 1 everywhere.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlphaMode#Opaque)
*/
export interface Opaque extends globalThis.EnumItem {
Name: "Opaque";
Value: 3;
EnumType: typeof globalThis.Enum.AlphaMode;
}
export const Opaque: Opaque;
export function GetEnumItems(this: globalThis.Enum): Array;
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 | AlphaMode.Opaque;
/**
* 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 {
/**
* The first custom field key, used to provide a breakdown dimension in Roblox-provided analytics charts.
*
* [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;
/**
* The second custom field key, used to provide a breakdown dimension in Roblox-provided analytics charts.
*
* [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;
/**
* The third custom field key, used to provide a breakdown dimension in Roblox-provided analytics charts.
*
* [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;
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;
/**
* Describes the type of economic transaction in `AnalyticsService:FireInGameEconomyEvent()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyAction)
*/
export namespace AnalyticsEconomyAction {
/**
* Default action. Used for an undefined Action.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyAction#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.AnalyticsEconomyAction;
}
export const Default: Default;
/**
* Indicates the acquisition of an in game resource. For example, a player acquires virtual currency by completing a specific in game task.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyAction#Acquire)
*/
export interface Acquire extends globalThis.EnumItem {
Name: "Acquire";
Value: 1;
EnumType: typeof globalThis.Enum.AnalyticsEconomyAction;
}
export const Acquire: Acquire;
/**
* Indicates the spending or loss of an in game resource. For example, a player spends virtual currency to acquire a new item.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyAction#Spend)
*/
export interface Spend extends globalThis.EnumItem {
Name: "Spend";
Value: 2;
EnumType: typeof globalThis.Enum.AnalyticsEconomyAction;
}
export const Spend: Spend;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnalyticsEconomyAction | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnalyticsEconomyAction | undefined;
}
export type AnalyticsEconomyAction = AnalyticsEconomyAction.Default | AnalyticsEconomyAction.Acquire | AnalyticsEconomyAction.Spend;
/**
* Specifies the direction of currency flow in an economy event logged by `AnalyticsService:LogEconomyEvent()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyFlowType)
*/
export namespace AnalyticsEconomyFlowType {
/**
* Currency is being removed from the player's account.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyFlowType#Sink)
*/
export interface Sink extends globalThis.EnumItem {
Name: "Sink";
Value: 0;
EnumType: typeof globalThis.Enum.AnalyticsEconomyFlowType;
}
export const Sink: Sink;
/**
* Currency is being added to the player's account.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyFlowType#Source)
*/
export interface Source extends globalThis.EnumItem {
Name: "Source";
Value: 1;
EnumType: typeof globalThis.Enum.AnalyticsEconomyFlowType;
}
export const Source: Source;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnalyticsEconomyFlowType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnalyticsEconomyFlowType | undefined;
}
export type AnalyticsEconomyFlowType = AnalyticsEconomyFlowType.Sink | AnalyticsEconomyFlowType.Source;
/**
* Categorizes the context of an in-experience economic transaction for use with `AnalyticsService:LogEconomyEvent()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType)
*/
export namespace AnalyticsEconomyTransactionType {
/**
* Represents a source of currency purchased via Robux, for example in-experience "gold" purchased for Robux.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#IAP)
*/
export interface IAP extends globalThis.EnumItem {
Name: "IAP";
Value: 0;
EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
}
export const IAP: IAP;
/**
* Purchases within a shop, for example in-experience "coins" used to buy an item within the experience.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#Shop)
*/
export interface Shop extends globalThis.EnumItem {
Name: "Shop";
Value: 1;
EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
}
export const Shop: Shop;
/**
* Currency earned or paid through gameplay, for example in-experience "gold" earned from winning a match.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#Gameplay)
*/
export interface Gameplay extends globalThis.EnumItem {
Name: "Gameplay";
Value: 2;
EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
}
export const Gameplay: Gameplay;
/**
* Purchase with direct context to a reward, for example in-experience "gold" used to purchase an extra life.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#ContextualPurchase)
*/
export interface ContextualPurchase extends globalThis.EnumItem {
Name: "ContextualPurchase";
Value: 3;
EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
}
export const ContextualPurchase: ContextualPurchase;
/**
* Time-based reward, for example in-experience "gold" rewarded for logging in daily.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#TimedReward)
*/
export interface TimedReward extends globalThis.EnumItem {
Name: "TimedReward";
Value: 4;
EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
}
export const TimedReward: TimedReward;
/**
* Transaction related to onboarding, for example in-experience "gold" rewarded for completing the tutorial.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#Onboarding)
*/
export interface Onboarding extends globalThis.EnumItem {
Name: "Onboarding";
Value: 5;
EnumType: typeof globalThis.Enum.AnalyticsEconomyTransactionType;
}
export const Onboarding: Onboarding;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnalyticsEconomyTransactionType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnalyticsEconomyTransactionType | undefined;
}
export type AnalyticsEconomyTransactionType = AnalyticsEconomyTransactionType.IAP | AnalyticsEconomyTransactionType.Shop | AnalyticsEconomyTransactionType.Gameplay | AnalyticsEconomyTransactionType.ContextualPurchase | AnalyticsEconomyTransactionType.TimedReward | AnalyticsEconomyTransactionType.Onboarding;
/**
* Specifies the severity level of an analytics log event passed to `AnalyticsService:FireLogEvent()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel)
*/
export namespace AnalyticsLogLevel {
/**
* Trace is the noisiest level, rarely (if ever) enabled for a production app.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Trace)
*/
export interface Trace extends globalThis.EnumItem {
Name: "Trace";
Value: 0;
EnumType: typeof globalThis.Enum.AnalyticsLogLevel;
}
export const Trace: Trace;
/**
* Used for debugging.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Debug)
*/
export interface Debug extends globalThis.EnumItem {
Name: "Debug";
Value: 1;
EnumType: typeof globalThis.Enum.AnalyticsLogLevel;
}
export const Debug: Debug;
/**
* Used for general informational messages that highlight progress or state changes during normal operation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Information)
*/
export interface Information extends globalThis.EnumItem {
Name: "Information";
Value: 2;
EnumType: typeof globalThis.Enum.AnalyticsLogLevel;
}
export const Information: Information;
/**
* Used for warning.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Warning)
*/
export interface Warning extends globalThis.EnumItem {
Name: "Warning";
Value: 3;
EnumType: typeof globalThis.Enum.AnalyticsLogLevel;
}
export const Warning: Warning;
/**
* When functionality is unavailable or expectations broken.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Error)
*/
export interface Error extends globalThis.EnumItem {
Name: "Error";
Value: 4;
EnumType: typeof globalThis.Enum.AnalyticsLogLevel;
}
export const Error: Error;
/**
* The most critical level, Fatal events demand immediate attention.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Fatal)
*/
export interface Fatal extends globalThis.EnumItem {
Name: "Fatal";
Value: 5;
EnumType: typeof globalThis.Enum.AnalyticsLogLevel;
}
export const Fatal: Fatal;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnalyticsLogLevel | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnalyticsLogLevel | undefined;
}
export type AnalyticsLogLevel = AnalyticsLogLevel.Trace | AnalyticsLogLevel.Debug | AnalyticsLogLevel.Information | AnalyticsLogLevel.Warning | AnalyticsLogLevel.Error | AnalyticsLogLevel.Fatal;
/**
* This enum is used as an argument in `AnalyticsService:FirePlayerProgressionEvent()` to describe the status of progression.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus)
*/
export namespace AnalyticsProgressionStatus {
/**
* Default status. Used for an undefined status.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.AnalyticsProgressionStatus;
}
export const Default: Default;
/**
* Indicates the beginning of progression.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus#Begin)
*/
export interface Begin extends globalThis.EnumItem {
Name: "Begin";
Value: 1;
EnumType: typeof globalThis.Enum.AnalyticsProgressionStatus;
}
export const Begin: Begin;
/**
* Indicates the progression completed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus#Complete)
*/
export interface Complete extends globalThis.EnumItem {
Name: "Complete";
Value: 2;
EnumType: typeof globalThis.Enum.AnalyticsProgressionStatus;
}
export const Complete: Complete;
/**
* Indicates the progression abandoned.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus#Abandon)
*/
export interface Abandon extends globalThis.EnumItem {
Name: "Abandon";
Value: 3;
EnumType: typeof globalThis.Enum.AnalyticsProgressionStatus;
}
export const Abandon: Abandon;
/**
* Indicates the progression failed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus#Fail)
*/
export interface Fail extends globalThis.EnumItem {
Name: "Fail";
Value: 4;
EnumType: typeof globalThis.Enum.AnalyticsProgressionStatus;
}
export const Fail: Fail;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnalyticsProgressionStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnalyticsProgressionStatus | undefined;
}
export type AnalyticsProgressionStatus = AnalyticsProgressionStatus.Default | AnalyticsProgressionStatus.Begin | AnalyticsProgressionStatus.Complete | AnalyticsProgressionStatus.Abandon | AnalyticsProgressionStatus.Fail;
/**
* Specifies the player's progression status in a level-progression event logged by `AnalyticsService:LogProgressionEvent()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionType)
*/
export namespace AnalyticsProgressionType {
/**
* A custom progression status for events outside the standard start/fail/complete lifecycle.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionType#Custom)
*/
export interface Custom extends globalThis.EnumItem {
Name: "Custom";
Value: 0;
EnumType: typeof globalThis.Enum.AnalyticsProgressionType;
}
export const Custom: Custom;
/**
* The player started the level attempt.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionType#Start)
*/
export interface Start extends globalThis.EnumItem {
Name: "Start";
Value: 1;
EnumType: typeof globalThis.Enum.AnalyticsProgressionType;
}
export const Start: Start;
/**
* The player failed the level attempt.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionType#Fail)
*/
export interface Fail extends globalThis.EnumItem {
Name: "Fail";
Value: 2;
EnumType: typeof globalThis.Enum.AnalyticsProgressionType;
}
export const Fail: Fail;
/**
* The player completed the level successfully.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionType#Complete)
*/
export interface Complete extends globalThis.EnumItem {
Name: "Complete";
Value: 3;
EnumType: typeof globalThis.Enum.AnalyticsProgressionType;
}
export const Complete: Complete;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnalyticsProgressionType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnalyticsProgressionType | undefined;
}
export type AnalyticsProgressionType = AnalyticsProgressionType.Custom | AnalyticsProgressionType.Start | AnalyticsProgressionType.Fail | AnalyticsProgressionType.Complete;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatedImagePlaybackState)
*/
export namespace AnimatedImagePlaybackState {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatedImagePlaybackState#Begin)
*/
export interface Begin extends globalThis.EnumItem {
Name: "Begin";
Value: 0;
EnumType: typeof globalThis.Enum.AnimatedImagePlaybackState;
}
export const Begin: Begin;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatedImagePlaybackState#Playing)
*/
export interface Playing extends globalThis.EnumItem {
Name: "Playing";
Value: 1;
EnumType: typeof globalThis.Enum.AnimatedImagePlaybackState;
}
export const Playing: Playing;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatedImagePlaybackState#Paused)
*/
export interface Paused extends globalThis.EnumItem {
Name: "Paused";
Value: 2;
EnumType: typeof globalThis.Enum.AnimatedImagePlaybackState;
}
export const Paused: Paused;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatedImagePlaybackState#Completed)
*/
export interface Completed extends globalThis.EnumItem {
Name: "Completed";
Value: 3;
EnumType: typeof globalThis.Enum.AnimatedImagePlaybackState;
}
export const Completed: Completed;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatedImagePlaybackState#Canceled)
*/
export interface Canceled extends globalThis.EnumItem {
Name: "Canceled";
Value: 4;
EnumType: typeof globalThis.Enum.AnimatedImagePlaybackState;
}
export const Canceled: Canceled;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimatedImagePlaybackState | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimatedImagePlaybackState | undefined;
}
export type AnimatedImagePlaybackState = AnimatedImagePlaybackState.Begin | AnimatedImagePlaybackState.Playing | AnimatedImagePlaybackState.Paused | AnimatedImagePlaybackState.Completed | AnimatedImagePlaybackState.Canceled;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatedImageScaleType)
*/
export namespace AnimatedImageScaleType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatedImageScaleType#Stretch)
*/
export interface Stretch extends globalThis.EnumItem {
Name: "Stretch";
Value: 0;
EnumType: typeof globalThis.Enum.AnimatedImageScaleType;
}
export const Stretch: Stretch;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatedImageScaleType#Tile)
*/
export interface Tile extends globalThis.EnumItem {
Name: "Tile";
Value: 1;
EnumType: typeof globalThis.Enum.AnimatedImageScaleType;
}
export const Tile: Tile;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatedImageScaleType#Fit)
*/
export interface Fit extends globalThis.EnumItem {
Name: "Fit";
Value: 2;
EnumType: typeof globalThis.Enum.AnimatedImageScaleType;
}
export const Fit: Fit;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatedImageScaleType#Crop)
*/
export interface Crop extends globalThis.EnumItem {
Name: "Crop";
Value: 3;
EnumType: typeof globalThis.Enum.AnimatedImageScaleType;
}
export const Crop: Crop;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimatedImageScaleType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimatedImageScaleType | undefined;
}
export type AnimatedImageScaleType = AnimatedImageScaleType.Stretch | AnimatedImageScaleType.Tile | AnimatedImageScaleType.Fit | AnimatedImageScaleType.Crop;
/**
* Indicates the current status or final outcome of a video-to-animation conversion started by `AssetService:PromptImportAnimationClipFromVideoAsync()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus)
*/
export namespace AnimationClipFromVideoStatus {
/**
* The video-to-animation job is being set up on the server.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Initializing)
*/
export interface Initializing extends globalThis.EnumItem {
Name: "Initializing";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const Initializing: Initializing;
/**
* The job has been queued on the server and is waiting for processing resources to become available.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Pending)
*/
export interface Pending extends globalThis.EnumItem {
Name: "Pending";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const Pending: Pending;
/**
* The server is actively analyzing the video and extracting motion-capture data to generate the animation clip.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Processing)
*/
export interface Processing extends globalThis.EnumItem {
Name: "Processing";
Value: 2;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const Processing: Processing;
/**
* The server-side video processing encountered an unspecified error.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorGeneric)
*/
export interface ErrorGeneric extends globalThis.EnumItem {
Name: "ErrorGeneric";
Value: 4;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const ErrorGeneric: ErrorGeneric;
/**
* The video was successfully converted into an `AnimationClip`, which is returned as the second element of the result tuple.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Success)
*/
export interface Success extends globalThis.EnumItem {
Name: "Success";
Value: 6;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const Success: Success;
/**
* Processing failed because the uploaded video exceeds the maximum allowed duration (15 seconds).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorVideoTooLong)
*/
export interface ErrorVideoTooLong extends globalThis.EnumItem {
Name: "ErrorVideoTooLong";
Value: 7;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const ErrorVideoTooLong: ErrorVideoTooLong;
/**
* Processing failed because no person could be detected in the video; the video must show a person fully in frame, facing the camera.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorNoPersonDetected)
*/
export interface ErrorNoPersonDetected extends globalThis.EnumItem {
Name: "ErrorNoPersonDetected";
Value: 8;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const ErrorNoPersonDetected: ErrorNoPersonDetected;
/**
* Processing failed because the video is too shaky for reliable motion capture; a more stable recording is required.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorVideoUnstable)
*/
export interface ErrorVideoUnstable extends globalThis.EnumItem {
Name: "ErrorVideoUnstable";
Value: 9;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const ErrorVideoUnstable: ErrorVideoUnstable;
/**
* Processing could not be completed in time, typically due to high request volume on the video processing backend.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Timeout)
*/
export interface Timeout extends globalThis.EnumItem {
Name: "Timeout";
Value: 10;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const Timeout: Timeout;
/**
* The player declined the consent prompt or provided no input, so the video upload was not started.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Cancelled)
*/
export interface Cancelled extends globalThis.EnumItem {
Name: "Cancelled";
Value: 11;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const Cancelled: Cancelled;
/**
* Processing failed because more than one person was detected in the video; the video must contain a single person fully in frame.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorMultiplePeople)
*/
export interface ErrorMultiplePeople extends globalThis.EnumItem {
Name: "ErrorMultiplePeople";
Value: 12;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const ErrorMultiplePeople: ErrorMultiplePeople;
/**
* The client-side video upload failed before the video reached the processing backend.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorUploadingVideo)
*/
export interface ErrorUploadingVideo extends globalThis.EnumItem {
Name: "ErrorUploadingVideo";
Value: 2001;
EnumType: typeof globalThis.Enum.AnimationClipFromVideoStatus;
}
export const ErrorUploadingVideo: ErrorUploadingVideo;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationClipFromVideoStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationClipFromVideoStatus | undefined;
}
export type AnimationClipFromVideoStatus = AnimationClipFromVideoStatus.Initializing | AnimationClipFromVideoStatus.Pending | AnimationClipFromVideoStatus.Processing | AnimationClipFromVideoStatus.ErrorGeneric | AnimationClipFromVideoStatus.Success | AnimationClipFromVideoStatus.ErrorVideoTooLong | AnimationClipFromVideoStatus.ErrorNoPersonDetected | AnimationClipFromVideoStatus.ErrorVideoUnstable | AnimationClipFromVideoStatus.Timeout | AnimationClipFromVideoStatus.Cancelled | AnimationClipFromVideoStatus.ErrorMultiplePeople | AnimationClipFromVideoStatus.ErrorUploadingVideo;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeBlend2DInputMode)
*/
export namespace AnimationNodeBlend2DInputMode {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeBlend2DInputMode#Cartesian)
*/
export interface Cartesian extends globalThis.EnumItem {
Name: "Cartesian";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationNodeBlend2DInputMode;
}
export const Cartesian: Cartesian;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeBlend2DInputMode#Polar)
*/
export interface Polar extends globalThis.EnumItem {
Name: "Polar";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationNodeBlend2DInputMode;
}
export const Polar: Polar;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodeBlend2DInputMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodeBlend2DInputMode | undefined;
}
export type AnimationNodeBlend2DInputMode = AnimationNodeBlend2DInputMode.Cartesian | AnimationNodeBlend2DInputMode.Polar;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeBlendMode)
*/
export namespace AnimationNodeBlendMode {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeBlendMode#Over)
*/
export interface Over extends globalThis.EnumItem {
Name: "Over";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationNodeBlendMode;
}
export const Over: Over;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeBlendMode#Add)
*/
export interface Add extends globalThis.EnumItem {
Name: "Add";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationNodeBlendMode;
}
export const Add: Add;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeBlendMode#Subtract)
*/
export interface Subtract extends globalThis.EnumItem {
Name: "Subtract";
Value: 2;
EnumType: typeof globalThis.Enum.AnimationNodeBlendMode;
}
export const Subtract: Subtract;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodeBlendMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodeBlendMode | undefined;
}
export type AnimationNodeBlendMode = AnimationNodeBlendMode.Over | AnimationNodeBlendMode.Add | AnimationNodeBlendMode.Subtract;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeInterruptible)
*/
export namespace AnimationNodeInterruptible {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeInterruptible#Always)
*/
export interface Always extends globalThis.EnumItem {
Name: "Always";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationNodeInterruptible;
}
export const Always: Always;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeInterruptible#Finished)
*/
export interface Finished extends globalThis.EnumItem {
Name: "Finished";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationNodeInterruptible;
}
export const Finished: Finished;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeInterruptible#Trigger)
*/
export interface Trigger extends globalThis.EnumItem {
Name: "Trigger";
Value: 2;
EnumType: typeof globalThis.Enum.AnimationNodeInterruptible;
}
export const Trigger: Trigger;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodeInterruptible | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodeInterruptible | undefined;
}
export type AnimationNodeInterruptible = AnimationNodeInterruptible.Always | AnimationNodeInterruptible.Finished | AnimationNodeInterruptible.Trigger;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePhaseSync)
*/
export namespace AnimationNodePhaseSync {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePhaseSync#Synced)
*/
export interface Synced extends globalThis.EnumItem {
Name: "Synced";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationNodePhaseSync;
}
export const Synced: Synced;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePhaseSync#Unsynced)
*/
export interface Unsynced extends globalThis.EnumItem {
Name: "Unsynced";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationNodePhaseSync;
}
export const Unsynced: Unsynced;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodePhaseSync | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodePhaseSync | undefined;
}
export type AnimationNodePhaseSync = AnimationNodePhaseSync.Synced | AnimationNodePhaseSync.Unsynced;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePlayMode)
*/
export namespace AnimationNodePlayMode {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePlayMode#Loop)
*/
export interface Loop extends globalThis.EnumItem {
Name: "Loop";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationNodePlayMode;
}
export const Loop: Loop;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePlayMode#PingPong)
*/
export interface PingPong extends globalThis.EnumItem {
Name: "PingPong";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationNodePlayMode;
}
export const PingPong: PingPong;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePlayMode#OnceAndHold)
*/
export interface OnceAndHold extends globalThis.EnumItem {
Name: "OnceAndHold";
Value: 2;
EnumType: typeof globalThis.Enum.AnimationNodePlayMode;
}
export const OnceAndHold: OnceAndHold;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePlayMode#OnceAndReset)
*/
export interface OnceAndReset extends globalThis.EnumItem {
Name: "OnceAndReset";
Value: 3;
EnumType: typeof globalThis.Enum.AnimationNodePlayMode;
}
export const OnceAndReset: OnceAndReset;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodePlayMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodePlayMode | undefined;
}
export type AnimationNodePlayMode = AnimationNodePlayMode.Loop | AnimationNodePlayMode.PingPong | AnimationNodePlayMode.OnceAndHold | AnimationNodePlayMode.OnceAndReset;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionType)
*/
export namespace AnimationNodeTransitionType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionType#CrossFade)
*/
export interface CrossFade extends globalThis.EnumItem {
Name: "CrossFade";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationNodeTransitionType;
}
export const CrossFade: CrossFade;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionType#InertialBlend)
*/
export interface InertialBlend extends globalThis.EnumItem {
Name: "InertialBlend";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationNodeTransitionType;
}
export const InertialBlend: InertialBlend;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionType#DeadBlend)
*/
export interface DeadBlend extends globalThis.EnumItem {
Name: "DeadBlend";
Value: 2;
EnumType: typeof globalThis.Enum.AnimationNodeTransitionType;
}
export const DeadBlend: DeadBlend;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodeTransitionType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodeTransitionType | undefined;
}
export type AnimationNodeTransitionType = AnimationNodeTransitionType.CrossFade | AnimationNodeTransitionType.InertialBlend | AnimationNodeTransitionType.DeadBlend;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionWhen)
*/
export namespace AnimationNodeTransitionWhen {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionWhen#Finished)
*/
export interface Finished extends globalThis.EnumItem {
Name: "Finished";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationNodeTransitionWhen;
}
export const Finished: Finished;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionWhen#BeforeFinished)
*/
export interface BeforeFinished extends globalThis.EnumItem {
Name: "BeforeFinished";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationNodeTransitionWhen;
}
export const BeforeFinished: BeforeFinished;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodeTransitionWhen | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodeTransitionWhen | undefined;
}
export type AnimationNodeTransitionWhen = AnimationNodeTransitionWhen.Finished | AnimationNodeTransitionWhen.BeforeFinished;
/**
* Specifies the type of an animation graph node, determining how it processes or combines animation data.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType)
*/
export namespace AnimationNodeType {
/**
* The default unassigned type indicating a node has not been configured.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#InvalidNode)
*/
export interface InvalidNode extends globalThis.EnumItem {
Name: "InvalidNode";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const InvalidNode: InvalidNode;
/**
* An additive blend node that layers an additive pose on top of a base pose.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#AddNode)
*/
export interface AddNode extends globalThis.EnumItem {
Name: "AddNode";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const AddNode: AddNode;
/**
* A layering node that composites an overlay pose on top of a base pose using per-joint masking.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#OverNode)
*/
export interface OverNode extends globalThis.EnumItem {
Name: "OverNode";
Value: 2;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const OverNode: OverNode;
/**
* A blend node that interpolates between multiple inputs along a single numeric axis.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#Blend1DNode)
*/
export interface Blend1DNode extends globalThis.EnumItem {
Name: "Blend1DNode";
Value: 3;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const Blend1DNode: Blend1DNode;
/**
* A blend node that interpolates between multiple inputs using a two-dimensional position.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#Blend2DNode)
*/
export interface Blend2DNode extends globalThis.EnumItem {
Name: "Blend2DNode";
Value: 4;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const Blend2DNode: Blend2DNode;
/**
* A leaf node that plays back an animation clip asset.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#ClipNode)
*/
export interface ClipNode extends globalThis.EnumItem {
Name: "ClipNode";
Value: 5;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const ClipNode: ClipNode;
/**
* The terminal output node of an animation graph that receives the final pose.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#GraphOutput)
*/
export interface GraphOutput extends globalThis.EnumItem {
Name: "GraphOutput";
Value: 6;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const GraphOutput: GraphOutput;
/**
* A node that filters its input pose through a per-joint weight mask.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#MaskNode)
*/
export interface MaskNode extends globalThis.EnumItem {
Name: "MaskNode";
Value: 7;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const MaskNode: MaskNode;
/**
* A state node that plays the highest-priority input whose trigger condition is true.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#PrioritySelectNode)
*/
export interface PrioritySelectNode extends globalThis.EnumItem {
Name: "PrioritySelectNode";
Value: 8;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const PrioritySelectNode: PrioritySelectNode;
/**
* A sequence node that plays its inputs in a weighted random order.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#RandomSequenceNode)
*/
export interface RandomSequenceNode extends globalThis.EnumItem {
Name: "RandomSequenceNode";
Value: 9;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const RandomSequenceNode: RandomSequenceNode;
/**
* A state node that plays whichever input is chosen by a string selection parameter.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#SelectNode)
*/
export interface SelectNode extends globalThis.EnumItem {
Name: "SelectNode";
Value: 10;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const SelectNode: SelectNode;
/**
* A node that plays its inputs one after another in order, optionally looping.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#SequenceNode)
*/
export interface SequenceNode extends globalThis.EnumItem {
Name: "SequenceNode";
Value: 11;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const SequenceNode: SequenceNode;
/**
* A node that scales the playback speed of its input.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#SpeedNode)
*/
export interface SpeedNode extends globalThis.EnumItem {
Name: "SpeedNode";
Value: 12;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const SpeedNode: SpeedNode;
/**
* A blend node that subtracts one pose from another to produce a difference pose.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#SubtractNode)
*/
export interface SubtractNode extends globalThis.EnumItem {
Name: "SubtractNode";
Value: 13;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const SubtractNode: SubtractNode;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#OneShotNode)
*/
export interface OneShotNode extends globalThis.EnumItem {
Name: "OneShotNode";
Value: 14;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const OneShotNode: OneShotNode;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType#StateMachineNode)
*/
export interface StateMachineNode extends globalThis.EnumItem {
Name: "StateMachineNode";
Value: 16;
EnumType: typeof globalThis.Enum.AnimationNodeType;
}
export const StateMachineNode: StateMachineNode;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodeType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodeType | undefined;
}
export type AnimationNodeType = AnimationNodeType.InvalidNode | AnimationNodeType.AddNode | AnimationNodeType.OverNode | AnimationNodeType.Blend1DNode | AnimationNodeType.Blend2DNode | AnimationNodeType.ClipNode | AnimationNodeType.GraphOutput | AnimationNodeType.MaskNode | AnimationNodeType.PrioritySelectNode | AnimationNodeType.RandomSequenceNode | AnimationNodeType.SelectNode | AnimationNodeType.SequenceNode | AnimationNodeType.SpeedNode | AnimationNodeType.SubtractNode | AnimationNodeType.OneShotNode | AnimationNodeType.StateMachineNode;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeWaitFor)
*/
export namespace AnimationNodeWaitFor {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeWaitFor#Finished)
*/
export interface Finished extends globalThis.EnumItem {
Name: "Finished";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationNodeWaitFor;
}
export const Finished: Finished;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeWaitFor#Trigger)
*/
export interface Trigger extends globalThis.EnumItem {
Name: "Trigger";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationNodeWaitFor;
}
export const Trigger: Trigger;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodeWaitFor | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodeWaitFor | undefined;
}
export type AnimationNodeWaitFor = AnimationNodeWaitFor.Finished | AnimationNodeWaitFor.Trigger;
/**
* The AnimationPriority Enum determines how concurrently-playing AnimationTracks contribute to the final animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationPriority)
*/
export namespace AnimationPriority {
/**
* (6) - Recommended priority for character idle animations.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Idle)
*/
export interface Idle extends globalThis.EnumItem {
Name: "Idle";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationPriority;
}
export const Idle: Idle;
/**
* (5) - Recommended priority for walk, run, swim, climb, and other locomotion animations.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Movement)
*/
export interface Movement extends globalThis.EnumItem {
Name: "Movement";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationPriority;
}
export const Movement: Movement;
/**
* (4) - Recommended priority for character actions that must override idle and locomotion animations.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Action)
*/
export interface Action extends globalThis.EnumItem {
Name: "Action";
Value: 2;
EnumType: typeof globalThis.Enum.AnimationPriority;
}
export const Action: Action;
/**
* (3) - Action2 will override Action.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Action2)
*/
export interface Action2 extends globalThis.EnumItem {
Name: "Action2";
Value: 3;
EnumType: typeof globalThis.Enum.AnimationPriority;
}
export const Action2: Action2;
/**
* (2) - Action3 will override Action2.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Action3)
*/
export interface Action3 extends globalThis.EnumItem {
Name: "Action3";
Value: 4;
EnumType: typeof globalThis.Enum.AnimationPriority;
}
export const Action3: Action3;
/**
* (1) - Action4 is the highest priority available, overriding all other priority values.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Action4)
*/
export interface Action4 extends globalThis.EnumItem {
Name: "Action4";
Value: 5;
EnumType: typeof globalThis.Enum.AnimationPriority;
}
export const Action4: Action4;
/**
* (7) - Lowest priority, intended for use by Roblox default animations and catalog animation bundles.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Core)
*/
export interface Core extends globalThis.EnumItem {
Name: "Core";
Value: 1000;
EnumType: typeof globalThis.Enum.AnimationPriority;
}
export const Core: Core;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationPriority | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationPriority | undefined;
}
export type AnimationPriority = AnimationPriority.Idle | AnimationPriority.Movement | AnimationPriority.Action | AnimationPriority.Action2 | AnimationPriority.Action3 | AnimationPriority.Action4 | AnimationPriority.Core;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationValueNodeType)
*/
export namespace AnimationValueNodeType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationValueNodeType#Invalid)
*/
export interface Invalid extends globalThis.EnumItem {
Name: "Invalid";
Value: 0;
EnumType: typeof globalThis.Enum.AnimationValueNodeType;
}
export const Invalid: Invalid;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationValueNodeType#Expression)
*/
export interface Expression extends globalThis.EnumItem {
Name: "Expression";
Value: 1;
EnumType: typeof globalThis.Enum.AnimationValueNodeType;
}
export const Expression: Expression;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationValueNodeType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationValueNodeType | undefined;
}
export type AnimationValueNodeType = AnimationValueNodeType.Invalid | AnimationValueNodeType.Expression;
/**
* Animation Retargeting setting.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatorRetargetingMode)
*/
export namespace AnimatorRetargetingMode {
/**
* Retargeting in default state, opt-in initially but subject to change.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatorRetargetingMode#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.AnimatorRetargetingMode;
}
export const Default: Default;
/**
* Animation retargeting is off; animations play exactly as authored without adapting joint transforms to the character's body proportions.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatorRetargetingMode#Disabled)
*/
export interface Disabled extends globalThis.EnumItem {
Name: "Disabled";
Value: 1;
EnumType: typeof globalThis.Enum.AnimatorRetargetingMode;
}
export const Disabled: Disabled;
/**
* Animation retargeting is always active; the Animator adapts animations to the character's body proportions regardless of the platform default.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimatorRetargetingMode#Enabled)
*/
export interface Enabled extends globalThis.EnumItem {
Name: "Enabled";
Value: 2;
EnumType: typeof globalThis.Enum.AnimatorRetargetingMode;
}
export const Enabled: Enabled;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimatorRetargetingMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimatorRetargetingMode | undefined;
}
export type AnimatorRetargetingMode = AnimatorRetargetingMode.Default | AnimatorRetargetingMode.Disabled | AnimatorRetargetingMode.Enabled;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationChannelContentPreference)
*/
export namespace AnnotationChannelContentPreference {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationChannelContentPreference#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.AnnotationChannelContentPreference;
}
export const None: None;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationChannelContentPreference#All)
*/
export interface All extends globalThis.EnumItem {
Name: "All";
Value: 1;
EnumType: typeof globalThis.Enum.AnnotationChannelContentPreference;
}
export const All: All;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationChannelContentPreference#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 2;
EnumType: typeof globalThis.Enum.AnnotationChannelContentPreference;
}
export const Unknown: Unknown;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnnotationChannelContentPreference | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnnotationChannelContentPreference | undefined;
}
export type AnnotationChannelContentPreference = AnnotationChannelContentPreference.None | AnnotationChannelContentPreference.All | AnnotationChannelContentPreference.Unknown;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationEditingMode)
*/
export namespace AnnotationEditingMode {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationEditingMode#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.AnnotationEditingMode;
}
export const None: None;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationEditingMode#PlacingNew)
*/
export interface PlacingNew extends globalThis.EnumItem {
Name: "PlacingNew";
Value: 1;
EnumType: typeof globalThis.Enum.AnnotationEditingMode;
}
export const PlacingNew: PlacingNew;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationEditingMode#WritingNew)
*/
export interface WritingNew extends globalThis.EnumItem {
Name: "WritingNew";
Value: 2;
EnumType: typeof globalThis.Enum.AnnotationEditingMode;
}
export const WritingNew: WritingNew;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnnotationEditingMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnnotationEditingMode | undefined;
}
export type AnnotationEditingMode = AnnotationEditingMode.None | AnnotationEditingMode.PlacingNew | AnnotationEditingMode.WritingNew;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationPlaceContentPreference)
*/
export namespace AnnotationPlaceContentPreference {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationPlaceContentPreference#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.AnnotationPlaceContentPreference;
}
export const None: None;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationPlaceContentPreference#All)
*/
export interface All extends globalThis.EnumItem {
Name: "All";
Value: 1;
EnumType: typeof globalThis.Enum.AnnotationPlaceContentPreference;
}
export const All: All;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationPlaceContentPreference#MentionsAndReplies)
*/
export interface MentionsAndReplies extends globalThis.EnumItem {
Name: "MentionsAndReplies";
Value: 2;
EnumType: typeof globalThis.Enum.AnnotationPlaceContentPreference;
}
export const MentionsAndReplies: MentionsAndReplies;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationPlaceContentPreference#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 3;
EnumType: typeof globalThis.Enum.AnnotationPlaceContentPreference;
}
export const Unknown: Unknown;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnnotationPlaceContentPreference | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnnotationPlaceContentPreference | undefined;
}
export type AnnotationPlaceContentPreference = AnnotationPlaceContentPreference.None | AnnotationPlaceContentPreference.All | AnnotationPlaceContentPreference.MentionsAndReplies | AnnotationPlaceContentPreference.Unknown;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus)
*/
export namespace AnnotationRequestStatus {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus#Success)
*/
export interface Success extends globalThis.EnumItem {
Name: "Success";
Value: 0;
EnumType: typeof globalThis.Enum.AnnotationRequestStatus;
}
export const Success: Success;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus#Loading)
*/
export interface Loading extends globalThis.EnumItem {
Name: "Loading";
Value: 1;
EnumType: typeof globalThis.Enum.AnnotationRequestStatus;
}
export const Loading: Loading;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus#ErrorInternalFailure)
*/
export interface ErrorInternalFailure extends globalThis.EnumItem {
Name: "ErrorInternalFailure";
Value: 2;
EnumType: typeof globalThis.Enum.AnnotationRequestStatus;
}
export const ErrorInternalFailure: ErrorInternalFailure;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus#ErrorNotFound)
*/
export interface ErrorNotFound extends globalThis.EnumItem {
Name: "ErrorNotFound";
Value: 3;
EnumType: typeof globalThis.Enum.AnnotationRequestStatus;
}
export const ErrorNotFound: ErrorNotFound;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus#ErrorModerated)
*/
export interface ErrorModerated extends globalThis.EnumItem {
Name: "ErrorModerated";
Value: 4;
EnumType: typeof globalThis.Enum.AnnotationRequestStatus;
}
export const ErrorModerated: ErrorModerated;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnnotationRequestStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnnotationRequestStatus | undefined;
}
export type AnnotationRequestStatus = AnnotationRequestStatus.Success | AnnotationRequestStatus.Loading | AnnotationRequestStatus.ErrorInternalFailure | AnnotationRequestStatus.ErrorNotFound | AnnotationRequestStatus.ErrorModerated;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType)
*/
export namespace AnnotationRequestType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.AnnotationRequestType;
}
export const Unknown: Unknown;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType#Create)
*/
export interface Create extends globalThis.EnumItem {
Name: "Create";
Value: 1;
EnumType: typeof globalThis.Enum.AnnotationRequestType;
}
export const Create: Create;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType#Resolve)
*/
export interface Resolve extends globalThis.EnumItem {
Name: "Resolve";
Value: 2;
EnumType: typeof globalThis.Enum.AnnotationRequestType;
}
export const Resolve: Resolve;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType#Delete)
*/
export interface Delete extends globalThis.EnumItem {
Name: "Delete";
Value: 3;
EnumType: typeof globalThis.Enum.AnnotationRequestType;
}
export const Delete: Delete;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType#Edit)
*/
export interface Edit extends globalThis.EnumItem {
Name: "Edit";
Value: 4;
EnumType: typeof globalThis.Enum.AnnotationRequestType;
}
export const Edit: Edit;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnnotationRequestType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnnotationRequestType | undefined;
}
export type AnnotationRequestType = AnnotationRequestType.Unknown | AnnotationRequestType.Create | AnnotationRequestType.Resolve | AnnotationRequestType.Delete | AnnotationRequestType.Edit;
/**
* Determines whether anti-aliasing is applied when drawing on the instance.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AntiAliasing)
*/
export namespace AntiAliasing {
/**
* Disables anti-aliasing, resulting in hard edges.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AntiAliasing#Disabled)
*/
export interface Disabled extends globalThis.EnumItem {
Name: "Disabled";
Value: 0;
EnumType: typeof globalThis.Enum.AntiAliasing;
}
export const Disabled: Disabled;
/**
* Enables anti-aliasing, resulting in soft edges.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AntiAliasing#Enabled)
*/
export interface Enabled extends globalThis.EnumItem {
Name: "Enabled";
Value: 1;
EnumType: typeof globalThis.Enum.AntiAliasing;
}
export const Enabled: Enabled;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AntiAliasing | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AntiAliasing | undefined;
}
export type AntiAliasing = AntiAliasing.Disabled | AntiAliasing.Enabled;
/**
* Describes the current lifecycle state of the Roblox application as reported by `AppLifecycleObserverService:GetCurrentState()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppLifecycleManagerState)
*/
export namespace AppLifecycleManagerState {
/**
* The application has not yet started or is shutting down. This is the initial state before the lifecycle manager is created and the final state entered during application termination.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppLifecycleManagerState#Detached)
*/
export interface Detached extends globalThis.EnumItem {
Name: "Detached";
Value: 0;
EnumType: typeof globalThis.Enum.AppLifecycleManagerState;
}
export const Detached: Detached;
/**
* The application is in the foreground and has input focus. This is the normal running state where the user is actively interacting with the experience.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppLifecycleManagerState#Active)
*/
export interface Active extends globalThis.EnumItem {
Name: "Active";
Value: 1;
EnumType: typeof globalThis.Enum.AppLifecycleManagerState;
}
export const Active: Active;
/**
* The application is visible but does not have input focus. On iOS this occurs during transitions such as incoming calls or notification center pull-down; on macOS it corresponds to the application resigning active status.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppLifecycleManagerState#Inactive)
*/
export interface Inactive extends globalThis.EnumItem {
Name: "Inactive";
Value: 2;
EnumType: typeof globalThis.Enum.AppLifecycleManagerState;
}
export const Inactive: Inactive;
/**
* The application is fully in the background and not visible to the user. On mobile platforms this corresponds to the app being backgrounded; on desktop it corresponds to the window being minimized or fully occluded.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppLifecycleManagerState#Hidden)
*/
export interface Hidden extends globalThis.EnumItem {
Name: "Hidden";
Value: 3;
EnumType: typeof globalThis.Enum.AppLifecycleManagerState;
}
export const Hidden: Hidden;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AppLifecycleManagerState | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AppLifecycleManagerState | undefined;
}
export type AppLifecycleManagerState = AppLifecycleManagerState.Detached | AppLifecycleManagerState.Active | AppLifecycleManagerState.Inactive | AppLifecycleManagerState.Hidden;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType)
*/
export namespace AppShellActionType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const None: None;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#OpenApp)
*/
export interface OpenApp extends globalThis.EnumItem {
Name: "OpenApp";
Value: 1;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const OpenApp: OpenApp;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#TapChatTab)
*/
export interface TapChatTab extends globalThis.EnumItem {
Name: "TapChatTab";
Value: 2;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const TapChatTab: TapChatTab;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#TapConversationEntry)
*/
export interface TapConversationEntry extends globalThis.EnumItem {
Name: "TapConversationEntry";
Value: 3;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const TapConversationEntry: TapConversationEntry;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#TapAvatarTab)
*/
export interface TapAvatarTab extends globalThis.EnumItem {
Name: "TapAvatarTab";
Value: 4;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const TapAvatarTab: TapAvatarTab;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#ReadConversation)
*/
export interface ReadConversation extends globalThis.EnumItem {
Name: "ReadConversation";
Value: 5;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const ReadConversation: ReadConversation;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#TapGamePageTab)
*/
export interface TapGamePageTab extends globalThis.EnumItem {
Name: "TapGamePageTab";
Value: 6;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const TapGamePageTab: TapGamePageTab;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#TapHomePageTab)
*/
export interface TapHomePageTab extends globalThis.EnumItem {
Name: "TapHomePageTab";
Value: 7;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const TapHomePageTab: TapHomePageTab;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#GamePageLoaded)
*/
export interface GamePageLoaded extends globalThis.EnumItem {
Name: "GamePageLoaded";
Value: 8;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const GamePageLoaded: GamePageLoaded;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#HomePageLoaded)
*/
export interface HomePageLoaded extends globalThis.EnumItem {
Name: "HomePageLoaded";
Value: 9;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const HomePageLoaded: HomePageLoaded;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#AvatarEditorPageLoaded)
*/
export interface AvatarEditorPageLoaded extends globalThis.EnumItem {
Name: "AvatarEditorPageLoaded";
Value: 10;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const AvatarEditorPageLoaded: AvatarEditorPageLoaded;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#HomePageInteractive)
*/
export interface HomePageInteractive extends globalThis.EnumItem {
Name: "HomePageInteractive";
Value: 11;
EnumType: typeof globalThis.Enum.AppShellActionType;
}
export const HomePageInteractive: HomePageInteractive;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AppShellActionType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AppShellActionType | undefined;
}
export type AppShellActionType = AppShellActionType.None | AppShellActionType.OpenApp | AppShellActionType.TapChatTab | AppShellActionType.TapConversationEntry | AppShellActionType.TapAvatarTab | AppShellActionType.ReadConversation | AppShellActionType.TapGamePageTab | AppShellActionType.TapHomePageTab | AppShellActionType.GamePageLoaded | AppShellActionType.HomePageLoaded | AppShellActionType.AvatarEditorPageLoaded | AppShellActionType.HomePageInteractive;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellFeature)
*/
export namespace AppShellFeature {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.AppShellFeature;
}
export const None: None;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#Chat)
*/
export interface Chat extends globalThis.EnumItem {
Name: "Chat";
Value: 1;
EnumType: typeof globalThis.Enum.AppShellFeature;
}
export const Chat: Chat;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#AvatarEditor)
*/
export interface AvatarEditor extends globalThis.EnumItem {
Name: "AvatarEditor";
Value: 2;
EnumType: typeof globalThis.Enum.AppShellFeature;
}
export const AvatarEditor: AvatarEditor;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#GamePage)
*/
export interface GamePage extends globalThis.EnumItem {
Name: "GamePage";
Value: 3;
EnumType: typeof globalThis.Enum.AppShellFeature;
}
export const GamePage: GamePage;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#HomePage)
*/
export interface HomePage extends globalThis.EnumItem {
Name: "HomePage";
Value: 4;
EnumType: typeof globalThis.Enum.AppShellFeature;
}
export const HomePage: HomePage;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#More)
*/
export interface More extends globalThis.EnumItem {
Name: "More";
Value: 5;
EnumType: typeof globalThis.Enum.AppShellFeature;
}
export const More: More;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#Landing)
*/
export interface Landing extends globalThis.EnumItem {
Name: "Landing";
Value: 6;
EnumType: typeof globalThis.Enum.AppShellFeature;
}
export const Landing: Landing;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#WatchPage)
*/
export interface WatchPage extends globalThis.EnumItem {
Name: "WatchPage";
Value: 7;
EnumType: typeof globalThis.Enum.AppShellFeature;
}
export const WatchPage: WatchPage;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AppShellFeature | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AppShellFeature | undefined;
}
export type AppShellFeature = AppShellFeature.None | AppShellFeature.Chat | AppShellFeature.AvatarEditor | AppShellFeature.GamePage | AppShellFeature.HomePage | AppShellFeature.More | AppShellFeature.Landing | AppShellFeature.WatchPage;
/**
* Indicates the result of an application update check performed by `AppUpdateService`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus)
*/
export namespace AppUpdateStatus {
/**
* The default state before any update check has been performed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.AppUpdateStatus;
}
export const Unknown: Unknown;
/**
* The platform does not support application updates.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#NotSupported)
*/
export interface NotSupported extends globalThis.EnumItem {
Name: "NotSupported";
Value: 1;
EnumType: typeof globalThis.Enum.AppUpdateStatus;
}
export const NotSupported: NotSupported;
/**
* The update check failed due to an error such as a network failure or missing initialization.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#Failed)
*/
export interface Failed extends globalThis.EnumItem {
Name: "Failed";
Value: 2;
EnumType: typeof globalThis.Enum.AppUpdateStatus;
}
export const Failed: Failed;
/**
* No update is currently required; the client is already running the latest version for its channel.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#NotAvailable)
*/
export interface NotAvailable extends globalThis.EnumItem {
Name: "NotAvailable";
Value: 3;
EnumType: typeof globalThis.Enum.AppUpdateStatus;
}
export const NotAvailable: NotAvailable;
/**
* An update is available through a public channel or production deployment.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#Available)
*/
export interface Available extends globalThis.EnumItem {
Name: "Available";
Value: 4;
EnumType: typeof globalThis.Enum.AppUpdateStatus;
}
export const Available: Available;
/**
* An update is available because the user is explicitly bound to a private or public channel.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#AvailableBoundChannel)
*/
export interface AvailableBoundChannel extends globalThis.EnumItem {
Name: "AvailableBoundChannel";
Value: 5;
EnumType: typeof globalThis.Enum.AppUpdateStatus;
}
export const AvailableBoundChannel: AvailableBoundChannel;
/**
* An update is available because the user opted into a beta program backed by a channel.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#AvailableBetaProgram)
*/
export interface AvailableBetaProgram extends globalThis.EnumItem {
Name: "AvailableBetaProgram";
Value: 6;
EnumType: typeof globalThis.Enum.AppUpdateStatus;
}
export const AvailableBetaProgram: AvailableBetaProgram;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AppUpdateStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AppUpdateStatus | undefined;
}
export type AppUpdateStatus = AppUpdateStatus.Unknown | AppUpdateStatus.NotSupported | AppUpdateStatus.Failed | AppUpdateStatus.NotAvailable | AppUpdateStatus.Available | AppUpdateStatus.AvailableBoundChannel | AppUpdateStatus.AvailableBetaProgram;
/**
* Controls which part of a parent UI element a `UIShadow` applies its drop shadow to.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ApplyShadowMode)
*/
export namespace ApplyShadowMode {
/**
* The shadow is applied to the parent element's frame.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ApplyShadowMode#Shape)
*/
export interface Shape extends globalThis.EnumItem {
Name: "Shape";
Value: 0;
EnumType: typeof globalThis.Enum.ApplyShadowMode;
}
export const Shape: Shape;
/**
* The shadow is applied to the parent element's text; no-op if the parent is not a text element.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ApplyShadowMode#Text)
*/
export interface Text extends globalThis.EnumItem {
Name: "Text";
Value: 1;
EnumType: typeof globalThis.Enum.ApplyShadowMode;
}
export const Text: Text;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ApplyShadowMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ApplyShadowMode | undefined;
}
export type ApplyShadowMode = ApplyShadowMode.Shape | ApplyShadowMode.Text;
/**
* Used by `UIStroke.ApplyStrokeMode` to determine where to apply the stroke.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ApplyStrokeMode)
*/
export namespace ApplyStrokeMode {
/**
* The stroke is applied to the parent UI element's text.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ApplyStrokeMode#Contextual)
*/
export interface Contextual extends globalThis.EnumItem {
Name: "Contextual";
Value: 0;
EnumType: typeof globalThis.Enum.ApplyStrokeMode;
}
export const Contextual: Contextual;
/**
* The stroke is applied to the parent UI element's border.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ApplyStrokeMode#Border)
*/
export interface Border extends globalThis.EnumItem {
Name: "Border";
Value: 1;
EnumType: typeof globalThis.Enum.ApplyStrokeMode;
}
export const Border: Border;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ApplyStrokeMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ApplyStrokeMode | undefined;
}
export type ApplyStrokeMode = ApplyStrokeMode.Contextual | ApplyStrokeMode.Border;
/**
* Used by `UIAspectRatioConstraint.AspectType` to control sizing behavior.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AspectType)
*/
export namespace AspectType {
/**
* The object will be the maximum size possible within its own `AbsoluteSize`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AspectType#FitWithinMaxSize)
*/
export interface FitWithinMaxSize extends globalThis.EnumItem {
Name: "FitWithinMaxSize";
Value: 0;
EnumType: typeof globalThis.Enum.AspectType;
}
export const FitWithinMaxSize: FitWithinMaxSize;
/**
* The object's maximum size will be the size of the parent while still maintaining the aspect ratio.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AspectType#ScaleWithParentSize)
*/
export interface ScaleWithParentSize extends globalThis.EnumItem {
Name: "ScaleWithParentSize";
Value: 1;
EnumType: typeof globalThis.Enum.AspectType;
}
export const ScaleWithParentSize: ScaleWithParentSize;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AspectType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AspectType | undefined;
}
export type AspectType = AspectType.FitWithinMaxSize | AspectType.ScaleWithParentSize;
/**
* Indicates whether an asset is owned by an individual user or a group.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetCreatorType)
*/
export namespace AssetCreatorType {
/**
* The asset is owned by an individual user; the accompanying creator ID is a user ID.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetCreatorType#User)
*/
export interface User extends globalThis.EnumItem {
Name: "User";
Value: 0;
EnumType: typeof globalThis.Enum.AssetCreatorType;
}
export const User: User;
/**
* The asset is owned by a group; the accompanying creator ID is a group ID.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetCreatorType#Group)
*/
export interface Group extends globalThis.EnumItem {
Name: "Group";
Value: 1;
EnumType: typeof globalThis.Enum.AssetCreatorType;
}
export const Group: Group;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AssetCreatorType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AssetCreatorType | undefined;
}
export type AssetCreatorType = AssetCreatorType.User | AssetCreatorType.Group;
/**
* Describes the download state of an asset requested through `ContentProvider`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus)
*/
export namespace AssetFetchStatus {
/**
* The asset loaded successfully.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus#Success)
*/
export interface Success extends globalThis.EnumItem {
Name: "Success";
Value: 0;
EnumType: typeof globalThis.Enum.AssetFetchStatus;
}
export const Success: Success;
/**
* The asset failed to load successfully. Subsequent attempts are likely to fail; there may be something wrong with the `Content` string.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus#Failure)
*/
export interface Failure extends globalThis.EnumItem {
Name: "Failure";
Value: 1;
EnumType: typeof globalThis.Enum.AssetFetchStatus;
}
export const Failure: Failure;
/**
* The engine has no information about this asset. The engine never tried to load it.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 2;
EnumType: typeof globalThis.Enum.AssetFetchStatus;
}
export const None: None;
/**
* The engine is in the middle of trying to load this asset.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus#Loading)
*/
export interface Loading extends globalThis.EnumItem {
Name: "Loading";
Value: 3;
EnumType: typeof globalThis.Enum.AssetFetchStatus;
}
export const Loading: Loading;
/**
* The engine tried to load this asset but timed out. Future attempts to load may succeed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus#TimedOut)
*/
export interface TimedOut extends globalThis.EnumItem {
Name: "TimedOut";
Value: 4;
EnumType: typeof globalThis.Enum.AssetFetchStatus;
}
export const TimedOut: TimedOut;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AssetFetchStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AssetFetchStatus | undefined;
}
export type AssetFetchStatus = AssetFetchStatus.Success | AssetFetchStatus.Failure | AssetFetchStatus.None | AssetFetchStatus.Loading | AssetFetchStatus.TimedOut;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetRepresentation)
*/
export namespace AssetRepresentation {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetRepresentation#FullLength)
*/
export interface FullLength extends globalThis.EnumItem {
Name: "FullLength";
Value: 0;
EnumType: typeof globalThis.Enum.AssetRepresentation;
}
export const FullLength: FullLength;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetRepresentation#ShortPreview)
*/
export interface ShortPreview extends globalThis.EnumItem {
Name: "ShortPreview";
Value: 1;
EnumType: typeof globalThis.Enum.AssetRepresentation;
}
export const ShortPreview: ShortPreview;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AssetRepresentation | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AssetRepresentation | undefined;
}
export type AssetRepresentation = AssetRepresentation.FullLength | AssetRepresentation.ShortPreview;
/**
* This Enum can be used to match the AssetTypeId from `MarketplaceService:GetProductInfoAsync()` to an asset type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType)
*/
export namespace AssetType {
/**
* The asset is an image.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Image)
*/
export interface Image extends globalThis.EnumItem {
Name: "Image";
Value: 1;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Image: Image;
/**
* The asset is a classic t-shirt (a flat image applied to the avatar's torso).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#TShirt)
*/
export interface TShirt extends globalThis.EnumItem {
Name: "TShirt";
Value: 2;
EnumType: typeof globalThis.Enum.AssetType;
}
export const TShirt: TShirt;
/**
* @deprecated renamed to TShirt
*/
export const TeeShirt: TShirt;
/**
* The asset is an audio clip.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Audio)
*/
export interface Audio extends globalThis.EnumItem {
Name: "Audio";
Value: 3;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Audio: Audio;
/**
* The asset is a mesh.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Mesh)
*/
export interface Mesh extends globalThis.EnumItem {
Name: "Mesh";
Value: 4;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Mesh: Mesh;
/**
* The asset is Luau code, for example a `ModuleScript`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Lua)
*/
export interface Lua extends globalThis.EnumItem {
Name: "Lua";
Value: 5;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Lua: Lua;
/**
* The asset is a hat.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Hat)
*/
export interface Hat extends globalThis.EnumItem {
Name: "Hat";
Value: 8;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Hat: Hat;
/**
* The asset is a place.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Place)
*/
export interface Place extends globalThis.EnumItem {
Name: "Place";
Value: 9;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Place: Place;
/**
* The asset is a model.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Model)
*/
export interface Model extends globalThis.EnumItem {
Name: "Model";
Value: 10;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Model: Model;
/**
* The asset is a shirt.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Shirt)
*/
export interface Shirt extends globalThis.EnumItem {
Name: "Shirt";
Value: 11;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Shirt: Shirt;
/**
* The asset is a pants item.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Pants)
*/
export interface Pants extends globalThis.EnumItem {
Name: "Pants";
Value: 12;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Pants: Pants;
/**
* The asset is a decal (image).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Decal)
*/
export interface Decal extends globalThis.EnumItem {
Name: "Decal";
Value: 13;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Decal: Decal;
/**
* The asset is a head.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Head)
*/
export interface Head extends globalThis.EnumItem {
Name: "Head";
Value: 17;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Head: Head;
/**
* The asset is a face.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Face)
*/
export interface Face extends globalThis.EnumItem {
Name: "Face";
Value: 18;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Face: Face;
/**
* The asset is a gear item.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Gear)
*/
export interface Gear extends globalThis.EnumItem {
Name: "Gear";
Value: 19;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Gear: Gear;
/**
* The asset is a badge.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Badge)
*/
export interface Badge extends globalThis.EnumItem {
Name: "Badge";
Value: 21;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Badge: Badge;
/**
* The asset is an animation; also see the more specific animation type enums below.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Animation)
*/
export interface Animation extends globalThis.EnumItem {
Name: "Animation";
Value: 24;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Animation: Animation;
/**
* The asset is a torso.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Torso)
*/
export interface Torso extends globalThis.EnumItem {
Name: "Torso";
Value: 27;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Torso: Torso;
/**
* The asset is a right arm.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#RightArm)
*/
export interface RightArm extends globalThis.EnumItem {
Name: "RightArm";
Value: 28;
EnumType: typeof globalThis.Enum.AssetType;
}
export const RightArm: RightArm;
/**
* The asset is a left arm.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#LeftArm)
*/
export interface LeftArm extends globalThis.EnumItem {
Name: "LeftArm";
Value: 29;
EnumType: typeof globalThis.Enum.AssetType;
}
export const LeftArm: LeftArm;
/**
* The asset is a left leg.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#LeftLeg)
*/
export interface LeftLeg extends globalThis.EnumItem {
Name: "LeftLeg";
Value: 30;
EnumType: typeof globalThis.Enum.AssetType;
}
export const LeftLeg: LeftLeg;
/**
* The asset is a right leg.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#RightLeg)
*/
export interface RightLeg extends globalThis.EnumItem {
Name: "RightLeg";
Value: 31;
EnumType: typeof globalThis.Enum.AssetType;
}
export const RightLeg: RightLeg;
/**
* The asset is a pack, for example an animation package.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Package)
*/
export interface Package extends globalThis.EnumItem {
Name: "Package";
Value: 32;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Package: Package;
/**
* The asset is a GamePass.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#GamePass)
*/
export interface GamePass extends globalThis.EnumItem {
Name: "GamePass";
Value: 34;
EnumType: typeof globalThis.Enum.AssetType;
}
export const GamePass: GamePass;
/**
* The asset is a plugin.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Plugin)
*/
export interface Plugin extends globalThis.EnumItem {
Name: "Plugin";
Value: 38;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Plugin: Plugin;
/**
* The asset is a mesh part.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#MeshPart)
*/
export interface MeshPart extends globalThis.EnumItem {
Name: "MeshPart";
Value: 40;
EnumType: typeof globalThis.Enum.AssetType;
}
export const MeshPart: MeshPart;
/**
* The asset is a hair accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#HairAccessory)
*/
export interface HairAccessory extends globalThis.EnumItem {
Name: "HairAccessory";
Value: 41;
EnumType: typeof globalThis.Enum.AssetType;
}
export const HairAccessory: HairAccessory;
/**
* The asset is a face accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#FaceAccessory)
*/
export interface FaceAccessory extends globalThis.EnumItem {
Name: "FaceAccessory";
Value: 42;
EnumType: typeof globalThis.Enum.AssetType;
}
export const FaceAccessory: FaceAccessory;
/**
* The asset is a neck accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#NeckAccessory)
*/
export interface NeckAccessory extends globalThis.EnumItem {
Name: "NeckAccessory";
Value: 43;
EnumType: typeof globalThis.Enum.AssetType;
}
export const NeckAccessory: NeckAccessory;
/**
* The asset is a shoulder accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#ShoulderAccessory)
*/
export interface ShoulderAccessory extends globalThis.EnumItem {
Name: "ShoulderAccessory";
Value: 44;
EnumType: typeof globalThis.Enum.AssetType;
}
export const ShoulderAccessory: ShoulderAccessory;
/**
* The asset is a front accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#FrontAccessory)
*/
export interface FrontAccessory extends globalThis.EnumItem {
Name: "FrontAccessory";
Value: 45;
EnumType: typeof globalThis.Enum.AssetType;
}
export const FrontAccessory: FrontAccessory;
/**
* The asset is a back accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#BackAccessory)
*/
export interface BackAccessory extends globalThis.EnumItem {
Name: "BackAccessory";
Value: 46;
EnumType: typeof globalThis.Enum.AssetType;
}
export const BackAccessory: BackAccessory;
/**
* The asset is a waist accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#WaistAccessory)
*/
export interface WaistAccessory extends globalThis.EnumItem {
Name: "WaistAccessory";
Value: 47;
EnumType: typeof globalThis.Enum.AssetType;
}
export const WaistAccessory: WaistAccessory;
/**
* The asset is a climb animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#ClimbAnimation)
*/
export interface ClimbAnimation extends globalThis.EnumItem {
Name: "ClimbAnimation";
Value: 48;
EnumType: typeof globalThis.Enum.AssetType;
}
export const ClimbAnimation: ClimbAnimation;
/**
* The asset is a death animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#DeathAnimation)
*/
export interface DeathAnimation extends globalThis.EnumItem {
Name: "DeathAnimation";
Value: 49;
EnumType: typeof globalThis.Enum.AssetType;
}
export const DeathAnimation: DeathAnimation;
/**
* The asset is a fall animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#FallAnimation)
*/
export interface FallAnimation extends globalThis.EnumItem {
Name: "FallAnimation";
Value: 50;
EnumType: typeof globalThis.Enum.AssetType;
}
export const FallAnimation: FallAnimation;
/**
* The asset is an idle animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#IdleAnimation)
*/
export interface IdleAnimation extends globalThis.EnumItem {
Name: "IdleAnimation";
Value: 51;
EnumType: typeof globalThis.Enum.AssetType;
}
export const IdleAnimation: IdleAnimation;
/**
* The asset is a jump animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#JumpAnimation)
*/
export interface JumpAnimation extends globalThis.EnumItem {
Name: "JumpAnimation";
Value: 52;
EnumType: typeof globalThis.Enum.AssetType;
}
export const JumpAnimation: JumpAnimation;
/**
* The asset is a run animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#RunAnimation)
*/
export interface RunAnimation extends globalThis.EnumItem {
Name: "RunAnimation";
Value: 53;
EnumType: typeof globalThis.Enum.AssetType;
}
export const RunAnimation: RunAnimation;
/**
* The asset is a swim animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#SwimAnimation)
*/
export interface SwimAnimation extends globalThis.EnumItem {
Name: "SwimAnimation";
Value: 54;
EnumType: typeof globalThis.Enum.AssetType;
}
export const SwimAnimation: SwimAnimation;
/**
* The asset is a walk animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#WalkAnimation)
*/
export interface WalkAnimation extends globalThis.EnumItem {
Name: "WalkAnimation";
Value: 55;
EnumType: typeof globalThis.Enum.AssetType;
}
export const WalkAnimation: WalkAnimation;
/**
* The asset is a pose animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#PoseAnimation)
*/
export interface PoseAnimation extends globalThis.EnumItem {
Name: "PoseAnimation";
Value: 56;
EnumType: typeof globalThis.Enum.AssetType;
}
export const PoseAnimation: PoseAnimation;
/**
* The asset is an ear accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#EarAccessory)
*/
export interface EarAccessory extends globalThis.EnumItem {
Name: "EarAccessory";
Value: 57;
EnumType: typeof globalThis.Enum.AssetType;
}
export const EarAccessory: EarAccessory;
/**
* The asset is an eye accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#EyeAccessory)
*/
export interface EyeAccessory extends globalThis.EnumItem {
Name: "EyeAccessory";
Value: 58;
EnumType: typeof globalThis.Enum.AssetType;
}
export const EyeAccessory: EyeAccessory;
/**
* The asset is an emote animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#EmoteAnimation)
*/
export interface EmoteAnimation extends globalThis.EnumItem {
Name: "EmoteAnimation";
Value: 61;
EnumType: typeof globalThis.Enum.AssetType;
}
export const EmoteAnimation: EmoteAnimation;
/**
* The asset is a video.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#Video)
*/
export interface Video extends globalThis.EnumItem {
Name: "Video";
Value: 62;
EnumType: typeof globalThis.Enum.AssetType;
}
export const Video: Video;
/**
* The asset is a layered clothing accessory representing a t-shirt.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#TShirtAccessory)
*/
export interface TShirtAccessory extends globalThis.EnumItem {
Name: "TShirtAccessory";
Value: 64;
EnumType: typeof globalThis.Enum.AssetType;
}
export const TShirtAccessory: TShirtAccessory;
/**
* @deprecated renamed to TShirtAccessory
*/
export const TeeShirtAccessory: TShirtAccessory;
/**
* The asset is a layered clothing accessory representing a shirt.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#ShirtAccessory)
*/
export interface ShirtAccessory extends globalThis.EnumItem {
Name: "ShirtAccessory";
Value: 65;
EnumType: typeof globalThis.Enum.AssetType;
}
export const ShirtAccessory: ShirtAccessory;
/**
* The asset is a layered clothing accessory representing pants.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#PantsAccessory)
*/
export interface PantsAccessory extends globalThis.EnumItem {
Name: "PantsAccessory";
Value: 66;
EnumType: typeof globalThis.Enum.AssetType;
}
export const PantsAccessory: PantsAccessory;
/**
* The asset is a layered clothing accessory representing a jacket.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#JacketAccessory)
*/
export interface JacketAccessory extends globalThis.EnumItem {
Name: "JacketAccessory";
Value: 67;
EnumType: typeof globalThis.Enum.AssetType;
}
export const JacketAccessory: JacketAccessory;
/**
* The asset is a layered clothing accessory representing a sweater.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#SweaterAccessory)
*/
export interface SweaterAccessory extends globalThis.EnumItem {
Name: "SweaterAccessory";
Value: 68;
EnumType: typeof globalThis.Enum.AssetType;
}
export const SweaterAccessory: SweaterAccessory;
/**
* The asset is a layered clothing accessory representing shorts.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#ShortsAccessory)
*/
export interface ShortsAccessory extends globalThis.EnumItem {
Name: "ShortsAccessory";
Value: 69;
EnumType: typeof globalThis.Enum.AssetType;
}
export const ShortsAccessory: ShortsAccessory;
/**
* The asset is a layered clothing accessory representing a left shoe.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#LeftShoeAccessory)
*/
export interface LeftShoeAccessory extends globalThis.EnumItem {
Name: "LeftShoeAccessory";
Value: 70;
EnumType: typeof globalThis.Enum.AssetType;
}
export const LeftShoeAccessory: LeftShoeAccessory;
/**
* The asset is a layered clothing accessory representing a right shoe.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#RightShoeAccessory)
*/
export interface RightShoeAccessory extends globalThis.EnumItem {
Name: "RightShoeAccessory";
Value: 71;
EnumType: typeof globalThis.Enum.AssetType;
}
export const RightShoeAccessory: RightShoeAccessory;
/**
* The asset is a layered clothing accessory representing a dress or skirt.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#DressSkirtAccessory)
*/
export interface DressSkirtAccessory extends globalThis.EnumItem {
Name: "DressSkirtAccessory";
Value: 72;
EnumType: typeof globalThis.Enum.AssetType;
}
export const DressSkirtAccessory: DressSkirtAccessory;
/**
* The asset is a font family used for text rendering.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#FontFamily)
*/
export interface FontFamily extends globalThis.EnumItem {
Name: "FontFamily";
Value: 73;
EnumType: typeof globalThis.Enum.AssetType;
}
export const FontFamily: FontFamily;
/**
* The asset is a layered eyebrow accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#EyebrowAccessory)
*/
export interface EyebrowAccessory extends globalThis.EnumItem {
Name: "EyebrowAccessory";
Value: 76;
EnumType: typeof globalThis.Enum.AssetType;
}
export const EyebrowAccessory: EyebrowAccessory;
/**
* The asset is a layered eyelash accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#EyelashAccessory)
*/
export interface EyelashAccessory extends globalThis.EnumItem {
Name: "EyelashAccessory";
Value: 77;
EnumType: typeof globalThis.Enum.AssetType;
}
export const EyelashAccessory: EyelashAccessory;
/**
* The asset is a mood animation that defines a static facial expression for a character.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#MoodAnimation)
*/
export interface MoodAnimation extends globalThis.EnumItem {
Name: "MoodAnimation";
Value: 78;
EnumType: typeof globalThis.Enum.AssetType;
}
export const MoodAnimation: MoodAnimation;
/**
* The asset is a head with facial animation support.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#DynamicHead)
*/
export interface DynamicHead extends globalThis.EnumItem {
Name: "DynamicHead";
Value: 79;
EnumType: typeof globalThis.Enum.AssetType;
}
export const DynamicHead: DynamicHead;
/**
* The asset is face makeup applied to a character's head via texture transfer.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#FaceMakeup)
*/
export interface FaceMakeup extends globalThis.EnumItem {
Name: "FaceMakeup";
Value: 88;
EnumType: typeof globalThis.Enum.AssetType;
}
export const FaceMakeup: FaceMakeup;
/**
* The asset is lip makeup applied to a character's face via texture transfer.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#LipMakeup)
*/
export interface LipMakeup extends globalThis.EnumItem {
Name: "LipMakeup";
Value: 89;
EnumType: typeof globalThis.Enum.AssetType;
}
export const LipMakeup: LipMakeup;
/**
* The asset is eye makeup applied to a character's face via texture transfer.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#EyeMakeup)
*/
export interface EyeMakeup extends globalThis.EnumItem {
Name: "EyeMakeup";
Value: 90;
EnumType: typeof globalThis.Enum.AssetType;
}
export const EyeMakeup: EyeMakeup;
/**
* The asset is an avatar background used as a scene backdrop in avatar previews.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#AvatarBackground)
*/
export interface AvatarBackground extends globalThis.EnumItem {
Name: "AvatarBackground";
Value: 92;
EnumType: typeof globalThis.Enum.AssetType;
}
export const AvatarBackground: AvatarBackground;
/**
* The asset is a text document.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#TextDocument)
*/
export interface TextDocument extends globalThis.EnumItem {
Name: "TextDocument";
Value: 93;
EnumType: typeof globalThis.Enum.AssetType;
}
export const TextDocument: TextDocument;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AssetType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AssetType | undefined;
}
export type AssetType = AssetType.Image | AssetType.TShirt | AssetType.Audio | AssetType.Mesh | AssetType.Lua | AssetType.Hat | AssetType.Place | AssetType.Model | AssetType.Shirt | AssetType.Pants | AssetType.Decal | AssetType.Head | AssetType.Face | AssetType.Gear | AssetType.Badge | AssetType.Animation | AssetType.Torso | AssetType.RightArm | AssetType.LeftArm | AssetType.LeftLeg | AssetType.RightLeg | AssetType.Package | AssetType.GamePass | AssetType.Plugin | AssetType.MeshPart | AssetType.HairAccessory | AssetType.FaceAccessory | AssetType.NeckAccessory | AssetType.ShoulderAccessory | AssetType.FrontAccessory | AssetType.BackAccessory | AssetType.WaistAccessory | AssetType.ClimbAnimation | AssetType.DeathAnimation | AssetType.FallAnimation | AssetType.IdleAnimation | AssetType.JumpAnimation | AssetType.RunAnimation | AssetType.SwimAnimation | AssetType.WalkAnimation | AssetType.PoseAnimation | AssetType.EarAccessory | AssetType.EyeAccessory | AssetType.EmoteAnimation | AssetType.Video | AssetType.TShirtAccessory | AssetType.ShirtAccessory | AssetType.PantsAccessory | AssetType.JacketAccessory | AssetType.SweaterAccessory | AssetType.ShortsAccessory | AssetType.LeftShoeAccessory | AssetType.RightShoeAccessory | AssetType.DressSkirtAccessory | AssetType.FontFamily | AssetType.EyebrowAccessory | AssetType.EyelashAccessory | AssetType.MoodAnimation | AssetType.DynamicHead | AssetType.FaceMakeup | AssetType.LipMakeup | AssetType.EyeMakeup | AssetType.AvatarBackground | AssetType.TextDocument;
/**
* Determines the asset type verification mode.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetTypeVerification)
*/
export namespace AssetTypeVerification {
/**
* Use the default behavior for asset type verification.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetTypeVerification#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 1;
EnumType: typeof globalThis.Enum.AssetTypeVerification;
}
export const Default: Default;
/**
* Only verify asset types on the client. Asset type verification can not be turned off on the client.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetTypeVerification#ClientOnly)
*/
export interface ClientOnly extends globalThis.EnumItem {
Name: "ClientOnly";
Value: 2;
EnumType: typeof globalThis.Enum.AssetTypeVerification;
}
export const ClientOnly: ClientOnly;
/**
* Always verify the asset types to be loaded and disallow loading models.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetTypeVerification#Always)
*/
export interface Always extends globalThis.EnumItem {
Name: "Always";
Value: 3;
EnumType: typeof globalThis.Enum.AssetTypeVerification;
}
export const Always: Always;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AssetTypeVerification | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AssetTypeVerification | undefined;
}
export type AssetTypeVerification = AssetTypeVerification.Default | AssetTypeVerification.ClientOnly | AssetTypeVerification.Always;
/**
* Used to determine whether voice chat is represented and controlled by `AudioDeviceInput` objects.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioApiRollout)
*/
export namespace AudioApiRollout {
/**
* Voice chat will use an internal voice chat implementation that is automatic and hidden.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioApiRollout#Disabled)
*/
export interface Disabled extends globalThis.EnumItem {
Name: "Disabled";
Value: 0;
EnumType: typeof globalThis.Enum.AudioApiRollout;
}
export const Disabled: Disabled;
/**
* Currently means the same thing as `Disabled`, but will be updated to mean `Enabled` in the future.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioApiRollout#Automatic)
*/
export interface Automatic extends globalThis.EnumItem {
Name: "Automatic";
Value: 1;
EnumType: typeof globalThis.Enum.AudioApiRollout;
}
export const Automatic: Automatic;
/**
* Voice chat can be customized or controlled via `AudioDeviceInputs`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioApiRollout#Enabled)
*/
export interface Enabled extends globalThis.EnumItem {
Name: "Enabled";
Value: 2;
EnumType: typeof globalThis.Enum.AudioApiRollout;
}
export const Enabled: Enabled;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AudioApiRollout | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AudioApiRollout | undefined;
}
export type AudioApiRollout = AudioApiRollout.Disabled | AudioApiRollout.Automatic | AudioApiRollout.Enabled;
/**
* Describes the channel layout of an audio stream.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout)
*/
export namespace AudioChannelLayout {
/**
* Monaural audio streams contain only one **Center** channel. 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Mono)
*/
export interface Mono extends globalThis.EnumItem {
Name: "Mono";
Value: 0;
EnumType: typeof globalThis.Enum.AudioChannelLayout;
}
export const Mono: Mono;
/**
* Stereophonic audio streams consist of two channels: **Left** and **Right**. 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Stereo)
*/
export interface Stereo extends globalThis.EnumItem {
Name: "Stereo";
Value: 1;
EnumType: typeof globalThis.Enum.AudioChannelLayout;
}
export const Stereo: Stereo;
/**
* Quadrophonic audio streams consist of four channels: **Left**, **Right**, **BackLeft**, and **BackRight**. Quadrophonic streams can encode forward/backward spatial information that stereo streams might struggle with. 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Quad)
*/
export interface Quad extends globalThis.EnumItem {
Name: "Quad";
Value: 2;
EnumType: typeof globalThis.Enum.AudioChannelLayout;
}
export const Quad: Quad;
/**
* Surround sound audio streams consist of five channels: **Left**, **Right**, **Center**, **BackLeft**, and **BackRight**. Surround sound streams encode spatial information with better resolution front and center. 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_5)
*/
export interface Surround_5 extends globalThis.EnumItem {
Name: "Surround_5";
Value: 3;
EnumType: typeof globalThis.Enum.AudioChannelLayout;
}
export const Surround_5: Surround_5;
/**
* 5.1 surround sound consists of six channels: **Left**, **Right**, **Center**, **BackLeft**, **BackRight**, and a **Sub** (subsonic) low‑frequency channel. 5.1 surround sound benefits from low frequencies being less directional in order to encode higher resolution spatial information versus simple 5‑channel surround sound. 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_5_1)
*/
export interface Surround_5_1 extends globalThis.EnumItem {
Name: "Surround_5_1";
Value: 4;
EnumType: typeof globalThis.Enum.AudioChannelLayout;
}
export const Surround_5_1: Surround_5_1;
/**
* 7.1 surround sound consists of eight channels: **Left**, **Right**, **Center**, **SurroundLeft**, **SurroundRight**, **BackLeft**, **BackRight**, and a **Sub** (subsonic) low‑frequency channel. 7.1 surround sound is an improvement over 5.1 surround sound, offering better spatial resolution directly to the left and right as well. 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_7_1)
*/
export interface Surround_7_1 extends globalThis.EnumItem {
Name: "Surround_7_1";
Value: 5;
EnumType: typeof globalThis.Enum.AudioChannelLayout;
}
export const Surround_7_1: Surround_7_1;
/**
* 7.1.4 surround sound consists of twelve channels: **Left**, **Right**, **Center**, **SurroundLeft**, **SurroundRight**, **BackLeft**, **BackRight**, **Sub**, **TopLeft**, **TopRight**, **TopBackLeft**, and **TopBackRight**. 7.1.4 is the only currently supported channel layout that encodes height information. 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_7_1_4)
*/
export interface Surround_7_1_4 extends globalThis.EnumItem {
Name: "Surround_7_1_4";
Value: 6;
EnumType: typeof globalThis.Enum.AudioChannelLayout;
}
export const Surround_7_1_4: Surround_7_1_4;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AudioChannelLayout | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AudioChannelLayout | undefined;
}
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;
/**
* Filter types used for `AudioFilter` instances.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType)
*/
export namespace AudioFilterType {
/**
* Filter that boosts or reduces sound near a specified `Frequency`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Peak)
*/
export interface Peak extends globalThis.EnumItem {
Name: "Peak";
Value: 0;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const Peak: Peak;
/**
* Filter that boosts or reduces sound below a specified `Frequency`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#LowShelf)
*/
export interface LowShelf extends globalThis.EnumItem {
Name: "LowShelf";
Value: 1;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const LowShelf: LowShelf;
/**
* Filter that boosts or reduces sound above a specified `Frequency`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#HighShelf)
*/
export interface HighShelf extends globalThis.EnumItem {
Name: "HighShelf";
Value: 2;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const HighShelf: HighShelf;
/**
* Filter that cuts sound above a specified `Frequency`, at a slope of -12dB/octave.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Lowpass12dB)
*/
export interface Lowpass12dB extends globalThis.EnumItem {
Name: "Lowpass12dB";
Value: 3;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const Lowpass12dB: Lowpass12dB;
/**
* Filter that cuts sound above a specified `Frequency`, at a slope of -24dB/octave.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Lowpass24dB)
*/
export interface Lowpass24dB extends globalThis.EnumItem {
Name: "Lowpass24dB";
Value: 4;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const Lowpass24dB: Lowpass24dB;
/**
* Filter that cuts sound above a specified `Frequency`, at a slope of -48dB/octave.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Lowpass48dB)
*/
export interface Lowpass48dB extends globalThis.EnumItem {
Name: "Lowpass48dB";
Value: 5;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const Lowpass48dB: Lowpass48dB;
/**
* Filter that cuts sound below a specified `Frequency`, at a slope of -12dB/octave.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Highpass12dB)
*/
export interface Highpass12dB extends globalThis.EnumItem {
Name: "Highpass12dB";
Value: 6;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const Highpass12dB: Highpass12dB;
/**
* Filter that cuts sound below a specified `Frequency`, at a slope of -24dB/octave.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Highpass24dB)
*/
export interface Highpass24dB extends globalThis.EnumItem {
Name: "Highpass24dB";
Value: 7;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const Highpass24dB: Highpass24dB;
/**
* Filter that cuts sound below a specified `Frequency`, at a slope of -48dB/octave.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Highpass48dB)
*/
export interface Highpass48dB extends globalThis.EnumItem {
Name: "Highpass48dB";
Value: 8;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const Highpass48dB: Highpass48dB;
/**
* Filter that only allows sound near a specified `Frequency` to be heard.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Bandpass)
*/
export interface Bandpass extends globalThis.EnumItem {
Name: "Bandpass";
Value: 9;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const Bandpass: Bandpass;
/**
* Filter that cuts sound near a specified `Frequency`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Notch)
*/
export interface Notch extends globalThis.EnumItem {
Name: "Notch";
Value: 10;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const Notch: Notch;
/**
* Filter that cuts sound above a specified `Frequency`, at a slope of -6dB/octave.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Lowpass6dB)
*/
export interface Lowpass6dB extends globalThis.EnumItem {
Name: "Lowpass6dB";
Value: 11;
EnumType: typeof globalThis.Enum.AudioFilterType;
}
export const Lowpass6dB: Lowpass6dB;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AudioFilterType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AudioFilterType | undefined;
}
export type AudioFilterType = AudioFilterType.Peak | AudioFilterType.LowShelf | AudioFilterType.HighShelf | AudioFilterType.Lowpass12dB | AudioFilterType.Lowpass24dB | AudioFilterType.Lowpass48dB | AudioFilterType.Highpass12dB | AudioFilterType.Highpass24dB | AudioFilterType.Highpass48dB | AudioFilterType.Bandpass | AudioFilterType.Notch | AudioFilterType.Lowpass6dB;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioPositionType)
*/
export namespace AudioPositionType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioPositionType#Parent)
*/
export interface Parent extends globalThis.EnumItem {
Name: "Parent";
Value: 0;
EnumType: typeof globalThis.Enum.AudioPositionType;
}
export const Parent: Parent;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioPositionType#Instance)
*/
export interface Instance extends globalThis.EnumItem {
Name: "Instance";
Value: 1;
EnumType: typeof globalThis.Enum.AudioPositionType;
}
export const Instance: Instance;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AudioPositionType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AudioPositionType | undefined;
}
export type AudioPositionType = AudioPositionType.Parent | AudioPositionType.Instance;
/**
* Describes the numeric format used to represent individual audio samples.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioSampleFormat)
*/
export namespace AudioSampleFormat {
/**
* Samples are represented as 16-bit signed integers, ranging from `-32768` to `32767`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioSampleFormat#Int16)
*/
export interface Int16 extends globalThis.EnumItem {
Name: "Int16";
Value: 0;
EnumType: typeof globalThis.Enum.AudioSampleFormat;
}
export const Int16: Int16;
/**
* Samples are represented as 32-bit floating-point numbers, typically ranging from `-1.0` to `0`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioSampleFormat#Float32)
*/
export interface Float32 extends globalThis.EnumItem {
Name: "Float32";
Value: 1;
EnumType: typeof globalThis.Enum.AudioSampleFormat;
}
export const Float32: Float32;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AudioSampleFormat | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AudioSampleFormat | undefined;
}
export type AudioSampleFormat = AudioSampleFormat.Int16 | AudioSampleFormat.Float32;
/**
* Enum which determines how detailed audio simulation should be for `AudioEmitters` and `AudioListeners`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioSimulationFidelity)
*/
export namespace AudioSimulationFidelity {
/**
* No acoustic simulation occurs; only direction and distance are taken into account.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioSimulationFidelity#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.AudioSimulationFidelity;
}
export const None: None;
/**
* The audio engine simulates transmission, diffraction, and reflections at a level of detail suitable to most devices.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioSimulationFidelity#Automatic)
*/
export interface Automatic extends globalThis.EnumItem {
Name: "Automatic";
Value: 1;
EnumType: typeof globalThis.Enum.AudioSimulationFidelity;
}
export const Automatic: Automatic;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AudioSimulationFidelity | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AudioSimulationFidelity | undefined;
}
export type AudioSimulationFidelity = AudioSimulationFidelity.None | AudioSimulationFidelity.Automatic;
/**
* The categorization of an audio asset.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioSubType)
*/
export namespace AudioSubType {
/**
* Represents an asset which contains music.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioSubType#Music)
*/
export interface Music extends globalThis.EnumItem {
Name: "Music";
Value: 1;
EnumType: typeof globalThis.Enum.AudioSubType;
}
export const Music: Music;
/**
* Represents an asset which is a sound effect.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioSubType#SoundEffect)
*/
export interface SoundEffect extends globalThis.EnumItem {
Name: "SoundEffect";
Value: 2;
EnumType: typeof globalThis.Enum.AudioSubType;
}
export const SoundEffect: SoundEffect;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AudioSubType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AudioSubType | undefined;
}
export type AudioSubType = AudioSubType.Music | AudioSubType.SoundEffect;
/**
* For audio effects that use some internal buffering, determines the window-size used.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioWindowSize)
*/
export namespace AudioWindowSize {
/**
* The smallest buffer size, providing the lowest latency at the cost of frequency resolution.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioWindowSize#Small)
*/
export interface Small extends globalThis.EnumItem {
Name: "Small";
Value: 0;
EnumType: typeof globalThis.Enum.AudioWindowSize;
}
export const Small: Small;
/**
* A mid-sized buffer that balances frequency resolution and latency.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioWindowSize#Medium)
*/
export interface Medium extends globalThis.EnumItem {
Name: "Medium";
Value: 1;
EnumType: typeof globalThis.Enum.AudioWindowSize;
}
export const Medium: Medium;
/**
* The largest buffer size, providing higher frequency resolution at the cost of more latency.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AudioWindowSize#Large)
*/
export interface Large extends globalThis.EnumItem {
Name: "Large";
Value: 2;
EnumType: typeof globalThis.Enum.AudioWindowSize;
}
export const Large: Large;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AudioWindowSize | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AudioWindowSize | undefined;
}
export type AudioWindowSize = AudioWindowSize.Small | AudioWindowSize.Medium | AudioWindowSize.Large;
/**
* Enum used with `Workspace.AuthorityMode`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AuthorityMode)
*/
export namespace AuthorityMode {
/**
* Server authority with client side prediction and rollback enabled.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AuthorityMode#Server)
*/
export interface Server extends globalThis.EnumItem {
Name: "Server";
Value: 0;
EnumType: typeof globalThis.Enum.AuthorityMode;
}
export const Server: Server;
/**
* Traditional distributed authority model where, for each instance, the engine decides whether the server or a client should be the authority; `BasePart:SetNetworkOwner()` can be used to influence the decision.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AuthorityMode#Automatic)
*/
export interface Automatic extends globalThis.EnumItem {
Name: "Automatic";
Value: 1;
EnumType: typeof globalThis.Enum.AuthorityMode;
}
export const Automatic: Automatic;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AuthorityMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AuthorityMode | undefined;
}
export type AuthorityMode = AuthorityMode.Server | AuthorityMode.Automatic;
/**
* Specifies how Roblox Studio automatically indents lines in the script editor.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AutoIndentRule)
*/
export namespace AutoIndentRule {
/**
* Disables automatic indentation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AutoIndentRule#Off)
*/
export interface Off extends globalThis.EnumItem {
Name: "Off";
Value: 0;
EnumType: typeof globalThis.Enum.AutoIndentRule;
}
export const Off: Off;
/**
* Indents new lines according to the script's block structure.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AutoIndentRule#Absolute)
*/
export interface Absolute extends globalThis.EnumItem {
Name: "Absolute";
Value: 1;
EnumType: typeof globalThis.Enum.AutoIndentRule;
}
export const Absolute: Absolute;
/**
* Indents new lines according to the script's block structure and the indentation of the reference line.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AutoIndentRule#Relative)
*/
export interface Relative extends globalThis.EnumItem {
Name: "Relative";
Value: 2;
EnumType: typeof globalThis.Enum.AutoIndentRule;
}
export const Relative: Relative;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AutoIndentRule | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AutoIndentRule | undefined;
}
export type AutoIndentRule = AutoIndentRule.Off | AutoIndentRule.Absolute | AutoIndentRule.Relative;
/**
* UI objects with `AutomaticSize` enabled will increase in size up to maximum size allowed by the parent (if there is one) and no smaller than the `Size` property bounds.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AutomaticSize)
*/
export namespace AutomaticSize {
/**
* Default sizing behavior.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AutomaticSize#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.AutomaticSize;
}
export const None: None;
/**
* Automatically resize element along the **X** axis to fit child contents.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AutomaticSize#X)
*/
export interface X extends globalThis.EnumItem {
Name: "X";
Value: 1;
EnumType: typeof globalThis.Enum.AutomaticSize;
}
export const X: X;
/**
* Automatically resize element along the **Y** axis to fit child contents. Text objects will only resize along the **Y** axis if their `TextWrapped` property is enabled.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AutomaticSize#Y)
*/
export interface Y extends globalThis.EnumItem {
Name: "Y";
Value: 2;
EnumType: typeof globalThis.Enum.AutomaticSize;
}
export const Y: Y;
/**
* Automatically resize element along the **X** and **Y** axes to fit child contents.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AutomaticSize#XY)
*/
export interface XY extends globalThis.EnumItem {
Name: "XY";
Value: 3;
EnumType: typeof globalThis.Enum.AutomaticSize;
}
export const XY: XY;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AutomaticSize | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AutomaticSize | undefined;
}
export type AutomaticSize = AutomaticSize.None | AutomaticSize.X | AutomaticSize.Y | AutomaticSize.XY;
/**
* Describes the asset types that an avatar can equip.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType)
*/
export namespace AvatarAssetType {
/**
* A classic 2D TShirt.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#TShirt)
*/
export interface TShirt extends globalThis.EnumItem {
Name: "TShirt";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const TShirt: TShirt;
/**
* A hat.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Hat)
*/
export interface Hat extends globalThis.EnumItem {
Name: "Hat";
Value: 8;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const Hat: Hat;
/**
* A classic 2D shirt.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Shirt)
*/
export interface Shirt extends globalThis.EnumItem {
Name: "Shirt";
Value: 11;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const Shirt: Shirt;
/**
* A classic 2D pants.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Pants)
*/
export interface Pants extends globalThis.EnumItem {
Name: "Pants";
Value: 12;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const Pants: Pants;
/**
* A head.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Head)
*/
export interface Head extends globalThis.EnumItem {
Name: "Head";
Value: 17;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const Head: Head;
/**
* A face.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Face)
*/
export interface Face extends globalThis.EnumItem {
Name: "Face";
Value: 18;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const Face: Face;
/**
* A gear.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Gear)
*/
export interface Gear extends globalThis.EnumItem {
Name: "Gear";
Value: 19;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const Gear: Gear;
/**
* A torso.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Torso)
*/
export interface Torso extends globalThis.EnumItem {
Name: "Torso";
Value: 27;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const Torso: Torso;
/**
* A right arm.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#RightArm)
*/
export interface RightArm extends globalThis.EnumItem {
Name: "RightArm";
Value: 28;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const RightArm: RightArm;
/**
* A left arm.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#LeftArm)
*/
export interface LeftArm extends globalThis.EnumItem {
Name: "LeftArm";
Value: 29;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const LeftArm: LeftArm;
/**
* A left leg.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#LeftLeg)
*/
export interface LeftLeg extends globalThis.EnumItem {
Name: "LeftLeg";
Value: 30;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const LeftLeg: LeftLeg;
/**
* A right leg.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#RightLeg)
*/
export interface RightLeg extends globalThis.EnumItem {
Name: "RightLeg";
Value: 31;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const RightLeg: RightLeg;
/**
* A hair accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#HairAccessory)
*/
export interface HairAccessory extends globalThis.EnumItem {
Name: "HairAccessory";
Value: 41;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const HairAccessory: HairAccessory;
/**
* A face accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#FaceAccessory)
*/
export interface FaceAccessory extends globalThis.EnumItem {
Name: "FaceAccessory";
Value: 42;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const FaceAccessory: FaceAccessory;
/**
* A neck accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#NeckAccessory)
*/
export interface NeckAccessory extends globalThis.EnumItem {
Name: "NeckAccessory";
Value: 43;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const NeckAccessory: NeckAccessory;
/**
* A shoulder accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#ShoulderAccessory)
*/
export interface ShoulderAccessory extends globalThis.EnumItem {
Name: "ShoulderAccessory";
Value: 44;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const ShoulderAccessory: ShoulderAccessory;
/**
* A front accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#FrontAccessory)
*/
export interface FrontAccessory extends globalThis.EnumItem {
Name: "FrontAccessory";
Value: 45;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const FrontAccessory: FrontAccessory;
/**
* A back accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#BackAccessory)
*/
export interface BackAccessory extends globalThis.EnumItem {
Name: "BackAccessory";
Value: 46;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const BackAccessory: BackAccessory;
/**
* A waist accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#WaistAccessory)
*/
export interface WaistAccessory extends globalThis.EnumItem {
Name: "WaistAccessory";
Value: 47;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const WaistAccessory: WaistAccessory;
/**
* A climb animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#ClimbAnimation)
*/
export interface ClimbAnimation extends globalThis.EnumItem {
Name: "ClimbAnimation";
Value: 48;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const ClimbAnimation: ClimbAnimation;
/**
* A fall animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#FallAnimation)
*/
export interface FallAnimation extends globalThis.EnumItem {
Name: "FallAnimation";
Value: 50;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const FallAnimation: FallAnimation;
/**
* An idle animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#IdleAnimation)
*/
export interface IdleAnimation extends globalThis.EnumItem {
Name: "IdleAnimation";
Value: 51;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const IdleAnimation: IdleAnimation;
/**
* A jump animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#JumpAnimation)
*/
export interface JumpAnimation extends globalThis.EnumItem {
Name: "JumpAnimation";
Value: 52;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const JumpAnimation: JumpAnimation;
/**
* A run animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#RunAnimation)
*/
export interface RunAnimation extends globalThis.EnumItem {
Name: "RunAnimation";
Value: 53;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const RunAnimation: RunAnimation;
/**
* A swim animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#SwimAnimation)
*/
export interface SwimAnimation extends globalThis.EnumItem {
Name: "SwimAnimation";
Value: 54;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const SwimAnimation: SwimAnimation;
/**
* A walk animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#WalkAnimation)
*/
export interface WalkAnimation extends globalThis.EnumItem {
Name: "WalkAnimation";
Value: 55;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const WalkAnimation: WalkAnimation;
/**
* An emote animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#EmoteAnimation)
*/
export interface EmoteAnimation extends globalThis.EnumItem {
Name: "EmoteAnimation";
Value: 61;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const EmoteAnimation: EmoteAnimation;
/**
* A layered clothing TShirt.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#TShirtAccessory)
*/
export interface TShirtAccessory extends globalThis.EnumItem {
Name: "TShirtAccessory";
Value: 64;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const TShirtAccessory: TShirtAccessory;
/**
* @deprecated renamed to TShirtAccessory
*/
export const TeeShirtAccessory: TShirtAccessory;
/**
* A layered clothing shirt.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#ShirtAccessory)
*/
export interface ShirtAccessory extends globalThis.EnumItem {
Name: "ShirtAccessory";
Value: 65;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const ShirtAccessory: ShirtAccessory;
/**
* A layered clothing pants.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#PantsAccessory)
*/
export interface PantsAccessory extends globalThis.EnumItem {
Name: "PantsAccessory";
Value: 66;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const PantsAccessory: PantsAccessory;
/**
* A layered clothing jacket.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#JacketAccessory)
*/
export interface JacketAccessory extends globalThis.EnumItem {
Name: "JacketAccessory";
Value: 67;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const JacketAccessory: JacketAccessory;
/**
* A layered clothing sweater.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#SweaterAccessory)
*/
export interface SweaterAccessory extends globalThis.EnumItem {
Name: "SweaterAccessory";
Value: 68;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const SweaterAccessory: SweaterAccessory;
/**
* A layered clothing shorts.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#ShortsAccessory)
*/
export interface ShortsAccessory extends globalThis.EnumItem {
Name: "ShortsAccessory";
Value: 69;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const ShortsAccessory: ShortsAccessory;
/**
* A layered clothing left shoe.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#LeftShoeAccessory)
*/
export interface LeftShoeAccessory extends globalThis.EnumItem {
Name: "LeftShoeAccessory";
Value: 70;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const LeftShoeAccessory: LeftShoeAccessory;
/**
* A layered clothing right shoe.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#RightShoeAccessory)
*/
export interface RightShoeAccessory extends globalThis.EnumItem {
Name: "RightShoeAccessory";
Value: 71;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const RightShoeAccessory: RightShoeAccessory;
/**
* A layered clothing dress or skirt.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#DressSkirtAccessory)
*/
export interface DressSkirtAccessory extends globalThis.EnumItem {
Name: "DressSkirtAccessory";
Value: 72;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const DressSkirtAccessory: DressSkirtAccessory;
/**
* A layered eyebrow accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#EyebrowAccessory)
*/
export interface EyebrowAccessory extends globalThis.EnumItem {
Name: "EyebrowAccessory";
Value: 76;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const EyebrowAccessory: EyebrowAccessory;
/**
* A layered eyelash accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#EyelashAccessory)
*/
export interface EyelashAccessory extends globalThis.EnumItem {
Name: "EyelashAccessory";
Value: 77;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const EyelashAccessory: EyelashAccessory;
/**
* A mood animation that drives a character's facial expression.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#MoodAnimation)
*/
export interface MoodAnimation extends globalThis.EnumItem {
Name: "MoodAnimation";
Value: 78;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const MoodAnimation: MoodAnimation;
/**
* A head with facial animation support.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#DynamicHead)
*/
export interface DynamicHead extends globalThis.EnumItem {
Name: "DynamicHead";
Value: 79;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const DynamicHead: DynamicHead;
/**
* Face makeup applied to a character's head.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#FaceMakeup)
*/
export interface FaceMakeup extends globalThis.EnumItem {
Name: "FaceMakeup";
Value: 88;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const FaceMakeup: FaceMakeup;
/**
* Lip makeup applied to a character's face.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#LipMakeup)
*/
export interface LipMakeup extends globalThis.EnumItem {
Name: "LipMakeup";
Value: 89;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const LipMakeup: LipMakeup;
/**
* Eye makeup applied to a character's face.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#EyeMakeup)
*/
export interface EyeMakeup extends globalThis.EnumItem {
Name: "EyeMakeup";
Value: 90;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const EyeMakeup: EyeMakeup;
/**
* A 2D image background displayed behind a user's avatar on their profile and thumbnail surfaces.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#AvatarBackground)
*/
export interface AvatarBackground extends globalThis.EnumItem {
Name: "AvatarBackground";
Value: 92;
EnumType: typeof globalThis.Enum.AvatarAssetType;
}
export const AvatarBackground: AvatarBackground;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarAssetType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarAssetType | undefined;
}
export type AvatarAssetType = AvatarAssetType.TShirt | AvatarAssetType.Hat | AvatarAssetType.Shirt | AvatarAssetType.Pants | AvatarAssetType.Head | AvatarAssetType.Face | AvatarAssetType.Gear | AvatarAssetType.Torso | AvatarAssetType.RightArm | AvatarAssetType.LeftArm | AvatarAssetType.LeftLeg | AvatarAssetType.RightLeg | AvatarAssetType.HairAccessory | AvatarAssetType.FaceAccessory | AvatarAssetType.NeckAccessory | AvatarAssetType.ShoulderAccessory | AvatarAssetType.FrontAccessory | AvatarAssetType.BackAccessory | AvatarAssetType.WaistAccessory | AvatarAssetType.ClimbAnimation | AvatarAssetType.FallAnimation | AvatarAssetType.IdleAnimation | AvatarAssetType.JumpAnimation | AvatarAssetType.RunAnimation | AvatarAssetType.SwimAnimation | AvatarAssetType.WalkAnimation | AvatarAssetType.EmoteAnimation | AvatarAssetType.TShirtAccessory | AvatarAssetType.ShirtAccessory | AvatarAssetType.PantsAccessory | AvatarAssetType.JacketAccessory | AvatarAssetType.SweaterAccessory | AvatarAssetType.ShortsAccessory | AvatarAssetType.LeftShoeAccessory | AvatarAssetType.RightShoeAccessory | AvatarAssetType.DressSkirtAccessory | AvatarAssetType.EyebrowAccessory | AvatarAssetType.EyelashAccessory | AvatarAssetType.MoodAnimation | AvatarAssetType.DynamicHead | AvatarAssetType.FaceMakeup | AvatarAssetType.LipMakeup | AvatarAssetType.EyeMakeup | AvatarAssetType.AvatarBackground;
/**
* A bitmask enum whose items represent individual avatar chat capabilities for voice and video communication within an experience.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature)
*/
export namespace AvatarChatServiceFeature {
/**
* No avatar chat features are enabled. This is the default value of the bitmask before any capabilities are resolved.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
}
export const None: None;
/**
* Voice chat audio is enabled at the universe level. This is a server-side setting configured by the experience creator; it must be combined with `AvatarChatServiceFeature.PlaceAudio` for audio to be active in a given place.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UniverseAudio)
*/
export interface UniverseAudio extends globalThis.EnumItem {
Name: "UniverseAudio";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
}
export const UniverseAudio: UniverseAudio;
/**
* Avatar video (camera-based facial animation) is enabled at the universe level. This is a server-side setting configured by the experience creator; it must be combined with `AvatarChatServiceFeature.PlaceVideo` for video to be active in a given place.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UniverseVideo)
*/
export interface UniverseVideo extends globalThis.EnumItem {
Name: "UniverseVideo";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
}
export const UniverseVideo: UniverseVideo;
/**
* Voice chat audio is enabled for the current place. Both this flag and `AvatarChatServiceFeature.UniverseAudio` must be set for audio to be active in the place.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#PlaceAudio)
*/
export interface PlaceAudio extends globalThis.EnumItem {
Name: "PlaceAudio";
Value: 4;
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
}
export const PlaceAudio: PlaceAudio;
/**
* Avatar video (camera-based facial animation) is enabled for the current place. Both this flag and `AvatarChatServiceFeature.UniverseVideo` must be set for video to be active in the place.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#PlaceVideo)
*/
export interface PlaceVideo extends globalThis.EnumItem {
Name: "PlaceVideo";
Value: 8;
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
}
export const PlaceVideo: PlaceVideo;
/**
* The user meets the requirements to use voice chat audio (age-verified, not banned, etc.). Eligibility is resolved per-player from backend permissions; it does not imply the user has opted in (see `AvatarChatServiceFeature.UserAudio`).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserAudioEligible)
*/
export interface UserAudioEligible extends globalThis.EnumItem {
Name: "UserAudioEligible";
Value: 16;
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
}
export const UserAudioEligible: UserAudioEligible;
/**
* The user has opted in to voice chat audio. This flag is only meaningful when `AvatarChatServiceFeature.UserAudioEligible` is also set; together they indicate the user both can and has chosen to use voice.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserAudio)
*/
export interface UserAudio extends globalThis.EnumItem {
Name: "UserAudio";
Value: 32;
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
}
export const UserAudio: UserAudio;
/**
* The user meets the requirements to use avatar video (camera-based facial animation). Eligibility is resolved per-player from backend permissions; it does not imply the user has opted in (see `AvatarChatServiceFeature.UserVideo`).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserVideoEligible)
*/
export interface UserVideoEligible extends globalThis.EnumItem {
Name: "UserVideoEligible";
Value: 64;
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
}
export const UserVideoEligible: UserVideoEligible;
/**
* The user has opted in to avatar video (camera-based facial animation). This flag is only meaningful when `AvatarChatServiceFeature.UserVideoEligible` is also set; together they indicate the user both can and has chosen to use video.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserVideo)
*/
export interface UserVideo extends globalThis.EnumItem {
Name: "UserVideo";
Value: 128;
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
}
export const UserVideo: UserVideo;
/**
* The user is currently banned from avatar chat features. When this flag is present in the client features mask, voice and video capabilities are unavailable to the player regardless of other eligibility flags.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserBanned)
*/
export interface UserBanned extends globalThis.EnumItem {
Name: "UserBanned";
Value: 256;
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
}
export const UserBanned: UserBanned;
/**
* The user has completed voice verification.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserVerifiedForVoice)
*/
export interface UserVerifiedForVoice extends globalThis.EnumItem {
Name: "UserVerifiedForVoice";
Value: 512;
EnumType: typeof globalThis.Enum.AvatarChatServiceFeature;
}
export const UserVerifiedForVoice: UserVerifiedForVoice;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarChatServiceFeature | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarChatServiceFeature | undefined;
}
export type AvatarChatServiceFeature = AvatarChatServiceFeature.None | AvatarChatServiceFeature.UniverseAudio | AvatarChatServiceFeature.UniverseVideo | AvatarChatServiceFeature.PlaceAudio | AvatarChatServiceFeature.PlaceVideo | AvatarChatServiceFeature.UserAudioEligible | AvatarChatServiceFeature.UserAudio | AvatarChatServiceFeature.UserVideoEligible | AvatarChatServiceFeature.UserVideo | AvatarChatServiceFeature.UserBanned | AvatarChatServiceFeature.UserVerifiedForVoice;
/**
* Options for the Avatar Context Menu, a menu that allows users to interact with other players' characters in an experience.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarContextMenuOption)
*/
export namespace AvatarContextMenuOption {
/**
* Sends a friend request to the selected user.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarContextMenuOption#Friend)
*/
export interface Friend extends globalThis.EnumItem {
Name: "Friend";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarContextMenuOption;
}
export const Friend: Friend;
/**
* Opens a private conversation with the selected user in the in-game chat.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarContextMenuOption#Chat)
*/
export interface Chat extends globalThis.EnumItem {
Name: "Chat";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarContextMenuOption;
}
export const Chat: Chat;
/**
* Plays a wave emote animation directed at the selected user.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarContextMenuOption#Emote)
*/
export interface Emote extends globalThis.EnumItem {
Name: "Emote";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarContextMenuOption;
}
export const Emote: Emote;
/**
* Opens the Avatar Inspect Menu to view the selected user's avatar and equipped items.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarContextMenuOption#InspectMenu)
*/
export interface InspectMenu extends globalThis.EnumItem {
Name: "InspectMenu";
Value: 3;
EnumType: typeof globalThis.Enum.AvatarContextMenuOption;
}
export const InspectMenu: InspectMenu;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarContextMenuOption | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarContextMenuOption | undefined;
}
export type AvatarContextMenuOption = AvatarContextMenuOption.Friend | AvatarContextMenuOption.Chat | AvatarContextMenuOption.Emote | AvatarContextMenuOption.InspectMenu;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarGenerationError)
*/
export namespace AvatarGenerationError {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarGenerationError#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarGenerationError;
}
export const None: None;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarGenerationError#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarGenerationError;
}
export const Unknown: Unknown;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarGenerationError#DownloadFailed)
*/
export interface DownloadFailed extends globalThis.EnumItem {
Name: "DownloadFailed";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarGenerationError;
}
export const DownloadFailed: DownloadFailed;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarGenerationError#Canceled)
*/
export interface Canceled extends globalThis.EnumItem {
Name: "Canceled";
Value: 3;
EnumType: typeof globalThis.Enum.AvatarGenerationError;
}
export const Canceled: Canceled;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarGenerationError#Offensive)
*/
export interface Offensive extends globalThis.EnumItem {
Name: "Offensive";
Value: 4;
EnumType: typeof globalThis.Enum.AvatarGenerationError;
}
export const Offensive: Offensive;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarGenerationError#Timeout)
*/
export interface Timeout extends globalThis.EnumItem {
Name: "Timeout";
Value: 5;
EnumType: typeof globalThis.Enum.AvatarGenerationError;
}
export const Timeout: Timeout;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarGenerationError#JobNotFound)
*/
export interface JobNotFound extends globalThis.EnumItem {
Name: "JobNotFound";
Value: 6;
EnumType: typeof globalThis.Enum.AvatarGenerationError;
}
export const JobNotFound: JobNotFound;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarGenerationError | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarGenerationError | undefined;
}
export type AvatarGenerationError = AvatarGenerationError.None | AvatarGenerationError.Unknown | AvatarGenerationError.DownloadFailed | AvatarGenerationError.Canceled | AvatarGenerationError.Offensive | AvatarGenerationError.Timeout | AvatarGenerationError.JobNotFound;
/**
* The type (Asset or Bundle) of avatar items.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarItemType)
*/
export namespace AvatarItemType {
/**
* An individual avatar catalog item such as a hat, shirt, or accessory, identified by an asset ID.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarItemType#Asset)
*/
export interface Asset extends globalThis.EnumItem {
Name: "Asset";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarItemType;
}
export const Asset: Asset;
/**
* A collection of related avatar items sold together as a group, identified by a bundle ID.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarItemType#Bundle)
*/
export interface Bundle extends globalThis.EnumItem {
Name: "Bundle";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarItemType;
}
export const Bundle: Bundle;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarItemType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarItemType | undefined;
}
export type AvatarItemType = AvatarItemType.Asset | AvatarItemType.Bundle;
/**
* The result of prompt operations of `AvatarEditorService`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarPromptResult)
*/
export namespace AvatarPromptResult {
/**
* The prompted action was completed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarPromptResult#Success)
*/
export interface Success extends globalThis.EnumItem {
Name: "Success";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarPromptResult;
}
export const Success: Success;
/**
* Denied permission to take the prompted action.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarPromptResult#PermissionDenied)
*/
export interface PermissionDenied extends globalThis.EnumItem {
Name: "PermissionDenied";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarPromptResult;
}
export const PermissionDenied: PermissionDenied;
/**
* Failure while trying to take the prompted action.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarPromptResult#Failed)
*/
export interface Failed extends globalThis.EnumItem {
Name: "Failed";
Value: 3;
EnumType: typeof globalThis.Enum.AvatarPromptResult;
}
export const Failed: Failed;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarPromptResult | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarPromptResult | undefined;
}
export type AvatarPromptResult = AvatarPromptResult.Success | AvatarPromptResult.PermissionDenied | AvatarPromptResult.Failed;
/**
* Determines how `AvatarAccessoryRules` enforces accessory size limits when an accessory exceeds the configured bounds.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod)
*/
export namespace AvatarSettingsAccessoryLimitMethod {
/**
* Scales down rigid accessories that exceed the configured bounds, or removes them if scaling would reduce them below minimum size thresholds.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod#Scale)
*/
export interface Scale extends globalThis.EnumItem {
Name: "Scale";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsAccessoryLimitMethod;
}
export const Scale: Scale;
/**
* Destroys any rigid accessory whose bounding box exceeds the configured bounds.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod#Remove)
*/
export interface Remove extends globalThis.EnumItem {
Name: "Remove";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsAccessoryLimitMethod;
}
export const Remove: Remove;
/**
* Reports whether an accessory would be scaled or removed for exceeding the configured bounds without actually modifying it.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod#PreviewScale)
*/
export interface PreviewScale extends globalThis.EnumItem {
Name: "PreviewScale";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarSettingsAccessoryLimitMethod;
}
export const PreviewScale: PreviewScale;
/**
* Reports whether an accessory would be removed for exceeding the configured bounds without actually destroying it.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod#PreviewRemove)
*/
export interface PreviewRemove extends globalThis.EnumItem {
Name: "PreviewRemove";
Value: 3;
EnumType: typeof globalThis.Enum.AvatarSettingsAccessoryLimitMethod;
}
export const PreviewRemove: PreviewRemove;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsAccessoryLimitMethod | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsAccessoryLimitMethod | undefined;
}
export type AvatarSettingsAccessoryLimitMethod = AvatarSettingsAccessoryLimitMethod.Scale | AvatarSettingsAccessoryLimitMethod.Remove | AvatarSettingsAccessoryLimitMethod.PreviewScale | AvatarSettingsAccessoryLimitMethod.PreviewRemove;
/**
* Determines whether `AvatarAccessoryRules` enforces custom size limits on rigid accessories worn by player avatars.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryMode)
*/
export namespace AvatarSettingsAccessoryMode {
/**
* No custom size limits are applied to rigid accessories; the player's own accessory choices are displayed without modification.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryMode#PlayerChoice)
*/
export interface PlayerChoice extends globalThis.EnumItem {
Name: "PlayerChoice";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsAccessoryMode;
}
export const PlayerChoice: PlayerChoice;
/**
* The experience enforces custom size limits on rigid accessories using the LimitBounds and LimitMethod properties of `AvatarAccessoryRules`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryMode#CustomLimit)
*/
export interface CustomLimit extends globalThis.EnumItem {
Name: "CustomLimit";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsAccessoryMode;
}
export const CustomLimit: CustomLimit;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsAccessoryMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsAccessoryMode | undefined;
}
export type AvatarSettingsAccessoryMode = AvatarSettingsAccessoryMode.PlayerChoice | AvatarSettingsAccessoryMode.CustomLimit;
/**
* Determines whether avatar animation clips are defined by the experience or if they are determined by `AnimationPacksMode`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationClipsMode)
*/
export namespace AvatarSettingsAnimationClipsMode {
/**
* The clips determined by the `AnimationPacksMode` are used, without experience-level overrides.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationClipsMode#PlayerChoice)
*/
export interface PlayerChoice extends globalThis.EnumItem {
Name: "PlayerChoice";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsAnimationClipsMode;
}
export const PlayerChoice: PlayerChoice;
/**
* The experience overrides individual animation clips using the per-clip enabled and ID properties on `AvatarAnimationRules` (for example, `CustomRunAnimationEnabled` and `CustomRunAnimationId`). Only clips whose enabled flag is true are replaced.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationClipsMode#CustomClips)
*/
export interface CustomClips extends globalThis.EnumItem {
Name: "CustomClips";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsAnimationClipsMode;
}
export const CustomClips: CustomClips;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsAnimationClipsMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsAnimationClipsMode | undefined;
}
export type AvatarSettingsAnimationClipsMode = AvatarSettingsAnimationClipsMode.PlayerChoice | AvatarSettingsAnimationClipsMode.CustomClips;
/**
* Determines which base animation pack is applied to avatar characters, controlling whether players use their own equipped animations or the experience forces a standard R15 or R6 animation set.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationPacksMode)
*/
export namespace AvatarSettingsAnimationPacksMode {
/**
* The player's own equipped animation pack is used. The character's Animate script supplies the animations without experience-level overrides.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationPacksMode#PlayerChoice)
*/
export interface PlayerChoice extends globalThis.EnumItem {
Name: "PlayerChoice";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsAnimationPacksMode;
}
export const PlayerChoice: PlayerChoice;
/**
* The experience forces the standard R15 animation pack on all characters, overriding player-equipped animations with a fixed set of R15 locomotion clips.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationPacksMode#StandardR15)
*/
export interface StandardR15 extends globalThis.EnumItem {
Name: "StandardR15";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsAnimationPacksMode;
}
export const StandardR15: StandardR15;
/**
* The experience forces the standard R6 animation pack on all (R15) characters, overriding player-equipped animations with a fixed set of R6-style locomotion clips plus additional R6-style emote and tool animations.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationPacksMode#StandardR6)
*/
export interface StandardR6 extends globalThis.EnumItem {
Name: "StandardR6";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarSettingsAnimationPacksMode;
}
export const StandardR6: StandardR6;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsAnimationPacksMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsAnimationPacksMode | undefined;
}
export type AvatarSettingsAnimationPacksMode = AvatarSettingsAnimationPacksMode.PlayerChoice | AvatarSettingsAnimationPacksMode.StandardR15 | AvatarSettingsAnimationPacksMode.StandardR6;
/**
* Determines how the avatar's body-part appearance is sourced in an experience that uses `AvatarBodyRules`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAppearanceMode)
*/
export namespace AvatarSettingsAppearanceMode {
/**
* Players keep their own avatar body parts; the experience does not override any body-part assets.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAppearanceMode#PlayerChoice)
*/
export interface PlayerChoice extends globalThis.EnumItem {
Name: "PlayerChoice";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsAppearanceMode;
}
export const PlayerChoice: PlayerChoice;
/**
* The experience overrides individual body parts (head, face, torso, arms, legs) using per-part asset IDs and enablement settings on `AvatarBodyRules`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAppearanceMode#CustomParts)
*/
export interface CustomParts extends globalThis.EnumItem {
Name: "CustomParts";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsAppearanceMode;
}
export const CustomParts: CustomParts;
/**
* The experience replaces the avatar's entire body as a single unit, using `CustomBodyType` and `CustomBodyBundleId`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAppearanceMode#CustomBody)
*/
export interface CustomBody extends globalThis.EnumItem {
Name: "CustomBody";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarSettingsAppearanceMode;
}
export const CustomBody: CustomBody;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsAppearanceMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsAppearanceMode | undefined;
}
export type AvatarSettingsAppearanceMode = AvatarSettingsAppearanceMode.PlayerChoice | AvatarSettingsAppearanceMode.CustomParts | AvatarSettingsAppearanceMode.CustomBody;
/**
* Determines whether players can freely scale their avatar body or whether the experience enforces custom scale ranges.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsBuildMode)
*/
export namespace AvatarSettingsBuildMode {
/**
* Players can scale their avatar body freely within the full platform-wide limits. This is the default value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsBuildMode#PlayerChoice)
*/
export interface PlayerChoice extends globalThis.EnumItem {
Name: "PlayerChoice";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsBuildMode;
}
export const PlayerChoice: PlayerChoice;
/**
* The experience enforces creator-defined min/max ranges for avatar body scales (height, width, head, body type, and proportions), overriding the platform defaults.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsBuildMode#CustomBuild)
*/
export interface CustomBuild extends globalThis.EnumItem {
Name: "CustomBuild";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsBuildMode;
}
export const CustomBuild: CustomBuild;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsBuildMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsBuildMode | undefined;
}
export type AvatarSettingsBuildMode = AvatarSettingsBuildMode.PlayerChoice | AvatarSettingsBuildMode.CustomBuild;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCharacterControllerMode)
*/
export namespace AvatarSettingsCharacterControllerMode {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCharacterControllerMode#LegacyHumanoid)
*/
export interface LegacyHumanoid extends globalThis.EnumItem {
Name: "LegacyHumanoid";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsCharacterControllerMode;
}
export const LegacyHumanoid: LegacyHumanoid;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCharacterControllerMode#LuaCharacterController)
*/
export interface LuaCharacterController extends globalThis.EnumItem {
Name: "LuaCharacterController";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsCharacterControllerMode;
}
export const LuaCharacterController: LuaCharacterController;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsCharacterControllerMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsCharacterControllerMode | undefined;
}
export type AvatarSettingsCharacterControllerMode = AvatarSettingsCharacterControllerMode.LegacyHumanoid | AvatarSettingsCharacterControllerMode.LuaCharacterController;
/**
* Determines whether the experience applies a spatial bounding limit to layered clothing on player characters.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsClothingMode)
*/
export namespace AvatarSettingsClothingMode {
/**
* No spatial limit is applied to layered clothing; the player's layered clothing accessories deform without a bounding constraint.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsClothingMode#PlayerChoice)
*/
export interface PlayerChoice extends globalThis.EnumItem {
Name: "PlayerChoice";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsClothingMode;
}
export const PlayerChoice: PlayerChoice;
/**
* Applies a custom spatial limit to layered clothing based on `LimitBounds`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsClothingMode#CustomLimit)
*/
export interface CustomLimit extends globalThis.EnumItem {
Name: "CustomLimit";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsClothingMode;
}
export const CustomLimit: CustomLimit;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsClothingMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsClothingMode | undefined;
}
export type AvatarSettingsClothingMode = AvatarSettingsClothingMode.PlayerChoice | AvatarSettingsClothingMode.CustomLimit;
/**
* Determines the collision geometry mode for avatars managed by `AvatarCollisionRules`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCollisionMode)
*/
export namespace AvatarSettingsCollisionMode {
/**
* Each body part uses its native collision geometry. The HumanoidRootPart, UpperTorso, and LowerTorso collide while other parts do not. This is the default value for `CollisionMode`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCollisionMode#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsCollisionMode;
}
export const Default: Default;
/**
* A single box-shaped collider part replaces all per-part collision. The collider is welded to the HumanoidRootPart and sized by `SingleColliderSize` (default 2, 3, 1). All other parts become non-collidable and massless.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCollisionMode#SingleCollider)
*/
export interface SingleCollider extends globalThis.EnumItem {
Name: "SingleCollider";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsCollisionMode;
}
export const SingleCollider: SingleCollider;
/**
* Collision geometry is determined by `LegacyCollisionMode`, which selects either inner-box colliders or R6-style colliders.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCollisionMode#Legacy)
*/
export interface Legacy extends globalThis.EnumItem {
Name: "Legacy";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarSettingsCollisionMode;
}
export const Legacy: Legacy;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsCollisionMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsCollisionMode | undefined;
}
export type AvatarSettingsCollisionMode = AvatarSettingsCollisionMode.Default | AvatarSettingsCollisionMode.SingleCollider | AvatarSettingsCollisionMode.Legacy;
/**
* Determines whether `AvatarAccessoryRules` replaces player accessories with experience-defined custom accessories.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomAccessoryMode)
*/
export namespace AvatarSettingsCustomAccessoryMode {
/**
* No custom accessory replacement is applied; the player's own accessory choices are displayed without modification.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomAccessoryMode#PlayerChoice)
*/
export interface PlayerChoice extends globalThis.EnumItem {
Name: "PlayerChoice";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsCustomAccessoryMode;
}
export const PlayerChoice: PlayerChoice;
/**
* The experience replaces player accessories with custom accessories defined by the per-slot properties on `AvatarAccessoryRules`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomAccessoryMode#CustomAccessories)
*/
export interface CustomAccessories extends globalThis.EnumItem {
Name: "CustomAccessories";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsCustomAccessoryMode;
}
export const CustomAccessories: CustomAccessories;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsCustomAccessoryMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsCustomAccessoryMode | undefined;
}
export type AvatarSettingsCustomAccessoryMode = AvatarSettingsCustomAccessoryMode.PlayerChoice | AvatarSettingsCustomAccessoryMode.CustomAccessories;
/**
* Determines whether an experience's custom body override is identified by individual asset references or by a single bundle ID.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomBodyType)
*/
export namespace AvatarSettingsCustomBodyType {
/**
* The custom body is assembled from individual per-part asset references on `AvatarBodyRules`. This is the default value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomBodyType#AvatarReference)
*/
export interface AvatarReference extends globalThis.EnumItem {
Name: "AvatarReference";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsCustomBodyType;
}
export const AvatarReference: AvatarReference;
/**
* The custom body is sourced from a single avatar bundle, identified by the `CustomBodyBundleId` property.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomBodyType#BundleId)
*/
export interface BundleId extends globalThis.EnumItem {
Name: "BundleId";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsCustomBodyType;
}
export const BundleId: BundleId;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsCustomBodyType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsCustomBodyType | undefined;
}
export type AvatarSettingsCustomBodyType = AvatarSettingsCustomBodyType.AvatarReference | AvatarSettingsCustomBodyType.BundleId;
/**
* Determines whether an experience overrides a player's classic 2D or layered 3D clothing with creator-specified assets or preserves the player's own clothing choices.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomClothingMode)
*/
export namespace AvatarSettingsCustomClothingMode {
/**
* Players keep their own clothing selections. The experience does not override clothing assets. This is the default value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomClothingMode#PlayerChoice)
*/
export interface PlayerChoice extends globalThis.EnumItem {
Name: "PlayerChoice";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsCustomClothingMode;
}
export const PlayerChoice: PlayerChoice;
/**
* The experience enforces creator-specified clothing assets from `AvatarClothingRules`, overriding each player's own equipped clothing.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomClothingMode#CustomClothing)
*/
export interface CustomClothing extends globalThis.EnumItem {
Name: "CustomClothing";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsCustomClothingMode;
}
export const CustomClothing: CustomClothing;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsCustomClothingMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsCustomClothingMode | undefined;
}
export type AvatarSettingsCustomClothingMode = AvatarSettingsCustomClothingMode.PlayerChoice | AvatarSettingsCustomClothingMode.CustomClothing;
/**
* Determines whether hit detection and spatial queries use the individual body parts or the single collider when `CollisionMode` is `AvatarSettingsCollisionMode.SingleCollider`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsHitAndTouchDetectionMode)
*/
export namespace AvatarSettingsHitAndTouchDetectionMode {
/**
* Individual avatar body parts handle `Touched` events and spatial queries (`CanTouch` and `CanQuery` enabled on body parts) while the single collider part has `CanTouch` and `CanQuery` disabled. This is the default value for `HitAndTouchDetectionMode`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsHitAndTouchDetectionMode#UseParts)
*/
export interface UseParts extends globalThis.EnumItem {
Name: "UseParts";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsHitAndTouchDetectionMode;
}
export const UseParts: UseParts;
/**
* The single collider part handles `Touched` events and spatial queries (`CanTouch` and `CanQuery` enabled on the collider) while all individual body parts have `CanTouch` and `CanQuery` disabled.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsHitAndTouchDetectionMode#UseCollider)
*/
export interface UseCollider extends globalThis.EnumItem {
Name: "UseCollider";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsHitAndTouchDetectionMode;
}
export const UseCollider: UseCollider;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsHitAndTouchDetectionMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsHitAndTouchDetectionMode | undefined;
}
export type AvatarSettingsHitAndTouchDetectionMode = AvatarSettingsHitAndTouchDetectionMode.UseParts | AvatarSettingsHitAndTouchDetectionMode.UseCollider;
/**
* Determines whether the avatar jump setting for an experience is configured using jump height (studs) or jump power (force).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsJumpMode)
*/
export namespace AvatarSettingsJumpMode {
/**
* The avatar jump is configured using `Humanoid.JumpHeight`, which specifies the target jump height in studs. Corresponds to `Humanoid.UseJumpPower` being false.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsJumpMode#JumpHeight)
*/
export interface JumpHeight extends globalThis.EnumItem {
Name: "JumpHeight";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsJumpMode;
}
export const JumpHeight: JumpHeight;
/**
* The avatar jump is configured using `Humanoid.JumpPower`, which applies an upward force to the character. Corresponds to `Humanoid.UseJumpPower` being true.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsJumpMode#JumpPower)
*/
export interface JumpPower extends globalThis.EnumItem {
Name: "JumpPower";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsJumpMode;
}
export const JumpPower: JumpPower;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsJumpMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsJumpMode | undefined;
}
export type AvatarSettingsJumpMode = AvatarSettingsJumpMode.JumpHeight | AvatarSettingsJumpMode.JumpPower;
/**
* Determines which legacy collision geometry is applied to R15 avatars when `AvatarSettingsCollisionMode` is set to Legacy.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsLegacyCollisionMode)
*/
export namespace AvatarSettingsLegacyCollisionMode {
/**
* Creates six invisible box collider parts welded to R15 limbs to approximate classic R6 collision geometry. The engine spawns six invisible `Part` instances (head, torso, left arm, right arm, left leg, right leg) parented to the character and welded to the corresponding R15 body parts. All original R15 mesh parts have their `BasePart.CanCollide`, `BasePart.CanTouch`, and `BasePart.CanQuery` disabled and are made massless; only the HumanoidRootPart retains mass so it remains the physics assembly root.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsLegacyCollisionMode#R6Colliders)
*/
export interface R6Colliders extends globalThis.EnumItem {
Name: "R6Colliders";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsLegacyCollisionMode;
}
export const R6Colliders: R6Colliders;
/**
* Overrides each R15 mesh part's collision physics with inner-box geometry derived from the standard R15 scaling model. The engine recalculates every `MeshPart` in the character with collision data from the default R15 model's bounding dimensions, producing tighter collision volumes that follow the avatar's proportions without adding extra parts. This is the default value of `LegacyCollisionMode`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsLegacyCollisionMode#InnerBoxColliders)
*/
export interface InnerBoxColliders extends globalThis.EnumItem {
Name: "InnerBoxColliders";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsLegacyCollisionMode;
}
export const InnerBoxColliders: InnerBoxColliders;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsLegacyCollisionMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsLegacyCollisionMode | undefined;
}
export type AvatarSettingsLegacyCollisionMode = AvatarSettingsLegacyCollisionMode.R6Colliders | AvatarSettingsLegacyCollisionMode.InnerBoxColliders;
/**
* Determines whether the experience enforces a custom height range on player characters or allows players to spawn at their natural avatar height.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsScaleMode)
*/
export namespace AvatarSettingsScaleMode {
/**
* Characters spawn at their natural avatar height without any experience-level height override. This is the default value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsScaleMode#PlayerChoice)
*/
export interface PlayerChoice extends globalThis.EnumItem {
Name: "PlayerChoice";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarSettingsScaleMode;
}
export const PlayerChoice: PlayerChoice;
/**
* The experience clamps the character's height to the range specified by `CustomHeight`, overriding the player's natural avatar height.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsScaleMode#CustomScale)
*/
export interface CustomScale extends globalThis.EnumItem {
Name: "CustomScale";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarSettingsScaleMode;
}
export const CustomScale: CustomScale;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarSettingsScaleMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarSettingsScaleMode | undefined;
}
export type AvatarSettingsScaleMode = AvatarSettingsScaleMode.PlayerChoice | AvatarSettingsScaleMode.CustomScale;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarThumbnailCustomizationType)
*/
export namespace AvatarThumbnailCustomizationType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarThumbnailCustomizationType#Closeup)
*/
export interface Closeup extends globalThis.EnumItem {
Name: "Closeup";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarThumbnailCustomizationType;
}
export const Closeup: Closeup;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarThumbnailCustomizationType#FullBody)
*/
export interface FullBody extends globalThis.EnumItem {
Name: "FullBody";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarThumbnailCustomizationType;
}
export const FullBody: FullBody;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarThumbnailCustomizationType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarThumbnailCustomizationType | undefined;
}
export type AvatarThumbnailCustomizationType = AvatarThumbnailCustomizationType.Closeup | AvatarThumbnailCustomizationType.FullBody;
/**
* Controls whether the R6 to R15 adapter is active, allowing R15 avatars to join R6 experiences.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarUnificationMode)
*/
export namespace AvatarUnificationMode {
/**
* Resolves to the engine's current built-in default for avatar unification, which currently behaves the same as `Disabled`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarUnificationMode#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.AvatarUnificationMode;
}
export const Default: Default;
/**
* Disables the R6-to-R15 adapter; R6 avatars in an R6 experience load using the standard R6 rig with no adapter parts applied.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarUnificationMode#Disabled)
*/
export interface Disabled extends globalThis.EnumItem {
Name: "Disabled";
Value: 1;
EnumType: typeof globalThis.Enum.AvatarUnificationMode;
}
export const Disabled: Disabled;
/**
* Enables the R6-to-R15 adapter; R6 avatars joining an R6 experience receive invisible R15 adapter `MeshParts` welded to their R6-named joints, preserving R6 scale while enabling R15 features such as layered clothing and animatable heads.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarUnificationMode#Enabled)
*/
export interface Enabled extends globalThis.EnumItem {
Name: "Enabled";
Value: 2;
EnumType: typeof globalThis.Enum.AvatarUnificationMode;
}
export const Enabled: Enabled;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarUnificationMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarUnificationMode | undefined;
}
export type AvatarUnificationMode = AvatarUnificationMode.Default | AvatarUnificationMode.Disabled | AvatarUnificationMode.Enabled;
/**
* One of the 3D axes.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Axis)
*/
export namespace Axis {
/**
* The X axis.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Axis#X)
*/
export interface X extends globalThis.EnumItem {
Name: "X";
Value: 0;
EnumType: typeof globalThis.Enum.Axis;
}
export const X: X;
/**
* @deprecated renamed to X
*/
export const Left: X;
/**
* @deprecated renamed to X
*/
export const Right: X;
/**
* The Y axis.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Axis#Y)
*/
export interface Y extends globalThis.EnumItem {
Name: "Y";
Value: 1;
EnumType: typeof globalThis.Enum.Axis;
}
export const Y: Y;
/**
* @deprecated renamed to Y
*/
export const Bottom: Y;
/**
* @deprecated renamed to Y
*/
export const Top: Y;
/**
* The Z axis.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Axis#Z)
*/
export interface Z extends globalThis.EnumItem {
Name: "Z";
Value: 2;
EnumType: typeof globalThis.Enum.Axis;
}
export const Z: Z;
/**
* @deprecated renamed to Z
*/
export const Back: Z;
/**
* @deprecated renamed to Z
*/
export const Front: Z;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.Axis | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.Axis | undefined;
}
export type Axis = Axis.X | Axis.Y | Axis.Z;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BasicMeshPartShape)
*/
export namespace BasicMeshPartShape {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BasicMeshPartShape#Capsule)
*/
export interface Capsule extends globalThis.EnumItem {
Name: "Capsule";
Value: 5;
EnumType: typeof globalThis.Enum.BasicMeshPartShape;
}
export const Capsule: Capsule;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BasicMeshPartShape#Cone)
*/
export interface Cone extends globalThis.EnumItem {
Name: "Cone";
Value: 6;
EnumType: typeof globalThis.Enum.BasicMeshPartShape;
}
export const Cone: Cone;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BasicMeshPartShape#RoundedBox)
*/
export interface RoundedBox extends globalThis.EnumItem {
Name: "RoundedBox";
Value: 7;
EnumType: typeof globalThis.Enum.BasicMeshPartShape;
}
export const RoundedBox: RoundedBox;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BasicMeshPartShape | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BasicMeshPartShape | undefined;
}
export type BasicMeshPartShape = BasicMeshPartShape.Capsule | BasicMeshPartShape.Cone | BasicMeshPartShape.RoundedBox;
/**
* Indicates the type of virtual benefit granted to a user when they purchase a commerce product through `CommerceService`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BenefitType)
*/
export namespace BenefitType {
/**
* The benefit is a developer product whose receipt is delivered through `MarketplaceService:BindReceiptHandler()` upon purchase of a commerce product.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BenefitType#DeveloperProduct)
*/
export interface DeveloperProduct extends globalThis.EnumItem {
Name: "DeveloperProduct";
Value: 0;
EnumType: typeof globalThis.Enum.BenefitType;
}
export const DeveloperProduct: DeveloperProduct;
/**
* The benefit is a single avatar asset granted to the user's inventory upon purchase of a commerce product.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BenefitType#AvatarAsset)
*/
export interface AvatarAsset extends globalThis.EnumItem {
Name: "AvatarAsset";
Value: 1;
EnumType: typeof globalThis.Enum.BenefitType;
}
export const AvatarAsset: AvatarAsset;
/**
* The benefit is an avatar bundle granted to the user's inventory upon purchase of a commerce product.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BenefitType#AvatarBundle)
*/
export interface AvatarBundle extends globalThis.EnumItem {
Name: "AvatarBundle";
Value: 2;
EnumType: typeof globalThis.Enum.BenefitType;
}
export const AvatarBundle: AvatarBundle;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BenefitType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BenefitType | undefined;
}
export type BenefitType = BenefitType.DeveloperProduct | BenefitType.AvatarAsset | BenefitType.AvatarBundle;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BinType)
*/
export namespace BinType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BinType#Script)
*/
export interface Script extends globalThis.EnumItem {
Name: "Script";
Value: 0;
EnumType: typeof globalThis.Enum.BinType;
}
export const Script: Script;
/**
* @deprecated renamed to Script
*/
export const Laser: Script;
/**
* @deprecated renamed to Script
*/
export const Rocket: Script;
/**
* @deprecated renamed to Script
*/
export const Slingshot: Script;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BinType#GameTool)
*/
export interface GameTool extends globalThis.EnumItem {
Name: "GameTool";
Value: 1;
EnumType: typeof globalThis.Enum.BinType;
}
export const GameTool: GameTool;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BinType#Grab)
*/
export interface Grab extends globalThis.EnumItem {
Name: "Grab";
Value: 2;
EnumType: typeof globalThis.Enum.BinType;
}
export const Grab: Grab;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BinType#Clone)
*/
export interface Clone extends globalThis.EnumItem {
Name: "Clone";
Value: 3;
EnumType: typeof globalThis.Enum.BinType;
}
export const Clone: Clone;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BinType#Hammer)
*/
export interface Hammer extends globalThis.EnumItem {
Name: "Hammer";
Value: 4;
EnumType: typeof globalThis.Enum.BinType;
}
export const Hammer: Hammer;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BinType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BinType | undefined;
}
export type BinType = BinType.Script | BinType.GameTool | BinType.Grab | BinType.Clone | BinType.Hammer;
/**
* The BodyPart Enum determines which BodyPart a `CharacterMesh` affects.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPart)
*/
export namespace BodyPart {
/**
* The head BodyPart.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPart#Head)
*/
export interface Head extends globalThis.EnumItem {
Name: "Head";
Value: 0;
EnumType: typeof globalThis.Enum.BodyPart;
}
export const Head: Head;
/**
* The torso BodyPart.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPart#Torso)
*/
export interface Torso extends globalThis.EnumItem {
Name: "Torso";
Value: 1;
EnumType: typeof globalThis.Enum.BodyPart;
}
export const Torso: Torso;
/**
* The left arm BodyPart.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPart#LeftArm)
*/
export interface LeftArm extends globalThis.EnumItem {
Name: "LeftArm";
Value: 2;
EnumType: typeof globalThis.Enum.BodyPart;
}
export const LeftArm: LeftArm;
/**
* The right arm BodyPart.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPart#RightArm)
*/
export interface RightArm extends globalThis.EnumItem {
Name: "RightArm";
Value: 3;
EnumType: typeof globalThis.Enum.BodyPart;
}
export const RightArm: RightArm;
/**
* The left leg BodyPart.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPart#LeftLeg)
*/
export interface LeftLeg extends globalThis.EnumItem {
Name: "LeftLeg";
Value: 4;
EnumType: typeof globalThis.Enum.BodyPart;
}
export const LeftLeg: LeftLeg;
/**
* The right leg BodyPart.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPart#RightLeg)
*/
export interface RightLeg extends globalThis.EnumItem {
Name: "RightLeg";
Value: 5;
EnumType: typeof globalThis.Enum.BodyPart;
}
export const RightLeg: RightLeg;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BodyPart | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BodyPart | undefined;
}
export type BodyPart = BodyPart.Head | BodyPart.Torso | BodyPart.LeftArm | BodyPart.RightArm | BodyPart.LeftLeg | BodyPart.RightLeg;
/**
* BodyPartR15 is an enum with entries for each of the 15 body parts of an R15 character (plus an entry for the HumanoidRootPart).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15)
*/
export namespace BodyPartR15 {
/**
* Reference to a Humanoid's Head.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#Head)
*/
export interface Head extends globalThis.EnumItem {
Name: "Head";
Value: 0;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const Head: Head;
/**
* Reference to a Humanoid's UpperTorso.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#UpperTorso)
*/
export interface UpperTorso extends globalThis.EnumItem {
Name: "UpperTorso";
Value: 1;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const UpperTorso: UpperTorso;
/**
* Reference to a Humanoid's LowerTorso.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LowerTorso)
*/
export interface LowerTorso extends globalThis.EnumItem {
Name: "LowerTorso";
Value: 2;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const LowerTorso: LowerTorso;
/**
* Reference to a Humanoid's LeftFoot.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftFoot)
*/
export interface LeftFoot extends globalThis.EnumItem {
Name: "LeftFoot";
Value: 3;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const LeftFoot: LeftFoot;
/**
* Reference to a Humanoid's LeftLowerLeg.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftLowerLeg)
*/
export interface LeftLowerLeg extends globalThis.EnumItem {
Name: "LeftLowerLeg";
Value: 4;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const LeftLowerLeg: LeftLowerLeg;
/**
* Reference to a Humanoid's LeftUpperLeg.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftUpperLeg)
*/
export interface LeftUpperLeg extends globalThis.EnumItem {
Name: "LeftUpperLeg";
Value: 5;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const LeftUpperLeg: LeftUpperLeg;
/**
* Reference to a Humanoid's RightFoot.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightFoot)
*/
export interface RightFoot extends globalThis.EnumItem {
Name: "RightFoot";
Value: 6;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const RightFoot: RightFoot;
/**
* Reference to a Humanoid's RightLowerLeg.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightLowerLeg)
*/
export interface RightLowerLeg extends globalThis.EnumItem {
Name: "RightLowerLeg";
Value: 7;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const RightLowerLeg: RightLowerLeg;
/**
* Reference to a Humanoid's RightUpperLeg.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightUpperLeg)
*/
export interface RightUpperLeg extends globalThis.EnumItem {
Name: "RightUpperLeg";
Value: 8;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const RightUpperLeg: RightUpperLeg;
/**
* Reference to a Humanoid's LeftHand.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftHand)
*/
export interface LeftHand extends globalThis.EnumItem {
Name: "LeftHand";
Value: 9;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const LeftHand: LeftHand;
/**
* Reference to a Humanoid's LeftLowerArm.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftLowerArm)
*/
export interface LeftLowerArm extends globalThis.EnumItem {
Name: "LeftLowerArm";
Value: 10;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const LeftLowerArm: LeftLowerArm;
/**
* Reference to a Humanoid's LeftUpperArm.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftUpperArm)
*/
export interface LeftUpperArm extends globalThis.EnumItem {
Name: "LeftUpperArm";
Value: 11;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const LeftUpperArm: LeftUpperArm;
/**
* Reference to a Humanoid's RightHand.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightHand)
*/
export interface RightHand extends globalThis.EnumItem {
Name: "RightHand";
Value: 12;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const RightHand: RightHand;
/**
* Reference to a Humanoid's RightLowerArm.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightLowerArm)
*/
export interface RightLowerArm extends globalThis.EnumItem {
Name: "RightLowerArm";
Value: 13;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const RightLowerArm: RightLowerArm;
/**
* Reference to a Humanoid's RightUpperArm.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightUpperArm)
*/
export interface RightUpperArm extends globalThis.EnumItem {
Name: "RightUpperArm";
Value: 14;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const RightUpperArm: RightUpperArm;
/**
* Reference to a Humanoid's HumanoidRootPart.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RootPart)
*/
export interface RootPart extends globalThis.EnumItem {
Name: "RootPart";
Value: 15;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const RootPart: RootPart;
/**
* Unknown R15 Humanoid body part.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 17;
EnumType: typeof globalThis.Enum.BodyPartR15;
}
export const Unknown: Unknown;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BodyPartR15 | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BodyPartR15 | undefined;
}
export type BodyPartR15 = BodyPartR15.Head | BodyPartR15.UpperTorso | BodyPartR15.LowerTorso | BodyPartR15.LeftFoot | BodyPartR15.LeftLowerLeg | BodyPartR15.LeftUpperLeg | BodyPartR15.RightFoot | BodyPartR15.RightLowerLeg | BodyPartR15.RightUpperLeg | BodyPartR15.LeftHand | BodyPartR15.LeftLowerArm | BodyPartR15.LeftUpperArm | BodyPartR15.RightHand | BodyPartR15.RightLowerArm | BodyPartR15.RightUpperArm | BodyPartR15.RootPart | BodyPartR15.Unknown;
/**
* Used by `GuiObject.BorderMode` to determine where borders are placed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BorderMode)
*/
export namespace BorderMode {
/**
* As `GuiObject.BorderSizePixel` increases, the border grows outward. The dimensions of the GuiObject's contents do not change.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BorderMode#Outline)
*/
export interface Outline extends globalThis.EnumItem {
Name: "Outline";
Value: 0;
EnumType: typeof globalThis.Enum.BorderMode;
}
export const Outline: Outline;
/**
* As `GuiObject.BorderSizePixel` increases, the border grows evenly inward and outward. The dimensions of the GuiObject's contents are reduced at a 1:1 ratio.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BorderMode#Middle)
*/
export interface Middle extends globalThis.EnumItem {
Name: "Middle";
Value: 1;
EnumType: typeof globalThis.Enum.BorderMode;
}
export const Middle: Middle;
/**
* As `GuiObject.BorderSizePixel` increases, the border grows evenly inward only. The dimensions of the GuiObject's contents are reduced at a 1:2 ratio.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BorderMode#Inset)
*/
export interface Inset extends globalThis.EnumItem {
Name: "Inset";
Value: 2;
EnumType: typeof globalThis.Enum.BorderMode;
}
export const Inset: Inset;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BorderMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BorderMode | undefined;
}
export type BorderMode = BorderMode.Outline | BorderMode.Middle | BorderMode.Inset;
/**
* Used by `UIStroke.BorderStrokePosition` to determine the stroke's position on its parent's border.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BorderStrokePosition)
*/
export namespace BorderStrokePosition {
/**
* The stroke renders on the outer border of the parent UI element.
*
*
*
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BorderStrokePosition#Outer)
*/
export interface Outer extends globalThis.EnumItem {
Name: "Outer";
Value: 0;
EnumType: typeof globalThis.Enum.BorderStrokePosition;
}
export const Outer: Outer;
/**
* The stroke renders on the center border of the parent UI element.
*
*
*
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BorderStrokePosition#Center)
*/
export interface Center extends globalThis.EnumItem {
Name: "Center";
Value: 1;
EnumType: typeof globalThis.Enum.BorderStrokePosition;
}
export const Center: Center;
/**
* The stroke renders on the inner border of the parent UI element.
*
*
*
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BorderStrokePosition#Inner)
*/
export interface Inner extends globalThis.EnumItem {
Name: "Inner";
Value: 2;
EnumType: typeof globalThis.Enum.BorderStrokePosition;
}
export const Inner: Inner;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BorderStrokePosition | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BorderStrokePosition | undefined;
}
export type BorderStrokePosition = BorderStrokePosition.Outer | BorderStrokePosition.Center | BorderStrokePosition.Inner;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BranchStatus)
*/
export namespace BranchStatus {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BranchStatus#Draft)
*/
export interface Draft extends globalThis.EnumItem {
Name: "Draft";
Value: 0;
EnumType: typeof globalThis.Enum.BranchStatus;
}
export const Draft: Draft;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BranchStatus#ReadyToMerge)
*/
export interface ReadyToMerge extends globalThis.EnumItem {
Name: "ReadyToMerge";
Value: 1;
EnumType: typeof globalThis.Enum.BranchStatus;
}
export const ReadyToMerge: ReadyToMerge;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BranchStatus#Merged)
*/
export interface Merged extends globalThis.EnumItem {
Name: "Merged";
Value: 2;
EnumType: typeof globalThis.Enum.BranchStatus;
}
export const Merged: Merged;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BranchStatus#Archived)
*/
export interface Archived extends globalThis.EnumItem {
Name: "Archived";
Value: 3;
EnumType: typeof globalThis.Enum.BranchStatus;
}
export const Archived: Archived;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BranchStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BranchStatus | undefined;
}
export type BranchStatus = BranchStatus.Draft | BranchStatus.ReadyToMerge | BranchStatus.Merged | BranchStatus.Archived;
/**
* Reason for the breakpoint hit.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BreakReason)
*/
export namespace BreakReason {
/**
* Pausing for a reason not covered by other values, for example if the user hit "Pause" button.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BreakReason#Other)
*/
export interface Other extends globalThis.EnumItem {
Name: "Other";
Value: 0;
EnumType: typeof globalThis.Enum.BreakReason;
}
export const Other: Other;
/**
* Pausing on error hit in the code.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BreakReason#Error)
*/
export interface Error extends globalThis.EnumItem {
Name: "Error";
Value: 1;
EnumType: typeof globalThis.Enum.BreakReason;
}
export const Error: Error;
/**
* Pausing on an internal breakpoint set by debugger command: e.g. step over, step into, step out of.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BreakReason#SpecialBreakpoint)
*/
export interface SpecialBreakpoint extends globalThis.EnumItem {
Name: "SpecialBreakpoint";
Value: 2;
EnumType: typeof globalThis.Enum.BreakReason;
}
export const SpecialBreakpoint: SpecialBreakpoint;
/**
* Pausing on a user breakpoint.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BreakReason#UserBreakpoint)
*/
export interface UserBreakpoint extends globalThis.EnumItem {
Name: "UserBreakpoint";
Value: 3;
EnumType: typeof globalThis.Enum.BreakReason;
}
export const UserBreakpoint: UserBreakpoint;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BreakReason | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BreakReason | undefined;
}
export type BreakReason = BreakReason.Other | BreakReason.Error | BreakReason.SpecialBreakpoint | BreakReason.UserBreakpoint;
/**
* Reason that a breakpoint was removed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BreakpointRemoveReason)
*/
export namespace BreakpointRemoveReason {
/**
* Breakpoint removal was requested by user or a command.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BreakpointRemoveReason#Requested)
*/
export interface Requested extends globalThis.EnumItem {
Name: "Requested";
Value: 0;
EnumType: typeof globalThis.Enum.BreakpointRemoveReason;
}
export const Requested: Requested;
/**
* Script that contained the breakpoint has changed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BreakpointRemoveReason#ScriptChanged)
*/
export interface ScriptChanged extends globalThis.EnumItem {
Name: "ScriptChanged";
Value: 1;
EnumType: typeof globalThis.Enum.BreakpointRemoveReason;
}
export const ScriptChanged: ScriptChanged;
/**
* Script that contained the breakpoint was removed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BreakpointRemoveReason#ScriptRemoved)
*/
export interface ScriptRemoved extends globalThis.EnumItem {
Name: "ScriptRemoved";
Value: 2;
EnumType: typeof globalThis.Enum.BreakpointRemoveReason;
}
export const ScriptRemoved: ScriptRemoved;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BreakpointRemoveReason | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BreakpointRemoveReason | undefined;
}
export type BreakpointRemoveReason = BreakpointRemoveReason.Requested | BreakpointRemoveReason.ScriptChanged | BreakpointRemoveReason.ScriptRemoved;
/**
* Determines the set of property changed events that fire when parts are moved by `WorldRoot:BulkMoveTo()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BulkMoveMode)
*/
export namespace BulkMoveMode {
/**
* Every property changed event fires for each moved part, including `CFrame`, `Position`, `Orientation`, and `Rotation`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BulkMoveMode#FireAllEvents)
*/
export interface FireAllEvents extends globalThis.EnumItem {
Name: "FireAllEvents";
Value: 0;
EnumType: typeof globalThis.Enum.BulkMoveMode;
}
export const FireAllEvents: FireAllEvents;
/**
* Only the `CFrame` property changed event fires for each moved part; `Position`, `Orientation`, and `Rotation` changed events are suppressed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BulkMoveMode#FireCFrameChanged)
*/
export interface FireCFrameChanged extends globalThis.EnumItem {
Name: "FireCFrameChanged";
Value: 1;
EnumType: typeof globalThis.Enum.BulkMoveMode;
}
export const FireCFrameChanged: FireCFrameChanged;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BulkMoveMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BulkMoveMode | undefined;
}
export type BulkMoveMode = BulkMoveMode.FireAllEvents | BulkMoveMode.FireCFrameChanged;
/**
* The type of a bundle of assets.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BundleType)
*/
export namespace BundleType {
/**
* A bundle of body parts and accessories.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BundleType#BodyParts)
*/
export interface BodyParts extends globalThis.EnumItem {
Name: "BodyParts";
Value: 1;
EnumType: typeof globalThis.Enum.BundleType;
}
export const BodyParts: BodyParts;
/**
* A bundle of just animations.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BundleType#Animations)
*/
export interface Animations extends globalThis.EnumItem {
Name: "Animations";
Value: 2;
EnumType: typeof globalThis.Enum.BundleType;
}
export const Animations: Animations;
/**
* A bundle of left shoe and right shoe.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BundleType#Shoes)
*/
export interface Shoes extends globalThis.EnumItem {
Name: "Shoes";
Value: 3;
EnumType: typeof globalThis.Enum.BundleType;
}
export const Shoes: Shoes;
/**
* A bundle consisting of dynamicHead and moodAnimation assets, optionally with eyebrowAccessory and eyelashAccessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BundleType#DynamicHead)
*/
export interface DynamicHead extends globalThis.EnumItem {
Name: "DynamicHead";
Value: 4;
EnumType: typeof globalThis.Enum.BundleType;
}
export const DynamicHead: DynamicHead;
/**
* A bundle containing full body parts and a dynamic head with facial animation support.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/BundleType#DynamicHeadAvatar)
*/
export interface DynamicHeadAvatar extends globalThis.EnumItem {
Name: "DynamicHeadAvatar";
Value: 5;
EnumType: typeof globalThis.Enum.BundleType;
}
export const DynamicHeadAvatar: DynamicHeadAvatar;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.BundleType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.BundleType | undefined;
}
export type BundleType = BundleType.BodyParts | BundleType.Animations | BundleType.Shoes | BundleType.DynamicHead | BundleType.DynamicHeadAvatar;
/**
* One of the buttons used by `Controller`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Button)
*/
export namespace Button {
/**
* Represents the dismount action that can be bound on a `Controller` to detect when a player triggers the dismount input.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Button#Dismount)
*/
export interface Dismount extends globalThis.EnumItem {
Name: "Dismount";
Value: 8;
EnumType: typeof globalThis.Enum.Button;
}
export const Dismount: Dismount;
/**
* Represents the jump action that can be bound on a `Controller` to detect when a player triggers the jump input.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Button#Jump)
*/
export interface Jump extends globalThis.EnumItem {
Name: "Jump";
Value: 32;
EnumType: typeof globalThis.Enum.Button;
}
export const Jump: Jump;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.Button | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.Button | undefined;
}
export type Button = Button.Dismount | Button.Jump;
/**
* Used by `GuiButton.Style` to set a special hardcoded appearance.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ButtonStyle)
*/
export namespace ButtonStyle {
/**
* The button will respect the `GuiObject.BorderColor3` and `GuiObject.BackgroundColor3` properties.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#Custom)
*/
export interface Custom extends globalThis.EnumItem {
Name: "Custom";
Value: 0;
EnumType: typeof globalThis.Enum.ButtonStyle;
}
export const Custom: Custom;
/**
* A black background with a red border, and rounded corners.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#RobloxButtonDefault)
*/
export interface RobloxButtonDefault extends globalThis.EnumItem {
Name: "RobloxButtonDefault";
Value: 1;
EnumType: typeof globalThis.Enum.ButtonStyle;
}
export const RobloxButtonDefault: RobloxButtonDefault;
/**
* A black background with a grey border, and rounded corners.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#RobloxButton)
*/
export interface RobloxButton extends globalThis.EnumItem {
Name: "RobloxButton";
Value: 2;
EnumType: typeof globalThis.Enum.ButtonStyle;
}
export const RobloxButton: RobloxButton;
/**
* A grey background with rounded corners, and a slight drop shadow.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#RobloxRoundButton)
*/
export interface RobloxRoundButton extends globalThis.EnumItem {
Name: "RobloxRoundButton";
Value: 3;
EnumType: typeof globalThis.Enum.ButtonStyle;
}
export const RobloxRoundButton: RobloxRoundButton;
/**
* A blue background with rounded corners, and a slight drop shadow.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#RobloxRoundDefaultButton)
*/
export interface RobloxRoundDefaultButton extends globalThis.EnumItem {
Name: "RobloxRoundDefaultButton";
Value: 4;
EnumType: typeof globalThis.Enum.ButtonStyle;
}
export const RobloxRoundDefaultButton: RobloxRoundDefaultButton;
/**
* A white background with a thin grey border, rounded corners, and a slight drop shadow.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#RobloxRoundDropdownButton)
*/
export interface RobloxRoundDropdownButton extends globalThis.EnumItem {
Name: "RobloxRoundDropdownButton";
Value: 5;
EnumType: typeof globalThis.Enum.ButtonStyle;
}
export const RobloxRoundDropdownButton: RobloxRoundDropdownButton;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ButtonStyle | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ButtonStyle | undefined;
}
export type ButtonStyle = ButtonStyle.Custom | ButtonStyle.RobloxButtonDefault | ButtonStyle.RobloxButton | ButtonStyle.RobloxRoundButton | ButtonStyle.RobloxRoundDefaultButton | ButtonStyle.RobloxRoundDropdownButton;
/**
* Specifies which cage surface — inner or outer — to read or write on a `BaseWrap` object.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CageType)
*/
export namespace CageType {
/**
* Selects the inner cage mesh, which defines the surface that conforms to the body or underlying layer beneath the accessory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CageType#Inner)
*/
export interface Inner extends globalThis.EnumItem {
Name: "Inner";
Value: 0;
EnumType: typeof globalThis.Enum.CageType;
}
export const Inner: Inner;
/**
* Selects the outer cage mesh, which defines the surface that the next clothing layer above this accessory conforms to.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CageType#Outer)
*/
export interface Outer extends globalThis.EnumItem {
Name: "Outer";
Value: 1;
EnumType: typeof globalThis.Enum.CageType;
}
export const Outer: Outer;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CageType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CageType | undefined;
}
export type CageType = CageType.Inner | CageType.Outer;
/**
* Used to set `Player.CameraMode` to determine when first person and third person cameras should be used.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraMode)
*/
export namespace CameraMode {
/**
* Third person camera which can be zoomed into first person.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraMode#Classic)
*/
export interface Classic extends globalThis.EnumItem {
Name: "Classic";
Value: 0;
EnumType: typeof globalThis.Enum.CameraMode;
}
export const Classic: Classic;
/**
* Exclusively first person camera.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraMode#LockFirstPerson)
*/
export interface LockFirstPerson extends globalThis.EnumItem {
Name: "LockFirstPerson";
Value: 1;
EnumType: typeof globalThis.Enum.CameraMode;
}
export const LockFirstPerson: LockFirstPerson;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CameraMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CameraMode | undefined;
}
export type CameraMode = CameraMode.Classic | CameraMode.LockFirstPerson;
/**
* Determines the camera navigation paradigm used in the Roblox Studio editor viewport.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraNavigationModel)
*/
export namespace CameraNavigationModel {
/**
* Classic Roblox Studio camera navigation model with linear zoom and focus-locked orbiting; the default value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraNavigationModel#Roblox)
*/
export interface Roblox extends globalThis.EnumItem {
Name: "Roblox";
Value: 0;
EnumType: typeof globalThis.Enum.CameraNavigationModel;
}
export const Roblox: Roblox;
/**
* Camera navigation model that follows industry-standard 3D application conventions, with non-linear zoom and simultaneous WASD-plus-orbit movement.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraNavigationModel#IndustryCompatible)
*/
export interface IndustryCompatible extends globalThis.EnumItem {
Name: "IndustryCompatible";
Value: 1;
EnumType: typeof globalThis.Enum.CameraNavigationModel;
}
export const IndustryCompatible: IndustryCompatible;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CameraNavigationModel | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CameraNavigationModel | undefined;
}
export type CameraNavigationModel = CameraNavigationModel.Roblox | CameraNavigationModel.IndustryCompatible;
/**
* The CameraPanMode Enum represents the available pan modes for `Camera:SetCameraPanMode()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraPanMode)
*/
export namespace CameraPanMode {
/**
* Enables swipe and pan on mobile devices, and disables edge bump camera controls. Default.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraPanMode#Classic)
*/
export interface Classic extends globalThis.EnumItem {
Name: "Classic";
Value: 0;
EnumType: typeof globalThis.Enum.CameraPanMode;
}
export const Classic: Classic;
/**
* Disables swipe to pan on mobile devices, and enables edge bump camera controls. It does not affect Windows or Mac users.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraPanMode#EdgeBump)
*/
export interface EdgeBump extends globalThis.EnumItem {
Name: "EdgeBump";
Value: 1;
EnumType: typeof globalThis.Enum.CameraPanMode;
}
export const EdgeBump: EdgeBump;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CameraPanMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CameraPanMode | undefined;
}
export type CameraPanMode = CameraPanMode.Classic | CameraPanMode.EdgeBump;
/**
* Controls which input gesture adjusts the Studio camera's fly speed while navigating.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraSpeedAdjustBinding)
*/
export namespace CameraSpeedAdjustBinding {
/**
* No input gesture is bound to camera speed adjustment; the scroll wheel always zooms.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraSpeedAdjustBinding#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.CameraSpeedAdjustBinding;
}
export const None: None;
/**
* Scrolling while holding the right mouse button adjusts the camera fly speed instead of zooming.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraSpeedAdjustBinding#RmbScroll)
*/
export interface RmbScroll extends globalThis.EnumItem {
Name: "RmbScroll";
Value: 1;
EnumType: typeof globalThis.Enum.CameraSpeedAdjustBinding;
}
export const RmbScroll: RmbScroll;
/**
* Scrolling while holding Alt adjusts the camera fly speed instead of zooming.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraSpeedAdjustBinding#AltScroll)
*/
export interface AltScroll extends globalThis.EnumItem {
Name: "AltScroll";
Value: 2;
EnumType: typeof globalThis.Enum.CameraSpeedAdjustBinding;
}
export const AltScroll: AltScroll;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CameraSpeedAdjustBinding | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CameraSpeedAdjustBinding | undefined;
}
export type CameraSpeedAdjustBinding = CameraSpeedAdjustBinding.None | CameraSpeedAdjustBinding.RmbScroll | CameraSpeedAdjustBinding.AltScroll;
/**
* Describes the camera behavior mode if using the default PlayerScripts.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraType)
*/
export namespace CameraType {
/**
* Camera is stationary.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraType#Fixed)
*/
export interface Fixed extends globalThis.EnumItem {
Name: "Fixed";
Value: 0;
EnumType: typeof globalThis.Enum.CameraType;
}
export const Fixed: Fixed;
/**
* Camera moves with the subject at a fixed offset and will rotate as the subject rotates.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraType#Attach)
*/
export interface Attach extends globalThis.EnumItem {
Name: "Attach";
Value: 1;
EnumType: typeof globalThis.Enum.CameraType;
}
export const Attach: Attach;
/**
* Camera is stationary but will rotate to keep the subject in the center of the screen.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraType#Watch)
*/
export interface Watch extends globalThis.EnumItem {
Name: "Watch";
Value: 2;
EnumType: typeof globalThis.Enum.CameraType;
}
export const Watch: Watch;
/**
* Camera moves with the subject but does not rotate automatically.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraType#Track)
*/
export interface Track extends globalThis.EnumItem {
Name: "Track";
Value: 3;
EnumType: typeof globalThis.Enum.CameraType;
}
export const Track: Track;
/**
* Camera moves with the subject and rotates to keep the subject in the center.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraType#Follow)
*/
export interface Follow extends globalThis.EnumItem {
Name: "Follow";
Value: 4;
EnumType: typeof globalThis.Enum.CameraType;
}
export const Follow: Follow;
/**
* Default mode used by Roblox core scripts.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraType#Custom)
*/
export interface Custom extends globalThis.EnumItem {
Name: "Custom";
Value: 5;
EnumType: typeof globalThis.Enum.CameraType;
}
export const Custom: Custom;
/**
* No default behavior. Used when developers need to script custom behavior.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraType#Scriptable)
*/
export interface Scriptable extends globalThis.EnumItem {
Name: "Scriptable";
Value: 6;
EnumType: typeof globalThis.Enum.CameraType;
}
export const Scriptable: Scriptable;
/**
* The camera has a fixed Y position, but can be rotated around the player.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CameraType#Orbital)
*/
export interface Orbital extends globalThis.EnumItem {
Name: "Orbital";
Value: 7;
EnumType: typeof globalThis.Enum.CameraType;
}
export const Orbital: Orbital;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CameraType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CameraType | undefined;
}
export type CameraType = CameraType.Fixed | CameraType.Attach | CameraType.Watch | CameraType.Track | CameraType.Follow | CameraType.Custom | CameraType.Scriptable | CameraType.Orbital;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError)
*/
export namespace CanCollaborateError {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#Invalid)
*/
export interface Invalid extends globalThis.EnumItem {
Name: "Invalid";
Value: 0;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const Invalid: Invalid;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 1;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const None: None;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#NotAgeVerified)
*/
export interface NotAgeVerified extends globalThis.EnumItem {
Name: "NotAgeVerified";
Value: 2;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const NotAgeVerified: NotAgeVerified;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#OutsideAgeBucket)
*/
export interface OutsideAgeBucket extends globalThis.EnumItem {
Name: "OutsideAgeBucket";
Value: 3;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const OutsideAgeBucket: OutsideAgeBucket;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#TooManyCollaborators)
*/
export interface TooManyCollaborators extends globalThis.EnumItem {
Name: "TooManyCollaborators";
Value: 4;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const TooManyCollaborators: TooManyCollaborators;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#PCBlock)
*/
export interface PCBlock extends globalThis.EnumItem {
Name: "PCBlock";
Value: 5;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const PCBlock: PCBlock;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#NotFound)
*/
export interface NotFound extends globalThis.EnumItem {
Name: "NotFound";
Value: 6;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const NotFound: NotFound;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#OutsideOwnerAgeBucket)
*/
export interface OutsideOwnerAgeBucket extends globalThis.EnumItem {
Name: "OutsideOwnerAgeBucket";
Value: 7;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const OutsideOwnerAgeBucket: OutsideOwnerAgeBucket;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#NotAuthorized)
*/
export interface NotAuthorized extends globalThis.EnumItem {
Name: "NotAuthorized";
Value: 8;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const NotAuthorized: NotAuthorized;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#OutsideAgeBucketTcPc)
*/
export interface OutsideAgeBucketTcPc extends globalThis.EnumItem {
Name: "OutsideAgeBucketTcPc";
Value: 9;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const OutsideAgeBucketTcPc: OutsideAgeBucketTcPc;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#OtherCollaboratorSettingsPreventTrust)
*/
export interface OtherCollaboratorSettingsPreventTrust extends globalThis.EnumItem {
Name: "OtherCollaboratorSettingsPreventTrust";
Value: 10;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const OtherCollaboratorSettingsPreventTrust: OtherCollaboratorSettingsPreventTrust;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#AgeVerificationCountryBlocked)
*/
export interface AgeVerificationCountryBlocked extends globalThis.EnumItem {
Name: "AgeVerificationCountryBlocked";
Value: 11;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const AgeVerificationCountryBlocked: AgeVerificationCountryBlocked;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#OtherUserCannotCollaborate)
*/
export interface OtherUserCannotCollaborate extends globalThis.EnumItem {
Name: "OtherUserCannotCollaborate";
Value: 12;
EnumType: typeof globalThis.Enum.CanCollaborateError;
}
export const OtherUserCannotCollaborate: OtherUserCannotCollaborate;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CanCollaborateError | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CanCollaborateError | undefined;
}
export type CanCollaborateError = CanCollaborateError.Invalid | CanCollaborateError.None | CanCollaborateError.NotAgeVerified | CanCollaborateError.OutsideAgeBucket | CanCollaborateError.TooManyCollaborators | CanCollaborateError.PCBlock | CanCollaborateError.NotFound | CanCollaborateError.OutsideOwnerAgeBucket | CanCollaborateError.NotAuthorized | CanCollaborateError.OutsideAgeBucketTcPc | CanCollaborateError.OtherCollaboratorSettingsPreventTrust | CanCollaborateError.AgeVerificationCountryBlocked | CanCollaborateError.OtherUserCannotCollaborate;
/**
* Specifies the scope of permissions an experience requests for accessing the device's capture gallery.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureGalleryPermission)
*/
export namespace CaptureGalleryPermission {
/**
* Requests permission to read captures from and upload captures to the device's gallery.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureGalleryPermission#ReadAndUpload)
*/
export interface ReadAndUpload extends globalThis.EnumItem {
Name: "ReadAndUpload";
Value: 0;
EnumType: typeof globalThis.Enum.CaptureGalleryPermission;
}
export const ReadAndUpload: ReadAndUpload;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CaptureGalleryPermission | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CaptureGalleryPermission | undefined;
}
export type CaptureGalleryPermission = CaptureGalleryPermission.ReadAndUpload;
/**
* Indicates whether a capture is a screenshot or a video recording.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureType)
*/
export namespace CaptureType {
/**
* The capture is a screenshot image.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureType#Screenshot)
*/
export interface Screenshot extends globalThis.EnumItem {
Name: "Screenshot";
Value: 1;
EnumType: typeof globalThis.Enum.CaptureType;
}
export const Screenshot: Screenshot;
/**
* The capture is a video recording.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureType#Video)
*/
export interface Video extends globalThis.EnumItem {
Name: "Video";
Value: 2;
EnumType: typeof globalThis.Enum.CaptureType;
}
export const Video: Video;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CaptureType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CaptureType | undefined;
}
export type CaptureType = CaptureType.Screenshot | CaptureType.Video;
/**
* Filters Avatar Shop catalog search results by a predefined category such as Featured, Premium, or Recommended.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter)
*/
export namespace CatalogCategoryFilter {
/**
* No category filter is applied; returns items from all categories. This is the default value of `CatalogSearchParams.CategoryFilter`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 1;
EnumType: typeof globalThis.Enum.CatalogCategoryFilter;
}
export const None: None;
/**
* Returns only items editorially featured in the Avatar Shop catalog.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#Featured)
*/
export interface Featured extends globalThis.EnumItem {
Name: "Featured";
Value: 2;
EnumType: typeof globalThis.Enum.CatalogCategoryFilter;
}
export const Featured: Featured;
/**
* **Deprecated:**
*
* Deprecated. Previously filtered for collectible items; use `SalesTypeFilter.Collectibles` via `CatalogSearchParams.SalesTypeFilter` instead.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#Collectibles)
*/
export interface Collectibles extends globalThis.EnumItem {
Name: "Collectibles";
Value: 3;
EnumType: typeof globalThis.Enum.CatalogCategoryFilter;
}
export const Collectibles: Collectibles;
/**
* Returns only items created by community developers.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#CommunityCreations)
*/
export interface CommunityCreations extends globalThis.EnumItem {
Name: "CommunityCreations";
Value: 4;
EnumType: typeof globalThis.Enum.CatalogCategoryFilter;
}
export const CommunityCreations: CommunityCreations;
/**
* Returns only items available to Roblox Premium subscribers.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#Premium)
*/
export interface Premium extends globalThis.EnumItem {
Name: "Premium";
Value: 5;
EnumType: typeof globalThis.Enum.CatalogCategoryFilter;
}
export const Premium: Premium;
/**
* Returns only items recommended by the catalog for the current user.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#Recommended)
*/
export interface Recommended extends globalThis.EnumItem {
Name: "Recommended";
Value: 6;
EnumType: typeof globalThis.Enum.CatalogCategoryFilter;
}
export const Recommended: Recommended;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CatalogCategoryFilter | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CatalogCategoryFilter | undefined;
}
export type CatalogCategoryFilter = CatalogCategoryFilter.None | CatalogCategoryFilter.Featured | CatalogCategoryFilter.Collectibles | CatalogCategoryFilter.CommunityCreations | CatalogCategoryFilter.Premium | CatalogCategoryFilter.Recommended;
/**
* Specifies the time window over which catalog items are aggregated when sorting `CatalogSearchParams` results.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation)
*/
export namespace CatalogSortAggregation {
/**
* Aggregates catalog data from the past 12 hours when sorting search results.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#Past12Hours)
*/
export interface Past12Hours extends globalThis.EnumItem {
Name: "Past12Hours";
Value: 1;
EnumType: typeof globalThis.Enum.CatalogSortAggregation;
}
export const Past12Hours: Past12Hours;
/**
* Aggregates catalog data from the past day when sorting search results.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#PastDay)
*/
export interface PastDay extends globalThis.EnumItem {
Name: "PastDay";
Value: 2;
EnumType: typeof globalThis.Enum.CatalogSortAggregation;
}
export const PastDay: PastDay;
/**
* Aggregates catalog data from the past 3 days when sorting search results.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#Past3Days)
*/
export interface Past3Days extends globalThis.EnumItem {
Name: "Past3Days";
Value: 3;
EnumType: typeof globalThis.Enum.CatalogSortAggregation;
}
export const Past3Days: Past3Days;
/**
* Aggregates catalog data from the past week when sorting search results.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#PastWeek)
*/
export interface PastWeek extends globalThis.EnumItem {
Name: "PastWeek";
Value: 4;
EnumType: typeof globalThis.Enum.CatalogSortAggregation;
}
export const PastWeek: PastWeek;
/**
* Aggregates catalog data from the past month when sorting search results.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#PastMonth)
*/
export interface PastMonth extends globalThis.EnumItem {
Name: "PastMonth";
Value: 5;
EnumType: typeof globalThis.Enum.CatalogSortAggregation;
}
export const PastMonth: PastMonth;
/**
* Aggregates catalog data across all time when sorting search results.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#AllTime)
*/
export interface AllTime extends globalThis.EnumItem {
Name: "AllTime";
Value: 6;
EnumType: typeof globalThis.Enum.CatalogSortAggregation;
}
export const AllTime: AllTime;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CatalogSortAggregation | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CatalogSortAggregation | undefined;
}
export type CatalogSortAggregation = CatalogSortAggregation.Past12Hours | CatalogSortAggregation.PastDay | CatalogSortAggregation.Past3Days | CatalogSortAggregation.PastWeek | CatalogSortAggregation.PastMonth | CatalogSortAggregation.AllTime;
/**
* Specifies the sort order for catalog search results returned by `AvatarEditorService:SearchCatalogAsync()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortType)
*/
export namespace CatalogSortType {
/**
* Sorts catalog results by relevance to the search keyword or other query parameters.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#Relevance)
*/
export interface Relevance extends globalThis.EnumItem {
Name: "Relevance";
Value: 1;
EnumType: typeof globalThis.Enum.CatalogSortType;
}
export const Relevance: Relevance;
/**
* Sorts catalog results from the highest price to the lowest price.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#PriceHighToLow)
*/
export interface PriceHighToLow extends globalThis.EnumItem {
Name: "PriceHighToLow";
Value: 2;
EnumType: typeof globalThis.Enum.CatalogSortType;
}
export const PriceHighToLow: PriceHighToLow;
/**
* Sorts catalog results from the lowest price to the highest price.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#PriceLowToHigh)
*/
export interface PriceLowToHigh extends globalThis.EnumItem {
Name: "PriceLowToHigh";
Value: 3;
EnumType: typeof globalThis.Enum.CatalogSortType;
}
export const PriceLowToHigh: PriceLowToHigh;
/**
* Sorts catalog results by the number of times items have been favorited, with most-favorited items listed first.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#MostFavorited)
*/
export interface MostFavorited extends globalThis.EnumItem {
Name: "MostFavorited";
Value: 5;
EnumType: typeof globalThis.Enum.CatalogSortType;
}
export const MostFavorited: MostFavorited;
/**
* Sorts catalog results by creation date, with the most recently created items listed first.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#RecentlyCreated)
*/
export interface RecentlyCreated extends globalThis.EnumItem {
Name: "RecentlyCreated";
Value: 6;
EnumType: typeof globalThis.Enum.CatalogSortType;
}
export const RecentlyCreated: RecentlyCreated;
/**
* @deprecated renamed to RecentlyCreated
*/
export const RecentlyUpdated: RecentlyCreated;
/**
* Sorts catalog results by total sales, with best-selling items listed first.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#Bestselling)
*/
export interface Bestselling extends globalThis.EnumItem {
Name: "Bestselling";
Value: 7;
EnumType: typeof globalThis.Enum.CatalogSortType;
}
export const Bestselling: Bestselling;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CatalogSortType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CatalogSortType | undefined;
}
export type CatalogSortType = CatalogSortType.Relevance | CatalogSortType.PriceHighToLow | CatalogSortType.PriceLowToHigh | CatalogSortType.MostFavorited | CatalogSortType.RecentlyCreated | CatalogSortType.Bestselling;
/**
* Deprecated enum specifying the geometric block shape of a legacy voxel terrain cell, used with the removed `Terrain:SetCell()` method.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellBlock)
*/
export namespace CellBlock {
/**
* A legacy voxel cell that is completely filled, occupying the full cell volume.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellBlock#Solid)
*/
export interface Solid extends globalThis.EnumItem {
Name: "Solid";
Value: 0;
EnumType: typeof globalThis.Enum.CellBlock;
}
export const Solid: Solid;
/**
* A legacy voxel cell shaped as a vertical wedge, occupying half of a full cell's volume.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellBlock#VerticalWedge)
*/
export interface VerticalWedge extends globalThis.EnumItem {
Name: "VerticalWedge";
Value: 1;
EnumType: typeof globalThis.Enum.CellBlock;
}
export const VerticalWedge: VerticalWedge;
/**
* A legacy voxel cell shaped as a corner wedge, occupying approximately one-third of a full cell's volume.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellBlock#CornerWedge)
*/
export interface CornerWedge extends globalThis.EnumItem {
Name: "CornerWedge";
Value: 2;
EnumType: typeof globalThis.Enum.CellBlock;
}
export const CornerWedge: CornerWedge;
/**
* A legacy voxel cell shaped as an inverse corner wedge, occupying approximately two-thirds of a full cell's volume.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellBlock#InverseCornerWedge)
*/
export interface InverseCornerWedge extends globalThis.EnumItem {
Name: "InverseCornerWedge";
Value: 3;
EnumType: typeof globalThis.Enum.CellBlock;
}
export const InverseCornerWedge: InverseCornerWedge;
/**
* A legacy voxel cell shaped as a horizontal wedge, occupying half of a full cell's volume.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellBlock#HorizontalWedge)
*/
export interface HorizontalWedge extends globalThis.EnumItem {
Name: "HorizontalWedge";
Value: 4;
EnumType: typeof globalThis.Enum.CellBlock;
}
export const HorizontalWedge: HorizontalWedge;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CellBlock | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CellBlock | undefined;
}
export type CellBlock = CellBlock.Solid | CellBlock.VerticalWedge | CellBlock.CornerWedge | CellBlock.InverseCornerWedge | CellBlock.HorizontalWedge;
/**
* Material values for individual cells in the deprecated legacy voxel-based `Terrain` engine.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial)
*/
export namespace CellMaterial {
/**
* Represents an air (unfilled) cell in the legacy voxel terrain; converted to air in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Empty)
*/
export interface Empty extends globalThis.EnumItem {
Name: "Empty";
Value: 0;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Empty: Empty;
/**
* A green grassy cell material in the legacy voxel terrain, converted to `Material.Grass` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Grass)
*/
export interface Grass extends globalThis.EnumItem {
Name: "Grass";
Value: 1;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Grass: Grass;
/**
* A sandy cell material in the legacy voxel terrain, converted to `Material.Sand` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Sand)
*/
export interface Sand extends globalThis.EnumItem {
Name: "Sand";
Value: 2;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Sand: Sand;
/**
* A red brick cell material in the legacy voxel terrain, converted to `Material.Brick` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Brick)
*/
export interface Brick extends globalThis.EnumItem {
Name: "Brick";
Value: 3;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Brick: Brick;
/**
* A speckled stone cell material in the legacy voxel terrain, converted to `Material.Slate` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Granite)
*/
export interface Granite extends globalThis.EnumItem {
Name: "Granite";
Value: 4;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Granite: Granite;
/**
* A dark paved road cell material in the legacy voxel terrain, converted to `Material.Asphalt` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Asphalt)
*/
export interface Asphalt extends globalThis.EnumItem {
Name: "Asphalt";
Value: 5;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Asphalt: Asphalt;
/**
* A dark metallic cell material in the legacy voxel terrain, converted to `Material.Concrete` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Iron)
*/
export interface Iron extends globalThis.EnumItem {
Name: "Iron";
Value: 6;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Iron: Iron;
/**
* A metallic silver cell material in the legacy voxel terrain, converted to `Material.Concrete` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Aluminum)
*/
export interface Aluminum extends globalThis.EnumItem {
Name: "Aluminum";
Value: 7;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Aluminum: Aluminum;
/**
* A golden metallic cell material in the legacy voxel terrain, converted to `Material.Concrete` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Gold)
*/
export interface Gold extends globalThis.EnumItem {
Name: "Gold";
Value: 8;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Gold: Gold;
/**
* A flat wooden plank cell material in the legacy voxel terrain, converted to `Material.WoodPlanks` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#WoodPlank)
*/
export interface WoodPlank extends globalThis.EnumItem {
Name: "WoodPlank";
Value: 9;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const WoodPlank: WoodPlank;
/**
* A round wooden log cell material in the legacy voxel terrain, converted to `Material.WoodPlanks` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#WoodLog)
*/
export interface WoodLog extends globalThis.EnumItem {
Name: "WoodLog";
Value: 10;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const WoodLog: WoodLog;
/**
* A loose-stone cell material in the legacy voxel terrain, converted to `Material.Asphalt` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Gravel)
*/
export interface Gravel extends globalThis.EnumItem {
Name: "Gravel";
Value: 11;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Gravel: Gravel;
/**
* A rough masonry cell material in the legacy voxel terrain, converted to `Material.Concrete` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#CinderBlock)
*/
export interface CinderBlock extends globalThis.EnumItem {
Name: "CinderBlock";
Value: 12;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const CinderBlock: CinderBlock;
/**
* A weathered stone cell material in the legacy voxel terrain, converted to `Material.Pavement` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#MossyStone)
*/
export interface MossyStone extends globalThis.EnumItem {
Name: "MossyStone";
Value: 13;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const MossyStone: MossyStone;
/**
* A gray cement cell material in the legacy voxel terrain, converted to `Material.Concrete` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Cement)
*/
export interface Cement extends globalThis.EnumItem {
Name: "Cement";
Value: 14;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Cement: Cement;
/**
* A red-tinted cell material in the legacy voxel terrain, converted to `Material.Sandstone` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#RedPlastic)
*/
export interface RedPlastic extends globalThis.EnumItem {
Name: "RedPlastic";
Value: 15;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const RedPlastic: RedPlastic;
/**
* A blue-tinted cell material in the legacy voxel terrain, converted to `Material.Ice` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#BluePlastic)
*/
export interface BluePlastic extends globalThis.EnumItem {
Name: "BluePlastic";
Value: 16;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const BluePlastic: BluePlastic;
/**
* A water-filled cell in the legacy voxel terrain, converted to `Material.Water` in the modern terrain system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Water)
*/
export interface Water extends globalThis.EnumItem {
Name: "Water";
Value: 17;
EnumType: typeof globalThis.Enum.CellMaterial;
}
export const Water: Water;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CellMaterial | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CellMaterial | undefined;
}
export type CellMaterial = CellMaterial.Empty | CellMaterial.Grass | CellMaterial.Sand | CellMaterial.Brick | CellMaterial.Granite | CellMaterial.Asphalt | CellMaterial.Iron | CellMaterial.Aluminum | CellMaterial.Gold | CellMaterial.WoodPlank | CellMaterial.WoodLog | CellMaterial.Gravel | CellMaterial.CinderBlock | CellMaterial.MossyStone | CellMaterial.Cement | CellMaterial.RedPlastic | CellMaterial.BluePlastic | CellMaterial.Water;
/**
* Specifies the corner orientation of a legacy terrain cell, used with the deprecated `Terrain:SetCell()` method.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellOrientation)
*/
export namespace CellOrientation {
/**
* Upper-left corner orientation when the cell is viewed from directly above.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellOrientation#NegZ)
*/
export interface NegZ extends globalThis.EnumItem {
Name: "NegZ";
Value: 0;
EnumType: typeof globalThis.Enum.CellOrientation;
}
export const NegZ: NegZ;
/**
* Upper-right corner orientation when the cell is viewed from directly above.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellOrientation#X)
*/
export interface X extends globalThis.EnumItem {
Name: "X";
Value: 1;
EnumType: typeof globalThis.Enum.CellOrientation;
}
export const X: X;
/**
* Lower-right corner orientation when the cell is viewed from directly above.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellOrientation#Z)
*/
export interface Z extends globalThis.EnumItem {
Name: "Z";
Value: 2;
EnumType: typeof globalThis.Enum.CellOrientation;
}
export const Z: Z;
/**
* Lower-left corner orientation when the cell is viewed from directly above.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CellOrientation#NegX)
*/
export interface NegX extends globalThis.EnumItem {
Name: "NegX";
Value: 3;
EnumType: typeof globalThis.Enum.CellOrientation;
}
export const NegX: NegX;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CellOrientation | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CellOrientation | undefined;
}
export type CellOrientation = CellOrientation.NegZ | CellOrientation.X | CellOrientation.Z | CellOrientation.NegX;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CenterDialogType)
*/
export namespace CenterDialogType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CenterDialogType#UnsolicitedDialog)
*/
export interface UnsolicitedDialog extends globalThis.EnumItem {
Name: "UnsolicitedDialog";
Value: 1;
EnumType: typeof globalThis.Enum.CenterDialogType;
}
export const UnsolicitedDialog: UnsolicitedDialog;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CenterDialogType#PlayerInitiatedDialog)
*/
export interface PlayerInitiatedDialog extends globalThis.EnumItem {
Name: "PlayerInitiatedDialog";
Value: 2;
EnumType: typeof globalThis.Enum.CenterDialogType;
}
export const PlayerInitiatedDialog: PlayerInitiatedDialog;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CenterDialogType#ModalDialog)
*/
export interface ModalDialog extends globalThis.EnumItem {
Name: "ModalDialog";
Value: 3;
EnumType: typeof globalThis.Enum.CenterDialogType;
}
export const ModalDialog: ModalDialog;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CenterDialogType#QuitDialog)
*/
export interface QuitDialog extends globalThis.EnumItem {
Name: "QuitDialog";
Value: 4;
EnumType: typeof globalThis.Enum.CenterDialogType;
}
export const QuitDialog: QuitDialog;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CenterDialogType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CenterDialogType | undefined;
}
export type CenterDialogType = CenterDialogType.UnsolicitedDialog | CenterDialogType.PlayerInitiatedDialog | CenterDialogType.ModalDialog | CenterDialogType.QuitDialog;
/**
* Specifies which character controller implementation an experience uses.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CharacterControlMode)
*/
export namespace CharacterControlMode {
/**
* Uses Roblox's default character controller selection.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CharacterControlMode#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.CharacterControlMode;
}
export const Default: Default;
/**
* Uses the legacy character controller.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CharacterControlMode#Legacy)
*/
export interface Legacy extends globalThis.EnumItem {
Name: "Legacy";
Value: 1;
EnumType: typeof globalThis.Enum.CharacterControlMode;
}
export const Legacy: Legacy;
/**
* Does not load a character controller.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CharacterControlMode#NoCharacterController)
*/
export interface NoCharacterController extends globalThis.EnumItem {
Name: "NoCharacterController";
Value: 2;
EnumType: typeof globalThis.Enum.CharacterControlMode;
}
export const NoCharacterController: NoCharacterController;
/**
* Uses the Luau character controller.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CharacterControlMode#LuaCharacterController)
*/
export interface LuaCharacterController extends globalThis.EnumItem {
Name: "LuaCharacterController";
Value: 3;
EnumType: typeof globalThis.Enum.CharacterControlMode;
}
export const LuaCharacterController: LuaCharacterController;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CharacterControlMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CharacterControlMode | undefined;
}
export type CharacterControlMode = CharacterControlMode.Default | CharacterControlMode.Legacy | CharacterControlMode.NoCharacterController | CharacterControlMode.LuaCharacterController;
/**
* Identifies a hook point in the legacy Luau chat pipeline for use with `Chat:RegisterChatCallback()` and `Chat:InvokeChatCallback()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatCallbackType)
*/
export namespace ChatCallbackType {
/**
* Client-only callback invoked before the chat window is constructed, allowing custom settings to be supplied.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatCallbackType#OnCreatingChatWindow)
*/
export interface OnCreatingChatWindow extends globalThis.EnumItem {
Name: "OnCreatingChatWindow";
Value: 1;
EnumType: typeof globalThis.Enum.ChatCallbackType;
}
export const OnCreatingChatWindow: OnCreatingChatWindow;
/**
* Client-only callback reserved for when the client sends a message; not currently invoked.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatCallbackType#OnClientSendingMessage)
*/
export interface OnClientSendingMessage extends globalThis.EnumItem {
Name: "OnClientSendingMessage";
Value: 2;
EnumType: typeof globalThis.Enum.ChatCallbackType;
}
export const OnClientSendingMessage: OnClientSendingMessage;
/**
* Client-only callback invoked before a message is displayed, allowing its display data to be modified.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatCallbackType#OnClientFormattingMessage)
*/
export interface OnClientFormattingMessage extends globalThis.EnumItem {
Name: "OnClientFormattingMessage";
Value: 3;
EnumType: typeof globalThis.Enum.ChatCallbackType;
}
export const OnClientFormattingMessage: OnClientFormattingMessage;
/**
* Server-only callback invoked when the server receives a message from a speaker, allowing the message to be modified or suppressed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatCallbackType#OnServerReceivingMessage)
*/
export interface OnServerReceivingMessage extends globalThis.EnumItem {
Name: "OnServerReceivingMessage";
Value: 17;
EnumType: typeof globalThis.Enum.ChatCallbackType;
}
export const OnServerReceivingMessage: OnServerReceivingMessage;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ChatCallbackType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ChatCallbackType | undefined;
}
export type ChatCallbackType = ChatCallbackType.OnCreatingChatWindow | ChatCallbackType.OnClientSendingMessage | ChatCallbackType.OnClientFormattingMessage | ChatCallbackType.OnServerReceivingMessage;
/**
* Describes the chat color.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatColor)
*/
export namespace ChatColor {
/**
* The blue chat color; the default value passed to `Chat()` and `ChatLocal()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatColor#Blue)
*/
export interface Blue extends globalThis.EnumItem {
Name: "Blue";
Value: 0;
EnumType: typeof globalThis.Enum.ChatColor;
}
export const Blue: Blue;
/**
* The green chat color, passed as the `color` argument to `Chat()` or `ChatLocal()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatColor#Green)
*/
export interface Green extends globalThis.EnumItem {
Name: "Green";
Value: 1;
EnumType: typeof globalThis.Enum.ChatColor;
}
export const Green: Green;
/**
* The red chat color, passed as the `color` argument to `Chat()` or `ChatLocal()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatColor#Red)
*/
export interface Red extends globalThis.EnumItem {
Name: "Red";
Value: 2;
EnumType: typeof globalThis.Enum.ChatColor;
}
export const Red: Red;
/**
* The white chat color, passed as the `color` argument to `Chat()` or `ChatLocal()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatColor#White)
*/
export interface White extends globalThis.EnumItem {
Name: "White";
Value: 3;
EnumType: typeof globalThis.Enum.ChatColor;
}
export const White: White;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ChatColor | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ChatColor | undefined;
}
export type ChatColor = ChatColor.Blue | ChatColor.Green | ChatColor.Red | ChatColor.White;
/**
* Describes the methods of communication available to a player.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatMode)
*/
export namespace ChatMode {
/**
* The player is restricted to chatting via a menu of chat messages.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatMode#Menu)
*/
export interface Menu extends globalThis.EnumItem {
Name: "Menu";
Value: 0;
EnumType: typeof globalThis.Enum.ChatMode;
}
export const Menu: Menu;
/**
* A player can chat via custom text messages and a menu of chat messages.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatMode#TextAndMenu)
*/
export interface TextAndMenu extends globalThis.EnumItem {
Name: "TextAndMenu";
Value: 1;
EnumType: typeof globalThis.Enum.ChatMode;
}
export const TextAndMenu: TextAndMenu;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ChatMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ChatMode | undefined;
}
export type ChatMode = ChatMode.Menu | ChatMode.TextAndMenu;
/**
* Describes which other users a player is permitted to exchange in-game chat messages with.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatPrivacyMode)
*/
export namespace ChatPrivacyMode {
/**
* A player can chat with all users in a game.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatPrivacyMode#AllUsers)
*/
export interface AllUsers extends globalThis.EnumItem {
Name: "AllUsers";
Value: 0;
EnumType: typeof globalThis.Enum.ChatPrivacyMode;
}
export const AllUsers: AllUsers;
/**
* A player cannot chat with any other users in a game.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatPrivacyMode#NoOne)
*/
export interface NoOne extends globalThis.EnumItem {
Name: "NoOne";
Value: 1;
EnumType: typeof globalThis.Enum.ChatPrivacyMode;
}
export const NoOne: NoOne;
/**
* A player can only chat with users in a game that are on their friends list.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatPrivacyMode#Friends)
*/
export interface Friends extends globalThis.EnumItem {
Name: "Friends";
Value: 2;
EnumType: typeof globalThis.Enum.ChatPrivacyMode;
}
export const Friends: Friends;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ChatPrivacyMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ChatPrivacyMode | undefined;
}
export type ChatPrivacyMode = ChatPrivacyMode.AllUsers | ChatPrivacyMode.NoOne | ChatPrivacyMode.Friends;
/**
* Describes the chat restriction status that a third-party platform reports for a user.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatRestrictionStatus)
*/
export namespace ChatRestrictionStatus {
/**
* The platform's chat restriction status for the user has not yet been determined; this is the default value for all ChatRestrictionStatus properties.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatRestrictionStatus#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.ChatRestrictionStatus;
}
export const Unknown: Unknown;
/**
* The third-party platform has confirmed the user has no chat restrictions in effect.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatRestrictionStatus#NotRestricted)
*/
export interface NotRestricted extends globalThis.EnumItem {
Name: "NotRestricted";
Value: 1;
EnumType: typeof globalThis.Enum.ChatRestrictionStatus;
}
export const NotRestricted: NotRestricted;
/**
* The third-party platform has reported the user is restricted from chat, typically due to parental controls or platform communication settings.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatRestrictionStatus#Restricted)
*/
export interface Restricted extends globalThis.EnumItem {
Name: "Restricted";
Value: 2;
EnumType: typeof globalThis.Enum.ChatRestrictionStatus;
}
export const Restricted: Restricted;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ChatRestrictionStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ChatRestrictionStatus | undefined;
}
export type ChatRestrictionStatus = ChatRestrictionStatus.Unknown | ChatRestrictionStatus.NotRestricted | ChatRestrictionStatus.Restricted;
/**
* The ChatStyle Enum is used to set the style of `Chat` used in a game via the `Players:SetChatStyle()` method.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatStyle)
*/
export namespace ChatStyle {
/**
* Displays chats in the chat user interface at the top-left corner of the screen.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatStyle#Classic)
*/
export interface Classic extends globalThis.EnumItem {
Name: "Classic";
Value: 0;
EnumType: typeof globalThis.Enum.ChatStyle;
}
export const Classic: Classic;
/**
* Displays chats in a bubble above the sender's head.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatStyle#Bubble)
*/
export interface Bubble extends globalThis.EnumItem {
Name: "Bubble";
Value: 1;
EnumType: typeof globalThis.Enum.ChatStyle;
}
export const Bubble: Bubble;
/**
* Has the effects of Classic and Bubble combined.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatStyle#ClassicAndBubble)
*/
export interface ClassicAndBubble extends globalThis.EnumItem {
Name: "ClassicAndBubble";
Value: 2;
EnumType: typeof globalThis.Enum.ChatStyle;
}
export const ClassicAndBubble: ClassicAndBubble;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ChatStyle | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ChatStyle | undefined;
}
export type ChatStyle = ChatStyle.Classic | ChatStyle.Bubble | ChatStyle.ClassicAndBubble;
/**
* Determines whether `TextChatService` should be fully enabled or to allow the legacy system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatVersion)
*/
export namespace ChatVersion {
/**
* Enables the legacy chat system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatVersion#LegacyChatService)
*/
export interface LegacyChatService extends globalThis.EnumItem {
Name: "LegacyChatService";
Value: 0;
EnumType: typeof globalThis.Enum.ChatVersion;
}
export const LegacyChatService: LegacyChatService;
/**
* Enables `TextChatService` chat and prevents legacy chat system behavior.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ChatVersion#TextChatService)
*/
export interface TextChatService extends globalThis.EnumItem {
Name: "TextChatService";
Value: 1;
EnumType: typeof globalThis.Enum.ChatVersion;
}
export const TextChatService: TextChatService;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ChatVersion | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ChatVersion | undefined;
}
export type ChatVersion = ChatVersion.LegacyChatService | ChatVersion.TextChatService;
/**
* An Enum describing various animation throttling modes on clients.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ClientAnimatorThrottlingMode)
*/
export namespace ClientAnimatorThrottlingMode {
/**
* The default animation throttling mode defined by Roblox.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ClientAnimatorThrottlingMode#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.ClientAnimatorThrottlingMode;
}
export const Default: Default;
/**
* Disables animation throttling.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ClientAnimatorThrottlingMode#Disabled)
*/
export interface Disabled extends globalThis.EnumItem {
Name: "Disabled";
Value: 1;
EnumType: typeof globalThis.Enum.ClientAnimatorThrottlingMode;
}
export const Disabled: Disabled;
/**
* Enables animation throttling.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ClientAnimatorThrottlingMode#Enabled)
*/
export interface Enabled extends globalThis.EnumItem {
Name: "Enabled";
Value: 2;
EnumType: typeof globalThis.Enum.ClientAnimatorThrottlingMode;
}
export const Enabled: Enabled;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ClientAnimatorThrottlingMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ClientAnimatorThrottlingMode | undefined;
}
export type ClientAnimatorThrottlingMode = ClientAnimatorThrottlingMode.Default | ClientAnimatorThrottlingMode.Disabled | ClientAnimatorThrottlingMode.Enabled;
/**
* Specifies the reason for the experience server shutdown.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CloseReason)
*/
export namespace CloseReason {
/**
* The server shut down for an unknown reason.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CloseReason#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.CloseReason;
}
export const Unknown: Unknown;
/**
* The server shut down for maintenance.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CloseReason#RobloxMaintenance)
*/
export interface RobloxMaintenance extends globalThis.EnumItem {
Name: "RobloxMaintenance";
Value: 1;
EnumType: typeof globalThis.Enum.CloseReason;
}
export const RobloxMaintenance: RobloxMaintenance;
/**
* The experience developer has shut down the server, or functions bound by `BindToClose()` have been called inside Studio.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CloseReason#DeveloperShutdown)
*/
export interface DeveloperShutdown extends globalThis.EnumItem {
Name: "DeveloperShutdown";
Value: 2;
EnumType: typeof globalThis.Enum.CloseReason;
}
export const DeveloperShutdown: DeveloperShutdown;
/**
* The experience developer has migrated the server to a new place version.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CloseReason#DeveloperUpdate)
*/
export interface DeveloperUpdate extends globalThis.EnumItem {
Name: "DeveloperUpdate";
Value: 3;
EnumType: typeof globalThis.Enum.CloseReason;
}
export const DeveloperUpdate: DeveloperUpdate;
/**
* The last player has left and the experience is empty.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CloseReason#ServerEmpty)
*/
export interface ServerEmpty extends globalThis.EnumItem {
Name: "ServerEmpty";
Value: 4;
EnumType: typeof globalThis.Enum.CloseReason;
}
export const ServerEmpty: ServerEmpty;
/**
* The experience has hit the memory limit for the game server.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CloseReason#OutOfMemory)
*/
export interface OutOfMemory extends globalThis.EnumItem {
Name: "OutOfMemory";
Value: 5;
EnumType: typeof globalThis.Enum.CloseReason;
}
export const OutOfMemory: OutOfMemory;
/**
* The server was shut down because the experience or place was taken down for moderation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CloseReason#Moderation)
*/
export interface Moderation extends globalThis.EnumItem {
Name: "Moderation";
Value: 6;
EnumType: typeof globalThis.Enum.CloseReason;
}
export const Moderation: Moderation;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CloseReason | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CloseReason | undefined;
}
export type CloseReason = CloseReason.Unknown | CloseReason.RobloxMaintenance | CloseReason.DeveloperShutdown | CloseReason.DeveloperUpdate | CloseReason.ServerEmpty | CloseReason.OutOfMemory | CloseReason.Moderation;
/**
* Describes the current editing activity of a collaborator in a Team Create session.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollaboratorStatus)
*/
export namespace CollaboratorStatus {
/**
* The collaborator has no active editing context; this is the default status.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollaboratorStatus#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.CollaboratorStatus;
}
export const None: None;
/**
* The collaborator is actively working in the 3D viewport.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollaboratorStatus#Editing3D)
*/
export interface Editing3D extends globalThis.EnumItem {
Name: "Editing3D";
Value: 1;
EnumType: typeof globalThis.Enum.CollaboratorStatus;
}
export const Editing3D: Editing3D;
/**
* The collaborator is editing a script that is replicated to the server.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollaboratorStatus#Scripting)
*/
export interface Scripting extends globalThis.EnumItem {
Name: "Scripting";
Value: 2;
EnumType: typeof globalThis.Enum.CollaboratorStatus;
}
export const Scripting: Scripting;
/**
* The collaborator is editing a script that is not replicated to the server (a local or module script not visible server-side).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollaboratorStatus#PrivateScripting)
*/
export interface PrivateScripting extends globalThis.EnumItem {
Name: "PrivateScripting";
Value: 3;
EnumType: typeof globalThis.Enum.CollaboratorStatus;
}
export const PrivateScripting: PrivateScripting;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CollaboratorStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CollaboratorStatus | undefined;
}
export type CollaboratorStatus = CollaboratorStatus.None | CollaboratorStatus.Editing3D | CollaboratorStatus.Scripting | CollaboratorStatus.PrivateScripting;
/**
* Determines behavior of the collision hitbox for `MeshPart` and `PartOperation` instances.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity)
*/
export namespace CollisionFidelity {
/**
* Collision model uses a voxel-based convex-hull decomposition that is relatively fast but may not be highly accurate, especially for holes, doorways, and cavities in general.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.CollisionFidelity;
}
export const Default: Default;
/**
* Collision model uses the convex hull of the visual mesh.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Hull)
*/
export interface Hull extends globalThis.EnumItem {
Name: "Hull";
Value: 1;
EnumType: typeof globalThis.Enum.CollisionFidelity;
}
export const Hull: Hull;
/**
* Collision model uses a bounding box that encompasses the visual mesh.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Box)
*/
export interface Box extends globalThis.EnumItem {
Name: "Box";
Value: 2;
EnumType: typeof globalThis.Enum.CollisionFidelity;
}
export const Box: Box;
/**
* Collison model uses a convex-hull decomposition of the visual mesh which is computed by a variation of an algorithm called HACD. This option is the most accurate representation of collision geometry for complex objects with built-in tolerances to reduce the total number of convex-hulls by compromising on accuracy when justified.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#PreciseConvexDecomposition)
*/
export interface PreciseConvexDecomposition extends globalThis.EnumItem {
Name: "PreciseConvexDecomposition";
Value: 3;
EnumType: typeof globalThis.Enum.CollisionFidelity;
}
export const PreciseConvexDecomposition: PreciseConvexDecomposition;
/**
* Collision model that supports precision tuning of convex decomposition fidelity.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Tunable)
*/
export interface Tunable extends globalThis.EnumItem {
Name: "Tunable";
Value: 4;
EnumType: typeof globalThis.Enum.CollisionFidelity;
}
export const Tunable: Tunable;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CollisionFidelity | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CollisionFidelity | undefined;
}
export type CollisionFidelity = CollisionFidelity.Default | CollisionFidelity.Hull | CollisionFidelity.Box | CollisionFidelity.PreciseConvexDecomposition | CollisionFidelity.Tunable;
/**
* Specifies the minimum security permission level required to invoke a Studio command.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CommandPermission)
*/
export namespace CommandPermission {
/**
* The command is accessible to scripts running at the standard Plugin security level.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CommandPermission#Plugin)
*/
export interface Plugin extends globalThis.EnumItem {
Name: "Plugin";
Value: 0;
EnumType: typeof globalThis.Enum.CommandPermission;
}
export const Plugin: Plugin;
/**
* The command requires the LocalUser security level, granting access to IDE-only APIs.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CommandPermission#LocalUser)
*/
export interface LocalUser extends globalThis.EnumItem {
Name: "LocalUser";
Value: 1;
EnumType: typeof globalThis.Enum.CommandPermission;
}
export const LocalUser: LocalUser;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CommandPermission | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CommandPermission | undefined;
}
export type CommandPermission = CommandPermission.Plugin | CommandPermission.LocalUser;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompileTarget)
*/
export namespace CompileTarget {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompileTarget#Client)
*/
export interface Client extends globalThis.EnumItem {
Name: "Client";
Value: 0;
EnumType: typeof globalThis.Enum.CompileTarget;
}
export const Client: Client;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompileTarget#CoreScript)
*/
export interface CoreScript extends globalThis.EnumItem {
Name: "CoreScript";
Value: 1;
EnumType: typeof globalThis.Enum.CompileTarget;
}
export const CoreScript: CoreScript;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompileTarget#Studio)
*/
export interface Studio extends globalThis.EnumItem {
Name: "Studio";
Value: 2;
EnumType: typeof globalThis.Enum.CompileTarget;
}
export const Studio: Studio;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompileTarget#CoreScriptRaw)
*/
export interface CoreScriptRaw extends globalThis.EnumItem {
Name: "CoreScriptRaw";
Value: 3;
EnumType: typeof globalThis.Enum.CompileTarget;
}
export const CoreScriptRaw: CoreScriptRaw;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CompileTarget | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CompileTarget | undefined;
}
export type CompileTarget = CompileTarget.Client | CompileTarget.CoreScript | CompileTarget.Studio | CompileTarget.CoreScriptRaw;
/**
* Controls how the Script Editor inserts or replaces text when an autocomplete suggestion is accepted with Enter or Tab.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionAcceptanceBehavior)
*/
export namespace CompletionAcceptanceBehavior {
/**
* Accepting a completion with either Enter or Tab inserts the suggestion without replacing existing text after the cursor.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionAcceptanceBehavior#Insert)
*/
export interface Insert extends globalThis.EnumItem {
Name: "Insert";
Value: 0;
EnumType: typeof globalThis.Enum.CompletionAcceptanceBehavior;
}
export const Insert: Insert;
/**
* Accepting a completion with either Enter or Tab replaces existing text after the cursor with the full suggestion text.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionAcceptanceBehavior#Replace)
*/
export interface Replace extends globalThis.EnumItem {
Name: "Replace";
Value: 1;
EnumType: typeof globalThis.Enum.CompletionAcceptanceBehavior;
}
export const Replace: Replace;
/**
* Pressing Enter replaces existing text after the cursor; pressing Tab inserts without replacing text after the cursor.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionAcceptanceBehavior#ReplaceOnEnterInsertOnTab)
*/
export interface ReplaceOnEnterInsertOnTab extends globalThis.EnumItem {
Name: "ReplaceOnEnterInsertOnTab";
Value: 2;
EnumType: typeof globalThis.Enum.CompletionAcceptanceBehavior;
}
export const ReplaceOnEnterInsertOnTab: ReplaceOnEnterInsertOnTab;
/**
* Pressing Enter inserts without replacing text after the cursor; pressing Tab replaces text after the cursor. This is the default of `Studio.AutocompleteAcceptanceBehavior`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionAcceptanceBehavior#InsertOnEnterReplaceOnTab)
*/
export interface InsertOnEnterReplaceOnTab extends globalThis.EnumItem {
Name: "InsertOnEnterReplaceOnTab";
Value: 3;
EnumType: typeof globalThis.Enum.CompletionAcceptanceBehavior;
}
export const InsertOnEnterReplaceOnTab: InsertOnEnterReplaceOnTab;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CompletionAcceptanceBehavior | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CompletionAcceptanceBehavior | undefined;
}
export type CompletionAcceptanceBehavior = CompletionAcceptanceBehavior.Insert | CompletionAcceptanceBehavior.Replace | CompletionAcceptanceBehavior.ReplaceOnEnterInsertOnTab | CompletionAcceptanceBehavior.InsertOnEnterReplaceOnTab;
/**
* Indicates the category of a script editor autocomplete suggestion, controlling its icon and display in the completion list.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind)
*/
export namespace CompletionItemKind {
/**
* Indicates the completion item represents a plain text suggestion.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Text)
*/
export interface Text extends globalThis.EnumItem {
Name: "Text";
Value: 1;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Text: Text;
/**
* Indicates the completion item represents a method on a class or object.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Method)
*/
export interface Method extends globalThis.EnumItem {
Name: "Method";
Value: 2;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Method: Method;
/**
* Indicates the completion item represents a function.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Function)
*/
export interface Function extends globalThis.EnumItem {
Name: "Function";
Value: 3;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Function: Function;
/**
* Indicates the completion item represents a constructor.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Constructor)
*/
export interface Constructor extends globalThis.EnumItem {
Name: "Constructor";
Value: 4;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Constructor: Constructor;
/**
* Indicates the completion item represents a field within a record or struct.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Field)
*/
export interface Field extends globalThis.EnumItem {
Name: "Field";
Value: 5;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Field: Field;
/**
* Indicates the completion item represents a variable binding.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Variable)
*/
export interface Variable extends globalThis.EnumItem {
Name: "Variable";
Value: 6;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Variable: Variable;
/**
* Indicates the completion item represents a class or type definition.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Class)
*/
export interface Class extends globalThis.EnumItem {
Name: "Class";
Value: 7;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Class: Class;
/**
* Indicates the completion item represents an interface type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Interface)
*/
export interface Interface extends globalThis.EnumItem {
Name: "Interface";
Value: 8;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Interface: Interface;
/**
* Indicates the completion item represents a module.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Module)
*/
export interface Module extends globalThis.EnumItem {
Name: "Module";
Value: 9;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Module: Module;
/**
* Indicates the completion item represents a property on a class or object.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Property)
*/
export interface Property extends globalThis.EnumItem {
Name: "Property";
Value: 10;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Property: Property;
/**
* Indicates the completion item represents a unit of measurement or a module-level value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Unit)
*/
export interface Unit extends globalThis.EnumItem {
Name: "Unit";
Value: 11;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Unit: Unit;
/**
* Indicates the completion item represents a value expression.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Value)
*/
export interface Value extends globalThis.EnumItem {
Name: "Value";
Value: 12;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Value: Value;
/**
* Indicates the completion item represents an enum type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Enum)
*/
export interface Enum extends globalThis.EnumItem {
Name: "Enum";
Value: 13;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Enum: Enum;
/**
* Indicates the completion item represents a language keyword.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Keyword)
*/
export interface Keyword extends globalThis.EnumItem {
Name: "Keyword";
Value: 14;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Keyword: Keyword;
/**
* Indicates the completion item represents an insertable code snippet with tab stops.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Snippet)
*/
export interface Snippet extends globalThis.EnumItem {
Name: "Snippet";
Value: 15;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Snippet: Snippet;
/**
* Indicates the completion item represents a color value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Color)
*/
export interface Color extends globalThis.EnumItem {
Name: "Color";
Value: 16;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Color: Color;
/**
* Indicates the completion item represents a file reference.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#File)
*/
export interface File extends globalThis.EnumItem {
Name: "File";
Value: 17;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const File: File;
/**
* Indicates the completion item represents a reference to another symbol.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Reference)
*/
export interface Reference extends globalThis.EnumItem {
Name: "Reference";
Value: 18;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Reference: Reference;
/**
* Indicates the completion item represents a folder or directory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Folder)
*/
export interface Folder extends globalThis.EnumItem {
Name: "Folder";
Value: 19;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Folder: Folder;
/**
* Indicates the completion item represents an individual enum member value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#EnumMember)
*/
export interface EnumMember extends globalThis.EnumItem {
Name: "EnumMember";
Value: 20;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const EnumMember: EnumMember;
/**
* Indicates the completion item represents a constant value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Constant)
*/
export interface Constant extends globalThis.EnumItem {
Name: "Constant";
Value: 21;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Constant: Constant;
/**
* Indicates the completion item represents a struct or table type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Struct)
*/
export interface Struct extends globalThis.EnumItem {
Name: "Struct";
Value: 22;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Struct: Struct;
/**
* Indicates the completion item represents an event.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Event)
*/
export interface Event extends globalThis.EnumItem {
Name: "Event";
Value: 23;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Event: Event;
/**
* Indicates the completion item represents an operator.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Operator)
*/
export interface Operator extends globalThis.EnumItem {
Name: "Operator";
Value: 24;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const Operator: Operator;
/**
* Indicates the completion item represents a generic type parameter.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#TypeParameter)
*/
export interface TypeParameter extends globalThis.EnumItem {
Name: "TypeParameter";
Value: 25;
EnumType: typeof globalThis.Enum.CompletionItemKind;
}
export const TypeParameter: TypeParameter;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CompletionItemKind | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CompletionItemKind | undefined;
}
export type CompletionItemKind = CompletionItemKind.Text | CompletionItemKind.Method | CompletionItemKind.Function | CompletionItemKind.Constructor | CompletionItemKind.Field | CompletionItemKind.Variable | CompletionItemKind.Class | CompletionItemKind.Interface | CompletionItemKind.Module | CompletionItemKind.Property | CompletionItemKind.Unit | CompletionItemKind.Value | CompletionItemKind.Enum | CompletionItemKind.Keyword | CompletionItemKind.Snippet | CompletionItemKind.Color | CompletionItemKind.File | CompletionItemKind.Reference | CompletionItemKind.Folder | CompletionItemKind.EnumMember | CompletionItemKind.Constant | CompletionItemKind.Struct | CompletionItemKind.Event | CompletionItemKind.Operator | CompletionItemKind.TypeParameter;
/**
* Determines the tags for completion items in `ScriptEditorService:RegisterAutocompleteCallback()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag)
*/
export namespace CompletionItemTag {
/**
* Indicates that the completion is deprecated, applying a penalty towards its score and crossing it out in the completion list.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#Deprecated)
*/
export interface Deprecated extends globalThis.EnumItem {
Name: "Deprecated";
Value: 1;
EnumType: typeof globalThis.Enum.CompletionItemTag;
}
export const Deprecated: Deprecated;
/**
* Indicates that the completion is a member and being accessed with the wrong index type (e.g. using `:` to access a property), hiding it from the completion list.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#IncorrectIndexType)
*/
export interface IncorrectIndexType extends globalThis.EnumItem {
Name: "IncorrectIndexType";
Value: 2;
EnumType: typeof globalThis.Enum.CompletionItemTag;
}
export const IncorrectIndexType: IncorrectIndexType;
/**
* Indicates that the completion requires Plugin security level to access, hiding it if the client lacks this level.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#PluginPermissions)
*/
export interface PluginPermissions extends globalThis.EnumItem {
Name: "PluginPermissions";
Value: 3;
EnumType: typeof globalThis.Enum.CompletionItemTag;
}
export const PluginPermissions: PluginPermissions;
/**
* Indicates that the completion requires Command line security level to access, hiding it if the client lacks this level.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#CommandLinePermissions)
*/
export interface CommandLinePermissions extends globalThis.EnumItem {
Name: "CommandLinePermissions";
Value: 4;
EnumType: typeof globalThis.Enum.CompletionItemTag;
}
export const CommandLinePermissions: CommandLinePermissions;
/**
* Indicates that the completion requires core script security level to access, hiding it if the client lacks this level.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#RobloxPermissions)
*/
export interface RobloxPermissions extends globalThis.EnumItem {
Name: "RobloxPermissions";
Value: 5;
EnumType: typeof globalThis.Enum.CompletionItemTag;
}
export const RobloxPermissions: RobloxPermissions;
/**
* Instructs the editor to add parentheses before the cursor after inserting the given completion, if accepted.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#AddParens)
*/
export interface AddParens extends globalThis.EnumItem {
Name: "AddParens";
Value: 6;
EnumType: typeof globalThis.Enum.CompletionItemTag;
}
export const AddParens: AddParens;
/**
* Instructs the editor to add parentheses before the cursor and move the cursor into the parentheses after inserting the given completion, if accepted.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#PutCursorInParens)
*/
export interface PutCursorInParens extends globalThis.EnumItem {
Name: "PutCursorInParens";
Value: 7;
EnumType: typeof globalThis.Enum.CompletionItemTag;
}
export const PutCursorInParens: PutCursorInParens;
/**
* Indicates that the completion is type correct in the current context, granting a bonus to its score.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#TypeCorrect)
*/
export interface TypeCorrect extends globalThis.EnumItem {
Name: "TypeCorrect";
Value: 8;
EnumType: typeof globalThis.Enum.CompletionItemTag;
}
export const TypeCorrect: TypeCorrect;
/**
* Indicates that the completion is being accessed from the wrong side of the client/server boundary (e.g. Players.LocalPlayer in a server script), hiding it from the completion list.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#ClientServerBoundaryViolation)
*/
export interface ClientServerBoundaryViolation extends globalThis.EnumItem {
Name: "ClientServerBoundaryViolation";
Value: 9;
EnumType: typeof globalThis.Enum.CompletionItemTag;
}
export const ClientServerBoundaryViolation: ClientServerBoundaryViolation;
/**
* Indicates that the completion is stale because the cursor has moved outside the item's valid replacement range, hiding it from the completion list.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#Invalidated)
*/
export interface Invalidated extends globalThis.EnumItem {
Name: "Invalidated";
Value: 10;
EnumType: typeof globalThis.Enum.CompletionItemTag;
}
export const Invalidated: Invalidated;
/**
* Instructs the editor to move the cursor to just before the nearest preceding `end` keyword after inserting the given completion, if accepted.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#PutCursorBeforeEnd)
*/
export interface PutCursorBeforeEnd extends globalThis.EnumItem {
Name: "PutCursorBeforeEnd";
Value: 11;
EnumType: typeof globalThis.Enum.CompletionItemTag;
}
export const PutCursorBeforeEnd: PutCursorBeforeEnd;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CompletionItemTag | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CompletionItemTag | undefined;
}
export type CompletionItemTag = CompletionItemTag.Deprecated | CompletionItemTag.IncorrectIndexType | CompletionItemTag.PluginPermissions | CompletionItemTag.CommandLinePermissions | CompletionItemTag.RobloxPermissions | CompletionItemTag.AddParens | CompletionItemTag.PutCursorInParens | CompletionItemTag.TypeCorrect | CompletionItemTag.ClientServerBoundaryViolation | CompletionItemTag.Invalidated | CompletionItemTag.PutCursorBeforeEnd;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionTriggerKind)
*/
export namespace CompletionTriggerKind {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionTriggerKind#Invoked)
*/
export interface Invoked extends globalThis.EnumItem {
Name: "Invoked";
Value: 1;
EnumType: typeof globalThis.Enum.CompletionTriggerKind;
}
export const Invoked: Invoked;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionTriggerKind#TriggerCharacter)
*/
export interface TriggerCharacter extends globalThis.EnumItem {
Name: "TriggerCharacter";
Value: 2;
EnumType: typeof globalThis.Enum.CompletionTriggerKind;
}
export const TriggerCharacter: TriggerCharacter;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompletionTriggerKind#TriggerForIncompleteCompletions)
*/
export interface TriggerForIncompleteCompletions extends globalThis.EnumItem {
Name: "TriggerForIncompleteCompletions";
Value: 3;
EnumType: typeof globalThis.Enum.CompletionTriggerKind;
}
export const TriggerForIncompleteCompletions: TriggerForIncompleteCompletions;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CompletionTriggerKind | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CompletionTriggerKind | undefined;
}
export type CompletionTriggerKind = CompletionTriggerKind.Invoked | CompletionTriggerKind.TriggerCharacter | CompletionTriggerKind.TriggerForIncompleteCompletions;
/**
* Describes the type of value animated by a `CompositeValueCurve`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType)
*/
export namespace CompositeValueCurveType {
/**
* The `CompositeValueCurve` will animate children of type `FloatCurve` named `"R"`, `"G"`, and `"B"` to animate the corresponding components of the `Color3` value returned by the method `CompositeValueCurve:GetValueAtTime()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#ColorRGB)
*/
export interface ColorRGB extends globalThis.EnumItem {
Name: "ColorRGB";
Value: 0;
EnumType: typeof globalThis.Enum.CompositeValueCurveType;
}
export const ColorRGB: ColorRGB;
/**
* The `CompositeValueCurve` will animate children of type `FloatCurve` named `"H"`, `"S"`, and `"V"` to animate hue, saturation, and value of a color that will be converted to RGB before returning a `Color3` value from the method `CompositeValueCurve:GetValueAtTime()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#ColorHSV)
*/
export interface ColorHSV extends globalThis.EnumItem {
Name: "ColorHSV";
Value: 1;
EnumType: typeof globalThis.Enum.CompositeValueCurveType;
}
export const ColorHSV: ColorHSV;
/**
* The `CompositeValueCurve` will animate children of type `FloatCurve` named `"Min"` and `"Max"` to animate the corresponding components of the `NumberRange` value returned by the method `CompositeValueCurve:GetValueAtTime()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#NumberRange)
*/
export interface NumberRange extends globalThis.EnumItem {
Name: "NumberRange";
Value: 2;
EnumType: typeof globalThis.Enum.CompositeValueCurveType;
}
export const NumberRange: NumberRange;
/**
* The `CompositeValueCurve` will animate children of type `FloatCurve` named `"MinX"`, `"MaxX"`, `"MinY"`, and `"MaxY"` to animate the corresponding components of the `Rect` value returned by the method `CompositeValueCurve:GetValueAtTime()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#Rect)
*/
export interface Rect extends globalThis.EnumItem {
Name: "Rect";
Value: 3;
EnumType: typeof globalThis.Enum.CompositeValueCurveType;
}
export const Rect: Rect;
/**
* The `CompositeValueCurve` will animate children of type `FloatCurve` named `"Scale"` and `"Offset"` to animate the corresponding components of the `UDim` value returned by the method `CompositeValueCurve:GetValueAtTime()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#UDim)
*/
export interface UDim extends globalThis.EnumItem {
Name: "UDim";
Value: 4;
EnumType: typeof globalThis.Enum.CompositeValueCurveType;
}
export const UDim: UDim;
/**
* The `CompositeValueCurve` will animate children of type `FloatCurve` named `"ScaleX"`, `"OffsetX"`, `"ScaleY"`, and `"OffsetY"` to animate the corresponding components of the `UDim2` value returned by the method `CompositeValueCurve:GetValueAtTime()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#UDim2)
*/
export interface UDim2 extends globalThis.EnumItem {
Name: "UDim2";
Value: 5;
EnumType: typeof globalThis.Enum.CompositeValueCurveType;
}
export const UDim2: UDim2;
/**
* The `CompositeValueCurve` will animate children of type `FloatCurve` named `"X"` and `"Y"` to animate the corresponding components of the `Vector2` value returned by the method `CompositeValueCurve:GetValueAtTime()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#Vector2)
*/
export interface Vector2 extends globalThis.EnumItem {
Name: "Vector2";
Value: 6;
EnumType: typeof globalThis.Enum.CompositeValueCurveType;
}
export const Vector2: Vector2;
/**
* The `CompositeValueCurve` will animate children of type `FloatCurve` named `"X"`, `"Y"`, and `"Z"` to animate the corresponding components of the `Vector3` value returned by the method `CompositeValueCurve:GetValueAtTime()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#Vector3)
*/
export interface Vector3 extends globalThis.EnumItem {
Name: "Vector3";
Value: 7;
EnumType: typeof globalThis.Enum.CompositeValueCurveType;
}
export const Vector3: Vector3;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CompositeValueCurveType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CompositeValueCurveType | undefined;
}
export type CompositeValueCurveType = CompositeValueCurveType.ColorRGB | CompositeValueCurveType.ColorHSV | CompositeValueCurveType.NumberRange | CompositeValueCurveType.Rect | CompositeValueCurveType.UDim | CompositeValueCurveType.UDim2 | CompositeValueCurveType.Vector2 | CompositeValueCurveType.Vector3;
/**
* A compression algorithm to use in `EncodingService` methods.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompressionAlgorithm)
*/
export namespace CompressionAlgorithm {
/**
* Used to perform compression using [Zstandard](https://en.wikipedia.org/wiki/Zstd) compression, also known as zstd.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CompressionAlgorithm#Zstd)
*/
export interface Zstd extends globalThis.EnumItem {
Name: "Zstd";
Value: 0;
EnumType: typeof globalThis.Enum.CompressionAlgorithm;
}
export const Zstd: Zstd;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CompressionAlgorithm | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CompressionAlgorithm | undefined;
}
export type CompressionAlgorithm = CompressionAlgorithm.Zstd;
/**
* The camera movement mode currently in-use by the client.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode)
*/
export namespace ComputerCameraMovementMode {
/**
* The default camera movement mode is classic.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.ComputerCameraMovementMode;
}
export const Default: Default;
/**
* Camera tracks the player but will not automatically rotate if the player walks left or right.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode#Classic)
*/
export interface Classic extends globalThis.EnumItem {
Name: "Classic";
Value: 1;
EnumType: typeof globalThis.Enum.ComputerCameraMovementMode;
}
export const Classic: Classic;
/**
* Camera tracks the player and automatically rotates if the player walks left or right.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode#Follow)
*/
export interface Follow extends globalThis.EnumItem {
Name: "Follow";
Value: 2;
EnumType: typeof globalThis.Enum.ComputerCameraMovementMode;
}
export const Follow: Follow;
/**
* The camera has a fixed Y position, but can be rotated around the player.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode#Orbital)
*/
export interface Orbital extends globalThis.EnumItem {
Name: "Orbital";
Value: 3;
EnumType: typeof globalThis.Enum.ComputerCameraMovementMode;
}
export const Orbital: Orbital;
/**
* The camera toggles between locked and free rotation with the right mouse button.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode#CameraToggle)
*/
export interface CameraToggle extends globalThis.EnumItem {
Name: "CameraToggle";
Value: 4;
EnumType: typeof globalThis.Enum.ComputerCameraMovementMode;
}
export const CameraToggle: CameraToggle;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ComputerCameraMovementMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ComputerCameraMovementMode | undefined;
}
export type ComputerCameraMovementMode = ComputerCameraMovementMode.Default | ComputerCameraMovementMode.Classic | ComputerCameraMovementMode.Follow | ComputerCameraMovementMode.Orbital | ComputerCameraMovementMode.CameraToggle;
/**
* The computer movement type in-use by the client.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ComputerMovementMode)
*/
export namespace ComputerMovementMode {
/**
* The movement mode has not been explicitly set and behaves identically to `KeyboardMouse`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ComputerMovementMode#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.ComputerMovementMode;
}
export const Default: Default;
/**
* The player moves their character using keyboard keys and steers the camera with the mouse.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ComputerMovementMode#KeyboardMouse)
*/
export interface KeyboardMouse extends globalThis.EnumItem {
Name: "KeyboardMouse";
Value: 1;
EnumType: typeof globalThis.Enum.ComputerMovementMode;
}
export const KeyboardMouse: KeyboardMouse;
/**
* The player moves their character by clicking a destination in the game world; the character automatically navigates there and jumps over surmountable obstacles.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ComputerMovementMode#ClickToMove)
*/
export interface ClickToMove extends globalThis.EnumItem {
Name: "ClickToMove";
Value: 2;
EnumType: typeof globalThis.Enum.ComputerMovementMode;
}
export const ClickToMove: ClickToMove;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ComputerMovementMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ComputerMovementMode | undefined;
}
export type ComputerMovementMode = ComputerMovementMode.Default | ComputerMovementMode.KeyboardMouse | ComputerMovementMode.ClickToMove;
/**
* Describes the error state of a `ConfigSnapshot` object.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConfigSnapshotErrorState)
*/
export namespace ConfigSnapshotErrorState {
/**
* Indicates the snapshot loaded successfully with no error; this is the default state.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConfigSnapshotErrorState#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.ConfigSnapshotErrorState;
}
export const None: None;
/**
* Indicates the snapshot failed to load because the underlying config service was unavailable at construction time.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConfigSnapshotErrorState#LoadFailed)
*/
export interface LoadFailed extends globalThis.EnumItem {
Name: "LoadFailed";
Value: 1;
EnumType: typeof globalThis.Enum.ConfigSnapshotErrorState;
}
export const LoadFailed: LoadFailed;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ConfigSnapshotErrorState | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ConfigSnapshotErrorState | undefined;
}
export type ConfigSnapshotErrorState = ConfigSnapshotErrorState.None | ConfigSnapshotErrorState.LoadFailed;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError)
*/
export namespace ConnectionError {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#OK)
*/
export interface OK extends globalThis.EnumItem {
Name: "OK";
Value: 0;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const OK: OK;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 1;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const Unknown: Unknown;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ConnectErrors)
*/
export interface ConnectErrors extends globalThis.EnumItem {
Name: "ConnectErrors";
Value: 2;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const ConnectErrors: ConnectErrors;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#AlreadyConnected)
*/
export interface AlreadyConnected extends globalThis.EnumItem {
Name: "AlreadyConnected";
Value: 3;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const AlreadyConnected: AlreadyConnected;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NoFreeIncomingConnections)
*/
export interface NoFreeIncomingConnections extends globalThis.EnumItem {
Name: "NoFreeIncomingConnections";
Value: 4;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const NoFreeIncomingConnections: NoFreeIncomingConnections;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ConnectionBanned)
*/
export interface ConnectionBanned extends globalThis.EnumItem {
Name: "ConnectionBanned";
Value: 5;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const ConnectionBanned: ConnectionBanned;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#InvalidPassword)
*/
export interface InvalidPassword extends globalThis.EnumItem {
Name: "InvalidPassword";
Value: 6;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const InvalidPassword: InvalidPassword;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#IncompatibleProtocolVersion)
*/
export interface IncompatibleProtocolVersion extends globalThis.EnumItem {
Name: "IncompatibleProtocolVersion";
Value: 7;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const IncompatibleProtocolVersion: IncompatibleProtocolVersion;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#IPRecentlyConnected)
*/
export interface IPRecentlyConnected extends globalThis.EnumItem {
Name: "IPRecentlyConnected";
Value: 8;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const IPRecentlyConnected: IPRecentlyConnected;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#OurSystemRequiresSecurity)
*/
export interface OurSystemRequiresSecurity extends globalThis.EnumItem {
Name: "OurSystemRequiresSecurity";
Value: 9;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const OurSystemRequiresSecurity: OurSystemRequiresSecurity;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#SecurityKeyMismatch)
*/
export interface SecurityKeyMismatch extends globalThis.EnumItem {
Name: "SecurityKeyMismatch";
Value: 10;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const SecurityKeyMismatch: SecurityKeyMismatch;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectErrors)
*/
export interface DisconnectErrors extends globalThis.EnumItem {
Name: "DisconnectErrors";
Value: 256;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectErrors: DisconnectErrors;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectBadhash)
*/
export interface DisconnectBadhash extends globalThis.EnumItem {
Name: "DisconnectBadhash";
Value: 257;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectBadhash: DisconnectBadhash;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectSecurityKeyMismatch)
*/
export interface DisconnectSecurityKeyMismatch extends globalThis.EnumItem {
Name: "DisconnectSecurityKeyMismatch";
Value: 258;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectSecurityKeyMismatch: DisconnectSecurityKeyMismatch;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectProtocolMismatch)
*/
export interface DisconnectProtocolMismatch extends globalThis.EnumItem {
Name: "DisconnectProtocolMismatch";
Value: 259;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectProtocolMismatch: DisconnectProtocolMismatch;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectReceivePacketError)
*/
export interface DisconnectReceivePacketError extends globalThis.EnumItem {
Name: "DisconnectReceivePacketError";
Value: 260;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectReceivePacketError: DisconnectReceivePacketError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectReceivePacketStreamError)
*/
export interface DisconnectReceivePacketStreamError extends globalThis.EnumItem {
Name: "DisconnectReceivePacketStreamError";
Value: 261;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectReceivePacketStreamError: DisconnectReceivePacketStreamError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectSendPacketError)
*/
export interface DisconnectSendPacketError extends globalThis.EnumItem {
Name: "DisconnectSendPacketError";
Value: 262;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectSendPacketError: DisconnectSendPacketError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectIllegalTeleport)
*/
export interface DisconnectIllegalTeleport extends globalThis.EnumItem {
Name: "DisconnectIllegalTeleport";
Value: 263;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectIllegalTeleport: DisconnectIllegalTeleport;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectDuplicatePlayer)
*/
export interface DisconnectDuplicatePlayer extends globalThis.EnumItem {
Name: "DisconnectDuplicatePlayer";
Value: 264;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectDuplicatePlayer: DisconnectDuplicatePlayer;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectDuplicateTicket)
*/
export interface DisconnectDuplicateTicket extends globalThis.EnumItem {
Name: "DisconnectDuplicateTicket";
Value: 265;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectDuplicateTicket: DisconnectDuplicateTicket;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectTimeout)
*/
export interface DisconnectTimeout extends globalThis.EnumItem {
Name: "DisconnectTimeout";
Value: 266;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectTimeout: DisconnectTimeout;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectLuaKick)
*/
export interface DisconnectLuaKick extends globalThis.EnumItem {
Name: "DisconnectLuaKick";
Value: 267;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectLuaKick: DisconnectLuaKick;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectOnRemoteSysStats)
*/
export interface DisconnectOnRemoteSysStats extends globalThis.EnumItem {
Name: "DisconnectOnRemoteSysStats";
Value: 268;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectOnRemoteSysStats: DisconnectOnRemoteSysStats;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectHashTimeout)
*/
export interface DisconnectHashTimeout extends globalThis.EnumItem {
Name: "DisconnectHashTimeout";
Value: 269;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectHashTimeout: DisconnectHashTimeout;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCloudEditKick)
*/
export interface DisconnectCloudEditKick extends globalThis.EnumItem {
Name: "DisconnectCloudEditKick";
Value: 270;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectCloudEditKick: DisconnectCloudEditKick;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectPlayerless)
*/
export interface DisconnectPlayerless extends globalThis.EnumItem {
Name: "DisconnectPlayerless";
Value: 271;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectPlayerless: DisconnectPlayerless;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectNewSecurityKeyMismatch)
*/
export interface DisconnectNewSecurityKeyMismatch extends globalThis.EnumItem {
Name: "DisconnectNewSecurityKeyMismatch";
Value: 272;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectNewSecurityKeyMismatch: DisconnectNewSecurityKeyMismatch;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectEvicted)
*/
export interface DisconnectEvicted extends globalThis.EnumItem {
Name: "DisconnectEvicted";
Value: 273;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectEvicted: DisconnectEvicted;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectDevMaintenance)
*/
export interface DisconnectDevMaintenance extends globalThis.EnumItem {
Name: "DisconnectDevMaintenance";
Value: 274;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectDevMaintenance: DisconnectDevMaintenance;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRobloxMaintenance)
*/
export interface DisconnectRobloxMaintenance extends globalThis.EnumItem {
Name: "DisconnectRobloxMaintenance";
Value: 275;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectRobloxMaintenance: DisconnectRobloxMaintenance;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRejoin)
*/
export interface DisconnectRejoin extends globalThis.EnumItem {
Name: "DisconnectRejoin";
Value: 276;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectRejoin: DisconnectRejoin;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectConnectionLost)
*/
export interface DisconnectConnectionLost extends globalThis.EnumItem {
Name: "DisconnectConnectionLost";
Value: 277;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectConnectionLost: DisconnectConnectionLost;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectIdle)
*/
export interface DisconnectIdle extends globalThis.EnumItem {
Name: "DisconnectIdle";
Value: 278;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectIdle: DisconnectIdle;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRaknetErrors)
*/
export interface DisconnectRaknetErrors extends globalThis.EnumItem {
Name: "DisconnectRaknetErrors";
Value: 279;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectRaknetErrors: DisconnectRaknetErrors;
/**
* @deprecated renamed to DisconnectRaknetErrors
*/
export const DisconnectNoResponse: DisconnectRaknetErrors;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectWrongVersion)
*/
export interface DisconnectWrongVersion extends globalThis.EnumItem {
Name: "DisconnectWrongVersion";
Value: 280;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectWrongVersion: DisconnectWrongVersion;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectBySecurityPolicy)
*/
export interface DisconnectBySecurityPolicy extends globalThis.EnumItem {
Name: "DisconnectBySecurityPolicy";
Value: 281;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectBySecurityPolicy: DisconnectBySecurityPolicy;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectBlockedIP)
*/
export interface DisconnectBlockedIP extends globalThis.EnumItem {
Name: "DisconnectBlockedIP";
Value: 282;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectBlockedIP: DisconnectBlockedIP;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectClientFailure)
*/
export interface DisconnectClientFailure extends globalThis.EnumItem {
Name: "DisconnectClientFailure";
Value: 284;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectClientFailure: DisconnectClientFailure;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectClientRequest)
*/
export interface DisconnectClientRequest extends globalThis.EnumItem {
Name: "DisconnectClientRequest";
Value: 285;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectClientRequest: DisconnectClientRequest;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectPrivateServerKickout)
*/
export interface DisconnectPrivateServerKickout extends globalThis.EnumItem {
Name: "DisconnectPrivateServerKickout";
Value: 286;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectPrivateServerKickout: DisconnectPrivateServerKickout;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectModeratedGame)
*/
export interface DisconnectModeratedGame extends globalThis.EnumItem {
Name: "DisconnectModeratedGame";
Value: 287;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectModeratedGame: DisconnectModeratedGame;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ServerShutdown)
*/
export interface ServerShutdown extends globalThis.EnumItem {
Name: "ServerShutdown";
Value: 288;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const ServerShutdown: ServerShutdown;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ReplicatorTimeout)
*/
export interface ReplicatorTimeout extends globalThis.EnumItem {
Name: "ReplicatorTimeout";
Value: 290;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const ReplicatorTimeout: ReplicatorTimeout;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlayerRemoved)
*/
export interface PlayerRemoved extends globalThis.EnumItem {
Name: "PlayerRemoved";
Value: 291;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlayerRemoved: PlayerRemoved;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectOutOfMemoryKeepPlayingLeave)
*/
export interface DisconnectOutOfMemoryKeepPlayingLeave extends globalThis.EnumItem {
Name: "DisconnectOutOfMemoryKeepPlayingLeave";
Value: 292;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectOutOfMemoryKeepPlayingLeave: DisconnectOutOfMemoryKeepPlayingLeave;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRomarkEndOfTest)
*/
export interface DisconnectRomarkEndOfTest extends globalThis.EnumItem {
Name: "DisconnectRomarkEndOfTest";
Value: 293;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectRomarkEndOfTest: DisconnectRomarkEndOfTest;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCollaboratorPermissionRevoked)
*/
export interface DisconnectCollaboratorPermissionRevoked extends globalThis.EnumItem {
Name: "DisconnectCollaboratorPermissionRevoked";
Value: 294;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectCollaboratorPermissionRevoked: DisconnectCollaboratorPermissionRevoked;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCollaboratorUnderage)
*/
export interface DisconnectCollaboratorUnderage extends globalThis.EnumItem {
Name: "DisconnectCollaboratorUnderage";
Value: 295;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectCollaboratorUnderage: DisconnectCollaboratorUnderage;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NetworkInternal)
*/
export interface NetworkInternal extends globalThis.EnumItem {
Name: "NetworkInternal";
Value: 296;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const NetworkInternal: NetworkInternal;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NetworkSend)
*/
export interface NetworkSend extends globalThis.EnumItem {
Name: "NetworkSend";
Value: 297;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const NetworkSend: NetworkSend;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NetworkTimeout)
*/
export interface NetworkTimeout extends globalThis.EnumItem {
Name: "NetworkTimeout";
Value: 298;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const NetworkTimeout: NetworkTimeout;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NetworkMisbehavior)
*/
export interface NetworkMisbehavior extends globalThis.EnumItem {
Name: "NetworkMisbehavior";
Value: 299;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const NetworkMisbehavior: NetworkMisbehavior;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NetworkSecurity)
*/
export interface NetworkSecurity extends globalThis.EnumItem {
Name: "NetworkSecurity";
Value: 300;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const NetworkSecurity: NetworkSecurity;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ReplacementReady)
*/
export interface ReplacementReady extends globalThis.EnumItem {
Name: "ReplacementReady";
Value: 301;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const ReplacementReady: ReplacementReady;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ServerEmpty)
*/
export interface ServerEmpty extends globalThis.EnumItem {
Name: "ServerEmpty";
Value: 302;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const ServerEmpty: ServerEmpty;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PhantomFreeze)
*/
export interface PhantomFreeze extends globalThis.EnumItem {
Name: "PhantomFreeze";
Value: 303;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PhantomFreeze: PhantomFreeze;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#AndroidAnticheatKick)
*/
export interface AndroidAnticheatKick extends globalThis.EnumItem {
Name: "AndroidAnticheatKick";
Value: 304;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const AndroidAnticheatKick: AndroidAnticheatKick;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#AndroidEmulatorKick)
*/
export interface AndroidEmulatorKick extends globalThis.EnumItem {
Name: "AndroidEmulatorKick";
Value: 305;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const AndroidEmulatorKick: AndroidEmulatorKick;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#AndroidRootedKick)
*/
export interface AndroidRootedKick extends globalThis.EnumItem {
Name: "AndroidRootedKick";
Value: 306;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const AndroidRootedKick: AndroidRootedKick;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ScreentimeLockoutKick)
*/
export interface ScreentimeLockoutKick extends globalThis.EnumItem {
Name: "ScreentimeLockoutKick";
Value: 307;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const ScreentimeLockoutKick: ScreentimeLockoutKick;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectionNotification)
*/
export interface DisconnectionNotification extends globalThis.EnumItem {
Name: "DisconnectionNotification";
Value: 308;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectionNotification: DisconnectionNotification;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectVerboselyModeratedGame)
*/
export interface DisconnectVerboselyModeratedGame extends globalThis.EnumItem {
Name: "DisconnectVerboselyModeratedGame";
Value: 309;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectVerboselyModeratedGame: DisconnectVerboselyModeratedGame;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCollaboratorNotAgeVerified)
*/
export interface DisconnectCollaboratorNotAgeVerified extends globalThis.EnumItem {
Name: "DisconnectCollaboratorNotAgeVerified";
Value: 310;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectCollaboratorNotAgeVerified: DisconnectCollaboratorNotAgeVerified;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCollaboratorTrustedConnectionsRequired)
*/
export interface DisconnectCollaboratorTrustedConnectionsRequired extends globalThis.EnumItem {
Name: "DisconnectCollaboratorTrustedConnectionsRequired";
Value: 311;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectCollaboratorTrustedConnectionsRequired: DisconnectCollaboratorTrustedConnectionsRequired;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCollaboratorOwnerActionRequired)
*/
export interface DisconnectCollaboratorOwnerActionRequired extends globalThis.EnumItem {
Name: "DisconnectCollaboratorOwnerActionRequired";
Value: 312;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectCollaboratorOwnerActionRequired: DisconnectCollaboratorOwnerActionRequired;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCollaboratorTooManyCollaborators)
*/
export interface DisconnectCollaboratorTooManyCollaborators extends globalThis.EnumItem {
Name: "DisconnectCollaboratorTooManyCollaborators";
Value: 313;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectCollaboratorTooManyCollaborators: DisconnectCollaboratorTooManyCollaborators;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCollaboratorUnknownError)
*/
export interface DisconnectCollaboratorUnknownError extends globalThis.EnumItem {
Name: "DisconnectCollaboratorUnknownError";
Value: 314;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectCollaboratorUnknownError: DisconnectCollaboratorUnknownError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCollaboratorRequestedEviction)
*/
export interface DisconnectCollaboratorRequestedEviction extends globalThis.EnumItem {
Name: "DisconnectCollaboratorRequestedEviction";
Value: 315;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectCollaboratorRequestedEviction: DisconnectCollaboratorRequestedEviction;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCollaboratorTrustedConnectionsRequiredPC)
*/
export interface DisconnectCollaboratorTrustedConnectionsRequiredPC extends globalThis.EnumItem {
Name: "DisconnectCollaboratorTrustedConnectionsRequiredPC";
Value: 316;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectCollaboratorTrustedConnectionsRequiredPC: DisconnectCollaboratorTrustedConnectionsRequiredPC;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRemoteAttestationUnsupported)
*/
export interface DisconnectRemoteAttestationUnsupported extends globalThis.EnumItem {
Name: "DisconnectRemoteAttestationUnsupported";
Value: 317;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectRemoteAttestationUnsupported: DisconnectRemoteAttestationUnsupported;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRemoteAttestationGeneralFailure)
*/
export interface DisconnectRemoteAttestationGeneralFailure extends globalThis.EnumItem {
Name: "DisconnectRemoteAttestationGeneralFailure";
Value: 318;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectRemoteAttestationGeneralFailure: DisconnectRemoteAttestationGeneralFailure;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRemoteAttestationTimeout)
*/
export interface DisconnectRemoteAttestationTimeout extends globalThis.EnumItem {
Name: "DisconnectRemoteAttestationTimeout";
Value: 319;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectRemoteAttestationTimeout: DisconnectRemoteAttestationTimeout;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRemoteAttestationOSOutOfDate)
*/
export interface DisconnectRemoteAttestationOSOutOfDate extends globalThis.EnumItem {
Name: "DisconnectRemoteAttestationOSOutOfDate";
Value: 320;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectRemoteAttestationOSOutOfDate: DisconnectRemoteAttestationOSOutOfDate;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRemoteAttestationBootValidationFailure)
*/
export interface DisconnectRemoteAttestationBootValidationFailure extends globalThis.EnumItem {
Name: "DisconnectRemoteAttestationBootValidationFailure";
Value: 321;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectRemoteAttestationBootValidationFailure: DisconnectRemoteAttestationBootValidationFailure;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchErrors)
*/
export interface PlacelaunchErrors extends globalThis.EnumItem {
Name: "PlacelaunchErrors";
Value: 512;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchErrors: PlacelaunchErrors;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchDisabled)
*/
export interface PlacelaunchDisabled extends globalThis.EnumItem {
Name: "PlacelaunchDisabled";
Value: 515;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchDisabled: PlacelaunchDisabled;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchError)
*/
export interface PlacelaunchError extends globalThis.EnumItem {
Name: "PlacelaunchError";
Value: 516;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchError: PlacelaunchError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchGameEnded)
*/
export interface PlacelaunchGameEnded extends globalThis.EnumItem {
Name: "PlacelaunchGameEnded";
Value: 517;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchGameEnded: PlacelaunchGameEnded;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchGameFull)
*/
export interface PlacelaunchGameFull extends globalThis.EnumItem {
Name: "PlacelaunchGameFull";
Value: 518;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchGameFull: PlacelaunchGameFull;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchUserLeft)
*/
export interface PlacelaunchUserLeft extends globalThis.EnumItem {
Name: "PlacelaunchUserLeft";
Value: 522;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchUserLeft: PlacelaunchUserLeft;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchRestricted)
*/
export interface PlacelaunchRestricted extends globalThis.EnumItem {
Name: "PlacelaunchRestricted";
Value: 523;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchRestricted: PlacelaunchRestricted;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchUnauthorized)
*/
export interface PlacelaunchUnauthorized extends globalThis.EnumItem {
Name: "PlacelaunchUnauthorized";
Value: 524;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchUnauthorized: PlacelaunchUnauthorized;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchFlooded)
*/
export interface PlacelaunchFlooded extends globalThis.EnumItem {
Name: "PlacelaunchFlooded";
Value: 525;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchFlooded: PlacelaunchFlooded;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchHashExpired)
*/
export interface PlacelaunchHashExpired extends globalThis.EnumItem {
Name: "PlacelaunchHashExpired";
Value: 526;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchHashExpired: PlacelaunchHashExpired;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchHashException)
*/
export interface PlacelaunchHashException extends globalThis.EnumItem {
Name: "PlacelaunchHashException";
Value: 527;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchHashException: PlacelaunchHashException;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchPartyCannotFit)
*/
export interface PlacelaunchPartyCannotFit extends globalThis.EnumItem {
Name: "PlacelaunchPartyCannotFit";
Value: 528;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchPartyCannotFit: PlacelaunchPartyCannotFit;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchHttpError)
*/
export interface PlacelaunchHttpError extends globalThis.EnumItem {
Name: "PlacelaunchHttpError";
Value: 529;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchHttpError: PlacelaunchHttpError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchUserPrivacyUnauthorized)
*/
export interface PlacelaunchUserPrivacyUnauthorized extends globalThis.EnumItem {
Name: "PlacelaunchUserPrivacyUnauthorized";
Value: 533;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchUserPrivacyUnauthorized: PlacelaunchUserPrivacyUnauthorized;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchVipOwnerNotPresent)
*/
export interface PlacelaunchVipOwnerNotPresent extends globalThis.EnumItem {
Name: "PlacelaunchVipOwnerNotPresent";
Value: 541;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchVipOwnerNotPresent: PlacelaunchVipOwnerNotPresent;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchAgeVerificationRequired)
*/
export interface PlacelaunchAgeVerificationRequired extends globalThis.EnumItem {
Name: "PlacelaunchAgeVerificationRequired";
Value: 542;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchAgeVerificationRequired: PlacelaunchAgeVerificationRequired;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchParentalApprovalRequired)
*/
export interface PlacelaunchParentalApprovalRequired extends globalThis.EnumItem {
Name: "PlacelaunchParentalApprovalRequired";
Value: 543;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchParentalApprovalRequired: PlacelaunchParentalApprovalRequired;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchCoreGated)
*/
export interface PlacelaunchCoreGated extends globalThis.EnumItem {
Name: "PlacelaunchCoreGated";
Value: 544;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchCoreGated: PlacelaunchCoreGated;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchCollaborationCoreGated)
*/
export interface PlacelaunchCollaborationCoreGated extends globalThis.EnumItem {
Name: "PlacelaunchCollaborationCoreGated";
Value: 545;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchCollaborationCoreGated: PlacelaunchCollaborationCoreGated;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchCreatorBan)
*/
export interface PlacelaunchCreatorBan extends globalThis.EnumItem {
Name: "PlacelaunchCreatorBan";
Value: 600;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchCreatorBan: PlacelaunchCreatorBan;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchDeviceBlock)
*/
export interface PlacelaunchDeviceBlock extends globalThis.EnumItem {
Name: "PlacelaunchDeviceBlock";
Value: 601;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchDeviceBlock: PlacelaunchDeviceBlock;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchCustomMessage)
*/
export interface PlacelaunchCustomMessage extends globalThis.EnumItem {
Name: "PlacelaunchCustomMessage";
Value: 610;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchCustomMessage: PlacelaunchCustomMessage;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchOtherError)
*/
export interface PlacelaunchOtherError extends globalThis.EnumItem {
Name: "PlacelaunchOtherError";
Value: 611;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const PlacelaunchOtherError: PlacelaunchOtherError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportErrors)
*/
export interface TeleportErrors extends globalThis.EnumItem {
Name: "TeleportErrors";
Value: 768;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const TeleportErrors: TeleportErrors;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportFailure)
*/
export interface TeleportFailure extends globalThis.EnumItem {
Name: "TeleportFailure";
Value: 769;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const TeleportFailure: TeleportFailure;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportGameNotFound)
*/
export interface TeleportGameNotFound extends globalThis.EnumItem {
Name: "TeleportGameNotFound";
Value: 770;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const TeleportGameNotFound: TeleportGameNotFound;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportGameEnded)
*/
export interface TeleportGameEnded extends globalThis.EnumItem {
Name: "TeleportGameEnded";
Value: 771;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const TeleportGameEnded: TeleportGameEnded;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportGameFull)
*/
export interface TeleportGameFull extends globalThis.EnumItem {
Name: "TeleportGameFull";
Value: 772;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const TeleportGameFull: TeleportGameFull;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportUnauthorized)
*/
export interface TeleportUnauthorized extends globalThis.EnumItem {
Name: "TeleportUnauthorized";
Value: 773;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const TeleportUnauthorized: TeleportUnauthorized;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportFlooded)
*/
export interface TeleportFlooded extends globalThis.EnumItem {
Name: "TeleportFlooded";
Value: 774;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const TeleportFlooded: TeleportFlooded;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportIsTeleporting)
*/
export interface TeleportIsTeleporting extends globalThis.EnumItem {
Name: "TeleportIsTeleporting";
Value: 775;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const TeleportIsTeleporting: TeleportIsTeleporting;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TransportErrors)
*/
export interface TransportErrors extends globalThis.EnumItem {
Name: "TransportErrors";
Value: 1024;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const TransportErrors: TransportErrors;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectTransportIoError)
*/
export interface DisconnectTransportIoError extends globalThis.EnumItem {
Name: "DisconnectTransportIoError";
Value: 1025;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectTransportIoError: DisconnectTransportIoError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectTransportIoInternetError)
*/
export interface DisconnectTransportIoInternetError extends globalThis.EnumItem {
Name: "DisconnectTransportIoInternetError";
Value: 1026;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectTransportIoInternetError: DisconnectTransportIoInternetError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectTransportProtocolError)
*/
export interface DisconnectTransportProtocolError extends globalThis.EnumItem {
Name: "DisconnectTransportProtocolError";
Value: 1027;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectTransportProtocolError: DisconnectTransportProtocolError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectTransportNgtcp2Error)
*/
export interface DisconnectTransportNgtcp2Error extends globalThis.EnumItem {
Name: "DisconnectTransportNgtcp2Error";
Value: 1028;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectTransportNgtcp2Error: DisconnectTransportNgtcp2Error;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectTransportQuicError)
*/
export interface DisconnectTransportQuicError extends globalThis.EnumItem {
Name: "DisconnectTransportQuicError";
Value: 1029;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectTransportQuicError: DisconnectTransportQuicError;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectTransportRnaError)
*/
export interface DisconnectTransportRnaError extends globalThis.EnumItem {
Name: "DisconnectTransportRnaError";
Value: 1030;
EnumType: typeof globalThis.Enum.ConnectionError;
}
export const DisconnectTransportRnaError: DisconnectTransportRnaError;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ConnectionError | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ConnectionError | undefined;
}
export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.ConnectErrors | ConnectionError.AlreadyConnected | ConnectionError.NoFreeIncomingConnections | ConnectionError.ConnectionBanned | ConnectionError.InvalidPassword | ConnectionError.IncompatibleProtocolVersion | ConnectionError.IPRecentlyConnected | ConnectionError.OurSystemRequiresSecurity | ConnectionError.SecurityKeyMismatch | 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.AndroidAnticheatKick | ConnectionError.AndroidEmulatorKick | ConnectionError.AndroidRootedKick | ConnectionError.ScreentimeLockoutKick | ConnectionError.DisconnectionNotification | ConnectionError.DisconnectVerboselyModeratedGame | ConnectionError.DisconnectCollaboratorNotAgeVerified | ConnectionError.DisconnectCollaboratorTrustedConnectionsRequired | ConnectionError.DisconnectCollaboratorOwnerActionRequired | ConnectionError.DisconnectCollaboratorTooManyCollaborators | ConnectionError.DisconnectCollaboratorUnknownError | ConnectionError.DisconnectCollaboratorRequestedEviction | ConnectionError.DisconnectCollaboratorTrustedConnectionsRequiredPC | ConnectionError.DisconnectRemoteAttestationUnsupported | ConnectionError.DisconnectRemoteAttestationGeneralFailure | ConnectionError.DisconnectRemoteAttestationTimeout | ConnectionError.DisconnectRemoteAttestationOSOutOfDate | ConnectionError.DisconnectRemoteAttestationBootValidationFailure | 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.PlacelaunchVipOwnerNotPresent | ConnectionError.PlacelaunchAgeVerificationRequired | ConnectionError.PlacelaunchParentalApprovalRequired | ConnectionError.PlacelaunchCoreGated | ConnectionError.PlacelaunchCollaborationCoreGated | ConnectionError.PlacelaunchCreatorBan | ConnectionError.PlacelaunchDeviceBlock | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting | ConnectionError.TransportErrors | ConnectionError.DisconnectTransportIoError | ConnectionError.DisconnectTransportIoInternetError | ConnectionError.DisconnectTransportProtocolError | ConnectionError.DisconnectTransportNgtcp2Error | ConnectionError.DisconnectTransportQuicError | ConnectionError.DisconnectTransportRnaError;
/**
* Used to determine the connection state of the client to the game server.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionState)
*/
export namespace ConnectionState {
/**
* The client is connected.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionState#Connected)
*/
export interface Connected extends globalThis.EnumItem {
Name: "Connected";
Value: 0;
EnumType: typeof globalThis.Enum.ConnectionState;
}
export const Connected: Connected;
/**
* The client is disconnected.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionState#Disconnected)
*/
export interface Disconnected extends globalThis.EnumItem {
Name: "Disconnected";
Value: 1;
EnumType: typeof globalThis.Enum.ConnectionState;
}
export const Disconnected: Disconnected;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ConnectionState | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ConnectionState | undefined;
}
export type ConnectionState = ConnectionState.Connected | ConnectionState.Disconnected;
/**
* The source type of a `Content` value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContentSourceType)
*/
export namespace ContentSourceType {
/**
* Empty value with no source type. Does not reference any content or hold any non‑`nil` value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContentSourceType#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.ContentSourceType;
}
export const None: None;
/**
* An [asset URI](../../../projects/assets/index.md#asset-uris) `string` value contained in `Content.Uri`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContentSourceType#Uri)
*/
export interface Uri extends globalThis.EnumItem {
Name: "Uri";
Value: 1;
EnumType: typeof globalThis.Enum.ContentSourceType;
}
export const Uri: Uri;
/**
* A non-`nil` `Object` reference contained in `Content.Object`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContentSourceType#Object)
*/
export interface Object extends globalThis.EnumItem {
Name: "Object";
Value: 2;
EnumType: typeof globalThis.Enum.ContentSourceType;
}
export const Object: Object;
/**
* A non-`nil` `Opaque` reference contained in `Content.Opaque`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContentSourceType#Opaque)
*/
export interface Opaque extends globalThis.EnumItem {
Name: "Opaque";
Value: 3;
EnumType: typeof globalThis.Enum.ContentSourceType;
}
export const Opaque: Opaque;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ContentSourceType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ContentSourceType | undefined;
}
export type ContentSourceType = ContentSourceType.None | ContentSourceType.Uri | ContentSourceType.Object | ContentSourceType.Opaque;
/**
* Describes the priority of a context action.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContextActionPriority)
*/
export namespace ContextActionPriority {
/**
* The lowest named priority level (value 1000); an action at this level is invoked after `High` and `Medium` actions bound to the same input.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContextActionPriority#Low)
*/
export interface Low extends globalThis.EnumItem {
Name: "Low";
Value: 1000;
EnumType: typeof globalThis.Enum.ContextActionPriority;
}
export const Low: Low;
/**
* The default priority level (value 2000); used automatically by `ContextActionService:BindAction()` and falls between `High` and `Low` in processing order.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContextActionPriority#Medium)
*/
export interface Medium extends globalThis.EnumItem {
Name: "Medium";
Value: 2000;
EnumType: typeof globalThis.Enum.ContextActionPriority;
}
export const Medium: Medium;
/**
* @deprecated renamed to Medium
*/
export const Default: Medium;
/**
* The highest named priority level (value 3000); an action at this level is invoked before `Medium` and `Low` actions bound to the same input.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContextActionPriority#High)
*/
export interface High extends globalThis.EnumItem {
Name: "High";
Value: 3000;
EnumType: typeof globalThis.Enum.ContextActionPriority;
}
export const High: High;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ContextActionPriority | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ContextActionPriority | undefined;
}
export type ContextActionPriority = ContextActionPriority.Low | ContextActionPriority.Medium | ContextActionPriority.High;
/**
* Describes whether a contextual action should sink or pass input events.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContextActionResult)
*/
export namespace ContextActionResult {
/**
* If `functionToBind` from `ContextActionService:BindAction()` returns `ContextActionResult.Sink`, the input event will stop at that function and no other bound actions under it will be processed. This is the default behavior if `functionToBind` does not return anything or yields in any way.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContextActionResult#Sink)
*/
export interface Sink extends globalThis.EnumItem {
Name: "Sink";
Value: 0;
EnumType: typeof globalThis.Enum.ContextActionResult;
}
export const Sink: Sink;
/**
* If `functionToBind` from `ContextActionService:BindAction()` returns `ContextActionResult.Pass`, the input event is considered to have not been handled by `functionToBind` and will continue being passed to actions bound to the same input type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ContextActionResult#Pass)
*/
export interface Pass extends globalThis.EnumItem {
Name: "Pass";
Value: 1;
EnumType: typeof globalThis.Enum.ContextActionResult;
}
export const Pass: Pass;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ContextActionResult | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ContextActionResult | undefined;
}
export type ContextActionResult = ContextActionResult.Sink | ContextActionResult.Pass;
/**
* The ControlMode Enum sets how the player is controlled.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ControlMode)
*/
export namespace ControlMode {
/**
* Allows the camera to be moved by clicking and dragging with the right mouse button.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ControlMode#Classic)
*/
export interface Classic extends globalThis.EnumItem {
Name: "Classic";
Value: 0;
EnumType: typeof globalThis.Enum.ControlMode;
}
export const Classic: Classic;
/**
* Similar to classic, but allows the player to toggle mouse locking, causing the camera to rotate as the player moves the mouse (without holding down a button).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ControlMode#MouseLockSwitch)
*/
export interface MouseLockSwitch extends globalThis.EnumItem {
Name: "MouseLockSwitch";
Value: 1;
EnumType: typeof globalThis.Enum.ControlMode;
}
export const MouseLockSwitch: MouseLockSwitch;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ControlMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ControlMode | undefined;
}
export type ControlMode = ControlMode.Classic | ControlMode.MouseLockSwitch;
/**
* Represents all available `CoreGui` "types" such as the `Backpack` and text chat window.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType)
*/
export namespace CoreGuiType {
/**
* Dynamically updated `Players` list, commonly used as a [leaderboard](../../../players/leaderboards.md).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#PlayerList)
*/
export interface PlayerList extends globalThis.EnumItem {
Name: "PlayerList";
Value: 0;
EnumType: typeof globalThis.Enum.CoreGuiType;
}
export const PlayerList: PlayerList;
/**
* The character's `Health` bar.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#Health)
*/
export interface Health extends globalThis.EnumItem {
Name: "Health";
Value: 1;
EnumType: typeof globalThis.Enum.CoreGuiType;
}
export const Health: Health;
/**
* The character's `Backpack` which contains [in‑experience tools](../../../players/tools.md).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#Backpack)
*/
export interface Backpack extends globalThis.EnumItem {
Name: "Backpack";
Value: 2;
EnumType: typeof globalThis.Enum.CoreGuiType;
}
export const Backpack: Backpack;
/**
* The [text chat](../../../chat/in-experience-text-chat.md) window.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#Chat)
*/
export interface Chat extends globalThis.EnumItem {
Name: "Chat";
Value: 3;
EnumType: typeof globalThis.Enum.CoreGuiType;
}
export const Chat: Chat;
/**
* Refers to all available core UI.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#All)
*/
export interface All extends globalThis.EnumItem {
Name: "All";
Value: 4;
EnumType: typeof globalThis.Enum.CoreGuiType;
}
export const All: All;
/**
* Popup menu of character [emotes](../../../characters/emotes.md).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#EmotesMenu)
*/
export interface EmotesMenu extends globalThis.EnumItem {
Name: "EmotesMenu";
Value: 5;
EnumType: typeof globalThis.Enum.CoreGuiType;
}
export const EmotesMenu: EmotesMenu;
/**
* A player's perspective or view of their own character.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#SelfView)
*/
export interface SelfView extends globalThis.EnumItem {
Name: "SelfView";
Value: 6;
EnumType: typeof globalThis.Enum.CoreGuiType;
}
export const SelfView: SelfView;
/**
* A "capture" button along the right side of the screen.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#Captures)
*/
export interface Captures extends globalThis.EnumItem {
Name: "Captures";
Value: 7;
EnumType: typeof globalThis.Enum.CoreGuiType;
}
export const Captures: Captures;
/**
* The **Avatar Switcher** allows users to change their platform avatar.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#AvatarSwitcher)
*/
export interface AvatarSwitcher extends globalThis.EnumItem {
Name: "AvatarSwitcher";
Value: 8;
EnumType: typeof globalThis.Enum.CoreGuiType;
}
export const AvatarSwitcher: AvatarSwitcher;
/**
* The in-experience shop overlay that lets players browse and purchase items without leaving the experience.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#ExperienceShop)
*/
export interface ExperienceShop extends globalThis.EnumItem {
Name: "ExperienceShop";
Value: 9;
EnumType: typeof globalThis.Enum.CoreGuiType;
}
export const ExperienceShop: ExperienceShop;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CoreGuiType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CoreGuiType | undefined;
}
export type CoreGuiType = CoreGuiType.PlayerList | CoreGuiType.Health | CoreGuiType.Backpack | CoreGuiType.Chat | CoreGuiType.All | CoreGuiType.EmotesMenu | CoreGuiType.SelfView | CoreGuiType.Captures | CoreGuiType.AvatarSwitcher | CoreGuiType.ExperienceShop;
/**
* Indicates the outcome of a call to `AssetService:CreateAssetAsync()` or `AssetService:CreateAssetVersionAsync()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateAssetResult)
*/
export namespace CreateAssetResult {
/**
* The asset was created or updated successfully.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateAssetResult#Success)
*/
export interface Success extends globalThis.EnumItem {
Name: "Success";
Value: 1;
EnumType: typeof globalThis.Enum.CreateAssetResult;
}
export const Success: Success;
/**
* The caller does not have permission to create or update an asset in the target inventory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateAssetResult#PermissionDenied)
*/
export interface PermissionDenied extends globalThis.EnumItem {
Name: "PermissionDenied";
Value: 2;
EnumType: typeof globalThis.Enum.CreateAssetResult;
}
export const PermissionDenied: PermissionDenied;
/**
* The upload request to the Roblox asset service failed for a reason other than a permission error.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateAssetResult#UploadFailed)
*/
export interface UploadFailed extends globalThis.EnumItem {
Name: "UploadFailed";
Value: 3;
EnumType: typeof globalThis.Enum.CreateAssetResult;
}
export const UploadFailed: UploadFailed;
/**
* An unexpected error occurred and the operation could not complete.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateAssetResult#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 4;
EnumType: typeof globalThis.Enum.CreateAssetResult;
}
export const Unknown: Unknown;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CreateAssetResult | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CreateAssetResult | undefined;
}
export type CreateAssetResult = CreateAssetResult.Success | CreateAssetResult.PermissionDenied | CreateAssetResult.UploadFailed | CreateAssetResult.Unknown;
/**
* Indicates the result of a `AssetService:CreateDataModelContentAsync()` call.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateContentResult)
*/
export namespace CreateContentResult {
/**
* The content object was created and stored successfully.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateContentResult#Success)
*/
export interface Success extends globalThis.EnumItem {
Name: "Success";
Value: 1;
EnumType: typeof globalThis.Enum.CreateContentResult;
}
export const Success: Success;
/**
* The user does not have the required permissions to perform this operation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateContentResult#PermissionDenied)
*/
export interface PermissionDenied extends globalThis.EnumItem {
Name: "PermissionDenied";
Value: 2;
EnumType: typeof globalThis.Enum.CreateContentResult;
}
export const PermissionDenied: PermissionDenied;
/**
* Asset failed to upload.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateContentResult#UploadFailed)
*/
export interface UploadFailed extends globalThis.EnumItem {
Name: "UploadFailed";
Value: 3;
EnumType: typeof globalThis.Enum.CreateContentResult;
}
export const UploadFailed: UploadFailed;
/**
* The storage budget limit for `DataModel`-scoped content was exceeded.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateContentResult#StorageLimitExceeded)
*/
export interface StorageLimitExceeded extends globalThis.EnumItem {
Name: "StorageLimitExceeded";
Value: 4;
EnumType: typeof globalThis.Enum.CreateContentResult;
}
export const StorageLimitExceeded: StorageLimitExceeded;
/**
* An unknown error occurred.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateContentResult#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 5;
EnumType: typeof globalThis.Enum.CreateContentResult;
}
export const Unknown: Unknown;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CreateContentResult | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CreateContentResult | undefined;
}
export type CreateContentResult = CreateContentResult.Success | CreateContentResult.PermissionDenied | CreateContentResult.UploadFailed | CreateContentResult.StorageLimitExceeded | CreateContentResult.Unknown;
/**
* Indicates why a `AvatarEditorService:PromptCreateOutfit()` call failed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateOutfitFailure)
*/
export namespace CreateOutfitFailure {
/**
* The outfit name provided by the player was rejected as invalid.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateOutfitFailure#InvalidName)
*/
export interface InvalidName extends globalThis.EnumItem {
Name: "InvalidName";
Value: 1;
EnumType: typeof globalThis.Enum.CreateOutfitFailure;
}
export const InvalidName: InvalidName;
/**
* The player has reached the maximum number of saved outfits.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateOutfitFailure#OutfitLimitReached)
*/
export interface OutfitLimitReached extends globalThis.EnumItem {
Name: "OutfitLimitReached";
Value: 2;
EnumType: typeof globalThis.Enum.CreateOutfitFailure;
}
export const OutfitLimitReached: OutfitLimitReached;
/**
* The outfit creation failed for an unspecified or unrecognized reason.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreateOutfitFailure#Other)
*/
export interface Other extends globalThis.EnumItem {
Name: "Other";
Value: 3;
EnumType: typeof globalThis.Enum.CreateOutfitFailure;
}
export const Other: Other;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CreateOutfitFailure | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CreateOutfitFailure | undefined;
}
export type CreateOutfitFailure = CreateOutfitFailure.InvalidName | CreateOutfitFailure.OutfitLimitReached | CreateOutfitFailure.Other;
/**
* Indicates whether the currently running place is owned by an individual user or a group.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreatorType)
*/
export namespace CreatorType {
/**
* The place is owned by a single user.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreatorType#User)
*/
export interface User extends globalThis.EnumItem {
Name: "User";
Value: 0;
EnumType: typeof globalThis.Enum.CreatorType;
}
export const User: User;
/**
* The place is owned by a group.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreatorType#Group)
*/
export interface Group extends globalThis.EnumItem {
Name: "Group";
Value: 1;
EnumType: typeof globalThis.Enum.CreatorType;
}
export const Group: Group;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CreatorType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CreatorType | undefined;
}
export type CreatorType = CreatorType.User | CreatorType.Group;
/**
* Specifies which creator type to include when filtering catalog search results in `CatalogSearchParams`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreatorTypeFilter)
*/
export namespace CreatorTypeFilter {
/**
* Limits catalog search results to items created by individual users.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreatorTypeFilter#User)
*/
export interface User extends globalThis.EnumItem {
Name: "User";
Value: 0;
EnumType: typeof globalThis.Enum.CreatorTypeFilter;
}
export const User: User;
/**
* Limits catalog search results to items created by groups.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreatorTypeFilter#Group)
*/
export interface Group extends globalThis.EnumItem {
Name: "Group";
Value: 1;
EnumType: typeof globalThis.Enum.CreatorTypeFilter;
}
export const Group: Group;
/**
* Includes items from all creator types; no filtering by creator is applied.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CreatorTypeFilter#All)
*/
export interface All extends globalThis.EnumItem {
Name: "All";
Value: 2;
EnumType: typeof globalThis.Enum.CreatorTypeFilter;
}
export const All: All;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CreatorTypeFilter | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CreatorTypeFilter | undefined;
}
export type CreatorTypeFilter = CreatorTypeFilter.User | CreatorTypeFilter.Group | CreatorTypeFilter.All;
/**
* The CurrencyType Enum is used with `MarketplaceService` to set the currency used.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CurrencyType)
*/
export namespace CurrencyType {
/**
* Use the default currency (Robux), equivalent to not specifying a currency.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CurrencyType#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.CurrencyType;
}
export const Default: Default;
/**
* Use Robux.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CurrencyType#Robux)
*/
export interface Robux extends globalThis.EnumItem {
Name: "Robux";
Value: 1;
EnumType: typeof globalThis.Enum.CurrencyType;
}
export const Robux: Robux;
/**
* Use Tickets.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CurrencyType#Tix)
*/
export interface Tix extends globalThis.EnumItem {
Name: "Tix";
Value: 2;
EnumType: typeof globalThis.Enum.CurrencyType;
}
export const Tix: Tix;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CurrencyType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CurrencyType | undefined;
}
export type CurrencyType = CurrencyType.Default | CurrencyType.Robux | CurrencyType.Tix;
/**
* Changes the player's camera mode.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CustomCameraMode)
*/
export namespace CustomCameraMode {
/**
* The default camera mode is classic.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CustomCameraMode#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.CustomCameraMode;
}
export const Default: Default;
/**
* Camera tracks the player but will not automatically rotate if the player walks left or right.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CustomCameraMode#Classic)
*/
export interface Classic extends globalThis.EnumItem {
Name: "Classic";
Value: 1;
EnumType: typeof globalThis.Enum.CustomCameraMode;
}
export const Classic: Classic;
/**
* Camera tracks the player and automatically rotates if the player walks left or right.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CustomCameraMode#Follow)
*/
export interface Follow extends globalThis.EnumItem {
Name: "Follow";
Value: 2;
EnumType: typeof globalThis.Enum.CustomCameraMode;
}
export const Follow: Follow;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CustomCameraMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CustomCameraMode | undefined;
}
export type CustomCameraMode = CustomCameraMode.Default | CustomCameraMode.Classic | CustomCameraMode.Follow;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataModelChangeType)
*/
export namespace DataModelChangeType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataModelChangeType#Add)
*/
export interface Add extends globalThis.EnumItem {
Name: "Add";
Value: 0;
EnumType: typeof globalThis.Enum.DataModelChangeType;
}
export const Add: Add;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataModelChangeType#Remove)
*/
export interface Remove extends globalThis.EnumItem {
Name: "Remove";
Value: 1;
EnumType: typeof globalThis.Enum.DataModelChangeType;
}
export const Remove: Remove;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataModelChangeType#Modify)
*/
export interface Modify extends globalThis.EnumItem {
Name: "Modify";
Value: 2;
EnumType: typeof globalThis.Enum.DataModelChangeType;
}
export const Modify: Modify;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataModelChangeType#AddPackage)
*/
export interface AddPackage extends globalThis.EnumItem {
Name: "AddPackage";
Value: 3;
EnumType: typeof globalThis.Enum.DataModelChangeType;
}
export const AddPackage: AddPackage;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DataModelChangeType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DataModelChangeType | undefined;
}
export type DataModelChangeType = DataModelChangeType.Add | DataModelChangeType.Remove | DataModelChangeType.Modify | DataModelChangeType.AddPackage;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataModelExtractorFileType)
*/
export namespace DataModelExtractorFileType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataModelExtractorFileType#PlaceFile)
*/
export interface PlaceFile extends globalThis.EnumItem {
Name: "PlaceFile";
Value: 0;
EnumType: typeof globalThis.Enum.DataModelExtractorFileType;
}
export const PlaceFile: PlaceFile;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataModelExtractorFileType#FirstSlice)
*/
export interface FirstSlice extends globalThis.EnumItem {
Name: "FirstSlice";
Value: 1;
EnumType: typeof globalThis.Enum.DataModelExtractorFileType;
}
export const FirstSlice: FirstSlice;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataModelExtractorFileType#NonFirstSlice)
*/
export interface NonFirstSlice extends globalThis.EnumItem {
Name: "NonFirstSlice";
Value: 2;
EnumType: typeof globalThis.Enum.DataModelExtractorFileType;
}
export const NonFirstSlice: NonFirstSlice;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DataModelExtractorFileType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DataModelExtractorFileType | undefined;
}
export type DataModelExtractorFileType = DataModelExtractorFileType.PlaceFile | DataModelExtractorFileType.FirstSlice | DataModelExtractorFileType.NonFirstSlice;
/**
* Indicates the type of data store request being made.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType)
*/
export namespace DataStoreRequestType {
/**
* Refers to `GetAsync()` and the read of `UpdateAsync()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#GetAsync)
*/
export interface GetAsync extends globalThis.EnumItem {
Name: "GetAsync";
Value: 0;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const GetAsync: GetAsync;
/**
* Refers to `SetAsync()`, `IncrementAsync()`, `RemoveAsync()`, and the write of `UpdateAsync()` when it returns a non-`nil` value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#SetIncrementAsync)
*/
export interface SetIncrementAsync extends globalThis.EnumItem {
Name: "SetIncrementAsync";
Value: 1;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const SetIncrementAsync: SetIncrementAsync;
/**
* Refers to `UpdateAsync()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#UpdateAsync)
*/
export interface UpdateAsync extends globalThis.EnumItem {
Name: "UpdateAsync";
Value: 2;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const UpdateAsync: UpdateAsync;
/**
* Refers to `GetSortedAsync()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#GetSortedAsync)
*/
export interface GetSortedAsync extends globalThis.EnumItem {
Name: "GetSortedAsync";
Value: 3;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const GetSortedAsync: GetSortedAsync;
/**
* Refers to `SetAsync()` `IncrementAsync()`, `RemoveAsync()`, and the write of `UpdateAsync()` while using an `OrderedDataStore`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#SetIncrementSortedAsync)
*/
export interface SetIncrementSortedAsync extends globalThis.EnumItem {
Name: "SetIncrementSortedAsync";
Value: 4;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const SetIncrementSortedAsync: SetIncrementSortedAsync;
/**
* Refers to `OnUpdate()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#OnUpdate)
*/
export interface OnUpdate extends globalThis.EnumItem {
Name: "OnUpdate";
Value: 5;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const OnUpdate: OnUpdate;
/**
* Refers to `ListKeysAsync()` and `ListVersionsAsync()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#ListAsync)
*/
export interface ListAsync extends globalThis.EnumItem {
Name: "ListAsync";
Value: 6;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const ListAsync: ListAsync;
/**
* Refers to `GetVersionAsync()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#GetVersionAsync)
*/
export interface GetVersionAsync extends globalThis.EnumItem {
Name: "GetVersionAsync";
Value: 7;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const GetVersionAsync: GetVersionAsync;
/**
* Refers to `RemoveVersionAsync()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#RemoveVersionAsync)
*/
export interface RemoveVersionAsync extends globalThis.EnumItem {
Name: "RemoveVersionAsync";
Value: 8;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const RemoveVersionAsync: RemoveVersionAsync;
/**
* Refers to `GetAsync()`, `GetVersionAsync()`, `GetVersionAtTimeAsync()`, and the read of `UpdateAsync()` for `DataStore`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#StandardRead)
*/
export interface StandardRead extends globalThis.EnumItem {
Name: "StandardRead";
Value: 9;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const StandardRead: StandardRead;
/**
* Refers to `SetAsync()`, `IncrementAsync()`, and the write of `UpdateAsync()` for `DataStore`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#StandardWrite)
*/
export interface StandardWrite extends globalThis.EnumItem {
Name: "StandardWrite";
Value: 10;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const StandardWrite: StandardWrite;
/**
* Refers to `ListDataStoresAsync()`, and `ListKeysAsync()` and `ListVersionsAsync()` for `DataStore`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#StandardList)
*/
export interface StandardList extends globalThis.EnumItem {
Name: "StandardList";
Value: 11;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const StandardList: StandardList;
/**
* Refers to `RemoveAsync()` for `DataStore`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#StandardRemove)
*/
export interface StandardRemove extends globalThis.EnumItem {
Name: "StandardRemove";
Value: 12;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const StandardRemove: StandardRemove;
/**
* Refers to `GetAsync()` and the read of `UpdateAsync()` for `OrderedDataStore`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#OrderedRead)
*/
export interface OrderedRead extends globalThis.EnumItem {
Name: "OrderedRead";
Value: 13;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const OrderedRead: OrderedRead;
/**
* Refers to `SetAsync()`, `IncrementAsync()`, and the write of `UpdateAsync()` for `OrderedDataStore`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#OrderedWrite)
*/
export interface OrderedWrite extends globalThis.EnumItem {
Name: "OrderedWrite";
Value: 14;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const OrderedWrite: OrderedWrite;
/**
* Refers to `GetSortedAsync()` for `OrderedDataStore`. GetRequestBudgetForRequestType()`with this enum will return`0`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#OrderedList)
*/
export interface OrderedList extends globalThis.EnumItem {
Name: "OrderedList";
Value: 15;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const OrderedList: OrderedList;
/**
* Refers to `RemoveAsync()` for `OrderedDataStore`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#OrderedRemove)
*/
export interface OrderedRemove extends globalThis.EnumItem {
Name: "OrderedRemove";
Value: 16;
EnumType: typeof globalThis.Enum.DataStoreRequestType;
}
export const OrderedRemove: OrderedRemove;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DataStoreRequestType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DataStoreRequestType | undefined;
}
export type DataStoreRequestType = DataStoreRequestType.GetAsync | DataStoreRequestType.SetIncrementAsync | DataStoreRequestType.UpdateAsync | DataStoreRequestType.GetSortedAsync | DataStoreRequestType.SetIncrementSortedAsync | DataStoreRequestType.OnUpdate | DataStoreRequestType.ListAsync | DataStoreRequestType.GetVersionAsync | DataStoreRequestType.RemoveVersionAsync | DataStoreRequestType.StandardRead | DataStoreRequestType.StandardWrite | DataStoreRequestType.StandardList | DataStoreRequestType.StandardRemove | DataStoreRequestType.OrderedRead | DataStoreRequestType.OrderedWrite | DataStoreRequestType.OrderedList | DataStoreRequestType.OrderedRemove;
/**
* Controls when the debugger pauses on exceptions.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType)
*/
export namespace DebugBreakModeType {
/**
* Never break on exceptions.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType#Never)
*/
export interface Never extends globalThis.EnumItem {
Name: "Never";
Value: 0;
EnumType: typeof globalThis.Enum.DebugBreakModeType;
}
export const Never: Never;
/**
* Break on all exceptions.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType#Always)
*/
export interface Always extends globalThis.EnumItem {
Name: "Always";
Value: 1;
EnumType: typeof globalThis.Enum.DebugBreakModeType;
}
export const Always: Always;
/**
* Break only on unhandled exceptions.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType#Unhandled)
*/
export interface Unhandled extends globalThis.EnumItem {
Name: "Unhandled";
Value: 2;
EnumType: typeof globalThis.Enum.DebugBreakModeType;
}
export const Unhandled: Unhandled;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DebugBreakModeType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DebugBreakModeType | undefined;
}
export type DebugBreakModeType = DebugBreakModeType.Never | DebugBreakModeType.Always | DebugBreakModeType.Unhandled;
/**
* Reason for the end of the debugger session.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason)
*/
export namespace DebuggerEndReason {
/**
* Client requested connection termination.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#ClientRequest)
*/
export interface ClientRequest extends globalThis.EnumItem {
Name: "ClientRequest";
Value: 0;
EnumType: typeof globalThis.Enum.DebuggerEndReason;
}
export const ClientRequest: ClientRequest;
/**
* Connection timed out.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#Timeout)
*/
export interface Timeout extends globalThis.EnumItem {
Name: "Timeout";
Value: 1;
EnumType: typeof globalThis.Enum.DebuggerEndReason;
}
export const Timeout: Timeout;
/**
* Invalid host:port combination.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#InvalidHost)
*/
export interface InvalidHost extends globalThis.EnumItem {
Name: "InvalidHost";
Value: 2;
EnumType: typeof globalThis.Enum.DebuggerEndReason;
}
export const InvalidHost: InvalidHost;
/**
* Connection was lost.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#Disconnected)
*/
export interface Disconnected extends globalThis.EnumItem {
Name: "Disconnected";
Value: 3;
EnumType: typeof globalThis.Enum.DebuggerEndReason;
}
export const Disconnected: Disconnected;
/**
* Server terminated the connection because it shut down.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#ServerShutdown)
*/
export interface ServerShutdown extends globalThis.EnumItem {
Name: "ServerShutdown";
Value: 4;
EnumType: typeof globalThis.Enum.DebuggerEndReason;
}
export const ServerShutdown: ServerShutdown;
/**
* Server has wrong version of protocol.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#ServerProtocolMismatch)
*/
export interface ServerProtocolMismatch extends globalThis.EnumItem {
Name: "ServerProtocolMismatch";
Value: 5;
EnumType: typeof globalThis.Enum.DebuggerEndReason;
}
export const ServerProtocolMismatch: ServerProtocolMismatch;
/**
* Got a failure response when trying to configure the server.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#ConfigurationFailed)
*/
export interface ConfigurationFailed extends globalThis.EnumItem {
Name: "ConfigurationFailed";
Value: 6;
EnumType: typeof globalThis.Enum.DebuggerEndReason;
}
export const ConfigurationFailed: ConfigurationFailed;
/**
* An error occurred in the RPC layer.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#RpcError)
*/
export interface RpcError extends globalThis.EnumItem {
Name: "RpcError";
Value: 7;
EnumType: typeof globalThis.Enum.DebuggerEndReason;
}
export const RpcError: RpcError;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DebuggerEndReason | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DebuggerEndReason | undefined;
}
export type DebuggerEndReason = DebuggerEndReason.ClientRequest | DebuggerEndReason.Timeout | DebuggerEndReason.InvalidHost | DebuggerEndReason.Disconnected | DebuggerEndReason.ServerShutdown | DebuggerEndReason.ServerProtocolMismatch | DebuggerEndReason.ConfigurationFailed | DebuggerEndReason.RpcError;
/**
* Controls when the Luau debugger pauses script execution in response to a runtime exception.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerExceptionBreakMode)
*/
export namespace DebuggerExceptionBreakMode {
/**
* The debugger never pauses due to a runtime exception; execution continues normally regardless of whether the exception is caught or uncaught.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerExceptionBreakMode#Never)
*/
export interface Never extends globalThis.EnumItem {
Name: "Never";
Value: 0;
EnumType: typeof globalThis.Enum.DebuggerExceptionBreakMode;
}
export const Never: Never;
/**
* The debugger pauses on every runtime exception, including those caught by `pcall` or `xpcall`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerExceptionBreakMode#Always)
*/
export interface Always extends globalThis.EnumItem {
Name: "Always";
Value: 1;
EnumType: typeof globalThis.Enum.DebuggerExceptionBreakMode;
}
export const Always: Always;
/**
* The debugger pauses only on runtime exceptions that propagate without being caught by `pcall` or `xpcall`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerExceptionBreakMode#Unhandled)
*/
export interface Unhandled extends globalThis.EnumItem {
Name: "Unhandled";
Value: 2;
EnumType: typeof globalThis.Enum.DebuggerExceptionBreakMode;
}
export const Unhandled: Unhandled;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DebuggerExceptionBreakMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DebuggerExceptionBreakMode | undefined;
}
export type DebuggerExceptionBreakMode = DebuggerExceptionBreakMode.Never | DebuggerExceptionBreakMode.Always | DebuggerExceptionBreakMode.Unhandled;
/**
* Call stack frame type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerFrameType)
*/
export namespace DebuggerFrameType {
/**
* Call stack frame belongs to a C (native) function.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerFrameType#C)
*/
export interface C extends globalThis.EnumItem {
Name: "C";
Value: 0;
EnumType: typeof globalThis.Enum.DebuggerFrameType;
}
export const C: C;
/**
* Call stack frame belongs to a Luau function.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerFrameType#Lua)
*/
export interface Lua extends globalThis.EnumItem {
Name: "Lua";
Value: 1;
EnumType: typeof globalThis.Enum.DebuggerFrameType;
}
export const Lua: Lua;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DebuggerFrameType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DebuggerFrameType | undefined;
}
export type DebuggerFrameType = DebuggerFrameType.C | DebuggerFrameType.Lua;
/**
* Reason that the DataModel was paused.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason)
*/
export namespace DebuggerPauseReason {
/**
* Pausing for a reason not covered by other values.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.DebuggerPauseReason;
}
export const Unknown: Unknown;
/**
* Pause was requested by user.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#Requested)
*/
export interface Requested extends globalThis.EnumItem {
Name: "Requested";
Value: 1;
EnumType: typeof globalThis.Enum.DebuggerPauseReason;
}
export const Requested: Requested;
/**
* Pausing on a user breakpoint.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#Breakpoint)
*/
export interface Breakpoint extends globalThis.EnumItem {
Name: "Breakpoint";
Value: 2;
EnumType: typeof globalThis.Enum.DebuggerPauseReason;
}
export const Breakpoint: Breakpoint;
/**
* Pausing on error hit in the code.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#Exception)
*/
export interface Exception extends globalThis.EnumItem {
Name: "Exception";
Value: 3;
EnumType: typeof globalThis.Enum.DebuggerPauseReason;
}
export const Exception: Exception;
/**
* Pausing on an internal breakpoint set by debugger command: e.g. step over, step into, step out of.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#SingleStep)
*/
export interface SingleStep extends globalThis.EnumItem {
Name: "SingleStep";
Value: 4;
EnumType: typeof globalThis.Enum.DebuggerPauseReason;
}
export const SingleStep: SingleStep;
/**
* Pausing at the entry on the script.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#Entrypoint)
*/
export interface Entrypoint extends globalThis.EnumItem {
Name: "Entrypoint";
Value: 5;
EnumType: typeof globalThis.Enum.DebuggerPauseReason;
}
export const Entrypoint: Entrypoint;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DebuggerPauseReason | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DebuggerPauseReason | undefined;
}
export type DebuggerPauseReason = DebuggerPauseReason.Unknown | DebuggerPauseReason.Requested | DebuggerPauseReason.Breakpoint | DebuggerPauseReason.Exception | DebuggerPauseReason.SingleStep | DebuggerPauseReason.Entrypoint;
/**
* Specifies how the debugger should resume execution after a pause.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType)
*/
export namespace DebuggerResumeType {
/**
* Step into the next function call on the specified thread.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#StepInto)
*/
export interface StepInto extends globalThis.EnumItem {
Name: "StepInto";
Value: 0;
EnumType: typeof globalThis.Enum.DebuggerResumeType;
}
export const StepInto: StepInto;
/**
* Step out of the current function on the specified thread.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#StepOut)
*/
export interface StepOut extends globalThis.EnumItem {
Name: "StepOut";
Value: 1;
EnumType: typeof globalThis.Enum.DebuggerResumeType;
}
export const StepOut: StepOut;
/**
* Step over the current line on the specified thread.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#StepOver)
*/
export interface StepOver extends globalThis.EnumItem {
Name: "StepOver";
Value: 2;
EnumType: typeof globalThis.Enum.DebuggerResumeType;
}
export const StepOver: StepOver;
/**
* Resume execution normally without stepping.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#Resume)
*/
export interface Resume extends globalThis.EnumItem {
Name: "Resume";
Value: 3;
EnumType: typeof globalThis.Enum.DebuggerResumeType;
}
export const Resume: Resume;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DebuggerResumeType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DebuggerResumeType | undefined;
}
export type DebuggerResumeType = DebuggerResumeType.StepInto | DebuggerResumeType.StepOut | DebuggerResumeType.StepOver | DebuggerResumeType.Resume;
/**
* Result of a debugger request.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus)
*/
export namespace DebuggerStatus {
/**
* Request has completed successfully.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#Success)
*/
export interface Success extends globalThis.EnumItem {
Name: "Success";
Value: 0;
EnumType: typeof globalThis.Enum.DebuggerStatus;
}
export const Success: Success;
/**
* Timed out while waiting for response.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#Timeout)
*/
export interface Timeout extends globalThis.EnumItem {
Name: "Timeout";
Value: 1;
EnumType: typeof globalThis.Enum.DebuggerStatus;
}
export const Timeout: Timeout;
/**
* Connection to the debugger was lost.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#ConnectionLost)
*/
export interface ConnectionLost extends globalThis.EnumItem {
Name: "ConnectionLost";
Value: 2;
EnumType: typeof globalThis.Enum.DebuggerStatus;
}
export const ConnectionLost: ConnectionLost;
/**
* Failed to parse response.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#InvalidResponse)
*/
export interface InvalidResponse extends globalThis.EnumItem {
Name: "InvalidResponse";
Value: 3;
EnumType: typeof globalThis.Enum.DebuggerStatus;
}
export const InvalidResponse: InvalidResponse;
/**
* Exception encountered while processing response.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#InternalError)
*/
export interface InternalError extends globalThis.EnumItem {
Name: "InternalError";
Value: 4;
EnumType: typeof globalThis.Enum.DebuggerStatus;
}
export const InternalError: InternalError;
/**
* The request was not appropriate for the current debugger state.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#InvalidState)
*/
export interface InvalidState extends globalThis.EnumItem {
Name: "InvalidState";
Value: 5;
EnumType: typeof globalThis.Enum.DebuggerStatus;
}
export const InvalidState: InvalidState;
/**
* Response was an error.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#RpcError)
*/
export interface RpcError extends globalThis.EnumItem {
Name: "RpcError";
Value: 6;
EnumType: typeof globalThis.Enum.DebuggerStatus;
}
export const RpcError: RpcError;
/**
* One of the request arguments was invalid.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#InvalidArgument)
*/
export interface InvalidArgument extends globalThis.EnumItem {
Name: "InvalidArgument";
Value: 7;
EnumType: typeof globalThis.Enum.DebuggerStatus;
}
export const InvalidArgument: InvalidArgument;
/**
* Connection closed while waiting for response.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#ConnectionClosed)
*/
export interface ConnectionClosed extends globalThis.EnumItem {
Name: "ConnectionClosed";
Value: 8;
EnumType: typeof globalThis.Enum.DebuggerStatus;
}
export const ConnectionClosed: ConnectionClosed;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DebuggerStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DebuggerStatus | undefined;
}
export type DebuggerStatus = DebuggerStatus.Success | DebuggerStatus.Timeout | DebuggerStatus.ConnectionLost | DebuggerStatus.InvalidResponse | DebuggerStatus.InternalError | DebuggerStatus.InvalidState | DebuggerStatus.RpcError | DebuggerStatus.InvalidArgument | DebuggerStatus.ConnectionClosed;
/**
* Controls the file extension used when Studio's script sync feature saves script instances to the filesystem.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DefaultScriptSyncFileType)
*/
export namespace DefaultScriptSyncFileType {
/**
* Script files are synced to the filesystem with a `.lua` extension.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DefaultScriptSyncFileType#Lua)
*/
export interface Lua extends globalThis.EnumItem {
Name: "Lua";
Value: 0;
EnumType: typeof globalThis.Enum.DefaultScriptSyncFileType;
}
export const Lua: Lua;
/**
* Script files are synced to the filesystem with a `.luau` extension.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DefaultScriptSyncFileType#Luau)
*/
export interface Luau extends globalThis.EnumItem {
Name: "Luau";
Value: 1;
EnumType: typeof globalThis.Enum.DefaultScriptSyncFileType;
}
export const Luau: Luau;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DefaultScriptSyncFileType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DefaultScriptSyncFileType | undefined;
}
export type DefaultScriptSyncFileType = DefaultScriptSyncFileType.Lua | DefaultScriptSyncFileType.Luau;
/**
* Determines how the default camera handles objects that are in-between the camera and the camera subject.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevCameraOcclusionMode)
*/
export namespace DevCameraOcclusionMode {
/**
* The camera zooms in until there is nothing between it and its subject.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevCameraOcclusionMode#Zoom)
*/
export interface Zoom extends globalThis.EnumItem {
Name: "Zoom";
Value: 0;
EnumType: typeof globalThis.Enum.DevCameraOcclusionMode;
}
export const Zoom: Zoom;
/**
* Any objects between the camera and its subject become translucent locally.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevCameraOcclusionMode#Invisicam)
*/
export interface Invisicam extends globalThis.EnumItem {
Name: "Invisicam";
Value: 1;
EnumType: typeof globalThis.Enum.DevCameraOcclusionMode;
}
export const Invisicam: Invisicam;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DevCameraOcclusionMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DevCameraOcclusionMode | undefined;
}
export type DevCameraOcclusionMode = DevCameraOcclusionMode.Zoom | DevCameraOcclusionMode.Invisicam;
/**
* Overwrites the player's camera movement mode setting on a computer.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode)
*/
export namespace DevComputerCameraMovementMode {
/**
* The camera will move based on the player's settings.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode#UserChoice)
*/
export interface UserChoice extends globalThis.EnumItem {
Name: "UserChoice";
Value: 0;
EnumType: typeof globalThis.Enum.DevComputerCameraMovementMode;
}
export const UserChoice: UserChoice;
/**
* Camera tracks the player but will not automatically rotate if the player walks left or right.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode#Classic)
*/
export interface Classic extends globalThis.EnumItem {
Name: "Classic";
Value: 1;
EnumType: typeof globalThis.Enum.DevComputerCameraMovementMode;
}
export const Classic: Classic;
/**
* Camera tracks the player and automatically rotates if the player walks left or right.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode#Follow)
*/
export interface Follow extends globalThis.EnumItem {
Name: "Follow";
Value: 2;
EnumType: typeof globalThis.Enum.DevComputerCameraMovementMode;
}
export const Follow: Follow;
/**
* The camera has a fixed Y position, but can be rotated around the player.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode#Orbital)
*/
export interface Orbital extends globalThis.EnumItem {
Name: "Orbital";
Value: 3;
EnumType: typeof globalThis.Enum.DevComputerCameraMovementMode;
}
export const Orbital: Orbital;
/**
* The camera toggles between locked and free rotation with the right mouse button.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode#CameraToggle)
*/
export interface CameraToggle extends globalThis.EnumItem {
Name: "CameraToggle";
Value: 4;
EnumType: typeof globalThis.Enum.DevComputerCameraMovementMode;
}
export const CameraToggle: CameraToggle;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DevComputerCameraMovementMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DevComputerCameraMovementMode | undefined;
}
export type DevComputerCameraMovementMode = DevComputerCameraMovementMode.UserChoice | DevComputerCameraMovementMode.Classic | DevComputerCameraMovementMode.Follow | DevComputerCameraMovementMode.Orbital | DevComputerCameraMovementMode.CameraToggle;
/**
* Sets the movement mode of players who are playing on computers.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode)
*/
export namespace DevComputerMovementMode {
/**
* Allows players to choose their desired control scheme from the in-experience menu. This is the default movement mode.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode#UserChoice)
*/
export interface UserChoice extends globalThis.EnumItem {
Name: "UserChoice";
Value: 0;
EnumType: typeof globalThis.Enum.DevComputerMovementMode;
}
export const UserChoice: UserChoice;
/**
* The player's character will be controlled using the keyboard and mouse.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode#KeyboardMouse)
*/
export interface KeyboardMouse extends globalThis.EnumItem {
Name: "KeyboardMouse";
Value: 1;
EnumType: typeof globalThis.Enum.DevComputerMovementMode;
}
export const KeyboardMouse: KeyboardMouse;
/**
* Players can only move through the experience by clicking a target location. The player's character will automatically jump when reaching a surmountable obstacle/gap while moving to the click destination.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode#ClickToMove)
*/
export interface ClickToMove extends globalThis.EnumItem {
Name: "ClickToMove";
Value: 2;
EnumType: typeof globalThis.Enum.DevComputerMovementMode;
}
export const ClickToMove: ClickToMove;
/**
* Disables all default controls and allows you to script your own control scheme.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode#Scriptable)
*/
export interface Scriptable extends globalThis.EnumItem {
Name: "Scriptable";
Value: 3;
EnumType: typeof globalThis.Enum.DevComputerMovementMode;
}
export const Scriptable: Scriptable;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DevComputerMovementMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DevComputerMovementMode | undefined;
}
export type DevComputerMovementMode = DevComputerMovementMode.UserChoice | DevComputerMovementMode.KeyboardMouse | DevComputerMovementMode.ClickToMove | DevComputerMovementMode.Scriptable;
/**
* Overwrites the camera mode if the player is on a touch device.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchCameraMovementMode)
*/
export namespace DevTouchCameraMovementMode {
/**
* The camera will move based on the player's settings.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchCameraMovementMode#UserChoice)
*/
export interface UserChoice extends globalThis.EnumItem {
Name: "UserChoice";
Value: 0;
EnumType: typeof globalThis.Enum.DevTouchCameraMovementMode;
}
export const UserChoice: UserChoice;
/**
* Camera tracks the player but will not automatically rotate if the player walks left or right.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchCameraMovementMode#Classic)
*/
export interface Classic extends globalThis.EnumItem {
Name: "Classic";
Value: 1;
EnumType: typeof globalThis.Enum.DevTouchCameraMovementMode;
}
export const Classic: Classic;
/**
* Camera tracks the player and automatically rotates if the player walks left or right.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchCameraMovementMode#Follow)
*/
export interface Follow extends globalThis.EnumItem {
Name: "Follow";
Value: 2;
EnumType: typeof globalThis.Enum.DevTouchCameraMovementMode;
}
export const Follow: Follow;
/**
* The camera has a fixed Y position, but can be rotated around the player.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchCameraMovementMode#Orbital)
*/
export interface Orbital extends globalThis.EnumItem {
Name: "Orbital";
Value: 3;
EnumType: typeof globalThis.Enum.DevTouchCameraMovementMode;
}
export const Orbital: Orbital;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DevTouchCameraMovementMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DevTouchCameraMovementMode | undefined;
}
export type DevTouchCameraMovementMode = DevTouchCameraMovementMode.UserChoice | DevTouchCameraMovementMode.Classic | DevTouchCameraMovementMode.Follow | DevTouchCameraMovementMode.Orbital;
/**
* Overrides the movement mode of players who are playing on touch-enabled devices.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode)
*/
export namespace DevTouchMovementMode {
/**
* Allows players to choose their desired control scheme from the in-experience menu. This is the default movement mode.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#UserChoice)
*/
export interface UserChoice extends globalThis.EnumItem {
Name: "UserChoice";
Value: 0;
EnumType: typeof globalThis.Enum.DevTouchMovementMode;
}
export const UserChoice: UserChoice;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#Thumbstick)
*/
export interface Thumbstick extends globalThis.EnumItem {
Name: "Thumbstick";
Value: 1;
EnumType: typeof globalThis.Enum.DevTouchMovementMode;
}
export const Thumbstick: Thumbstick;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#DPad)
*/
export interface DPad extends globalThis.EnumItem {
Name: "DPad";
Value: 2;
EnumType: typeof globalThis.Enum.DevTouchMovementMode;
}
export const DPad: DPad;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#Thumbpad)
*/
export interface Thumbpad extends globalThis.EnumItem {
Name: "Thumbpad";
Value: 3;
EnumType: typeof globalThis.Enum.DevTouchMovementMode;
}
export const Thumbpad: Thumbpad;
/**
* The player's character will attempt to move to a location in the world when the player taps a location.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#ClickToMove)
*/
export interface ClickToMove extends globalThis.EnumItem {
Name: "ClickToMove";
Value: 4;
EnumType: typeof globalThis.Enum.DevTouchMovementMode;
}
export const ClickToMove: ClickToMove;
/**
* The player's character will not respond to default controls; any character movement must be defined in custom scripts.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#Scriptable)
*/
export interface Scriptable extends globalThis.EnumItem {
Name: "Scriptable";
Value: 5;
EnumType: typeof globalThis.Enum.DevTouchMovementMode;
}
export const Scriptable: Scriptable;
/**
* The player's character is controlled with a virtual thumbstick that appears when they touch the lower portion of the screen. Jumping is controlled with a separate button.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#DynamicThumbstick)
*/
export interface DynamicThumbstick extends globalThis.EnumItem {
Name: "DynamicThumbstick";
Value: 6;
EnumType: typeof globalThis.Enum.DevTouchMovementMode;
}
export const DynamicThumbstick: DynamicThumbstick;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DevTouchMovementMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DevTouchMovementMode | undefined;
}
export type DevTouchMovementMode = DevTouchMovementMode.UserChoice | DevTouchMovementMode.Thumbstick | DevTouchMovementMode.DPad | DevTouchMovementMode.Thumbpad | DevTouchMovementMode.ClickToMove | DevTouchMovementMode.Scriptable | DevTouchMovementMode.DynamicThumbstick;
/**
* A memory tracking category.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag)
*/
export namespace DeveloperMemoryTag {
/**
* General data that doesn't have any categorization. This could be due to either internal reasons, or because it simply isn't being tracked categorically.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Internal)
*/
export interface Internal extends globalThis.EnumItem {
Name: "Internal";
Value: 0;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const Internal: Internal;
/**
* A cache of HTTP responses.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#HttpCache)
*/
export interface HttpCache extends globalThis.EnumItem {
Name: "HttpCache";
Value: 1;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const HttpCache: HttpCache;
/**
* All the Instances present in memory.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Instances)
*/
export interface Instances extends globalThis.EnumItem {
Name: "Instances";
Value: 2;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const Instances: Instances;
/**
* Events, signals, connections, etc.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Signals)
*/
export interface Signals extends globalThis.EnumItem {
Name: "Signals";
Value: 3;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const Signals: Signals;
/**
* All of the data in Luau, including everything happening in core scripts, built-in data types, etc.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#LuaHeap)
*/
export interface LuaHeap extends globalThis.EnumItem {
Name: "LuaHeap";
Value: 4;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const LuaHeap: LuaHeap;
/**
* All memory being manipulated and referenced by scripts.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Script)
*/
export interface Script extends globalThis.EnumItem {
Name: "Script";
Value: 5;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const Script: Script;
/**
* Collision detection in the `Workspace`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#PhysicsCollision)
*/
export interface PhysicsCollision extends globalThis.EnumItem {
Name: "PhysicsCollision";
Value: 6;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const PhysicsCollision: PhysicsCollision;
/**
* 3D parts used for simulation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#BaseParts)
*/
export interface BaseParts extends globalThis.EnumItem {
Name: "BaseParts";
Value: 7;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const BaseParts: BaseParts;
/**
* @deprecated renamed to BaseParts
*/
export const PhysicsParts: BaseParts;
/**
* Rendering solid models (stuff made with Union, Negate, etc.).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsSolidModels)
*/
export interface GraphicsSolidModels extends globalThis.EnumItem {
Name: "GraphicsSolidModels";
Value: 8;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const GraphicsSolidModels: GraphicsSolidModels;
/**
* Rendering of mesh parts.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsMeshParts)
*/
export interface GraphicsMeshParts extends globalThis.EnumItem {
Name: "GraphicsMeshParts";
Value: 10;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const GraphicsMeshParts: GraphicsMeshParts;
/**
* Rendering of particles from ParticleEmitters.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsParticles)
*/
export interface GraphicsParticles extends globalThis.EnumItem {
Name: "GraphicsParticles";
Value: 11;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const GraphicsParticles: GraphicsParticles;
/**
* Rendering of regular parts.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsParts)
*/
export interface GraphicsParts extends globalThis.EnumItem {
Name: "GraphicsParts";
Value: 12;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const GraphicsParts: GraphicsParts;
/**
* Spatial hash lookup tables of the game world that are used for rendering.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsSpatialHash)
*/
export interface GraphicsSpatialHash extends globalThis.EnumItem {
Name: "GraphicsSpatialHash";
Value: 13;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const GraphicsSpatialHash: GraphicsSpatialHash;
/**
* Rendering of terrain geometry.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsTerrain)
*/
export interface GraphicsTerrain extends globalThis.EnumItem {
Name: "GraphicsTerrain";
Value: 14;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const GraphicsTerrain: GraphicsTerrain;
/**
* Rendering of textures in the game world.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsTexture)
*/
export interface GraphicsTexture extends globalThis.EnumItem {
Name: "GraphicsTexture";
Value: 15;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const GraphicsTexture: GraphicsTexture;
/**
* Rendering of texture composition maps that are generated for Humanoids.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsTextureCharacter)
*/
export interface GraphicsTextureCharacter extends globalThis.EnumItem {
Name: "GraphicsTextureCharacter";
Value: 16;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const GraphicsTextureCharacter: GraphicsTextureCharacter;
/**
* Data of sounds in-game.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Sounds)
*/
export interface Sounds extends globalThis.EnumItem {
Name: "Sounds";
Value: 17;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const Sounds: Sounds;
/**
* Playback of sounds in-game.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#StreamingSounds)
*/
export interface StreamingSounds extends globalThis.EnumItem {
Name: "StreamingSounds";
Value: 18;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const StreamingSounds: StreamingSounds;
/**
* Occupancy/Material data of the Terrain.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#TerrainVoxels)
*/
export interface TerrainVoxels extends globalThis.EnumItem {
Name: "TerrainVoxels";
Value: 19;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const TerrainVoxels: TerrainVoxels;
/**
* Gui element data and rendering.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Gui)
*/
export interface Gui extends globalThis.EnumItem {
Name: "Gui";
Value: 21;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const Gui: Gui;
/**
* Playback of Animations on Humanoids and AnimationControllers.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Animation)
*/
export interface Animation extends globalThis.EnumItem {
Name: "Animation";
Value: 22;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const Animation: Animation;
/**
* Pathfinding for Humanoids via the PathfindingService.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Navigation)
*/
export interface Navigation extends globalThis.EnumItem {
Name: "Navigation";
Value: 23;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const Navigation: Navigation;
/**
* Geometry mesh data for CSG objects such as `UnionOperation` and `PartOperation`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GeometryCSG)
*/
export interface GeometryCSG extends globalThis.EnumItem {
Name: "GeometryCSG";
Value: 24;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const GeometryCSG: GeometryCSG;
/**
* Rendering memory for SLIM (streamed level-of-detail instance mesh) model data.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsSlimModels)
*/
export interface GraphicsSlimModels extends globalThis.EnumItem {
Name: "GraphicsSlimModels";
Value: 25;
EnumType: typeof globalThis.Enum.DeveloperMemoryTag;
}
export const GraphicsSlimModels: GraphicsSlimModels;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DeveloperMemoryTag | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DeveloperMemoryTag | undefined;
}
export type DeveloperMemoryTag = DeveloperMemoryTag.Internal | DeveloperMemoryTag.HttpCache | DeveloperMemoryTag.Instances | DeveloperMemoryTag.Signals | DeveloperMemoryTag.LuaHeap | DeveloperMemoryTag.Script | DeveloperMemoryTag.PhysicsCollision | DeveloperMemoryTag.BaseParts | DeveloperMemoryTag.GraphicsSolidModels | DeveloperMemoryTag.GraphicsMeshParts | DeveloperMemoryTag.GraphicsParticles | DeveloperMemoryTag.GraphicsParts | DeveloperMemoryTag.GraphicsSpatialHash | DeveloperMemoryTag.GraphicsTerrain | DeveloperMemoryTag.GraphicsTexture | DeveloperMemoryTag.GraphicsTextureCharacter | DeveloperMemoryTag.Sounds | DeveloperMemoryTag.StreamingSounds | DeveloperMemoryTag.TerrainVoxels | DeveloperMemoryTag.Gui | DeveloperMemoryTag.Animation | DeveloperMemoryTag.Navigation | DeveloperMemoryTag.GeometryCSG | DeveloperMemoryTag.GraphicsSlimModels;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceFeatureType)
*/
export namespace DeviceFeatureType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceFeatureType#DeviceCapture)
*/
export interface DeviceCapture extends globalThis.EnumItem {
Name: "DeviceCapture";
Value: 0;
EnumType: typeof globalThis.Enum.DeviceFeatureType;
}
export const DeviceCapture: DeviceCapture;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceFeatureType#InExperienceFAE)
*/
export interface InExperienceFAE extends globalThis.EnumItem {
Name: "InExperienceFAE";
Value: 1;
EnumType: typeof globalThis.Enum.DeviceFeatureType;
}
export const InExperienceFAE: InExperienceFAE;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DeviceFeatureType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DeviceFeatureType | undefined;
}
export type DeviceFeatureType = DeviceFeatureType.DeviceCapture | DeviceFeatureType.InExperienceFAE;
/**
* Describes the physical form factor of a device used during Studio device emulation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceForm)
*/
export namespace DeviceForm {
/**
* Represents a gaming console device, such as an Xbox or PlayStation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceForm#Console)
*/
export interface Console extends globalThis.EnumItem {
Name: "Console";
Value: 0;
EnumType: typeof globalThis.Enum.DeviceForm;
}
export const Console: Console;
/**
* Represents a mobile phone with a touchscreen.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceForm#Phone)
*/
export interface Phone extends globalThis.EnumItem {
Name: "Phone";
Value: 1;
EnumType: typeof globalThis.Enum.DeviceForm;
}
export const Phone: Phone;
/**
* Represents a tablet with a touchscreen.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceForm#Tablet)
*/
export interface Tablet extends globalThis.EnumItem {
Name: "Tablet";
Value: 2;
EnumType: typeof globalThis.Enum.DeviceForm;
}
export const Tablet: Tablet;
/**
* Represents a desktop or laptop computer.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceForm#Desktop)
*/
export interface Desktop extends globalThis.EnumItem {
Name: "Desktop";
Value: 3;
EnumType: typeof globalThis.Enum.DeviceForm;
}
export const Desktop: Desktop;
/**
* Represents a virtual reality headset.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceForm#VR)
*/
export interface VR extends globalThis.EnumItem {
Name: "VR";
Value: 4;
EnumType: typeof globalThis.Enum.DeviceForm;
}
export const VR: VR;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DeviceForm | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DeviceForm | undefined;
}
export type DeviceForm = DeviceForm.Console | DeviceForm.Phone | DeviceForm.Tablet | DeviceForm.Desktop | DeviceForm.VR;
/**
* Classifies a device's hardware capability tier.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceLevel)
*/
export namespace DeviceLevel {
/**
* Indicates a low-end device that benefits from reduced graphics or simulation quality.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceLevel#Low)
*/
export interface Low extends globalThis.EnumItem {
Name: "Low";
Value: 0;
EnumType: typeof globalThis.Enum.DeviceLevel;
}
export const Low: Low;
/**
* Indicates a mid-range device that may benefit from moderate reductions in resource-intensive features.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceLevel#Medium)
*/
export interface Medium extends globalThis.EnumItem {
Name: "Medium";
Value: 1;
EnumType: typeof globalThis.Enum.DeviceLevel;
}
export const Medium: Medium;
/**
* Indicates a high-end device capable of running resource-intensive features at full fidelity.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceLevel#High)
*/
export interface High extends globalThis.EnumItem {
Name: "High";
Value: 2;
EnumType: typeof globalThis.Enum.DeviceLevel;
}
export const High: High;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DeviceLevel | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DeviceLevel | undefined;
}
export type DeviceLevel = DeviceLevel.Low | DeviceLevel.Medium | DeviceLevel.High;
/**
* Controls how the Device Simulator viewport scales the simulated device resolution within the Studio window.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceSimulatorScalingMode)
*/
export namespace DeviceSimulatorScalingMode {
/**
* Scales the simulated viewport so that its pixels correspond to their physical size on the developer's monitor, computed from the screen DPI and an optional target DPI override.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceSimulatorScalingMode#ScaleToPhysicalSize)
*/
export interface ScaleToPhysicalSize extends globalThis.EnumItem {
Name: "ScaleToPhysicalSize";
Value: 0;
EnumType: typeof globalThis.Enum.DeviceSimulatorScalingMode;
}
export const ScaleToPhysicalSize: ScaleToPhysicalSize;
/**
* Renders the simulated viewport at a 1:1 pixel mapping with no scaling applied.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceSimulatorScalingMode#ActualResolution)
*/
export interface ActualResolution extends globalThis.EnumItem {
Name: "ActualResolution";
Value: 1;
EnumType: typeof globalThis.Enum.DeviceSimulatorScalingMode;
}
export const ActualResolution: ActualResolution;
/**
* Scales the simulated viewport uniformly to fill as much of the available Studio window as possible while preserving the device's aspect ratio.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceSimulatorScalingMode#FitToWindow)
*/
export interface FitToWindow extends globalThis.EnumItem {
Name: "FitToWindow";
Value: 2;
EnumType: typeof globalThis.Enum.DeviceSimulatorScalingMode;
}
export const FitToWindow: FitToWindow;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DeviceSimulatorScalingMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DeviceSimulatorScalingMode | undefined;
}
export type DeviceSimulatorScalingMode = DeviceSimulatorScalingMode.ScaleToPhysicalSize | DeviceSimulatorScalingMode.ActualResolution | DeviceSimulatorScalingMode.FitToWindow;
/**
* Device category of the client.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceType)
*/
export namespace DeviceType {
/**
* The client is an unknown device.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceType#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.DeviceType;
}
export const Unknown: Unknown;
/**
* The client is a desktop device.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceType#Desktop)
*/
export interface Desktop extends globalThis.EnumItem {
Name: "Desktop";
Value: 1;
EnumType: typeof globalThis.Enum.DeviceType;
}
export const Desktop: Desktop;
/**
* The client is a tablet device.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceType#Tablet)
*/
export interface Tablet extends globalThis.EnumItem {
Name: "Tablet";
Value: 2;
EnumType: typeof globalThis.Enum.DeviceType;
}
export const Tablet: Tablet;
/**
* The client is a phone device.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceType#Phone)
*/
export interface Phone extends globalThis.EnumItem {
Name: "Phone";
Value: 3;
EnumType: typeof globalThis.Enum.DeviceType;
}
export const Phone: Phone;
/**
* The client is a TV device.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DeviceType#TV)
*/
export interface TV extends globalThis.EnumItem {
Name: "TV";
Value: 4;
EnumType: typeof globalThis.Enum.DeviceType;
}
export const TV: TV;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DeviceType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DeviceType | undefined;
}
export type DeviceType = DeviceType.Unknown | DeviceType.Desktop | DeviceType.Tablet | DeviceType.Phone | DeviceType.TV;
/**
* Controls whether multiple people can use this dialog, or only one person at a time can use it.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DialogBehaviorType)
*/
export namespace DialogBehaviorType {
/**
* Only one player can interact with this dialog at a time. The conversation between the player and dialog can be seen by all players.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DialogBehaviorType#SinglePlayer)
*/
export interface SinglePlayer extends globalThis.EnumItem {
Name: "SinglePlayer";
Value: 0;
EnumType: typeof globalThis.Enum.DialogBehaviorType;
}
export const SinglePlayer: SinglePlayer;
/**
* Multiple players can simultaneously interact with this dialog. The conversation between the player and the dialog cannot be seen by other players.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DialogBehaviorType#MultiplePlayers)
*/
export interface MultiplePlayers extends globalThis.EnumItem {
Name: "MultiplePlayers";
Value: 1;
EnumType: typeof globalThis.Enum.DialogBehaviorType;
}
export const MultiplePlayers: MultiplePlayers;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DialogBehaviorType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DialogBehaviorType | undefined;
}
export type DialogBehaviorType = DialogBehaviorType.SinglePlayer | DialogBehaviorType.MultiplePlayers;
/**
* The DialogPurpose enum is used to set the icon of a `Dialog`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DialogPurpose)
*/
export namespace DialogPurpose {
/**
* Shows an exclamation point ('''!''').
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DialogPurpose#Quest)
*/
export interface Quest extends globalThis.EnumItem {
Name: "Quest";
Value: 0;
EnumType: typeof globalThis.Enum.DialogPurpose;
}
export const Quest: Quest;
/**
* Shows a question mark ('''?''').
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DialogPurpose#Help)
*/
export interface Help extends globalThis.EnumItem {
Name: "Help";
Value: 1;
EnumType: typeof globalThis.Enum.DialogPurpose;
}
export const Help: Help;
/**
* Shows a dollar sign ('''$''').
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DialogPurpose#Shop)
*/
export interface Shop extends globalThis.EnumItem {
Name: "Shop";
Value: 2;
EnumType: typeof globalThis.Enum.DialogPurpose;
}
export const Shop: Shop;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DialogPurpose | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DialogPurpose | undefined;
}
export type DialogPurpose = DialogPurpose.Quest | DialogPurpose.Help | DialogPurpose.Shop;
/**
* Sets the `Dialog.Tone` of a `Dialog` object, which influences how the dialog appears.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DialogTone)
*/
export namespace DialogTone {
/**
* Causes the dialog to have a blue bar on its left-hand side.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DialogTone#Neutral)
*/
export interface Neutral extends globalThis.EnumItem {
Name: "Neutral";
Value: 0;
EnumType: typeof globalThis.Enum.DialogTone;
}
export const Neutral: Neutral;
/**
* Causes the dialog to have a green bar on its left-hand side.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DialogTone#Friendly)
*/
export interface Friendly extends globalThis.EnumItem {
Name: "Friendly";
Value: 1;
EnumType: typeof globalThis.Enum.DialogTone;
}
export const Friendly: Friendly;
/**
* Causes the dialog to have a red bar on its left-hand side.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DialogTone#Enemy)
*/
export interface Enemy extends globalThis.EnumItem {
Name: "Enemy";
Value: 2;
EnumType: typeof globalThis.Enum.DialogTone;
}
export const Enemy: Enemy;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DialogTone | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DialogTone | undefined;
}
export type DialogTone = DialogTone.Neutral | DialogTone.Friendly | DialogTone.Enemy;
/**
* Specifies which hand side a `DigitsRigDescription` instance is assigned to.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DigitsRigDescriptionSide)
*/
export namespace DigitsRigDescriptionSide {
/**
* The `DigitsRigDescription` has not been assigned to a hand side and is skipped by the animation system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DigitsRigDescriptionSide#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.DigitsRigDescriptionSide;
}
export const None: None;
/**
* The `DigitsRigDescription` is assigned to the left hand.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DigitsRigDescriptionSide#Left)
*/
export interface Left extends globalThis.EnumItem {
Name: "Left";
Value: 1;
EnumType: typeof globalThis.Enum.DigitsRigDescriptionSide;
}
export const Left: Left;
/**
* The `DigitsRigDescription` is assigned to the right hand.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DigitsRigDescriptionSide#Right)
*/
export interface Right extends globalThis.EnumItem {
Name: "Right";
Value: 2;
EnumType: typeof globalThis.Enum.DigitsRigDescriptionSide;
}
export const Right: Right;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DigitsRigDescriptionSide | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DigitsRigDescriptionSide | undefined;
}
export type DigitsRigDescriptionSide = DigitsRigDescriptionSide.None | DigitsRigDescriptionSide.Left | DigitsRigDescriptionSide.Right;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DiscountType)
*/
export namespace DiscountType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DiscountType#Uncategorized)
*/
export interface Uncategorized extends globalThis.EnumItem {
Name: "Uncategorized";
Value: 0;
EnumType: typeof globalThis.Enum.DiscountType;
}
export const Uncategorized: Uncategorized;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DiscountType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DiscountType | undefined;
}
export type DiscountType = DiscountType.Uncategorized;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplayScalingMode)
*/
export namespace DisplayScalingMode {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplayScalingMode#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.DisplayScalingMode;
}
export const Default: Default;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplayScalingMode#Legacy)
*/
export interface Legacy extends globalThis.EnumItem {
Name: "Legacy";
Value: 1;
EnumType: typeof globalThis.Enum.DisplayScalingMode;
}
export const Legacy: Legacy;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplayScalingMode#Responsive)
*/
export interface Responsive extends globalThis.EnumItem {
Name: "Responsive";
Value: 2;
EnumType: typeof globalThis.Enum.DisplayScalingMode;
}
export const Responsive: Responsive;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DisplayScalingMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DisplayScalingMode | undefined;
}
export type DisplayScalingMode = DisplayScalingMode.Default | DisplayScalingMode.Legacy | DisplayScalingMode.Responsive;
/**
* This enum is used with `GuiService.ViewportDisplaySize` to indicate the internally-categorized rendering size of the viewport.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize)
*/
export namespace DisplaySize {
/**
* Viewport is categorized as small. Applies to most tablet/mobile/handheld devices.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Small)
*/
export interface Small extends globalThis.EnumItem {
Name: "Small";
Value: 0;
EnumType: typeof globalThis.Enum.DisplaySize;
}
export const Small: Small;
/**
* Viewport is categorized as medium. Applies to most laptops and monitors.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Medium)
*/
export interface Medium extends globalThis.EnumItem {
Name: "Medium";
Value: 1;
EnumType: typeof globalThis.Enum.DisplaySize;
}
export const Medium: Medium;
/**
* Viewport is categorized as large. Applies to most TVs or larger.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Large)
*/
export interface Large extends globalThis.EnumItem {
Name: "Large";
Value: 2;
EnumType: typeof globalThis.Enum.DisplaySize;
}
export const Large: Large;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DisplaySize | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DisplaySize | undefined;
}
export type DisplaySize = DisplaySize.Small | DisplaySize.Medium | DisplaySize.Large;
/**
* Determines how an `AudioEmitter` attenuates (fades out) as the distance between the `AudioEmitter` and an interacting `AudioListener` increases.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DistanceAttenuationMode)
*/
export namespace DistanceAttenuationMode {
/**
* Uses the developer-supplied `DistanceAttenuation` curve for gain rolloff.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DistanceAttenuationMode#Custom)
*/
export interface Custom extends globalThis.EnumItem {
Name: "Custom";
Value: 0;
EnumType: typeof globalThis.Enum.DistanceAttenuationMode;
}
export const Custom: Custom;
/**
* Volume attenuates according to a hybrid model which follows the `DistanceAttenuationMode.Inverse` model when close to the lower bound of `AudioEmitter.DistanceAttenuationBounds` and the `DistanceAttenuationMode.LinearSquared` model when close to the upper bound of `AudioEmitter.DistanceAttenuationBounds`. This is done by taking the lesser of these two curves, such that the curve mostly follows an inverse relationship but tapers to silence at the maximum distance.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DistanceAttenuationMode#InverseTapered)
*/
export interface InverseTapered extends globalThis.EnumItem {
Name: "InverseTapered";
Value: 1;
EnumType: typeof globalThis.Enum.DistanceAttenuationMode;
}
export const InverseTapered: InverseTapered;
/**
* Volume attenuates between the bounds of `AudioEmitter.DistanceAttenuationBounds` with a linear relationship. This is done by computing (`maxDistance` - `distance`) / (`maxDistance` - `minDistance`), where distance is the `Vector3.Magnitude` between the `AudioEmitter`'s position and the `AudioListener`'s position.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DistanceAttenuationMode#Linear)
*/
export interface Linear extends globalThis.EnumItem {
Name: "Linear";
Value: 2;
EnumType: typeof globalThis.Enum.DistanceAttenuationMode;
}
export const Linear: Linear;
/**
* Volume attenuates between the bounds of `AudioEmitter.DistanceAttenuationBounds` with a linear-squared relationship. This is done by squaring the formula used to determine the volume when using `DistanceAttenuationMode.Linear`, which creates a parabolic curve with a steeper fade.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DistanceAttenuationMode#LinearSquared)
*/
export interface LinearSquared extends globalThis.EnumItem {
Name: "LinearSquared";
Value: 3;
EnumType: typeof globalThis.Enum.DistanceAttenuationMode;
}
export const LinearSquared: LinearSquared;
/**
* Volume attenuates from the lower bound of `AudioEmitter.DistanceAttenuationBounds` in an inverse manner, mirroring how sounds attenuate in the real world. This is done by computing (`minDistance`/`distance`), where `distance` is the `Vector2.Magnitude` between the `AudioEmitter`'s position and the `AudioListener`'s position.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DistanceAttenuationMode#Inverse)
*/
export interface Inverse extends globalThis.EnumItem {
Name: "Inverse";
Value: 4;
EnumType: typeof globalThis.Enum.DistanceAttenuationMode;
}
export const Inverse: Inverse;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DistanceAttenuationMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DistanceAttenuationMode | undefined;
}
export type DistanceAttenuationMode = DistanceAttenuationMode.Custom | DistanceAttenuationMode.InverseTapered | DistanceAttenuationMode.Linear | DistanceAttenuationMode.LinearSquared | DistanceAttenuationMode.Inverse;
/**
* Specifies the type of domain that a `User` is scoped to.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DomainType)
*/
export namespace DomainType {
/**
* The user ID is scoped to a specific experience (universe).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DomainType#EXPERIENCE)
*/
export interface EXPERIENCE extends globalThis.EnumItem {
Name: "EXPERIENCE";
Value: 1;
EnumType: typeof globalThis.Enum.DomainType;
}
export const EXPERIENCE: EXPERIENCE;
/**
* The user ID is scoped to a specific OAuth application.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DomainType#OAUTH)
*/
export interface OAUTH extends globalThis.EnumItem {
Name: "OAUTH";
Value: 3;
EnumType: typeof globalThis.Enum.DomainType;
}
export const OAUTH: OAUTH;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DomainType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DomainType | undefined;
}
export type DomainType = DomainType.EXPERIENCE | DomainType.OAUTH;
/**
* Used by `UIAspectRatioConstraint.DominantAxis` for resizing the object to maintain the aspect ratio.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DominantAxis)
*/
export namespace DominantAxis {
/**
* The X axis.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DominantAxis#Width)
*/
export interface Width extends globalThis.EnumItem {
Name: "Width";
Value: 0;
EnumType: typeof globalThis.Enum.DominantAxis;
}
export const Width: Width;
/**
* The Y axis.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DominantAxis#Height)
*/
export interface Height extends globalThis.EnumItem {
Name: "Height";
Value: 1;
EnumType: typeof globalThis.Enum.DominantAxis;
}
export const Height: Height;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DominantAxis | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DominantAxis | undefined;
}
export type DominantAxis = DominantAxis.Width | DominantAxis.Height;
/**
* Describes the state of a script draft tracked by `DraftsService`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraftStatusCode)
*/
export namespace DraftStatusCode {
/**
* The draft is in sync with the server's base version and has no blocking conflicts.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraftStatusCode#OK)
*/
export interface OK extends globalThis.EnumItem {
Name: "OK";
Value: 0;
EnumType: typeof globalThis.Enum.DraftStatusCode;
}
export const OK: OK;
/**
* The server version of the script has advanced beyond the base version used when the draft was created, so the draft must be updated before it can be committed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraftStatusCode#DraftOutdated)
*/
export interface DraftOutdated extends globalThis.EnumItem {
Name: "DraftOutdated";
Value: 1;
EnumType: typeof globalThis.Enum.DraftStatusCode;
}
export const DraftOutdated: DraftOutdated;
/**
* The script referenced by the draft no longer exists in the data model.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraftStatusCode#ScriptRemoved)
*/
export interface ScriptRemoved extends globalThis.EnumItem {
Name: "ScriptRemoved";
Value: 2;
EnumType: typeof globalThis.Enum.DraftStatusCode;
}
export const ScriptRemoved: ScriptRemoved;
/**
* The draft was successfully committed to the server and removed from the local sandbox.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraftStatusCode#DraftCommitted)
*/
export interface DraftCommitted extends globalThis.EnumItem {
Name: "DraftCommitted";
Value: 3;
EnumType: typeof globalThis.Enum.DraftStatusCode;
}
export const DraftCommitted: DraftCommitted;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DraftStatusCode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DraftStatusCode | undefined;
}
export type DraftStatusCode = DraftStatusCode.OK | DraftStatusCode.DraftOutdated | DraftStatusCode.ScriptRemoved | DraftStatusCode.DraftCommitted;
/**
* Used with `DragDetector` as the paradigm to generate proposed motion, given a stream of cursor rays.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle)
*/
export namespace DragDetectorDragStyle {
/**
* 1D motion along the detector's `Axis`, by default the world **Y** axis.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#TranslateLine)
*/
export interface TranslateLine extends globalThis.EnumItem {
Name: "TranslateLine";
Value: 0;
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
}
export const TranslateLine: TranslateLine;
/**
* 2D motion in the plane **perpendicular** to the detector's `Axis`, by default the world **XZ** plane.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#TranslatePlane)
*/
export interface TranslatePlane extends globalThis.EnumItem {
Name: "TranslatePlane";
Value: 1;
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
}
export const TranslatePlane: TranslatePlane;
/**
* 2D motion in the plane **perpendicular** to the detector's `Axis` and, when the modifier is active, 1D motion along the detector's `Axis`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#TranslatePlaneOrLine)
*/
export interface TranslatePlaneOrLine extends globalThis.EnumItem {
Name: "TranslatePlaneOrLine";
Value: 2;
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
}
export const TranslatePlaneOrLine: TranslatePlaneOrLine;
/**
* 1D motion along the detector's `Axis` and, when the modifier is active, 2D motion in the plane **perpendicular** to the detector's `Axis`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#TranslateLineOrPlane)
*/
export interface TranslateLineOrPlane extends globalThis.EnumItem {
Name: "TranslateLineOrPlane";
Value: 3;
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
}
export const TranslateLineOrPlane: TranslateLineOrPlane;
/**
* 2D motion in the plane perpendicular to the camera's view. In this mode, the plane is constantly updated, even while dragging, and will always face the camera's current view.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#TranslateViewPlane)
*/
export interface TranslateViewPlane extends globalThis.EnumItem {
Name: "TranslateViewPlane";
Value: 4;
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
}
export const TranslateViewPlane: TranslateViewPlane;
/**
* Rotation about the detector's `Axis`, by default the world **Y** axis.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#RotateAxis)
*/
export interface RotateAxis extends globalThis.EnumItem {
Name: "RotateAxis";
Value: 5;
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
}
export const RotateAxis: RotateAxis;
/**
* Trackball rotation, further customized through the `TrackballRadialPullFactor` and `TrackballRollFactor` properties.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#RotateTrackball)
*/
export interface RotateTrackball extends globalThis.EnumItem {
Name: "RotateTrackball";
Value: 6;
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
}
export const RotateTrackball: RotateTrackball;
/**
* Calculates desired motion via a custom function provided through `SetDragStyleFunction()`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#Scriptable)
*/
export interface Scriptable extends globalThis.EnumItem {
Name: "Scriptable";
Value: 7;
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
}
export const Scriptable: Scriptable;
/**
* **TranslatePlaneOrLine** for mouse and gamepad; **TranslatePlane** for touch; **6DOF** for VR.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#BestForDevice)
*/
export interface BestForDevice extends globalThis.EnumItem {
Name: "BestForDevice";
Value: 8;
EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
}
export const BestForDevice: BestForDevice;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DragDetectorDragStyle | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DragDetectorDragStyle | undefined;
}
export type DragDetectorDragStyle = DragDetectorDragStyle.TranslateLine | DragDetectorDragStyle.TranslatePlane | DragDetectorDragStyle.TranslatePlaneOrLine | DragDetectorDragStyle.TranslateLineOrPlane | DragDetectorDragStyle.TranslateViewPlane | DragDetectorDragStyle.RotateAxis | DragDetectorDragStyle.RotateTrackball | DragDetectorDragStyle.Scriptable | DragDetectorDragStyle.BestForDevice;
/**
* Used to control the permission level for which players can interact with a `DragDetector`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorPermissionPolicy)
*/
export namespace DragDetectorPermissionPolicy {
/**
* No players can interact with the `DragDetector`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorPermissionPolicy#Nobody)
*/
export interface Nobody extends globalThis.EnumItem {
Name: "Nobody";
Value: 0;
EnumType: typeof globalThis.Enum.DragDetectorPermissionPolicy;
}
export const Nobody: Nobody;
/**
* All players can interact with the `DragDetector`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorPermissionPolicy#Everybody)
*/
export interface Everybody extends globalThis.EnumItem {
Name: "Everybody";
Value: 1;
EnumType: typeof globalThis.Enum.DragDetectorPermissionPolicy;
}
export const Everybody: Everybody;
/**
* Invokes the function registered via `DragDetector:SetPermissionPolicyFunction()`, enabling/disabling the detector based on whether the function returns `true` or `false`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorPermissionPolicy#Scriptable)
*/
export interface Scriptable extends globalThis.EnumItem {
Name: "Scriptable";
Value: 2;
EnumType: typeof globalThis.Enum.DragDetectorPermissionPolicy;
}
export const Scriptable: Scriptable;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DragDetectorPermissionPolicy | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DragDetectorPermissionPolicy | undefined;
}
export type DragDetectorPermissionPolicy = DragDetectorPermissionPolicy.Nobody | DragDetectorPermissionPolicy.Everybody | DragDetectorPermissionPolicy.Scriptable;
/**
* Describes how the clicked object will be treated once the desired motion has been calculated.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorResponseStyle)
*/
export namespace DragDetectorResponseStyle {
/**
* For an `Anchored` object both inside the running experience and in Studio edit mode, the position/orientation of the object will be updated to exactly reflect the proposed motion. For an unanchored object, behavior is the same as for an anchored object; however, in a running experience, the object will be anchored at the start of the drag and restored to unanchored upon drag release.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorResponseStyle#Geometric)
*/
export interface Geometric extends globalThis.EnumItem {
Name: "Geometric";
Value: 0;
EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
}
export const Geometric: Geometric;
/**
* An `Anchored` object will default to **Geometric** behavior as it is not affected by forces. An unanchored object will be moved by constraint forces that attempt to bring it to the desired position and/or orientation given by the proposed motion.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorResponseStyle#Physical)
*/
export interface Physical extends globalThis.EnumItem {
Name: "Physical";
Value: 1;
EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
}
export const Physical: Physical;
/**
* The object will not move at all, but `DragFrame` will still be updated and you can respond to drag manipulation however you'd like.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DragDetectorResponseStyle#Custom)
*/
export interface Custom extends globalThis.EnumItem {
Name: "Custom";
Value: 2;
EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
}
export const Custom: Custom;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DragDetectorResponseStyle | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DragDetectorResponseStyle | undefined;
}
export type DragDetectorResponseStyle = DragDetectorResponseStyle.Geometric | DragDetectorResponseStyle.Physical | DragDetectorResponseStyle.Custom;
/**
* Determines the coordinate space used when dragging objects in Studio.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraggerCoordinateSpace)
*/
export namespace DraggerCoordinateSpace {
/**
* Dragging is performed relative to the object's local coordinate space.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraggerCoordinateSpace#Object)
*/
export interface Object extends globalThis.EnumItem {
Name: "Object";
Value: 0;
EnumType: typeof globalThis.Enum.DraggerCoordinateSpace;
}
export const Object: Object;
/**
* Dragging is performed relative to the world coordinate space.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraggerCoordinateSpace#World)
*/
export interface World extends globalThis.EnumItem {
Name: "World";
Value: 1;
EnumType: typeof globalThis.Enum.DraggerCoordinateSpace;
}
export const World: World;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DraggerCoordinateSpace | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DraggerCoordinateSpace | undefined;
}
export type DraggerCoordinateSpace = DraggerCoordinateSpace.Object | DraggerCoordinateSpace.World;
/**
* Controls whether `DraggerService` moves parts geometrically or with physics simulation during Studio drag operations.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraggerMovementMode)
*/
export namespace DraggerMovementMode {
/**
* Parts are moved by directly updating their position and orientation, ignoring physics and constraints.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraggerMovementMode#Geometric)
*/
export interface Geometric extends globalThis.EnumItem {
Name: "Geometric";
Value: 0;
EnumType: typeof globalThis.Enum.DraggerMovementMode;
}
export const Geometric: Geometric;
/**
* Parts are moved by applying physics impulses, so constraints and collisions are respected during the drag.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraggerMovementMode#Physical)
*/
export interface Physical extends globalThis.EnumItem {
Name: "Physical";
Value: 1;
EnumType: typeof globalThis.Enum.DraggerMovementMode;
}
export const Physical: Physical;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DraggerMovementMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DraggerMovementMode | undefined;
}
export type DraggerMovementMode = DraggerMovementMode.Geometric | DraggerMovementMode.Physical;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraggingScrollBar)
*/
export namespace DraggingScrollBar {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraggingScrollBar#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.DraggingScrollBar;
}
export const None: None;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraggingScrollBar#Horizontal)
*/
export interface Horizontal extends globalThis.EnumItem {
Name: "Horizontal";
Value: 1;
EnumType: typeof globalThis.Enum.DraggingScrollBar;
}
export const Horizontal: Horizontal;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DraggingScrollBar#Vertical)
*/
export interface Vertical extends globalThis.EnumItem {
Name: "Vertical";
Value: 2;
EnumType: typeof globalThis.Enum.DraggingScrollBar;
}
export const Vertical: Vertical;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DraggingScrollBar | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DraggingScrollBar | undefined;
}
export type DraggingScrollBar = DraggingScrollBar.None | DraggingScrollBar.Horizontal | DraggingScrollBar.Vertical;
/**
* Enum used with `TweenInfo.new()` to control the direction `Tweens` play in.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingDirection)
*/
export namespace EasingDirection {
/**
* The easing style is applied in a forward direction.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingDirection#In)
*/
export interface In extends globalThis.EnumItem {
Name: "In";
Value: 0;
EnumType: typeof globalThis.Enum.EasingDirection;
}
export const In: In;
/**
* The easing style is applied in a reverse direction.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingDirection#Out)
*/
export interface Out extends globalThis.EnumItem {
Name: "Out";
Value: 1;
EnumType: typeof globalThis.Enum.EasingDirection;
}
export const Out: Out;
/**
* The easing style is applied forward for the first half and in reverse for the second half.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingDirection#InOut)
*/
export interface InOut extends globalThis.EnumItem {
Name: "InOut";
Value: 2;
EnumType: typeof globalThis.Enum.EasingDirection;
}
export const InOut: InOut;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.EasingDirection | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.EasingDirection | undefined;
}
export type EasingDirection = EasingDirection.In | EasingDirection.Out | EasingDirection.InOut;
/**
* Enum used with `TweenInfo.new` to control the motion of a `Tween`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle)
*/
export namespace EasingStyle {
/**
* Moves at a constant speed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Linear)
*/
export interface Linear extends globalThis.EnumItem {
Name: "Linear";
Value: 0;
EnumType: typeof globalThis.Enum.EasingStyle;
}
export const Linear: Linear;
/**
* Speed is determined by a sine wave for a gentle easing motion.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Sine)
*/
export interface Sine extends globalThis.EnumItem {
Name: "Sine";
Value: 1;
EnumType: typeof globalThis.Enum.EasingStyle;
}
export const Sine: Sine;
/**
* Slightly overshoots the target, then backs into place.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Back)
*/
export interface Back extends globalThis.EnumItem {
Name: "Back";
Value: 2;
EnumType: typeof globalThis.Enum.EasingStyle;
}
export const Back: Back;
/**
* Similar to `Sine` but with a slightly sharper curve based on quadratic interpolation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Quad)
*/
export interface Quad extends globalThis.EnumItem {
Name: "Quad";
Value: 3;
EnumType: typeof globalThis.Enum.EasingStyle;
}
export const Quad: Quad;
/**
* Similar to `Cubic` but with an even sharper curve based on quartic interpolation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Quart)
*/
export interface Quart extends globalThis.EnumItem {
Name: "Quart";
Value: 4;
EnumType: typeof globalThis.Enum.EasingStyle;
}
export const Quart: Quart;
/**
* Similar to `Quart` but with an even sharper curve based on quintic interpolation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Quint)
*/
export interface Quint extends globalThis.EnumItem {
Name: "Quint";
Value: 5;
EnumType: typeof globalThis.Enum.EasingStyle;
}
export const Quint: Quint;
/**
* Bounces backwards multiple times after reaching the target, before eventually settling.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Bounce)
*/
export interface Bounce extends globalThis.EnumItem {
Name: "Bounce";
Value: 6;
EnumType: typeof globalThis.Enum.EasingStyle;
}
export const Bounce: Bounce;
/**
* Moves as if attached to a rubber band, overshooting the target several times.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Elastic)
*/
export interface Elastic extends globalThis.EnumItem {
Name: "Elastic";
Value: 7;
EnumType: typeof globalThis.Enum.EasingStyle;
}
export const Elastic: Elastic;
/**
* The sharpest curve based on exponential interpolation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Exponential)
*/
export interface Exponential extends globalThis.EnumItem {
Name: "Exponential";
Value: 8;
EnumType: typeof globalThis.Enum.EasingStyle;
}
export const Exponential: Exponential;
/**
* Follows a circular arc, such that acceleration is more sudden and deceleration more gradual versus `Quint` or `Exponential`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Circular)
*/
export interface Circular extends globalThis.EnumItem {
Name: "Circular";
Value: 9;
EnumType: typeof globalThis.Enum.EasingStyle;
}
export const Circular: Circular;
/**
* Similar to `Quad` but with a slightly sharper curve based on cubic interpolation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Cubic)
*/
export interface Cubic extends globalThis.EnumItem {
Name: "Cubic";
Value: 10;
EnumType: typeof globalThis.Enum.EasingStyle;
}
export const Cubic: Cubic;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.EasingStyle | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.EasingStyle | undefined;
}
export type EasingStyle = EasingStyle.Linear | EasingStyle.Sine | EasingStyle.Back | EasingStyle.Quad | EasingStyle.Quart | EasingStyle.Quint | EasingStyle.Bounce | EasingStyle.Elastic | EasingStyle.Exponential | EasingStyle.Circular | EasingStyle.Cubic;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EditableStatus)
*/
export namespace EditableStatus {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EditableStatus#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.EditableStatus;
}
export const Unknown: Unknown;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EditableStatus#Allowed)
*/
export interface Allowed extends globalThis.EnumItem {
Name: "Allowed";
Value: 1;
EnumType: typeof globalThis.Enum.EditableStatus;
}
export const Allowed: Allowed;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EditableStatus#Disallowed)
*/
export interface Disallowed extends globalThis.EnumItem {
Name: "Disallowed";
Value: 2;
EnumType: typeof globalThis.Enum.EditableStatus;
}
export const Disallowed: Disallowed;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.EditableStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.EditableStatus | undefined;
}
export type EditableStatus = EditableStatus.Unknown | EditableStatus.Allowed | EditableStatus.Disallowed;
/**
* This enum is used by `ScrollingFrame.ElasticBehavior` to control when elastic scrolling is active on touch‑enabled devices.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior)
*/
export namespace ElasticBehavior {
/**
* Scrolling is elastic when there is content to be scrolled to.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior#WhenScrollable)
*/
export interface WhenScrollable extends globalThis.EnumItem {
Name: "WhenScrollable";
Value: 0;
EnumType: typeof globalThis.Enum.ElasticBehavior;
}
export const WhenScrollable: WhenScrollable;
/**
* Scrolling is always elastic, even when there isn't content available to scroll to.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior#Always)
*/
export interface Always extends globalThis.EnumItem {
Name: "Always";
Value: 1;
EnumType: typeof globalThis.Enum.ElasticBehavior;
}
export const Always: Always;
/**
* Scrolling is never elastic and the canvas will never scroll beyond its bounds.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior#Never)
*/
export interface Never extends globalThis.EnumItem {
Name: "Never";
Value: 2;
EnumType: typeof globalThis.Enum.ElasticBehavior;
}
export const Never: Never;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ElasticBehavior | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ElasticBehavior | undefined;
}
export type ElasticBehavior = ElasticBehavior.WhenScrollable | ElasticBehavior.Always | ElasticBehavior.Never;
/**
* Defines where and how an `AudioEmitter` is positioned when sending out spatial audio.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EmitterPositionType)
*/
export namespace EmitterPositionType {
/**
* Uses the parent `Instance` of the `AudioEmitter`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EmitterPositionType#Parent)
*/
export interface Parent extends globalThis.EnumItem {
Name: "Parent";
Value: 0;
EnumType: typeof globalThis.Enum.EmitterPositionType;
}
export const Parent: Parent;
/**
* Uses a specified `Instance`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EmitterPositionType#Instance)
*/
export interface Instance extends globalThis.EnumItem {
Name: "Instance";
Value: 1;
EnumType: typeof globalThis.Enum.EmitterPositionType;
}
export const Instance: Instance;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.EmitterPositionType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.EmitterPositionType | undefined;
}
export type EmitterPositionType = EmitterPositionType.Parent | EmitterPositionType.Instance;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EngagementLevel)
*/
export namespace EngagementLevel {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EngagementLevel#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.EngagementLevel;
}
export const Unknown: Unknown;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EngagementLevel#Inactive)
*/
export interface Inactive extends globalThis.EnumItem {
Name: "Inactive";
Value: 1;
EnumType: typeof globalThis.Enum.EngagementLevel;
}
export const Inactive: Inactive;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EngagementLevel#Low)
*/
export interface Low extends globalThis.EnumItem {
Name: "Low";
Value: 2;
EnumType: typeof globalThis.Enum.EngagementLevel;
}
export const Low: Low;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EngagementLevel#Medium)
*/
export interface Medium extends globalThis.EnumItem {
Name: "Medium";
Value: 3;
EnumType: typeof globalThis.Enum.EngagementLevel;
}
export const Medium: Medium;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EngagementLevel#High)
*/
export interface High extends globalThis.EnumItem {
Name: "High";
Value: 4;
EnumType: typeof globalThis.Enum.EngagementLevel;
}
export const High: High;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.EngagementLevel | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.EngagementLevel | undefined;
}
export type EngagementLevel = EngagementLevel.Unknown | EngagementLevel.Inactive | EngagementLevel.Low | EngagementLevel.Medium | EngagementLevel.High;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EngineFolder)
*/
export namespace EngineFolder {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EngineFolder#Screenshots)
*/
export interface Screenshots extends globalThis.EnumItem {
Name: "Screenshots";
Value: 0;
EnumType: typeof globalThis.Enum.EngineFolder;
}
export const Screenshots: Screenshots;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EngineFolder#Videos)
*/
export interface Videos extends globalThis.EnumItem {
Name: "Videos";
Value: 1;
EnumType: typeof globalThis.Enum.EngineFolder;
}
export const Videos: Videos;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EngineFolder#Logs)
*/
export interface Logs extends globalThis.EnumItem {
Name: "Logs";
Value: 2;
EnumType: typeof globalThis.Enum.EngineFolder;
}
export const Logs: Logs;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.EngineFolder | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.EngineFolder | undefined;
}
export type EngineFolder = EngineFolder.Screenshots | EngineFolder.Videos | EngineFolder.Logs;
/**
* Used to control the throttle rate of Roblox's physics engine.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle)
*/
export namespace EnviromentalPhysicsThrottle {
/**
* Automatically adjusts throttle level based on performance.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#DefaultAuto)
*/
export interface DefaultAuto extends globalThis.EnumItem {
Name: "DefaultAuto";
Value: 0;
EnumType: typeof globalThis.Enum.EnviromentalPhysicsThrottle;
}
export const DefaultAuto: DefaultAuto;
/**
* No throttling; every physics step runs.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Disabled)
*/
export interface Disabled extends globalThis.EnumItem {
Name: "Disabled";
Value: 1;
EnumType: typeof globalThis.Enum.EnviromentalPhysicsThrottle;
}
export const Disabled: Disabled;
/**
* Maximum throttling; physics is effectively frozen.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Always)
*/
export interface Always extends globalThis.EnumItem {
Name: "Always";
Value: 2;
EnumType: typeof globalThis.Enum.EnviromentalPhysicsThrottle;
}
export const Always: Always;
/**
* Runs 1 out of every 2 steps (50% reduction). If `Workspace.PhysicsSteppingMethod` is set to `Adaptive`, skipping is based on groups of 4 steps instead of individual steps.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip2)
*/
export interface Skip2 extends globalThis.EnumItem {
Name: "Skip2";
Value: 3;
EnumType: typeof globalThis.Enum.EnviromentalPhysicsThrottle;
}
export const Skip2: Skip2;
/**
* Runs 1 out of every 4 steps (75% reduction). If `Workspace.PhysicsSteppingMethod` is set to `Adaptive`, skipping is based on groups of 4 steps instead of individual steps.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip4)
*/
export interface Skip4 extends globalThis.EnumItem {
Name: "Skip4";
Value: 4;
EnumType: typeof globalThis.Enum.EnviromentalPhysicsThrottle;
}
export const Skip4: Skip4;
/**
* Runs 1 out of every 8 steps (87.5% reduction). If `Workspace.PhysicsSteppingMethod` is set to `Adaptive`, skipping is based on groups of 4 steps instead of individual steps.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip8)
*/
export interface Skip8 extends globalThis.EnumItem {
Name: "Skip8";
Value: 5;
EnumType: typeof globalThis.Enum.EnviromentalPhysicsThrottle;
}
export const Skip8: Skip8;
/**
* Runs 1 out of every 16 steps (93.75% reduction). If `Workspace.PhysicsSteppingMethod` is set to `Adaptive`, skipping is based on groups of 4 steps instead of individual steps.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip16)
*/
export interface Skip16 extends globalThis.EnumItem {
Name: "Skip16";
Value: 6;
EnumType: typeof globalThis.Enum.EnviromentalPhysicsThrottle;
}
export const Skip16: Skip16;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.EnviromentalPhysicsThrottle | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.EnviromentalPhysicsThrottle | undefined;
}
export type EnviromentalPhysicsThrottle = EnviromentalPhysicsThrottle.DefaultAuto | EnviromentalPhysicsThrottle.Disabled | EnviromentalPhysicsThrottle.Always | EnviromentalPhysicsThrottle.Skip2 | EnviromentalPhysicsThrottle.Skip4 | EnviromentalPhysicsThrottle.Skip8 | EnviromentalPhysicsThrottle.Skip16;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceActivationStatus)
*/
export namespace ExperienceActivationStatus {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceActivationStatus#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.ExperienceActivationStatus;
}
export const Unknown: Unknown;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceActivationStatus#New)
*/
export interface New extends globalThis.EnumItem {
Name: "New";
Value: 1;
EnumType: typeof globalThis.Enum.ExperienceActivationStatus;
}
export const New: New;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceActivationStatus#Active)
*/
export interface Active extends globalThis.EnumItem {
Name: "Active";
Value: 2;
EnumType: typeof globalThis.Enum.ExperienceActivationStatus;
}
export const Active: Active;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceActivationStatus#Lapsed)
*/
export interface Lapsed extends globalThis.EnumItem {
Name: "Lapsed";
Value: 3;
EnumType: typeof globalThis.Enum.ExperienceActivationStatus;
}
export const Lapsed: Lapsed;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceActivationStatus#Reactivated)
*/
export interface Reactivated extends globalThis.EnumItem {
Name: "Reactivated";
Value: 4;
EnumType: typeof globalThis.Enum.ExperienceActivationStatus;
}
export const Reactivated: Reactivated;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ExperienceActivationStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ExperienceActivationStatus | undefined;
}
export type ExperienceActivationStatus = ExperienceActivationStatus.Unknown | ExperienceActivationStatus.New | ExperienceActivationStatus.Active | ExperienceActivationStatus.Lapsed | ExperienceActivationStatus.Reactivated;
/**
* Enumerates the authorization scopes an experience can request when prompting a creator for permission to access their assets.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceAuthScope)
*/
export namespace ExperienceAuthScope {
/**
* The base scope (value `0`) representing no additional permissions; used internally when no specific asset authorization is required.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceAuthScope#DefaultScope)
*/
export interface DefaultScope extends globalThis.EnumItem {
Name: "DefaultScope";
Value: 0;
EnumType: typeof globalThis.Enum.ExperienceAuthScope;
}
export const DefaultScope: DefaultScope;
/**
* Requests read and write access to the creator's assets; maps to the `asset:*:read,write` authorization token scope.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceAuthScope#CreatorAssetsCreate)
*/
export interface CreatorAssetsCreate extends globalThis.EnumItem {
Name: "CreatorAssetsCreate";
Value: 1;
EnumType: typeof globalThis.Enum.ExperienceAuthScope;
}
export const CreatorAssetsCreate: CreatorAssetsCreate;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ExperienceAuthScope | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ExperienceAuthScope | undefined;
}
export type ExperienceAuthScope = ExperienceAuthScope.DefaultScope | ExperienceAuthScope.CreatorAssetsCreate;
/**
* Describes the lifecycle state of a Roblox experience event as returned by `SocialService`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus)
*/
export namespace ExperienceEventStatus {
/**
* The event is currently published and available.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus#Active)
*/
export interface Active extends globalThis.EnumItem {
Name: "Active";
Value: 0;
EnumType: typeof globalThis.Enum.ExperienceEventStatus;
}
export const Active: Active;
/**
* The event has been cancelled and will not occur.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus#Cancelled)
*/
export interface Cancelled extends globalThis.EnumItem {
Name: "Cancelled";
Value: 1;
EnumType: typeof globalThis.Enum.ExperienceEventStatus;
}
export const Cancelled: Cancelled;
/**
* The event has been removed by moderation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus#Moderated)
*/
export interface Moderated extends globalThis.EnumItem {
Name: "Moderated";
Value: 2;
EnumType: typeof globalThis.Enum.ExperienceEventStatus;
}
export const Moderated: Moderated;
/**
* The event has been unpublished by the creator.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus#Unpublished)
*/
export interface Unpublished extends globalThis.EnumItem {
Name: "Unpublished";
Value: 3;
EnumType: typeof globalThis.Enum.ExperienceEventStatus;
}
export const Unpublished: Unpublished;
/**
* The event status could not be determined.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 4;
EnumType: typeof globalThis.Enum.ExperienceEventStatus;
}
export const Unknown: Unknown;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ExperienceEventStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ExperienceEventStatus | undefined;
}
export type ExperienceEventStatus = ExperienceEventStatus.Active | ExperienceEventStatus.Cancelled | ExperienceEventStatus.Moderated | ExperienceEventStatus.Unpublished | ExperienceEventStatus.Unknown;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateCaptureSelectionMode)
*/
export namespace ExperienceStateCaptureSelectionMode {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateCaptureSelectionMode#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.ExperienceStateCaptureSelectionMode;
}
export const Default: Default;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateCaptureSelectionMode#SafetyHighlightMode)
*/
export interface SafetyHighlightMode extends globalThis.EnumItem {
Name: "SafetyHighlightMode";
Value: 1;
EnumType: typeof globalThis.Enum.ExperienceStateCaptureSelectionMode;
}
export const SafetyHighlightMode: SafetyHighlightMode;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ExperienceStateCaptureSelectionMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ExperienceStateCaptureSelectionMode | undefined;
}
export type ExperienceStateCaptureSelectionMode = ExperienceStateCaptureSelectionMode.Default | ExperienceStateCaptureSelectionMode.SafetyHighlightMode;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingLoadMode)
*/
export namespace ExperienceStateRecordingLoadMode {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingLoadMode#NewReplay)
*/
export interface NewReplay extends globalThis.EnumItem {
Name: "NewReplay";
Value: 0;
EnumType: typeof globalThis.Enum.ExperienceStateRecordingLoadMode;
}
export const NewReplay: NewReplay;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingLoadMode#ContiguousSlice)
*/
export interface ContiguousSlice extends globalThis.EnumItem {
Name: "ContiguousSlice";
Value: 1;
EnumType: typeof globalThis.Enum.ExperienceStateRecordingLoadMode;
}
export const ContiguousSlice: ContiguousSlice;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingLoadMode#NoncontiguousSlice)
*/
export interface NoncontiguousSlice extends globalThis.EnumItem {
Name: "NoncontiguousSlice";
Value: 2;
EnumType: typeof globalThis.Enum.ExperienceStateRecordingLoadMode;
}
export const NoncontiguousSlice: NoncontiguousSlice;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ExperienceStateRecordingLoadMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ExperienceStateRecordingLoadMode | undefined;
}
export type ExperienceStateRecordingLoadMode = ExperienceStateRecordingLoadMode.NewReplay | ExperienceStateRecordingLoadMode.ContiguousSlice | ExperienceStateRecordingLoadMode.NoncontiguousSlice;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingLoadSourceType)
*/
export namespace ExperienceStateRecordingLoadSourceType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingLoadSourceType#S3Url)
*/
export interface S3Url extends globalThis.EnumItem {
Name: "S3Url";
Value: 0;
EnumType: typeof globalThis.Enum.ExperienceStateRecordingLoadSourceType;
}
export const S3Url: S3Url;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingLoadSourceType#File)
*/
export interface File extends globalThis.EnumItem {
Name: "File";
Value: 1;
EnumType: typeof globalThis.Enum.ExperienceStateRecordingLoadSourceType;
}
export const File: File;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ExperienceStateRecordingLoadSourceType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ExperienceStateRecordingLoadSourceType | undefined;
}
export type ExperienceStateRecordingLoadSourceType = ExperienceStateRecordingLoadSourceType.S3Url | ExperienceStateRecordingLoadSourceType.File;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingPlaybackMode)
*/
export namespace ExperienceStateRecordingPlaybackMode {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingPlaybackMode#Undefined)
*/
export interface Undefined extends globalThis.EnumItem {
Name: "Undefined";
Value: 0;
EnumType: typeof globalThis.Enum.ExperienceStateRecordingPlaybackMode;
}
export const Undefined: Undefined;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingPlaybackMode#Stopped)
*/
export interface Stopped extends globalThis.EnumItem {
Name: "Stopped";
Value: 1;
EnumType: typeof globalThis.Enum.ExperienceStateRecordingPlaybackMode;
}
export const Stopped: Stopped;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingPlaybackMode#Playing)
*/
export interface Playing extends globalThis.EnumItem {
Name: "Playing";
Value: 2;
EnumType: typeof globalThis.Enum.ExperienceStateRecordingPlaybackMode;
}
export const Playing: Playing;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingPlaybackMode#Rewinding)
*/
export interface Rewinding extends globalThis.EnumItem {
Name: "Rewinding";
Value: 3;
EnumType: typeof globalThis.Enum.ExperienceStateRecordingPlaybackMode;
}
export const Rewinding: Rewinding;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ExperienceStateRecordingPlaybackMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ExperienceStateRecordingPlaybackMode | undefined;
}
export type ExperienceStateRecordingPlaybackMode = ExperienceStateRecordingPlaybackMode.Undefined | ExperienceStateRecordingPlaybackMode.Stopped | ExperienceStateRecordingPlaybackMode.Playing | ExperienceStateRecordingPlaybackMode.Rewinding;
/**
* Determines whether an `Explosion` creates craters when it detonates.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExplosionType)
*/
export namespace ExplosionType {
/**
* Explosion does not generate craters.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExplosionType#NoCraters)
*/
export interface NoCraters extends globalThis.EnumItem {
Name: "NoCraters";
Value: 0;
EnumType: typeof globalThis.Enum.ExplosionType;
}
export const NoCraters: NoCraters;
/**
* Explosion generates craters.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExplosionType#Craters)
*/
export interface Craters extends globalThis.EnumItem {
Name: "Craters";
Value: 1;
EnumType: typeof globalThis.Enum.ExplosionType;
}
export const Craters: Craters;
/**
* @deprecated renamed to Craters
*/
export const CratersAndDebris: Craters;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ExplosionType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ExplosionType | undefined;
}
export type ExplosionType = ExplosionType.NoCraters | ExplosionType.Craters;
/**
* Controls whether Roblox Studio opens scripts in the operating system's default editor or in a user-selected external editor.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExternalEditorMode)
*/
export namespace ExternalEditorMode {
/**
* Studio opens scripts using the operating system's default application for the file type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExternalEditorMode#SystemDefault)
*/
export interface SystemDefault extends globalThis.EnumItem {
Name: "SystemDefault";
Value: 0;
EnumType: typeof globalThis.Enum.ExternalEditorMode;
}
export const SystemDefault: SystemDefault;
/**
* Studio opens scripts using the external editor executable specified in `Studio.ExternalEditorSelection`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExternalEditorMode#UserSelectedEditor)
*/
export interface UserSelectedEditor extends globalThis.EnumItem {
Name: "UserSelectedEditor";
Value: 1;
EnumType: typeof globalThis.Enum.ExternalEditorMode;
}
export const UserSelectedEditor: UserSelectedEditor;
/**
* @deprecated renamed to UserSelectedEditor
*/
export const CustomEditor: UserSelectedEditor;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ExternalEditorMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ExternalEditorMode | undefined;
}
export type ExternalEditorMode = ExternalEditorMode.SystemDefault | ExternalEditorMode.UserSelectedEditor;
/**
* Specifies the level of detail for FACS blendshape data transmitted by the face tracking system.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FACSDataLod)
*/
export namespace FACSDataLod {
/**
* Full-fidelity FACS data transmitting all 50 blendshape controls.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FACSDataLod#LOD0)
*/
export interface LOD0 extends globalThis.EnumItem {
Name: "LOD0";
Value: 0;
EnumType: typeof globalThis.Enum.FACSDataLod;
}
export const LOD0: LOD0;
/**
* Reduced FACS data transmitting 6 blendshape controls: JawDrop, RightEyeClosed, LeftEyeClosed, RightLipCornerPuller, LeftLipCornerPuller, and Pucker.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FACSDataLod#LOD1)
*/
export interface LOD1 extends globalThis.EnumItem {
Name: "LOD1";
Value: 1;
EnumType: typeof globalThis.Enum.FACSDataLod;
}
export const LOD1: LOD1;
/**
* Sentinel value equal to the total number of FACSDataLod levels; not a valid LOD to assign.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FACSDataLod#LODCount)
*/
export interface LODCount extends globalThis.EnumItem {
Name: "LODCount";
Value: 2;
EnumType: typeof globalThis.Enum.FACSDataLod;
}
export const LODCount: LODCount;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FACSDataLod | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FACSDataLod | undefined;
}
export type FACSDataLod = FACSDataLod.LOD0 | FACSDataLod.LOD1 | FACSDataLod.LODCount;
/**
* Describes the outcome of a facial age estimation inquiry initiated by `FacialAgeEstimationService`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacialAgeEstimationResultType)
*/
export namespace FacialAgeEstimationResultType {
/**
* The facial age estimation inquiry finished successfully.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacialAgeEstimationResultType#Complete)
*/
export interface Complete extends globalThis.EnumItem {
Name: "Complete";
Value: 0;
EnumType: typeof globalThis.Enum.FacialAgeEstimationResultType;
}
export const Complete: Complete;
/**
* The facial age estimation inquiry was cancelled before it could complete.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacialAgeEstimationResultType#Cancel)
*/
export interface Cancel extends globalThis.EnumItem {
Name: "Cancel";
Value: 1;
EnumType: typeof globalThis.Enum.FacialAgeEstimationResultType;
}
export const Cancel: Cancel;
/**
* The facial age estimation inquiry failed due to an error.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacialAgeEstimationResultType#Error)
*/
export interface Error extends globalThis.EnumItem {
Name: "Error";
Value: 2;
EnumType: typeof globalThis.Enum.FacialAgeEstimationResultType;
}
export const Error: Error;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FacialAgeEstimationResultType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FacialAgeEstimationResultType | undefined;
}
export type FacialAgeEstimationResultType = FacialAgeEstimationResultType.Complete | FacialAgeEstimationResultType.Cancel | FacialAgeEstimationResultType.Error;
/**
* A bitmask enum describing which facial animation streaming capabilities are active for a user or service.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState)
*/
export namespace FacialAnimationStreamingState {
/**
* Indicates that no facial animation streaming is active.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState#None)
*/
export interface None extends globalThis.EnumItem {
Name: "None";
Value: 0;
EnumType: typeof globalThis.Enum.FacialAnimationStreamingState;
}
export const None: None;
/**
* Indicates that audio-based facial animation streaming is enabled for the user.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState#Audio)
*/
export interface Audio extends globalThis.EnumItem {
Name: "Audio";
Value: 1;
EnumType: typeof globalThis.Enum.FacialAnimationStreamingState;
}
export const Audio: Audio;
/**
* Indicates that video-based facial animation streaming is enabled for the user.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState#Video)
*/
export interface Video extends globalThis.EnumItem {
Name: "Video";
Value: 2;
EnumType: typeof globalThis.Enum.FacialAnimationStreamingState;
}
export const Video: Video;
/**
* Indicates that facial animation streaming is enabled at the place level.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState#Place)
*/
export interface Place extends globalThis.EnumItem {
Name: "Place";
Value: 4;
EnumType: typeof globalThis.Enum.FacialAnimationStreamingState;
}
export const Place: Place;
/**
* Indicates that facial animation streaming is enabled at the server level.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState#Server)
*/
export interface Server extends globalThis.EnumItem {
Name: "Server";
Value: 8;
EnumType: typeof globalThis.Enum.FacialAnimationStreamingState;
}
export const Server: Server;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FacialAnimationStreamingState | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FacialAnimationStreamingState | undefined;
}
export type FacialAnimationStreamingState = FacialAnimationStreamingState.None | FacialAnimationStreamingState.Audio | FacialAnimationStreamingState.Video | FacialAnimationStreamingState.Place | FacialAnimationStreamingState.Server;
/**
* Identifies a Facial Action Coding System pose for facial animation.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit)
*/
export namespace FacsActionUnit {
/**
* Moves the upper lip upward when the chin raiser is engaged.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#ChinRaiserUpperLip)
*/
export interface ChinRaiserUpperLip extends globalThis.EnumItem {
Name: "ChinRaiserUpperLip";
Value: 0;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const ChinRaiserUpperLip: ChinRaiserUpperLip;
/**
* Raises the chin and moves the lower lip upward.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#ChinRaiser)
*/
export interface ChinRaiser extends globalThis.EnumItem {
Name: "ChinRaiser";
Value: 1;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const ChinRaiser: ChinRaiser;
/**
* Moves the mouth corners inward and presses the lips against the teeth.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#FlatPucker)
*/
export interface FlatPucker extends globalThis.EnumItem {
Name: "FlatPucker";
Value: 2;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const FlatPucker: FlatPucker;
/**
* Forms an O shape with the mouth.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#Funneler)
*/
export interface Funneler extends globalThis.EnumItem {
Name: "Funneler";
Value: 3;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const Funneler: Funneler;
/**
* Rolls the lower lip over the teeth.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LowerLipSuck)
*/
export interface LowerLipSuck extends globalThis.EnumItem {
Name: "LowerLipSuck";
Value: 4;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LowerLipSuck: LowerLipSuck;
/**
* Presses the lips together.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LipPresser)
*/
export interface LipPresser extends globalThis.EnumItem {
Name: "LipPresser";
Value: 5;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LipPresser: LipPresser;
/**
* Brings the lips together relative to the jaw-drop pose.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LipsTogether)
*/
export interface LipsTogether extends globalThis.EnumItem {
Name: "LipsTogether";
Value: 6;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LipsTogether: LipsTogether;
/**
* Moves the mouth to the character's left.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#MouthLeft)
*/
export interface MouthLeft extends globalThis.EnumItem {
Name: "MouthLeft";
Value: 7;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const MouthLeft: MouthLeft;
/**
* Moves the mouth to the character's right.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#MouthRight)
*/
export interface MouthRight extends globalThis.EnumItem {
Name: "MouthRight";
Value: 8;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const MouthRight: MouthRight;
/**
* Puckers the lips into a kiss-like shape.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#Pucker)
*/
export interface Pucker extends globalThis.EnumItem {
Name: "Pucker";
Value: 9;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const Pucker: Pucker;
/**
* Rolls the upper lip over the teeth.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#UpperLipSuck)
*/
export interface UpperLipSuck extends globalThis.EnumItem {
Name: "UpperLipSuck";
Value: 10;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const UpperLipSuck: UpperLipSuck;
/**
* Puffs the left cheek.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftCheekPuff)
*/
export interface LeftCheekPuff extends globalThis.EnumItem {
Name: "LeftCheekPuff";
Value: 11;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftCheekPuff: LeftCheekPuff;
/**
* Moves the left mouth corner backward to form a dimple.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftDimpler)
*/
export interface LeftDimpler extends globalThis.EnumItem {
Name: "LeftDimpler";
Value: 12;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftDimpler: LeftDimpler;
/**
* Lowers the left mouth corner into a frown.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftLipCornerDown)
*/
export interface LeftLipCornerDown extends globalThis.EnumItem {
Name: "LeftLipCornerDown";
Value: 13;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftLipCornerDown: LeftLipCornerDown;
/**
* Lowers the left side of the lower lip to reveal the lower teeth.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftLowerLipDepressor)
*/
export interface LeftLowerLipDepressor extends globalThis.EnumItem {
Name: "LeftLowerLipDepressor";
Value: 14;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftLowerLipDepressor: LeftLowerLipDepressor;
/**
* Raises the left mouth corner into a smile.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftLipCornerPuller)
*/
export interface LeftLipCornerPuller extends globalThis.EnumItem {
Name: "LeftLipCornerPuller";
Value: 15;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftLipCornerPuller: LeftLipCornerPuller;
/**
* Stretches the left mouth corner outward.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftLipStretcher)
*/
export interface LeftLipStretcher extends globalThis.EnumItem {
Name: "LeftLipStretcher";
Value: 16;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftLipStretcher: LeftLipStretcher;
/**
* Raises the left side of the upper lip to reveal the upper teeth.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftUpperLipRaiser)
*/
export interface LeftUpperLipRaiser extends globalThis.EnumItem {
Name: "LeftUpperLipRaiser";
Value: 17;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftUpperLipRaiser: LeftUpperLipRaiser;
/**
* Puffs the right cheek.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightCheekPuff)
*/
export interface RightCheekPuff extends globalThis.EnumItem {
Name: "RightCheekPuff";
Value: 18;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightCheekPuff: RightCheekPuff;
/**
* Moves the right mouth corner backward to form a dimple.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightDimpler)
*/
export interface RightDimpler extends globalThis.EnumItem {
Name: "RightDimpler";
Value: 19;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightDimpler: RightDimpler;
/**
* Lowers the right mouth corner into a frown.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightLipCornerDown)
*/
export interface RightLipCornerDown extends globalThis.EnumItem {
Name: "RightLipCornerDown";
Value: 20;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightLipCornerDown: RightLipCornerDown;
/**
* Lowers the right side of the lower lip to reveal the lower teeth.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightLowerLipDepressor)
*/
export interface RightLowerLipDepressor extends globalThis.EnumItem {
Name: "RightLowerLipDepressor";
Value: 21;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightLowerLipDepressor: RightLowerLipDepressor;
/**
* Raises the right mouth corner into a smile.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightLipCornerPuller)
*/
export interface RightLipCornerPuller extends globalThis.EnumItem {
Name: "RightLipCornerPuller";
Value: 22;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightLipCornerPuller: RightLipCornerPuller;
/**
* Stretches the right mouth corner outward.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightLipStretcher)
*/
export interface RightLipStretcher extends globalThis.EnumItem {
Name: "RightLipStretcher";
Value: 23;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightLipStretcher: RightLipStretcher;
/**
* Raises the right side of the upper lip to reveal the upper teeth.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightUpperLipRaiser)
*/
export interface RightUpperLipRaiser extends globalThis.EnumItem {
Name: "RightUpperLipRaiser";
Value: 24;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightUpperLipRaiser: RightUpperLipRaiser;
/**
* Lowers the jaw to open the mouth.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#JawDrop)
*/
export interface JawDrop extends globalThis.EnumItem {
Name: "JawDrop";
Value: 25;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const JawDrop: JawDrop;
/**
* Moves the mouth and jaw toward the character's left.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#JawLeft)
*/
export interface JawLeft extends globalThis.EnumItem {
Name: "JawLeft";
Value: 26;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const JawLeft: JawLeft;
/**
* Moves the mouth and jaw toward the character's right.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#JawRight)
*/
export interface JawRight extends globalThis.EnumItem {
Name: "JawRight";
Value: 27;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const JawRight: JawRight;
/**
* Moves the left and right eyebrows inward.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#Corrugator)
*/
export interface Corrugator extends globalThis.EnumItem {
Name: "Corrugator";
Value: 28;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const Corrugator: Corrugator;
/**
* Lowers the left eyebrow.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftBrowLowerer)
*/
export interface LeftBrowLowerer extends globalThis.EnumItem {
Name: "LeftBrowLowerer";
Value: 29;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftBrowLowerer: LeftBrowLowerer;
/**
* Raises the outer part of the left eyebrow.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftOuterBrowRaiser)
*/
export interface LeftOuterBrowRaiser extends globalThis.EnumItem {
Name: "LeftOuterBrowRaiser";
Value: 30;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftOuterBrowRaiser: LeftOuterBrowRaiser;
/**
* Raises the left nostril and wrinkles the left side of the nose.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftNoseWrinkler)
*/
export interface LeftNoseWrinkler extends globalThis.EnumItem {
Name: "LeftNoseWrinkler";
Value: 31;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftNoseWrinkler: LeftNoseWrinkler;
/**
* Raises the inner half of the left eyebrow.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftInnerBrowRaiser)
*/
export interface LeftInnerBrowRaiser extends globalThis.EnumItem {
Name: "LeftInnerBrowRaiser";
Value: 32;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftInnerBrowRaiser: LeftInnerBrowRaiser;
/**
* Lowers the right eyebrow.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightBrowLowerer)
*/
export interface RightBrowLowerer extends globalThis.EnumItem {
Name: "RightBrowLowerer";
Value: 33;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightBrowLowerer: RightBrowLowerer;
/**
* Raises the outer part of the right eyebrow.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightOuterBrowRaiser)
*/
export interface RightOuterBrowRaiser extends globalThis.EnumItem {
Name: "RightOuterBrowRaiser";
Value: 34;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightOuterBrowRaiser: RightOuterBrowRaiser;
/**
* Raises the inner half of the right eyebrow.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightInnerBrowRaiser)
*/
export interface RightInnerBrowRaiser extends globalThis.EnumItem {
Name: "RightInnerBrowRaiser";
Value: 35;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightInnerBrowRaiser: RightInnerBrowRaiser;
/**
* Raises the right nostril and wrinkles the right side of the nose.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightNoseWrinkler)
*/
export interface RightNoseWrinkler extends globalThis.EnumItem {
Name: "RightNoseWrinkler";
Value: 36;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightNoseWrinkler: RightNoseWrinkler;
/**
* Moves the gaze downward.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#EyesLookDown)
*/
export interface EyesLookDown extends globalThis.EnumItem {
Name: "EyesLookDown";
Value: 37;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const EyesLookDown: EyesLookDown;
/**
* Moves the gaze to the left.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#EyesLookLeft)
*/
export interface EyesLookLeft extends globalThis.EnumItem {
Name: "EyesLookLeft";
Value: 38;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const EyesLookLeft: EyesLookLeft;
/**
* Moves the gaze upward.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#EyesLookUp)
*/
export interface EyesLookUp extends globalThis.EnumItem {
Name: "EyesLookUp";
Value: 39;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const EyesLookUp: EyesLookUp;
/**
* Moves the gaze to the right.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#EyesLookRight)
*/
export interface EyesLookRight extends globalThis.EnumItem {
Name: "EyesLookRight";
Value: 40;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const EyesLookRight: EyesLookRight;
/**
* Raises the left cheek and squints the left eye.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftCheekRaiser)
*/
export interface LeftCheekRaiser extends globalThis.EnumItem {
Name: "LeftCheekRaiser";
Value: 41;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftCheekRaiser: LeftCheekRaiser;
/**
* Raises the left upper eyelid to reveal more of the eye above the iris.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftEyeUpperLidRaiser)
*/
export interface LeftEyeUpperLidRaiser extends globalThis.EnumItem {
Name: "LeftEyeUpperLidRaiser";
Value: 42;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftEyeUpperLidRaiser: LeftEyeUpperLidRaiser;
/**
* Closes the left eyelid.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftEyeClosed)
*/
export interface LeftEyeClosed extends globalThis.EnumItem {
Name: "LeftEyeClosed";
Value: 43;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const LeftEyeClosed: LeftEyeClosed;
/**
* Raises the right cheek and squints the right eye.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightCheekRaiser)
*/
export interface RightCheekRaiser extends globalThis.EnumItem {
Name: "RightCheekRaiser";
Value: 44;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightCheekRaiser: RightCheekRaiser;
/**
* Raises the right upper eyelid to reveal more of the eye above the iris.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightEyeUpperLidRaiser)
*/
export interface RightEyeUpperLidRaiser extends globalThis.EnumItem {
Name: "RightEyeUpperLidRaiser";
Value: 45;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightEyeUpperLidRaiser: RightEyeUpperLidRaiser;
/**
* Closes the right eyelid.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightEyeClosed)
*/
export interface RightEyeClosed extends globalThis.EnumItem {
Name: "RightEyeClosed";
Value: 46;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const RightEyeClosed: RightEyeClosed;
/**
* Bends the tongue downward.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#TongueDown)
*/
export interface TongueDown extends globalThis.EnumItem {
Name: "TongueDown";
Value: 47;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const TongueDown: TongueDown;
/**
* Extends the tip of the tongue out of the mouth.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#TongueOut)
*/
export interface TongueOut extends globalThis.EnumItem {
Name: "TongueOut";
Value: 48;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const TongueOut: TongueOut;
/**
* Bends the tongue upward.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#TongueUp)
*/
export interface TongueUp extends globalThis.EnumItem {
Name: "TongueUp";
Value: 49;
EnumType: typeof globalThis.Enum.FacsActionUnit;
}
export const TongueUp: TongueUp;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FacsActionUnit | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FacsActionUnit | undefined;
}
export type FacsActionUnit = FacsActionUnit.ChinRaiserUpperLip | FacsActionUnit.ChinRaiser | FacsActionUnit.FlatPucker | FacsActionUnit.Funneler | FacsActionUnit.LowerLipSuck | FacsActionUnit.LipPresser | FacsActionUnit.LipsTogether | FacsActionUnit.MouthLeft | FacsActionUnit.MouthRight | FacsActionUnit.Pucker | FacsActionUnit.UpperLipSuck | FacsActionUnit.LeftCheekPuff | FacsActionUnit.LeftDimpler | FacsActionUnit.LeftLipCornerDown | FacsActionUnit.LeftLowerLipDepressor | FacsActionUnit.LeftLipCornerPuller | FacsActionUnit.LeftLipStretcher | FacsActionUnit.LeftUpperLipRaiser | FacsActionUnit.RightCheekPuff | FacsActionUnit.RightDimpler | FacsActionUnit.RightLipCornerDown | FacsActionUnit.RightLowerLipDepressor | FacsActionUnit.RightLipCornerPuller | FacsActionUnit.RightLipStretcher | FacsActionUnit.RightUpperLipRaiser | FacsActionUnit.JawDrop | FacsActionUnit.JawLeft | FacsActionUnit.JawRight | FacsActionUnit.Corrugator | FacsActionUnit.LeftBrowLowerer | FacsActionUnit.LeftOuterBrowRaiser | FacsActionUnit.LeftNoseWrinkler | FacsActionUnit.LeftInnerBrowRaiser | FacsActionUnit.RightBrowLowerer | FacsActionUnit.RightOuterBrowRaiser | FacsActionUnit.RightInnerBrowRaiser | FacsActionUnit.RightNoseWrinkler | FacsActionUnit.EyesLookDown | FacsActionUnit.EyesLookLeft | FacsActionUnit.EyesLookUp | FacsActionUnit.EyesLookRight | FacsActionUnit.LeftCheekRaiser | FacsActionUnit.LeftEyeUpperLidRaiser | FacsActionUnit.LeftEyeClosed | FacsActionUnit.RightCheekRaiser | FacsActionUnit.RightEyeUpperLidRaiser | FacsActionUnit.RightEyeClosed | FacsActionUnit.TongueDown | FacsActionUnit.TongueOut | FacsActionUnit.TongueUp;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeatureRestrictionAbuseVector)
*/
export namespace FeatureRestrictionAbuseVector {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeatureRestrictionAbuseVector#ExperienceChat)
*/
export interface ExperienceChat extends globalThis.EnumItem {
Name: "ExperienceChat";
Value: 0;
EnumType: typeof globalThis.Enum.FeatureRestrictionAbuseVector;
}
export const ExperienceChat: ExperienceChat;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeatureRestrictionAbuseVector#Communication)
*/
export interface Communication extends globalThis.EnumItem {
Name: "Communication";
Value: 1;
EnumType: typeof globalThis.Enum.FeatureRestrictionAbuseVector;
}
export const Communication: Communication;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FeatureRestrictionAbuseVector | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FeatureRestrictionAbuseVector | undefined;
}
export type FeatureRestrictionAbuseVector = FeatureRestrictionAbuseVector.ExperienceChat | FeatureRestrictionAbuseVector.Communication;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeedbackType)
*/
export namespace FeedbackType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeedbackType#Feedback)
*/
export interface Feedback extends globalThis.EnumItem {
Name: "Feedback";
Value: 0;
EnumType: typeof globalThis.Enum.FeedbackType;
}
export const Feedback: Feedback;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeedbackType#PlayerSupport)
*/
export interface PlayerSupport extends globalThis.EnumItem {
Name: "PlayerSupport";
Value: 1;
EnumType: typeof globalThis.Enum.FeedbackType;
}
export const PlayerSupport: PlayerSupport;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FeedbackType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FeedbackType | undefined;
}
export type FeedbackType = FeedbackType.Feedback | FeedbackType.PlayerSupport;
/**
* Determines which field-of-view angle a `Camera` holds constant when the viewport is resized.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FieldOfViewMode)
*/
export namespace FieldOfViewMode {
/**
* The camera holds its vertical field of view constant when the viewport is resized.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FieldOfViewMode#Vertical)
*/
export interface Vertical extends globalThis.EnumItem {
Name: "Vertical";
Value: 0;
EnumType: typeof globalThis.Enum.FieldOfViewMode;
}
export const Vertical: Vertical;
/**
* The camera holds its diagonal field of view constant when the viewport is resized.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FieldOfViewMode#Diagonal)
*/
export interface Diagonal extends globalThis.EnumItem {
Name: "Diagonal";
Value: 1;
EnumType: typeof globalThis.Enum.FieldOfViewMode;
}
export const Diagonal: Diagonal;
/**
* The camera holds the field of view along the longer viewport axis constant when the viewport is resized.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FieldOfViewMode#MaxAxis)
*/
export interface MaxAxis extends globalThis.EnumItem {
Name: "MaxAxis";
Value: 2;
EnumType: typeof globalThis.Enum.FieldOfViewMode;
}
export const MaxAxis: MaxAxis;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FieldOfViewMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FieldOfViewMode | undefined;
}
export type FieldOfViewMode = FieldOfViewMode.Vertical | FieldOfViewMode.Diagonal | FieldOfViewMode.MaxAxis;
/**
* Used by `UIGridStyleLayout.FillDirection` to control which direction elements are placed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FillDirection)
*/
export namespace FillDirection {
/**
* Fill in the left-to-right direction.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FillDirection#Horizontal)
*/
export interface Horizontal extends globalThis.EnumItem {
Name: "Horizontal";
Value: 0;
EnumType: typeof globalThis.Enum.FillDirection;
}
export const Horizontal: Horizontal;
/**
* Fill in the top-to-bottom direction.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FillDirection#Vertical)
*/
export interface Vertical extends globalThis.EnumItem {
Name: "Vertical";
Value: 1;
EnumType: typeof globalThis.Enum.FillDirection;
}
export const Vertical: Vertical;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FillDirection | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FillDirection | undefined;
}
export type FillDirection = FillDirection.Horizontal | FillDirection.Vertical;
/**
* Identifies the category of a parse or validation error produced by the Studio Explorer filter expression engine.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType)
*/
export namespace FilterErrorType {
/**
* A backslash at the end of a quoted string has nothing after it to escape.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#BackslashNotEscapingAnything)
*/
export interface BackslashNotEscapingAnything extends globalThis.EnumItem {
Name: "BackslashNotEscapingAnything";
Value: 0;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const BackslashNotEscapingAnything: BackslashNotEscapingAnything;
/**
* A recognized bespoke filter keyword (such as `classname:`) is missing its required value, or a `query:` expression contains an invalid query string.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#BadBespokeFilter)
*/
export interface BadBespokeFilter extends globalThis.EnumItem {
Name: "BadBespokeFilter";
Value: 1;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const BadBespokeFilter: BadBespokeFilter;
/**
* An unexpected token was encountered where a name or identifier was expected.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#BadName)
*/
export interface BadName extends globalThis.EnumItem {
Name: "BadName";
Value: 2;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const BadName: BadName;
/**
* Reserved error code for an incomplete `or` expression; currently not emitted by the filter engine.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#IncompleteOr)
*/
export interface IncompleteOr extends globalThis.EnumItem {
Name: "IncompleteOr";
Value: 3;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const IncompleteOr: IncompleteOr;
/**
* An opening parenthesis `(` in the filter expression has no matching closing parenthesis `)`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#IncompleteParenthesis)
*/
export interface IncompleteParenthesis extends globalThis.EnumItem {
Name: "IncompleteParenthesis";
Value: 4;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const IncompleteParenthesis: IncompleteParenthesis;
/**
* A `**` wildcard token directly follows a `*` wildcard in a dotted name path (for example, `*.**.X`), which is not allowed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#InvalidDoubleStar)
*/
export interface InvalidDoubleStar extends globalThis.EnumItem {
Name: "InvalidDoubleStar";
Value: 5;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const InvalidDoubleStar: InvalidDoubleStar;
/**
* A lone `~` character was found that is not part of the `~=` not-equal operator.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#InvalidTilde)
*/
export interface InvalidTilde extends globalThis.EnumItem {
Name: "InvalidTilde";
Value: 6;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const InvalidTilde: InvalidTilde;
/**
* A comparison operator other than `=` or `~=` was used with a property type that only supports equality comparisons.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyBadOperator)
*/
export interface PropertyBadOperator extends globalThis.EnumItem {
Name: "PropertyBadOperator";
Value: 7;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const PropertyBadOperator: PropertyBadOperator;
/**
* The named property does not exist on any reflected class known to the filter engine.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyDoesNotExist)
*/
export interface PropertyDoesNotExist extends globalThis.EnumItem {
Name: "PropertyDoesNotExist";
Value: 8;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const PropertyDoesNotExist: PropertyDoesNotExist;
/**
* A sub-field index (such as `.W`) was used with a vector or color property that does not have a field by that name.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyInvalidField)
*/
export interface PropertyInvalidField extends globalThis.EnumItem {
Name: "PropertyInvalidField";
Value: 9;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const PropertyInvalidField: PropertyInvalidField;
/**
* The value string provided for a property comparison cannot be parsed into the expected type for that property (for example, `Locked=notabool`).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyInvalidValue)
*/
export interface PropertyInvalidValue extends globalThis.EnumItem {
Name: "PropertyInvalidValue";
Value: 10;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const PropertyInvalidValue: PropertyInvalidValue;
/**
* A sub-field index was used with a property type that does not support field access (for example, `X=true`).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyUnsupportedFields)
*/
export interface PropertyUnsupportedFields extends globalThis.EnumItem {
Name: "PropertyUnsupportedFields";
Value: 11;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const PropertyUnsupportedFields: PropertyUnsupportedFields;
/**
* The named property exists but its type is not supported by the filter engine (for example, complex datatypes such as `CFrame` or `TweenInfo`).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyUnsupportedProperty)
*/
export interface PropertyUnsupportedProperty extends globalThis.EnumItem {
Name: "PropertyUnsupportedProperty";
Value: 12;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const PropertyUnsupportedProperty: PropertyUnsupportedProperty;
/**
* A `.` in a dotted name path is not followed by a valid name, number, or wildcard token.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#UnexpectedNameIndex)
*/
export interface UnexpectedNameIndex extends globalThis.EnumItem {
Name: "UnexpectedNameIndex";
Value: 13;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const UnexpectedNameIndex: UnexpectedNameIndex;
/**
* A token that cannot be a value (such as an operator) appears where a value is expected after a comparison operator.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#UnexpectedToken)
*/
export interface UnexpectedToken extends globalThis.EnumItem {
Name: "UnexpectedToken";
Value: 14;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const UnexpectedToken: UnexpectedToken;
/**
* An `and` or `or` binary operator appears with no right-hand operand.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#UnfinishedBinaryOperator)
*/
export interface UnfinishedBinaryOperator extends globalThis.EnumItem {
Name: "UnfinishedBinaryOperator";
Value: 15;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const UnfinishedBinaryOperator: UnfinishedBinaryOperator;
/**
* A quoted string was opened but not closed before the end of the filter input.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#UnfinishedQuote)
*/
export interface UnfinishedQuote extends globalThis.EnumItem {
Name: "UnfinishedQuote";
Value: 16;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const UnfinishedQuote: UnfinishedQuote;
/**
* A `name:value` token uses a keyword that is not a recognized bespoke filter type (for example, `foo:Bar`).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#UnknownBespokeFilter)
*/
export interface UnknownBespokeFilter extends globalThis.EnumItem {
Name: "UnknownBespokeFilter";
Value: 17;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const UnknownBespokeFilter: UnknownBespokeFilter;
/**
* A wildcard (`*` or `**`) appears in the property portion of a dotted expression where a concrete property name is required.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#WildcardInProperty)
*/
export interface WildcardInProperty extends globalThis.EnumItem {
Name: "WildcardInProperty";
Value: 18;
EnumType: typeof globalThis.Enum.FilterErrorType;
}
export const WildcardInProperty: WildcardInProperty;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FilterErrorType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FilterErrorType | undefined;
}
export type FilterErrorType = FilterErrorType.BackslashNotEscapingAnything | FilterErrorType.BadBespokeFilter | FilterErrorType.BadName | FilterErrorType.IncompleteOr | FilterErrorType.IncompleteParenthesis | FilterErrorType.InvalidDoubleStar | FilterErrorType.InvalidTilde | FilterErrorType.PropertyBadOperator | FilterErrorType.PropertyDoesNotExist | FilterErrorType.PropertyInvalidField | FilterErrorType.PropertyInvalidValue | FilterErrorType.PropertyUnsupportedFields | FilterErrorType.PropertyUnsupportedProperty | FilterErrorType.UnexpectedNameIndex | FilterErrorType.UnexpectedToken | FilterErrorType.UnfinishedBinaryOperator | FilterErrorType.UnfinishedQuote | FilterErrorType.UnknownBespokeFilter | FilterErrorType.WildcardInProperty;
/**
* Used to determine the result of a text filter request.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterResult)
*/
export namespace FilterResult {
/**
* Text accepted by filter.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterResult#Accepted)
*/
export interface Accepted extends globalThis.EnumItem {
Name: "Accepted";
Value: 0;
EnumType: typeof globalThis.Enum.FilterResult;
}
export const Accepted: Accepted;
/**
* Text rejected by filter.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterResult#Rejected)
*/
export interface Rejected extends globalThis.EnumItem {
Name: "Rejected";
Value: 1;
EnumType: typeof globalThis.Enum.FilterResult;
}
export const Rejected: Rejected;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FilterResult | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FilterResult | undefined;
}
export type FilterResult = FilterResult.Accepted | FilterResult.Rejected;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterType)
*/
export namespace FilterType {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterType#Exclude)
*/
export interface Exclude extends globalThis.EnumItem {
Name: "Exclude";
Value: 0;
EnumType: typeof globalThis.Enum.FilterType;
}
export const Exclude: Exclude;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FilterType#Include)
*/
export interface Include extends globalThis.EnumItem {
Name: "Include";
Value: 1;
EnumType: typeof globalThis.Enum.FilterType;
}
export const Include: Include;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FilterType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FilterType | undefined;
}
export type FilterType = FilterType.Exclude | FilterType.Include;
/**
* Controls how `ChangeHistoryService:FinishRecording()` completes or discards a recording session.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FinishRecordingOperation)
*/
export namespace FinishRecordingOperation {
/**
* Cancels the recording, automatically undoing any work in progress.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FinishRecordingOperation#Cancel)
*/
export interface Cancel extends globalThis.EnumItem {
Name: "Cancel";
Value: 0;
EnumType: typeof globalThis.Enum.FinishRecordingOperation;
}
export const Cancel: Cancel;
/**
* Commits the recorded work.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FinishRecordingOperation#Commit)
*/
export interface Commit extends globalThis.EnumItem {
Name: "Commit";
Value: 1;
EnumType: typeof globalThis.Enum.FinishRecordingOperation;
}
export const Commit: Commit;
/**
* Commits the recorded work and merges with the previous recording if possible.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FinishRecordingOperation#Append)
*/
export interface Append extends globalThis.EnumItem {
Name: "Append";
Value: 2;
EnumType: typeof globalThis.Enum.FinishRecordingOperation;
}
export const Append: Append;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FinishRecordingOperation | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FinishRecordingOperation | undefined;
}
export type FinishRecordingOperation = FinishRecordingOperation.Cancel | FinishRecordingOperation.Commit | FinishRecordingOperation.Append;
/**
* Determines the geometric representation used to compute aerodynamic forces.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FluidFidelity)
*/
export namespace FluidFidelity {
/**
* Let the physics engine select the geometric representation for aerodynamic force and torque calculations.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FluidFidelity#Automatic)
*/
export interface Automatic extends globalThis.EnumItem {
Name: "Automatic";
Value: 0;
EnumType: typeof globalThis.Enum.FluidFidelity;
}
export const Automatic: Automatic;
/**
* Use the current collision geometry specified by `TriangleMeshPart.CollisionFidelity` for aerodynamic force and torque calculations .
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FluidFidelity#UseCollisionGeometry)
*/
export interface UseCollisionGeometry extends globalThis.EnumItem {
Name: "UseCollisionGeometry";
Value: 1;
EnumType: typeof globalThis.Enum.FluidFidelity;
}
export const UseCollisionGeometry: UseCollisionGeometry;
/**
* Force the engine to compute aerodynamic forces and torques using a more precise geometry representation based on the original mesh. This option may increase join and replication time if used on a large scale.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FluidFidelity#UsePreciseGeometry)
*/
export interface UsePreciseGeometry extends globalThis.EnumItem {
Name: "UsePreciseGeometry";
Value: 2;
EnumType: typeof globalThis.Enum.FluidFidelity;
}
export const UsePreciseGeometry: UsePreciseGeometry;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FluidFidelity | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FluidFidelity | undefined;
}
export type FluidFidelity = FluidFidelity.Automatic | FluidFidelity.UseCollisionGeometry | FluidFidelity.UsePreciseGeometry;
/**
* Controls the enablement of aerodynamic forces on parts and assemblies in the workspace.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FluidForces)
*/
export namespace FluidForces {
/**
* Aerodynamic forces will not be calculated on any `BaseParts`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FluidForces#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.FluidForces;
}
export const Default: Default;
/**
* Aerodynamic forces will be calculated on `BaseParts` with `EnableFluidForces` set to true. During the beta phase, the behavior of the aerodynamic force model may change as the model improves.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FluidForces#Experimental)
*/
export interface Experimental extends globalThis.EnumItem {
Name: "Experimental";
Value: 1;
EnumType: typeof globalThis.Enum.FluidForces;
}
export const Experimental: Experimental;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FluidForces | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FluidForces | undefined;
}
export type FluidForces = FluidForces.Default | FluidForces.Experimental;
/**
* Determines the font used to render text in GUI objects such as Class.TextLabel, Class.TextButton, and Class.TextBox. This is a legacy property. For new work, use `Font`, `FontFace`, and `FontFace` instead.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font)
*/
export namespace Font {
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Legacy)
*/
export interface Legacy extends globalThis.EnumItem {
Name: "Legacy";
Value: 0;
EnumType: typeof globalThis.Enum.Font;
}
export const Legacy: Legacy;
/**
* `Arial` has been removed. Using it will map to the `Arimo` font family of the `Font` data type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Arial)
*/
export interface Arial extends globalThis.EnumItem {
Name: "Arial";
Value: 1;
EnumType: typeof globalThis.Enum.Font;
}
export const Arial: Arial;
/**
* `ArialBold` has been removed. Using it will map to the `Arimo` font family of the `Font` data type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#ArialBold)
*/
export interface ArialBold extends globalThis.EnumItem {
Name: "ArialBold";
Value: 2;
EnumType: typeof globalThis.Enum.Font;
}
export const ArialBold: ArialBold;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#SourceSans)
*/
export interface SourceSans extends globalThis.EnumItem {
Name: "SourceSans";
Value: 3;
EnumType: typeof globalThis.Enum.Font;
}
export const SourceSans: SourceSans;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#SourceSansBold)
*/
export interface SourceSansBold extends globalThis.EnumItem {
Name: "SourceSansBold";
Value: 4;
EnumType: typeof globalThis.Enum.Font;
}
export const SourceSansBold: SourceSansBold;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#SourceSansLight)
*/
export interface SourceSansLight extends globalThis.EnumItem {
Name: "SourceSansLight";
Value: 5;
EnumType: typeof globalThis.Enum.Font;
}
export const SourceSansLight: SourceSansLight;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#SourceSansItalic)
*/
export interface SourceSansItalic extends globalThis.EnumItem {
Name: "SourceSansItalic";
Value: 6;
EnumType: typeof globalThis.Enum.Font;
}
export const SourceSansItalic: SourceSansItalic;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Bodoni)
*/
export interface Bodoni extends globalThis.EnumItem {
Name: "Bodoni";
Value: 7;
EnumType: typeof globalThis.Enum.Font;
}
export const Bodoni: Bodoni;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Garamond)
*/
export interface Garamond extends globalThis.EnumItem {
Name: "Garamond";
Value: 8;
EnumType: typeof globalThis.Enum.Font;
}
export const Garamond: Garamond;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Cartoon)
*/
export interface Cartoon extends globalThis.EnumItem {
Name: "Cartoon";
Value: 9;
EnumType: typeof globalThis.Enum.Font;
}
export const Cartoon: Cartoon;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Code)
*/
export interface Code extends globalThis.EnumItem {
Name: "Code";
Value: 10;
EnumType: typeof globalThis.Enum.Font;
}
export const Code: Code;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Highway)
*/
export interface Highway extends globalThis.EnumItem {
Name: "Highway";
Value: 11;
EnumType: typeof globalThis.Enum.Font;
}
export const Highway: Highway;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#SciFi)
*/
export interface SciFi extends globalThis.EnumItem {
Name: "SciFi";
Value: 12;
EnumType: typeof globalThis.Enum.Font;
}
export const SciFi: SciFi;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Arcade)
*/
export interface Arcade extends globalThis.EnumItem {
Name: "Arcade";
Value: 13;
EnumType: typeof globalThis.Enum.Font;
}
export const Arcade: Arcade;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Fantasy)
*/
export interface Fantasy extends globalThis.EnumItem {
Name: "Fantasy";
Value: 14;
EnumType: typeof globalThis.Enum.Font;
}
export const Fantasy: Fantasy;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Antique)
*/
export interface Antique extends globalThis.EnumItem {
Name: "Antique";
Value: 15;
EnumType: typeof globalThis.Enum.Font;
}
export const Antique: Antique;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#SourceSansSemibold)
*/
export interface SourceSansSemibold extends globalThis.EnumItem {
Name: "SourceSansSemibold";
Value: 16;
EnumType: typeof globalThis.Enum.Font;
}
export const SourceSansSemibold: SourceSansSemibold;
/**
* `Gotham` has been removed. Using it will map to the `Montserrat` font family of the `Font` data type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Gotham)
*/
export interface Gotham extends globalThis.EnumItem {
Name: "Gotham";
Value: 17;
EnumType: typeof globalThis.Enum.Font;
}
export const Gotham: Gotham;
/**
* @deprecated renamed to Gotham
*/
export const Montserrat: Gotham;
/**
* `GothamMedium` has been removed. Using it will map to the `Montserrat` font family of the `Font` data type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#GothamMedium)
*/
export interface GothamMedium extends globalThis.EnumItem {
Name: "GothamMedium";
Value: 18;
EnumType: typeof globalThis.Enum.Font;
}
export const GothamMedium: GothamMedium;
/**
* @deprecated renamed to GothamMedium
*/
export const GothamSemibold: GothamMedium;
/**
* @deprecated renamed to GothamMedium
*/
export const MontserratMedium: GothamMedium;
/**
* `GothamBold` has been removed. Using it will map to the `Montserrat` font family of the `Font` data type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#GothamBold)
*/
export interface GothamBold extends globalThis.EnumItem {
Name: "GothamBold";
Value: 19;
EnumType: typeof globalThis.Enum.Font;
}
export const GothamBold: GothamBold;
/**
* @deprecated renamed to GothamBold
*/
export const MontserratBold: GothamBold;
/**
* `GothamBlack` has been removed. Using it will map to the `Montserrat` font family of the `Font` data type.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#GothamBlack)
*/
export interface GothamBlack extends globalThis.EnumItem {
Name: "GothamBlack";
Value: 20;
EnumType: typeof globalThis.Enum.Font;
}
export const GothamBlack: GothamBlack;
/**
* @deprecated renamed to GothamBlack
*/
export const MontserratBlack: GothamBlack;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#AmaticSC)
*/
export interface AmaticSC extends globalThis.EnumItem {
Name: "AmaticSC";
Value: 21;
EnumType: typeof globalThis.Enum.Font;
}
export const AmaticSC: AmaticSC;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Bangers)
*/
export interface Bangers extends globalThis.EnumItem {
Name: "Bangers";
Value: 22;
EnumType: typeof globalThis.Enum.Font;
}
export const Bangers: Bangers;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Creepster)
*/
export interface Creepster extends globalThis.EnumItem {
Name: "Creepster";
Value: 23;
EnumType: typeof globalThis.Enum.Font;
}
export const Creepster: Creepster;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#DenkOne)
*/
export interface DenkOne extends globalThis.EnumItem {
Name: "DenkOne";
Value: 24;
EnumType: typeof globalThis.Enum.Font;
}
export const DenkOne: DenkOne;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Fondamento)
*/
export interface Fondamento extends globalThis.EnumItem {
Name: "Fondamento";
Value: 25;
EnumType: typeof globalThis.Enum.Font;
}
export const Fondamento: Fondamento;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#FredokaOne)
*/
export interface FredokaOne extends globalThis.EnumItem {
Name: "FredokaOne";
Value: 26;
EnumType: typeof globalThis.Enum.Font;
}
export const FredokaOne: FredokaOne;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#GrenzeGotisch)
*/
export interface GrenzeGotisch extends globalThis.EnumItem {
Name: "GrenzeGotisch";
Value: 27;
EnumType: typeof globalThis.Enum.Font;
}
export const GrenzeGotisch: GrenzeGotisch;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#IndieFlower)
*/
export interface IndieFlower extends globalThis.EnumItem {
Name: "IndieFlower";
Value: 28;
EnumType: typeof globalThis.Enum.Font;
}
export const IndieFlower: IndieFlower;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#JosefinSans)
*/
export interface JosefinSans extends globalThis.EnumItem {
Name: "JosefinSans";
Value: 29;
EnumType: typeof globalThis.Enum.Font;
}
export const JosefinSans: JosefinSans;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Jura)
*/
export interface Jura extends globalThis.EnumItem {
Name: "Jura";
Value: 30;
EnumType: typeof globalThis.Enum.Font;
}
export const Jura: Jura;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Kalam)
*/
export interface Kalam extends globalThis.EnumItem {
Name: "Kalam";
Value: 31;
EnumType: typeof globalThis.Enum.Font;
}
export const Kalam: Kalam;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#LuckiestGuy)
*/
export interface LuckiestGuy extends globalThis.EnumItem {
Name: "LuckiestGuy";
Value: 32;
EnumType: typeof globalThis.Enum.Font;
}
export const LuckiestGuy: LuckiestGuy;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Merriweather)
*/
export interface Merriweather extends globalThis.EnumItem {
Name: "Merriweather";
Value: 33;
EnumType: typeof globalThis.Enum.Font;
}
export const Merriweather: Merriweather;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Michroma)
*/
export interface Michroma extends globalThis.EnumItem {
Name: "Michroma";
Value: 34;
EnumType: typeof globalThis.Enum.Font;
}
export const Michroma: Michroma;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Nunito)
*/
export interface Nunito extends globalThis.EnumItem {
Name: "Nunito";
Value: 35;
EnumType: typeof globalThis.Enum.Font;
}
export const Nunito: Nunito;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Oswald)
*/
export interface Oswald extends globalThis.EnumItem {
Name: "Oswald";
Value: 36;
EnumType: typeof globalThis.Enum.Font;
}
export const Oswald: Oswald;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#PatrickHand)
*/
export interface PatrickHand extends globalThis.EnumItem {
Name: "PatrickHand";
Value: 37;
EnumType: typeof globalThis.Enum.Font;
}
export const PatrickHand: PatrickHand;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#PermanentMarker)
*/
export interface PermanentMarker extends globalThis.EnumItem {
Name: "PermanentMarker";
Value: 38;
EnumType: typeof globalThis.Enum.Font;
}
export const PermanentMarker: PermanentMarker;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Roboto)
*/
export interface Roboto extends globalThis.EnumItem {
Name: "Roboto";
Value: 39;
EnumType: typeof globalThis.Enum.Font;
}
export const Roboto: Roboto;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#RobotoCondensed)
*/
export interface RobotoCondensed extends globalThis.EnumItem {
Name: "RobotoCondensed";
Value: 40;
EnumType: typeof globalThis.Enum.Font;
}
export const RobotoCondensed: RobotoCondensed;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#RobotoMono)
*/
export interface RobotoMono extends globalThis.EnumItem {
Name: "RobotoMono";
Value: 41;
EnumType: typeof globalThis.Enum.Font;
}
export const RobotoMono: RobotoMono;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Sarpanch)
*/
export interface Sarpanch extends globalThis.EnumItem {
Name: "Sarpanch";
Value: 42;
EnumType: typeof globalThis.Enum.Font;
}
export const Sarpanch: Sarpanch;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#SpecialElite)
*/
export interface SpecialElite extends globalThis.EnumItem {
Name: "SpecialElite";
Value: 43;
EnumType: typeof globalThis.Enum.Font;
}
export const SpecialElite: SpecialElite;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#TitilliumWeb)
*/
export interface TitilliumWeb extends globalThis.EnumItem {
Name: "TitilliumWeb";
Value: 44;
EnumType: typeof globalThis.Enum.Font;
}
export const TitilliumWeb: TitilliumWeb;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Ubuntu)
*/
export interface Ubuntu extends globalThis.EnumItem {
Name: "Ubuntu";
Value: 45;
EnumType: typeof globalThis.Enum.Font;
}
export const Ubuntu: Ubuntu;
/**
*  See [Builder Font License](../../../resources/builder-font-license.md).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#BuilderSans)
*/
export interface BuilderSans extends globalThis.EnumItem {
Name: "BuilderSans";
Value: 46;
EnumType: typeof globalThis.Enum.Font;
}
export const BuilderSans: BuilderSans;
/**
*  See [Builder Font License](../../../resources/builder-font-license.md).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#BuilderSansMedium)
*/
export interface BuilderSansMedium extends globalThis.EnumItem {
Name: "BuilderSansMedium";
Value: 47;
EnumType: typeof globalThis.Enum.Font;
}
export const BuilderSansMedium: BuilderSansMedium;
/**
*  See [Builder Font License](../../../resources/builder-font-license.md).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#BuilderSansBold)
*/
export interface BuilderSansBold extends globalThis.EnumItem {
Name: "BuilderSansBold";
Value: 48;
EnumType: typeof globalThis.Enum.Font;
}
export const BuilderSansBold: BuilderSansBold;
/**
*  See [Builder Font License](../../../resources/builder-font-license.md).
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#BuilderSansExtraBold)
*/
export interface BuilderSansExtraBold extends globalThis.EnumItem {
Name: "BuilderSansExtraBold";
Value: 49;
EnumType: typeof globalThis.Enum.Font;
}
export const BuilderSansExtraBold: BuilderSansExtraBold;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Arimo)
*/
export interface Arimo extends globalThis.EnumItem {
Name: "Arimo";
Value: 50;
EnumType: typeof globalThis.Enum.Font;
}
export const Arimo: Arimo;
/**
* 
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#ArimoBold)
*/
export interface ArimoBold extends globalThis.EnumItem {
Name: "ArimoBold";
Value: 51;
EnumType: typeof globalThis.Enum.Font;
}
export const ArimoBold: ArimoBold;
/**
* Set when the GUI object's font face is set to a `Font` that has no corresponding enum value.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 100;
EnumType: typeof globalThis.Enum.Font;
}
export const Unknown: Unknown;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.Font | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.Font | undefined;
}
export type Font = Font.Legacy | Font.Arial | Font.ArialBold | Font.SourceSans | Font.SourceSansBold | Font.SourceSansLight | Font.SourceSansItalic | Font.Bodoni | Font.Garamond | Font.Cartoon | Font.Code | Font.Highway | Font.SciFi | Font.Arcade | Font.Fantasy | Font.Antique | Font.SourceSansSemibold | Font.Gotham | Font.GothamMedium | Font.GothamBold | Font.GothamBlack | Font.AmaticSC | Font.Bangers | Font.Creepster | Font.DenkOne | Font.Fondamento | Font.FredokaOne | Font.GrenzeGotisch | Font.IndieFlower | Font.JosefinSans | Font.Jura | Font.Kalam | Font.LuckiestGuy | Font.Merriweather | Font.Michroma | Font.Nunito | Font.Oswald | Font.PatrickHand | Font.PermanentMarker | Font.Roboto | Font.RobotoCondensed | Font.RobotoMono | Font.Sarpanch | Font.SpecialElite | Font.TitilliumWeb | Font.Ubuntu | Font.BuilderSans | Font.BuilderSansMedium | Font.BuilderSansBold | Font.BuilderSansExtraBold | Font.Arimo | Font.ArimoBold | Font.Unknown;
/**
* Specifies preset font sizes for text-rendering UI objects such as `TextLabel`, `TextButton`, and `TextBox`. Prefer the `TextSize` property instead of this deprecated enum.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize)
*/
export namespace FontSize {
/**
* Font size `8`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size8)
*/
export interface Size8 extends globalThis.EnumItem {
Name: "Size8";
Value: 0;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size8: Size8;
/**
* Font size `9`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size9)
*/
export interface Size9 extends globalThis.EnumItem {
Name: "Size9";
Value: 1;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size9: Size9;
/**
* Font size `10`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size10)
*/
export interface Size10 extends globalThis.EnumItem {
Name: "Size10";
Value: 2;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size10: Size10;
/**
* Font size `11`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size11)
*/
export interface Size11 extends globalThis.EnumItem {
Name: "Size11";
Value: 3;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size11: Size11;
/**
* Font size `12`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size12)
*/
export interface Size12 extends globalThis.EnumItem {
Name: "Size12";
Value: 4;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size12: Size12;
/**
* Font size `14`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size14)
*/
export interface Size14 extends globalThis.EnumItem {
Name: "Size14";
Value: 5;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size14: Size14;
/**
* Font size `18`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size18)
*/
export interface Size18 extends globalThis.EnumItem {
Name: "Size18";
Value: 6;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size18: Size18;
/**
* Font size `24`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size24)
*/
export interface Size24 extends globalThis.EnumItem {
Name: "Size24";
Value: 7;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size24: Size24;
/**
* Font size `36`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size36)
*/
export interface Size36 extends globalThis.EnumItem {
Name: "Size36";
Value: 8;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size36: Size36;
/**
* Font size `48`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size48)
*/
export interface Size48 extends globalThis.EnumItem {
Name: "Size48";
Value: 9;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size48: Size48;
/**
* Font size `28`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size28)
*/
export interface Size28 extends globalThis.EnumItem {
Name: "Size28";
Value: 10;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size28: Size28;
/**
* Font size `32`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size32)
*/
export interface Size32 extends globalThis.EnumItem {
Name: "Size32";
Value: 11;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size32: Size32;
/**
* Font size `42`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size42)
*/
export interface Size42 extends globalThis.EnumItem {
Name: "Size42";
Value: 12;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size42: Size42;
/**
* Font size `60`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size60)
*/
export interface Size60 extends globalThis.EnumItem {
Name: "Size60";
Value: 13;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size60: Size60;
/**
* Font size `96`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size96)
*/
export interface Size96 extends globalThis.EnumItem {
Name: "Size96";
Value: 14;
EnumType: typeof globalThis.Enum.FontSize;
}
export const Size96: Size96;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FontSize | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FontSize | undefined;
}
export type FontSize = FontSize.Size8 | FontSize.Size9 | FontSize.Size10 | FontSize.Size11 | FontSize.Size12 | FontSize.Size14 | FontSize.Size18 | FontSize.Size24 | FontSize.Size36 | FontSize.Size48 | FontSize.Size28 | FontSize.Size32 | FontSize.Size42 | FontSize.Size60 | FontSize.Size96;
/**
* Describes whether a `Font` style is normal or italic.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontStyle)
*/
export namespace FontStyle {
/**
* The text renders normally with this font.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontStyle#Normal)
*/
export interface Normal extends globalThis.EnumItem {
Name: "Normal";
Value: 0;
EnumType: typeof globalThis.Enum.FontStyle;
}
export const Normal: Normal;
/**
* The text renders italic with this font.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontStyle#Italic)
*/
export interface Italic extends globalThis.EnumItem {
Name: "Italic";
Value: 1;
EnumType: typeof globalThis.Enum.FontStyle;
}
export const Italic: Italic;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FontStyle | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FontStyle | undefined;
}
export type FontStyle = FontStyle.Normal | FontStyle.Italic;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontWeight)
*/
export namespace FontWeight {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontWeight#Thin)
*/
export interface Thin extends globalThis.EnumItem {
Name: "Thin";
Value: 100;
EnumType: typeof globalThis.Enum.FontWeight;
}
export const Thin: Thin;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontWeight#ExtraLight)
*/
export interface ExtraLight extends globalThis.EnumItem {
Name: "ExtraLight";
Value: 200;
EnumType: typeof globalThis.Enum.FontWeight;
}
export const ExtraLight: ExtraLight;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontWeight#Light)
*/
export interface Light extends globalThis.EnumItem {
Name: "Light";
Value: 300;
EnumType: typeof globalThis.Enum.FontWeight;
}
export const Light: Light;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontWeight#Regular)
*/
export interface Regular extends globalThis.EnumItem {
Name: "Regular";
Value: 400;
EnumType: typeof globalThis.Enum.FontWeight;
}
export const Regular: Regular;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontWeight#Medium)
*/
export interface Medium extends globalThis.EnumItem {
Name: "Medium";
Value: 500;
EnumType: typeof globalThis.Enum.FontWeight;
}
export const Medium: Medium;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontWeight#SemiBold)
*/
export interface SemiBold extends globalThis.EnumItem {
Name: "SemiBold";
Value: 600;
EnumType: typeof globalThis.Enum.FontWeight;
}
export const SemiBold: SemiBold;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontWeight#Bold)
*/
export interface Bold extends globalThis.EnumItem {
Name: "Bold";
Value: 700;
EnumType: typeof globalThis.Enum.FontWeight;
}
export const Bold: Bold;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontWeight#ExtraBold)
*/
export interface ExtraBold extends globalThis.EnumItem {
Name: "ExtraBold";
Value: 800;
EnumType: typeof globalThis.Enum.FontWeight;
}
export const ExtraBold: ExtraBold;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontWeight#Heavy)
*/
export interface Heavy extends globalThis.EnumItem {
Name: "Heavy";
Value: 900;
EnumType: typeof globalThis.Enum.FontWeight;
}
export const Heavy: Heavy;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FontWeight | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FontWeight | undefined;
}
export type FontWeight = FontWeight.Thin | FontWeight.ExtraLight | FontWeight.Light | FontWeight.Regular | FontWeight.Medium | FontWeight.SemiBold | FontWeight.Bold | FontWeight.ExtraBold | FontWeight.Heavy;
/**
* The **ForceLimitMode** enum determines how the maximum force for a constraint is specified and how that limit is enforced by the constraint.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ForceLimitMode)
*/
export namespace ForceLimitMode {
/**
* A single number is used to specify the magnitude of the maximum constraint force. The constraint will ensure that the force it applies will have a magnitude that is less than this limit.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ForceLimitMode#Magnitude)
*/
export interface Magnitude extends globalThis.EnumItem {
Name: "Magnitude";
Value: 0;
EnumType: typeof globalThis.Enum.ForceLimitMode;
}
export const Magnitude: Magnitude;
/**
* A vector is used to specify the maximum force value along each axis of a given reference frame. The constraint will ensure that each component of the force will have an absolute value that's less than the corresponding vector entry.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ForceLimitMode#PerAxis)
*/
export interface PerAxis extends globalThis.EnumItem {
Name: "PerAxis";
Value: 1;
EnumType: typeof globalThis.Enum.ForceLimitMode;
}
export const PerAxis: PerAxis;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ForceLimitMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ForceLimitMode | undefined;
}
export type ForceLimitMode = ForceLimitMode.Magnitude | ForceLimitMode.PerAxis;
/**
* Deprecated enum that previously controlled the minimum size and resize increment of a `FormFactorPart` along each axis.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FormFactor)
*/
export namespace FormFactor {
/**
* Increases by a rate of 1 along all axes.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FormFactor#Symmetric)
*/
export interface Symmetric extends globalThis.EnumItem {
Name: "Symmetric";
Value: 0;
EnumType: typeof globalThis.Enum.FormFactor;
}
export const Symmetric: Symmetric;
/**
* Increases by a rate of 1 along the x- and z- axes, 1.2 along the y-axis.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FormFactor#Brick)
*/
export interface Brick extends globalThis.EnumItem {
Name: "Brick";
Value: 1;
EnumType: typeof globalThis.Enum.FormFactor;
}
export const Brick: Brick;
/**
* @deprecated renamed to Brick
*/
export const Block: Brick;
/**
* Increases by a rate of 1 along the x- and z- axes, 0.4 along the y-axis.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FormFactor#Plate)
*/
export interface Plate extends globalThis.EnumItem {
Name: "Plate";
Value: 2;
EnumType: typeof globalThis.Enum.FormFactor;
}
export const Plate: Plate;
/**
* Increases by a rate as low as .001 along all axes.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FormFactor#Custom)
*/
export interface Custom extends globalThis.EnumItem {
Name: "Custom";
Value: 3;
EnumType: typeof globalThis.Enum.FormFactor;
}
export const Custom: Custom;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FormFactor | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FormFactor | undefined;
}
export type FormFactor = FormFactor.Symmetric | FormFactor.Brick | FormFactor.Plate | FormFactor.Custom;
/**
* Used to set the style of a `Frame`.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrameStyle)
*/
export namespace FrameStyle {
/**
* Uses the frame's `GuiObject.BackgroundColor3`, `GuiObject.BorderColor3`, and `GuiObject.BackgroundTransparency` properties to determine the frame's appearance. It has no padding; elements with the position `UDim2.new(0, 0, 0, 0)` will appear at the frame's top-left corner.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrameStyle#Custom)
*/
export interface Custom extends globalThis.EnumItem {
Name: "Custom";
Value: 0;
EnumType: typeof globalThis.Enum.FrameStyle;
}
export const Custom: Custom;
/**
* Causes the frame to appear similar to a `Dialog` with its `Tone` property set to `DialogTone.Neutral`. Like **ChatGreen** and **ChatRed**, this has a padding of fifteen pixels on all sides.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrameStyle#ChatBlue)
*/
export interface ChatBlue extends globalThis.EnumItem {
Name: "ChatBlue";
Value: 1;
EnumType: typeof globalThis.Enum.FrameStyle;
}
export const ChatBlue: ChatBlue;
/**
* Causes the frame to appear as a translucent dark gray rectangle with a padding of five pixels on all sides.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrameStyle#RobloxSquare)
*/
export interface RobloxSquare extends globalThis.EnumItem {
Name: "RobloxSquare";
Value: 2;
EnumType: typeof globalThis.Enum.FrameStyle;
}
export const RobloxSquare: RobloxSquare;
/**
* Causes the frame to appear as a translucent dark gray rectangle with rounded edges. Like **RobloxSquare**, this has a padding of five pixels on all sides.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrameStyle#RobloxRound)
*/
export interface RobloxRound extends globalThis.EnumItem {
Name: "RobloxRound";
Value: 3;
EnumType: typeof globalThis.Enum.FrameStyle;
}
export const RobloxRound: RobloxRound;
/**
* Causes the frame to appear similar to a `Dialog` with its `Tone` property set to `DialogTone.Friendly`. Like **ChatBlue** and **ChatRed**, this has a padding of fifteen pixels on all sides.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrameStyle#ChatGreen)
*/
export interface ChatGreen extends globalThis.EnumItem {
Name: "ChatGreen";
Value: 4;
EnumType: typeof globalThis.Enum.FrameStyle;
}
export const ChatGreen: ChatGreen;
/**
* Causes the frame to appear similar to a `Dialog` with its `Tone` property set to `DialogTone.Enemy`. Like **ChatBlue** and **ChatGreen**, this has a padding of fifteen pixels on all sides.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrameStyle#ChatRed)
*/
export interface ChatRed extends globalThis.EnumItem {
Name: "ChatRed";
Value: 5;
EnumType: typeof globalThis.Enum.FrameStyle;
}
export const ChatRed: ChatRed;
/**
* Causes the frame to appear as a translucent gray rectangle with blurred sides. The blur is more apparent on the bottom edge. It has a padding of eight pixels on all sides.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrameStyle#DropShadow)
*/
export interface DropShadow extends globalThis.EnumItem {
Name: "DropShadow";
Value: 6;
EnumType: typeof globalThis.Enum.FrameStyle;
}
export const DropShadow: DropShadow;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FrameStyle | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FrameStyle | undefined;
}
export type FrameStyle = FrameStyle.Custom | FrameStyle.ChatBlue | FrameStyle.RobloxSquare | FrameStyle.RobloxRound | FrameStyle.ChatGreen | FrameStyle.ChatRed | FrameStyle.DropShadow;
/**
* Controls how the Frame Rate Manager (FRM) adjusts rendering quality to maintain target frame rates.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FramerateManagerMode)
*/
export namespace FramerateManagerMode {
/**
* The engine selects whether to run FRM based on hardware and platform context. This is the default.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FramerateManagerMode#Automatic)
*/
export interface Automatic extends globalThis.EnumItem {
Name: "Automatic";
Value: 0;
EnumType: typeof globalThis.Enum.FramerateManagerMode;
}
export const Automatic: Automatic;
/**
* FRM is explicitly enabled and dynamically adjusts rendering quality to meet frame rate targets.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FramerateManagerMode#On)
*/
export interface On extends globalThis.EnumItem {
Name: "On";
Value: 1;
EnumType: typeof globalThis.Enum.FramerateManagerMode;
}
export const On: On;
/**
* FRM quality throttling is disabled; block count is fixed at the baseline level regardless of frame rate.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FramerateManagerMode#Off)
*/
export interface Off extends globalThis.EnumItem {
Name: "Off";
Value: 2;
EnumType: typeof globalThis.Enum.FramerateManagerMode;
}
export const Off: Off;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FramerateManagerMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FramerateManagerMode | undefined;
}
export type FramerateManagerMode = FramerateManagerMode.Automatic | FramerateManagerMode.On | FramerateManagerMode.Off;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent)
*/
export namespace FriendRequestEvent {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Issue)
*/
export interface Issue extends globalThis.EnumItem {
Name: "Issue";
Value: 0;
EnumType: typeof globalThis.Enum.FriendRequestEvent;
}
export const Issue: Issue;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Revoke)
*/
export interface Revoke extends globalThis.EnumItem {
Name: "Revoke";
Value: 1;
EnumType: typeof globalThis.Enum.FriendRequestEvent;
}
export const Revoke: Revoke;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Accept)
*/
export interface Accept extends globalThis.EnumItem {
Name: "Accept";
Value: 2;
EnumType: typeof globalThis.Enum.FriendRequestEvent;
}
export const Accept: Accept;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Deny)
*/
export interface Deny extends globalThis.EnumItem {
Name: "Deny";
Value: 3;
EnumType: typeof globalThis.Enum.FriendRequestEvent;
}
export const Deny: Deny;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FriendRequestEvent | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FriendRequestEvent | undefined;
}
export type FriendRequestEvent = FriendRequestEvent.Issue | FriendRequestEvent.Revoke | FriendRequestEvent.Accept | FriendRequestEvent.Deny;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendStatus)
*/
export namespace FriendStatus {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendStatus#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.FriendStatus;
}
export const Unknown: Unknown;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendStatus#NotFriend)
*/
export interface NotFriend extends globalThis.EnumItem {
Name: "NotFriend";
Value: 1;
EnumType: typeof globalThis.Enum.FriendStatus;
}
export const NotFriend: NotFriend;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendStatus#Friend)
*/
export interface Friend extends globalThis.EnumItem {
Name: "Friend";
Value: 2;
EnumType: typeof globalThis.Enum.FriendStatus;
}
export const Friend: Friend;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendStatus#FriendRequestSent)
*/
export interface FriendRequestSent extends globalThis.EnumItem {
Name: "FriendRequestSent";
Value: 3;
EnumType: typeof globalThis.Enum.FriendStatus;
}
export const FriendRequestSent: FriendRequestSent;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FriendStatus#FriendRequestReceived)
*/
export interface FriendRequestReceived extends globalThis.EnumItem {
Name: "FriendRequestReceived";
Value: 4;
EnumType: typeof globalThis.Enum.FriendStatus;
}
export const FriendRequestReceived: FriendRequestReceived;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FriendStatus | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FriendStatus | undefined;
}
export type FriendStatus = FriendStatus.Unknown | FriendStatus.NotFriend | FriendStatus.Friend | FriendStatus.FriendRequestSent | FriendStatus.FriendRequestReceived;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrustumStreamingMode)
*/
export namespace FrustumStreamingMode {
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrustumStreamingMode#Default)
*/
export interface Default extends globalThis.EnumItem {
Name: "Default";
Value: 0;
EnumType: typeof globalThis.Enum.FrustumStreamingMode;
}
export const Default: Default;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrustumStreamingMode#Enabled)
*/
export interface Enabled extends globalThis.EnumItem {
Name: "Enabled";
Value: 1;
EnumType: typeof globalThis.Enum.FrustumStreamingMode;
}
export const Enabled: Enabled;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrustumStreamingMode#Disabled)
*/
export interface Disabled extends globalThis.EnumItem {
Name: "Disabled";
Value: 2;
EnumType: typeof globalThis.Enum.FrustumStreamingMode;
}
export const Disabled: Disabled;
/**
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FrustumStreamingMode#Automatic)
*/
export interface Automatic extends globalThis.EnumItem {
Name: "Automatic";
Value: 3;
EnumType: typeof globalThis.Enum.FrustumStreamingMode;
}
export const Automatic: Automatic;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FrustumStreamingMode | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FrustumStreamingMode | undefined;
}
export type FrustumStreamingMode = FrustumStreamingMode.Default | FrustumStreamingMode.Enabled | FrustumStreamingMode.Disabled | FrustumStreamingMode.Automatic;
/**
* Status of a single functional test run.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FunctionalTestResult)
*/
export namespace FunctionalTestResult {
/**
* The test run was successful.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FunctionalTestResult#Passed)
*/
export interface Passed extends globalThis.EnumItem {
Name: "Passed";
Value: 0;
EnumType: typeof globalThis.Enum.FunctionalTestResult;
}
export const Passed: Passed;
/**
* The test run is potentially unstable.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FunctionalTestResult#Warning)
*/
export interface Warning extends globalThis.EnumItem {
Name: "Warning";
Value: 1;
EnumType: typeof globalThis.Enum.FunctionalTestResult;
}
export const Warning: Warning;
/**
* The test run failed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FunctionalTestResult#Error)
*/
export interface Error extends globalThis.EnumItem {
Name: "Error";
Value: 2;
EnumType: typeof globalThis.Enum.FunctionalTestResult;
}
export const Error: Error;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FunctionalTestResult | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FunctionalTestResult | undefined;
}
export type FunctionalTestResult = FunctionalTestResult.Passed | FunctionalTestResult.Warning | FunctionalTestResult.Error;
/**
* Value indicating which type of avatar an experience uses.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GameAvatarType)
*/
export namespace GameAvatarType {
/**
* The R6 character rig.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GameAvatarType#R6)
*/
export interface R6 extends globalThis.EnumItem {
Name: "R6";
Value: 0;
EnumType: typeof globalThis.Enum.GameAvatarType;
}
export const R6: R6;
/**
* The R15 character rig.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GameAvatarType#R15)
*/
export interface R15 extends globalThis.EnumItem {
Name: "R15";
Value: 1;
EnumType: typeof globalThis.Enum.GameAvatarType;
}
export const R15: R15;
/**
* The rig (either R6 or [R15](../../../avatar/character-bodies/specifications.md#rigging) determined by a player's character settings set on the website in the 'Edit Avatar' page.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GameAvatarType#PlayerChoice)
*/
export interface PlayerChoice extends globalThis.EnumItem {
Name: "PlayerChoice";
Value: 2;
EnumType: typeof globalThis.Enum.GameAvatarType;
}
export const PlayerChoice: PlayerChoice;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.GameAvatarType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.GameAvatarType | undefined;
}
export type GameAvatarType = GameAvatarType.R6 | GameAvatarType.R15 | GameAvatarType.PlayerChoice;
/**
* Identifies the hardware type of a connected gamepad controller.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GamepadType)
*/
export namespace GamepadType {
/**
* A gamepad whose hardware type could not be determined, or no gamepad has connected yet.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GamepadType#Unknown)
*/
export interface Unknown extends globalThis.EnumItem {
Name: "Unknown";
Value: 0;
EnumType: typeof globalThis.Enum.GamepadType;
}
export const Unknown: Unknown;
/**
* A Sony PlayStation 4 DualShock controller.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GamepadType#PS4)
*/
export interface PS4 extends globalThis.EnumItem {
Name: "PS4";
Value: 1;
EnumType: typeof globalThis.Enum.GamepadType;
}
export const PS4: PS4;
/**
* A Sony PlayStation 5 DualSense controller.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GamepadType#PS5)
*/
export interface PS5 extends globalThis.EnumItem {
Name: "PS5";
Value: 2;
EnumType: typeof globalThis.Enum.GamepadType;
}
export const PS5: PS5;
/**
* A Microsoft Xbox One controller.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GamepadType#XboxOne)
*/
export interface XboxOne extends globalThis.EnumItem {
Name: "XboxOne";
Value: 3;
EnumType: typeof globalThis.Enum.GamepadType;
}
export const XboxOne: XboxOne;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.GamepadType | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.GamepadType | undefined;
}
export type GamepadType = GamepadType.Unknown | GamepadType.PS4 | GamepadType.PS5 | GamepadType.XboxOne;
/**
* **Deprecated:** This enum is deprecated as it is used by deprecated properties that are no longer functional. It should not be used.
*
* Controls which gear genres are permitted in a place.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearGenreSetting)
*/
export namespace GearGenreSetting {
/**
* **Deprecated:**
*
* All gear genres are allowed.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearGenreSetting#AllGenres)
*/
export interface AllGenres extends globalThis.EnumItem {
Name: "AllGenres";
Value: 0;
EnumType: typeof globalThis.Enum.GearGenreSetting;
}
export const AllGenres: AllGenres;
/**
* **Deprecated:**
*
* Only gear genres matching the allowed genres specified in a place's configuration settings.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearGenreSetting#MatchingGenreOnly)
*/
export interface MatchingGenreOnly extends globalThis.EnumItem {
Name: "MatchingGenreOnly";
Value: 1;
EnumType: typeof globalThis.Enum.GearGenreSetting;
}
export const MatchingGenreOnly: MatchingGenreOnly;
export function GetEnumItems(this: globalThis.Enum): Array;
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.GearGenreSetting | undefined;
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.GearGenreSetting | undefined;
}
export type GearGenreSetting = GearGenreSetting.AllGenres | GearGenreSetting.MatchingGenreOnly;
/**
* **Deprecated:** This enum is deprecated because it's used by deprecated properties. Don't use it.
*
* Categorizes gear items by type for use with deprecated gear-allowlist properties.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearType)
*/
export namespace GearType {
/**
* **Deprecated:**
*
* Gear with the 'Melee' attribute.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearType#MeleeWeapons)
*/
export interface MeleeWeapons extends globalThis.EnumItem {
Name: "MeleeWeapons";
Value: 0;
EnumType: typeof globalThis.Enum.GearType;
}
export const MeleeWeapons: MeleeWeapons;
/**
* **Deprecated:**
*
* Gear with the 'Ranged' attribute.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearType#RangedWeapons)
*/
export interface RangedWeapons extends globalThis.EnumItem {
Name: "RangedWeapons";
Value: 1;
EnumType: typeof globalThis.Enum.GearType;
}
export const RangedWeapons: RangedWeapons;
/**
* **Deprecated:**
*
* Gear with the 'Explosive' attribute.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearType#Explosives)
*/
export interface Explosives extends globalThis.EnumItem {
Name: "Explosives";
Value: 2;
EnumType: typeof globalThis.Enum.GearType;
}
export const Explosives: Explosives;
/**
* **Deprecated:**
*
* Gear with the 'Power Up' attribute.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearType#PowerUps)
*/
export interface PowerUps extends globalThis.EnumItem {
Name: "PowerUps";
Value: 3;
EnumType: typeof globalThis.Enum.GearType;
}
export const PowerUps: PowerUps;
/**
* **Deprecated:**
*
* Gear with the 'Navigation' attribute.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearType#NavigationEnhancers)
*/
export interface NavigationEnhancers extends globalThis.EnumItem {
Name: "NavigationEnhancers";
Value: 4;
EnumType: typeof globalThis.Enum.GearType;
}
export const NavigationEnhancers: NavigationEnhancers;
/**
* **Deprecated:**
*
* Gear with the 'Musical' attribute.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearType#MusicalInstruments)
*/
export interface MusicalInstruments extends globalThis.EnumItem {
Name: "MusicalInstruments";
Value: 5;
EnumType: typeof globalThis.Enum.GearType;
}
export const MusicalInstruments: MusicalInstruments;
/**
* **Deprecated:**
*
* Gear with the 'Social' attribute.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearType#SocialItems)
*/
export interface SocialItems extends globalThis.EnumItem {
Name: "SocialItems";
Value: 6;
EnumType: typeof globalThis.Enum.GearType;
}
export const SocialItems: SocialItems;
/**
* **Deprecated:**
*
* Gear with the 'Building' attribute.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearType#BuildingTools)
*/
export interface BuildingTools extends globalThis.EnumItem {
Name: "BuildingTools";
Value: 7;
EnumType: typeof globalThis.Enum.GearType;
}
export const BuildingTools: BuildingTools;
/**
* **Deprecated:**
*
* Gear with the 'Transport' attribute.
*
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GearType#Transport)
*/
export interface Transport extends globalThis.EnumItem {
Name: "Transport";
Value: 8;
EnumType: typeof globalThis.Enum.GearType;
}
export const Transport: Transport;
export function GetEnumItems(this: globalThis.Enum): Array