Barotrauma Client Doc
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
Barotrauma.Networking.Client Class Reference
Inheritance diagram for Barotrauma.Networking.Client:

Public Member Functions

 Client (string name, byte sessionId)
 
T GetVote< T > (VoteType voteType)
 
void SetVote (VoteType voteType, object value)
 
bool SessionOrAccountIdMatches (string userId)
 
void WritePermissions (IWriteMessage msg)
 
void ReadPermissions (IReadMessage inc)
 
void Dispose ()
 
void UpdateVoipSound ()
 
void SetPermissions (ClientPermissions permissions, IEnumerable< Identifier > permittedConsoleCommands)
 
void SetPermissions (ClientPermissions permissions, IEnumerable< DebugConsole.Command > permittedConsoleCommands)
 
void GivePermission (ClientPermissions permission)
 
void RemovePermission (ClientPermissions permission)
 
bool HasPermission (ClientPermissions permission)
 
void ResetVotes ()
 

Static Public Member Functions

static void ReadPermissions (IReadMessage inc, out ClientPermissions permissions, out List< DebugConsole.Command > permittedCommands)
 
static string SanitizeName (string name)
 

Public Attributes

string Name
 
UInt16 NameId
 
readonly byte SessionId
 An ID for this client for the current session. THIS IS NOT A PERSISTENT VALUE. DO NOT STORE THIS LONG-TERM. IT CANNOT BE USED TO IDENTIFY PLAYERS ACROSS SESSIONS. More...
 
AccountInfo AccountInfo
 
LanguageIdentifier Language
 
UInt16 Ping
 
Identifier PreferredJob
 
CharacterTeamType TeamID
 
CharacterTeamType PreferredTeam
 
bool UsingFreeCam
 Is the client using the 'freecam' console command? More...
 
UInt16 CharacterID
 
bool HasSpawned
 
HashSet< Identifier > GivenAchievements = new HashSet<Identifier>()
 
ClientPermissions Permissions = ClientPermissions.None
 
readonly HashSet< DebugConsole.Command > PermittedConsoleCommands = new HashSet<DebugConsole.Command>()
 
bool IsOwner
 
bool IsDownloading
 
float Karma
 

Static Public Attributes

const int MaxNameLength = 32
 

Properties

static IReadOnlyList< Client > ClientList [get]
 
ulong SteamID [get]
 
Option< AccountId > AccountId [get]
 The ID of the account used to authenticate this session. This value can be used as a persistent value to identify players in the banlist and campaign saves. More...
 
Character????? Character [get, set]
 
Vector2? SpectatePos [get, set]
 
bool Spectating [get]
 
bool?? Muted [get, set]
 
bool HasPermissions [get]
 
VoipQueue VoipQueue [get]
 
bool InGame [get, set]
 
VoipSound VoipSound [get, set]
 
float RadioNoise [get, set]
 
bool?? MutedLocally [get, set]
 
bool AllowKicking [get]
 

Detailed Description

Definition at line 10 of file LuaBarotraumaAdditions.cs.

Constructor & Destructor Documentation

◆ Client()

Barotrauma.Networking.Client.Client ( string  name,
byte  sessionId 
)

Definition at line 188 of file BarotraumaShared/SharedSource/Networking/Client.cs.

Member Function Documentation

◆ Dispose()

void Barotrauma.Networking.Client.Dispose ( )

Definition at line 274 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ GetVote< T >()

T Barotrauma.Networking.Client.GetVote< T > ( VoteType  voteType)

Definition at line 198 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ GivePermission()

void Barotrauma.Networking.Client.GivePermission ( ClientPermissions  permission)

Definition at line 153 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ HasPermission()

bool Barotrauma.Networking.Client.HasPermission ( ClientPermissions  permission)

Definition at line 171 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ ReadPermissions() [1/2]

void Barotrauma.Networking.Client.ReadPermissions ( IReadMessage  inc)

Definition at line 253 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ ReadPermissions() [2/2]

static void Barotrauma.Networking.Client.ReadPermissions ( IReadMessage  inc,
out ClientPermissions  permissions,
out List< DebugConsole.Command >  permittedCommands 
)
static

Definition at line 225 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ RemovePermission()

void Barotrauma.Networking.Client.RemovePermission ( ClientPermissions  permission)

Definition at line 162 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ ResetVotes()

void Barotrauma.Networking.Client.ResetVotes ( )

Definition at line 181 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ SanitizeName()

static string Barotrauma.Networking.Client.SanitizeName ( string  name)
static

Definition at line 259 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ SessionOrAccountIdMatches()

bool Barotrauma.Networking.Client.SessionOrAccountIdMatches ( string  userId)

◆ SetPermissions() [1/2]

void Barotrauma.Networking.Client.SetPermissions ( ClientPermissions  permissions,
IEnumerable< DebugConsole.Command >  permittedConsoleCommands 
)

Definition at line 139 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ SetPermissions() [2/2]

void Barotrauma.Networking.Client.SetPermissions ( ClientPermissions  permissions,
IEnumerable< Identifier >  permittedConsoleCommands 
)

Definition at line 125 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ SetVote()

void Barotrauma.Networking.Client.SetVote ( VoteType  voteType,
object  value 
)

Definition at line 203 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ UpdateVoipSound()

void Barotrauma.Networking.Client.UpdateVoipSound ( )

Definition at line 55 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ WritePermissions()

void Barotrauma.Networking.Client.WritePermissions ( IWriteMessage  msg)

Definition at line 212 of file BarotraumaShared/SharedSource/Networking/Client.cs.

Member Data Documentation

◆ AccountInfo

AccountInfo Barotrauma.Networking.Client.AccountInfo

Definition at line 39 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ CharacterID

UInt16 Barotrauma.Networking.Client.CharacterID

Definition at line 103 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ GivenAchievements

HashSet<Identifier> Barotrauma.Networking.Client.GivenAchievements = new HashSet<Identifier>()

Definition at line 179 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ HasSpawned

bool Barotrauma.Networking.Client.HasSpawned

Definition at line 177 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ IsDownloading

bool Barotrauma.Networking.Client.IsDownloading

Definition at line 45 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ IsOwner

bool Barotrauma.Networking.Client.IsOwner

Definition at line 42 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ Karma

float Barotrauma.Networking.Client.Karma

Definition at line 47 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ Language

LanguageIdentifier Barotrauma.Networking.Client.Language

Definition at line 48 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ MaxNameLength

const int Barotrauma.Networking.Client.MaxNameLength = 32
static

Definition at line 28 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ Name

string Barotrauma.Networking.Client.Name

Definition at line 30 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ NameId

UInt16 Barotrauma.Networking.Client.NameId

Definition at line 30 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ Permissions

ClientPermissions Barotrauma.Networking.Client.Permissions = ClientPermissions.None

Definition at line 181 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ PermittedConsoleCommands

readonly HashSet<DebugConsole.Command> Barotrauma.Networking.Client.PermittedConsoleCommands = new HashSet<DebugConsole.Command>()

Definition at line 182 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ Ping

UInt16 Barotrauma.Networking.Client.Ping

Definition at line 50 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ PreferredJob

Identifier Barotrauma.Networking.Client.PreferredJob

Definition at line 52 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ PreferredTeam

CharacterTeamType Barotrauma.Networking.Client.PreferredTeam

Definition at line 56 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ SessionId

readonly byte Barotrauma.Networking.Client.SessionId

An ID for this client for the current session. THIS IS NOT A PERSISTENT VALUE. DO NOT STORE THIS LONG-TERM. IT CANNOT BE USED TO IDENTIFY PLAYERS ACROSS SESSIONS.

Definition at line 37 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ TeamID

CharacterTeamType Barotrauma.Networking.Client.TeamID

Definition at line 54 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ UsingFreeCam

bool Barotrauma.Networking.Client.UsingFreeCam

Is the client using the 'freecam' console command?

Definition at line 101 of file BarotraumaShared/SharedSource/Networking/Client.cs.

Property Documentation

◆ AccountId

Option<AccountId> Barotrauma.Networking.Client.AccountId
get

The ID of the account used to authenticate this session. This value can be used as a persistent value to identify players in the banlist and campaign saves.

Definition at line 46 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ AllowKicking

bool Barotrauma.Networking.Client.AllowKicking
get

Definition at line 49 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ Character

Character????? Barotrauma.Networking.Client.Character
getset

Definition at line 59 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ ClientList

IReadOnlyList<Client> Barotrauma.Networking.Client.ClientList
staticget

Definition at line 12 of file LuaBarotraumaAdditions.cs.

◆ HasPermissions

bool Barotrauma.Networking.Client.HasPermissions
get

Definition at line 153 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ InGame

bool Barotrauma.Networking.Client.InGame
getset

Definition at line 162 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ Muted

bool?? Barotrauma.Networking.Client.Muted
getset

Definition at line 135 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ MutedLocally

bool?? Barotrauma.Networking.Client.MutedLocally
getset

Definition at line 28 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ RadioNoise

float Barotrauma.Networking.Client.RadioNoise
getset

Definition at line 20 of file BarotraumaClient/ClientSource/Networking/Client.cs.

◆ SpectatePos

Vector2? Barotrauma.Networking.Client.SpectatePos
getset

Definition at line 106 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ Spectating

bool Barotrauma.Networking.Client.Spectating
get

Definition at line 126 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ SteamID

ulong Barotrauma.Networking.Client.SteamID
get

Definition at line 26 of file LuaBarotraumaAdditions.cs.

◆ VoipQueue

VoipQueue Barotrauma.Networking.Client.VoipQueue
get

Definition at line 155 of file BarotraumaShared/SharedSource/Networking/Client.cs.

◆ VoipSound

VoipSound Barotrauma.Networking.Client.VoipSound
getset

Definition at line 11 of file BarotraumaClient/ClientSource/Networking/Client.cs.