Class PlayerPending

Namespace

Uncreated.Warfare.Events.Models.Players

Assembly

Uncreated.Warfare.dll

Event listener args which handles a patch on when the player gets put in the queue.

public sealed class PlayerPending : CancellableEvent, ICancellable, IActionLoggableEvent

Inheritance

object

CancellableEvent

PlayerPending

Implements

ICancellable

IActionLoggableEvent

Inherited Members

CancellableEvent.IsCancelled

CancellableEvent.IsActionCancelled

CancellableEvent.Cancel(bool)

CancellableEvent.CancelAction()

CancellableEvent.ResumeAction()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BeardIndex

The player's beard style.

public byte BeardIndex { get; set; }

Property Value

byte

Remarks

This can be changed.

CharacterIndex

Which character the player has selected.

public byte CharacterIndex { get; set; }

Property Value

byte

Remarks

This can be changed.

CharacterName

Public name of the player's character.

public string CharacterName { get; set; }

Property Value

string

Remarks

This can be changed.

CultureInfo

The culture to use for translating rejection messages.

public required CultureInfo CultureInfo { get; init; }

Property Value

CultureInfo

EquippedMarketplaceBackpack

The Steam marketplace instance ID of the backpack skin equipped on the player.

public ulong EquippedMarketplaceBackpack { get; set; }

Property Value

ulong

Remarks

This can be changed.

EquippedMarketplaceGlasses

The Steam marketplace instance ID of the glassess skin equipped on the player.

public ulong EquippedMarketplaceGlasses { get; set; }

Property Value

ulong

Remarks

This can be changed.

EquippedMarketplaceHat

The Steam marketplace instance ID of the hat skin equipped on the player.

public ulong EquippedMarketplaceHat { get; set; }

Property Value

ulong

Remarks

This can be changed.

EquippedMarketplaceMask

The Steam marketplace instance ID of the mask skin equipped on the player.

public ulong EquippedMarketplaceMask { get; set; }

Property Value

ulong

Remarks

This can be changed.

EquippedMarketplacePants

The Steam marketplace instance ID of the pants skin equipped on the player.

public ulong EquippedMarketplacePants { get; set; }

Property Value

ulong

Remarks

This can be changed.

EquippedMarketplaceShirt

The Steam marketplace instance ID of the shirt skin equipped on the player.

public ulong EquippedMarketplaceShirt { get; set; }

Property Value

ulong

Remarks

This can be changed.

EquippedMarketplaceVest

The Steam marketplace instance ID of the vest skin equipped on the player.

public ulong EquippedMarketplaceVest { get; set; }

Property Value

ulong

Remarks

This can be changed.

EquippedSkins

The Steam marketplace instance IDs of all equipped skins.

public ulong[] EquippedSkins { get; set; }

Property Value

ulong[]

Remarks

This can be changed.

FaceIndex

The player's starting face style.

public byte FaceIndex { get; set; }

Property Value

byte

Remarks

This can be changed.

GroupId

The player's group ID.

public CSteamID GroupId { get; set; }

Property Value

CSteamID

Remarks

This can be changed.

HairColor

The player's hair color.

public Color HairColor { get; set; }

Property Value

Color

Remarks

This can be changed.

HairIndex

The player's hair style.

public byte HairIndex { get; set; }

Property Value

byte

Remarks

This can be changed.

HasGold

If the player has Unturned Gold (Pro) when they join.

public bool HasGold { get; set; }

Property Value

bool

Remarks

This can be changed.

IsAdmin

If the player is a vanilla admin when they join.

public bool IsAdmin { get; set; }

Property Value

bool

Remarks

This can be changed.

IsLeftHanded

The player's left-handedness setting.

public bool IsLeftHanded { get; set; }

Property Value

bool

Remarks

This can be changed.

IsNewPlayer

If this is the first time the player has joined.

public bool IsNewPlayer { get; }

Property Value

bool

Language

The player's Steam language.

public string Language { get; set; }

Property Value

string

Remarks

This can be changed.

LanguageInfo

The language to use for translating rejection messages.

public required LanguageInfo LanguageInfo { get; init; }

Property Value

LanguageInfo

MarkerColor

The player's marker color.

public Color MarkerColor { get; set; }

Property Value

Color

Remarks

This can be changed.

NickName

Name of the player's character visible to their group.

public string NickName { get; set; }

Property Value

string

Remarks

This can be changed.

PendingPlayer

The pending player.

public required SteamPending PendingPlayer { get; init; }

Property Value

SteamPending

PlayerName

The Steam name of the pending player.

public string PlayerName { get; }

Property Value

string

RejectReason

Rejection reason if the player is rejected. Defaults to a generic error message.

public required string RejectReason { get; set; }

Property Value

string

Remarks

This can be changed.

Rejection

Rejection reason type if the player is rejected. Defaults to SDG.Unturned.ESteamRejection.PLUGIN.

public ESteamRejection Rejection { get; set; }

Property Value

ESteamRejection

Remarks

This can be changed.

SaveData

Previous save data for the player.

public required BinaryPlayerSave? SaveData { get; init; }

Property Value

BinaryPlayerSave

Skillset

The player's character skillset.

public EPlayerSkillset Skillset { get; set; }

Property Value

EPlayerSkillset

Remarks

This can be changed.

SkinColor

The player's skin color.

public Color SkinColor { get; set; }

Property Value

Color

Remarks

This can be changed.

Steam64

The Steam ID of the pending player.

public CSteamID Steam64 { get; }

Property Value

CSteamID

Summary

Steam summary of the player containing information about their Steam account.

public required PlayerSummary Summary { get; init; }

Property Value

PlayerSummary

TimeZone

The time zone to use for translating rejection messages.

public required TimeZoneInfo TimeZone { get; init; }

Property Value

TimeZoneInfo

Methods

GetActionLogEntry(IServiceProvider, ref ActionLogEntry[]?)

public ActionLogEntry GetActionLogEntry(IServiceProvider serviceProvider, ref ActionLogEntry[]? multipleEntries)

Parameters

serviceProvider IServiceProvider

multipleEntries ActionLogEntry[]

Returns

ActionLogEntry

Reject(string)

Reject the player.

public ControlException Reject(string reason)

Parameters

reason string

Returns

ControlException

An exception that can be thrown without logging an error.

Reject(string, ESteamRejection)

Reject the player.

public ControlException Reject(string reason, ESteamRejection rejection)

Parameters

reason string

rejection ESteamRejection

Returns

ControlException

An exception that can be thrown without logging an error.