Class ScreenBase

Namespace

TaleWorlds.ScreenSystem

Assembly

TaleWorlds.ScreenSystem.dll

public abstract class ScreenBase

Inheritance

object

ScreenBase

Derived

MBInitialScreenBase

MBProfileSelectionScreenBase

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ScreenBase()

protected ScreenBase()

Fields

_shouldTickLayersThisFrame

protected bool _shouldTickLayersThisFrame

Field Value

bool

Properties

DebugInput

public IInputContext DebugInput { get; }

Property Value

IInputContext

IsActive

public bool IsActive { get; }

Property Value

bool

IsPaused

public bool IsPaused { get; }

Property Value

bool

Layers

public MBReadOnlyList<ScreenLayer> Layers { get; }

Property Value

MBReadOnlyList<ScreenLayer>

MouseVisible

public virtual bool MouseVisible { get; set; }

Property Value

bool

Methods

Activate()

public void Activate()

ActivateAllLayers()

public void ActivateAllLayers()

AddComponent(ScreenComponent)

public void AddComponent(ScreenComponent component)

Parameters

component ScreenComponent

AddLayer(ScreenLayer)

public void AddLayer(ScreenLayer layer)

Parameters

layer ScreenLayer

Deactivate()

public void Deactivate()

DeactivateAllLayers()

public void DeactivateAllLayers()

FindComponent<T>()

public T FindComponent<T>() where T : ScreenComponent

Returns

T

Type Parameters

T

FindLayer<T>()

public T FindLayer<T>() where T : ScreenLayer

Returns

T

Type Parameters

T

FindLayer<T>(string)

public T FindLayer<T>(string name) where T : ScreenLayer

Parameters

name string

Returns

T

Type Parameters

T

HasLayer(ScreenLayer)

public bool HasLayer(ScreenLayer layer)

Parameters

layer ScreenLayer

Returns

bool

OnActivate()

protected virtual void OnActivate()

OnDeactivate()

protected virtual void OnDeactivate()

OnFinalize()

protected virtual void OnFinalize()

OnFocusChangeOnGameWindow(bool)

public virtual void OnFocusChangeOnGameWindow(bool focusGained)

Parameters

focusGained bool

OnFrameTick(float)

protected virtual void OnFrameTick(float dt)

Parameters

dt float

OnIdleTick(float)

protected virtual void OnIdleTick(float dt)

Parameters

dt float

OnInitialize()

protected virtual void OnInitialize()

OnPause()

protected virtual void OnPause()

OnResume()

protected virtual void OnResume()

RemoveLayer(ScreenLayer)

public void RemoveLayer(ScreenLayer layer)

Parameters

layer ScreenLayer

SetLayerCategoriesState(string[], bool)

public void SetLayerCategoriesState(string[] categoryIds, bool isActive)

Parameters

categoryIds string[]

isActive bool

SetLayerCategoriesStateAndDeactivateOthers(string[], bool)

public void SetLayerCategoriesStateAndDeactivateOthers(string[] categoryIds, bool isActive)

Parameters

categoryIds string[]

isActive bool

SetLayerCategoriesStateAndToggleOthers(string[], bool)

public void SetLayerCategoriesStateAndToggleOthers(string[] categoryIds, bool isActive)

Parameters

categoryIds string[]

isActive bool

UpdateLayout()

public virtual void UpdateLayout()

Events

OnAddLayer

public event ScreenBase.OnLayerAddedEvent OnAddLayer

Event Type

ScreenBase.OnLayerAddedEvent

OnRemoveLayer

public event ScreenBase.OnLayerRemovedEvent OnRemoveLayer

Event Type

ScreenBase.OnLayerRemovedEvent

---

This page was last modified at 09/01/2024 16:12:00 +00:00 (UTC).