UIBlocker

Namespace: WellFired.Command.Unity.Runtime

Description

This class create a UnityUI canvas allowing to place input blockers below our Unity legacy GUI system. This ensure that input events happening in the Console are not used by element of the game. This is a temporary solution, in the future, .:ref:Command<namespacewellfired_command> will use Unity most recent UI system.

Public Methods

void	UnblockConsoleArea ( )
	UIBlocker ( Transform parent )
void	BlockOpenConsoleArea ( Rect rect )
void	UnblockOpenConsoleArea ( )
void	BlockConsoleArea ( Rect rect )
void	SetSortingOrder ( int sortingOrder )
void	BlockFilterArea ( Rect rect )
void	BlockCommandsArea ( Rect rect )
void	BlockLogEntryArea ( Rect rect )
void	BlockScreen ( )
void	UnblockScreen ( )

Breakdown

• void SetSortingOrder ( int sortingOrder )

  Description

  The blocking canvas is placed on top of every canvas by default. This function allows to change it.

  Parameters

  sortingOrder

• void UnblockConsoleArea ( )

• void BlockOpenConsoleArea ( Rect rect )

  Description

  Will set the size of the input blocker corresponding to the open console button.

  Parameters

  rect

• void UnblockOpenConsoleArea ( )

• void BlockConsoleArea ( Rect rect )

  Description

  Will set the size of the input blocker corresponding to the console window.

  Parameters

  rect

• UIBlocker ( Transform parent )

• void BlockFilterArea ( Rect rect )

  Description

  Will set the size of the input blocker corresponding to the filter window.

  Parameters

  rect

• void BlockCommandsArea ( Rect rect )

  Description

  Will set the size of the input blocker corresponding to the commands window.

  Parameters

  rect

• void BlockLogEntryArea ( Rect rect )

  Description

  Will set the size of the input blocker corresponding to the log entry window.

  Parameters

  rect

• void BlockScreen ( )

• void UnblockScreen ( )