Class VoteUIDisplay<TData>

Namespace

Uncreated.Warfare.Players

Assembly

Uncreated.Warfare.dll

A UI implementation of IVoteDisplay.

public abstract class VoteUIDisplay<TData> : UnturnedUI, IDisposable, IVoteDisplay where TData : VoteUIDisplayData

Type Parameters

TData

Player-specific UI data type inheriting VoteUIDisplayData.

Inheritance

object

UnturnedUI

VoteUIDisplay<TData>

Implements

IDisposable

IVoteDisplay

Inherited Members

UnturnedUI.Logger

UnturnedUI.LoggerFactory

UnturnedUI.GetLogger()

UnturnedUI.LoadFromConfig(Guid)

UnturnedUI.LoadFromConfig(IAssetContainer)

UnturnedUI.LoadFromConfig(ushort)

UnturnedUI.LoadFromConfig(EffectAsset)

UnturnedUI.AddData(IUnturnedUIData)

UnturnedUI.GetOrAddData<TData>(CSteamID, Func<CSteamID, TData>)

UnturnedUI.GetData<TData>(CSteamID)

UnturnedUI.EnumerateData()

UnturnedUI.LateRegisterElement(UnturnedUIElement)

UnturnedUI.LateRegisterElement(object)

UnturnedUI.SendToPlayer(SteamPlayer)

UnturnedUI.SendToPlayer(Player)

UnturnedUI.SendToPlayer(ITransportConnection)

UnturnedUI.SendToPlayer(SteamPlayer, string)

UnturnedUI.SendToPlayer(Player, string)

UnturnedUI.SendToPlayer(ITransportConnection, string)

UnturnedUI.SendToPlayer(SteamPlayer, string, string)

UnturnedUI.SendToPlayer(Player, string, string)

UnturnedUI.SendToPlayer(ITransportConnection, string, string)

UnturnedUI.SendToPlayer(SteamPlayer, string, string, string)

UnturnedUI.SendToPlayer(Player, string, string, string)

UnturnedUI.SendToPlayer(ITransportConnection, string, string, string)

UnturnedUI.SendToPlayer(SteamPlayer, string, string, string, string)

UnturnedUI.SendToPlayer(Player, string, string, string, string)

UnturnedUI.SendToPlayer(ITransportConnection, string, string, string, string)

UnturnedUI.ClearFromPlayer(SteamPlayer)

UnturnedUI.ClearFromPlayer(Player)

UnturnedUI.ClearFromPlayer(ITransportConnection)

UnturnedUI.SendToAllPlayers()

UnturnedUI.SendToAllPlayers(string)

UnturnedUI.SendToAllPlayers(string, string)

UnturnedUI.SendToAllPlayers(string, string, string)

UnturnedUI.SendToAllPlayers(string, string, string, string)

UnturnedUI.ClearFromAllPlayers()

UnturnedUI.Dispose()

UnturnedUI.OnDisposing()

UnturnedUI.HasAssetOrId

UnturnedUI.HasAsset

UnturnedUI.Id

UnturnedUI.Guid

UnturnedUI.Asset

UnturnedUI.IsReliable

UnturnedUI.IsSendReliable

UnturnedUI.HasElements

UnturnedUI.DebugLogging

UnturnedUI.Elements

UnturnedUI.HasDefaultName

UnturnedUI.Name

UnturnedUI.Key

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

VoteUIDisplay(IServiceProvider, IPlayerVoteManager, string)

protected VoteUIDisplay(IServiceProvider serviceProvider, IPlayerVoteManager voteManager, string uiConfig)

Parameters

serviceProvider IServiceProvider

voteManager IPlayerVoteManager

uiConfig string

Fields

TranslationService

protected readonly ITranslationService TranslationService

Field Value

ITranslationService

VoteManager

protected readonly IPlayerVoteManager VoteManager

Field Value

IPlayerVoteManager

VoteSettings

protected VoteSettings VoteSettings

Field Value

VoteSettings

Properties

HasVote

protected bool HasVote { get; }

Property Value

bool

Methods

CreateData(CSteamID)

protected abstract TData CreateData(CSteamID arg)

Parameters

arg CSteamID

Returns

TData

GetOrAddData(CSteamID)

protected TData GetOrAddData(CSteamID id)

Parameters

id CSteamID

Returns

TData

OnCleared(WarfarePlayer, TData)

protected virtual void OnCleared(WarfarePlayer player, TData data)

Parameters

player WarfarePlayer

data TData

PlayerIsVoting()

protected Func<WarfarePlayer, bool> PlayerIsVoting()

Returns

Func<WarfarePlayer, bool>

PlayerJoinedVote(WarfarePlayer)

Invoked on the game thread when a player joins the vote.

public void PlayerJoinedVote(WarfarePlayer player)

Parameters

player WarfarePlayer

PlayerLeftVote(WarfarePlayer)

Invoked on the game thread when a player leaves the vote.

public void PlayerLeftVote(WarfarePlayer player)

Parameters

player WarfarePlayer

PlayerVoteUpdated(CSteamID, PlayerVoteState, PlayerVoteState)

Invoked when a player enters or changes their vote.

public void PlayerVoteUpdated(CSteamID playerId, PlayerVoteState newVote, PlayerVoteState oldVote)

Parameters

playerId CSteamID

newVote PlayerVoteState

oldVote PlayerVoteState

SendToPlayers(LanguageSet)

protected abstract void SendToPlayers(LanguageSet set)

Parameters

set LanguageSet

VoteFinished(IVoteResult)

Invoked on the game thread when the vote finishes or gets cancelled.

public void VoteFinished(IVoteResult result)

Parameters

result IVoteResult

VoteStarted(in VoteSettings, Func<WarfarePlayer, bool>?)

Invoked on the game thread when the vote first starts.

public void VoteStarted(in VoteSettings settings, Func<WarfarePlayer, bool>? playerSelector)

Parameters

settings VoteSettings

playerSelector Func<WarfarePlayer, bool>