Class Debug

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

Hierarchy

FrameworkObject
- Debug

Index

Constructors

Properties

traceOutputEnabled

Accessors

messageCount messages

Methods

clear log logError logMessage logTrace logWarning saveLog submitCrashReport

Events

onLogEntryAdded onLogCleared

Constructors

`Protected`constructor

new Debug(isInternalConstructor?): Debug
Parameters
- OptionalisInternalConstructor: boolean
Returns Debug
Inherited from DebugGenerated.constructor

Properties

`Static` `Readonly`traceOutputEnabled

traceOutputEnabled: boolean

Accessors

`Static`messageCount

get messageCount(): number
Gets the number of new entries.

Returns number
Inherited from DebugGenerated.messageCount

`Static`messages

get messages(): Iterable<LogEntry>
Returns all existing log entries.

Returns Iterable<LogEntry>
Inherited from DebugGenerated.messages

Methods

`Static`clear

clear(verbosity?, category?): void
Removes all log entries.
Parameters
- Optionalverbosity: EnumValue<LogVerbosity, number>
- Optionalcategory: number
Returns void
Inherited from DebugGenerated.clear

`Static`log

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

`Static`logError

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

`Static`logMessage

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
Overrides DebugGenerated.logMessage

`Static`logTrace

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

`Static`logWarning

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

`Static`saveLog

saveLog(path, type?): void
Saves a log about the current state of the application to the specified location.
Parameters
- path: FilePath
  Absolute path to the log filename.
- Optionaltype: EnumValue<SavedLogType, number>
  Format of the saved log.
Returns void
Inherited from DebugGenerated.saveLog

`Static`submitCrashReport

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` `Readonly`onLogEntryAdded

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

Triggered when a new entry in the log is added.

Note

Sim thread only.

`Static` `Readonly`onLogCleared

onLogCleared: Event<[], void>

Triggered when the log is cleared.

Note

Sim thread only.