g_actor.cpp

Go to the documentation of this file.

/*
Copyright (C) 2002-2020 UFO: Alien Invasion.

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_actor.h"
#include "g_client.h"
#include "g_edicts.h"
#include "g_health.h"
#include "g_inventory.h"
#include "g_reaction.h"
#include "g_spawn.h"
#include "g_utils.h"
#include "g_vis.h"

/* however we manipulate TUs, this value must never be exceeded */
#define MAX_TU              (ROUTING_NOT_REACHABLE - 1)

bool G_IsLivingActor (const Edict* ent)
{
    return G_IsActor(ent) && (G_IsStunned(ent) || !G_IsDead(ent));
}

void G_ActorUseDoor (Actor* actor, Edict* door)
{
    /* check whether it's part of an edict group but not the master */
    if (door->flags & FL_GROUPSLAVE)
        door = door->groupMaster;

    if (!G_ClientUseEdict(actor->getPlayer(), actor, door))
        return;

    /* end this loop here, for the AI this is a) not interesting,
     * and b) could result in endless loops */
    if (G_IsAI(actor))
        return;

    Edict* closeActor = nullptr;
    while ((closeActor = G_FindRadius(closeActor, door->origin, UNIT_SIZE * 3))) {
        /* check whether the door is still reachable (this might have
         * changed due to the rotation) or whether an actor can reach it now */
        G_TouchTriggers(closeActor);
    }
}

void G_ActorSetClientAction (Edict* actor, Edict* ent)
{
    if (actor->clientAction == ent)
        return;

    assert(ent == nullptr || (ent->flags & FL_CLIENTACTION));
    actor->clientAction = ent;
    if (ent == nullptr) {
        G_EventResetClientAction(*actor);
    } else {
        G_EventSetClientAction(*actor);
    }
}

int G_ActorUsableTUs (const Edict* ent)
{
    if (!ent)
        return 0;

    return ent->getTus() - ent->getReservedTUs();
}

int G_ActorGetTUForReactionFire (const Edict* ent)
{
    const FiremodeSettings* fm = &ent->chr.RFmode;

    const Item* weapon = ent->getHandItem(fm->getHand());
    assert(weapon);
    assert(weapon->def());

    const fireDef_t* fd = weapon->getFiredefs();
    assert(fd);
    return G_ActorGetModifiedTimeForFiredef(ent, &fd[fm->getFmIdx()], false);
}

void G_ActorReserveTUs (Edict* ent, int resReaction, int resShot, int resCrouch)
{
    if (ent->getTus() >= resReaction + resShot + resCrouch) {
        ent->chr.reservedTus.reaction = resReaction;
        ent->chr.reservedTus.shot = resShot;
        ent->chr.reservedTus.crouch = resCrouch;
    }

    G_EventActorSendReservations(*ent);
}

int G_ActorDoTurn (Edict* ent, byte dir)
{
    assert(ent->dir < CORE_DIRECTIONS);
    assert(dir < PATHFINDING_DIRECTIONS);

    /*
     * If dir is at least CORE_DIRECTIONS but less than FLYING_DIRECTIONS,
     * then the direction is an action.
     */
    if (dir >= CORE_DIRECTIONS && dir < FLYING_DIRECTIONS)
        return 0;

    /* Clamp dir between 0 and CORE_DIRECTIONS - 1. */
    dir &= (CORE_DIRECTIONS - 1);
    assert(dir < CORE_DIRECTIONS);

    /* Return if no rotation needs to be done. */
    if (ent->dir == dir)
        return 0;

    /* calculate angle difference */
    float angleDiv = directionAngles[dir] - directionAngles[ent->dir];
    if (angleDiv > 180.0)
        angleDiv -= 360.0;
    if (angleDiv < -180.0)
        angleDiv += 360.0;

    /* prepare rotation - decide whether the actor turns around the left
     * shoulder or the right - this is needed the get the rotation vector
     * that is used below to check in each of the rotation steps
     * (1/8, 22.5 degree) whether something became visible while turning */
    const byte* rot;
    int num;
    if (angleDiv > 0) {
        const int angleStep = (360.0 / CORE_DIRECTIONS);
        rot = dvleft;
        num = (angleDiv + angleStep / 2) / angleStep;
    } else {
        const int angleStep = (360.0 / CORE_DIRECTIONS);
        rot = dvright;
        num = (-angleDiv + angleStep / 2) / angleStep;
    }

    /* do rotation and vis checks */
    int status = 0;

    /* check every angle (1/8 steps - on the way to the end direction) in the rotation
     * whether something becomes visible and stop before reaching the final direction
     * if this happened */
    for (int i = 0; i < num; i++) {
        ent->dir = rot[ent->dir];
        assert(ent->dir < CORE_DIRECTIONS);
        status |= G_CheckVisTeamAll(ent->getTeam(), 0, ent);
    }

    if (status & VIS_STOP) {
        /* send the turn */
        G_EventActorTurn(*ent);
    }

    return status;
}

void G_ActorSetMaxs (Actor* actor)
{
    switch (actor->type) {
    case ET_ACTOR:
        actor->entBox.setMaxs(PLAYER_WIDTH, PLAYER_WIDTH, PLAYER_STAND);
        break;
    case ET_ACTOR2x2:
        actor->entBox.setMaxs(PLAYER2x2_WIDTH, PLAYER2x2_WIDTH, PLAYER_STAND);
        break;
    default:
        gi.Error("G_ActorSetMaxs: Unknown actor type: %i (ent %i)", actor->type, actor->getIdNum());
    }
    if (actor->isCrouched())
        actor->entBox.setMaxZ(PLAYER_CROUCH);
    else if (actor->isDead() && !CHRSH_IsTeamDefRobot(actor->chr.teamDef))
        actor->entBox.setMaxZ(PLAYER_DEAD);

    /* Link it. */
    gi.LinkEdict(actor);
}

int G_ActorCalculateMaxTU (const Edict* ent)
{
    const int invWeight = ent->chr.inv.getWeight();
    const int currentMaxTU = GET_TU(ent->chr.score.skills[ABILITY_SPEED], GET_ENCUMBRANCE_PENALTY(invWeight,
            ent->chr.score.skills[ABILITY_POWER])) * G_ActorGetInjuryPenalty(ent, MODIFIER_TU);

    return std::min(currentMaxTU, MAX_TU);
}

void G_ActorGiveTimeUnits (Actor* actor)
{
    const int tus = actor->isDazed() ? 0 : G_ActorCalculateMaxTU(actor);
    G_ActorSetTU(actor, tus);
    actor->removeDazed();
}

void G_ActorSetTU (Edict* ent, int tus)
{
    if (tus > 0 && tus < ent->getTus()) {
        if (g_notu != nullptr && g_notu->integer) {
            ent->setTus(G_ActorCalculateMaxTU(ent));
            return;
        }
    }
    ent->setTus(std::max(tus, 0));
}

void G_ActorUseTU (Edict* ent, int tus)
{
    G_ActorSetTU(ent, ent->getTus() - tus);
}

static bool G_ActorStun (Actor* actor, const Edict* attacker)
{
    /* already dead or stunned? */
    if (actor->isDead())
        return false;

    /* no other state should be set here */
    actor->state = STATE_STUN;
    G_ActorSetMaxs(actor);
    actor->link = attacker;

    G_ActorModifyCounters(attacker, actor, -1, 0, 1);

    return true;
}

void G_ActorModifyCounters (const Edict* attacker, const Edict* victim, int deltaAlive, int deltaKills, int deltaStuns)
{
    const int victimTeam = victim->getTeam();
    const unsigned spawned = level.num_spawned[victimTeam];
    const int attackerTeam = (attacker != nullptr ? attacker->getTeam() : MAX_TEAMS);
    byte* alive = level.num_alive;

    alive[victimTeam] += deltaAlive;
    if (alive[victimTeam] > spawned)
        gi.Error("alive counter out of sync");

    if (deltaStuns != 0) {
        unsigned* stuns = level.num_stuns[attackerTeam];
        stuns[victimTeam] += deltaStuns;
        if (stuns[victimTeam] > spawned)
            gi.Error("stuns counter out of sync");
    }

    if (deltaKills != 0) {
        unsigned* kills = level.num_kills[attackerTeam];
        kills[victimTeam] += deltaKills;
        if (kills[victimTeam] > spawned)
            gi.Error("kills counter out of sync");
    }
#if 0
    {
        Com_Printf("num_spawned: %i\n", spawned);

        if (attacker)
        for (int i = 0; i < MAX_TEAMS; i++) {
            if (i == victimTeam) {
                Com_Printf("^2num_alive (team %i): %i\n", i, level.num_alive[i]);
            } else {
                Com_Printf("num_alive (team %i): %i\n", i, level.num_alive[i]);
            }

            for (int j = 0; j < MAX_TEAMS; j++) {
                if (j == victimTeam) {
                    Com_Printf("^2num_kills (team %i killed  %i): %i\n", i, j, level.num_kills[i][j]);
                    Com_Printf("^2num_stuns (team %i stunned %i): %i\n", i, j, level.num_stuns[i][j]);
                } else if (i == attacker->team) {
                    Com_Printf("^3num_kills (team %i killed  %i): %i\n", i, j, level.num_kills[i][j]);
                    Com_Printf("^3num_stuns (team %i stunned %i): %i\n", i, j, level.num_stuns[i][j]);
                } else {
                    Com_Printf("num_kills (team %i killed  %i): %i\n", i, j, level.num_kills[i][j]);
                    Com_Printf("num_stuns (team %i stunned %i): %i\n", i, j, level.num_stuns[i][j]);
                }
            }
        }
    }
#endif
}

void G_ActorGetEyeVector (const Edict* actor, vec3_t eye)
{
    VectorCopy(actor->origin, eye);
    if (G_IsCrouched(actor) || G_IsPanicked(actor))
        eye[2] += EYE_CROUCH;
    else
        eye[2] += EYE_STAND;
}

static void G_ActorRevitalise (Actor* actor)
{
    if (actor->isStunned()) {
        actor->removeStunned();
        G_ActorModifyCounters(actor->link, actor, 1, 0, -1);
        G_GetFloorItems(actor);
    }
    G_ActorSetMaxs(actor);

    /* check if the player appears/perishes, seen from other teams */
    G_CheckVis(actor);

    /* calc new vis for this player */
    G_CheckVisTeamAll(actor->getTeam(), 0, actor);

    G_PrintStats("%s is revitalized.", actor->chr.name);
}

void G_ActorCheckRevitalise (Actor* actor)
{
    if (actor->isStunned() && actor->getStun() < actor->HP) {
        /* check that we could move after we stood up */
        Edict* otherActor = nullptr;
        while ((otherActor = G_EdictsGetNextInUse(otherActor))) {
            if (!VectorCompare(actor->pos, otherActor->pos))
                continue;
            if (G_IsBlockingMovementActor(otherActor))
                return;
        }

        G_ActorRevitalise(actor);
        G_EventActorRevitalise(*actor);
        G_EventActorStateChange(~G_VisToPM(actor->visflags), *actor);
        G_SendStats(*actor);
    }
}

static bool G_ActorDie (Actor* actor, const Edict* attacker)
{
    const bool stunned = actor->isStunned();

    actor->removeStunned();

    if (actor->isDead())
        return false;

    G_SetState(actor, 1 + rand() % MAX_DEATH);
    G_ActorSetMaxs(actor);

    if (stunned) {
        G_ActorModifyCounters(attacker, actor, 0, 1, 0);
        G_ActorModifyCounters(actor->link, actor, 0, 0, -1);
    } else {
        G_ActorModifyCounters(attacker, actor, -1, 1, 0);
    }

    return true;
}

bool G_ActorDieOrStun (Actor* actor, Edict* attacker)
{
    bool state;

    if (actor->HP == 0)
        state = G_ActorDie(actor, attacker);
    else
        state = G_ActorStun(actor, attacker);

    /* no state change performed? */
    if (!state) {
        gi.DPrintf("G_ActorDieOrStun: State wasn't changed\n");
        return false;
    }

    if (!actor->isStunned())
        actor->solid = SOLID_NOT;

    /* send death */
    G_EventActorDie(*actor, attacker != nullptr);
    G_EventActorStateChange(~G_VisToPM(actor->visflags), *actor);

    /* handle inventory - drop everything but the armour to the floor */
    G_InventoryToFloor(actor);
    G_ClientStateChange(actor->getPlayer(), actor, ~STATE_REACTION, false);

    /* check if the player appears/perishes, seen from other teams */
    G_CheckVis(actor);

    /* check if the attacker appears/perishes, seen from other teams */
    if (attacker)
        G_CheckVis(attacker);

    /* calc new vis for this player */
    G_CheckVisTeamAll(actor->getTeam(), 0, attacker);

    /* unlink the floor container */
    actor->resetFloor();

    G_ReactionFireOnDead(actor);
    if (!actor->isStunned())
        G_ReactionFireTargetsDestroy(actor);

    return true;
}

int G_ActorGetContentFlags (const vec3_t origin)
{
    vec3_t pointTrace;

    VectorCopy(origin, pointTrace);
    pointTrace[2] += PLAYER_MIN;

    return gi.PointContents(pointTrace);
}

bool G_ActorInvMove (Actor* actor, const invDef_t* fromContType, Item* fItem, const invDef_t* toContType, int tx, int ty, bool checkaction)
{
    assert(fItem);
    assert(fItem->def());

    /* Store the location/item of 'from' BEFORE actually moving items with moveInInventory. */
    Item fromItemBackup = *fItem;

    /* Store the location of 'to' BEFORE actually moving items with moveInInventory
     * so in case we swap ammo the client can be updated correctly */
    Item* tc = actor->chr.inv.getItemAtPos(toContType, tx, ty);
    Item toItemBackup;
    if (tc)
        toItemBackup = *tc;
    else
        toItemBackup = *fItem;

    /* Get first used bit in item. */
    int fx, fy;
    fItem->getFirstShapePosition(&fx, &fy);
    fx += fItem->getX();
    fy += fItem->getY();

    /* Check if action is possible */
    /* TUs are 1 here - but this is only a dummy - the real TU check is done in the inventory functions below */
    Player& player = actor->getPlayer();
    if (checkaction && !G_ActionCheckForCurrentTeam(player, actor, 1))
        return false;

    if (!actor->chr.inv.canHoldItemWeight(fromContType->id, toContType->id, *fItem, actor->chr.score.skills[ABILITY_POWER])) {
        G_ClientPrintf(player, PRINT_HUD, _("This soldier can not carry anything else."));
        return false;
    }

    /* "get floor ready" - searching for existing floor-edict */
    Edict* floor = G_GetFloorItems(actor);
    bool newFloor = false;
    if (toContType->isFloorDef() && !floor) {
        /* We are moving to the floor, but no existing edict for this floor-tile found -> create new one */
        floor = G_SpawnFloor(actor->pos);
        newFloor = true;
    } else if (fromContType->isFloorDef() && !floor) {
        /* We are moving from the floor, but no existing edict for this floor-tile found -> this should never be the case. */
        gi.DPrintf("G_ClientInvMove: No source-floor found.\n");
        return false;
    }

    /* search for space */
    Item* item2;
    if (tx == NONE) {
        item2 = actor->chr.inv.getItemAtPos(fromContType, fItem->getX(), fItem->getY());
        if (item2)
            actor->chr.inv.findSpace(toContType, item2, &tx, &ty, fItem);
        if (tx == NONE)
            return false;
    }

    /* Because moveInInventory don't know anything about character_t and it updates actor->TU,
     * we need to save original actor->TU for the sake of checking TU reservations. */
    int originalTU = actor->getTus();
    int reservedTU = actor->getReservedTUs();
    /* Temporary decrease actor->TU to make moveInInventory do what expected. */
    G_ActorUseTU(actor, reservedTU);
    /* Try to actually move the item and check the return value after restoring valid actor->TU. */
    inventory_action_t ia;
    ia = game.invi.moveInInventory(&actor->chr.inv, fromContType, fItem, toContType, tx, ty, checkaction ? &actor->TU : nullptr, &item2);
    /* Now restore the original actor->TU and decrease it for TU used for inventory move. */
    G_ActorSetTU(actor, originalTU - (originalTU - reservedTU - actor->getTus()));

    switch (ia) {
    case IA_NONE:
        /* No action possible - abort */
        return false;
    case IA_NOTIME:
        G_ClientPrintf(player, PRINT_HUD, _("Can't perform action - not enough TUs!"));
        /* New floor was created, inventory move was aborted, delete empty the floor */
        if (newFloor) {
            G_FreeEdict(floor);
        }
        return false;
    case IA_NORELOAD:
        G_ClientPrintf(player, PRINT_HUD,
                _("Can't perform action - weapon already fully loaded with the same ammunition!"));
        return false;
    default:
        /* Continue below. */
        break;
    }

    /* successful inventory change; remove the item in clients */
    if (fromContType->isFloorDef()) {
        /* We removed an item from the floor - check how the client
         * needs to be updated. */
        assert(!newFloor);
        if (actor->getFloor()) {
            /* There is still something on the floor. */
            floor->setFloor(actor);
            /* Delay this if swapping ammo, otherwise the le will be removed in the client before we can add back
             * the current ammo because removeNextFrame is set in LE_PlaceItem() if the floor le has no items */
            if (ia != IA_RELOAD_SWAP)
                G_EventInventoryDelete(*floor, G_VisToPM(floor->visflags), fromContType->id, fx, fy);
        } else {
            /* Floor is empty, remove the edict (from server + client) if we are
             * not moving to it. */
            if (!toContType->isFloorDef()) {
                G_EventPerish(*floor);
                G_FreeEdict(floor);
            } else
                G_EventInventoryDelete(*floor, G_VisToPM(floor->visflags), fromContType->id, fx, fy);
        }
    } else {
        G_EventInventoryDelete(*actor, G_TeamToPM(actor->getTeam()), fromContType->id, fx, fy);
    }

    /* send tu's */
    G_SendStats(*actor);

    assert(item2);
    Item item = *item2;
    playermask_t mask;

    if (ia == IA_RELOAD || ia == IA_RELOAD_SWAP) {
        /* reload */
        if (toContType->isFloorDef())
            mask = G_VisToPM(floor->visflags);
        else
            mask = G_TeamToPM(actor->getTeam());

        G_EventInventoryReload(toContType->isFloorDef() ? *floor : *actor, mask, &item, toContType, item2);

        if (ia == IA_RELOAD) {
            return true;
        } else { /* ia == IA_RELOAD_SWAP */
            item.setAmmoLeft(NONE_AMMO);
            item.setAmmoDef(nullptr);
            item.setDef(toItemBackup.ammoDef());
            item.rotated = fromItemBackup.rotated;
            item.setAmount(toItemBackup.getAmount());
            toContType = fromContType;
            if (toContType->isFloorDef()) {
                /* moveInInventory placed the swapped ammo in an available space, check where it was placed
                 * so we can place it at the same place in the client, otherwise since fItem hasn't been removed
                 * this could end in a different place in the client - will cause an error if trying to use it again */
                item2 = actor->chr.inv.findInContainer(toContType->id, &item);
                assert(item2);
                fromItemBackup = item;
                fromItemBackup.setX(item2->getX());
                fromItemBackup.setY(item2->getY());
            }
            tx = fromItemBackup.getX();
            ty = fromItemBackup.getY();
        }
    }

    /* We moved an item to the floor - check how the client needs to be updated. */
    if (toContType->isFloorDef()) {
        /* we have to link the temp floor container to the new floor edict or add
         * the item to an already existing floor edict - the floor container that
         * is already linked might be from a different entity (this might happen
         * in case of a throw by another actor) */
        floor->setFloor(actor);

        /* A new container was created for the floor. */
        if (newFloor) {
            /* Send item info to the clients */
            G_CheckVis(floor);
        } else {
            /* use the backup item to use the old amount values, because the clients have to use the same actions
             * on the original amount. Otherwise they would end in a different amount of items as the server (+1) */
            G_EventInventoryAdd(*floor, G_VisToPM(floor->visflags), 1);
            G_WriteItem(fromItemBackup, toContType->id, tx, ty);
            G_EventEnd();
            /* Couldn't remove it before because that would remove the le from the client and would cause battlescape to crash
             * when trying to add back the swapped ammo above */
            if (ia == IA_RELOAD_SWAP)
                G_EventInventoryDelete(*floor, G_VisToPM(floor->visflags), fromContType->id, fx, fy);
        }
    } else {
        G_EventInventoryAdd(*actor, G_TeamToPM(actor->getTeam()), 1);
        G_WriteItem(item, toContType->id, tx, ty);
        G_EventEnd();
    }

    G_ReactionFireSettingsUpdate(actor, actor->chr.RFmode.getFmIdx(), actor->chr.RFmode.getHand(), actor->chr.RFmode.getWeapon());

    /* Other players receive weapon info only. */
    mask = G_VisToPM(actor->visflags) & ~G_TeamToPM(actor->getTeam());
    if (mask) {
        if (fromContType->isRightDef() || fromContType->isLeftDef()) {
            G_EventInventoryDelete(*actor, mask, fromContType->id, fx, fy);
        }
        if (toContType->isRightDef() || toContType->isLeftDef()) {
            G_EventInventoryAdd(*actor, mask, 1);
            G_WriteItem(item, toContType->id, tx, ty);
            G_EventEnd();
        }
    }

    return true;
}

bool G_ActorReload (Actor* actor, const invDef_t* invDef)
{
    const objDef_t* weapon;

    if (actor->getContainer(invDef->id)) {
        weapon = actor->getContainer(invDef->id)->def();
    } else if (invDef->isLeftDef() && actor->getRightHandItem()->isHeldTwoHanded()) {
        /* Check for two-handed weapon */
        invDef = INVDEF(CID_RIGHT);
        weapon = actor->getRightHandItem()->def();
    } else
        return false;

    assert(weapon);

    /* LordHavoc: Check if item is researched when in singleplayer? I don't think this is really a
     * cheat issue as in singleplayer there is no way to inject fake client commands in the virtual
     * network buffer, and in multiplayer everything is researched */

    /* search for clips and select the one that is available easily */
    /* also try the temp containers */
    const invDef_t* bestContainer = nullptr;
    Item* ammoItem = nullptr;
    int tu = 100;
    const Container* cont = nullptr;
    while ((cont = actor->chr.inv.getNextCont(cont, true))) {
        if (cont->def()->out >= tu)
            continue;
        /* Once we've found at least one clip, there's no point
         * searching other containers if it would take longer
         * to retrieve the ammo from them than the one
         * we've already found. */
        Item* item = nullptr;
        while ((item = cont->getNextItem(item))) {
            if (item->def()->isLoadableInWeapon(weapon)) {
                ammoItem = item;
                bestContainer = INVDEF(cont->id);
                tu = bestContainer->out;
                break;
            }
        }
    }

    /* send request */
    if (bestContainer)
        return G_ActorInvMove(actor, bestContainer, ammoItem, invDef, 0, 0, true);
    /* No ammo found */
    return false;
}

int G_ActorGetModifiedTimeForFiredef (const Edict* const ent, const fireDef_t* const fd, const bool reaction)
{
    return fd->time * G_ActorGetInjuryPenalty(ent, reaction ? MODIFIER_REACTION : MODIFIER_SHOOTING);
}