# DevTool Canvas

### Description

DevTool Canvas is main component for displaying DevTool using a UI Elements.

### Prefab

Most easiest way to create DevTool Canvas it's use ready made prefab. To find it, go by this path in your project:&#x20;

_**`Assets/RenownedGames/DevTool/Prefabs/Canvas/DevTool Canvas.prefab`**_

![](https://4085687494-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeXPMJ4ODmHlL5WRTdS1F%2Fuploads%2FFhlvT96lWV9JvQic9GHG%2Fimage.png?alt=media\&token=842457d3-a11d-4eeb-8c04-a7065e586a13)

Drag and drop at the your scene.

![DevTool Canvas gameobject](https://4085687494-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeXPMJ4ODmHlL5WRTdS1F%2Fuploads%2FrvHdH3ttQrG7HSLT5hq2%2Fimage.png?alt=media\&token=ddb2ac36-fd4c-4714-9da1-d66424bb1de1)

{% hint style="warning" %}
Don't forget, Event System required to work DevTool Canvas. Make sure that you create it, in the scene where you use DevTool Canvas.
{% endhint %}

![Create Event System menu item](https://4085687494-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeXPMJ4ODmHlL5WRTdS1F%2Fuploads%2FfUDZAMdtNdATO61kNuNw%2Fimage.png?alt=media\&token=0fc93102-d1f8-4aef-85dc-6f86f19e2fa4)

After that you start a play to test it.

![DevTool Canvas in game mode.](https://4085687494-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeXPMJ4ODmHlL5WRTdS1F%2Fuploads%2FVxjDu0vyZeTd07gp2B3J%2Fimage.png?alt=media\&token=241d77fc-2ebc-4dff-980e-e4c1946acb35)

### Component

To change some settings of canvas edit DevTool Canvas component.

![DevTool Canvas component](https://4085687494-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeXPMJ4ODmHlL5WRTdS1F%2Fuploads%2FiL7265V1QWkNGQkUH1fZ%2Fimage.png?alt=media\&token=518df301-95d1-4dd0-b051-06c33e19ed03)

<table><thead><tr><th width="189.48691570500597">Name</th><th>Description</th></tr></thead><tbody><tr><td>Contents</td><td>Rect Transform which will be used as parent for all items.</td></tr><tr><td>Max Display Items</td><td>How much items can be drawed per time.</td></tr><tr><td>Title Text</td><td>Display current path name.</td></tr><tr><td>Show Full Path</td><td>If true will be displayed absolute path to directory.</td></tr><tr><td><strong>Pause Settings</strong></td><td><strong>---------------------------------------------</strong></td></tr><tr><td>Pause Game</td><td>If true game will be paused after enabling DevTool Canvas</td></tr><tr><td>Game Object</td><td>Pause message panel.</td></tr><tr><td>Tick Rate</td><td>Notification tick rate of pause message panel.</td></tr><tr><td><strong>Message Settings</strong></td><td><strong>---------------------------------------------</strong></td></tr><tr><td>Game Object</td><td>Command execution result message panel.</td></tr><tr><td>Text</td><td>Command execution result message text.</td></tr><tr><td><strong>Input Settings</strong></td><td><strong>---------------------------------------------</strong></td></tr><tr><td>Parent Directory</td><td>Input key for opening parent directory of current.</td></tr></tbody></table>

## Canvas Toggle

After drag\&drop and start game canvas will be active at all the time. For toggling canvas by specified key you can use Canvas Toggle. To create it, click right mouse button on hierarhy window and select _Create Canvas Toggle_.

![Create Canvas Toggle menu item](https://4085687494-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeXPMJ4ODmHlL5WRTdS1F%2Fuploads%2FIQ7cNAz7AZbPqSvTnDR3%2Fimage.png?alt=media\&token=234c0b73-c20f-47d2-b958-5437030c38e5)

After that add your canvas here and set specified key to toggle it

&#x20;

![Canvas Toggle component.](https://4085687494-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeXPMJ4ODmHlL5WRTdS1F%2Fuploads%2FcWswTiA4WEXwdcbvfgW8%2Fimage.png?alt=media\&token=6fd5b96a-7859-4443-9b0e-991dd7828cad)
