Header file that describes the handicap system. More...

#include <common/mapinfo.qh>
#include <common/gametypes/gametype/cts/cts.qh>
#include <common/gametypes/gametype/race/race.qh>

Include dependency graph for handicap.qh:

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

Go to the source code of this file.

Macros
#define	HANDICAP_DISABLED()
#define	HANDICAP_MAX_LEVEL_EQUIVALENT 2.0

Functions
float	Handicap_GetForcedHandicap (entity player, bool receiving)
	Returns the forced handicap of the player.
float	Handicap_GetTotalHandicap (entity player, bool receiving)
	Returns the total handicap of the player.
float	Handicap_GetVoluntaryHandicap (entity player, bool receiving)
	Returns the voluntary handicap of the player.
void	Handicap_Initialize (entity player)
	Initializes handicap to its default value.
void	Handicap_SetForcedHandicap (entity player, float value, bool receiving)
	Sets the forced handicap of the player.
void	Handicap_UpdateHandicapLevel (entity player)
	Updates .handicap_level for the player.

Variables
float	handicap_avg_given_sum
float	handicap_avg_taken_sum
int	handicap_level

Detailed Description

Header file that describes the handicap system.

Author: Lyberta

Copyright: GNU GPLv2 or any later version.

Definition in file handicap.qh.

Macro Definition Documentation

◆ HANDICAP_DISABLED

#define HANDICAP_DISABLED ( )

Value:

(IS_GAMETYPE(CTS) || IS_GAMETYPE(RACE))

Definition at line 57 of file handicap.qh.

57#define HANDICAP_DISABLED() \

58 (IS_GAMETYPE(CTS) || IS_GAMETYPE(RACE))

Referenced by Handicap_GetForcedHandicap(), Handicap_GetTotalHandicap(), Handicap_GetVoluntaryHandicap(), Handicap_SetForcedHandicap(), and Handicap_UpdateHandicapLevel().

◆ HANDICAP_MAX_LEVEL_EQUIVALENT

#define HANDICAP_MAX_LEVEL_EQUIVALENT 2.0

Definition at line 66 of file handicap.qh.

Referenced by Handicap_UpdateHandicapLevel().

Function Documentation

◆ Handicap_GetForcedHandicap()

float Handicap_GetForcedHandicap	(	entity	player,
		bool	receiving )

Returns the forced handicap of the player.

Parameters

[in]	player	Player to check.
[in]	receiving	Whether handicap is for receiving or dealing.

Returns: Forced handicap of the player.

Definition at line 71 of file handicap.qc.

{
    if (HANDICAP_DISABLED())
        return 1;
    if (receiving)
        return (CS(player)) ? CS(player).m_handicap_take : 1;
    else
        return (CS(player)) ? CS(player).m_handicap_give : 1;
}

References CS(), entity(), and HANDICAP_DISABLED.

Referenced by Handicap_GetTotalHandicap().

◆ Handicap_GetTotalHandicap()

float Handicap_GetTotalHandicap	(	entity	player,
		bool	receiving )

Returns the total handicap of the player.

Parameters

[in]	player	Player to check.
[in]	receiving	Whether handicap is for receiving or dealing.

Returns: Total handicap of the player.

Definition at line 96 of file handicap.qc.

{
    if (HANDICAP_DISABLED())
        return 1;
    return Handicap_GetForcedHandicap(player, receiving) *
        Handicap_GetVoluntaryHandicap(player, receiving);
}

References entity(), HANDICAP_DISABLED, Handicap_GetForcedHandicap(), and Handicap_GetVoluntaryHandicap().

Referenced by Handicap_UpdateHandicapLevel(), PlayerDamage(), and PlayerFrame().

◆ Handicap_GetVoluntaryHandicap()

float Handicap_GetVoluntaryHandicap	(	entity	player,
		bool	receiving )

Returns the voluntary handicap of the player.

Parameters

[in]	player	Player to check.
[in]	receiving	Whether handicap is for receiving or dealing.

Returns: Voluntary handicap of the player.

Definition at line 25 of file handicap.qc.

{
    if (HANDICAP_DISABLED())
        return 1;
#if 0
    if (receiving)
        return bound(1.0, CS_CVAR(player).cvar_cl_handicap_damage_taken, 10.0);
    else
        return bound(1.0, CS_CVAR(player).cvar_cl_handicap_damage_given, 10.0);
#else
    // TODO: remove the else vector branch after 0.9 release
    // Forwards compatibility for old clients on new servers. `cl_handicap 2`
    // ( '2 0 0' ) is treated the same as `cl_handicap_damage_{given,taken} 2`.
    // The x is give and y is take.
    // '2 0 0' gives and takes x2
    // '2 2 0' gives and takes x2
    // '2 1 0' only gives x2
    // '1 2 0' only takes x2
    // z is wasted
 
    int handicap_value;
 
    // First read if the new cvars have a valid value,
    // if they don't then read old cvar, checking if the old cvar has
    // separate give and take values or we should use the first value for both
    if (receiving)
    {
        if (CS_CVAR(player).cvar_cl_handicap_damage_taken > 1)
            handicap_value = CS_CVAR(player).cvar_cl_handicap_damage_taken;
        else if (CS_CVAR(player).cvar_cl_handicap.y > 0)
            handicap_value = CS_CVAR(player).cvar_cl_handicap.y;
        else
            handicap_value = CS_CVAR(player).cvar_cl_handicap.x;
    }
    else
    {
        if (CS_CVAR(player).cvar_cl_handicap_damage_given > 1)
            handicap_value = CS_CVAR(player).cvar_cl_handicap_damage_given;
        else
            handicap_value = CS_CVAR(player).cvar_cl_handicap.x;
    }
 
    return bound(1.0, handicap_value, 10.0);
#endif
}

References bound(), CS_CVAR, entity(), and HANDICAP_DISABLED.

Referenced by Handicap_GetTotalHandicap().

◆ Handicap_Initialize()

void Handicap_Initialize ( entity player )

Initializes handicap to its default value.

Parameters

[in,out] player Player to initialize.

Returns: No return.

Definition at line 16 of file handicap.qc.

{
    // forced handicap defaults
    CS(player).m_handicap_give = 1;
    CS(player).m_handicap_take = 1;
 
    Handicap_UpdateHandicapLevel(player);
}

References CS(), entity(), and Handicap_UpdateHandicapLevel().

Referenced by ClientConnect().

◆ Handicap_SetForcedHandicap()

void Handicap_SetForcedHandicap	(	entity	player,
		float	value,
		bool	receiving )

Sets the forced handicap of the player.

Parameters

[in]	player	Player to alter.
[in]	value	Handicap value to set.
[in]	receiving	Whether handicap is for receiving or dealing.

Returns: No return.

Definition at line 81 of file handicap.qc.

{
    if (HANDICAP_DISABLED())
        return;
    if (value <= 0)
        error("Handicap_SetForcedHandicap: Invalid handicap value.");
 
    if (receiving)
        CS(player).m_handicap_take = value;
    else
        CS(player).m_handicap_give = value;
 
    Handicap_UpdateHandicapLevel(player);
}

References CS(), entity(), error, HANDICAP_DISABLED, and Handicap_UpdateHandicapLevel().

Referenced by DynamicHandicap_UpdateHandicap().

◆ Handicap_UpdateHandicapLevel()

void Handicap_UpdateHandicapLevel ( entity player )

Updates .handicap_level for the player.

Parameters

[in] player Player to check.

Definition at line 104 of file handicap.qc.

{
    if (HANDICAP_DISABLED())
    {
        player.handicap_level = 0;
        return;
    }
 
    float handicap_total = (Handicap_GetTotalHandicap(player, true) +
        Handicap_GetTotalHandicap(player, false)) / 2;
    player.handicap_level = floor(map_bound_ranges(handicap_total, 1, HANDICAP_MAX_LEVEL_EQUIVALENT, 0, 16));
}

References entity(), floor(), HANDICAP_DISABLED, Handicap_GetTotalHandicap(), HANDICAP_MAX_LEVEL_EQUIVALENT, and map_bound_ranges().

Referenced by Handicap_Initialize(), Handicap_SetForcedHandicap(), REPLICATE_APPLYCHANGE(), and REPLICATE_APPLYCHANGE().

Variable Documentation

◆ handicap_avg_given_sum

float handicap_avg_given_sum

Definition at line 71 of file handicap.qh.

Referenced by PlayerFrame().

◆ handicap_avg_taken_sum

float handicap_avg_taken_sum

Definition at line 72 of file handicap.qh.

Referenced by PlayerFrame().

◆ handicap_level

int handicap_level

Definition at line 64 of file handicap.qh.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ HANDICAP_DISABLED

◆ HANDICAP_MAX_LEVEL_EQUIVALENT

Function Documentation

◆ Handicap_GetForcedHandicap()

◆ Handicap_GetTotalHandicap()

◆ Handicap_GetVoluntaryHandicap()

◆ Handicap_Initialize()

◆ Handicap_SetForcedHandicap()

◆ Handicap_UpdateHandicapLevel()

Variable Documentation

◆ handicap_avg_given_sum

◆ handicap_avg_taken_sum

◆ handicap_level