status_effects.qh File Reference

#include <common/mutators/base.qh>
#include "all.qh"

Include dependency graph for status_effects.qh:

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

Go to the source code of this file.

Macros
#define	G_MAJOR(id)
#define	G_MINOR(id)

Functions
	NET_HANDLE (ENT_CLIENT_STATUSEFFECTS, bool isnew)
void	ONREMOVE (entity this)
	REGISTER_MUTATOR (status_effects, true)
	STATIC_INIT (StatusEffects)
bool	StatusEffects_active (StatusEffect this, entity actor)
void	StatusEffects_apply (StatusEffect this, entity actor, float eff_time, int eff_flags)
void	StatusEffects_clearall (entity store)
void	StatusEffects_copy (StatusEffect this, entity store, float time_offset)
bool	StatusEffects_customize (entity this, entity client)
void	StatusEffects_delete (entity e)
void	StatusEffects_entremove (entity this)
float	StatusEffects_gettime (StatusEffect this, entity actor)
void	StatusEffects_new (entity this)
void	StatusEffects_remove (StatusEffect this, entity actor, int removal_type)
void	StatusEffects_removeall (entity actor, int removal_type)
bool	StatusEffects_Send (StatusEffect this, entity to, int sf)
void	StatusEffects_tick (entity actor)
void	StatusEffects_update (entity e)
void	StatusEffects_Write (StatusEffect data, StatusEffect store)
void	StatusEffectsStorage_attach (entity e)
void	StatusEffectsStorage_delete (entity e)

Variables
StatusEffect	g_statuseffects
int	SEFminorBitsArr [StatusEffects_groups_major]
StatusEffect	statuseffects
	Entity statuseffects.
const int	StatusEffects_groups_major = 4
const int	StatusEffects_groups_minor = 8
StatusEffect	statuseffects_store
	Player statuseffects storage (holds previous state)

Macro Definition Documentation

G_MAJOR

#define G_MAJOR

(

id

)

Value:

(floor((id) / StatusEffects_groups_minor))

Definition at line 36 of file status_effects.qh.

Referenced by StatusEffects_Write().

G_MINOR

#define G_MINOR

(

id

)

Value:

((id) % StatusEffects_groups_minor)

Definition at line 37 of file status_effects.qh.

Referenced by StatusEffects_Write().

Function Documentation

NET_HANDLE()

NET_HANDLE	(	ENT_CLIENT_STATUSEFFECTS	,
		bool	isnew )

Definition at line 48 of file status_effects.qh.

{
    make_pure(this);
    g_statuseffects = this;
    this.entremove = StatusEffects_entremove;
    const int majorBits = Readbits(StatusEffects_groups_major);
    for (int i = 0; i < StatusEffects_groups_major; ++i) {
        if (!(majorBits & BIT(i))) {
            continue;
        }
        const int minorBits = Readbits(StatusEffects_groups_minor);
        for (int j = 0; j < StatusEffects_groups_minor; ++j) {
            if (!(minorBits & BIT(j))) {
                continue;
            }
            const StatusEffect it = REGISTRY_GET(StatusEffects, StatusEffects_groups_minor * i + j);
            this.statuseffect_time[it.m_id] = ReadFloat();
            this.statuseffect_flags[it.m_id] = ReadByte();
        }
    }
    return true;
}

References BIT, g_statuseffects, StatusEffect::m_id, make_pure, Readbits(), ReadByte(), ReadFloat, REGISTRY_GET, StatusEffects_entremove(), StatusEffects_groups_major, and StatusEffects_groups_minor.

ONREMOVE()

void ONREMOVE

(

entity

this

)

Definition at line 173 of file status_effects.qh.

{
    // remove statuseffects object attached to 'this'
    if(this.statuseffects && this.statuseffects.owner == this)
        StatusEffects_delete(this);
}

References entity(), statuseffects, and StatusEffects_delete().

Referenced by ClientDisconnect(), and CSQC_Ent_Update().

REGISTER_MUTATOR()

REGISTER_MUTATOR	(	status_effects	,
		true	)

STATIC_INIT()

STATIC_INIT

(

StatusEffects

)

Definition at line 25 of file status_effects.qh.

{
    if (StatusEffects_groups_minor / 8 != floor(StatusEffects_groups_minor / 8))
        error("StatusEffects_groups_minor is not a multiple of 8.");
    int min_major_value = ceil(REGISTRY_COUNT(StatusEffects) / StatusEffects_groups_minor);
    if (StatusEffects_groups_major < min_major_value)
        error(sprintf("StatusEffects_groups_major can not be < %d.", min_major_value));
}

References ceil(), error, floor(), REGISTRY_COUNT, StatusEffects_groups_major, and StatusEffects_groups_minor.

StatusEffects_active()

bool StatusEffects_active	(	StatusEffect	this,
		entity	actor )

Definition at line 4 of file status_effects.qc.

{
    return this.m_active(this, actor);
}

References entity().

Referenced by ctf_Handle_Throw(), Damage(), Fire_AddDamage(), Fire_ApplyDamage(), GiveBuff(), GiveItems(), GiveStatusEffect(), GrapplingHookThink(), havocbot_ai(), M_Mage_Defend_Heal_Check(), Monster_Anim(), Monster_Damage(), Monster_Move(), Monster_Think(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), nade_ice_think(), nade_prime(), napalm_damage(), player_anim(), player_powerups(), PlayerDamage(), PlayerFrame(), PlayerUseKey(), vehicles_enter(), W_Fireball_LaserPlay(), W_OverkillHeavyMachineGun_Attack_Auto(), W_Porto_Attack(), WantEventchase(), weapon_prepareattack_do(), and weaponLocked().

StatusEffects_apply()

void StatusEffects_apply	(	StatusEffect	this,
		entity	actor,
		float	eff_time,
		int	eff_flags )

Definition at line 31 of file status_effects.qc.

{
    if (!actor || eff_time <= time)
        return;
 
    this.m_apply(this, actor, eff_time, eff_flags);
}

References entity(), and time.

Referenced by buff_Disability_ApplyStunned(), buff_Touch(), Fire_AddDamage(), GiveBuff(), GiveItems(), GiveStatusEffect(), Item_GiveTo(), M_Mage_Defend_Shield(), Monster_Spawn(), nade_ice_freeze(), and PutPlayerInServer().

StatusEffects_clearall()

void StatusEffects_clearall

(

entity

store

)

Definition at line 156 of file status_effects.qh.

{
    if(!store)
        return; // safety net
    // NOTE: you will need to perform StatusEffects_update after this to update the storage entity
    // (unless store is the storage entity)
    FOREACH(StatusEffects, true, {
        store.statuseffect_time[it.m_id] = 0;
        store.statuseffect_flags[it.m_id] = 0;
    });
}

References entity(), and FOREACH.

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

StatusEffects_copy()

void StatusEffects_copy	(	StatusEffect	this,
		entity	store,
		float	time_offset )

Definition at line 39 of file status_effects.qc.

{
    if(!this || !store)
        return;
    FOREACH(StatusEffects, true,
    {
        if(time_offset)
            store.statuseffect_time[it.m_id] = time + this.statuseffect_time[it.m_id] - time_offset;
        else
            store.statuseffect_time[it.m_id] = this.statuseffect_time[it.m_id];
        store.statuseffect_flags[it.m_id] = this.statuseffect_flags[it.m_id];
    });
}

References entity(), FOREACH, and time.

Referenced by CheatImpulse().

StatusEffects_customize()

bool StatusEffects_customize	(	entity	this,
		entity	client )

Definition at line 132 of file status_effects.qh.

{
    // sends to spectators too!
    return (client.statuseffects == this);
}

References entity().

Referenced by StatusEffects_new().

StatusEffects_delete()

void StatusEffects_delete

(

entity

e

)

Definition at line 150 of file status_effects.qh.

{ delete(e.statuseffects); e.statuseffects = NULL; }

References entity(), and NULL.

Referenced by MUTATOR_HOOKFUNCTION(), and ONREMOVE().

StatusEffects_entremove()

void StatusEffects_entremove

(

entity

this

)

Definition at line 42 of file status_effects.qh.

{
    if(g_statuseffects == this)
        g_statuseffects = NULL;
}

References entity(), g_statuseffects, and NULL.

Referenced by NET_HANDLE().

StatusEffects_gettime()

float StatusEffects_gettime	(	StatusEffect	this,
		entity	actor )

Definition at line 17 of file status_effects.qc.

{
    entity store = actor;
#ifdef SVQC
    store = actor.statuseffects;
#endif
    if(!store) return 0;
    float eff_time = store.statuseffect_time[this.m_id];
    // if effect end time has passed and m_tick hasn't removed the effect yet
    // return current time since the effect is actually still active in this frame
    return (eff_time < time ? time : eff_time);
}

References entity(), m_id, and time.

Referenced by Fire_AddDamage(), Fire_ApplyDamage(), GiveBuff(), GiveStatusEffect(), havocbot_goalrating_enemyplayers(), Item_GiveTo(), MUTATOR_HOOKFUNCTION(), player_powerups(), powerups_DropItem(), and W_ThrowNewWeapon().

StatusEffects_new()

void StatusEffects_new

(

entity

this

)

Definition at line 138 of file status_effects.qh.

{
    StatusEffect eff = NEW(StatusEffect);
    this.statuseffects = eff;
    eff.owner = this;
    if(this.statuseffects_store)
    {
        setcefc(eff, StatusEffects_customize);
        Net_LinkEntity(eff, false, 0, StatusEffects_Send);
    }
}

References entity(), Net_LinkEntity(), NEW, setcefc, statuseffects, StatusEffects_customize(), StatusEffects_Send(), and statuseffects_store.

Referenced by StatusEffect::m_apply().

StatusEffects_remove()

void StatusEffects_remove	(	StatusEffect	this,
		entity	actor,
		int	removal_type )

Definition at line 53 of file status_effects.qc.

{
    this.m_remove(this, actor, removal_type);
}

References entity().

Referenced by Damage(), GiveBuff(), GiveStatusEffect(), invasion_SpawnChosenMonster(), player_powerups(), W_ThrowNewWeapon(), and weapon_prepareattack_do().

StatusEffects_removeall()

void StatusEffects_removeall	(	entity	actor,
		int	removal_type )

Definition at line 58 of file status_effects.qc.

{
    if(!actor.statuseffects)
        return;
    FOREACH(StatusEffects, true,
    {
        it.m_remove(it, actor, removal_type);
    });
}

References entity(), and FOREACH.

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

StatusEffects_Send()

bool StatusEffects_Send	(	StatusEffect	this,
		entity	to,
		int	sf )

Definition at line 124 of file status_effects.qh.

{
    TC(StatusEffect, this);
    WriteHeader(MSG_ENTITY, ENT_CLIENT_STATUSEFFECTS);
    StatusEffects_Write(this, to.statuseffects_store);
    return true;
}

References entity(), MSG_ENTITY, StatusEffects_Write(), TC, and WriteHeader.

Referenced by StatusEffects_new().

StatusEffects_tick()

void StatusEffects_tick

(

entity

actor

)

Definition at line 9 of file status_effects.qc.

{
    FOREACH(StatusEffects, it.m_active(it, actor),
    {
        it.m_tick(it, actor);
    });
}

References entity(), and FOREACH.

Referenced by MUTATOR_HOOKFUNCTION().

StatusEffects_update()

void StatusEffects_update

(

entity

e

)

Definition at line 153 of file status_effects.qh.

{ e.statuseffects.SendFlags = 0xFFFFFF; }

References entity().

Referenced by CheatImpulse(), GiveItems(), StatusEffect::m_apply(), StatusEffect::m_remove(), Monster_Spawn(), MUTATOR_HOOKFUNCTION(), and W_ThrowNewWeapon().

StatusEffects_Write()

void StatusEffects_Write	(	StatusEffect	data,
		StatusEffect	store )

Definition at line 74 of file status_effects.qh.

{
    if (!data) {
        WriteShort(MSG_ENTITY, 0);
        return;
    }
    TC(StatusEffect, data);
 
    for (int i = 0; i < StatusEffects_groups_major; ++i)
        SEFminorBitsArr[i] = 0;
 
    int majorBits = 0;
    FOREACH(StatusEffects, true, {
        .float fld = statuseffect_time[it.m_id];
        .int flg = statuseffect_flags[it.m_id];
        const bool changed = (store.(fld) != data.(fld) || store.(flg) != data.(flg));
        store.(fld) = data.(fld);
        store.(flg) = data.(flg);
        if (changed) {
            int maj = G_MAJOR(it.m_id);
            majorBits = BITSET(majorBits, BIT(maj), true);
            SEFminorBitsArr[maj] = BITSET(SEFminorBitsArr[maj], BIT(G_MINOR(it.m_id)), true);
        }
    });
 
    Writebits(MSG_ENTITY, majorBits, StatusEffects_groups_major);
    for (int i = 0; i < StatusEffects_groups_major; ++i)
    {
        if (!(majorBits & BIT(i)))
            continue;
 
        const int minorBits = SEFminorBitsArr[i];
        Writebits(MSG_ENTITY, minorBits, StatusEffects_groups_minor);
        for (int j = 0; j < StatusEffects_groups_minor; ++j)
        {
            if (!(minorBits & BIT(j)))
                continue;
 
            const entity it = REGISTRY_GET(StatusEffects, StatusEffects_groups_minor * i + j);
            WriteFloat(MSG_ENTITY, data.statuseffect_time[it.m_id]);
            WriteByte(MSG_ENTITY, data.statuseffect_flags[it.m_id]);
        }
    }
}

References BIT, BITSET, entity(), FOREACH, G_MAJOR, G_MINOR, MSG_ENTITY, REGISTRY_GET, SEFminorBitsArr, StatusEffect::statuseffect_flags, StatusEffect::statuseffect_time, StatusEffects_groups_major, StatusEffects_groups_minor, TC, WriteByte(), and WriteShort().

Referenced by StatusEffects_Send().

StatusEffectsStorage_attach()

void StatusEffectsStorage_attach

(

entity

e

)

Definition at line 168 of file status_effects.qh.

{ e.statuseffects_store = NEW(StatusEffect); e.statuseffects_store.drawonlytoclient = e; }

References entity(), and NEW.

Referenced by ClientState_attach().

StatusEffectsStorage_delete()

void StatusEffectsStorage_delete

(

entity

e

)

Definition at line 169 of file status_effects.qh.

{ delete(e.statuseffects_store); e.statuseffects_store = NULL; }

References entity(), and NULL.

Referenced by ClientState_detach().

Variable Documentation

g_statuseffects

StatusEffect g_statuseffects

Definition at line 41 of file status_effects.qh.

Referenced by StatusEffect::m_active(), MUTATOR_HOOKFUNCTION(), NET_HANDLE(), and StatusEffects_entremove().

SEFminorBitsArr

int SEFminorBitsArr[StatusEffects_groups_major]

Definition at line 73 of file status_effects.qh.

Referenced by StatusEffects_Write().

statuseffects

StatusEffect statuseffects

Entity statuseffects.

Definition at line 13 of file status_effects.qh.

Referenced by CheatImpulse(), Monster_Spawn(), ONREMOVE(), and StatusEffects_new().

StatusEffects_groups_major

const int StatusEffects_groups_major = 4

Definition at line 20 of file status_effects.qh.

Referenced by NET_HANDLE(), STATIC_INIT(), and StatusEffects_Write().

StatusEffects_groups_minor

const int StatusEffects_groups_minor = 8

Definition at line 19 of file status_effects.qh.

Referenced by NET_HANDLE(), STATIC_INIT(), and StatusEffects_Write().

statuseffects_store

StatusEffect statuseffects_store

Player statuseffects storage (holds previous state)

Definition at line 15 of file status_effects.qh.

Referenced by StatusEffects_new().