Class Debug

The Debug class provides various functionality relating to debugging and logging.

Hierarchy

  • FrameworkObject
    • Debug

Constructors

constructor

Properties

traceOutputEnabled

Accessors

messageCount messages

Methods

clear log logDebugWarning logError logMessage logTrace logWarning saveLog submitCrashReport

Events

onLogEntryAdded onLogEntriesRead onErrorLogEntryAdded onLogCleared

Constructors

Protectedconstructor

  • new Debug(isInternalConstructor?): Debug

  • Parameters

    • OptionalisInternalConstructor: boolean

    Returns Debug

Properties

Static ReadonlytraceOutputEnabled

traceOutputEnabled: boolean

Accessors

StaticmessageCount

  • get messageCount(): number

  • Gets the number of new entries.

    Returns number

Staticmessages

Methods

Staticclear

  • clear(verbosity?, category?): void

  • Removes all log entries.

    Parameters

    Returns void

Staticlog

  • log(message, category?): void

  • Logs a new informative message to the global debug log.

    Parameters

    • message: any

      Message to log.

    • Optionalcategory: number

      Optional index of the category to group the message under.

    Returns void

StaticlogDebugWarning

  • logDebugWarning(message, category?): void

  • Logs a new warning message to the global debug log.

    Parameters

    • message: any

      Message to log.

    • Optionalcategory: number

      Optional index of the category to group the message under.

    Returns void

StaticlogError

  • logError(message, category?): void

  • Logs a new error message to the global debug log.

    Parameters

    • message: any

      Message to log.

    • Optionalcategory: number

      Optional index of the category to group the message under.

    Returns void

StaticlogMessage

  • logMessage(message, verbosity, category?): void

  • Logs a new message to the global debug log using the provided type.

    Parameters

    • message: any

      Message to log.

    • verbosity: EnumValue<LogVerbosity, number>

      Verbosity level defining message importance.

    • Optionalcategory: number

      Optional index of the category to group the message under.

    Returns void

StaticlogTrace

  • logTrace(message, category?): void

  • Logs a new trace message to the global debug log.

    Parameters

    • message: any

      Message to log.

    • Optionalcategory: number

      Optional index of the category to group the message under.

    Returns void

StaticlogWarning

  • logWarning(message, category?): void

  • Logs a new warning message to the global debug log.

    Parameters

    • message: any

      Message to log.

    • Optionalcategory: number

      Optional index of the category to group the message under.

    Returns void

StaticsaveLog

  • saveLog(path, type?): void

  • Saves a log about the current state of the application to the specified location.

    Parameters

    Returns void

StaticsubmitCrashReport

  • submitCrashReport(crashReportData, engineVersion, fnOnSubmitted?): void

  • Submits a crash report to the RSX server.

    Parameters

    • crashReportData: {
          contents: JsonObject;
          directoryPath: string;
          userInfo: string;
      }

      The log entry to submit.

      • contents: JsonObject
      • directoryPath: string
      • userInfo: string
    • engineVersion: string

      The current engine version.

    • OptionalfnOnSubmitted: ((isSuccess: boolean) => void)
        • (isSuccess): void

        • Parameters

          • isSuccess: boolean

          Returns void

    Returns void

Events

Static ReadonlyonLogEntryAdded

onLogEntryAdded: Event<[p0: Immutable<LogEntry>], void>

Triggered when a new entry in the log is added.

Note

Sim thread only.

Static ReadonlyonLogEntriesRead

onLogEntriesRead: Event<[infoCount: number, warningCount: number, errorCount: number], void>

Triggered when a new entry were read.

Note

Sim thread only.

Static ReadonlyonErrorLogEntryAdded

onErrorLogEntryAdded: Event<[p0: Immutable<LogEntry>], void>

Triggered when a new error entry in the log is added.

Note

Error logs are also dispatched by onLogEntryAdded, this API helps to only surface error logs. Sim thread only.

Static ReadonlyonLogCleared

onLogCleared: Event<[], void>

Triggered when the log is cleared.

Note

Sim thread only.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events