Interface IPlayerHelper

Namespace

Archipelago.MultiClient.Net.Helpers

Assembly

Archipelago.MultiClient.Net.dll

A helper class containing information about all players in the current multiworld

public interface IPlayerHelper

Properties

ActivePlayer

The player info for the currently connected player

PlayerInfo ActivePlayer { get; }

Property Value

PlayerInfo

AllPlayers

A enumerable of PlayerInfo's for all players in the multiworld

IEnumerable<PlayerInfo> AllPlayers { get; }

Property Value

IEnumerable<PlayerInfo>

Players

A dictionary of all team's containing all their PlayerInfo's index by their slot

Dictionary<int, ReadOnlyCollection<PlayerInfo>> Players { get; }

Property Value

Dictionary<int, ReadOnlyCollection<PlayerInfo>>

Methods

GetPlayerAlias(int)

Returns the Alias corresponding to the provided player slot Alias defaults to the player's name until a different alias is specifically set

string GetPlayerAlias(int slot)

Parameters

slot int

The slot of which to retrieve the alias

Returns

string

The player's alias, or null if no such player is found

GetPlayerAliasAndName(int)

Returns the Alias and Name corresponding to the provided player slot Alias defaults to the player's name until a different alias is specifically set The result is returned in the format of "Alias (Name)"

string GetPlayerAliasAndName(int slot)

Parameters

slot int

The slot of which to retrieve the alias

Returns

string

The player's alias and name in the following format of "Alias (Name)", or null if no such player is found

GetPlayerInfo(int)

Gets the PlayerInfo for the provided team and slot, or null if no such slot exists

PlayerInfo GetPlayerInfo(int slot)

Parameters

slot int

the slot to lookup

Returns

PlayerInfo

the playerinfo of corresponding slot, or null if no such slot exists

GetPlayerInfo(int, int)

Gets the PlayerInfo for the provided team and slot, or null if no such team / slot exists

PlayerInfo GetPlayerInfo(int team, int slot)

Parameters

team int

the team to lookup the slot in

slot int

the slot to lookup

Returns

PlayerInfo

the playerinfo of corresponding slot, or null if no such slot exists

GetPlayerName(int)

Returns the Name corresponding to the provided player slot

string GetPlayerName(int slot)

Parameters

slot int

The slot of which to retrieve the name

Returns

string

The player's name, or null if no such player is found