HKI Core
Public Member Functions | Properties | Private Member Functions | Private Attributes | List of all members
HKI.Core.UI.UIScreen Class Reference

This ScriptableObject holds all the information that is required by the UIScreenManager to display a screen (window). A screen can be open with a simple Open call of this UIScreen and closed with a call of the function Close. More...

Inheritance diagram for HKI.Core.UI.UIScreen:

Public Member Functions

void Open ()
 
void Close ()
 

Properties

int GetScreenId [get]
 
GameObject GetScreenPrefab [get]
 
bool GetDestroyWhenClosed [get]
 
bool GetDisableScreensUnderneath [get]
 

Private Member Functions

void OnEnable ()
 

Private Attributes

GameObject ScreenPrefab = null
 
bool DestroyWhenClosed = true
 
bool DisableScreensUnderneath = true
 
int screenId = 0
 

Detailed Description

This ScriptableObject holds all the information that is required by the UIScreenManager to display a screen (window). A screen can be open with a simple Open call of this UIScreen and closed with a call of the function Close.

Definition at line 9 of file UIScreen.cs.

Member Function Documentation

◆ Close()

void HKI.Core.UI.UIScreen.Close ( )
inline

Definition at line 43 of file UIScreen.cs.

◆ OnEnable()

void HKI.Core.UI.UIScreen.OnEnable ( )
inlineprivate

Definition at line 26 of file UIScreen.cs.

◆ Open()

void HKI.Core.UI.UIScreen.Open ( )
inline

Definition at line 32 of file UIScreen.cs.

Member Data Documentation

◆ DestroyWhenClosed

bool HKI.Core.UI.UIScreen.DestroyWhenClosed = true
private

Definition at line 13 of file UIScreen.cs.

◆ DisableScreensUnderneath

bool HKI.Core.UI.UIScreen.DisableScreensUnderneath = true
private

Definition at line 14 of file UIScreen.cs.

◆ screenId

int HKI.Core.UI.UIScreen.screenId = 0
private

Definition at line 16 of file UIScreen.cs.

◆ ScreenPrefab

GameObject HKI.Core.UI.UIScreen.ScreenPrefab = null
private

Definition at line 12 of file UIScreen.cs.

Property Documentation

◆ GetDestroyWhenClosed

bool HKI.Core.UI.UIScreen.GetDestroyWhenClosed
get

Definition at line 22 of file UIScreen.cs.

◆ GetDisableScreensUnderneath

bool HKI.Core.UI.UIScreen.GetDisableScreensUnderneath
get

Definition at line 23 of file UIScreen.cs.

◆ GetScreenId

int HKI.Core.UI.UIScreen.GetScreenId
get

Definition at line 19 of file UIScreen.cs.

◆ GetScreenPrefab

GameObject HKI.Core.UI.UIScreen.GetScreenPrefab
get

Definition at line 21 of file UIScreen.cs.


The documentation for this class was generated from the following file: