@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
34 lines (33 loc) • 1.5 kB
TypeScript
/// <reference types="@rbxts/compiler-types" />
import { ZrValue } from "@rbxts/zirconium/out/Data/Locals";
import { ZirconEnum } from "./ZirconEnum";
import { ZirconFunction } from "./ZirconFunction";
import { ZirconGroupConfiguration } from "./ZirconGroupBuilder";
import { ZirconNamespace } from "./ZirconNamespace";
import { ZirconValidator } from "./ZirconTypeValidator";
export declare type ZirconClientScopedGlobal = ZirconNamespace | ZirconEnum<any> | ZirconFunction<any, any>;
export interface ZirconClientConfiguration {
readonly Groups: readonly ZirconGroupConfiguration[];
readonly Registry: ZirconClientScopedGlobal[];
}
export interface DefaultAdminGroupOptions {
readonly GroupRank: number;
readonly GroupId?: number;
}
export interface DefaultUserGroupOptions {
readonly CanAccessConsole: boolean;
}
export declare class ZirconClientConfigurationBuilder {
configuration: Writable<ZirconClientConfiguration>;
constructor();
/**
* Adds the specified function to Zircon
*
* Note: This function is available to all users who can access this console, therefore is considered insecure.
*
* Do not use it for anything important. Important stuff should be a server function
* @param functionType The function
*/
AddFunction<A extends readonly ZirconValidator<unknown, unknown>[], R extends void | ZrValue>(functionType: ZirconFunction<A, R>): this;
Build(): ZirconClientConfiguration;
}