@needle-tools/engine/lib/engine/debug/debug_overlay.d.ts

Needle Engine is a web-based runtime for 3D apps. It runs on your machine for development with great integrations into editors like Unity or Blender - and can be deployed onto any device! It is flexible, extensible and networking and XR are built-in.

export declare enum LogType {
    Log = 0,
    Warn = 1,
    Error = 2
}
export type BalloonOptions = {
    type: LogType;
    /**
     * A key can be used to update an existing message instead of showing a new one.
     */
    key?: string;
    /**
     * If true, only show this message once. If the same message is logged again, it will be ignored. Note that messages are considered the same if their text is identical, so using this with dynamic values might lead to unexpected results.
     */
    once?: boolean;
    /**
     * Duration in seconds for how long the message should be shown. By default, messages will be shown for 10 seconds.
     */
    duration?: number;
};
export declare function getErrorCount(): number;
/** Register callback when a new error happens */
export declare function onError(cb: (...args: any[]) => void): void;
/** Unregister error callback */
export declare function offError(cb: (...args: any[]) => void): void;
/** Set false to prevent overlay messages from being shown */
export declare function setAllowBalloonMessages(allow: boolean): void;
/**
 * @deprecated Use {@link setAllowBalloonMessages} instead
 */
export declare function setAllowOverlayMessages(allow: boolean): void;
export declare function makeErrorsVisibleForDevelopment(): void;
export declare function addLog(type: LogType, message: string | any[], opts?: Omit<BalloonOptions, "type">, _file?: string | null, _line?: number | null): void;
/**
 * Clear all overlay messages from the screen
 */
export declare function clearMessages(): void;