g_utils.cpp

Go to the documentation of this file.

 
/*
All original material Copyright (C) 2002-2025 UFO: Alien Invasion.
 
Original file from Quake 2 v3.21: quake2-2.31/game/g_utils.c
Copyright (C) 1997-2001 Id Software, Inc.
 
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
See the GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
*/
 
#include "g_utils.h"
#include <time.h>
#include "g_client.h"
#include "g_actor.h"
#include "g_edicts.h"
#include "g_trigger.h"

void G_FreeEdict (Edict* ent)
{
    G_EventDestroyEdict(*ent);
 
    /* unlink from world */
    gi.UnlinkEdict(ent);
 
    ent->nativeReset();
    ent->classname = "freed";
    ent->inuse = false;
}

Edict* G_GetEdictFromPos (const pos3_t pos, const entity_type_t type)
{
    Edict* ent = nullptr;
 
    while ((ent = G_EdictsGetNextInUse(ent))) {
        if (type > ET_NULL && ent->type != type)
            continue;
        if (!VectorCompare(pos, ent->pos))
            continue;
 
        return ent;
    }
    /* nothing found at this pos */
    return nullptr;
}

Edict* G_GetEdictFromPosExcluding (const pos3_t pos, const int n, ...)
{
    entity_type_t types[ET_MAX];
    va_list ap;
 
    assert(n > 0);
    assert(n < sizeof(types));
 
    va_start(ap, n);
 
    for (int i = 0; i < n; i++) {
        types[i] = (entity_type_t)va_arg(ap, int);
    }
 
    Edict* ent = nullptr;
    while ((ent = G_EdictsGetNextInUse(ent))) {
        int i;
        for (i = 0; i < n; i++)
            if (ent->type == types[i])
                break;
        if (i != n)
            continue;
        if (VectorCompare(pos, ent->pos))
            return ent;
    }
    /* nothing found at this pos */
    return nullptr;
}

bool G_UseEdict (Edict* ent, Edict* activator)
{
    if (!ent)
        return false;
 
    if (ent->groupMaster)
        ent = ent->groupMaster;
 
    bool status = true;
    /* no use function assigned */
    if (!ent->use) {
        status = false;
    } else if (!ent->use(ent, activator)) {
        status = false;
    }
 
    Edict* chain = ent->groupChain;
    while (chain) {
        if (chain->use)
            chain->use(chain, activator);
        chain = chain->groupChain;
    }
 
    return status;
}

static const objDef_t* G_GetObjectForFiredef (const fireDef_t* fd)
{
    /* For each object ... */
    for (int i = 0; i < gi.csi->numODs; i++) {
        const objDef_t* od = &gi.csi->ods[i];
        /* For each weapon-entry in the object ... */
        for (int j = 0; j < od->numWeapons; j++) {
            /* For each fire-definition in the weapon entry  ... */
            for (int k = 0; k < od->numFiredefs[j]; k++) {
                const fireDef_t* csiFD = &od->fd[j][k];
                if (csiFD == fd)
                    return od;
            }
        }
    }
 
    return nullptr;
}

const char* G_GetWeaponNameForFiredef (const fireDef_t* fd)
{
    const objDef_t* obj = G_GetObjectForFiredef(fd);
    if (!obj)
        return "unknown";
    else
        return obj->id;
}

Player* G_GetPlayerForTeam (int team)
{
    /* search corresponding player (even ai players) */
    Player* p = nullptr;
    while ((p = G_PlayerGetNextActiveHuman(p)))
        if (p->getTeam() == team)
            /* found player */
            return p;
 
    p = nullptr;
    while ((p = G_PlayerGetNextActiveAI(p)))
        if (p->getTeam() == team)
            /* found player */
            return p;
 
    return nullptr;
}

void G_TakeDamage (Edict* ent, int damage)
{
    if (G_IsBreakable(ent) || G_IsActor(ent))
        ent->HP = std::max(ent->HP - damage, 0);
}

static inline void G_TraceDraw (const Line& traceLine)
{
    if (g_drawtraces->integer)
        G_EventParticleSpawn(PM_ALL, "fadeTracerDebug", TRACE_ALL_LEVELS, traceLine.start, traceLine.stop, vec3_origin);
}

bool G_TestLineWithEnts (const vec3_t start, const vec3_t end)
{
    const char* entList[MAX_EDICTS];
    /* generate entity list */
    G_GenerateEntList(entList);
    G_TraceDraw(Line(start, end));
    /* test for visibility */
    return gi.TestLineWithEnt(start, end, TL_FLAG_NONE, entList);
}

bool G_TestLine (const vec3_t start, const vec3_t end)
{
    G_TraceDraw(Line(start, end));
    return gi.TestLine(start, end, TL_FLAG_NONE);
}

trace_t G_Trace (const Line& trLine, const Edict* passent, int contentmask)
{
    static const AABB box;
    G_TraceDraw(trLine);
    return gi.Trace(trLine, box, passent, contentmask);
}

const char* G_GetPlayerName (int pnum)
{
    if (pnum >= game.sv_maxplayersperteam)
        return "";
    return game.players[pnum].pers.netname;
}

playermask_t G_GetClosePlayerMask (const vec3_t origin, float radius)
{
    playermask_t pm = 0;
    Edict* closeActor = nullptr;
    while ((closeActor = G_FindRadius(closeActor, origin, radius))) {
        if (!G_IsLivingActor(closeActor))
            continue;
        pm |= G_TeamToPM(closeActor->getTeam());
    }
    return pm;
}

void G_PrintStats (const char* format, ...)
{
    char buffer[512];
    va_list argptr;
 
    va_start(argptr, format);
    Q_vsnprintf(buffer, sizeof(buffer), format, argptr);
    va_end(argptr);
 
    gi.DPrintf("[STATS] %s\n", buffer);
    if (logstatsfile) {
        char tbuf[32];
        time_t aclock;
 
        time(&aclock);
        const struct tm* t = localtime(&aclock);
 
        Com_sprintf(tbuf, sizeof(tbuf), "%4i/%02i/%02i %02i:%02i:%02i", t->tm_year + 1900,
                t->tm_mon + 1, t->tm_mday, t->tm_hour, t->tm_min, t->tm_sec);
 
        fprintf(logstatsfile, "[STATS] %s - %s\n", tbuf, buffer);
    }
}

void G_PrintActorStats (const Edict* victim, const Edict* attacker, const fireDef_t* fd)
{
    char buffer[512];
 
    if (attacker != nullptr && fd != nullptr) {
        if (victim->getPlayerNum() != attacker->getPlayerNum()) {
            const char* victimName = G_GetPlayerName(victim->getPlayerNum());
            const char* attackerName = G_GetPlayerName(attacker->getPlayerNum());
            if (victimName[0] == '\0') { /* empty string */
                switch (victim->getTeam()) {
                case TEAM_CIVILIAN:
                    victimName = "civilian";
                    break;
                case TEAM_ALIEN:
                    victimName = "alien";
                    break;
                default:
                    victimName = "unknown";
                    break;
                }
            }
            if (attackerName[0] == '\0') { /* empty string */
                switch (attacker->getTeam()) {
                case TEAM_CIVILIAN:
                    attackerName = "civilian";
                    break;
                case TEAM_ALIEN:
                    attackerName = "alien";
                    break;
                default:
                    attackerName = "unknown";
                    break;
                }
            }
            if (!victim->isSameTeamAs(attacker)) {
                Com_sprintf(buffer, sizeof(buffer), "%s (%s) %s %s (%s) with %s of %s (entnum: %i)",
                    attackerName, attacker->chr.name,
                    (victim->HP == 0 ? "kills" : "stuns"),
                    victimName, victim->chr.name, fd->name, G_GetWeaponNameForFiredef(fd), victim->getIdNum());
            } else {
                Com_sprintf(buffer, sizeof(buffer), "%s (%s) %s %s (%s) (teamkill) with %s of %s (entnum: %i)",
                    attackerName, attacker->chr.name,
                    (victim->HP == 0 ? "kills" : "stuns"),
                    victimName, victim->chr.name, fd->name, G_GetWeaponNameForFiredef(fd), victim->getIdNum());
            }
        } else {
            const char* attackerName = G_GetPlayerName(attacker->getPlayerNum());
            Com_sprintf(buffer, sizeof(buffer), "%s %s %s (own team) with %s of %s (entnum: %i)",
                attackerName, (victim->HP == 0 ? "kills" : "stuns"),
                victim->chr.name, fd->name, G_GetWeaponNameForFiredef(fd), victim->getIdNum());
        }
    } else {
        const char* victimName = G_GetPlayerName(victim->getPlayerNum());
        Com_sprintf(buffer, sizeof(buffer), "%s (%s) was %s (entnum: %i)",
            victimName, victim->chr.name, (victim->HP == 0 ? "killed" : "stunned"), victim->getIdNum());
    }
    G_PrintStats("%s", buffer);
}

Edict* G_FindRadius (Edict* from, const vec3_t org, float rad, entity_type_t type)
{
    Edict* ent = from;
 
    while ((ent = G_EdictsGetNextInUse(ent))) {
        vec3_t eorg;
        vec3_t center;
        ent->entBox.getCenter(center);
        for (int j = 0; j < 3; j++)
            eorg[j] = org[j] - (ent->origin[j] + center[j]);
        if (VectorLength(eorg) > rad)
            continue;
        if (type != ET_NULL && ent->type != type)
            continue;
        return ent;
    }
 
    return nullptr;
}
 
#define IS_BMODEL(ent) ((ent)->model && (ent)->model[0] == '*' && (ent)->solid == SOLID_BSP)

void G_GenerateEntList (const char* entList[MAX_EDICTS])
{
    int i = 0;
    Edict* ent = nullptr;
 
    /* generate entity list */
    while ((ent = G_EdictsGetNextInUse(ent)))
        if (IS_BMODEL(ent))
            entList[i++] = ent->model;
    entList[i] = nullptr;
}

void G_RecalcRouting (const char* model, const GridBox& box)
{
    const char* entList[MAX_EDICTS];
    /* generate entity list */
    G_GenerateEntList(entList);
    /* recalculate routing */
    gi.GridRecalcRouting(model, box, entList);
}

void G_CompleteRecalcRouting (void)
{
    double start = time(nullptr);   /* stopwatch */
 
    Edict* ent = nullptr;
    int i = 0;
    while ((ent = G_EdictsGetNextInUse(ent)))
        if (IS_BMODEL(ent)) {
            i++;
            G_RecalcRouting(ent->model, GridBox::EMPTY);
        }
 
    Com_Printf("Rerouted for %i Edicts in %5.2fs\n", i, time(nullptr) - start);
}

static void G_ResetTriggers (Edict* ent, Edict** touched, int num)
{
    Edict* trigger = nullptr;
 
    /* check all edicts to find all triggers */
    while ((trigger = G_EdictsGetNextInUse(trigger))) {
        if (trigger->solid == SOLID_TRIGGER) {
            /* check if our edict is among the known triggerers of this trigger */
            if (G_TriggerIsInList(trigger, ent)) {
                /* if so, check if it still touches it */
                int i;
                for (i = 0; i < num; i++) {
                    if (touched[i] == trigger)
                        break;  /* Yes ! */
                }
                if (i == num) { /* No ! */
                    G_TriggerRemoveFromList(trigger, ent);
                    /* the ent left the trigger area */
                    if (trigger->reset != nullptr)
                        trigger->reset(trigger, ent);
                }
            }
        }
    }
}

static int G_GetTouchingEdicts (const AABB& aabb, Edict** list, int maxCount, Edict* skip)
{
    int num = 0;
 
    /* skip the world */
    Edict* ent = G_EdictsGetFirst();
    while ((ent = G_EdictsGetNextInUse(ent))) {
        /* deactivated */
        if (ent->solid == SOLID_NOT)
            continue;
        if (ent == skip)
            continue;
        if (aabb.doesIntersect(ent->absBox)) {
            list[num++] = ent;
            if (num >= maxCount)
                break;
        }
    }
 
    return num;
}

int G_TouchTriggers (Edict* ent, const entity_type_t type)
{
    Edict* touched[MAX_EDICTS];
 
    if (!G_IsLivingActor(ent))
        return 0;
    Actor* actor = makeActor(ent);
 
    const int num = G_GetTouchingEdicts(actor->absBox, touched, lengthof(touched), actor);
 
    G_ResetTriggers(actor, touched, num);
 
    /* be careful, it is possible to have an entity in this
     * list removed before we get to it (killtriggered) */
    int usedNum = 0;
    for (int i = 0; i < num; i++) {
        Edict* hit = touched[i];
        if (hit->solid != SOLID_TRIGGER)
            continue;
        if (type != ET_NULL && hit->type != type)
            continue;
        if (!hit->hasTouch())
            continue;
        if (hit->dmg == 0 && actor->isStunned())
            continue;
        if (hit->callTouch(actor))
            usedNum++;
        /* now after the use function was executed, we can add the ent to
         * the touched list of the trigger. We do this because we want to be
         * able to check whether another call changes the triggered state for
         * the added entity. We have to do this after the use function was
         * called, because there are triggers that may only be triggered once
         * if someone touches it. */
        G_TriggerAddToList(hit, actor);
    }
    return usedNum;
}

int G_TouchSolids (Edict* ent, float extend)
{
    if (!G_IsLivingActor(ent))
        return 0;
    Actor* actor = makeActor(ent);
 
    AABB absbox(actor->absBox);
    absbox.expand(extend);
 
    Edict* touched[MAX_EDICTS];
    const int num = G_GetTouchingEdicts(absbox, touched, lengthof(touched), actor);
 
    int usedNum = 0;
    /* be careful, it is possible to have an entity in this
     * list removed before we get to it (killtriggered) */
    for (int i = 0; i < num; i++) {
        Edict* hit = touched[i];
        if (hit->solid == SOLID_TRIGGER)
            continue;
        if (!hit->inuse)
            continue;
        if (!hit->hasTouch())
            continue;
        hit->callTouch(actor);
        usedNum++;
    }
    return usedNum;
}

void G_TouchEdicts (Edict* trigger, float extend)
{
    const char* entName = (trigger->model) ? trigger->model : trigger->chr.name;
 
    AABB absbox(trigger->absBox);
    absbox.expand(extend);
 
    Edict* touched[MAX_EDICTS];
    const int num = G_GetTouchingEdicts(absbox, touched, lengthof(touched), trigger);
    Com_DPrintf(DEBUG_GAME, "G_TouchEdicts: Entities touching %s: %i (%f extent).\n", entName, num, extend);
 
    /* be careful, it is possible to have an entity in this
     * list removed before we get to it (killtriggered) */
    for (int i = 0; i < num; i++) {
        Edict* hit = touched[i];
        if (!hit->inuse)
            continue;
        if (trigger->hasTouch())
            trigger->callTouch(hit);
    }
}

uint32_t G_GetLevelFlagsFromPos (const pos3_t pos)
{
    uint32_t levelflags = 0;
    for (int i = 0; i < PATHFINDING_HEIGHT; i++) {
        if (i >= pos[2]) {
            levelflags |= (1 << i);
        }
    }
 
    return levelflags;
}