UNPKG

@rbxts/types

Version:

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

1,232 lines 1.7 MB
// 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; 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; CoreScriptDebuggingManagerHelper: CoreScriptDebuggingManagerHelper; CreationDBService: CreationDBService; CreatorStoreService: CreatorStoreService; CrossDMScriptChangeListener: CrossDMScriptChangeListener; DataModelPatchService: DataModelPatchService; DataStoreService: DataStoreService; Debris: Debris; DebuggablePluginWatcher: DebuggablePluginWatcher; DebuggerConnectionManager: DebuggerConnectionManager; 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; OmniRecommendationsService: OmniRecommendationsService; OpenCloudService: OpenCloudService; 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; PluginManagementService: PluginManagementService; PluginPolicyService: PluginPolicyService; PolicyService: PolicyService; ProcessInstancePhysicsService: ProcessInstancePhysicsService; ProximityPromptService: ProximityPromptService; PublishService: PublishService; ReflectionService: ReflectionService; RemoteCursorService: RemoteCursorService; RemoteDebuggerServer: RemoteDebuggerServer; ReplicatedFirst: ReplicatedFirst; ReplicatedStorage: ReplicatedStorage; RibbonNotificationService: RibbonNotificationService; RobloxServerStorage: RobloxServerStorage; RomarkRbxAnalyticsService: RomarkRbxAnalyticsService; RomarkService: RomarkService; RtMessagingService: RtMessagingService; RunService: RunService; SafetyService: SafetyService; ScriptChangeService: ScriptChangeService; ScriptCloneWatcher: ScriptCloneWatcher; ScriptCloneWatcherHelper: ScriptCloneWatcherHelper; ScriptCommitService: ScriptCommitService; ScriptContext: ScriptContext; ScriptProfilerService: ScriptProfilerService; ScriptRegistrationService: ScriptRegistrationService; 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; StudioAssetService: StudioAssetService; StudioCameraService: StudioCameraService; StudioDeviceEmulatorService: StudioDeviceEmulatorService; StudioPublishService: StudioPublishService; StudioScriptDebugEventListener: StudioScriptDebugEventListener; StudioSdkService: StudioSdkService; StudioUserService: StudioUserService; StudioWidgetsService: StudioWidgetsService; StylingService: StylingService; SystemThemeService: SystemThemeService; 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; 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; PluginCapabilities: PluginCapabilities; PointLight: PointLight; Pose: Pose; PrismaticConstraint: PrismaticConstraint; ProximityPrompt: ProximityPrompt; RayValue: RayValue; RelativeGui: RelativeGui; RemoteEvent: RemoteEvent; RemoteFunction: RemoteFunction; 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; Clothing: Clothing; CloudLocalizationTable: CloudLocalizationTable; Collaborator: Collaborator; CommandInstance: CommandInstance; Constraint: Constraint; Controller: Controller; ControllerBase: ControllerBase; ControllerSensor: ControllerSensor; CustomSoundEffect: CustomSoundEffect; DataModel: DataModel; DataModelMesh: DataModelMesh; DataStore: DataStore; DataStoreInfo: DataStoreInfo; DataStoreKey: DataStoreKey; DataStoreKeyInfo: DataStoreKeyInfo; DataStoreKeyPages: DataStoreKeyPages; DataStoreListingPages: DataStoreListingPages; DataStoreObjectVersionInfo: DataStoreObjectVersionInfo; DataStorePages: DataStorePages; DataStoreVersionPages: DataStoreVersionPages; DebuggerConnection: DebuggerConnection; DebuggerLuaResponse: DebuggerLuaResponse; DebuggerVariable: DebuggerVariable; DynamicRotate: DynamicRotate; EmotesPages: EmotesPages; ExplorerFilterAutocompleter: ExplorerFilterAutocompleter; FaceInstance: FaceInstance; FacialAnimationStreamingServiceStats: FacialAnimationStreamingServiceStats; FacialAnimationStreamingSubsessionStats: FacialAnimationStreamingSubsessionStats; FacsImportData: FacsImportData; Feature: Feature; FeedPages: FeedPages; FormFactorPart: FormFactorPart; FriendPages: FriendPages; GenericSettings: GenericSettings; GlobalDataStore: GlobalDataStore; 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; LuaSourceContainer: LuaSourceContainer; ManualSurfaceJointInstance: ManualSurfaceJointInstance; MaterialGenerationSession: MaterialGenerationSession; MaterialImportData: MaterialImportData; MemoryStoreHashMap: MemoryStoreHashMap; MemoryStoreHashMapPages: MemoryStoreHashMapPages; MemoryStoreQueue: MemoryStoreQueue; MemoryStoreSortedMap: MemoryStoreSortedMap; MeshImportData: MeshImportData; MessageBusConnection: MessageBusConnection; MetaBreakpoint: MetaBreakpoint; MetaBreakpointContext: MetaBreakpointContext; Mouse: Mouse; NetworkMarker: NetworkMarker; OpenCloudApiV1: OpenCloudApiV1; OrderedDataStore: OrderedDataStore; OutfitPages: OutfitPages; PackageLink: PackageLink; Pages: Pages; ParabolaAdornment: ParabolaAdornment; PartAdornment: PartAdornment; PatchMapping: PatchMapping; Path: Path; PausedState: PausedState; PausedStateBreakpoint: PausedStateBreakpoint; PausedStateException: PausedStateException; Platform: Platform; Player: Player; PlayerData: PlayerData; PlayerDataRecord: PlayerDataRecord; PlayerDataRecordConfig: PlayerDataRecordConfig; PlayerGui: PlayerGui; PlayerMouse: PlayerMouse; PlayerScripts: PlayerScripts; PluginManagerInterface: PluginManagerInterface; PoseBase: PoseBase; PostEffect: PostEffect; PVAdornment: PVAdornment; PVInstance: PVInstance; RobloxSerializableInstance: RobloxSerializableInstance; RootImportData: RootImportData; ScreenshotHud: ScreenshotHud; ScriptBuilder: ScriptBuilder; ScriptRuntime: ScriptRuntime; SelectionLasso: SelectionLasso; SensorBase: SensorBase; ServiceProvider: ServiceProvider; SlidingBallConstraint: SlidingBallConstraint; SoundEffect: SoundEffect; StackFrame: StackFrame; StandardPages: StandardPages; StarterCharacterScripts: StarterCharacterScripts; StarterPlayerScripts: StarterPlayerScripts; StudioObjectBase: StudioObjectBase; 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; 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; /** * A read-only string representing the class this `Object` belongs to. * * - **ThreadSafety**: ReadSafe * - **Tags**: NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Object#ClassName) */ readonly ClassName: string; /** * Get an event that fires when a given property of the object changes. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Object#GetPropertyChangedSignal) * @param this Object is the base class for all classes in the Roblox class hierarchy. * @param property The property to connect to. * @returns A signal that fires whenever the property changes. */ GetPropertyChangedSignal<T extends RBXObject>(this: T, propertyName: InstancePropertyNames<T>): RBXScriptSignal<() => void>; /** * Returns true if an object's class matches or inherits from a given class. * * - **ThreadSafety**: Safe * - **Tags**: CustomLuaState * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Object#IsA) * @param this Object is the base class for all classes in the Roblox class hierarchy. * @param className The class against which the Object's class will be checked. Case-sensitive. * @returns Describes whether the Object's class matched or is a subclass of the given class. */ IsA<T extends keyof Objects>(this: RBXObject, className: T): this is Objects[T]; /** * Fired immediately after a property of the object changes, with some limitations. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Object#Changed) */ readonly Changed: unknown; } /** * - **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; /** * - **ThreadSafety**: ReadSafe * - **Tags**: NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Error) */ readonly Error: Enum.ConfigSnapshotErrorState; /** * - **ThreadSafety**: ReadSafe * - **Tags**: NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Outdated) */ readonly Outdated: boolean; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValue) * @param this * @param key * @param defaultValue */ GetValue(this: ConfigSnapshot, key: string, defaultValue: unknown): unknown; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValueChangedSignal) * @param this * @param key */ GetValueChangedSignal(this: ConfigSnapshot, key: string): RBXScriptSignal; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Refresh) * @param this */ Refresh(this: ConfigSnapshot): void; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#UpdateAvailable) */ readonly UpdateAvailable: RBXScriptSignal<() => void>; } /** * 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; /** * Size of the `EditableImage` in pixels. * * - **ThreadSafety**: ReadSafe * - **Tags**: NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#Size) */ readonly Size: Vector2; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#Destroy) * @param this Instance which allows for the runtime creation and manipulation of images. */ Destroy(this: EditableImage): void; /** * Draws a circle at the specified point. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawCircle) * @param this Instance which allows for the runtime creation and manipulation of images. * @param center Center of the circle, relative to the top-left corner of the `EditableImage`. Positions outside the canvas bounds are allowed. * @param radius Radius of the circle in pixels. * @param color Color of the circle. * @param transparency Transparency of the circle with 0 being fully opaque and 1 being fully transparent. * @param combineType How the pixels of the source image are blended with the pixels of the added image. */ DrawCircle(this: EditableImage, center: Vector2, radius: number, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>): void; /** * Draws another `EditableImage` into this `EditableImage` at the given position. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImage) * @param this Instance which allows for the runtime creation and manipulation of images. * @param position Position at which the top-left corner of the added image will be drawn. * @param image The `EditableImage` to draw into this `EditableImage`. * @param combineType How the pixels of the source image should be blended with the pixels of the added image. */ DrawImage(this: EditableImage, position: Vector2, image: EditableImage, combineType: CastsToEnum<Enum.ImageCombineType>): void; /** * Projects another `EditableImage` into an `EditableMesh` and stores the result on this `EditableImage`. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImageProjected) * @param this Instance which allows for the runtime creation and manipulation of images. * @param mesh The `EditableMesh` used to project into. * @param projection Projection configuration dictionary including the following key-value pairs: - `Direction` (`Vector3`) where the projector is facing. * - `Position` (`Vector3`) as the position in local space with respect to the mesh. * - `Size` (`Vector3`) as the size of the projector. * - `Up` (`Vector3`) as the up vector of the projector in local space with respect to the mesh. * * * @param brushConfig Brush configuration dictionary including the following key-value pairs: - `AlphaBlendType` (`ImageAlphaType`) which determines how this projection will blend alpha values. * - `ColorBlendType` (`ImageCombineType`) which determines how this projection will blend color values. * - `Decal` (`EditableImage`) as the image used for projection. * - `FadeAngle` (number) as the angle in degrees for the projection edges to fall off. * - `BlendIntensity` (number) as the value between `0` and `1` which controls how much of the projection is blended into the resulting image. */ DrawImageProjected(this: EditableImage, mesh: EditableMesh, projection: DrawImageProjectedProjection, brushConfig: DrawImageProjectedBrushConfig): void; /** * Draws an image into this `EditableImage` with transformations including scaling and rotation, placing it at the specified position. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImageTransformed) * @param this Instance which allows for the runtime creation and manipulation of images. * @param position Position in pixels where the pivot point of the source image will be placed on this image. * @param scale Scaling factors for the source image along the X and Y axes. * @param rotation The rotation angle in degrees, applied around the pivot point of the source image. * @param image The source `EditableImage` to be drawn into this image. * @param options Optional dictionary for additional configuration: - `CombineType`: Specifies how the pixels of the source image blend with those of the destination. Default is `ImageCombineType.AlphaBlend`. * - `SamplingMode`: Specifies the sampling method (e.g. `Default` for bilinear or `Pixelated` for nearest neighbor). Default is `ResamplerMode.Default`. * - `PivotPoint`: Specifies the pivot point within the source image for scaling and rotation. Default is the center of the source image (i.e. `Size / 2`). */ DrawImageTransformed(this: EditableImage, position: Vector2, scale: Vector2, rotation: number, image: EditableImage, options: DrawImageTransformedOptions): void; /** * Draws a line between two provided points. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawLine) * @param this Instance which allows for the runtime creation and manipulation of images. * @param p1 Start point of the line. * @param p2 End point of the line. * @param color Color of the line. * @param transparency Transparency of the line. * @param combineType How the pixels of the source image are blended with the pixels of the added image. */ DrawLine(this: EditableImage, p1: Vector2, p2: Vector2, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>): void; /** * Draws a rectangle of the given size at the given top-left position. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawRectangle) * @param this Instance which allows for the runtime creation and manipulation of images. * @param position Position of the top-left of the rectangle. Unlike other drawing methods, this cannot be outside the canvas bounds of the `EditableImage`. * @param size Size of the rectangle to draw, in pixels. * @param color Color of the rectangle. * @param transparency Transparency of the rectangle. * @param combineType How the pixels of the source image are blended with the pixels of the added image. */ DrawRectangle(this: EditableImage, position: Vector2, size: Vector2, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>): void; /** * Reads a rectangular region of pixels into a buffer. * * - **ThreadSafety**: Safe * - **Tags**: CustomLuaState * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#ReadPixelsBuffer) * @param this Instance which allows for the runtime creation and manipulation of images. * @param position Top-left corner of the rectangular region of pixels to read. * @param size Size of the rectangular region of pixels to read. * @returns Buffer where each pixel is represented by four bytes (red, green, blue and alpha respectively). The length of the buffer can be calculated as `X * Size.Y * 4` bytes. */ ReadPixelsBuffer(this: EditableImage, position: Vector2, size: Vector2): buffer; /** * Writes a rectangular region of pixels into the image. * * - **ThreadSafety**: Unsafe * - **Tags**: CustomLuaState * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#WritePixelsBuffer) * @param this Instance which allows for the runtime creation and manipulation of images. * @param position Top-left corner of the rectangular region to draw the pixels into. * @param size Size of the rectangular region of pixels to write. * @param buffer A buffer where each pixel is represented by four bytes (red, green, blue, and alpha respectively). The length of the buffer should be `X * Size.Y * 4` bytes. */ WritePixelsBuffer(this: EditableImage, position: Vector2, size: Vector2, buffer: buffer): void; } /** * 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; /** * Returns `true` if a mesh is fixed-size. * * - **ThreadSafety**: ReadSafe * - **Tags**: NotReplicated * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FixedSize) */ get FixedSize(): boolean; /** * **Deprecated:** * * - **ThreadSafety**: ReadSafe * - **Tags**: * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SkinningEnabled) * * @deprecated */ SkinningEnabled: boolean; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddBone) */ AddBone(this: EditableMesh, boneProperties: object): number; /** * Adds a new color to the geometry and returns a stable color ID. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddColor) * @param this Instance which allows for the runtime creation and manipulation of meshes. * @param color The new color. * @param alpha The color alpha (transparency). * @returns Stable color ID of the new color. */ AddColor(this: EditableMesh, color: Color3, alpha: number): number; /** * Adds a new normal to the geometry and returns a stable normal ID. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddNormal) * @param this Instance which allows for the runtime creation and manipulation of meshes. * @param normal The normal vector. If the normal value isn't specified, the normal will be automatically calculated. * @returns Stable normal ID of the new normal. */ AddNormal(this: EditableMesh, normal?: Vector3): number; /** * Adds a new triangle to the mesh and returns a stable face ID. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddTriangle) * @param this Instance which allows for the runtime creation and manipulation of meshes. * @param vertexId0 ID of the first vertex of the triangle. * @param vertexId1 ID of the second vertex of the triangle. * @param vertexId2 ID of the third vertex of the triangle. * @returns Stable face ID of the new face. */ AddTriangle(this: EditableMesh, vertexId0: number, vertexId1: number, vertexId2: number): number; /** * Adds a new UV to the geometry and returns a stable UV ID. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddUV) * @param this Instance which allows for the runtime creation and manipulation of meshes. * @param uv The new UV coordinate. * @returns Stable UV ID of the new UV. */ AddUV(this: EditableMesh, uv: Vector2): number; /** * Adds a new vertex to the geometry and returns a stable vertex ID. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddVertex) * @param this Instance which allows for the runtime creation and manipulation of meshes. * @param p Position in the mesh's local object space. * @returns Stable vertex ID of the new vertex. */ AddVertex(this: EditableMesh, p: Vector3): number; /** * Destroys the mesh. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#Destroy) * @param this Instance which allows for the runtime creation and manipulation of meshes. */ Destroy(this: EditableMesh): void; /** * Finds the closest point on the mesh's surface. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindClosestPointOnSurface) * @param this Instance which allows for the runtime creation and manipulation of meshes. * @param point Point position in the mesh's local object space. * @returns Tuple of the face ID, point on the mesh in local object space, and the barycentric coordinate of the position within the face. */ FindClosestPointOnSurface(this: EditableMesh, point: Vector3): LuaTuple<[ number, Vector3, Vector3 ]>; /** * Finds the closest vertex to a specific point in space. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindClosestVertex) * @param this Instance which allows for the runtime creation and manipulation of meshes. * @param toThisPoint Point position in the mesh's local object space. * @returns Closest stable vertex ID to the specified point in space. */ FindClosestVertex(this: EditableMesh, toThisPoint: Vector3): number; /** * Finds all vertices within a specific sphere. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindVerticesWithinSphere) * @param this Instance which allows for the runtime creation and manipulation of meshes. * @param center Center of the sphere in the mesh's local object space. * @param radius Radius of the sphere. * @returns List of stable vertex IDs within the requested sphere. */ FindVerticesWithinSphere(this: EditableMesh, center: Vector3, radius: number): Array<number>; /** * Returns a list of faces adjacent to a given face. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetAdjacentFaces) * @param this Instance which allows for the runtime creation and manipulation of meshes. * @param faceId * @returns List of face IDs adjacent to the given face. */ GetAdjacentFaces(this: EditableMesh, faceId: number): Array<unknown>; /** * Returns a list of vertices adjacent to a given vertex. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetAdjacentVertices) * @param this Instance which allows for the runtime creation and manipulation of meshes. * @param vertexId Vertex ID around which to get adjacent vertices. * @returns List of IDs of adjacent vertices around the given vertex ID. */ GetAdjacentVertices(this: EditableMesh, vertexId: number): Array<number>; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneByName) */ GetBoneByName(this: EditableMesh, boneName: string): number; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneCFrame) */ GetBoneCFrame(this: EditableMesh, boneId: number): CFrame; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneIsVirtual) */ GetBoneIsVirtual(this: EditableMesh, boneId: number): boolean; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneName) */ GetBoneName(this: EditableMesh, boneId: number): string; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneParent) */ GetBoneParent(this: EditableMesh, boneId: number): number; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBones) */ GetBones(this: EditableMesh): Array<unknown>; /** * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetCenter) * @param this Instance which allows for the runtime creation and manipulation of meshes. * @returns Center of the bounding box of the `EditableMesh`. */ GetCenter(this: EditableMesh): Vector3; /** * Returns the color for the given color ID. * * - **ThreadSafety**: Unsafe * * [Creator Hub](https://create.roblox.com/docs/