hook.qh File Reference

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

Go to the source code of this file.

Functions
void	GrapplingHookThink (entity this)
void	RemoveGrapplingHooks (entity pl)
void	RemoveHook (entity this)

Variables
float	autocvar_g_balance_grapplehook_airfriction
bool	autocvar_g_balance_grapplehook_crouchslide
float	autocvar_g_balance_grapplehook_damagedbycontents
float	autocvar_g_balance_grapplehook_force_rubber
float	autocvar_g_balance_grapplehook_force_rubber_overstretch
bool	autocvar_g_balance_grapplehook_gravity
float	autocvar_g_balance_grapplehook_health
float	autocvar_g_balance_grapplehook_length_min
float	autocvar_g_balance_grapplehook_nade_time
int	autocvar_g_balance_grapplehook_pull_frozen
float	autocvar_g_balance_grapplehook_refire
float	autocvar_g_balance_grapplehook_speed_fly
float	autocvar_g_balance_grapplehook_speed_pull
float	autocvar_g_balance_grapplehook_stretch
entity	hook
const float	HOOK_FIRING = BIT(0)
float	hook_length
const float	HOOK_PULLING = BIT(2)
const float	HOOK_RELEASING = BIT(3)
const float	HOOK_REMOVING = BIT(1)
vector	hook_shotorigin [4]
int	hook_state
float	hook_time
const float	HOOK_WAITING_FOR_RELEASE = BIT(4)
int	state

Function Documentation

GrapplingHookThink()

void GrapplingHookThink

(

entity

this

)

Definition at line 106 of file hook.qc.

{
    float spd, dist;
 
    .entity weaponentity = this.weaponentity_fld;
    if(this.realowner.(weaponentity).hook != this) // how did that happen?
    {
        error("Owner lost the hook!\n");
        return;
    }
    if((this.move_movetype == MOVETYPE_FOLLOW && LostMovetypeFollow(this))
        || game_stopped || (round_handler_IsActive() && !round_handler_IsRoundStarted())
        || ((this.aiment.flags & FL_PROJECTILE) && this.aiment.classname != "nade"))
    {
        RemoveHook(this);
        return;
    }
    if(this.aiment)
        WarpZone_RefSys_AddIncrementally(this, this.aiment);
 
    this.nextthink = time;
 
    int s = W_GunAlign(this.realowner.(weaponentity), STAT(GUNALIGN, this.realowner)) - 1;
 
    makevectors(this.realowner.v_angle);
    vector vs = hook_shotorigin[s];
    vs = v_forward * vs.x + v_right * -vs.y + v_up * vs.z;
    vector org = this.realowner.origin + this.realowner.view_ofs + vs;
    vector myorg = WarpZone_RefSys_TransformOrigin(this.realowner, this, org);
 
    if(this.hook_length < 0)
        this.hook_length = vlen(myorg - this.origin);
 
    int tarzan = autocvar_g_grappling_hook_tarzan;
    entity pull_entity = this.realowner;
    float velocity_multiplier = 1;
    MUTATOR_CALLHOOK(GrappleHookThink, this, tarzan, pull_entity, velocity_multiplier);
    tarzan = M_ARGV(1, int);
    pull_entity = M_ARGV(2, entity);
    velocity_multiplier = M_ARGV(3, float);
 
    if(this.state == 1)
    {
        float pullspeed = autocvar_g_balance_grapplehook_speed_pull;
        // speed the rope is pulled with
 
        float rubberforce = autocvar_g_balance_grapplehook_force_rubber;
        // force the rope will use if it is stretched
 
        float rubberforce_overstretch = autocvar_g_balance_grapplehook_force_rubber_overstretch;
        // force the rope will use if it is stretched
 
        float minlength = autocvar_g_balance_grapplehook_length_min;
        // minimal rope length
        // if the rope goes below this length, it isn't pulled any more
 
        float ropestretch = autocvar_g_balance_grapplehook_stretch;
        // if the rope is stretched by more than this amount, more rope is
        // given to you again
 
        float ropeairfriction = autocvar_g_balance_grapplehook_airfriction;
        // while hanging on the rope, this friction component will help you a
        // bit to control the rope
 
        bool frozen_pulling = (autocvar_g_grappling_hook_tarzan >= 2 && autocvar_g_balance_grapplehook_pull_frozen);
        bool target_isfrozen = (STAT(FROZEN, this.aiment) || StatusEffects_active(STATUSEFFECT_Frozen, this.aiment));
 
        vector dir = this.origin - myorg;
        dist = vlen(dir);
 
        // TODO: Consider changing this back to `dir / dist` after https://github.com/graphitemaster/gmqcc/issues/210.
        dir = (dist ? dir * (1 / dist) : '0 0 0'); // same as dir = normalize(dir); but cheaper
 
        if(tarzan)
        {
            vector v, v0;
            v = v0 = WarpZone_RefSys_TransformVelocity(pull_entity, this, pull_entity.velocity);
 
            // first pull the rope...
            if(this.realowner.(weaponentity).hook_state & HOOK_PULLING)
            {
                float newlength = max(this.hook_length - pullspeed * frametime, minlength);
 
                if(newlength < dist - ropestretch) // overstretched?
                {
                    newlength = dist - ropestretch;
                    if(v * dir < 0) // only if not already moving in hook direction
                        v = v + frametime * dir * rubberforce_overstretch;
                }
 
                this.hook_length = newlength;
            }
 
            if(pull_entity.move_movetype == MOVETYPE_FLY)
                set_movetype(pull_entity, MOVETYPE_WALK);
 
            if(this.realowner.(weaponentity).hook_state & HOOK_RELEASING)
            {
                this.hook_length = dist;
            }
            else
            {
                // then pull the player
                spd = bound(0, (dist - this.hook_length) / ropestretch, 1);
                v = v * (1 - frametime * ropeairfriction);
                v = v + frametime * dir * spd * rubberforce;
 
                vector dv = ((v - v0) * dir) * dir;
                if(tarzan >= 2)
                {
                    if(this.aiment.move_movetype == MOVETYPE_WALK || this.aiment.classname == "nade")
                    {
                        entity aim_ent = ((IS_VEHICLE(this.aiment) && this.aiment.owner) ? this.aiment.owner : this.aiment);
                        v = v - dv * 0.5;
                        if((frozen_pulling && target_isfrozen) || !frozen_pulling)
                        {
                            this.aiment.velocity = this.aiment.velocity - dv * 0.5;
                            UNSET_ONGROUND(this.aiment);
                            if(this.aiment.flags & FL_PROJECTILE)
                                UpdateCSQCProjectile(this.aiment);
                        }
                        if(this.aiment.classname == "nade")
                            this.aiment.nextthink = time + autocvar_g_balance_grapplehook_nade_time; // set time after letting go?
                        aim_ent.pusher = this.realowner;
                        aim_ent.pushltime = time + autocvar_g_maxpushtime;
                        aim_ent.istypefrag = PHYS_INPUT_BUTTON_CHAT(aim_ent);
                    }
                }
 
                UNSET_ONGROUND(pull_entity);
            }
 
            if(!frozen_pulling && !(this.aiment.flags & FL_PROJECTILE))
                pull_entity.velocity = WarpZone_RefSys_TransformVelocity(this, pull_entity, v * velocity_multiplier);
 
            if(frozen_pulling && autocvar_g_balance_grapplehook_pull_frozen == 2 && !target_isfrozen)
            {
                RemoveHook(this);
                return;
            }
        }
        else
        {
            vector end = this.origin - dir * 50;
            dist = vlen(end - myorg);
            if(dist < 200)
                spd = dist * (pullspeed / 200);
            else
                spd = pullspeed;
            if(spd < 50)
                spd = 0;
            this.realowner.velocity = dir * spd;
            set_movetype(this.realowner, MOVETYPE_FLY);
 
            UNSET_ONGROUND(this.realowner);
        }
    }
 
    makevectors(this.angles.x * '-1 0 0' + this.angles.y * '0 1 0');
    myorg = WarpZone_RefSys_TransformOrigin(this, this.realowner, this.origin); // + v_forward * (-9);
 
    if(myorg != this.hook_start)
    {
        this.SendFlags |= 2;
        this.hook_start = myorg;
    }
    if(org != this.hook_end)
    {
        this.SendFlags |= 4;
        this.hook_end = org;
    }
}

References aiment, angles, autocvar_g_balance_grapplehook_airfriction, autocvar_g_balance_grapplehook_force_rubber, autocvar_g_balance_grapplehook_force_rubber_overstretch, autocvar_g_balance_grapplehook_length_min, autocvar_g_balance_grapplehook_nade_time, autocvar_g_balance_grapplehook_pull_frozen, autocvar_g_balance_grapplehook_speed_pull, autocvar_g_balance_grapplehook_stretch, autocvar_g_grappling_hook_tarzan, autocvar_g_maxpushtime, bound(), dir, entity(), error, FL_PROJECTILE, frametime, game_stopped, hook_end, hook_length, HOOK_PULLING, HOOK_RELEASING, hook_shotorigin, hook_start, IS_VEHICLE, LostMovetypeFollow(), M_ARGV, makevectors, max(), move_movetype, MOVETYPE_FLY, MOVETYPE_FOLLOW, MOVETYPE_WALK, MUTATOR_CALLHOOK, nextthink, org, origin, PHYS_INPUT_BUTTON_CHAT, realowner, RemoveHook(), round_handler_IsActive, round_handler_IsRoundStarted, SendFlags, set_movetype(), STAT, state, StatusEffects_active(), time, UNSET_ONGROUND, UpdateCSQCProjectile(), v_forward, v_right, v_up, vector, vlen(), W_GunAlign(), WarpZone_RefSys_AddIncrementally(), WarpZone_RefSys_TransformOrigin(), WarpZone_RefSys_TransformVelocity(), and weaponentity_fld.

Referenced by FireGrapplingHook(), and GrapplingHook_Stop().

RemoveGrapplingHooks()

void RemoveGrapplingHooks

(

entity

pl

)

Definition at line 30 of file hook.qc.

{
    if(pl.move_movetype == MOVETYPE_FLY)
        set_movetype(pl, MOVETYPE_WALK);
 
    for(int slot = 0; slot < MAX_WEAPONSLOTS; ++slot)
    {
        .entity weaponentity = weaponentities[slot];
        if(!pl.(weaponentity))
            continue; // continue incase other slots exist?
        if(pl.(weaponentity).hook)
            delete(pl.(weaponentity).hook);
        pl.(weaponentity).hook = NULL;
    }
 
    //pl.disableclientprediction = false;
}

References entity(), hook, MAX_WEAPONSLOTS, MOVETYPE_FLY, MOVETYPE_WALK, NULL, set_movetype(), and weaponentities.

Referenced by bumblebee_gunner_enter(), ClientDisconnect(), freezetag_Freeze(), PlayerDamage(), PutObserverInServer(), target_teleport_use(), Teleport_Touch(), and vehicles_enter().

RemoveHook()

void RemoveHook

(

entity

this

)

Definition at line 48 of file hook.qc.

{
    entity player = this.realowner;
    .entity weaponentity = this.weaponentity_fld;
 
    if(player.(weaponentity).hook == this)
        player.(weaponentity).hook = NULL;
 
    if(player.move_movetype == MOVETYPE_FLY)
        set_movetype(player, MOVETYPE_WALK);
    delete(this);
}

References entity(), hook, MOVETYPE_FLY, MOVETYPE_WALK, NULL, realowner, set_movetype(), and weaponentity_fld.

Referenced by Damage(), freezetag_Freeze(), freezetag_Unfreeze(), GrapplingHook_Damage(), GrapplingHookReset(), GrapplingHookThink(), MUTATOR_HOOKFUNCTION(), vehicles_spawn(), and WarpZone_Projectile_Touch_ImpactFilter_Callback().

Variable Documentation

autocvar_g_balance_grapplehook_airfriction

float autocvar_g_balance_grapplehook_airfriction

Definition at line 3 of file hook.qh.

Referenced by GrapplingHookThink().

autocvar_g_balance_grapplehook_crouchslide

bool autocvar_g_balance_grapplehook_crouchslide

Definition at line 16 of file hook.qh.

autocvar_g_balance_grapplehook_damagedbycontents

float autocvar_g_balance_grapplehook_damagedbycontents

Definition at line 11 of file hook.qh.

Referenced by FireGrapplingHook().

autocvar_g_balance_grapplehook_force_rubber

float autocvar_g_balance_grapplehook_force_rubber

Definition at line 4 of file hook.qh.

Referenced by GrapplingHookThink().

autocvar_g_balance_grapplehook_force_rubber_overstretch

float autocvar_g_balance_grapplehook_force_rubber_overstretch

Definition at line 5 of file hook.qh.

Referenced by GrapplingHookThink().

autocvar_g_balance_grapplehook_gravity

bool autocvar_g_balance_grapplehook_gravity

Definition at line 15 of file hook.qh.

Referenced by FireGrapplingHook().

autocvar_g_balance_grapplehook_health

float autocvar_g_balance_grapplehook_health

Definition at line 6 of file hook.qh.

Referenced by FireGrapplingHook().

autocvar_g_balance_grapplehook_length_min

float autocvar_g_balance_grapplehook_length_min

Definition at line 7 of file hook.qh.

Referenced by GrapplingHookThink().

autocvar_g_balance_grapplehook_nade_time

float autocvar_g_balance_grapplehook_nade_time

Definition at line 14 of file hook.qh.

Referenced by GrapplingHookThink().

autocvar_g_balance_grapplehook_pull_frozen

int autocvar_g_balance_grapplehook_pull_frozen

Definition at line 13 of file hook.qh.

Referenced by GrapplingHookThink().

autocvar_g_balance_grapplehook_refire

float autocvar_g_balance_grapplehook_refire

Definition at line 12 of file hook.qh.

autocvar_g_balance_grapplehook_speed_fly

float autocvar_g_balance_grapplehook_speed_fly

Definition at line 8 of file hook.qh.

Referenced by FireGrapplingHook().

autocvar_g_balance_grapplehook_speed_pull

float autocvar_g_balance_grapplehook_speed_pull

Definition at line 9 of file hook.qh.

Referenced by GrapplingHookThink().

autocvar_g_balance_grapplehook_stretch

float autocvar_g_balance_grapplehook_stretch

Definition at line 10 of file hook.qh.

Referenced by GrapplingHookThink().

hook

entity hook

Definition at line 19 of file hook.qh.

HOOK_FIRING

const float HOOK_FIRING = BIT(0)

Definition at line 27 of file hook.qh.

hook_length

float hook_length

Definition at line 25 of file hook.qh.

Referenced by GrapplingHook_Stop(), and GrapplingHookThink().

HOOK_PULLING

const float HOOK_PULLING = BIT(2)

Definition at line 29 of file hook.qh.

Referenced by GrapplingHookThink().

HOOK_RELEASING

const float HOOK_RELEASING = BIT(3)

Definition at line 30 of file hook.qh.

Referenced by GrapplingHookThink().

HOOK_REMOVING

const float HOOK_REMOVING = BIT(1)

Definition at line 28 of file hook.qh.

hook_shotorigin

vector hook_shotorigin[4]

Definition at line 35 of file hook.qh.

hook_state

int hook_state

Definition at line 32 of file hook.qh.

hook_time

float hook_time

Definition at line 24 of file hook.qh.

HOOK_WAITING_FOR_RELEASE

const float HOOK_WAITING_FOR_RELEASE = BIT(4)

Definition at line 31 of file hook.qh.

state

int state

Definition at line 33 of file hook.qh.