This graph shows which files directly or indirectly include this file:

Classes
class	ClientState
	Purpose: common client state, usable on client and server Client: singleton representing the viewed player Server: instance per client. More...
class	PlayerState
	Purpose: common player state, usable on client and server Client: singleton representing the viewed player Server: instance per client, clients decoupled from players. More...

Macros
#define	CS_CVAR(this)
#define	PS(this)

Functions
void	ClientState_attach (entity this)
void	ClientState_detach (entity this)
ClientState	CS (Client this)
void	PlayerState_attach (entity this)
void	PlayerState_detach (entity this)

Variables
ClientState	_cs
PlayerState	_ps

Macro Definition Documentation

◆ CS_CVAR

#define CS_CVAR ( this )

Value:

(this)

Definition at line 51 of file state.qh.

Referenced by _GlobalSound(), accuracy_send(), antilag_getlag(), bot_setclientfields(), buff_Touch(), buff_Waypoint_visible_for_player(), ClientCommand_autoswitch(), ClientCommand_physics(), ClientCommand_sentcvar(), ClientDisconnect(), ClientState_detach(), for(), GiveItems(), Handicap_GetVoluntaryHandicap(), IntermissionThink(), Item_GiveTo(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), nade_prime(), ObserverOrSpectatorThink(), Physics_ClientOption(), PlayerFrame(), PlayerStats_GameReport_AddPlayer(), PlayerStats_GameReport_FinalizePlayer(), PlayerThink(), PutPlayerInServer(), race_checkAndWriteName(), race_setTime(), SpawnCasing(), tracebox_antilag(), traceline_antilag(), W_FixWeaponOrder_ForceComplete_AndBuildImpulseList(), W_NextWeapon(), W_NextWeaponOnImpulse(), W_PreviousWeapon(), W_SetupShot_Dir_ProjectileSize_Range(), W_SwitchWeapon(), W_SwitchWeapon_TryOthers(), WarpZone_tracebox_antilag(), and WarpZone_traceline_antilag().

◆ PS

#define PS ( this )

Value:

((this)._ps)

Definition at line 18 of file state.qh.

Referenced by client_hasweapon(), door_check_keys(), fireBullet_falloff(), Inventory_customize(), Inventory_pickupitem(), item_key_touch(), PlayerDamage(), PlayerState_attach(), PlayerState_detach(), PutClientInServer(), PutPlayerInServer(), reset_map(), SpectateCopy(), trigger_keylock_touch(), and W_WeaponFrame().

Function Documentation

◆ ClientState_attach()

void ClientState_attach ( entity this )

Definition at line 46 of file state.qc.

{
    this._cs = NEW(ClientState, this);
 
    // TODO: fold all of these into ClientState
 
    DecodeLevelParms(this);
 
    PlayerScore_Attach(this);
    PlayerStats_PlayerBasic_CheckUpdate(this);
    ClientData_Attach(this);
    accuracy_init(this);
    entcs_attach(this);
    anticheat_init(this);
    W_HitPlotOpen(this);
    InventoryStorage_attach(this);
    StatusEffectsStorage_attach(this);
}

◆ ClientState_detach()

void ClientState_detach ( entity this )

Definition at line 73 of file state.qc.

{
    GetCvars(this, CS_CVAR(this), -1);  // free cvars TODO: is this still needed now that it's stored on the clientstate entity?
    accuracy_free(this); // TODO: needs to be before CS() is deleted!
    PlayerScore_Detach(this); // what ^they^ said
    W_HitPlotClose(this);
    ClientData_Detach(this);
    entcs_detach(this);
    InventoryStorage_delete(this);
    StatusEffectsStorage_delete(this);
    delete(CS(this));
    this._cs = NULL;
 
    bot_clientdisconnect(this);
 
    anticheat_report_to_eventlog(this);
}

References _cs, accuracy_free(), anticheat_report_to_eventlog(), bot_clientdisconnect(), ClientData_Detach(), CS(), CS_CVAR, entcs_detach(), entity(), GetCvars(), InventoryStorage_delete(), NULL, PlayerScore_Detach(), StatusEffectsStorage_delete(), and W_HitPlotClose().

Referenced by ClientDisconnect().

◆ CS()

ClientState CS ( Client this )

Definition at line 47 of file state.qh.

47{ TC(Client, this); assert(this._cs); return this._cs; }

Client

Definition client.qh:89

TC

#define TC(T, sym)

Definition _all.inc:82

assert

#define assert(expr,...)

Definition log.qh:8

References _cs, assert, and TC.

◆ PlayerState_attach()

void PlayerState_attach ( entity this )

Definition at line 12 of file state.qc.

{
    if (PS(this) && PS(this).m_client == this)
        return;
 
    this._ps = NEW(PlayerState, this);
 
    Inventory_new(PS(this));
}

References _ps, entity(), Inventory_new(), NEW, and PS.

Referenced by PutPlayerInServer().

◆ PlayerState_detach()

void PlayerState_detach ( entity this )

Definition at line 22 of file state.qc.

{
    PlayerState ps = PS(this);
    if (!ps) return;  // initial connect
    PS(this) = NULL;
    Inventory_clear(this.inventory_store); // no need to network updates, as there is no inventory attached
 
    if (ps.m_client != this) return;  // don't own state, spectator
    ps.ps_push(ps, this);
    Inventory_delete(ps);
 
    FOREACH_CLIENT(PS(it) == ps, { PS(it) = NULL; });
    delete(ps);
}