Table of Contents

Class UI

Namespace
AO
Assembly
CoreAssembly.dll

UI is a core engine system used to draw UI elements with the immediate mode UI.

public static class UI
Inheritance
UI
Inherited Members

Fields

BlueprintBackgroundNineSlice 

public static UI.NineSlice BlueprintBackgroundNineSlice

Field Value

UI.NineSlice

MainWindowLayer 

public const int MainWindowLayer = 125

Field Value

int

RoundedBackgroundNineSlice 

public static UI.NineSlice RoundedBackgroundNineSlice

Field Value

UI.NineSlice

SideCarWindowLayer 

public const int SideCarWindowLayer = 120

Field Value

int

SimpleButtonSlice 

public static UI.NineSlice SimpleButtonSlice

Field Value

UI.NineSlice

SimpleModalBackgroundNineSlice 

public static UI.NineSlice SimpleModalBackgroundNineSlice

Field Value

UI.NineSlice

SimpleModalBackgroundWithBottomStripeNineSlice 

public static UI.NineSlice SimpleModalBackgroundWithBottomStripeNineSlice

Field Value

UI.NineSlice

SimpleModalHeaderNineSlice 

public static UI.NineSlice SimpleModalHeaderNineSlice

Field Value

UI.NineSlice

TabButtonSlice 

public static UI.NineSlice TabButtonSlice

Field Value

UI.NineSlice

TabLargeSlice 

public static UI.NineSlice TabLargeSlice

Field Value

UI.NineSlice

TabSmallSlice 

public static UI.NineSlice TabSmallSlice

Field Value

UI.NineSlice

TabTrapezoidSlice 

public static UI.NineSlice TabTrapezoidSlice

Field Value

UI.NineSlice

TextSettingsForButtons 

public static UI.TextSettings TextSettingsForButtons

Field Value

UI.TextSettings

TextSettingsForHeaders 

public static UI.TextSettings TextSettingsForHeaders

Field Value

UI.TextSettings

TextSettingsForMessages 

public static UI.TextSettings TextSettingsForMessages

Field Value

UI.TextSettings

TitleFlareSlice 

public static UI.NineSlice TitleFlareSlice

Field Value

UI.NineSlice

TransparentBackgroundSlice 

public static UI.NineSlice TransparentBackgroundSlice

Field Value

UI.NineSlice

Properties

IsBlockingWindowOpen 

public static bool IsBlockingWindowOpen { get; }

Property Value

bool

SafeRect 

public static Rect SafeRect { get; }

Property Value

Rect

ScreenRect 

public static Rect ScreenRect { get; }

Property Value

Rect

ScreenScaleFactor 

public static float ScreenScaleFactor { get; }

Property Value

float

WhiteSprite 

public static Texture WhiteSprite { get; }

Property Value

Texture

Methods

AddSystemButton(string, string, string, SystemButtonLocation) 

public static extern SystemButton AddSystemButton(string id, string iconAssetId, string iconSelectedAssetId, SystemButtonLocation location)

Parameters

id string
iconAssetId string
iconSelectedAssetId string
location SystemButtonLocation

Returns

SystemButton

BeginButton(Rect, string, ButtonSettings, TextSettings) 

public static extern UI.InteractResult BeginButton(Rect rect, string text, UI.ButtonSettings buttonSettings, UI.TextSettings textSettings)

Parameters

rect Rect
text string
buttonSettings UI.ButtonSettings
textSettings UI.TextSettings

Returns

UI.InteractResult

BeginModal(Rect, string) 

public static UI.ModalResult BeginModal(Rect rect, string id)

Parameters

rect Rect
id string

Returns

UI.ModalResult

Blocker(Rect, string) 

public static extern void Blocker(Rect rect, string id)

Parameters

rect Rect
id string

Button(Rect, string, ButtonSettings, TextSettings) 

public static extern UI.InteractResult Button(Rect rect, string text, UI.ButtonSettings buttonSettings, UI.TextSettings textSettings)

Parameters

rect Rect
text string
buttonSettings UI.ButtonSettings
textSettings UI.TextSettings

Returns

UI.InteractResult

ColorFromButtonColor(ButtonColor) 

public static Vector4 ColorFromButtonColor(ButtonColor color)

Parameters

color ButtonColor

Returns

Vector4

ContrastingTextColorForWindowBackground(WindowBackgroundColor) 

public static Vector4 ContrastingTextColorForWindowBackground(WindowBackgroundColor backgroundColor)

Parameters

backgroundColor WindowBackgroundColor

Returns

Vector4

CreateSystemButton(string, string, string, SystemButtonLocation) 

[Obsolete("Use AddSystemButton(). In the All Out APIs, a Create() function implies a Destroy() function but system buttons don't need a destroy. This will become an error in proto 40.")]
public static SystemButton CreateSystemButton(string id, string iconAssetId, string iconSelectedAssetId, SystemButtonLocation location)

Parameters

id string
iconAssetId string
iconSelectedAssetId string
location SystemButtonLocation

Returns

SystemButton

DragDropSource(Rect, string, object) 

public static extern bool DragDropSource(Rect rect, string payloadId, object payload)

Parameters

rect Rect
payloadId string
payload object

Returns

bool

DragDropTarget(Rect, string) 

public static extern UI.InteractResult DragDropTarget(Rect rect, string payloadId)

Parameters

rect Rect
payloadId string

Returns

UI.InteractResult

DrawAlertWindow(AlertWindowOptions) 

public static AlertWindowResult DrawAlertWindow(AlertWindowOptions options)

Parameters

options AlertWindowOptions

Returns

AlertWindowResult

DrawEmptyWindow(Rect, WindowOptionsBase) 

public static (bool, Rect) DrawEmptyWindow(Rect rect, WindowOptionsBase options)

Parameters

rect Rect
options WindowOptionsBase

Returns

(bool, Rect)

DrawGridElementBackground(Rect, ElementColor, ElementStyle, bool) 

public static void DrawGridElementBackground(Rect rect, ElementColor color, ElementStyle style, bool tab)

Parameters

rect Rect
color ElementColor
style ElementStyle
tab bool

DrawSkeleton(Rect, SpineInstance, Vector2, float) 

public static void DrawSkeleton(Rect rect, SpineInstance instance, Vector2 scale, float rotationDegrees)

Parameters

rect Rect
instance SpineInstance
scale Vector2
rotationDegrees float

DrawTabButton(Rect, string, TabButtonStyle, ButtonColor) 

public static void DrawTabButton(Rect rect, string label, TabButtonStyle style, ButtonColor color)

Parameters

rect Rect
label string
style TabButtonStyle
color ButtonColor

DrawWindow(Rect, Window) 

public static bool DrawWindow(Rect rect, Window window)

Parameters

rect Rect
window Window

Returns

bool

DrawWindow(Window) 

public static bool DrawWindow(Window window)

Parameters

window Window

Returns

bool

DrawWindowBackground(Rect, WindowBackgroundStyle, WindowBackgroundColor, Vector4) 

public static void DrawWindowBackground(Rect rect, WindowBackgroundStyle style, WindowBackgroundColor backgroundColor, Vector4 tint)

Parameters

rect Rect
style WindowBackgroundStyle
backgroundColor WindowBackgroundColor
tint Vector4

DrawWindowButton(Rect, string, Texture, ButtonColor, ButtonStyle) 

public static UI.InteractResult DrawWindowButton(Rect buttonRect, string text, Texture icon, ButtonColor color, ButtonStyle style)

Parameters

buttonRect Rect
text string
icon Texture
color ButtonColor
style ButtonStyle

Returns

UI.InteractResult

DrawWindowContent(Rect, WindowContent) 

public static void DrawWindowContent(Rect rect, WindowContent content)

Parameters

rect Rect
content WindowContent

EndButton() 

public static extern void EndButton()

EndModal() 

public static void EndModal()

ExpandCurrentScrollView(Rect) 

public static extern void ExpandCurrentScrollView(Rect rect)

Parameters

rect Rect

GetButtonSlice(ButtonColor, ButtonStyle) 

public static UI.NineSlice GetButtonSlice(ButtonColor color, ButtonStyle style)

Parameters

color ButtonColor
style ButtonStyle

Returns

UI.NineSlice

GetButtonTexture(ButtonColor, ButtonStyle) 

public static Texture GetButtonTexture(ButtonColor color, ButtonStyle style)

Parameters

color ButtonColor
style ButtonStyle

Returns

Texture

GetPlayerRect(Player) 

public static Rect GetPlayerRect(Player player)

Parameters

player Player

Returns

Rect

GetRarityPipTexture(RarityPipStyle, RarityPipColor) 

public static Texture GetRarityPipTexture(RarityPipStyle rarityStyle, RarityPipColor rarityColor)

Parameters

rarityStyle RarityPipStyle
rarityColor RarityPipColor

Returns

Texture

GetScrollViewScrollBarRect_Internal(Rect, nint) 

public static extern Rect GetScrollViewScrollBarRect_Internal(Rect rect, nint scrollViewPtr)

Parameters

rect Rect
scrollViewPtr nint

Returns

Rect

Gif(Rect, string, Gif) 

public static void Gif(Rect rect, string id, Gif gif)

Parameters

rect Rect
id string
gif Gif

Gif_Internal(Rect, string, ulong) 

public static extern void Gif_Internal(Rect rect, string id, ulong gif_id)

Parameters

rect Rect
id string
gif_id ulong

Image(Rect, Texture, NineSlice, float) 

public static void Image(Rect rect, Texture texture, UI.NineSlice nineSlice = default, float rotationDegrees = 0)

Parameters

rect Rect
texture Texture
nineSlice UI.NineSlice
rotationDegrees float

Image(Rect, Texture, Vector4, NineSlice, float) 

public static void Image(Rect rect, Texture texture, Vector4 tint, UI.NineSlice nineSlice = default, float rotationDegrees = 0)

Parameters

rect Rect
texture Texture
tint Vector4
nineSlice UI.NineSlice
rotationDegrees float

InvisibleButton(Rect, string) 

public static extern UI.InteractResult InvisibleButton(Rect rect, string id)

Parameters

rect Rect
id string

Returns

UI.InteractResult

IsChatOpen() 

public static extern bool IsChatOpen()

Returns

bool

IsLeaderboardOpen() 

public static extern bool IsLeaderboardOpen()

Returns

bool

LitText(Rect, string, TextSettings, bool) 

[Obsolete("UI.LitText() will be made async by default in proto 40, breaking compatibility. If you need the result Rect, use UI.LitTextSync(). Otherwise use UI.LitTextAsync().", true)]
public static Rect LitText(Rect rect, string text, UI.TextSettings textSettings, bool dryRun = false)

Parameters

rect Rect
text string
textSettings UI.TextSettings
dryRun bool

Returns

Rect

LitTextAsync(Rect, string, TextSettings) 

public static void LitTextAsync(Rect rect, string text, UI.TextSettings textSettings)

Parameters

rect Rect
text string
textSettings UI.TextSettings

LitTextAsync_Internal(Rect, string, TextSettings) 

public static extern void LitTextAsync_Internal(Rect rect, string text, UI.TextSettings textSettings)

Parameters

rect Rect
text string
textSettings UI.TextSettings

LitTextSync(Rect, string, TextSettings, bool) 

public static Rect LitTextSync(Rect rect, string text, UI.TextSettings textSettings, bool dryRun = false)

Parameters

rect Rect
text string
textSettings UI.TextSettings
dryRun bool

Returns

Rect

LitTextSync_Internal(Rect, string, TextSettings, bool) 

public static extern Rect LitTextSync_Internal(Rect rect, string text, UI.TextSettings textSettings, bool dryRun)

Parameters

rect Rect
text string
textSettings UI.TextSettings
dryRun bool

Returns

Rect

PUSH_COLOR_MULTIPLIER(Vector4, bool) 

public static AllOut.DeferImpl PUSH_COLOR_MULTIPLIER(Vector4 color, bool condition = true)

Parameters

color Vector4
condition bool

Returns

AllOut.DeferImpl

PUSH_COLOR_MULTIPLIER(float, bool) 

public static AllOut.DeferImpl PUSH_COLOR_MULTIPLIER(float all, bool condition = true)

Parameters

all float
condition bool

Returns

AllOut.DeferImpl

PUSH_COMMAND_LIST() 

public static AllOut.DeferImpl PUSH_COMMAND_LIST()

Returns

AllOut.DeferImpl

PUSH_CONTEXT(Context) 

public static AllOut.DeferImpl PUSH_CONTEXT(UI.Context ctx)

Parameters

ctx UI.Context

Returns

AllOut.DeferImpl

PUSH_DISABLED(bool) 

public static AllOut.DeferImpl PUSH_DISABLED(bool condition)

Parameters

condition bool

Returns

AllOut.DeferImpl

PUSH_DISABLED_VISUALS(bool) 

public static AllOut.DeferImpl PUSH_DISABLED_VISUALS(bool condition)

Parameters

condition bool

Returns

AllOut.DeferImpl

PUSH_ID(int) 

public static AllOut.DeferImpl PUSH_ID(int id)

Parameters

id int

Returns

AllOut.DeferImpl

PUSH_ID(string) 

public static AllOut.DeferImpl PUSH_ID(string id)

Parameters

id string

Returns

AllOut.DeferImpl

PUSH_LAYER(int) 

public static AllOut.DeferImpl PUSH_LAYER(int layer)

Parameters

layer int

Returns

AllOut.DeferImpl

PUSH_LAYER_RELATIVE(int) 

public static AllOut.DeferImpl PUSH_LAYER_RELATIVE(int delta)

Parameters

delta int

Returns

AllOut.DeferImpl

PUSH_MATERIAL(Material) 

public static AllOut.DeferImpl PUSH_MATERIAL(UI.Material material)

Parameters

material UI.Material

Returns

AllOut.DeferImpl

PUSH_MATRIX(Matrix4) 

public static AllOut.DeferImpl PUSH_MATRIX(Matrix4 matrix)

Parameters

matrix Matrix4

Returns

AllOut.DeferImpl

PUSH_MODAL(Rect, string, out ModalResult) 

public static AllOut.DeferImpl PUSH_MODAL(Rect rect, string id, out UI.ModalResult modal)

Parameters

rect Rect
id string
modal UI.ModalResult

Returns

AllOut.DeferImpl

PUSH_PLAYER_MATERIAL(Player) 

public static AllOut.DeferImpl PUSH_PLAYER_MATERIAL(Player player)

Parameters

player Player

Returns

AllOut.DeferImpl

PUSH_ROTATE_ABOUT_POINT(float, Vector2) 

public static AllOut.DeferImpl PUSH_ROTATE_ABOUT_POINT(float degrees, Vector2 point)

Parameters

degrees float
point Vector2

Returns

AllOut.DeferImpl

PUSH_SCALE_FACTOR(float, bool) 

public static AllOut.DeferImpl PUSH_SCALE_FACTOR(float newScaleFactor, bool condition = true)

Parameters

newScaleFactor float
condition bool

Returns

AllOut.DeferImpl

PUSH_SCISSOR(Rect, bool) 

public static AllOut.DeferImpl PUSH_SCISSOR(Rect rect, bool overrideCurrent = false)

Parameters

rect Rect
overrideCurrent bool

Returns

AllOut.DeferImpl

PUSH_UNLIT_PLAYER_MATERIAL(Player) 

public static AllOut.DeferImpl PUSH_UNLIT_PLAYER_MATERIAL(Player player)

Parameters

player Player

Returns

AllOut.DeferImpl

PopColorMultiplier() 

public static extern void PopColorMultiplier()

PopCommandList() 

public static extern void PopCommandList()

PopContext() 

public static extern void PopContext()

PopDisabled() 

public static extern void PopDisabled()

PopDisabledVisuals() 

public static extern void PopDisabledVisuals()

PopId() 

public static extern void PopId()

PopLayer() 

public static extern void PopLayer()

PopMaterial() 

public static extern void PopMaterial()

PopMatrix() 

public static extern void PopMatrix()

PopPlayerMaterial() 

public static extern void PopPlayerMaterial()

PopScaleFactor() 

public static extern void PopScaleFactor()

PopScissor() 

public static extern void PopScissor()

PopScrollView() 

public static extern void PopScrollView()

PopUnlitPlayerMaterial() 

public static extern void PopUnlitPlayerMaterial()

PushColorMultiplier(Vector4) 

public static extern void PushColorMultiplier(Vector4 color)

Parameters

color Vector4

PushCommandList() 

public static extern void PushCommandList()

PushContext(Context) 

public static extern void PushContext(UI.Context ctxt)

Parameters

ctxt UI.Context

PushDisabled(bool) 

public static extern void PushDisabled(bool condition)

Parameters

condition bool

PushDisabledVisuals(bool) 

public static extern void PushDisabledVisuals(bool condition)

Parameters

condition bool

PushId(string) 

public static extern void PushId(string id)

Parameters

id string

PushIdInt(int) 

public static extern void PushIdInt(int id)

Parameters

id int

PushLayer(int) 

public static extern void PushLayer(int layer)

Parameters

layer int

PushLayerRelative(int) 

public static extern void PushLayerRelative(int delta)

Parameters

delta int

PushMaterial(Material) 

public static extern void PushMaterial(UI.Material material)

Parameters

material UI.Material

PushMatrix(Matrix4) 

public static extern void PushMatrix(Matrix4 matrix)

Parameters

matrix Matrix4

PushPlayerMaterial(Player) 

public static void PushPlayerMaterial(Player player)

Parameters

player Player

PushScaleFactor(float) 

public static extern void PushScaleFactor(float newScaleFactor)

Parameters

newScaleFactor float

PushScissor(Rect, bool) 

public static extern void PushScissor(Rect rect, bool overrideCurrent = false)

Parameters

rect Rect
overrideCurrent bool

PushScrollView(string, Rect, ScrollViewSettings) 

public static extern UI.ScrollView PushScrollView(string id, Rect rect, UI.ScrollViewSettings settings)

Parameters

id string
rect Rect
settings UI.ScrollViewSettings

Returns

UI.ScrollView

PushUnlitPlayerMaterial(Player) 

public static void PushUnlitPlayerMaterial(Player player)

Parameters

player Player

ScrollTo_Internal(Rect, nint, int) 

public static extern void ScrollTo_Internal(Rect rect, nint scrollViewPtr, int kind)

Parameters

rect Rect
scrollViewPtr nint
kind int

SetChatOpen(bool) 

public static extern void SetChatOpen(bool open)

Parameters

open bool

SetLeaderboardOpen(bool) 

public static extern void SetLeaderboardOpen(bool open)

Parameters

open bool

Text(Rect, string, TextSettings, bool) 

[Obsolete("UI.Text() will be made async by default in proto 40, breaking compatibility. If you need the result Rect, use UI.TextSync(). Otherwise use UI.TextAsync().", true)]
public static Rect Text(Rect rect, string text, UI.TextSettings textSettings, bool dryRun = false)

Parameters

rect Rect
text string
textSettings UI.TextSettings
dryRun bool

Returns

Rect

TextAsync(Rect, string, TextSettings) 

public static void TextAsync(Rect rect, string text, UI.TextSettings textSettings)

Parameters

rect Rect
text string
textSettings UI.TextSettings

TextAsync_Internal(Rect, string, TextSettings) 

public static extern void TextAsync_Internal(Rect rect, string text, UI.TextSettings textSettings)

Parameters

rect Rect
text string
textSettings UI.TextSettings

TextInput(string, Rect, TextInputSettings, ref string) 

public static extern UI.InteractResult TextInput(string id, Rect rect, UI.TextInputSettings settings, ref string text)

Parameters

id string
rect Rect
settings UI.TextInputSettings
text string

Returns

UI.InteractResult

TextSync(Rect, string, TextSettings, bool) 

public static Rect TextSync(Rect rect, string text, UI.TextSettings textSettings, bool dryRun = false)

Parameters

rect Rect
text string
textSettings UI.TextSettings
dryRun bool

Returns

Rect

TextSync_Internal(Rect, string, TextSettings, bool) 

public static extern Rect TextSync_Internal(Rect rect, string text, UI.TextSettings textSettings, bool dryRun)

Parameters

rect Rect
text string
textSettings UI.TextSettings
dryRun bool

Returns

Rect

Tooltip(Rect, string) 

public static extern UI.InteractResult Tooltip(Rect rect, string id)

Parameters

rect Rect
id string

Returns

UI.InteractResult

TryGetCurrentDragDropPayload(string) 

public static extern object TryGetCurrentDragDropPayload(string payloadId = null)

Parameters

payloadId string

Returns

object

TutorialElement(string, Rect) 

public static extern void TutorialElement(string id, Rect rect)

Parameters

id string
rect Rect
Edit this page