{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Console Viewer","type":"basic","slug":"consoleviewercanvas","excerpt":"","body":"## Overview\n\nAdds an in-scene representation of the Unity console on a world space canvas.\n\n**Prefab Usage:**\n * Place the `VRTK/Prefabs/ConsoleViewerCanvas/ConsoleViewerCanvas` prefab into the scene hierarchy.\n\n  > It is also possible to interact with the `ConsoleViewerCanvas` with a `VRTK_UIPointer`.\n\n## Inspector Parameters\n\n * **Font Size:** The size of the font the log text is displayed in.\n * **Info Message:** The colour of the text for an info log message.\n * **Assert Message:** The colour of the text for an assertion log message.\n * **Warning Message:** The colour of the text for a warning log message.\n * **Error Message:** The colour of the text for an error log message.\n * **Exception Message:** The colour of the text for an exception log message.\n\n## Class Methods\n\n### SetCollapse/1\n\n  > `public virtual void SetCollapse(bool state)`\n\n * Parameters\n   * `bool state` - The state of whether to collapse the output messages, true will collapse and false will not collapse.\n * Returns\n   * _none_\n\nThe 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.\n\n### ClearLog/0\n\n  > `public virtual void ClearLog()`\n\n * Parameters\n   * _none_\n * Returns\n   * _none_\n\nThe ClearLog method clears the current log view of all messages","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b1f8576c2505d00031254a5","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Prefabs","slug":"prefabs","order":1,"from_sync":false,"reference":false,"_id":"5b1f8576c2505d0003125425","version":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","createdAt":"2016-07-31T16:56:01.612Z","__v":0},"parentDoc":null,"project":"571fa55ca0acd42000af9545","user":"571fa519db52d01700f5cf3d","version":{"version":"3.3.0","version_clean":"3.3.0","codename":"Mangalica","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5b1f8576c2505d0003125424","5b1f8576c2505d0003125425","5b1f8576c2505d0003125426","5b1f8576c2505d0003125427","5b1f8576c2505d0003125428","5b1f8576c2505d0003125429","5b1f8576c2505d000312542a","5b1f8576c2505d000312542b","5b1f8576c2505d000312542c","5b1f8576c2505d000312542d","5b1f8576c2505d000312542e","5b1f8576c2505d000312542f","5b1f8576c2505d0003125430","5b1f8576c2505d0003125431","5b1f8576c2505d0003125432","5b1f8576c2505d0003125433","5b1f8576c2505d0003125434","5b1f8576c2505d0003125435","5b1f8576c2505d0003125436","5b1f8576c2505d0003125437","5b1f8576c2505d0003125438","5b1f8aab9c683000032979e7","5b1f8b2f3073470003ffa5da","5b1f8bd9fd653400031d94f4","5b1f900bd4c5f000036b57bd"],"_id":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":4,"forked_from":"594949e52be16d0026ec04cd","createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z"},"createdAt":"2016-07-31T17:46:12.091Z","githubsync":"","__v":0}
## 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