#include <server/spawnpoints.qh>
#include <server/scores.qh>
#include <server/scores_rules.qh>

Include dependency graph for sv_rules.qh:

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

Macros
#define	_GameRules_scoring_begin(teams, spprio, stprio)
#define	_GameRules_scoring_end ScoreRules_basics_end
#define	_GameRules_scoring_field ScoreInfo_SetLabel_PlayerScore
#define	_GameRules_scoring_field_team ScoreInfo_SetLabel_TeamScore
#define	GameRules_score_enabled(value)
#define	GameRules_scoring(teams, spprio, stprio, fields)
#define	GameRules_scoring_add(client, fld, value)
#define	GameRules_scoring_add_float2int(client, fld, value, float_field, score_factor)
#define	GameRules_scoring_add_team(client, fld, value)
#define	GameRules_scoring_add_team_float2int(client, fld, value, float_field, score_factor)
#define	GameRules_scoring_is_vip(player)
#define	GameRules_scoring_vip(player, value)
#define	GameRules_spawning_teams(value)
	Used to disable team spawns in team modes.
#define	INGAME(it)
#define	INGAME_JOINED(it)
#define	INGAME_JOINING(it)
#define	INGAME_STATUS_CLEAR(it)
#define	INGAME_STATUS_JOINED 1
#define	INGAME_STATUS_JOINING 0.5
#define	INGAME_STATUS_NONE 0
#define	INGAME_STATUS_SET(it, s)

Functions
float	_GameRules_scoring_add_float2int (entity client, entity sp, int st, float value,.float float_field, float score_factor, bool team)
	Accumulates the decimal part of the score to player.
void	GameRules_limit_fallbacks ()
	Set any unspecified rules to their defaults.
void	GameRules_limit_lead (int limit)
void	GameRules_limit_score (int limit)
void	GameRules_limit_time (int limit)
void	GameRules_limit_time_qualifying (int limit)
void	GameRules_teams (bool value)

Variables
bool	_GameRules_score_enabled = true
	Disabling score disables the "score" column on the scoreboard.
int	autocvar_leadlimit_and_fraglimit
int	autocvar_leadlimit_override
int	ingame
bool	m_GameRules_scoring_vip
	Mark a player as being 'important' (flag carrier, ball carrier, etc)
int	total_players

Macro Definition Documentation

◆ _GameRules_scoring_begin

#define _GameRules_scoring_begin	(	teams,
		spprio,
		stprio )

Value:

ScoreRules_basics(teams, spprio, stprio, _GameRules_score_enabled)

teams

entity teams

Definition main.qh:58

ScoreRules_basics

void ScoreRules_basics(int teams, float sprio, float stprio, float score_enabled)

Definition scores_rules.qc:25

_GameRules_score_enabled

bool _GameRules_score_enabled

Disabling score disables the "score" column on the scoreboard.

Definition sv_rules.qh:40

Definition at line 67 of file sv_rules.qh.

◆ _GameRules_scoring_end

#define _GameRules_scoring_end ScoreRules_basics_end

Definition at line 70 of file sv_rules.qh.

◆ _GameRules_scoring_field

#define _GameRules_scoring_field ScoreInfo_SetLabel_PlayerScore

Definition at line 68 of file sv_rules.qh.

◆ _GameRules_scoring_field_team

#define _GameRules_scoring_field_team ScoreInfo_SetLabel_TeamScore

Definition at line 69 of file sv_rules.qh.

◆ GameRules_score_enabled

#define GameRules_score_enabled ( value )

Value:

_GameRules_score_enabled = (value)

Definition at line 41 of file sv_rules.qh.

Referenced by cts_ScoreRules(), invasion_ScoreRules(), race_ScoreRules(), and REGISTER_MUTATOR().

◆ GameRules_scoring

#define GameRules_scoring	(	teams,
		spprio,
		stprio,
		fields )

Value:

    MACRO_BEGIN \
    _GameRules_scoring_begin((teams), (spprio), (stprio)); \
    noref void(entity, string, float) field = _GameRules_scoring_field; \
    /* todo: just have the one `field` function */ \
    noref void(int, string, float) field_team = _GameRules_scoring_field_team; \
    LAMBDA(fields); \
    _GameRules_scoring_end(); \
MACRO_END

Parameters

teams	a bitmask of active teams
spprio	player score priority (if frags aren't enabled)
stprio	team score priority (if frags aren't enabled)

Definition at line 58 of file sv_rules.qh.

#define GameRules_scoring(teams, spprio, stprio, fields) MACRO_BEGIN \
    _GameRules_scoring_begin((teams), (spprio), (stprio)); \
    noref void(entity, string, float) field = _GameRules_scoring_field; \
    /* todo: just have the one `field` function */ \
    noref void(int, string, float) field_team = _GameRules_scoring_field_team; \
    LAMBDA(fields); \
    _GameRules_scoring_end(); \
MACRO_END

Referenced by ctf_ScoreRules(), cts_ScoreRules(), freezetag_Initialize(), invasion_ScoreRules(), kh_ScoreRules(), nb_ScoreRules(), ons_ScoreRules(), race_ScoreRules(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), ScoreRules_dom(), ScoreRules_generic(), and surv_Initialize().

◆ GameRules_scoring_add

#define GameRules_scoring_add	(	client,
		fld,
		value )

Value:

PlayerScore_Add(client, SP_##fld, value)

PlayerScore_Add

float PlayerScore_Add(entity player, PlayerScoreField scorefield, float score)

Adds a score to the player's scores.

Definition scores.qc:352

Definition at line 85 of file sv_rules.qh.

◆ GameRules_scoring_add_float2int

#define GameRules_scoring_add_float2int	(	client,
		fld,
		value,
		float_field,
		score_factor )

Value:

_GameRules_scoring_add_float2int(client, SP_##fld, 0, value, float_field, score_factor, false)

_GameRules_scoring_add_float2int

float _GameRules_scoring_add_float2int(entity client, entity sp, int st, float value,.float decimal_field, float score_factor, bool team)

Accumulates the decimal part of the score to player.

Definition sv_rules.qc:73

Definition at line 83 of file sv_rules.qh.

83#define GameRules_scoring_add_float2int(client, fld, value, float_field, score_factor) \

84 _GameRules_scoring_add_float2int(client, SP_##fld, 0, value, float_field, score_factor, false)

Referenced by ka_BallThink_Carried(), and MUTATOR_HOOKFUNCTION().

◆ GameRules_scoring_add_team

#define GameRules_scoring_add_team	(	client,
		fld,
		value )

Value:

PlayerTeamScore_Add(client, SP_##fld, ST_##fld, value)

PlayerTeamScore_Add

float PlayerTeamScore_Add(entity player, PlayerScoreField pscorefield, float tscorefield, float score)

Adds a score to both the player and the team.

Definition scores.qc:406

Definition at line 89 of file sv_rules.qh.

Referenced by assault_objective_decrease_use(), ctf_Handle_Capture(), ctf_Handle_Drop(), ctf_Handle_Pickup(), ctf_Handle_Return(), GiveFrags(), kh_WinnerTeam(), MayhemCalculatePlayerScore(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), ons_ControlPoint_Icon_BuildThink(), and race_SendTime().

◆ GameRules_scoring_add_team_float2int

#define GameRules_scoring_add_team_float2int	(	client,
		fld,
		value,
		float_field,
		score_factor )

Value:

_GameRules_scoring_add_float2int(client, SP_##fld, ST_##fld, value, float_field, score_factor, true)

Definition at line 87 of file sv_rules.qh.

87#define GameRules_scoring_add_team_float2int(client, fld, value, float_field, score_factor) \

88 _GameRules_scoring_add_float2int(client, SP_##fld, ST_##fld, value, float_field, score_factor, true)

Referenced by kh_Scores_Event(), and tka_BallThink_Carried().

◆ GameRules_scoring_is_vip

#define GameRules_scoring_is_vip ( player )

Value:

(player).m_GameRules_scoring_vip

m_GameRules_scoring_vip

bool m_GameRules_scoring_vip

Mark a player as being 'important' (flag carrier, ball carrier, etc)

Definition sv_rules.qh:77

Definition at line 79 of file sv_rules.qh.

Referenced by MUTATOR_HOOKFUNCTION(), and MUTATOR_HOOKFUNCTION().

◆ GameRules_scoring_vip

#define GameRules_scoring_vip	(		player,
			value )

Value:

(player).m_GameRules_scoring_vip = (value)

Definition at line 78 of file sv_rules.qh.

Referenced by ctf_Handle_Pickup(), ctf_Handle_Retrieve(), ctf_Handle_Throw(), ctf_RespawnFlag(), DropBall(), GiveBall(), ka_PlayerReset(), ka_TouchEvent(), tka_PlayerReset(), and tka_TouchEvent().

◆ GameRules_spawning_teams

#define GameRules_spawning_teams ( value )

Value:

have_team_spawns = (value) ? -1 : 0

have_team_spawns

int have_team_spawns

Definition spawnpoints.qh:16

Used to disable team spawns in team modes.

Definition at line 35 of file sv_rules.qh.

Referenced by GameRules_teams(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), tdm_Initialize(), and tmayhem_Initialize().

◆ INGAME

#define INGAME ( it )

◆ INGAME_JOINED

#define INGAME_JOINED ( it )

Value:

((it).ingame == INGAME_STATUS_JOINED)

INGAME_STATUS_JOINED

#define INGAME_STATUS_JOINED

Definition sv_rules.qh:17

Definition at line 25 of file sv_rules.qh.

Referenced by ca_isEliminated(), ClientCommand_ready(), DumpStats(), MatchEnd_RestoreSpectatorAndTeamStatus(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), ReadyCount(), surv_isEliminated(), and WinningConditionHelper().

◆ INGAME_JOINING

#define INGAME_JOINING ( it )

Value:

((it).ingame == INGAME_STATUS_JOINING)

INGAME_STATUS_JOINING

#define INGAME_STATUS_JOINING

Definition sv_rules.qh:16

Definition at line 26 of file sv_rules.qh.

Referenced by ca_isEliminated(), MatchEnd_RestoreSpectatorAndTeamStatus(), MUTATOR_HOOKFUNCTION(), and surv_isEliminated().

◆ INGAME_STATUS_CLEAR

#define INGAME_STATUS_CLEAR ( it )

Value:

INGAME_STATUS_SET(it, INGAME_STATUS_NONE)

INGAME_STATUS_NONE

#define INGAME_STATUS_NONE

Definition sv_rules.qh:15

INGAME_STATUS_SET

#define INGAME_STATUS_SET(it, s)

Definition sv_rules.qh:21

Definition at line 22 of file sv_rules.qh.

Referenced by lms_RemovePlayer(), MatchEnd_RestoreSpectatorAndTeamStatus(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), and MUTATOR_HOOKFUNCTION().

◆ INGAME_STATUS_JOINED

#define INGAME_STATUS_JOINED 1

Definition at line 17 of file sv_rules.qh.

Referenced by lms_AddPlayer(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), and MUTATOR_HOOKFUNCTION().

◆ INGAME_STATUS_JOINING

#define INGAME_STATUS_JOINING 0.5

Definition at line 16 of file sv_rules.qh.

Referenced by lms_AddPlayer(), MUTATOR_HOOKFUNCTION(), and MUTATOR_HOOKFUNCTION().

◆ INGAME_STATUS_NONE

#define INGAME_STATUS_NONE 0

Definition at line 15 of file sv_rules.qh.

◆ INGAME_STATUS_SET

#define INGAME_STATUS_SET	(		it,
			s )

Value:

(it).ingame = s

ingame

int ingame

Definition sv_rules.qh:14

Definition at line 21 of file sv_rules.qh.

Referenced by lms_AddPlayer(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), and MUTATOR_HOOKFUNCTION().

Function Documentation

◆ _GameRules_scoring_add_float2int()

float _GameRules_scoring_add_float2int	(	entity	client,
		entity	sp,
		int	st,
		float	value,
		.float	decimal_field,
		float	score_factor,
		bool	team )

Accumulates the decimal part of the score to player.

(decimal_field) and adds the score to the player as int only when at least one unit of score has been accumulated. It works with negative score too Float scores can't be used as score because they aren't supported by the QC score networking system and online server browsers (e.g. qstat)

Definition at line 73 of file sv_rules.qc.

{
    client.(decimal_field) += value;
    float score_counter = client.(decimal_field) / score_factor;
    if (score_counter >= -0.5 && score_counter < 0.5)
        return 0;
 
    // NOTE: this code works for subtracting score too
    int points = floor(score_counter + 0.5);
    if (!points)
        return 0;
    client.(decimal_field) -= points * score_factor;
    return team ? PlayerTeamScore_Add(client, sp, st, points) : PlayerScore_Add(client, sp, points);
}

References entity(), floor(), PlayerScore_Add(), PlayerTeamScore_Add(), and team.

◆ GameRules_limit_fallbacks()

void GameRules_limit_fallbacks ( )

Set any unspecified rules to their defaults.

Definition at line 62 of file sv_rules.qc.

{
    GameRules_limit_score(autocvar_fraglimit_override);
    GameRules_limit_lead(autocvar_leadlimit_override);
    GameRules_limit_time(autocvar_timelimit_override);
}

References autocvar_fraglimit_override, autocvar_leadlimit_override, autocvar_timelimit_override, GameRules_limit_lead(), GameRules_limit_score(), and GameRules_limit_time().

Referenced by spawnfunc().

◆ GameRules_limit_lead()

void GameRules_limit_lead ( int limit )

Definition at line 33 of file sv_rules.qc.

{
    if (GameRules_limit_lead_initialized) return;
    if (autocvar_g_campaign) return;
    if (limit < 0) return;
    cvar_set("leadlimit", ftos(limit));
    GameRules_limit_lead_initialized = true;
}

References autocvar_g_campaign, cvar_set(), ftos(), and GameRules_limit_lead_initialized.

Referenced by GameRules_limit_fallbacks(), mayhem_Initialize(), nb_Initialize(), rc_SetLimits(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), tdm_Initialize(), and tmayhem_Initialize().

◆ GameRules_limit_score()

void GameRules_limit_score ( int limit )

Definition at line 23 of file sv_rules.qc.

{
    if (GameRules_limit_score_initialized) return;
    if (autocvar_g_campaign) return;
    if (limit < 0) return;
    cvar_set("fraglimit", ftos(limit));
    GameRules_limit_score_initialized = true;
}

References autocvar_g_campaign, cvar_set(), ftos(), and GameRules_limit_score_initialized.

Referenced by GameRules_limit_fallbacks(), mayhem_Initialize(), nb_Initialize(), rc_SetLimits(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), tdm_Initialize(), and tmayhem_Initialize().

◆ GameRules_limit_time()

void GameRules_limit_time ( int limit )

Definition at line 43 of file sv_rules.qc.

{
    if (GameRules_limit_time_initialized) return;
    if (autocvar_g_campaign) return;
    if (limit < 0) return;
    cvar_set("timelimit", ftos(limit));
    GameRules_limit_time_initialized = true;
}

References autocvar_g_campaign, cvar_set(), ftos(), and GameRules_limit_time_initialized.

Referenced by GameRules_limit_fallbacks(), and rc_SetLimits().

◆ GameRules_limit_time_qualifying()

void GameRules_limit_time_qualifying ( int limit )

Definition at line 53 of file sv_rules.qc.

{
    if (GameRules_limit_time_qualifying_initialized) return;
    if (autocvar_g_campaign) return;
    if (limit < 0) return;
    cvar_set("g_race_qualifying_timelimit", ftos(limit));
    GameRules_limit_time_qualifying_initialized = true;
}

References autocvar_g_campaign, cvar_set(), ftos(), and GameRules_limit_time_qualifying_initialized.

Referenced by rc_SetLimits().

◆ GameRules_teams()

void GameRules_teams ( bool value )

Definition at line 3 of file sv_rules.qc.

{
    if (value)
    {
        serverflags |= SERVERFLAG_TEAMPLAY;
        teamplay = 1;  // aka AVAILABLE_TEAMS, updated by ScoreRules_basics() after team ents spawn
        cvar_set("teamplay", "2");  // DP needs this for sending proper getstatus replies.
        Team_InitTeams();
        GameRules_spawning_teams(true);
    }
    else
    {
        serverflags &= ~SERVERFLAG_TEAMPLAY;
        teamplay = 0;
        cvar_set("teamplay", "0");  // DP needs this for sending proper getstatus replies.
        GameRules_spawning_teams(false);
    }
}

References cvar_set(), GameRules_spawning_teams, SERVERFLAG_TEAMPLAY, serverflags, Team_InitTeams(), and teamplay.

Referenced by InitGameplayMode(), nb_Initialize(), rc_SetLimits(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), tdm_Initialize(), and tmayhem_Initialize().

Variable Documentation

◆ _GameRules_score_enabled

bool _GameRules_score_enabled = true

Disabling score disables the "score" column on the scoreboard.

Definition at line 40 of file sv_rules.qh.

◆ autocvar_leadlimit_and_fraglimit

int autocvar_leadlimit_and_fraglimit

Definition at line 8 of file sv_rules.qh.

Referenced by WinningCondition_Scores().

◆ autocvar_leadlimit_override

int autocvar_leadlimit_override

Definition at line 9 of file sv_rules.qh.

Referenced by GameRules_limit_fallbacks().

◆ ingame

int ingame

Definition at line 14 of file sv_rules.qh.

◆ m_GameRules_scoring_vip

bool m_GameRules_scoring_vip

Mark a player as being 'important' (flag carrier, ball carrier, etc)

Parameters

player	the entity to mark
value	VIP status

Definition at line 77 of file sv_rules.qh.

◆ total_players

int total_players

Definition at line 12 of file sv_rules.qh.

Referenced by CA_CheckTeams(), CA_count_alive_players(), freezetag_CheckTeams(), freezetag_count_alive_players(), and ReadyCount().

Macros

Functions

Variables

Macro Definition Documentation

◆ _GameRules_scoring_begin

◆ _GameRules_scoring_end

◆ _GameRules_scoring_field

◆ _GameRules_scoring_field_team

◆ GameRules_score_enabled

◆ GameRules_scoring

◆ GameRules_scoring_add

◆ GameRules_scoring_add_float2int

◆ GameRules_scoring_add_team

◆ GameRules_scoring_add_team_float2int

◆ GameRules_scoring_is_vip

◆ GameRules_scoring_vip

◆ GameRules_spawning_teams

◆ INGAME

◆ INGAME_JOINED

◆ INGAME_JOINING

◆ INGAME_STATUS_CLEAR

◆ INGAME_STATUS_JOINED

◆ INGAME_STATUS_JOINING

◆ INGAME_STATUS_NONE

◆ INGAME_STATUS_SET

Function Documentation

◆ _GameRules_scoring_add_float2int()

◆ GameRules_limit_fallbacks()

◆ GameRules_limit_lead()

◆ GameRules_limit_score()

◆ GameRules_limit_time()

◆ GameRules_limit_time_qualifying()

◆ GameRules_teams()

Variable Documentation

◆ _GameRules_score_enabled

◆ autocvar_leadlimit_and_fraglimit

◆ autocvar_leadlimit_override

◆ ingame

◆ m_GameRules_scoring_vip

◆ total_players