eqemu-server/world/shared_task_manager.h
hg de63eaa4b2
[Quest API] Add apis to end shared tasks (#2521)
This required some minor shared task refactoring

- Shared task expiration handling was moved to world. Previously this
  was handled by zone and had clients self remove when a shared task
  expired. This resulted in wrong messages when a task ended.

- FailTask is now implemented for shared tasks which previously only
  made the client quit the shared task. It now fails the task for all
  members by ending the shared task.

The `Client::EndSharedTask` api will end the client's current shared
task (removing all members). This is similiar to the `FailTask` api
except it doesn't require a `task_id` and the red task fail banner is
optional (live doesn't use it for shared tasks).

The global `end_dz_task` api was added for when a client context isn't
available. This will end a shared task if the current zone is a dynamic
zone for a shared task mission. Currently only shared tasks use dynamic
zones but this api can be expanded if support is added for tasks/quests.

The global `get_dz_task_id` was added to conveniently get the task id
for the current dynamic zone if it's used for a mission. Note this is
a database hit since that information is not available at zone level.
2022-11-06 11:04:39 -05:00

146 lines
5.7 KiB
C++

#ifndef EQEMU_SHARED_TASK_MANAGER_H
#define EQEMU_SHARED_TASK_MANAGER_H
#include "../common/database.h"
#include "../common/shared_tasks.h"
#include "../common/timer.h"
#include "../common/repositories/character_task_timers_repository.h"
class DynamicZone;
namespace EQ {
namespace Net {
class DynamicPacket;
}
}
struct SharedTaskActiveInvitation {
uint32 shared_task_id;
uint32 character_id;
};
class SharedTaskManager {
public:
SharedTaskManager();
SharedTaskManager *SetDatabase(Database *db);
SharedTaskManager *SetContentDatabase(Database *db);
// loads task data into memory
SharedTaskManager *LoadTaskData();
// loads shared task state into memory
void LoadSharedTaskState();
// helper, references task memory data
TasksRepository::Tasks GetSharedTaskDataByTaskId(uint32 task_id);
std::vector<TaskActivitiesRepository::TaskActivities> GetSharedTaskActivityDataByTaskId(uint32 task_id);
// client attempting to create a shared task
void AttemptSharedTaskCreation(uint32 requested_task_id, uint32 requested_character_id, uint32 npc_type_id);
// shared task activity update middleware
void SharedTaskActivityUpdate(
uint32 source_character_id,
uint32 task_id,
uint32 activity_id,
uint32 done_count,
bool ignore_quest_update
);
SharedTask *FindSharedTaskByTaskIdAndCharacterId(uint32 task_id, uint32 character_id);
SharedTask *FindSharedTaskById(int64 shared_task_id);
SharedTask* FindSharedTaskByDzId(uint32_t dz_id);
void DeleteSharedTask(int64 shared_task_id);
void SaveSharedTaskActivityState(int64 shared_task_id, std::vector<SharedTaskActivityStateEntry> activity_state);
bool IsSharedTaskLeader(SharedTask *s, uint32 character_id);
void LockTask(SharedTask* s, bool lock);
void SendAcceptNewSharedTaskPacket(uint32 character_id, uint32 task_id, uint32_t npc_context_id, int accept_time);
void SendRemovePlayerFromSharedTaskPacket(uint32 character_id, uint32 task_id, bool remove_from_db);
void SendSharedTaskFailed(uint32_t character_id, uint32_t task_id);
void SendSharedTaskMemberList(uint32 character_id, const std::vector<SharedTaskMember> &members);
void SendSharedTaskMemberList(uint32 character_id, const EQ::Net::DynamicPacket &serialized_members);
void SendSharedTaskMemberChange(
uint32 character_id,
int64 shared_task_id,
const std::string &player_name,
bool removed
);
void RemovePlayerFromSharedTask(SharedTask *s, uint32 character_id);
void PrintSharedTaskState();
void Process();
void RemoveMember(SharedTask* s, const SharedTaskMember& member, bool remove_from_db);
void RemoveEveryoneFromSharedTask(SharedTask *s, uint32 requested_character_id);
// caller is responsible for removing from db/cache if erase is false
void Terminate(SharedTask& s, bool send_fail, bool erase);
void MakeLeaderByPlayerName(SharedTask *s, const std::string &character_name);
void AddPlayerByCharacterIdAndName(SharedTask *s, int64 character_id, const std::string &character_name);
void InvitePlayerByPlayerName(SharedTask *s, const std::string &player_name);
// invitations
void QueueActiveInvitation(int64 shared_task_id, int64 character_id);
bool IsInvitationActive(uint32 shared_task_id, uint32 character_id);
void RemoveActiveInvitation(int64 shared_task_id, int64 character_id);
void RemoveActiveInvitationByCharacterID(uint32_t character_id);
// dz
void CreateDynamicZone(SharedTask *s, DynamicZone &dz_request);
void PurgeAllSharedTasks();
// messages
void SendLeaderMessage(SharedTask *s, int chat_type, const std::string &message);
void SendLeaderMessageID(SharedTask *s, int chat_type, int eqstr_id, std::initializer_list<std::string> args = {});
void SendMembersMessage(SharedTask *s, int chat_type, const std::string &message);
void SendMembersMessageID(SharedTask *s, int chat_type, int eqstr_id, std::initializer_list<std::string> args = {});
const std::vector<SharedTask> &GetSharedTasks() const;
void SetSharedTasks(const std::vector<SharedTask> &shared_tasks);
SharedTaskManager * PurgeExpiredSharedTasks();
protected:
// reference to database
Database *m_database;
Database *m_content_database;
// reference to task data (all)
std::vector<TasksRepository::Tasks> m_task_data{};
std::vector<TaskActivitiesRepository::TaskActivities> m_task_activity_data{};
// internal shared tasks list
std::vector<SharedTask> m_shared_tasks{};
// store a reference of active invitations that have been sent to players
std::vector<SharedTaskActiveInvitation> m_active_invitations{};
Timer m_process_timer;
std::vector<CharacterTaskTimersRepository::CharacterTaskTimers> GetCharacterTimers(
const std::vector<uint32_t>& character_ids, const TasksRepository::Tasks& task);
void AddReplayTimers(SharedTask *s);
bool CanAddPlayer(SharedTask *s, uint32_t character_id, std::string player_name, bool accepted);
bool CanRequestSharedTask(uint32_t task_id, const SharedTaskRequest& request);
void ChooseNewLeader(SharedTask *s);
bool HandleCompletedActivities(SharedTask* s);
void HandleCompletedTask(SharedTask* s);
void LoadDynamicZoneTemplate(SharedTask* s);
void SendSharedTaskMemberListToAllMembers(SharedTask *s);
void SendSharedTaskMemberAddedToAllMembers(SharedTask *s, const std::string &player_name);
void SendSharedTaskMemberRemovedToAllMembers(SharedTask *s, const std::string &player_name);
void SaveMembers(SharedTask *s, std::vector<SharedTaskMember> members);
void SendSharedTaskInvitePacket(SharedTask *s, int64 invited_character_id);
void RecordSharedTaskCompletion(SharedTask *s);
void RemoveAllMembersFromDynamicZones(SharedTask *s);
void StartTerminateTimer(SharedTask* s);
// memory search
std::vector<SharedTaskMember> FindCharactersInSharedTasks(const std::vector<uint32_t> &find_characters);
};
#endif //EQEMU_SHARED_TASK_MANAGER_H