@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
35 lines (34 loc) • 1.39 kB
TypeScript
/// <reference types="@rbxts/compiler-types" />
/// <reference types="@rbxts/types" />
/// <reference types="roact" />
import Roact from "@rbxts/roact";
import Lazy from "../Shared/Lazy";
export declare enum ConsoleType {
DockedConsole = 0
}
declare namespace ZirconClient {
export const Registry: Lazy<typeof import("../Services/ClientRegistryService").ZirconClientRegistryService>;
export const Dispatch: Lazy<typeof import("../Services/ClientDispatchService").ZirconClientDispatchService>;
export function SetVisible(visible: boolean): void;
interface ConsoleOptions {
Keys?: Array<Enum.KeyCode>;
EnableTags?: boolean;
AutoFocusTextBox?: boolean;
ConsoleComponent?: typeof Roact.Component | ((props: defined) => Roact.Element);
}
/**
* Binds the built-in Zircon console
* Default Keybind: F10
*
* @param options The console options
*
* *This is not required, you can use your own console solution!*
*/
export function Init(options?: ConsoleOptions): void;
/** @deprecated Use `Init` */
export function BindConsole(options?: ConsoleOptions): void;
/** @hidden @deprecated No longer works - use `Keys` option to {@link Init} */
export function BindActivationKeys(keys: Enum.KeyCode[]): void;
export {};
}
export default ZirconClient;