sv_dynamic_handicap.qc File Reference

Source file that contains implementation of the Dynamic handicap mutator. More...

#include "sv_dynamic_handicap.qh"

Include dependency graph for sv_dynamic_handicap.qc:

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

Go to the source code of this file.

Functions
float	DynamicHandicap_ClampHandicap (float handicap)
	Clamps the value of the handicap.
void	DynamicHandicap_UpdateHandicap ()
	Updates the handicap of all players.
	MUTATOR_HOOKFUNCTION (dynamic_handicap, AddedPlayerScore)
	MUTATOR_HOOKFUNCTION (dynamic_handicap, BuildMutatorsPrettyString)
	MUTATOR_HOOKFUNCTION (dynamic_handicap, BuildMutatorsString)
	MUTATOR_HOOKFUNCTION (dynamic_handicap, ClientDisconnect)
	MUTATOR_HOOKFUNCTION (dynamic_handicap, MakePlayerObserver)
	MUTATOR_HOOKFUNCTION (dynamic_handicap, PutClientInServer)
	REGISTER_MUTATOR (dynamic_handicap, autocvar_g_dynamic_handicap &&!HANDICAP_DISABLED())

Variables
int	autocvar_g_dynamic_handicap
	Whether to enable dynamic handicap.
float	autocvar_g_dynamic_handicap_exponent
	The exponent used to calculate handicap.
float	autocvar_g_dynamic_handicap_max
	The maximum value of the handicap.
float	autocvar_g_dynamic_handicap_min
	The minimum value of the handicap.
float	autocvar_g_dynamic_handicap_scale
	The scale of the handicap.

Detailed Description

Source file that contains implementation of the Dynamic handicap mutator.

Author

Lyberta

Copyright

GNU GPLv2 or any later version.

Definition in file sv_dynamic_handicap.qc.

Function Documentation

DynamicHandicap_ClampHandicap()

float DynamicHandicap_ClampHandicap

(

float

handicap

)

Clamps the value of the handicap.

Parameters

[in]

handicap

Value to clamp.

Returns

Clamped value.

Definition at line 69 of file sv_dynamic_handicap.qc.

{
    if ((autocvar_g_dynamic_handicap_min >= 0) && (handicap <
        autocvar_g_dynamic_handicap_min))
    {
        handicap = autocvar_g_dynamic_handicap_min;
    }
    if ((autocvar_g_dynamic_handicap_max > 0) && (handicap >
        autocvar_g_dynamic_handicap_max))
    {
        handicap = autocvar_g_dynamic_handicap_max;
    }
    return handicap;
}

References autocvar_g_dynamic_handicap_max, and autocvar_g_dynamic_handicap_min.

Referenced by DynamicHandicap_UpdateHandicap().

DynamicHandicap_UpdateHandicap()

void DynamicHandicap_UpdateHandicap

(

)

Updates the handicap of all players.

Returns

No return.

Definition at line 32 of file sv_dynamic_handicap.qc.

{
    float total_score = 0;
    float totalplayers = 0;
    FOREACH_CLIENT(IS_PLAYER(it),
    {
        total_score += PlayerScore_Get(it, SP_SCORE);
        ++totalplayers;
    });
    if (totalplayers == 0)
        return;
 
    float mean_score = total_score / totalplayers;
    FOREACH_CLIENT(true,
    {
        float score = PlayerScore_Get(it, SP_SCORE);
        float handicap = fabs((score - mean_score) *
            autocvar_g_dynamic_handicap_scale);
        handicap = handicap ** autocvar_g_dynamic_handicap_exponent;
        if (score < mean_score)
        {
            handicap = -handicap;
        }
        if (handicap >= 0)
        {
            handicap += 1;
        }
        else
        {
            handicap = 1 / (fabs(handicap) + 1);
        }
        handicap = DynamicHandicap_ClampHandicap(handicap);
        Handicap_SetForcedHandicap(it, handicap, false);
        Handicap_SetForcedHandicap(it, handicap, true);
    });
}

References autocvar_g_dynamic_handicap_exponent, autocvar_g_dynamic_handicap_scale, DynamicHandicap_ClampHandicap(), fabs(), FOREACH_CLIENT, Handicap_SetForcedHandicap(), IS_PLAYER, and PlayerScore_Get.

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

MUTATOR_HOOKFUNCTION() [1/6]

MUTATOR_HOOKFUNCTION	(	dynamic_handicap	,
		AddedPlayerScore	)

Definition at line 113 of file sv_dynamic_handicap.qc.

{
    if (M_ARGV(0, entity) != SP_SCORE)
    {
        return;
    }
    DynamicHandicap_UpdateHandicap();
}

References DynamicHandicap_UpdateHandicap(), entity(), and M_ARGV.

MUTATOR_HOOKFUNCTION() [2/6]

MUTATOR_HOOKFUNCTION	(	dynamic_handicap	,
		BuildMutatorsPrettyString	)

Definition at line 93 of file sv_dynamic_handicap.qc.

{
    M_ARGV(0, string) = strcat(M_ARGV(0, string), ", Dynamic handicap");
}

References M_ARGV, and strcat().

MUTATOR_HOOKFUNCTION() [3/6]

MUTATOR_HOOKFUNCTION	(	dynamic_handicap	,
		BuildMutatorsString	)

Definition at line 88 of file sv_dynamic_handicap.qc.

{
    M_ARGV(0, string) = strcat(M_ARGV(0, string), ":handicap");
}

References M_ARGV, and strcat().

MUTATOR_HOOKFUNCTION() [4/6]

MUTATOR_HOOKFUNCTION	(	dynamic_handicap	,
		ClientDisconnect	)

Definition at line 98 of file sv_dynamic_handicap.qc.

{
    DynamicHandicap_UpdateHandicap();
}

References ClientDisconnect, and DynamicHandicap_UpdateHandicap().

MUTATOR_HOOKFUNCTION() [5/6]

MUTATOR_HOOKFUNCTION	(	dynamic_handicap	,
		MakePlayerObserver	)

Definition at line 108 of file sv_dynamic_handicap.qc.

{
    DynamicHandicap_UpdateHandicap();
}

References DynamicHandicap_UpdateHandicap().

MUTATOR_HOOKFUNCTION() [6/6]

MUTATOR_HOOKFUNCTION	(	dynamic_handicap	,
		PutClientInServer	)

Definition at line 103 of file sv_dynamic_handicap.qc.

{
    DynamicHandicap_UpdateHandicap();
}

References DynamicHandicap_UpdateHandicap(), and PutClientInServer.

REGISTER_MUTATOR()

REGISTER_MUTATOR	(	dynamic_handicap	,
		autocvar_g_dynamic_handicap &&!	HANDICAP_DISABLED() )

References autocvar_g_dynamic_handicap.

Variable Documentation

autocvar_g_dynamic_handicap

int autocvar_g_dynamic_handicap

Whether to enable dynamic handicap.

Definition at line 10 of file sv_dynamic_handicap.qc.

Referenced by REGISTER_MUTATOR().

autocvar_g_dynamic_handicap_exponent

float autocvar_g_dynamic_handicap_exponent

The exponent used to calculate handicap.

1 means linear scale. Values more than 1 mean stronger non-linear handicap. Values less than 1 mean weaker non-linear handicap.

Definition at line 17 of file sv_dynamic_handicap.qc.

Referenced by DynamicHandicap_UpdateHandicap().

autocvar_g_dynamic_handicap_max

float autocvar_g_dynamic_handicap_max

The maximum value of the handicap.

Definition at line 19 of file sv_dynamic_handicap.qc.

Referenced by DynamicHandicap_ClampHandicap().

autocvar_g_dynamic_handicap_min

float autocvar_g_dynamic_handicap_min

The minimum value of the handicap.

Definition at line 18 of file sv_dynamic_handicap.qc.

Referenced by DynamicHandicap_ClampHandicap().

autocvar_g_dynamic_handicap_scale

float autocvar_g_dynamic_handicap_scale

The scale of the handicap.

Larger values mean more penalties for strong players and more buffs for weak players.

Definition at line 13 of file sv_dynamic_handicap.qc.

Referenced by DynamicHandicap_UpdateHandicap().