AtomicNET : AtomicEngine Namespace

UI Class

Documentation for this section has not yet been entered.

Syntax

public class UI : AObject

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from AObject.

Public Constructors

UI ()
Documentation for this section has not yet been entered.
Construct.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

BlockChangedEvents bool . Documentation for this section has not yet been entered.
[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
[write-only]
DebugHudProfileMode DebugHudProfileMode . Documentation for this section has not yet been entered.
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
FocusedWidget bool . Documentation for this section has not yet been entered.
[read-only]
HoveredWidget UIWidget . Documentation for this section has not yet been entered.
[write-only]
InputDisabled bool . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[write-only]
KeyboardDisabled bool . Documentation for this section has not yet been entered.
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
SkinLoaded bool . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
TypeNameStatic string . Documentation for this section has not yet been entered. (Inherited from AObject.)

Public Methods

AddFont (string, string)
Documentation for this section has not yet been entered.
AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
static
csb_Atomic_UI_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
CycleDebugHudMode ()
Cycle debug HUD between showing primitive stats, current mode, profiler data, all three or none
DebugGetWrappedWidgetCount () : uint
Documentation for this section has not yet been entered.
static
DebugShowSettingsWindow (UIWidget)
Documentation for this section has not yet been entered.
GetBlockChangedEvents () : bool
Documentation for this section has not yet been entered.
GetCategory () : string
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. (Inherited from AObject.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetFocusedWidget () : bool
Documentation for this section has not yet been entered.
GetHoveredWidget () : UIWidget
Documentation for this section has not yet been entered.
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetSkinLoaded () : bool
Documentation for this section has not yet been entered.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetWidgetAt (int, int, bool) : UIWidget
Documentation for this section has not yet been entered.
HasEventHandlers () : bool
Return whether has subscribed to any event. (Inherited from AObject.)
HasSubscribedToEvent (StringHash) : bool
Return whether has subscribed to an event without specific sender. (Inherited from AObject.)
HasSubscribedToEvent (AObject, StringHash) : bool
Return whether has subscribed to a specific sender's event. (Inherited from AObject.)
Initialize (string)
Documentation for this section has not yet been entered.
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
override
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from AObject.)
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
LoadDefaultPlayerSkin ()
UI/Skin/Override/skin.ui.txt for base skin and possible override (TODO: baked in UI setting for load from project)
LoadSkin (string, string)
Documentation for this section has not yet been entered.
PruneUnreachableWidgets ()
Documentation for this section has not yet been entered.
Refs () : int
Return reference count. (Inherited from RefCounted.)
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
Render (bool)
Documentation for this section has not yet been entered.
RequestExit ()
request exit on next frame
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetBlockChangedEvents (bool)
Documentation for this section has not yet been entered.
SetDebugHudExtents (bool, IntVector2, IntVector2)
Documentation for this section has not yet been entered.
SetDebugHudProfileMode (DebugHudProfileMode)
Documentation for this section has not yet been entered.
SetDefaultFont (string, int)
Documentation for this section has not yet been entered.
SetInputDisabled (bool)
Documentation for this section has not yet been entered.
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetKeyboardDisabled (bool)
Documentation for this section has not yet been entered.
ShowConsole (bool)
Documentation for this section has not yet been entered.
ShowDebugHud (bool)
Documentation for this section has not yet been entered.
Shutdown ()
Documentation for this section has not yet been entered.
SubscribeToEvent (string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (AObject, NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
ToggleConsole ()
Documentation for this section has not yet been entered.
ToggleDebugHud ()
Documentation for this section has not yet been entered.
UnsubscribeFromAllEvents ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (StringHash)
Unsubscribe from an event. (Inherited from AObject.)
UnsubscribeFromEvent (uint)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (AObject, StringHash)
Unsubscribe from a specific sender's event. (Inherited from AObject.)
UnsubscribeFromEvent<T> ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEventReceiver (AObject)
Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object) (Inherited from AObject.)
UnsubscribeFromEvents (AObject)
Unsubscribe from a specific sender's events. (Inherited from AObject.)
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

UI Constructor

Documentation for this section has not yet been entered.

Syntax

public UI ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

UI Constructor

Construct.

Syntax

public UI (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AddFont Method

Documentation for this section has not yet been entered.

Syntax

public void AddFont (string fontFile, string name)

Parameters

fontFile
Documentation for this section has not yet been entered.
name
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

BlockChangedEvents Property

Documentation for this section has not yet been entered.

Syntax

public bool BlockChangedEvents { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_UI_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_UI_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

CycleDebugHudMode Method

Cycle debug HUD between showing primitive stats, current mode, profiler data, all three or none

Syntax

public void CycleDebugHudMode ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

DebugGetWrappedWidgetCount Method

Documentation for this section has not yet been entered.

Syntax

public uint DebugGetWrappedWidgetCount ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

DebugHudProfileMode Property

Documentation for this section has not yet been entered.

Syntax

public DebugHudProfileMode DebugHudProfileMode { set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

DebugShowSettingsWindow Method

Documentation for this section has not yet been entered.

Syntax

public static void DebugShowSettingsWindow (UIWidget parent)

Parameters

parent
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

FocusedWidget Property

Documentation for this section has not yet been entered.

Syntax

public bool FocusedWidget { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetBlockChangedEvents Method

Documentation for this section has not yet been entered.

Syntax

public bool GetBlockChangedEvents ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetFocusedWidget Method

Documentation for this section has not yet been entered.

Syntax

public bool GetFocusedWidget ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetHoveredWidget Method

Documentation for this section has not yet been entered.

Syntax

public UIWidget GetHoveredWidget ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetSkinLoaded Method

Documentation for this section has not yet been entered.

Syntax

public bool GetSkinLoaded ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetWidgetAt Method

Documentation for this section has not yet been entered.

Syntax

public UIWidget GetWidgetAt (int x, int y, bool include_children)

Parameters

x
Documentation for this section has not yet been entered.
y
Documentation for this section has not yet been entered.
include_children
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

HoveredWidget Property

Documentation for this section has not yet been entered.

Syntax

public UIWidget HoveredWidget { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Initialize Method

Documentation for this section has not yet been entered.

Syntax

public void Initialize (string languageFile)

Parameters

languageFile
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

InputDisabled Property

Documentation for this section has not yet been entered.

Syntax

public bool InputDisabled { set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

KeyboardDisabled Property

Documentation for this section has not yet been entered.

Syntax

public bool KeyboardDisabled { set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

LoadDefaultPlayerSkin Method

UI/Skin/Override/skin.ui.txt for base skin and possible override (TODO: baked in UI setting for load from project)

Syntax

public void LoadDefaultPlayerSkin ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

LoadSkin Method

Documentation for this section has not yet been entered.

Syntax

public void LoadSkin (string skin, string overrideSkin)

Parameters

skin
Documentation for this section has not yet been entered.
overrideSkin
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

PruneUnreachableWidgets Method

Documentation for this section has not yet been entered.

Syntax

public void PruneUnreachableWidgets ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Render Method

Documentation for this section has not yet been entered.

Syntax

public void Render (bool resetRenderTargets)

Parameters

resetRenderTargets
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

RequestExit Method

request exit on next frame

Syntax

public void RequestExit ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetBlockChangedEvents Method

Documentation for this section has not yet been entered.

Syntax

public void SetBlockChangedEvents (bool blocked)

Parameters

blocked
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetDebugHudExtents Method

Documentation for this section has not yet been entered.

Syntax

public void SetDebugHudExtents (bool useRootExtents, IntVector2 position, IntVector2 size)

Parameters

useRootExtents
Documentation for this section has not yet been entered.
position
Documentation for this section has not yet been entered.
size
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetDebugHudProfileMode Method

Documentation for this section has not yet been entered.

Syntax

public void SetDebugHudProfileMode (DebugHudProfileMode mode)

Parameters

mode
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetDefaultFont Method

Documentation for this section has not yet been entered.

Syntax

public void SetDefaultFont (string name, int size)

Parameters

name
Documentation for this section has not yet been entered.
size
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetInputDisabled Method

Documentation for this section has not yet been entered.

Syntax

public void SetInputDisabled (bool disabled)

Parameters

disabled
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetKeyboardDisabled Method

Documentation for this section has not yet been entered.

Syntax

public void SetKeyboardDisabled (bool disabled)

Parameters

disabled
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ShowConsole Method

Documentation for this section has not yet been entered.

Syntax

public void ShowConsole (bool value)

Parameters

value
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ShowDebugHud Method

Documentation for this section has not yet been entered.

Syntax

public void ShowDebugHud (bool value)

Parameters

value
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Shutdown Method

Documentation for this section has not yet been entered.

Syntax

public void Shutdown ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SkinLoaded Property

Documentation for this section has not yet been entered.

Syntax

public bool SkinLoaded { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ToggleConsole Method

Documentation for this section has not yet been entered.

Syntax

public void ToggleConsole ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ToggleDebugHud Method

Documentation for this section has not yet been entered.

Syntax

public void ToggleDebugHud ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0