Class ToastManager

Namespace

Uncreated.Warfare.Players.UI

Assembly

Uncreated.Warfare.dll

public sealed class ToastManager : IPlayerComponent, IDisposable

Inheritance

object

ToastManager

Implements

IPlayerComponent

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Channels

Overlapping toasts are split up into channels. Each channel can only show one toast at a time.

public ToastManager.ToastMessageChannel[] Channels { get; }

Property Value

ToastMessageChannel[]

HasToasts

public bool HasToasts { get; }

Property Value

bool

Hold

Makes toasts wait until this is set to false before continuing.

public bool Hold { get; set; }

Property Value

bool

Player

public WarfarePlayer Player { get; }

Property Value

WarfarePlayer

ToastMessages

List of data for each ToastMessageStyle in use.

public static ToastMessageInfo[] ToastMessages { get; }

Property Value

ToastMessageInfo[]

Remarks

Use the integer value of the enum as index.

Methods

BlockChannelFor(int, float)

public void BlockChannelFor(int channel, float time)

Parameters

channel int

time float

Queue(in ToastMessage)

public void Queue(in ToastMessage message)

Parameters

message ToastMessage

Remarks

Thread Safe

SkipExpiration(int)

public void SkipExpiration(int channel)

Parameters

channel int

Remarks

Thread Safe

SkipExpiration(ToastMessageStyle)

public void SkipExpiration(ToastMessageStyle style)

Parameters

style ToastMessageStyle

Remarks

Thread Safe

TryFindCurrentToastInfo(ToastMessageStyle, out ToastMessage)

public bool TryFindCurrentToastInfo(ToastMessageStyle style, out ToastMessage message)

Parameters

style ToastMessageStyle

message ToastMessage

Returns

bool