StrengthStatusEffect Class Reference

Inheritance diagram for StrengthStatusEffect:

Collaboration diagram for StrengthStatusEffect:

Public Member Functions
	ATTRIB (StatusEffect, m_icon, string)
	ATTRIB (StatusEffect, m_name, string)
virtual void	m_active ()
virtual void	m_apply ()
virtual void	m_persistent ()
	Sets the persistent flag and updates client side if returning true.
virtual void	m_remove ()
virtual void	m_tick ()

Public Attributes
vector	m_color = '1 1 1'
bool	m_hidden = false
	Whether the effect is displayed in the HUD.
string	m_icon = "strength"
int	m_id = 0
float	m_lifetime = 30
	Lifetime scale for HUD progress bars.
string	m_name = _("Strength")
Sound	m_sound = SND_Null
Sound	m_sound_rm = SND_POWEROFF
string	netname = "strength"
int	statuseffect_flags [REGISTRY_MAX(StatusEffects)]
float	statuseffect_time [REGISTRY_MAX(StatusEffects)]
	Stores times of status effects, the id being the index.

Detailed Description

Definition at line 57 of file strength.qh.

Member Function Documentation

ATTRIB() [1/2]

StatusEffect::ATTRIB ( StatusEffect , m_icon , string  )

inherited

References ATTRIB().

ATTRIB() [2/2]

StatusEffect::ATTRIB ( StatusEffect , m_name , string  )

inherited

References ATTRIB(), and m_name.

Referenced by ATTRIB(), and ATTRIB().

m_active()

void StatusEffect::m_active ( )

virtualinherited

Definition at line 3 of file cl_status_effects.qc.

{
    // TODO: allow per-entity status effects on the client side
    actor = g_statuseffects;
 
    if(!actor) return false;
    TC(StatusEffect, this);
    return (actor.statuseffect_flags[this.m_id] & STATUSEFFECT_FLAG_ACTIVE);
}

References entity(), g_statuseffects, m_active(), STATUSEFFECT_FLAG_ACTIVE, and TC.

Referenced by m_active().

m_apply()

void StatusEffect::m_apply ( )

virtualinherited

Definition at line 29 of file sv_status_effects.qc.

{
    if(!actor.statuseffects)
        StatusEffects_new(actor);
 
    eff_flags |= STATUSEFFECT_FLAG_ACTIVE; // automatically enable active flag if applied (TODO?)
    actor.statuseffects.statuseffect_time[this.m_id] = eff_time; // TODO: add onto the existing time rather than replacing it?
    actor.statuseffects.statuseffect_flags[this.m_id] = eff_flags;
    StatusEffects_update(actor);
}

References entity(), m_apply(), m_id, STATUSEFFECT_FLAG_ACTIVE, StatusEffects_new(), and StatusEffects_update().

Referenced by m_apply().

m_persistent()

virtual void StatusEffect::m_persistent ( )

inlinevirtualinherited

Sets the persistent flag and updates client side if returning true.

Definition at line 55 of file all.qh.

{ return false; };

References entity(), and m_persistent().

Referenced by m_persistent().

m_remove()

void StatusEffect::m_remove ( )

virtualinherited

Definition at line 40 of file sv_status_effects.qc.

{
    StatusEffect data = actor.statuseffects;
    if(!data)
        return;
    // NOTE: persistent effects do not make a sound on removal, this is intended as a workaround for #2620
    if(removal_type == STATUSEFFECT_REMOVE_NORMAL && !(data.statuseffect_flags[this.m_id] & STATUSEFFECT_FLAG_PERSISTENT) && this.m_active(this, actor))
        sound(actor, CH_TRIGGER, this.m_sound_rm, VOL_BASE, ATTEN_NORM);
    data.statuseffect_time[this.m_id] = 0;
    data.statuseffect_flags[this.m_id] = 0;
    StatusEffects_update(actor);
}

References ATTEN_NORM, CH_TRIGGER, entity(), m_id, m_remove(), m_sound_rm, sound, STATUSEFFECT_FLAG_PERSISTENT, statuseffect_flags, STATUSEFFECT_REMOVE_NORMAL, statuseffect_time, StatusEffects_update(), and VOL_BASE.

Referenced by m_remove().

m_tick()

void StatusEffect::m_tick ( )

virtualinherited

Definition at line 13 of file cl_status_effects.qc.

{
    if(this.m_hidden || autocvar__hud_configure)
        return;
 
    float currentTime = bound(0, actor.statuseffect_time[this.m_id] - time, 99);
    addPowerupItem(this.m_name, this.m_icon, this.m_color, currentTime, this.m_lifetime, (actor.statuseffect_flags[this.m_id] & STATUSEFFECT_FLAG_PERSISTENT));
}

References addPowerupItem(), autocvar__hud_configure, bound(), entity(), m_color, m_hidden, m_lifetime, m_name, m_tick(), STATUSEFFECT_FLAG_PERSISTENT, and time.

Referenced by m_tick().

Member Data Documentation

m_color

vector StatusEffect::m_color = '1 1 1'

inherited

Definition at line 37 of file all.qh.

Referenced by m_tick().

m_hidden

bool StatusEffect::m_hidden = false

inherited

Whether the effect is displayed in the HUD.

Definition at line 39 of file all.qh.

Referenced by m_tick().

m_icon

string StrengthStatusEffect::m_icon = "strength"

Definition at line 60 of file strength.qh.

m_id

int StatusEffect::m_id = 0

inherited

Definition at line 34 of file all.qh.

Referenced by m_apply(), m_remove(), and NET_HANDLE().

m_lifetime

float StatusEffect::m_lifetime = 30

inherited

Lifetime scale for HUD progress bars.

Definition at line 41 of file all.qh.

Referenced by m_tick().

m_name

string StrengthStatusEffect::m_name = _("Strength")

Definition at line 59 of file strength.qh.

m_sound

Sound StatusEffect::m_sound = SND_Null

inherited

Definition at line 43 of file all.qh.

m_sound_rm

Sound PowerupStatusEffect::m_sound_rm = SND_POWEROFF

inherited

Definition at line 38 of file powerups.qh.

netname

string StrengthStatusEffect::netname = "strength"

Definition at line 58 of file strength.qh.

statuseffect_flags

int StatusEffect::statuseffect_flags[REGISTRY_MAX(StatusEffects)]

inherited

Definition at line 49 of file all.qh.

Referenced by m_remove(), and StatusEffects_Write().

statuseffect_time

float StatusEffect::statuseffect_time[REGISTRY_MAX(StatusEffects)]

inherited

Stores times of status effects, the id being the index.

Definition at line 48 of file all.qh.

Referenced by m_remove(), and StatusEffects_Write().

---

The documentation for this class was generated from the following file:

• common/mutators/mutator/powerups/powerup/strength.qh