Coherent UI for Unity3D  2.5.3
A modern user interface library for games
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
CoherentUISystem Class Reference

Component controlling the CoherentUI System More...

Inherits MonoBehaviour.

Public Member Functions

bool IsReady ()
 Determines whether this instance is ready. More...
 

Public Attributes

Camera m_MainCamera = null
 The main camera. Used for obtaining mouse position over the HUD and raycasting in the world. More...
 

Static Public Attributes

static System.Func< FileHandler > FileHandlerFactoryFunc
 Creates the FileHandler instance for the system. Change to allow usage of custom FileHandler More...
 
static System.Func
< System.Action,
SystemListener > 
SystemListenerFactoryFunc
 Creates the SystemListener instance for the system. Change to allow usage of custom EventListener More...
 

Properties

bool IsUpdating [get, set]
 Determines whether the Coherent UI System component is currently in its Update() method More...
 
bool UseURLCache [get, set]
 Sets if the system should use the URL Cache. NOTE: This should almost always be enabled. Disable it if you already set the URL cache yourself for the app More...
 
int MemoryCacheSize [get, set]
 Sets the in-memory size of the URL cache More...
 
int DiskCacheSize [get, set]
 Sets the on-disk size of the URL cache More...
 
bool HasFocusedView [get]
 Determines whether there is an focused Click-to-focus view More...
 
ViewContext UISystem [get]
 Gets the user interface system. More...
 

Events

OnViewFocusedDelegate OnViewFocused
 Occurs when a Click-to-focus view gains or loses focus More...
 

Detailed Description

Component controlling the CoherentUI System

Member Function Documentation

bool CoherentUISystem.IsReady ( )
inline

Determines whether this instance is ready.

Returns
true if this instance is ready; otherwise, false.

Member Data Documentation

System.Func<FileHandler> CoherentUISystem.FileHandlerFactoryFunc
static
Initial value:
= () =>
{
return new UnityFileHandler();
}

Creates the FileHandler instance for the system. Change to allow usage of custom FileHandler

Camera CoherentUISystem.m_MainCamera = null

The main camera. Used for obtaining mouse position over the HUD and raycasting in the world.

System.Func<System.Action, SystemListener> CoherentUISystem.SystemListenerFactoryFunc
static

Creates the SystemListener instance for the system. Change to allow usage of custom EventListener

custom OnSystemReady override must call SystemListener.OnSystemReady

Action to be given to SystemListener constructor

Property Documentation

int CoherentUISystem.DiskCacheSize
getset

Sets the on-disk size of the URL cache

The maximum size of the on-disk cache

bool CoherentUISystem.HasFocusedView
get

Determines whether there is an focused Click-to-focus view

true if there is an focused Click-to-focus view; otherwise, false.

bool CoherentUISystem.IsUpdating
getset

Determines whether the Coherent UI System component is currently in its Update() method

Returns
true if this instance is updating; otherwise, false.
int CoherentUISystem.MemoryCacheSize
getset

Sets the in-memory size of the URL cache

The maximum size of the in-memory cache

ViewContext CoherentUISystem.UISystem
get

Gets the user interface system.

The user interface system.

bool CoherentUISystem.UseURLCache
getset

Sets if the system should use the URL Cache. NOTE: This should almost always be enabled. Disable it if you already set the URL cache yourself for the app

If to set the cache

Event Documentation

OnViewFocusedDelegate CoherentUISystem.OnViewFocused

Occurs when a Click-to-focus view gains or loses focus