cl_resources.qh File Reference

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

#include <common/resources/resources.qh>

Include dependency graph for cl_resources.qh:

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

Go to the source code of this file.

Functions
float	GetResource (entity e, Resource res_type)
	Returns the current amount of resource the given entity has.
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

Header file that describes the resource system.

Copyright

GNU GPLv2 or any later version.

Definition in file cl_resources.qh.

Function Documentation

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 10 of file cl_resources.qc.

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

SetResource()

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

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

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 26 of file cl_resources.qc.

{
    SetResourceExplicit(e, res_type, amount);
}

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 15 of file cl_resources.qc.

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

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 31 of file cl_resources.qc.

{
    if (amount == 0)
    {
        return;
    }
    SetResource(receiver, res_type, GetResource(receiver, res_type) - amount);
}

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 40 of file cl_resources.qc.

{
    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);
}