summaryrefslogtreecommitdiff
path: root/src/server/game/Scripting/ScriptDefines/AllCommandScript.h
blob: e56615b1521b6f00493c97541fc3e596c77e54bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/*
 * This file is part of the AzerothCore Project. See AUTHORS file for Copyright information
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Affero 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 Affero 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 SCRIPT_OBJECT_ALL_COMMAND_SCRIPT_H_
#define SCRIPT_OBJECT_ALL_COMMAND_SCRIPT_H_

#include "ScriptObject.h"
#include "ChatCommand.h"
#include <vector>

enum AllCommandHook
{
    ALLCOMMANDHOOK_ON_HANDLE_DEV_COMMAND,
    ALLCOMMANDHOOK_ON_TRY_EXECUTE_COMMAND,
    ALLCOMMANDHOOK_ON_BEFORE_IS_INVOKER_VISIBLE,
    ALLCOMMANDHOOK_END
};

class AllCommandScript : public ScriptObject
{
protected:
    AllCommandScript(const char* name, std::vector<uint16> enabledHooks = std::vector<uint16>());

public:
    [[nodiscard]] bool IsDatabaseBound() const override { return false; }

    virtual void OnHandleDevCommand(Player* /*player*/, bool& /*enable*/) { }

    /**
     * @brief This hook is triggered when a command is parsed, but before it is executed
     *
     * @param handler Contains information about the ChatHandler
     * @param cmdStr Contains information about the command name
     */
    [[nodiscard]] virtual bool OnTryExecuteCommand(ChatHandler& /*handler*/, std::string_view /*cmdStr*/) { return true; }

    [[nodiscard]] virtual bool OnBeforeIsInvokerVisible(std::string /*name*/, Acore::Impl::ChatCommands::CommandPermissions /*permissions*/, ChatHandler const& /*who*/) { return true; }
};

// Compatibility for old scripts
using CommandSC = AllCommandScript;

#endif