Class SUI

Inheritance

object

SUI

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: SUI

Assembly: SonsSdk.dll

Syntax

public class SUI

Constructors

SUI()

Declaration

public SUI()

Fields

BG_CYAN

Declaration

public static readonly Color BG_CYAN

Field Value

Type	Description
Color

_panels

Declaration

public static Dictionary<string, SPanelOptions> _panels

Field Value

Type	Description
Dictionary<string, SPanelOptions>

Properties

AssetBundle

Declaration

public static AssetBundle AssetBundle { get; }

Property Value

Type	Description
AssetBundle

BlurBackground

Declaration

public static Sprite BlurBackground { get; }

Property Value

Type	Description
Sprite

Fonts

Declaration

public static IReadOnlyList<TMP_FontAsset> Fonts { get; }

Property Value

Type	Description
IReadOnlyList<TMP_FontAsset>

IsInitialized

Declaration

public static bool IsInitialized { get; }

Property Value

Type	Description
bool

SBackground

Declaration

public static SContainerOptions SBackground { get; }

Property Value

Type	Description
SContainerOptions

SBgButton

Declaration

public static SBgButtonOptions SBgButton { get; }

Property Value

Type	Description
SBgButtonOptions

SButton

Declaration

public static SButtonOptions SButton { get; }

Property Value

Type	Description
SButtonOptions

SContainer

Declaration

public static SContainerOptions SContainer { get; }

Property Value

Type	Description
SContainerOptions

SDiv

Declaration

public static SContainerOptions SDiv { get; }

Property Value

Type	Description
SContainerOptions

SHorizontal

Declaration

public static SContainerOptions SHorizontal { get; }

Property Value

Type	Description
SContainerOptions

SImage

Declaration

public static SImageOptions SImage { get; }

Property Value

Type	Description
SImageOptions

SLabel

Declaration

public static SLabelOptions SLabel { get; }

Property Value

Type	Description
SLabelOptions

SLabelDivider

Declaration

public static SLabelDividerOptions SLabelDivider { get; }

Property Value

Type	Description
SLabelDividerOptions

SMaskedImage

Declaration

public static SMaskedImageOptions SMaskedImage { get; }

Property Value

Type	Description
SMaskedImageOptions

SMenuButton

Declaration

public static SMenuButtonOptions SMenuButton { get; }

Property Value

Type	Description
SMenuButtonOptions

SOptions

Declaration

public static SOptionsOptions SOptions { get; }

Property Value

Type	Description
SOptionsOptions

SScrollContainer

Declaration

public static SScrollContainerOptions SScrollContainer { get; }

Property Value

Type	Description
SScrollContainerOptions

SSlider

Declaration

public static SSliderOptions SSlider { get; }

Property Value

Type	Description
SSliderOptions

SSprite

Declaration

public static SSpriteOptions SSprite { get; }

Property Value

Type	Description
SSpriteOptions

STabController

Declaration

public static STabControllerOptions STabController { get; }

Property Value

Type	Description
STabControllerOptions

STextbox

Declaration

public static STextboxOptions STextbox { get; }

Property Value

Type	Description
STextboxOptions

SToggle

Declaration

public static SToggleOptions SToggle { get; }

Property Value

Type	Description
SToggleOptions

SUIViewport

Declaration

public static Canvas SUIViewport { get; }

Property Value

Type	Description
Canvas

SVertical

Declaration

public static SContainerOptions SVertical { get; }

Property Value

Type	Description
SContainerOptions

SpriteBackground

Declaration

public static Sprite SpriteBackground { get; }

Property Value

Type	Description
Sprite

SpriteBackground400ppu

Declaration

public static Sprite SpriteBackground400ppu { get; }

Property Value

Type	Description
Sprite

Sprites

Declaration

public static IReadOnlyList<Sprite> Sprites { get; }

Property Value

Type	Description
IReadOnlyList<Sprite>

Methods

ColorFromString(string)

Declaration

public static Color ColorFromString(string color)

Parameters

Type	Name	Description
string	color

Returns

Type	Description
Color

CreatePanel(Transform)

Declaration

public static SPanelOptions CreatePanel(Transform parent = null)

Parameters

Type	Name	Description
Transform	parent

Returns

Type	Description
SPanelOptions

GetBackgroundSprite(EBackground)

Declaration

public static Sprite GetBackgroundSprite(EBackground type)

Parameters

Type	Name	Description
EBackground	type

Returns

Type	Description
Sprite

GetFont(EFont)

Declaration

public static TMP_FontAsset GetFont(SUI.EFont font)

Parameters

Type	Name	Description
SUI.EFont	font

Returns

Type	Description
TMP_FontAsset

GetPanel(string)

Declaration

public static SPanelOptions GetPanel(string id)

Parameters

Type	Name	Description
string	id

Returns

Type	Description
SPanelOptions

GetSprite(string)

Declaration

public static Sprite GetSprite(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
Sprite

RegisterNewPanel(string, bool, KeyCode?)

Creates a new panel and registers it to the sui system.

Declaration

public static SPanelOptions RegisterNewPanel(string id, bool enableInput = false, KeyCode? toggleKey = null)

Parameters

Type	Name	Description
string	id	The id by which you can manage the panel later. Needs to be unique
bool	enableInput	If true enables the mouse and disables game keyboard input once the panel is showing
KeyCode?	toggleKey	Optional key by which you can toggle the panel

Returns

Type	Description
SPanelOptions

ToggleMenuPanel(string)

Declaration

public static bool ToggleMenuPanel(string id)

Parameters

Type	Name	Description
string	id

Returns

Type	Description
bool

ToggleMenuPanel(string, bool)

Declaration

public static SPanelOptions ToggleMenuPanel(string id, bool show)

Parameters

Type	Name	Description
string	id
bool	show

Returns

Type	Description
SPanelOptions

TogglePanel(string)

Declaration

public static bool TogglePanel(string id)

Parameters

Type	Name	Description
string	id

Returns

Type	Description
bool

TogglePanel(string, bool)

Declaration

public static SPanelOptions TogglePanel(string id, bool show)

Parameters

Type	Name	Description
string	id
bool	show

Returns

Type	Description
SPanelOptions