Skip to main content

Introduction

A UI control capable of sending and receiving messages over the Broadcast System to enable in-game debugging.

"Debug Console"

Fields#

NameDescription
Show HideMethod used to show/hide console.
Show Hide KeyKey used to show/hide console.
Show Hide ButtonButton used to show/hide console.
Start ShownShow the console immediately.
Show Hide Anim BoolAnimator bool parameter updated with show/hide state.
Receive ErrorsReceive errors for Unity.
OutputWhere should we show output text?
InputWhere do we get command input?
Buffer SizeHow many commands do we keep and display?
Auto Size ContainerShould we auto-size the output's parent transform?
Size PaddingWhen auto-size, what padding should we apply?
ScrollbarIf supplied scrollbar will scroll to bottom everytime a command or message is received.
On ShowEvent fired when the console is shown.
On HideEvent fired when the console is hidden.

Properties#

NameDescription
consoleAnimatorAnimator used to control show/hide animations.

Methods#

NameDescription
HideHide the console.
ShowShow the console.
ToggleShownToggle the show/hide state of the console.