Interface IUISystemAPI
Interface for the UI system API. Provides methods to create, get, and destroy screens.
Namespace: Fwt.HexTerrains
Assembly: fwt.hexterrains.dll
Syntax
public interface IUISystemAPIMethods
CreateScreen<TScreen>()
Creates a new screen of the specified type.
Declaration
TScreen CreateScreen<TScreen>() where TScreen : UIScreenReturns
| Type | Description |
|---|---|
| TScreen | screen instance |
Type Parameters
| Name | Description |
|---|---|
| TScreen | type of the screen to create |
DestroyScreen(UIScreen)
Destroys the specified screen instance.
Declaration
bool DestroyScreen(UIScreen screen)Parameters
| Type | Name | Description |
|---|---|---|
| UIScreen | screen | screen instance to destroy |
Returns
| Type | Description |
|---|---|
| bool | true if the screen was destroyed successfully; otherwise, false |
DestroyScreen<TScreen>()
Destroys the specified screen.
Declaration
bool DestroyScreen<TScreen>() where TScreen : UIScreenReturns
| Type | Description |
|---|---|
| bool | true if the screen was destroyed successfully; otherwise, false |
Type Parameters
| Name | Description |
|---|---|
| TScreen | type of a screen to destroy |
GetOrCreateScreen<TScreen>()
Gets an existing screen of the specified type, or creates a new one if it doesn't exist.
Declaration
TScreen GetOrCreateScreen<TScreen>() where TScreen : UIScreenReturns
| Type | Description |
|---|---|
| TScreen | screen instance |
Type Parameters
| Name | Description |
|---|---|
| TScreen | type of the screen to get or create |
GetScreen<TScreen>()
Gets an existing screen of the specified type if found.
Declaration
TScreen GetScreen<TScreen>() where TScreen : UIScreenReturns
| Type | Description |
|---|---|
| TScreen |
Type Parameters
| Name | Description |
|---|---|
| TScreen | type of the screen to get |