items.qc File Reference

#include "items.qh"
#include <client/main.qh>
#include <common/items/_mod.qh>
#include <common/physics/movetypes/movetypes.qh>
#include <common/weapons/_all.qh>
#include <lib/csqcmodel/cl_model.qh>
#include <lib/csqcmodel/common.qh>
#include <lib/warpzone/common.qh>

Include dependency graph for items.qc:

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

Go to the source code of this file.

Macros
#define	extensions(x)
#define	tryext(ext)

Functions
void	ItemDraw (entity this)
void	ItemRemove (entity this)
void	ItemSetModel (entity this, bool wantsimple)
	NET_HANDLE (ENT_CLIENT_ITEM, bool isnew)
	SHUTDOWN (ENT_CLIENT_ITEM_simple)
	STATIC_INIT (ENT_CLIENT_ITEM_simple)

Variables
float	alpha
vector	angles_held
float	anim_start_time
float	delay
HashMap	ENT_CLIENT_ITEM_simple
vector	item_glowmod
int	item_simple
vector	m_maxs
vector	m_mins
float	pointtime
bool	pushable
float	wait

Macro Definition Documentation

extensions

#define extensions

(

x

)

Value:

        x(iqm) \
        x(dpm) \
        x(md3) \
        x(mdl) \

Referenced by _Sound_fixpath(), and ItemSetModel().

tryext

#define tryext

(

ext

)

Value:

            { \
            string s = strcat(_fn2, autocvar_cl_simpleitems_postfix, "." #ext); \
            string cached = HM_gets(ENT_CLIENT_ITEM_simple, s); \
            if (cached == "") { \
                HM_sets(ENT_CLIENT_ITEM_simple, s, cached = fexists(s) ? "1" : "0"); \
            } \
            if (cached != "0") { \
                this.model = s; \
                this.item_simple = 1; \
                break; \
            } \
        }

Referenced by _Sound_fixpath(), and ItemSetModel().

Function Documentation

ItemDraw()

void ItemDraw

(

entity

this

)

Definition at line 76 of file items.qc.

{
    bool wantsimple = autocvar_cl_simple_items && (this.ItemStatus & ITS_ALLOWSI);
    if(wantsimple != this.item_simple && this.item_simple != -1)
        ItemSetModel(this, wantsimple);
 
    // no bobbing applied to simple items, for consistency's sake (no visual difference between ammo and weapons)
    bool animate = (autocvar_cl_items_animate & 1) && this.item_simple <= 0 && (this.ItemStatus & (ITS_ANIMATE1 | ITS_ANIMATE2));
 
    // rotation must be set before running physics
    if(!animate)
    {
        this.avelocity_y = 0;
        this.angles = this.angles_held; // restore angles sent from server
    }
    else if(!this.avelocity_y) // unset by MOVETYPE_TOSS or animation was disabled previously
    {
        if(this.ItemStatus & ITS_ANIMATE1)
            this.avelocity_y = 180;
        else if(this.ItemStatus & ITS_ANIMATE2)
            this.avelocity_y = -90;
    }
 
    // CSQC physics OR bobbing (both would look weird)
    float bobheight = 0; // reset bob offset if animations are disabled
    if(this.move_movetype && (!IS_ONGROUND(this) || this.velocity != '0 0 0'))
    {
        // this isn't equivalent to player prediction but allows smooth motion with very low ISF_LOCATION rate
        // which requires running this even if the item is just outside visible range (it could be moving into range)
        if(animate)
            bobheight = this.origin_z - this.oldorigin_z;
        Movetype_Physics_NoMatchTicrate(this, frametime, true);
        this.oldorigin = this.origin; // update real (SVQC equivalent) origin
        if(animate)
        {
            if(bobheight)
            {
                this.anim_start_time += frametime; // bobbing is paused this frame
                this.oldorigin_z -= bobheight; // restore bob offset (CSQC physics uses the offset bbox)
            }
            else
            {
                this.anim_start_time = time; // starting our bob animation from NOW
                if(this.ItemStatus & ITS_ANIMATE1)
                    bobheight = 10; // height of wave at 0 time
                else if(this.ItemStatus & ITS_ANIMATE2)
                    bobheight = 8; // height of wave at 0 time
            }
        }
    }
    else if(animate)
    {
        this.angles += this.avelocity * frametime; // MOVETYPE_TOSS does this while it's moving
 
        if(this.ItemStatus & ITS_ANIMATE1)
            bobheight = 10 + 8 * sin((time - this.anim_start_time) * 2);
        else if(this.ItemStatus & ITS_ANIMATE2)
            bobheight = 8 + 4 * sin((time - this.anim_start_time) * 3);
    }
 
    // apply new bob offset
    if (bobheight != this.origin_z - this.oldorigin_z)
    {
        this.origin_z = this.oldorigin_z + bobheight;
        this.mins_z = this.m_mins.z - bobheight; // don't want the absmin and absmax to bob
        this.maxs_z = this.m_maxs.z - bobheight;
    }
 
    // set alpha based on distance
    this.alpha = 1;
    this.drawmask = 0;
    if(this.fade_end && !warpzone_warpzones_exist)
    {
        vector org = getpropertyvec(VF_ORIGIN);
        if(vdist(org - this.origin, >, this.fade_end))
            this.alpha = 0; // save on some processing
        else if(autocvar_cl_items_fadedist > 0)
        {
            this.fade_start = max(500, this.fade_end - autocvar_cl_items_fadedist);
            if(vdist(org - this.origin, >, this.fade_start))
                this.alpha = bound(0, (this.fade_end - vlen(org - this.origin - 0.5 * (this.mins + this.maxs))) / (this.fade_end - this.fade_start), 1);
        }
    }
 
    if(!this.alpha)
        return;
 
    // modify alpha based on availability and vehicle hud
    if(this.ItemStatus & ITS_AVAILABLE)
    {
        if(hud) // apparently this means we're in a vehicle lol
        {
            this.alpha *= autocvar_cl_items_vehicle_alpha;
            this.colormod = this.glowmod = autocvar_cl_items_vehicle_color;
        }
        else if(this.ItemStatus & ITS_STAYWEP)
        {
            this.alpha *= autocvar_cl_weapon_stay_alpha;
            this.colormod = this.glowmod = autocvar_cl_weapon_stay_color;
        }
        else
        {
            this.colormod = '1 1 1';
            this.glowmod = this.item_glowmod;
        }
    }
    else
    {
        this.alpha *= autocvar_cl_ghost_items;
        this.colormod = this.glowmod = autocvar_cl_ghost_items_color;
    }
 
    if(!this.alpha)
        return;
 
    // loot item despawn effects
    if(this.ItemStatus & ITS_EXPIRING)
    {
        if(!this.wait) // when receiving the first message with ITS_EXPIRING set
        {
            this.wait = time + IT_DESPAWNFX_TIME; // it will despawn then
            this.delay = 0.25;
        }
 
        if(autocvar_cl_items_animate & 2)
            this.alpha *= (this.wait - time) / IT_DESPAWNFX_TIME;
 
        if((autocvar_cl_items_animate & 4) && time >= this.pointtime)
        {
            pointparticles(EFFECT_ITEM_DESPAWN, this.origin + '0 0 16', '0 0 0', 1);
            if (this.delay > 0.0625)
                this.delay *= 0.5;
            this.pointtime = time + this.delay;
        }
    }
 
    this.drawmask = this.alpha <= 0 ? 0 : MASK_NORMAL;
}

References alpha, angles, angles_held, anim_start_time, autocvar_cl_ghost_items, autocvar_cl_ghost_items_color, autocvar_cl_items_animate, autocvar_cl_items_fadedist, autocvar_cl_items_vehicle_alpha, autocvar_cl_items_vehicle_color, autocvar_cl_simple_items, autocvar_cl_weapon_stay_alpha, autocvar_cl_weapon_stay_color, avelocity, bound(), colormod, delay, drawmask, entity(), fade_end, fade_start, frametime, glowmod, hud, IS_ONGROUND, IT_DESPAWNFX_TIME, item_glowmod, item_simple, ItemSetModel(), ItemStatus, ITS_ALLOWSI, ITS_ANIMATE1, ITS_ANIMATE2, ITS_AVAILABLE, ITS_EXPIRING, ITS_STAYWEP, m_maxs, m_mins, MASK_NORMAL, max(), maxs, mins, move_movetype, Movetype_Physics_NoMatchTicrate(), oldorigin, org, origin, pointparticles, pointtime, sin(), time, vdist, vector, velocity, VF_ORIGIN, vlen(), wait, and warpzone_warpzones_exist.

Referenced by NET_HANDLE().

ItemRemove()

void ItemRemove

(

entity

this

)

Definition at line 215 of file items.qc.

{
    strfree(this.mdl);
}

References entity(), mdl, and strfree.

Referenced by NET_HANDLE().

ItemSetModel()

void ItemSetModel	(	entity	this,
		bool	wantsimple )

Definition at line 30 of file items.qc.

{
    if(wantsimple)
    {
        string _fn2 = substring(this.mdl, 0 , strlen(this.mdl) -4);
        #define extensions(x) \
        x(iqm) \
        x(dpm) \
        x(md3) \
        x(mdl) \
        /**/
        #define tryext(ext) { \
            string s = strcat(_fn2, autocvar_cl_simpleitems_postfix, "." #ext); \
            string cached = HM_gets(ENT_CLIENT_ITEM_simple, s); \
            if (cached == "") { \
                HM_sets(ENT_CLIENT_ITEM_simple, s, cached = fexists(s) ? "1" : "0"); \
            } \
            if (cached != "0") { \
                this.model = s; \
                this.item_simple = 1; \
                break; \
            } \
        }
        do {
            extensions(tryext);
            this.model = this.mdl; // fall back to 3d model
            this.item_simple = -1; // don't retry every frame
            LOG_TRACEF("Simple item requested for %s but no model exists for it", this.mdl);
        } while (0);
        #undef tryext
        #undef extensions
    }
    else
    {
        this.model = this.mdl;
        this.item_simple = 0;
    }
 
    // this.model is an engine string so it doesn't need to be zoned and can't be unzoned
    if(this.model == "")
        LOG_WARNF("this.model is unset for item %s", this.classname);
    precache_model(this.model);
    _setmodel(this, this.model);
    setsize(this, this.m_mins, this.m_maxs);
}

References classname, entity(), extensions, item_simple, LOG_TRACEF, LOG_WARNF, m_maxs, m_mins, mdl, model, strlen, substring(), and tryext.

Referenced by ItemDraw().

NET_HANDLE()

NET_HANDLE	(	ENT_CLIENT_ITEM	,
		bool	isnew )

Definition at line 220 of file items.qc.

{
    int sf = ReadByte();
 
    if(sf & ISF_LOCATION)
    {
        float bobheight = this.origin_z - this.oldorigin_z;
        this.origin = this.oldorigin = ReadVector();
        this.origin_z += bobheight; // restore animation offset (SVQC physics is unaware of CSQC bbox offset)
        setorigin(this, this.origin); // link
    }
 
    if(sf & ISF_ANGLES)
    {
        this.angles = this.angles_held = ReadAngleVector();
    }
 
    if(sf & ISF_STATUS) // need to read/write status first so model can handle simple, fb etc.
    {
        int prevItemStatus = this.ItemStatus;
        this.ItemStatus = ReadByte();
 
        if(this.ItemStatus & ITS_ALLOWFB)
            this.effects |= EF_FULLBRIGHT;
        else
            this.effects &= ~EF_FULLBRIGHT;
 
        if(this.ItemStatus & ITS_AVAILABLE)
        {
            if(this.solid != SOLID_TRIGGER)
            {
                this.solid = SOLID_TRIGGER;
                setorigin(this, this.origin); // link it to the area grid
            }
 
            if(this.ItemStatus & ITS_GLOW)
                this.effects |= (EF_ADDITIVE | EF_FULLBRIGHT);
            if(!(prevItemStatus & ITS_AVAILABLE) && this.alpha && !isnew)
                pointparticles(EFFECT_ITEM_RESPAWN, (this.absmin + this.absmax) * 0.5, '0 0 0', 1);
        }
        else
        {
            if(this.solid != SOLID_NOT)
            {
                this.solid = SOLID_NOT;
                setorigin(this, this.origin); // optimisation: unlink it from the area grid
            }
 
            if(this.ItemStatus & ITS_GLOW)
                this.effects &= ~(EF_ADDITIVE | EF_FULLBRIGHT);
            if((prevItemStatus & ITS_AVAILABLE) && this.alpha)
                pointparticles(EFFECT_ITEM_PICKUP, (this.absmin + this.absmax) * 0.5, '0 0 0', 1);
        }
    }
 
    if(sf & (ISF_SIZE | ISF_SIZE2)) // always true when it's spawned (in CSQC's perspective)
    {
        if(isnew)
        {
            IL_PUSH(g_drawables, this);
            this.draw = ItemDraw;
            this.flags |= FL_ITEM;
            this.entremove = ItemRemove;
        }
 
        if(sf & ISF_SIZE && !(sf & ISF_SIZE2)) // Small
        {
            this.m_mins = ITEM_S_MINS;
            this.m_maxs = ITEM_S_MAXS;
        }
        else if(!(sf & ISF_SIZE) && sf & ISF_SIZE2) // Large
        {
            this.m_mins = ITEM_D_MINS;
            this.m_maxs = ITEM_L_MAXS;
        }
        else // Default
        {
            this.m_mins = ITEM_D_MINS;
            this.m_maxs = ITEM_D_MAXS;
        }
 
        this.fade_end = ReadShort();
 
        strcpy(this.mdl, ReadString());
        this.item_simple = -2;
 
        this.skin = ReadByte();
    }
 
    if(sf & ISF_COLORMAP)
    {
        this.colormap = ReadShort();
        this.item_glowmod_x = ReadByte() / 255.0;
        this.item_glowmod_y = ReadByte() / 255.0;
        this.item_glowmod_z = ReadByte() / 255.0;
    }
 
    if(sf & ISF_DROP)
    {
        this.gravity = 1;
        this.pushable = true;
        set_movetype(this, MOVETYPE_TOSS);
        this.velocity = ReadVector();
    }
    else if (this.gravity) // caution: kludge FIXME (with sv_legacy_bbox_expand)
    {
        // workaround for prediction errors caused by bbox discrepancy between SVQC and CSQC
        this.gravity = 0; // don't do this kludge again
        this.pushable = false; // no fun allowed
        set_movetype(this, MOVETYPE_NONE); // disable physics
        this.velocity = '0 0 0'; // disable it more
        SET_ONGROUND(this); // extra overkill
    }
 
    if(sf & ISF_REMOVEFX && !(sf & (ISF_SIZE | ISF_SIZE2))) // TODO !isnew isn't reliable for this... are we double sending initialisations?
    {
        // no longer available to pick up, about to be removed
        if (this.drawmask) // this.alpha > 0
            pointparticles(EFFECT_ITEM_PICKUP, (this.absmin + this.absmax) * 0.5, '0 0 0', 1);
        // removing now causes CSQC_Ent_Remove() to spam
        this.drawmask = 0;
        IL_REMOVE(g_drawables, this);
        this.solid = SOLID_NOT;
    }
 
    return true;
}

References absmax, absmin, alpha, angles, angles_held, colormap, drawmask, EF_ADDITIVE, EF_FULLBRIGHT, effects, fade_end, FL_ITEM, flags, g_drawables, gravity, IL_PUSH(), IL_REMOVE(), ISF_ANGLES, ISF_COLORMAP, ISF_DROP, ISF_LOCATION, ISF_REMOVEFX, ISF_SIZE, ISF_SIZE2, ISF_STATUS, ITEM_D_MAXS, ITEM_D_MINS, ITEM_L_MAXS, ITEM_S_MAXS, ITEM_S_MINS, item_simple, ItemDraw(), ItemRemove(), ItemStatus, ITS_ALLOWFB, ITS_AVAILABLE, ITS_GLOW, m_maxs, m_mins, mdl, MOVETYPE_NONE, MOVETYPE_TOSS, oldorigin, origin, pointparticles, pushable, ReadAngleVector, ReadByte(), ReadString, ReadVector, set_movetype(), SET_ONGROUND, skin, solid, SOLID_NOT, SOLID_TRIGGER, strcpy, and velocity.

SHUTDOWN()

SHUTDOWN

(

ENT_CLIENT_ITEM_simple

)

Definition at line 25 of file items.qc.

{
    HM_DELETE(ENT_CLIENT_ITEM_simple);
}

References ENT_CLIENT_ITEM_simple, and HM_DELETE.

STATIC_INIT()

STATIC_INIT

(

ENT_CLIENT_ITEM_simple

)

Definition at line 21 of file items.qc.

{
    HM_NEW(ENT_CLIENT_ITEM_simple);
}

References ENT_CLIENT_ITEM_simple, and HM_NEW.

Variable Documentation

alpha

float alpha

Definition at line 13 of file items.qc.

Referenced by AuxiliaryXhair_Draw2D(), buff_Customize(), buffs_BuffModel_Customize(), buffs_BuffModel_Think(), buffs_BuffModel_Update(), Button_draw(), Casing_Draw(), CL_ExteriorWeaponentity_Think(), CL_Weaponentity_Think(), classfield(), classfield(), CopyBody(), cpicon_construct(), cpicon_draw(), CSQCModel_Effects_Apply(), Draw_ShowNames(), Draw_WaypointSprite(), DrawAmmoItem(), drawcharacter(), drawcolorcodedstring(), drawcolorcodedstring2(), drawfill(), drawpic(), drawstring(), drawsubpic(), float(), float(), float(), float(), GameTypeVote_DrawGameTypeItem(), generator_construct(), Gib_Draw(), HUD_Chat(), HUD_Mod_KH(), HUD_Notify(), ItemDraw(), ka_BallThink_Carried(), laser_SendEntity(), ModelEffect_Draw(), modeleffect_SendEntity(), nade_customize(), NET_HANDLE(), NET_HANDLE(), ons_generator_ray_draw(), orb_draw(), physical_item_think(), player_powerups(), PlayerCorpseDamage(), PlayerDamage(), Projectile_Draw(), Projectile_DrawTrail(), PutObserverInServer(), PutPlayerInServer(), raptor_blowup(), RaptorCBShellfragDraw(), respawn(), shieldhit_think(), spawnfunc(), spiderbot_blowup(), spiderbot_headfade(), StrafeHUD_DrawAngleIndicator(), StrafeHUD_DrawAngleIndicatorArrow(), StrafeHUD_DrawAngleIndicatorLine(), StrafeHUD_DrawGradient(), StrafeHUD_DrawSoftGradient(), StrafeHUD_DrawStrafeArrow(), StrafeHUD_DrawStrafeHUD(), StrafeHUD_DrawTextIndicator(), SUB(), SUB(), SUB_SetFade_Think(), tka_BallThink_Carried(), turret_construct(), turret_draw2d(), turret_gib_draw(), UpdateChatBubble(), vector(), vehicles_gib_think(), vehicles_reset_colors(), void(), void(), W_MuzzleFlash_Model_Think(), and WarpZone_Fade_PreDraw().

angles_held

vector angles_held

Definition at line 16 of file items.qc.

Referenced by ItemDraw(), and NET_HANDLE().

anim_start_time

float anim_start_time

Definition at line 15 of file items.qc.

Referenced by ewheel_move_idle(), ItemDraw(), turret_construct(), turret_send(), and turrets_setframe().

delay

float delay

Definition at line 17 of file items.qc.

Referenced by dompoint_captured(), dompointthink(), float(), float(), ItemDraw(), racer_blowup_think(), round_handler_Init(), round_handler_Think(), spawnfunc(), spawnfunc(), SUB_UseTargets_Ex(), target_voicescript_use(), trigger_heal_init(), trigger_heal_touch(), trigger_keylock_touch(), W_Blaster_Attack(), W_Electro_Bolt_Think(), W_Electro_Orb_Damage(), and W_Electro_TriggerCombo().

ENT_CLIENT_ITEM_simple

HashMap ENT_CLIENT_ITEM_simple

Definition at line 20 of file items.qc.

Referenced by SHUTDOWN(), and STATIC_INIT().

item_glowmod

vector item_glowmod

Definition at line 11 of file items.qc.

Referenced by ItemDraw().

item_simple

int item_simple

Definition at line 12 of file items.qc.

Referenced by ItemDraw(), ItemSetModel(), and NET_HANDLE().

m_maxs

vector m_maxs

Definition at line 18 of file items.qc.

Referenced by ctf_FlagThink(), ItemDraw(), ItemSetModel(), and NET_HANDLE().

m_mins

vector m_mins

Definition at line 18 of file items.qc.

Referenced by ctf_FlagThink(), ItemDraw(), ItemSetModel(), and NET_HANDLE().

pointtime

float pointtime

Definition at line 17 of file items.qc.

Referenced by classfield(), Draw_ShowNames(), and ItemDraw().

pushable

bool pushable

Definition at line 14 of file items.qc.

Referenced by NET_HANDLE(), spawnfunc(), and spawnfunc().

wait

float wait

Definition at line 17 of file items.qc.

Referenced by bumblebee_diethink(), bumblebee_regen(), button_setactive(), button_wait(), corner_send(), delay_use(), dom_controlpoint_setup(), dompoint_captured(), dompointthink(), door_generic_plat_blocked(), door_go_up(), door_hit_top(), door_init_shared(), door_rotating_go_up(), door_rotating_hit_top(), door_send(), fd_secret_move3(), Item_RespawnThink(), Item_Think(), ItemDraw(), ka_TouchEvent(), M_Mage_Attack_Spike_Think(), monoflop_fixed_use(), monoflop_use(), multi_trigger(), multivibrator_send(), nade_beep(), nade_timer_think(), ons_GeneratorThink(), powerups_DropItem_Think(), raptor_diethink(), round_handler_Reset(), round_handler_Spawn(), round_handler_Think(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spiderbot_rocket_do(), StartItem(), tka_TouchEvent(), train_next(), train_send(), train_wait(), trigger_keylock_touch(), W_MineLayer_Damage(), W_MineLayer_Touch(), and W_Seeker_Missile_Think().