UNPKG

@rbxts/zircon

Version:

<div> <img src="https://i.imgur.com/YgpbX7G.png" align="left" width="128"/> <h1>ZIRCON</h1> <h3>A clean, sleek, runtime debugging console for Roblox</h3> <a href="https://npmjs.com/package/@rbxts/zircon"><img src="https://badge.fury.io

62 lines (61 loc) 2.09 kB
/// <reference types="@rbxts/compiler-types" /> /// <reference types="roact" /> /// <reference types="@rbxts/types" /> /// <reference types="roact-rodux" /> import Roact from "@rbxts/roact"; import { ZirconContext, ZirconLogLevel } from "../../../Client/Types"; export interface DockedConsoleProps extends MappedProps, MappedDispatch { } interface DockedConsoleState { isVisible: boolean; isFullView: boolean; sizeY: number; source: string; levelFilter: Set<ZirconLogLevel>; filterVisible?: boolean; historyIndex: number; searchQuery: string; context: ZirconContext; } /** * The console */ declare class ZirconConsoleComponent extends Roact.Component<DockedConsoleProps, DockedConsoleState> { private positionY; private outputTransparency; private sizeY; private filterSizeY; private filterSettingsSizeY; private positionYMotor; private sizeYMotor; private outputTransparencyMotor; private dispatch; constructor(props: DockedConsoleProps); didMount(): void; didUpdate(prevProps: DockedConsoleProps, prevState: DockedConsoleState): void; renderNonExecutionBox(): Roact.Element; renderExecutionBox(): Roact.Element; render(): Roact.Element; } interface MappedDispatch { addMessage: (message: string) => void; updateSearchFilter: (search: string) => void; updateContextFilter: (context: ZirconContext | undefined) => void; updateLevelFilter: (levels: Set<ZirconLogLevel>) => void; close: () => void; } interface MappedProps { isVisible: boolean; executionEnabled: boolean; clientExecutionEnabled: boolean; history: string[]; searchQuery: string; toggleKeys: Enum.KeyCode[]; autoFocus: boolean; levelFilter: Set<ZirconLogLevel>; } /** * A docked console */ declare const ZirconDockedConsole: import("@rbxts/roact-rodux").ConnectedComponentClass<typeof ZirconConsoleComponent, Omit<DockedConsoleProps, keyof MappedProps | keyof MappedDispatch>>; export default ZirconDockedConsole;