attack_process.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef WORLD_ACTORS_ATTACKPROCESS_H
#define WORLD_ACTORS_ATTACKPROCESS_H

#include "ultima/ultima8/kernel/process.h"
#include "ultima/ultima8/misc/direction.h"

#include "common/memstream.h"

namespace Ultima {
namespace Ultima8 {

class Actor;
class CombatDat;

class AttackProcess : public Process {
public:
    AttackProcess();
    AttackProcess(Actor *actor);

    virtual ~AttackProcess();

    ENABLE_RUNTIME_CLASSTYPE()

    void run() override;

    void terminate() override;

    Common::String dumpInfo() const override;

    void setIsActivityAOrB() {
        _isActivityAorB = true;
    }
    void setIsActivity9OrB() {
        _isActivity9orB = true;
    }
    void setField97() {
        _field97 = true;
    }
    void setField7F() {
        _field7f = true;
    }

    void setTimer3();

    uint16 getTarget() const {
        return _target;
    }

    void setTarget(uint16 target) {
        _target = target;
    }

    static int16 getRandomAttackSoundRegret(const Actor *actor);

    bool loadData(Common::ReadStream *rs, uint32 version);
    void saveData(Common::WriteStream *ws) override;

    static const uint16 ATTACK_PROC_TYPE = 0x259;
private:
    void setTacticNo(int block);
    void setBlockNo(int block);

    uint16 readNextWordRaw();
    uint16 readNextWordWithData();

    void setAttackData(uint16 offset, uint16 val);
    uint16 getAttackData(uint16 offset) const;

    void genericAttack();

    void sleep(int ticks);

    bool readyForNextSound(uint32 now);

    bool checkTimer2PlusDelayElapsed(int now);
    void pathfindToItemInNPCData();
    bool timer4and5Update(int now);
    void timeNowToTimerVal2(int now);
    bool checkReady(int now, Direction targetdir);

    void checkRandomAttackSound(int now, uint32 shapeno);

    void checkRandomAttackSoundRegret(const Actor *actor);

    uint16 _target; // TODO: this is stored in NPC in game, does it matter?
    uint16 _tactic;
    uint16 _block;
    uint16 _tacticDatStartOffset;
    const CombatDat *_tacticDat;
    Common::MemoryReadStream *_tacticDatReadStream;

    int16 _soundNo;
    bool _playedStartSound;

    Direction _npcInitialDir;

    // Unknown fields..
    int16 _field57;
    uint16 _field59;
    //uint16 _field53; // Never really used?
    bool _field7f;
    bool _field96;
    bool _field97;

    bool _isActivity9orB;
    bool _isActivityAorB;
    bool _timer2set;
    bool _timer3set;
    bool _doubleDelay;

    uint16 _wpnField8;

    uint16 _dataArray[10];

    int32 _wpnBasedTimeout;
    int32 _difficultyBasedTimeout;

    int32 _timer2; // 0x73/0x75 in orig
    int32 _timer3; // 0x77/0x79 in orig
    int32 _timer4; // 0x6f/0x71 in orig
    int32 _timer5; // 0x8a/0x8c in orig

    uint32 _soundTimestamp; 
    uint32 _soundDelayTicks; 
    int32 _fireTimestamp; 

    // Used in No Regret only, to avoid replaying the same sfx for attack twice in a row.
    static int16 _lastAttackSound;
    static int16 _lastLastAttackSound;

};

} // End of namespace Ultima8
} // End of namespace Ultima

#endif