UNPKG

@rbxts/types

Version:

TypeScript typings for the Roblox platform. Partially handwritten and partially automatically generated.

1,464 lines 465 kB
// THIS FILE IS GENERATED AUTOMATICALLY AND SHOULD NOT BE EDITED BY HAND! /// <reference no-default-lib="true"/> /// <reference path="../roblox.d.ts" /> /// <reference path="enums.d.ts" /> interface Services { AccountService: AccountService; AchievementService: AchievementService; ActivityHistoryEventService: ActivityHistoryEventService; AnalyticsService: AnalyticsService; AnimationClipProvider: AnimationClipProvider; AnimationFromVideoCreatorService: AnimationFromVideoCreatorService; AnimationFromVideoCreatorStudioService: AnimationFromVideoCreatorStudioService; AnnotationsService: AnnotationsService; AppLifecycleObserverService: AppLifecycleObserverService; AppUpdateService: AppUpdateService; AssetCounterService: AssetCounterService; AssetDeliveryProxy: AssetDeliveryProxy; AssetImportService: AssetImportService; AssetManagerService: AssetManagerService; AssetService: AssetService; AudioFocusService: AudioFocusService; AuroraScriptService: AuroraScriptService; AuroraService: AuroraService; AvatarChatService: AvatarChatService; AvatarCreationService: AvatarCreationService; AvatarEditorService: AvatarEditorService; AvatarImportService: AvatarImportService; AvatarPreloader: AvatarPreloader; AvatarSettings: AvatarSettings; BadgeService: BadgeService; BugReporterService: BugReporterService; BulkImportService: BulkImportService; CalloutService: CalloutService; CaptureService: CaptureService; ChangeHistoryService: ChangeHistoryService; Chat: Chat; ChatbotUIService: ChatbotUIService; CloudCRUDService: CloudCRUDService; CollaboratorsService: CollaboratorsService; CollectionService: CollectionService; CommandService: CommandService; CommerceService: CommerceService; ConfigService: ConfigService; ConfigureServerService: ConfigureServerService; ConnectivityService: ConnectivityService; ContentProvider: ContentProvider; ContextActionService: ContextActionService; ControllerService: ControllerService; ConversationalAIAcceptanceService: ConversationalAIAcceptanceService; CoreGui: CoreGui; CoreScriptDebuggingManagerHelper: CoreScriptDebuggingManagerHelper; CreationDBService: CreationDBService; CreatorStoreService: CreatorStoreService; CrossDMScriptChangeListener: CrossDMScriptChangeListener; DataModelPatchService: DataModelPatchService; DataStoreService: DataStoreService; Debris: Debris; DebuggablePluginWatcher: DebuggablePluginWatcher; DebuggerConnectionManager: DebuggerConnectionManager; DebuggerManager: DebuggerManager; DebuggerUIService: DebuggerUIService; DeviceIdService: DeviceIdService; DraggerService: DraggerService; EditableService: EditableService; EventIngestService: EventIngestService; ExampleService: ExampleService; ExperienceAuthService: ExperienceAuthService; ExperienceNotificationService: ExperienceNotificationService; ExperienceService: ExperienceService; ExperienceStateCaptureService: ExperienceStateCaptureService; ExplorerServiceVisibilityService: ExplorerServiceVisibilityService; FaceAnimatorService: FaceAnimatorService; FacialAgeEstimationService: FacialAgeEstimationService; FacialAnimationRecordingService: FacialAnimationRecordingService; FacialAnimationStreamingServiceV2: FacialAnimationStreamingServiceV2; FeatureRestrictionManager: FeatureRestrictionManager; FeedService: FeedService; GamepadService: GamepadService; GamePassService: GamePassService; GenerationService: GenerationService; GenericChallengeService: GenericChallengeService; GeometryService: GeometryService; GroupService: GroupService; GuiService: GuiService; HapticService: HapticService; HeapProfilerService: HeapProfilerService; HeatmapService: HeatmapService; HeightmapImporterService: HeightmapImporterService; HttpService: HttpService; ILegacyStudioBridge: ILegacyStudioBridge; IncrementalPatchBuilder: IncrementalPatchBuilder; InsertService: InsertService; InternalSyncService: InternalSyncService; IXPService: IXPService; JointsService: JointsService; KeyframeSequenceProvider: KeyframeSequenceProvider; LanguageService: LanguageService; LegacyStudioBridge: LegacyStudioBridge; Lighting: Lighting; LinkingService: LinkingService; LiveScriptingService: LiveScriptingService; LiveSyncService: LiveSyncService; LocalizationService: LocalizationService; LodDataService: LodDataService; LogReporterService: LogReporterService; LogService: LogService; LSPFileSyncService: LSPFileSyncService; LuauScriptAnalyzerService: LuauScriptAnalyzerService; MarketplaceService: MarketplaceService; MatchmakingService: MatchmakingService; MaterialGenerationService: MaterialGenerationService; MaterialService: MaterialService; MemoryStoreService: MemoryStoreService; MessageBusService: MessageBusService; MessagingService: MessagingService; MetaBreakpointManager: MetaBreakpointManager; MLModelDeliveryService: MLModelDeliveryService; NetworkClient: NetworkClient; NetworkServer: NetworkServer; NetworkSettings: NetworkSettings; OmniRecommendationsService: OmniRecommendationsService; OpenCloudService: OpenCloudService; PackageService: PackageService; PackageUIService: PackageUIService; PatchBundlerFileWatch: PatchBundlerFileWatch; PathfindingService: PathfindingService; PerformanceControlService: PerformanceControlService; PhysicsService: PhysicsService; PlaceAssetIdsService: PlaceAssetIdsService; PlacesService: PlacesService; PlaceStatsService: PlaceStatsService; PlatformCloudStorageService: PlatformCloudStorageService; PlatformFriendsService: PlatformFriendsService; PlayerDataService: PlayerDataService; PlayerHydrationService: PlayerHydrationService; Players: Players; PlayerViewService: PlayerViewService; PluginDebugService: PluginDebugService; PluginGuiService: PluginGuiService; PluginManagementService: PluginManagementService; PluginPolicyService: PluginPolicyService; PolicyService: PolicyService; ProcessInstancePhysicsService: ProcessInstancePhysicsService; ProximityPromptService: ProximityPromptService; PublishService: PublishService; ReflectionService: ReflectionService; RemoteCursorService: RemoteCursorService; RemoteDebuggerServer: RemoteDebuggerServer; RenderSettings: RenderSettings; ReplicatedFirst: ReplicatedFirst; ReplicatedStorage: ReplicatedStorage; RibbonNotificationService: RibbonNotificationService; RobloxPluginGuiService: RobloxPluginGuiService; RobloxServerStorage: RobloxServerStorage; RomarkRbxAnalyticsService: RomarkRbxAnalyticsService; RomarkService: RomarkService; RtMessagingService: RtMessagingService; RunService: RunService; SafetyService: SafetyService; ScriptChangeService: ScriptChangeService; ScriptCloneWatcher: ScriptCloneWatcher; ScriptCloneWatcherHelper: ScriptCloneWatcherHelper; ScriptCommitService: ScriptCommitService; ScriptContext: ScriptContext; ScriptEditorService: ScriptEditorService; ScriptProfilerService: ScriptProfilerService; ScriptRegistrationService: ScriptRegistrationService; Selection: Selection; SelectionHighlightManager: SelectionHighlightManager; SerializationService: SerializationService; ServerScriptService: ServerScriptService; ServerStorage: ServerStorage; ServiceVisibilityService: ServiceVisibilityService; SessionService: SessionService; SharedTableRegistry: SharedTableRegistry; SlimContentProvider: SlimContentProvider; SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService; SnippetService: SnippetService; SocialService: SocialService; SoundService: SoundService; StarterGui: StarterGui; StarterPack: StarterPack; StarterPlayer: StarterPlayer; StartPageService: StartPageService; StartupMessageService: StartupMessageService; Stats: Stats; StreamingService: StreamingService; Studio: Studio; StudioAssetService: StudioAssetService; StudioCameraService: StudioCameraService; StudioData: StudioData; StudioDeviceEmulatorService: StudioDeviceEmulatorService; StudioPublishService: StudioPublishService; StudioScriptDebugEventListener: StudioScriptDebugEventListener; StudioSdkService: StudioSdkService; StudioService: StudioService; StudioUserService: StudioUserService; StudioWidgetsService: StudioWidgetsService; StylingService: StylingService; SystemThemeService: SystemThemeService; TaskScheduler: TaskScheduler; TeamCreateData: TeamCreateData; TeamCreatePublishService: TeamCreatePublishService; TeamCreateService: TeamCreateService; Teams: Teams; TelemetryService: TelemetryService; TeleportService: TeleportService; TemporaryCageMeshProvider: TemporaryCageMeshProvider; TemporaryScriptService: TemporaryScriptService; TestService: TestService; TextBoxService: TextBoxService; TextChatService: TextChatService; TextService: TextService; TextureGenerationService: TextureGenerationService; ToastNotificationService: ToastNotificationService; TracerService: TracerService; TutorialService: TutorialService; TweenService: TweenService; UGCAvatarService: UGCAvatarService; UIDragDetectorService: UIDragDetectorService; UniqueIdLookupService: UniqueIdLookupService; UnvalidatedAssetService: UnvalidatedAssetService; UserInputService: UserInputService; UserService: UserService; VersionControlService: VersionControlService; VideoCaptureService: VideoCaptureService; VideoService: VideoService; VisibilityCheckDispatcher: VisibilityCheckDispatcher; VisualizationModeService: VisualizationModeService; VoiceChatInternal: VoiceChatInternal; VoiceChatService: VoiceChatService; VRService: VRService; VRStatusService: VRStatusService; WebSocketService: WebSocketService; WebViewService: WebViewService; Workspace: Workspace; } interface CreatableInstances { Accessory: Accessory; AccessoryDescription: AccessoryDescription; Accoutrement: Accoutrement; Actor: Actor; AdGui: AdGui; AdPortal: AdPortal; AirController: AirController; AlignOrientation: AlignOrientation; AlignPosition: AlignPosition; AngularVelocity: AngularVelocity; Animation: Animation; AnimationConstraint: AnimationConstraint; AnimationController: AnimationController; AnimationRigData: AnimationRigData; Animator: Animator; Annotation: Annotation; ArcHandles: ArcHandles; Atmosphere: Atmosphere; AtmosphereSensor: AtmosphereSensor; Attachment: Attachment; AudioAnalyzer: AudioAnalyzer; AudioChannelMixer: AudioChannelMixer; AudioChannelSplitter: AudioChannelSplitter; AudioChorus: AudioChorus; AudioCompressor: AudioCompressor; AudioDeviceInput: AudioDeviceInput; AudioDeviceOutput: AudioDeviceOutput; AudioDistortion: AudioDistortion; AudioEcho: AudioEcho; AudioEmitter: AudioEmitter; AudioEqualizer: AudioEqualizer; AudioFader: AudioFader; AudioFilter: AudioFilter; AudioFlanger: AudioFlanger; AudioLimiter: AudioLimiter; AudioListener: AudioListener; AudioPitchShifter: AudioPitchShifter; AudioPlayer: AudioPlayer; AudioRecorder: AudioRecorder; AudioReverb: AudioReverb; AudioSearchParams: AudioSearchParams; AudioTextToSpeech: AudioTextToSpeech; AuroraScript: AuroraScript; AvatarAccessoryRules: AvatarAccessoryRules; AvatarAnimationRules: AvatarAnimationRules; AvatarBodyRules: AvatarBodyRules; AvatarClothingRules: AvatarClothingRules; AvatarCollisionRules: AvatarCollisionRules; AvatarRules: AvatarRules; Backpack: Backpack; BallSocketConstraint: BallSocketConstraint; Beam: Beam; BillboardGui: BillboardGui; BindableEvent: BindableEvent; BindableFunction: BindableFunction; BlockMesh: BlockMesh; BloomEffect: BloomEffect; BlurEffect: BlurEffect; BodyAngularVelocity: BodyAngularVelocity; BodyColors: BodyColors; BodyForce: BodyForce; BodyGyro: BodyGyro; BodyPartDescription: BodyPartDescription; BodyPosition: BodyPosition; BodyThrust: BodyThrust; BodyVelocity: BodyVelocity; Bone: Bone; BoolValue: BoolValue; BoxHandleAdornment: BoxHandleAdornment; Breakpoint: Breakpoint; BrickColorValue: BrickColorValue; BubbleChatMessageProperties: BubbleChatMessageProperties; BuoyancySensor: BuoyancySensor; Camera: Camera; CanvasGroup: CanvasGroup; CFrameValue: CFrameValue; CharacterMesh: CharacterMesh; ChorusSoundEffect: ChorusSoundEffect; ClickDetector: ClickDetector; ClimbController: ClimbController; Clouds: Clouds; Color3Value: Color3Value; ColorCorrectionEffect: ColorCorrectionEffect; ColorGradingEffect: ColorGradingEffect; CompressorSoundEffect: CompressorSoundEffect; ConeHandleAdornment: ConeHandleAdornment; Configuration: Configuration; ControllerManager: ControllerManager; ControllerPartSensor: ControllerPartSensor; CornerWedgePart: CornerWedgePart; CurveAnimation: CurveAnimation; CustomLog: CustomLog; CylinderHandleAdornment: CylinderHandleAdornment; CylinderMesh: CylinderMesh; CylindricalConstraint: CylindricalConstraint; DataStoreGetOptions: DataStoreGetOptions; DataStoreIncrementOptions: DataStoreIncrementOptions; DataStoreOptions: DataStoreOptions; DataStoreSetOptions: DataStoreSetOptions; Decal: Decal; DepthOfFieldEffect: DepthOfFieldEffect; Dialog: Dialog; DialogChoice: DialogChoice; DistortionSoundEffect: DistortionSoundEffect; DoubleConstrainedValue: DoubleConstrainedValue; DragDetector: DragDetector; Dragger: Dragger; EchoSoundEffect: EchoSoundEffect; EqualizerSoundEffect: EqualizerSoundEffect; EulerRotationCurve: EulerRotationCurve; ExperienceInviteOptions: ExperienceInviteOptions; ExplorerFilter: ExplorerFilter; Explosion: Explosion; FaceControls: FaceControls; FileMesh: FileMesh; Fire: Fire; FlangeSoundEffect: FlangeSoundEffect; FloatCurve: FloatCurve; FloorWire: FloorWire; FluidForceSensor: FluidForceSensor; Folder: Folder; ForceField: ForceField; Frame: Frame; GetTextBoundsParams: GetTextBoundsParams; Glue: Glue; GroundController: GroundController; Handles: Handles; HandRigDescription: HandRigDescription; HapticEffect: HapticEffect; Hat: Hat; HiddenSurfaceRemovalAsset: HiddenSurfaceRemovalAsset; Highlight: Highlight; HingeConstraint: HingeConstraint; Hole: Hole; Humanoid: Humanoid; HumanoidController: HumanoidController; HumanoidDescription: HumanoidDescription; HumanoidRigDescription: HumanoidRigDescription; IKControl: IKControl; ImageButton: ImageButton; ImageHandleAdornment: ImageHandleAdornment; ImageLabel: ImageLabel; InputAction: InputAction; InputBinding: InputBinding; InputContext: InputContext; IntConstrainedValue: IntConstrainedValue; InternalSyncItem: InternalSyncItem; IntersectOperation: IntersectOperation; IntValue: IntValue; Keyframe: Keyframe; KeyframeMarker: KeyframeMarker; KeyframeSequence: KeyframeSequence; LinearVelocity: LinearVelocity; LineForce: LineForce; LineHandleAdornment: LineHandleAdornment; LocalizationTable: LocalizationTable; LocalScript: LocalScript; ManualGlue: ManualGlue; ManualWeld: ManualWeld; MarkerCurve: MarkerCurve; MaterialVariant: MaterialVariant; MeshPart: MeshPart; Model: Model; ModuleScript: ModuleScript; Motor: Motor; Motor6D: Motor6D; MotorFeature: MotorFeature; NegateOperation: NegateOperation; NoCollisionConstraint: NoCollisionConstraint; Noise: Noise; NumberPose: NumberPose; NumberValue: NumberValue; ObjectValue: ObjectValue; OperationGraph: OperationGraph; Pants: Pants; Part: Part; ParticleEmitter: ParticleEmitter; PartOperation: PartOperation; Path2D: Path2D; PathfindingLink: PathfindingLink; PathfindingModifier: PathfindingModifier; PitchShiftSoundEffect: PitchShiftSoundEffect; Plane: Plane; PlaneConstraint: PlaneConstraint; PluginAction: PluginAction; PluginCapabilities: PluginCapabilities; PointLight: PointLight; Pose: Pose; PrismaticConstraint: PrismaticConstraint; ProximityPrompt: ProximityPrompt; RayValue: RayValue; RelativeGui: RelativeGui; RemoteEvent: RemoteEvent; RemoteFunction: RemoteFunction; RenderingTest: RenderingTest; ReverbSoundEffect: ReverbSoundEffect; RigidConstraint: RigidConstraint; RocketPropulsion: RocketPropulsion; RodConstraint: RodConstraint; RopeConstraint: RopeConstraint; Rotate: Rotate; RotateP: RotateP; RotateV: RotateV; RotationCurve: RotationCurve; RTAnimationTracker: RTAnimationTracker; ScreenGui: ScreenGui; Script: Script; ScrollingFrame: ScrollingFrame; Seat: Seat; SelectionBox: SelectionBox; SelectionPartLasso: SelectionPartLasso; SelectionPointLasso: SelectionPointLasso; SelectionSphere: SelectionSphere; Shirt: Shirt; ShirtGraphic: ShirtGraphic; SkateboardController: SkateboardController; SkateboardPlatform: SkateboardPlatform; Sky: Sky; Smoke: Smoke; Snap: Snap; Sound: Sound; SoundGroup: SoundGroup; Sparkles: Sparkles; SpawnLocation: SpawnLocation; SpecialMesh: SpecialMesh; SphereHandleAdornment: SphereHandleAdornment; SpotLight: SpotLight; SpringConstraint: SpringConstraint; StarterGear: StarterGear; StringValue: StringValue; StudioAttachment: StudioAttachment; StudioCallout: StudioCallout; StyleDerive: StyleDerive; StyleLink: StyleLink; StyleRule: StyleRule; StyleSheet: StyleSheet; SunRaysEffect: SunRaysEffect; SurfaceAppearance: SurfaceAppearance; SurfaceGui: SurfaceGui; SurfaceLight: SurfaceLight; SurfaceSelection: SurfaceSelection; SwimController: SwimController; Team: Team; TeleportOptions: TeleportOptions; TerrainDetail: TerrainDetail; TerrainRegion: TerrainRegion; TextBox: TextBox; TextButton: TextButton; TextChannel: TextChannel; TextChatCommand: TextChatCommand; TextChatMessageProperties: TextChatMessageProperties; TextLabel: TextLabel; Texture: Texture; Tool: Tool; Torque: Torque; TorsionSpringConstraint: TorsionSpringConstraint; TrackerStreamAnimation: TrackerStreamAnimation; Trail: Trail; TremoloSoundEffect: TremoloSoundEffect; TrussPart: TrussPart; UIAspectRatioConstraint: UIAspectRatioConstraint; UICorner: UICorner; UIDragDetector: UIDragDetector; UIFlexItem: UIFlexItem; UIGradient: UIGradient; UIGridLayout: UIGridLayout; UIListLayout: UIListLayout; UIPadding: UIPadding; UIPageLayout: UIPageLayout; UIScale: UIScale; UISizeConstraint: UISizeConstraint; UIStroke: UIStroke; UITableLayout: UITableLayout; UITextSizeConstraint: UITextSizeConstraint; UnionOperation: UnionOperation; UniversalConstraint: UniversalConstraint; UnreliableRemoteEvent: UnreliableRemoteEvent; Vector3Curve: Vector3Curve; Vector3Value: Vector3Value; VectorForce: VectorForce; VehicleController: VehicleController; VehicleSeat: VehicleSeat; VelocityMotor: VelocityMotor; VideoDeviceInput: VideoDeviceInput; VideoDisplay: VideoDisplay; VideoFrame: VideoFrame; VideoPlayer: VideoPlayer; ViewportFrame: ViewportFrame; VisualizationMode: VisualizationMode; VisualizationModeCategory: VisualizationModeCategory; WedgePart: WedgePart; Weld: Weld; WeldConstraint: WeldConstraint; Wire: Wire; WireframeHandleAdornment: WireframeHandleAdornment; WorkspaceAnnotation: WorkspaceAnnotation; WorldModel: WorldModel; WrapDeformer: WrapDeformer; WrapLayer: WrapLayer; WrapTarget: WrapTarget; } interface Instances extends Services, CreatableInstances { AnimationClip: AnimationClip; AnimationImportData: AnimationImportData; AnimationStreamTrack: AnimationStreamTrack; AnimationTrack: AnimationTrack; AssetImportSession: AssetImportSession; AssetPatchSettings: AssetPatchSettings; AssetSoundEffect: AssetSoundEffect; AudioPages: AudioPages; AuroraScriptObject: AuroraScriptObject; BackpackItem: BackpackItem; BanHistoryPages: BanHistoryPages; BaseImportData: BaseImportData; BasePart: BasePart; BasePlayerGui: BasePlayerGui; BaseRemoteEvent: BaseRemoteEvent; BaseScript: BaseScript; BaseWrap: BaseWrap; BevelMesh: BevelMesh; BodyMover: BodyMover; BubbleChatConfiguration: BubbleChatConfiguration; CatalogPages: CatalogPages; ChannelSelectorSoundEffect: ChannelSelectorSoundEffect; ChannelTabsConfiguration: ChannelTabsConfiguration; CharacterAppearance: CharacterAppearance; ChatInputBarConfiguration: ChatInputBarConfiguration; ChatWindowConfiguration: ChatWindowConfiguration; ChatWindowMessageProperties: ChatWindowMessageProperties; ClientReplicator: ClientReplicator; Clothing: Clothing; CloudLocalizationTable: CloudLocalizationTable; Collaborator: Collaborator; CommandInstance: CommandInstance; Constraint: Constraint; Controller: Controller; ControllerBase: ControllerBase; ControllerSensor: ControllerSensor; CustomSoundEffect: CustomSoundEffect; DataModel: DataModel; DataModelMesh: DataModelMesh; DataModelSession: DataModelSession; DataStore: DataStore; DataStoreInfo: DataStoreInfo; DataStoreKey: DataStoreKey; DataStoreKeyInfo: DataStoreKeyInfo; DataStoreKeyPages: DataStoreKeyPages; DataStoreListingPages: DataStoreListingPages; DataStoreObjectVersionInfo: DataStoreObjectVersionInfo; DataStorePages: DataStorePages; DataStoreVersionPages: DataStoreVersionPages; DebuggerBreakpoint: DebuggerBreakpoint; DebuggerConnection: DebuggerConnection; DebuggerLuaResponse: DebuggerLuaResponse; DebuggerVariable: DebuggerVariable; DebuggerWatch: DebuggerWatch; DebugSettings: DebugSettings; DockWidgetPluginGui: DockWidgetPluginGui; DynamicRotate: DynamicRotate; EmotesPages: EmotesPages; ExplorerFilterAutocompleter: ExplorerFilterAutocompleter; FaceInstance: FaceInstance; FacialAnimationStreamingServiceStats: FacialAnimationStreamingServiceStats; FacialAnimationStreamingSubsessionStats: FacialAnimationStreamingSubsessionStats; FacsImportData: FacsImportData; Feature: Feature; FeedPages: FeedPages; File: File; FormFactorPart: FormFactorPart; FriendPages: FriendPages; GameSettings: GameSettings; GenericSettings: GenericSettings; GlobalDataStore: GlobalDataStore; GlobalSettings: GlobalSettings; GroupImportData: GroupImportData; GuiBase: GuiBase; GuiBase2d: GuiBase2d; GuiBase3d: GuiBase3d; GuiButton: GuiButton; GuiLabel: GuiLabel; GuiObject: GuiObject; HandleAdornment: HandleAdornment; HandlesBase: HandlesBase; ImportSession: ImportSession; InputObject: InputObject; Instance: Instance; InstanceAdornment: InstanceAdornment; InventoryPages: InventoryPages; JointImportData: JointImportData; JointInstance: JointInstance; LayerCollector: LayerCollector; Light: Light; LocalDebuggerConnection: LocalDebuggerConnection; LodDataEntity: LodDataEntity; LuaSettings: LuaSettings; LuaSourceContainer: LuaSourceContainer; ManualSurfaceJointInstance: ManualSurfaceJointInstance; MaterialGenerationSession: MaterialGenerationSession; MaterialImportData: MaterialImportData; MemoryStoreHashMap: MemoryStoreHashMap; MemoryStoreHashMapPages: MemoryStoreHashMapPages; MemoryStoreQueue: MemoryStoreQueue; MemoryStoreSortedMap: MemoryStoreSortedMap; MemStorageConnection: MemStorageConnection; MeshImportData: MeshImportData; MessageBusConnection: MessageBusConnection; MetaBreakpoint: MetaBreakpoint; MetaBreakpointContext: MetaBreakpointContext; Mouse: Mouse; MultipleDocumentInterfaceInstance: MultipleDocumentInterfaceInstance; NetworkMarker: NetworkMarker; NetworkPeer: NetworkPeer; NetworkReplicator: NetworkReplicator; OpenCloudApiV1: OpenCloudApiV1; OrderedDataStore: OrderedDataStore; OutfitPages: OutfitPages; PackageLink: PackageLink; Pages: Pages; ParabolaAdornment: ParabolaAdornment; PartAdornment: PartAdornment; PatchMapping: PatchMapping; Path: Path; PausedState: PausedState; PausedStateBreakpoint: PausedStateBreakpoint; PausedStateException: PausedStateException; PhysicsSettings: PhysicsSettings; Platform: Platform; Player: Player; PlayerData: PlayerData; PlayerDataRecord: PlayerDataRecord; PlayerDataRecordConfig: PlayerDataRecordConfig; PlayerGui: PlayerGui; PlayerMouse: PlayerMouse; PlayerScripts: PlayerScripts; Plugin: Plugin; PluginDragEvent: PluginDragEvent; PluginGui: PluginGui; PluginManagerInterface: PluginManagerInterface; PluginMenu: PluginMenu; PluginMouse: PluginMouse; PluginToolbar: PluginToolbar; PluginToolbarButton: PluginToolbarButton; PoseBase: PoseBase; PostEffect: PostEffect; PVAdornment: PVAdornment; PVInstance: PVInstance; QWidgetPluginGui: QWidgetPluginGui; RobloxSerializableInstance: RobloxSerializableInstance; RootImportData: RootImportData; RunningAverageItemDouble: RunningAverageItemDouble; RunningAverageItemInt: RunningAverageItemInt; RunningAverageTimeIntervalItem: RunningAverageTimeIntervalItem; ScreenshotHud: ScreenshotHud; ScriptBuilder: ScriptBuilder; ScriptDebugger: ScriptDebugger; ScriptDocument: ScriptDocument; ScriptRuntime: ScriptRuntime; SelectionLasso: SelectionLasso; SensorBase: SensorBase; ServerReplicator: ServerReplicator; ServiceProvider: ServiceProvider; SlidingBallConstraint: SlidingBallConstraint; SoundEffect: SoundEffect; StackFrame: StackFrame; StandardPages: StandardPages; StarterCharacterScripts: StarterCharacterScripts; StarterPlayerScripts: StarterPlayerScripts; StatsItem: StatsItem; StudioObjectBase: StudioObjectBase; StudioTheme: StudioTheme; StudioWidget: StudioWidget; StyleBase: StyleBase; SurfaceGuiBase: SurfaceGuiBase; SyncScriptBuilder: SyncScriptBuilder; TeleportAsyncResult: TeleportAsyncResult; Terrain: Terrain; TextChatConfigurations: TextChatConfigurations; TextChatMessage: TextChatMessage; TextFilterResult: TextFilterResult; TextFilterTranslatedResult: TextFilterTranslatedResult; TextSource: TextSource; TextureGenerationPartGroup: TextureGenerationPartGroup; TextureGenerationUnwrappingRequest: TextureGenerationUnwrappingRequest; ThreadState: ThreadState; TotalCountTimeIntervalItem: TotalCountTimeIntervalItem; TouchTransmitter: TouchTransmitter; TrackerLodController: TrackerLodController; Translator: Translator; TriangleMeshPart: TriangleMeshPart; Tween: Tween; TweenBase: TweenBase; UIBase: UIBase; UIComponent: UIComponent; UIConstraint: UIConstraint; UIGridStyleLayout: UIGridStyleLayout; UILayout: UILayout; UserGameSettings: UserGameSettings; UserSettings: UserSettings; ValueBase: ValueBase; WebSocketClient: WebSocketClient; WorldRoot: WorldRoot; } interface Objects extends Instances { Capture: Capture; ConfigSnapshot: ConfigSnapshot; EditableImage: EditableImage; EditableMesh: EditableMesh; Object: RBXObject; ScreenshotCapture: ScreenshotCapture; TerrainIterateOperation: TerrainIterateOperation; TerrainModifyOperation: TerrainModifyOperation; TerrainReadOperation: TerrainReadOperation; TerrainWriteOperation: TerrainWriteOperation; VideoCapture: VideoCapture; } // GENERATED ROBLOX INSTANCE CLASSES /** * Object is the base class for all classes in the Roblox class hierarchy. * * - **Tags**: NotCreatable, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Object) */ interface RBXObject { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_Object: unique symbol; } /** * - **Tags**: NotCreatable, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Capture) */ interface Capture extends RBXObject { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_Capture: unique symbol; } /** * - **Tags**: NotCreatable, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScreenshotCapture) */ interface ScreenshotCapture extends Capture { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_ScreenshotCapture: unique symbol; } /** * - **Tags**: NotCreatable, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoCapture) */ interface VideoCapture extends Capture { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_VideoCapture: unique symbol; } /** * - **Tags**: NotCreatable, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot) */ interface ConfigSnapshot extends RBXObject { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_ConfigSnapshot: unique symbol; } /** * Instance which allows for the runtime creation and manipulation of images. * * - **Tags**: NotCreatable * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage) */ interface EditableImage extends RBXObject { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_EditableImage: unique symbol; } /** * Instance which allows for the runtime creation and manipulation of meshes. * * - **Tags**: NotCreatable * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh) */ interface EditableMesh extends RBXObject { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_EditableMesh: unique symbol; } /** * `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree. * * - **Tags**: NotCreatable, NotBrowsable * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance) */ interface Instance extends RBXObject { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_Instance: unique symbol; /** * A deprecated property that used to protect `CoreGui` objects. * * - **ThreadSafety**: ReadSafe * - **Tags**: Hidden * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#RobloxLocked) */ RobloxLocked: boolean; /** * Returns a coded string of the debug ID used internally by Roblox. * * - **ThreadSafety**: Unsafe * - **Tags**: NotBrowsable * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetDebugId) * @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree. * @param scopeLength The scope length. * @returns The Debug ID string. */ GetDebugId(this: Instance, scopeLength?: number): string; } /** * Describes the appearance of an `Accessory` for the `HumanoidDescription`. * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription) */ interface AccessoryDescription extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AccessoryDescription: unique symbol; } /** * - **Tags**: NotCreatable, Service, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AccountService) */ interface AccountService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AccountService: unique symbol; } /** * An object that can attach to a player's character. * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Accoutrement) */ interface Accoutrement extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_Accoutrement: unique symbol; } /** * An item that a Character can wear. * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Accessory) */ interface Accessory extends Accoutrement { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_Accessory: unique symbol; } /** * **Deprecated:** This class has been superseded by the `Accessory` class. Do not use it for new work. * * - **Tags**: * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Hat) * * @deprecated */ interface Hat extends Accoutrement { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_Hat: unique symbol; } /** * - **Tags**: NotCreatable, Service, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AchievementService) */ interface AchievementService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AchievementService: unique symbol; } /** * - **Tags**: NotCreatable, Service * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ActivityHistoryEventService) */ interface ActivityHistoryEventService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_ActivityHistoryEventService: unique symbol; } /** * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPortal) */ interface AdPortal extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AdPortal: unique symbol; } /** * Collection of methods that allows developers to track how users interact with their experiences. * * - **Tags**: NotCreatable, Service, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnalyticsService) */ interface AnalyticsService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AnalyticsService: unique symbol; } /** * References an animation asset which can be loaded by an `AnimationController`. * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animation) */ interface Animation extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_Animation: unique symbol; } /** * Represents all types of animation data that the Roblox animation system can consume. * * - **Tags**: NotCreatable * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationClip) */ interface AnimationClip extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AnimationClip: unique symbol; } /** * Stores animation data in the form of curves for each individual channel to animate. * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CurveAnimation) */ interface CurveAnimation extends AnimationClip { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_CurveAnimation: unique symbol; } /** * This object stores all of the `Keyframes` and other data for the animation. * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/KeyframeSequence) */ interface KeyframeSequence extends AnimationClip { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_KeyframeSequence: unique symbol; /** * Contains the hip height of the `Humanoid` of the model that was used to author this `KeyframeSequence`. * * - **ThreadSafety**: ReadSafe * - **Tags**: Hidden * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/KeyframeSequence#AuthoredHipHeight) */ AuthoredHipHeight: number; } /** * Provides functions to load and preview `AnimationClips`. * * - **Tags**: NotCreatable, Service, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider) */ interface AnimationClipProvider extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AnimationClipProvider: unique symbol; /** * **Deprecated:** This function is deprecated and can lead to the game freezing until the animation is loaded. Developers are recommended to use `GetAnimationClipAsync` instead. * * Returns a `AnimationClip` from a given asset URL. * * - **ThreadSafety**: Unsafe * - **Tags**: * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetAnimationClip) * @param this Provides functions to load and preview `AnimationClips`. * @param assetId The content ID of the animation. * @returns The `AnimationClip` found. * * @deprecated GetAnimationClipAsync */ GetAnimationClip(this: AnimationClipProvider, assetId: ContentId): AnimationClip; /** * **Deprecated:** This function is deprecated and can lead to the game freezing until the animation is loaded. Developers are recommended to use `GetAnimationClipAsync` instead. * * Returns a `AnimationClip` from the supplied assetId. * * - **ThreadSafety**: Unsafe * - **Tags**: * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetAnimationClipById) * @param this Provides functions to load and preview `AnimationClips`. * @param assetId The content ID of the animation. * @param useCache True if a cached version can be returned. * @returns The `AnimationClip` found. * * @deprecated GetAnimationClipAsync */ GetAnimationClipById(this: AnimationClipProvider, assetId: number, useCache: boolean): AnimationClip; } /** * Allows animations to be loaded and applied to a character or model in place of a `Humanoid`. * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationController) */ interface AnimationController extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AnimationController: unique symbol; } /** * - **Tags**: NotCreatable, Service * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationFromVideoCreatorService) */ interface AnimationFromVideoCreatorService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AnimationFromVideoCreatorService: unique symbol; } /** * - **Tags**: NotCreatable, Service, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationFromVideoCreatorStudioService) */ interface AnimationFromVideoCreatorStudioService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AnimationFromVideoCreatorStudioService: unique symbol; } /** * Used to store information regarding the model an animation was authored for. * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationRigData) */ interface AnimationRigData extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AnimationRigData: unique symbol; } /** * - **Tags**: NotCreatable, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationStreamTrack) */ interface AnimationStreamTrack extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AnimationStreamTrack: unique symbol; } /** * Controls the playback of an animation on an `Animator`. * * - **Tags**: NotCreatable * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack) */ interface AnimationTrack extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AnimationTrack: unique symbol; } /** * Responsible for the playback and replication of `Animations`. * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator) */ interface Animator extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_Animator: unique symbol; /** * Increments the `AnimationTrack.TimePosition` of all playing `AnimationTracks` that are loaded onto the `Animator`, applying the offsets to the model associated with the `Animator`. For use in the command bar or by plugins only. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#StepAnimations) * @param this Responsible for the playback and replication of `Animations`. * @param deltaTime The amount of time in seconds animation playback is to be incremented by. */ StepAnimations(this: Animator, deltaTime: number): void; } /** * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Annotation) */ interface Annotation extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_Annotation: unique symbol; } /** * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorkspaceAnnotation) */ interface WorkspaceAnnotation extends Annotation { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_WorkspaceAnnotation: unique symbol; } /** * - **Tags**: NotCreatable, Service * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnnotationsService) */ interface AnnotationsService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AnnotationsService: unique symbol; } /** * - **Tags**: NotCreatable, Service, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AppLifecycleObserverService) */ interface AppLifecycleObserverService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AppLifecycleObserverService: unique symbol; } /** * - **Tags**: NotCreatable, Service, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AppUpdateService) */ interface AppUpdateService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AppUpdateService: unique symbol; } /** * - **Tags**: NotCreatable, Service, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetCounterService) */ interface AssetCounterService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AssetCounterService: unique symbol; } /** * - **Tags**: NotCreatable, Service, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetDeliveryProxy) */ interface AssetDeliveryProxy extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AssetDeliveryProxy: unique symbol; } /** * - **Tags**: NotCreatable, Service, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetImportService) */ interface AssetImportService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AssetImportService: unique symbol; } /** * - **Tags**: NotCreatable, Service, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetManagerService) */ interface AssetManagerService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AssetManagerService: unique symbol; } /** * - **Tags**: NotCreatable, NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetPatchSettings) */ interface AssetPatchSettings extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AssetPatchSettings: unique symbol; } /** * A non-replicated service that handles asset-related queries to the Roblox web API. * * - **Tags**: NotCreatable, Service * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService) */ interface AssetService extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_AssetService: unique symbol; } /** * The `Atmosphere` object pushes Roblox closer toward realistic environments where sunlight scatters in different ways depending on density and other air particle properties. * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Atmosphere) */ interface Atmosphere extends Instance { /** * **DO NOT USE!** * * This field exists to force TypeScript to recognize this as a nominal type * @hidden * @deprecated */ readonly _nominal_Atmosphere: unique symbol; } /** * Defines a point and orientation relative to a parent `BasePart`, `Bone`, or another `Attachment`. * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment) */ interface Attac