Guides

Console Viewer

Overview

Adds an in-scene representation of the Unity console on a world space canvas.

Prefab Usage:

  • Place the VRTK/Prefabs/ConsoleViewerCanvas/ConsoleViewerCanvas prefab into the scene hierarchy.

It is also possible to interact with the ConsoleViewerCanvas with a VRTK_UIPointer.

Inspector Parameters

  • Font Size: The size of the font the log text is displayed in.
  • Info Message: The colour of the text for an info log message.
  • Assert Message: The colour of the text for an assertion log message.
  • Warning Message: The colour of the text for a warning log message.
  • Error Message: The colour of the text for an error log message.
  • Exception Message: The colour of the text for an exception log message.

Class Methods

SetCollapse/1

public virtual void SetCollapse(bool state)

  • Parameters
    • bool state - The state of whether to collapse the output messages, true will collapse and false will not collapse.
  • Returns
    • none

The SetCollapse method determines whether the console will collapse same message output into the same line. A state of true will collapse messages and false will print the same message for each line.

ClearLog/0

public virtual void ClearLog()

  • Parameters
    • none
  • Returns
    • none

The ClearLog method clears the current log view of all messages


Did this page help you?