ent_cs.qh File Reference

#include <client/csqcmodel_hooks.qh>
#include <client/main.qh>

Include dependency graph for ent_cs.qh:

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

Go to the source code of this file.

Macros
#define	entcs_is_self(e)
#define	entcs_IsSpectating(i)
#define	entcs_receiver(...)
#define	entcs_receiver_1(i)
#define	entcs_receiver_2(i, v)
#define	EVAL_entcs_receiver(...)

Functions
entity	CSQCModel_server2csqc (int i)
void	entcs_attach (entity player)
void	entcs_detach (entity player)
void	entcs_force_origin (entity player)
float	entcs_GetAlpha (int i)
int	entcs_GetClientColors (int i)
vector	entcs_GetColor (int i)
int	entcs_GetHandicapLevel (int i)
string	entcs_GetName (int i)
int	entcs_GetScoreTeam (int i)
	Same as entcs_GetTeam, but returns -1 for no team in teamplay.
int	entcs_GetSpecState (int i)
int	entcs_GetTeam (int i)
int	entcs_GetTeamColor (int i)
int	entcs_GetWantsJoin (int i)
bool	entcs_IsDead (int i)
bool	entcs_send (entity this, entity to, int sf)
void	entcs_think (entity this)
void	entcs_update_players (entity player)
	SHUTDOWN (_entcs)
	STATIC_INIT (_entcs)

Variables
ArrayList	_entcs
float	alpha
entity	entcs
const int	ENTCS_SPEC_IN_SCOREBOARD = 2
const int	ENTCS_SPEC_PURE = 1
int	frags
int	handicap_level
bool	has_origin
	True when origin is available.
bool	has_sv_origin
	True when a recent server sent origin has been received.
bool	m_entcs_private
	True when private information such as origin is available.
int	m_forceupdate
bool	radar_showenemies
int	sv_solid
int	wants_join

Macro Definition Documentation

entcs_is_self

#define entcs_is_self

(

e

)

Value:

((e).sv_entnum == player_localentnum - 1)

Definition at line 69 of file ent_cs.qh.

entcs_IsSpectating

#define entcs_IsSpectating

(

i

)

Value:

boolean(entcs_GetSpecState(i))

Definition at line 76 of file ent_cs.qh.

Referenced by Draw_ShowNames_All(), and HUD_Mod_Survival().

entcs_receiver

#define entcs_receiver

(

...

)

Value:

EVAL_entcs_receiver(OVERLOAD(entcs_receiver, __VA_ARGS__))

Definition at line 65 of file ent_cs.qh.

Referenced by Draw_ShowNames(), Draw_ShowNames_All(), Ent_RemoveEntCS(), entcs_GetClientColors(), entcs_GetHandicapLevel(), entcs_GetName(), entcs_GetSpecState(), entcs_GetWantsJoin(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), ReadEntcs(), and TrueAimCheck().

entcs_receiver_1

#define entcs_receiver_1

(

i

)

Value:

AL_gete(_entcs, i)

Definition at line 67 of file ent_cs.qh.

entcs_receiver_2

#define entcs_receiver_2	(		i,
			v )

Value:

AL_sete(_entcs, i, v)

Definition at line 68 of file ent_cs.qh.

EVAL_entcs_receiver

#define EVAL_entcs_receiver

(

...

)

Value:

__VA_ARGS__

Definition at line 66 of file ent_cs.qh.

Function Documentation

CSQCModel_server2csqc()

entity CSQCModel_server2csqc

(

int

i

)

Parameters

i	zero indexed player

Definition at line 314 of file cl_model.qc.

{
    if (i < maxclients) return CSQCModel_players[i];
    ++i;
    LOG_DEBUGF("player out of bounds: %d", i);
    return findfloat(NULL, entnum, i);
}

References CSQCModel_players, entity(), entnum, findfloat(), LOG_DEBUGF, maxclients, and NULL.

Referenced by CSQC_UpdateView(), CSQCPlayer_SetCamera(), entcs_GetAlpha(), entcs_GetColor(), entcs_IsDead(), Hud_Dynamic_Frame(), Scoreboard_WouldDraw(), StrafeHUD_GetStrafeplayer(), viewloc_SetViewLocation(), viewmodel_animate(), and viewmodel_draw().

entcs_attach()

void entcs_attach

(

entity

player

)

Definition at line 251 of file ent_cs.qc.

    {
        entity e = CS(player).entcs = new_pure(entcs_sender);
        e.owner = player;
        setthink(e, entcs_think);
        e.nextthink = time;
        Net_LinkEntity(e, false, 0, entcs_send);
        // NOTE: the following code block has been disabled as a workaround for https://gitlab.com/xonotic/xonotic-data.pk3dir/-/issues/1824
#if 0
        if (!IS_REAL_CLIENT(player)) return;
        FOREACH_CLIENT(true, {
            assert(CS(it).entcs);
            _entcs_send(CS(it).entcs, msg_entity = player, BITS(23), MSG_ONE);
        });
#endif
    }

entcs_detach()

void entcs_detach

(

entity

player

)

Definition at line 268 of file ent_cs.qc.

    {
        if (!CS(player).entcs) return;
        delete(CS(player).entcs);
        CS(player).entcs = NULL;
    }

entcs_force_origin()

void entcs_force_origin

(

entity

player

)

Definition at line 36 of file ent_cs.qc.

{
    CS(player).entcs.m_forceupdate = BIT(ENTCS_PROP_ORIGIN_id);
}

References BIT, CS(), ENTCS_PROP_ORIGIN_id, and entity().

Referenced by globalsound(), and playersound().

entcs_GetAlpha()

float entcs_GetAlpha

(

int

i

)

Parameters

i	zero indexed player

Definition at line 167 of file ent_cs.qh.

    {
        entity e = CSQCModel_server2csqc(i);
        return e ? e.alpha : 1;
    }

References CSQCModel_server2csqc(), and entity().

Referenced by Draw_ShowNames().

entcs_GetClientColors()

int entcs_GetClientColors

(

int

i

)

Parameters

i	zero indexed player

Definition at line 115 of file ent_cs.qh.

    {
        entity e = entcs_receiver(i);
        return e ? e.colormap : 0;
    }

References entcs_receiver, and entity().

Referenced by CSQCPlayer_ModelAppearance_Apply(), entcs_GetColor(), entcs_GetTeamColor(), HUD_Main(), NET_HANDLE(), Scoreboard_GetName(), and viewmodel_draw().

entcs_GetColor()

vector entcs_GetColor

(

int

i

)

Parameters

i	zero indexed player

Definition at line 176 of file ent_cs.qh.

    {
        entity e = CSQCModel_server2csqc(i);
        return (!e || e.colormap <= 0)
               ? '1 1 1'
               : colormapPaletteColor(((e.colormap >= 1024)
            ? e.colormap
            : entcs_GetClientColors(e.colormap - 1)) & 15, true)
        ;
    }

References colormapPaletteColor, CSQCModel_server2csqc(), entcs_GetClientColors(), entity(), and vector.

Referenced by Draw_GrapplingHook(), and NET_HANDLE().

entcs_GetHandicapLevel()

int entcs_GetHandicapLevel

(

int

i

)

Parameters

i	zero indexed player

Definition at line 97 of file ent_cs.qh.

    {
        entity e = entcs_receiver(i);
        return e.handicap_level;
    }

References entcs_receiver, and entity().

Referenced by Scoreboard_GetName().

entcs_GetName()

string entcs_GetName

(

int

i

)

Parameters

i	zero indexed player

Definition at line 151 of file ent_cs.qh.

    {
        entity e = entcs_receiver(i);
        return e ? ColorTranslateRGB(e.netname) : "";
    }

References ColorTranslateRGB(), entcs_receiver, and entity().

Referenced by Announcer_Duel(), Draw_ShowNames(), HUD_InfoMessages(), HUD_MinigameMenu_ClickInvite(), HUD_Mod_Race(), HUD_Quickmenu_PlayerListEntries(), HUD_Score_Rankings(), HUD_Scoreboard_InputEvent(), minigame_show_allspecs(), NET_HANDLE(), NET_HANDLE(), Playerchecker_Think(), Scoreboard_DrawOthers(), Scoreboard_GetName(), and Scoreboard_Rankings_Draw().

entcs_GetScoreTeam()

int entcs_GetScoreTeam

(

int

i

)

Same as entcs_GetTeam, but returns -1 for no team in teamplay.

Definition at line 141 of file ent_cs.qh.

    {
        int t = entcs_GetTeam(i);
        if (teamplay && !t) t = -1;
        return t;
    }

References entcs_GetTeam(), and teamplay.

Referenced by Playerchecker_Think(), and Scoreboard_UpdatePlayerTeams().

entcs_GetSpecState()

int entcs_GetSpecState

(

int

i

)

Parameters

i	zero indexed player

Definition at line 81 of file ent_cs.qh.

    {
        bool unconnected = !playerslots[i].gotscores;
        entity e = entcs_receiver(i);
        int fr = ((e) ? e.frags : 0);
        if (unconnected || fr == FRAGS_SPECTATOR)
            return ENTCS_SPEC_PURE;
        int sol = ((e) ? e.sv_solid : SOLID_NOT);
        if (fr == FRAGS_PLAYER_OUT_OF_GAME && sol == SOLID_NOT)
            return ENTCS_SPEC_IN_SCOREBOARD;
        return 0;
    }

References entcs_receiver, ENTCS_SPEC_IN_SCOREBOARD, ENTCS_SPEC_PURE, entity(), FRAGS_PLAYER_OUT_OF_GAME, FRAGS_SPECTATOR, playerslots, and SOLID_NOT.

Referenced by entcs_GetTeam(), MUTATOR_HOOKFUNCTION(), and Scoreboard_DrawItem().

entcs_GetTeam()

int entcs_GetTeam

(

int

i

)

Parameters

i	zero indexed player

Definition at line 133 of file ent_cs.qh.

    {
        return (entcs_GetSpecState(i) == ENTCS_SPEC_PURE) ? NUM_SPECTATOR : entcs_GetTeamColor(i);
    }

References entcs_GetSpecState(), entcs_GetTeamColor(), ENTCS_SPEC_PURE, and NUM_SPECTATOR.

Referenced by CSQC_UpdateView(), Draw_ShowNames(), Draw_WaypointSprite(), EnemyHitCheck(), entcs_GetScoreTeam(), Scoreboard_ComparePlayerScores(), and turret_draw2d().

entcs_GetTeamColor()

int entcs_GetTeamColor

(

int

i

)

Parameters

i	zero indexed player

Returns

0 if not teamplay

Definition at line 125 of file ent_cs.qh.

    {
        return (!teamplay) ? 0 : entcs_GetClientColors(i) & 15;
    }

References entcs_GetClientColors(), and teamplay.

Referenced by Draw_GrapplingHook(), and entcs_GetTeam().

entcs_GetWantsJoin()

int entcs_GetWantsJoin

(

int

i

)

Parameters

i	zero indexed player

Definition at line 106 of file ent_cs.qh.

    {
        entity e = entcs_receiver(i);
        return e.wants_join;
    }

References entcs_receiver, and entity().

Referenced by HUD_InfoMessages(), Scoreboard_DrawItem(), and Scoreboard_DrawOthers().

entcs_IsDead()

bool entcs_IsDead

(

int

i

)

Parameters

i	zero indexed player

Definition at line 190 of file ent_cs.qh.

    {
        entity e = CSQCModel_server2csqc(i);
        return e ? e.csqcmodel_isdead : false;
    }

References CSQCModel_server2csqc(), and entity().

Referenced by Draw_ShowNames_All().

entcs_send()

bool entcs_send	(	entity	this,
		entity	to,
		int	sf )

Definition at line 220 of file ent_cs.qc.

    {
        return _entcs_send(this, to, sf, MSG_ENTITY);
    }

References _entcs_send(), entity(), and MSG_ENTITY.

Referenced by entcs_attach().

entcs_think()

void entcs_think

(

entity

this

)

Definition at line 225 of file ent_cs.qc.

    {
        this.nextthink = time + 0.015625;  // TODO: increase this to like 0.125 once the client can do smoothing
        entity player = this.owner;
        FOREACH(EntCSProps, it.m_check(this, player),
        {
            it.m_set(this, player);
            this.SendFlags |= BIT(it.m_id);
        });
 
        if (intermission_running)
        {
            // health is set to special values after the game ends, ignore any change
            this.SendFlags &= ~BIT(ENTCS_PROP_HEALTH_id);
        }
 
        // always send origin of players even if they stand still otherwise
        // if a teammate isn't in my pvs and their health (or view angle or name
        // etc...) changes then their tag disappears
        if (IS_PLAYER(this.owner))
            this.SendFlags |= BIT(ENTCS_PROP_ORIGIN_id);
 
        // not needed, origin is just data to be sent
        //setorigin(this, this.origin); // relink
    }

References BIT, ENTCS_PROP_HEALTH_id, ENTCS_PROP_ORIGIN_id, entity(), FOREACH, intermission_running, IS_PLAYER, nextthink, owner, SendFlags, and time.

Referenced by entcs_attach(), and ReadEntcs().

entcs_update_players()

void entcs_update_players

(

entity

player

)

Definition at line 183 of file ent_cs.qc.

    {
        FOREACH_CLIENT(it != player && IS_PLAYER(it),
        {
            CS(it).entcs.SendFlags |= ENTCS_PRIVATEMASK;
        });
    }

References CS(), ENTCS_PRIVATEMASK, entity(), FOREACH_CLIENT, and IS_PLAYER.

Referenced by MUTATOR_HOOKFUNCTION(), and PutObserverInServer().

SHUTDOWN()

SHUTDOWN

(

_entcs

)

Definition at line 61 of file ent_cs.qh.

    {
        AL_DELETE(_entcs);
    }

References _entcs, and AL_DELETE.

STATIC_INIT()

STATIC_INIT

(

_entcs

)

Definition at line 57 of file ent_cs.qh.

    {
        AL_NEW(_entcs, 255, NULL, e);  // 255 is the engine limit on maxclients
    }

References _entcs, AL_NEW, and NULL.

Variable Documentation

_entcs

ArrayList _entcs

Definition at line 56 of file ent_cs.qh.

Referenced by SHUTDOWN(), and STATIC_INIT().

alpha

float alpha

Definition at line 162 of file ent_cs.qh.

entcs

entity entcs

Definition at line 34 of file ent_cs.qh.

Referenced by Draw_ShowNames(), Draw_ShowNames_All(), entcs_attach(), entcs_detach(), and NET_HANDLE().

ENTCS_SPEC_IN_SCOREBOARD

const int ENTCS_SPEC_IN_SCOREBOARD = 2

Definition at line 75 of file ent_cs.qh.

Referenced by entcs_GetSpecState(), and MUTATOR_HOOKFUNCTION().

ENTCS_SPEC_PURE

const int ENTCS_SPEC_PURE = 1

Definition at line 74 of file ent_cs.qh.

Referenced by entcs_GetSpecState(), entcs_GetTeam(), and Scoreboard_DrawItem().

frags

int frags

Definition at line 71 of file ent_cs.qh.

Referenced by dom_controlpoint_setup(), dompoint_captured(), dompointthink(), ENTCS_PROP(), fragsfilter_use(), PutObserverInServer(), PutPlayerInServer(), and spawnfunc().

handicap_level

int handicap_level

Definition at line 72 of file ent_cs.qh.

has_origin

bool has_origin

True when origin is available.

Definition at line 16 of file ent_cs.qh.

has_sv_origin

bool has_sv_origin

True when a recent server sent origin has been received.

Definition at line 19 of file ent_cs.qh.

m_entcs_private

bool m_entcs_private

True when private information such as origin is available.

Definition at line 13 of file ent_cs.qh.

m_forceupdate

int m_forceupdate

Definition at line 44 of file ent_cs.qh.

Referenced by _entcs_send(), and _wepent_send().

radar_showenemies

bool radar_showenemies

Definition at line 50 of file ent_cs.qh.

Referenced by _entcs_send(), nb_Initialize(), and race_Initialize().

sv_solid

int sv_solid

Definition at line 21 of file ent_cs.qh.

wants_join

int wants_join

Definition at line 73 of file ent_cs.qh.

Referenced by ClientConnect(), dropclient_schedule(), ENTCS_PROP(), HUD_InfoMessages(), Join(), joinAllowed(), ObserverOrSpectatorThink(), PlayerPreThink(), PutPlayerInServer(), Scoreboard_DrawItem(), and Scoreboard_DrawOthers().