sv_resources.qc File Reference

Source file that contains implementation of the resource system. More...

#include "sv_resources.qh"
#include <common/resources/resources.qh>
#include <server/mutators/_mod.qh>
#include <server/world.qh>

Include dependency graph for sv_resources.qc:

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

Go to the source code of this file.

Functions
int	GetAmmoConsumption (entity wpn)
	Returns ammo consumed per shot by the primary/default fire mode.
float	GetResource (entity e, Resource res_type)
	Returns the current amount of resource the given entity has.
float	GetResourceLimit (entity e, Resource res_type)
	Returns the maximum amount of the given resource.
void	GiveResource (entity receiver, Resource res_type, float amount)
	Gives an entity some resource.
void	GiveResourceWithLimit (entity receiver, Resource res_type, float amount, float limit)
	Gives an entity some resource but not more than a limit.
void	SetResource (entity e, Resource res_type, float amount)
	Sets the current amount of resource the given entity will have.
bool	SetResourceExplicit (entity e, Resource res_type, float amount)
	Sets the resource amount of an entity without calling any hooks.
void	TakeResource (entity receiver, Resource res_type, float amount)
	Takes an entity some resource.
void	TakeResourceWithLimit (entity receiver, Resource res_type, float amount, float limit)
	Takes an entity some resource but not less than a limit.

Detailed Description

Source file that contains implementation of the resource system.

Author

Lyberta

Copyright

GNU GPLv2 or any later version.

Definition in file sv_resources.qc.

Function Documentation

GetAmmoConsumption()

int GetAmmoConsumption

(

entity

wpn

)

Returns ammo consumed per shot by the primary/default fire mode.

Parameters

[in]

wpn

Weapon entity

Returns

value is undefined if wpn entity isn't a weapon.

Definition at line 231 of file sv_resources.qc.

{
    if (wpn.ammo_type == RES_NONE) return 0;
    switch (wpn)
    {
        case WEP_ARC:        return WEP_CVAR(WEP_ARC,        beam_ammo);
        case WEP_DEVASTATOR: return WEP_CVAR(WEP_DEVASTATOR, ammo);
        case WEP_MACHINEGUN: return WEP_CVAR(WEP_MACHINEGUN, sustained_ammo);
        case WEP_MINE_LAYER: return WEP_CVAR(WEP_MINE_LAYER, ammo);
        case WEP_SEEKER:     return WEP_CVAR(WEP_SEEKER,     tag_ammo);
        default:             return WEP_CVAR_PRI(wpn, ammo);
    }
}

References ammo, entity(), WEP_CVAR, and WEP_CVAR_PRI.

Referenced by weapon_defaultspawnfunc().

GetResource()

float GetResource	(	entity	e,
		Resource	res_type )

Returns the current amount of resource the given entity has.

Parameters

[in]	e	Entity to check.
[in]	res_type	Type of the resource (a RES_* constant).

Returns

Current amount of resource the given entity has.

Definition at line 71 of file sv_resources.qc.

{
    return e.(GetResourceField(res_type));
}

References entity().

Referenced by GiveResource(), GiveResourceWithLimit(), TakeResource(), and TakeResourceWithLimit().

GetResourceLimit()

float GetResourceLimit	(	entity	e,
		Resource	res_type )

Returns the maximum amount of the given resource.

Parameters

[in]	e	Entity to check.
[in]	res_type	Type of the resource (a RES_* constant).

Returns

Maximum amount of the given resource.

Definition at line 12 of file sv_resources.qc.

{
    if(!IS_PLAYER(e))
        return RES_LIMIT_NONE; // no limits on non-players
 
    float limit;
    // TODO: registry handles
    switch (res_type)
    {
        case RES_HEALTH:
        {
            limit = autocvar_g_balance_health_limit;
            break;
        }
        case RES_ARMOR:
        {
            limit = autocvar_g_balance_armor_limit;
            break;
        }
        case RES_SHELLS:
        {
            limit = autocvar_g_pickup_shells_max;
            break;
        }
        case RES_BULLETS:
        {
            limit = autocvar_g_pickup_nails_max;
            break;
        }
        case RES_ROCKETS:
        {
            limit = autocvar_g_pickup_rockets_max;
            break;
        }
        case RES_CELLS:
        {
            limit = autocvar_g_pickup_cells_max;
            break;
        }
        case RES_FUEL:
        {
            limit = autocvar_g_balance_fuel_limit;
            break;
        }
        default:
        {
            error("GetResourceLimit: Invalid resource type.");
            return 0;
        }
    }
    MUTATOR_CALLHOOK(GetResourceLimit, e, res_type, limit);
    limit = M_ARGV(9, float);
    if (limit > RES_AMOUNT_HARD_LIMIT)
    {
        limit = RES_AMOUNT_HARD_LIMIT;
    }
    return limit;
}

References autocvar_g_balance_armor_limit, autocvar_g_balance_fuel_limit, autocvar_g_balance_health_limit, autocvar_g_pickup_cells_max, autocvar_g_pickup_nails_max, autocvar_g_pickup_rockets_max, autocvar_g_pickup_shells_max, entity(), error, GetResourceLimit(), IS_PLAYER, M_ARGV, MUTATOR_CALLHOOK, RES_AMOUNT_HARD_LIMIT, RES_ARMOR, and RES_LIMIT_NONE.

Referenced by ammo_pickupevalfunc(), GetResourceLimit(), MUTATOR_HOOKABLE(), RotRegen(), and SetResource().

GiveResource()

void GiveResource	(	entity	receiver,
		Resource	res_type,
		float	amount )

Gives an entity some resource.

Parameters

[in,out]	receiver	Entity to give resource to.
[in]	res_type	Type of the resource (a RES_* constant).
[in]	amount	Amount of resource to give.

Returns

No return.

Definition at line 115 of file sv_resources.qc.

{
    if (amount <= 0)
    {
        return;
    }
    bool forbid = MUTATOR_CALLHOOK(GiveResource, receiver, res_type, amount);
    if (forbid)
    {
        return;
    }
    res_type = M_ARGV(8, entity);
    amount = M_ARGV(9, float);
    if (amount <= 0)
    {
        return;
    }
    SetResource(receiver, res_type, GetResource(receiver, res_type) + amount);
    // TODO: registry handles
    switch (res_type)
    {
        case RES_HEALTH:
        {
            receiver.pauserothealth_finished =
                max(receiver.pauserothealth_finished, time +
                autocvar_g_balance_pause_health_rot);
            return;
        }
        case RES_ARMOR:
        {
            receiver.pauserotarmor_finished =
                max(receiver.pauserotarmor_finished, time +
                autocvar_g_balance_pause_armor_rot);
            return;
        }
        case RES_FUEL:
        {
            receiver.pauserotfuel_finished = max(receiver.pauserotfuel_finished,
                time + autocvar_g_balance_pause_fuel_rot);
            return;
        }
    }
}

References autocvar_g_balance_pause_armor_rot, autocvar_g_balance_pause_fuel_rot, autocvar_g_balance_pause_health_rot, entity(), GetResource(), GiveResource(), M_ARGV, max(), MUTATOR_CALLHOOK, RES_ARMOR, SetResource(), and time.

Referenced by GiveRandomWeapons(), GiveResource(), GiveResourceWithLimit(), Monster_Miniboss_Setup(), MUTATOR_HOOKABLE(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), NIX_GiveCurrentWeapon(), ons_ControlPoint_Icon_BuildThink(), and W_ThrowNewWeapon().

GiveResourceWithLimit()

void GiveResourceWithLimit	(	entity	receiver,
		Resource	res_type,
		float	amount,
		float	limit )

Gives an entity some resource but not more than a limit.

Parameters

[in,out]	receiver	Entity to give resource to.
[in]	res_type	Type of the resource (a RES_* constant).
[in]	amount	Amount of resource to give.
[in]	limit	Limit of resources to give.

Returns

No return.

Definition at line 159 of file sv_resources.qc.

{
    if (amount <= 0)
    {
        return;
    }
    bool forbid = MUTATOR_CALLHOOK(GiveResourceWithLimit, receiver, res_type, amount, limit);
    if (forbid)
    {
        return;
    }
    res_type = M_ARGV(8, entity);
    amount = M_ARGV(9, float);
    limit = M_ARGV(10, float);
    if (amount <= 0)
    {
        return;
    }
    float current_amount = GetResource(receiver, res_type);
    if (current_amount + amount > limit && limit != RES_LIMIT_NONE)
    {
        amount = limit - current_amount;
    }
    GiveResource(receiver, res_type, amount);
}

References entity(), GetResource(), GiveResource(), GiveResourceWithLimit(), M_ARGV, MUTATOR_CALLHOOK, and RES_LIMIT_NONE.

Referenced by bumblebee_pilot_frame(), destructible_heal(), GiveResourceWithLimit(), Item_GiveAmmoTo(), M_Mage_Defend_Heal(), Monster_Heal(), MUTATOR_HOOKABLE(), nade_heal_touch(), ons_ControlPoint_Icon_Heal(), ons_ControlPoint_Icon_Think(), ons_GeneratorHeal(), PlayerHeal(), turret_heal(), vehicles_heal(), and W_Arc_Beam_Think().

SetResource()

void SetResource	(	entity	e,
		Resource	res_type,
		float	amount )

Sets the current amount of resource the given entity will have.

Sets the current amount of resource the given entity will have but limited to the max amount allowed for the resource type.

Parameters

[in,out]	e	Entity to adjust.
[in]	res_type	Type of the resource (a RES_* constant).
[in]	amount	Amount of resource to set.

Returns

No return.

Definition at line 87 of file sv_resources.qc.

{
    bool forbid = MUTATOR_CALLHOOK(SetResource, e, res_type, amount);
    if (forbid)
    {
        return;
    }
    res_type = M_ARGV(8, entity);
    amount = M_ARGV(9, float);
    float max_amount = GetResourceLimit(e, res_type); // TODO: should allow overriding these limits if cheats are enabled!
    float amount_wasted = 0;
    if (amount > max_amount && max_amount != RES_LIMIT_NONE)
    {
        amount_wasted = amount - max_amount;
        amount = max_amount;
    }
    bool changed = SetResourceExplicit(e, res_type, amount);
    if (changed)
    {
        MUTATOR_CALLHOOK(ResourceAmountChanged, e, res_type, amount);
    }
    if (amount_wasted == 0)
    {
        return;
    }
    MUTATOR_CALLHOOK(ResourceWasted, e, res_type, amount_wasted);
}

References entity(), GetResourceLimit(), M_ARGV, MUTATOR_CALLHOOK, RES_LIMIT_NONE, SetResource(), and SetResourceExplicit().

Referenced by GiveResource(), and TakeResource().

SetResourceExplicit()

bool SetResourceExplicit	(	entity	e,
		Resource	res_type,
		float	amount )

Sets the resource amount of an entity without calling any hooks.

Parameters

[in,out]	e	Entity to adjust.
[in]	res_type	Type of the resource (a RES_* constant).
[in]	amount	Amount of resource to set.

Returns

Boolean for whether the ammo amount was changed

Definition at line 76 of file sv_resources.qc.

{
    .float res_field = GetResourceField(res_type);
    if (e.(res_field) != amount)
    {
        e.(res_field) = amount;
        return true;
    }
    return false;
}

References entity(), and GetResourceField().

Referenced by SetResource().

TakeResource()

void TakeResource	(	entity	receiver,
		Resource	res_type,
		float	amount )

Takes an entity some resource.

Parameters

[in,out]	receiver	Entity to take resource from.
[in]	res_type	Type of the resource (a RES_* constant).
[in]	amount	Amount of resource to take.

Returns

No return.

Definition at line 185 of file sv_resources.qc.

{
    if (amount <= 0)
    {
        return;
    }
    bool forbid = MUTATOR_CALLHOOK(TakeResource, receiver, res_type, amount);
    if (forbid)
    {
        return;
    }
    res_type = M_ARGV(8, entity);
    amount = M_ARGV(9, float);
    if (amount <= 0)
    {
        return;
    }
    SetResource(receiver, res_type, GetResource(receiver, res_type) - amount);
}

References entity(), GetResource(), M_ARGV, MUTATOR_CALLHOOK, SetResource(), and TakeResource().

Referenced by TakeResourceWithLimit().

TakeResourceWithLimit()

void TakeResourceWithLimit	(	entity	receiver,
		Resource	res_type,
		float	amount,
		float	limit )

Takes an entity some resource but not less than a limit.

Parameters

[in,out]	receiver	Entity to take resource from.
[in]	res_type	Type of the resource (a RES_* constant).
[in]	amount	Amount of resource to take.
[in]	limit	Limit of resources to take.

Returns

No return.

Definition at line 205 of file sv_resources.qc.

{
    if (amount <= 0)
    {
        return;
    }
    bool forbid = MUTATOR_CALLHOOK(TakeResourceWithLimit, receiver, res_type, amount, limit);
    if (forbid)
    {
        return;
    }
    res_type = M_ARGV(8, entity);
    amount = M_ARGV(9, float);
    limit = M_ARGV(10, float);
    if (amount <= 0)
    {
        return;
    }
    float current_amount = GetResource(receiver, res_type);
    if (current_amount - amount < -limit)
    {
        amount = -limit + current_amount;
    }
    TakeResource(receiver, res_type, amount);
}

References entity(), GetResource(), M_ARGV, MUTATOR_CALLHOOK, TakeResource(), and TakeResourceWithLimit().