handicap.qh File Reference

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

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

Go to the source code of this file.

Functions
float	Handicap_GetForcedHandicap (entity player)
	Returns the forced handicap of the player. More...
float	Handicap_GetTotalHandicap (entity player)
	Returns the total handicap of the player. More...
float	Handicap_GetVoluntaryHandicap (entity player)
	Returns the voluntary handicap of the player. More...
void	Handicap_Initialize (entity player)
	Initializes handicap to its default value. More...
void	Handicap_SetForcedHandicap (entity player, float value)
	Sets the forced handicap of the player. More...

Detailed Description

Header file that describes the handicap system.

Author

Lyberta

Copyright

GNU GPLv2 or any later version.

Definition in file handicap.qh.

Function Documentation

Handicap_GetForcedHandicap()

float Handicap_GetForcedHandicap

(

entity

player

)

Returns the forced handicap of the player.

Parameters

[in]

player

Player to check.

Returns

Forced handicap of the player.

Definition at line 23 of file handicap.qc.

References CS().

Referenced by Handicap_GetTotalHandicap().

{
    return (CS(player)) ? CS(player).m_handicap : 1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Handicap_GetTotalHandicap()

float Handicap_GetTotalHandicap

(

entity

player

)

Returns the total handicap of the player.

Parameters

[in]

player

Player to check.

Returns

Total handicap of the player.

Definition at line 37 of file handicap.qc.

References Handicap_GetForcedHandicap(), and Handicap_GetVoluntaryHandicap().

Referenced by PlayerDamage().

{
    return Handicap_GetForcedHandicap(player) * Handicap_GetVoluntaryHandicap(
        player);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Handicap_GetVoluntaryHandicap()

float Handicap_GetVoluntaryHandicap

(

entity

player

)

Returns the voluntary handicap of the player.

Parameters

[in]

player

Player to check.

Returns

Voluntary handicap of the player.

Definition at line 18 of file handicap.qc.

References bound(), and CS_CVAR.

Referenced by Handicap_GetTotalHandicap().

{
    return bound(1.0, CS_CVAR(player).cvar_cl_handicap, 10.0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

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 13 of file handicap.qc.

References CS().

Referenced by ClientConnect().

{
    CS(player).m_handicap = 1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Handicap_SetForcedHandicap()

void Handicap_SetForcedHandicap	(	entity	player,
		float	value
	)

Sets the forced handicap of the player.

Parameters

[in]	player	Player to alter.
[in]	value	Handicap value to set.

Returns

No return.

Definition at line 28 of file handicap.qc.

References CS(), and error().

Referenced by DynamicHandicap_UpdateHandicap().

{
    if (value <= 0)
    {
        error("Handicap_SetForcedHandicap: Invalid handicap value.");
    }
    CS(player).m_handicap = value;
}

Here is the call graph for this function:

Here is the caller graph for this function: