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

#include "cl_resources.qh"
#include <common/items/item/ammo.qh>
#include <common/resources/resources.qh>

Include dependency graph for cl_resources.qc:

This graph shows which files directly or indirectly include 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

Source file that contains implementation of the resource system.

Copyright: GNU GPLv2 or any later version.

Definition in file cl_resources.qc.

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

References entity().

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

{
    SetResourceExplicit(e, res_type, amount);
}

References entity(), and SetResourceExplicit().

Referenced by DebugText3d::DebugText3d(), CheatImpulse(), freezetag_Freeze(), freezetag_Unfreeze(), GiveWarmupResources(), MUTATOR_HOOKABLE(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), nade_damage(), nade_spawn_SetSpawnHealth(), NIX_GiveCurrentWeapon(), PutPlayerInServer(), readplayerstartcvars(), REGISTER_MUTATOR(), RotRegen(), SetResource(), TakeResource(), target_init_use(), toss_nade(), vehicles_regen_resource(), W_Arc_Beam_Think(), W_DecreaseAmmo(), W_ReloadedAndReady(), W_ThrowNewWeapon(), and weapon_defaultspawnfunc().

◆ 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;
}

References entity(), and GetResourceField().

Referenced by ammo_bullets_init(), ammo_cells_init(), ammo_fuel_init(), ammo_rockets_init(), ammo_shells_init(), ammo_vaporizercells_init(), assault_objective_decrease_use(), assault_objective_reset(), assault_objective_use(), button_fire(), button_reset(), CheatCommand(), CopyBody(), ctf_FlagDamage(), ctf_FlagSetup(), ctf_FlagThink(), ctf_Handle_Drop(), ctf_Handle_Pickup(), ctf_RespawnFlag(), Damage(), door_damage(), door_go_down(), door_rotating_go_down(), Draw_ShowNames_All(), Draw_WaypointSprite(), electro_orb_setup(), Ent_WaypointSprite(), fd_secret_done(), fd_secret_use(), FireGrapplingHook(), FixIntermissionClient(), ft_RemovePlayer(), func_breakable_behave_destroyed(), func_breakable_behave_restore(), func_breakable_setup(), GiveResourceValue(), item_armorbig_init(), item_armormedium_init(), item_armormega_init(), item_armorsmall_init(), item_healthbig_init(), item_healthmedium_init(), item_healthmega_init(), item_healthsmall_init(), LinkDoors(), load_unit_settings(), M_Golem_Attack_Lightning(), M_Mage_Defend_Shield(), M_Spider_Attack_Web(), M_Zombie_Defend_Block(), M_Zombie_Defend_Block_End(), MapVote_Tick(), Monster_Dead_Fade(), Monster_Reset(), Monster_Spawn_Setup(), multi_reset(), multi_wait(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), ons_ControlPoint_Icon_BuildThink(), ons_ControlPoint_Icon_Spawn(), ons_GeneratorReset(), ons_GeneratorSetup(), orb_setup(), Portal_Spawn(), Portal_TeleportPlayer(), powerup_jetpack_init(), powerups_DropItem(), PutObserverInServer(), secret_reset(), SetResource(), spawnfunc(), spawnfunc(), SpectateCopy(), turret_construct(), turret_die(), turret_initialize(), turret_projectile(), turret_respawn(), vehicles_projectile(), W_Arc_Attack_Bolt(), W_Devastator_Attack(), W_Electro_Attack_Orb(), W_Electro_Orb_Stick(), W_Fireball_Attack1(), W_Hagar_Attack(), W_Hagar_Attack2(), W_Hagar_Attack2_Load_Release(), W_Hook_Attack2(), W_Hook_Damage(), W_MineLayer_Attack(), W_MineLayer_Stick(), W_Mortar_Attack(), W_Mortar_Attack2(), W_OverkillRocketPropelledChainsaw_Attack(), W_Seeker_Fire_Missile(), W_Seeker_Fire_Tag(), walker_fire_rocket(), and WaypointSprite_UpdateHealth().

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

References entity(), GetResource(), and SetResource().

Referenced by assault_objective_decrease_use(), button_damage(), ctf_FlagDamage(), ctf_FlagThink(), door_damage(), func_breakable_damage(), GrapplingHook_Damage(), M_Golem_Attack_Lightning_Damage(), Monster_Damage(), Monster_Dead_Damage(), multi_eventdamage(), MUTATOR_HOOKABLE(), MUTATOR_HOOKFUNCTION(), ons_ControlPoint_Icon_Damage(), ons_ControlPoint_Icon_Think(), ons_GeneratorDamage(), PlayerCorpseDamage(), PlayerDamage(), PM_jetpack(), Portal_Damage(), raptor_flare_damage(), TakeResource(), TakeResourceWithLimit(), turret_damage(), turret_projectile_damage(), vehicles_damage(), vehicles_projectile_damage(), W_Arc_Bolt_Damage(), W_Devastator_Damage(), W_Electro_Orb_Damage(), W_Fireball_Damage(), W_Hagar_Damage(), W_MineLayer_Damage(), W_Mortar_Grenade_Damage(), W_OverkillRocketPropelledChainsaw_Damage(), W_Seeker_Missile_Damage(), W_Seeker_Tag_Damage(), and walker_rocket_damage().

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

References entity(), GetResource(), and TakeResource().

Referenced by Item_GiveAmmoTo(), MUTATOR_HOOKABLE(), and TakeResourceWithLimit().

Functions

Detailed Description

Function Documentation

◆ GetResource()

◆ SetResource()

◆ SetResourceExplicit()

◆ TakeResource()

◆ TakeResourceWithLimit()