Система автоматической обработки команд чата [v1.4] [final]

CommandSystem_RegisterCommand("open", "OpenHandler");

#include "cj_types.j"

/* === Система игровых команд ===
        ~ Автор: DDarkSniper
        ~ Дата: 8.05.2013
        ~ Дополнение: 3.01.2014
   Описание:
        Система игровых команд позволяет с удобством управлять 
        вводимыми с клавиатуры командами 
*/
    
library CommandSystem initializer init {

    define {
        CheckString(s) = (s != null and s != "")
    
        MaxParamCount   = 5    // макс. кол-во параметров для одной команды
        MaxCommandCount = 100  // макс. кол-во команд, хранимых в словаре системы
        MinInputLength  = 3    // мин. длина сообщения, в котором может содержаться команда (+1 для добавляемого пробела)
        
        PermissionException = "You have not enough permission to execute this command" 
        CommandException    = "Wrong command"
        DisabledException   = "Requested command is unavailable at this moment"
        
        CommandPrefix       = "-"  // префикс команды (знак ее начала)   
        
        ShowListeningMessage = true
        
        ListeningEnabled   = "Now you can type commands in your chat window"
        ListeningDisabled  = "You can not type any chat commands anymore"
        
        CommandKey = StringHash("Commands") // Ключ хранения обработчиков в хеш-таблице
        StateKey   = StringHash("State")
    }

    // ==== свойства ====
    public string Command;      // название команды, обрабатываемой в данный момент
    public player Source;       // источник (игрок, вызывавший команду)
        
    public bool   HasParams;                // были ли при вызове команды указаны параметры 
    public int    ParamCount;               // кол-во указанных параметров (0, если нет)

    public string Params[MaxParamCount];    // параметры вызова команды (отделяются пробелами)    
    
    // === доп.свйоства ===
    public trigger CommandDetector;     // триггер, отвечающий на команды (возможно переопределение)
    public int     CommandCount;        // кол-во зарегистрированных команд в системе
    
    
    // === поля (внутренние переменные) ===
    private hashtable database;
    private string command;
    private force RegistredPlayers;           // игроки, которые могут вводить команды
    
    // ==== методы ====
    // определение вывода сообщения игроку (можно переопределить для создания эффектов)
    private void DisplayMessage(player p, string text) {
        DisplayTextToPlayer(p, 0, 0, text);
    }
    
    /* [GetCommand] returns string
       | Описание: возвращает обработчик команды по ее имени
       | Параметры:
       |     ~ name [string] - имя команды (без префикса)
       | Пример вызова:
       |    string hide = CommandSystem_GetCommand("hide");
    */
    public string GetCommand(string name) {
        if (CheckString(name) and database != null) {
            return LoadStr(database, CommandKey, StringHash(name));
        } return null;
    }
    
    /* [ContainsCommand] returns boolean
       | Описание: показыавет, содержится ли команда с указанным именем в системе
       | Параметры:
       |     ~ name [string] - имя команды (без префикса)
       | Пример вызова:
       |    if (CommandSystem_ContainsCommand("shot")) { ... }
    */
    public bool HasCommand(string name) {
        return CheckString(GetCommand(name));
    }
        
    /* [HasAccess] returns boolean
       | Описание: показыавет, содержится ли команда с указанным именем в системе
       | Параметры:
       |     ~ name [string] - имя команды (без префикса)
       |     ~ p [player] - игрок, для которого проверяется наличие доступа
       | Пример вызова:
       |    if (CommandSystem_HasAccess("share", Player(0))) { ... }
    */
    public bool HasAccess(string name, player p) {
        if (HasCommand(name) and p != null) {
            // возвращается противоположное значение, т.к при отсутсвии записи нужно вернуть True
            return not LoadBoolean(database, StringHash("Access" + I2S(GetPlayerId(p))), StringHash(name));
        } return false;
    }
    
    /* [SetAccess] returns nothing
       | Описание: устанавливает состояние доступа для указанного игрока
       | Параметры:
       |     ~ name [string] - имя команды (без префикса)
       |     ~ p [player] - игрок, для которого устанавливается доступ
       |     ~ hasAccess [boolean] - получит ли игрок доступ 
       | Пример вызова:
       |    CommandSystem_SetAccess("vote", Player(0), false);
    */
    public void SetAccess(string name, player p, bool hasAccess) {
        if (HasCommand(name) and p != null) {
            SaveBoolean(database, StringHash("Access" + I2S(GetPlayerId(p))), StringHash(name), not hasAccess);
        }
    }
    
    /* [ResetAccess] returns nothing
       | Описание: сбрасывает настройки доступа всех игроков для указанной команды
       | Параметры:
       |     ~ name [string] - имя команды (без префикса)
       |     ~ value [boolean] - значение сброса
       | Пример вызова:
       |    CommandSystem_ResetAccess("vote", true);
    */
    boolean tvalue;
    public void ResetAccess(string name, bool value) {
        command = name;
        tvalue = value;
        ForForce(RegistredPlayers, lambda void function() {
            SetAccess(command, GetEnumPlayer(), tvalue); 
        });
    }
    
    /* [IsCommandEnabled] returns boolean
       | Описание: показыавет, активна ли команда в данный момент
       | Параметры:
       |     ~ name [string] - имя команды (без префикса)
       | Пример вызова:
       |    if (CommandSystem_IsCommandEnabled("give")) { ... }
    */
    public bool IsCommandEnabled(string name) {
        if (HasCommand(name)) {
            return not LoadBoolean(database, StateKey, StringHash(name));
        } return false;
    }
    
    /* [SetAccess] returns nothing
       | Описание: устанавливает состояние команды (включена\отключена)
       | Параметры:
       |     ~ name [string] - имя команды (без префикса)
       |     ~ enabled [boolean] - включена ли команда
       | Пример вызова:
       |    CommandSystem_SetCommandState("vote", false);
    */
    public void SetCommandState(string name, bool enabled) {
        if (HasCommand(name)) {
            SaveBoolean(database, StateKey, StringHash(name), not enabled);
        } 
    }
    
    /* [RegisterCommand] returns nothing
       | Описание: регистрирует команду в системе для определенных пользователей
       | Параметры:
       |     ~ name [string] - имя команды (без префикса)
       |     ~ handler [string] - название функции обработки команды 
       |     ~ target [force] - группа игрков, для которой регистрируется команда
       | Пример вызова:
       |    CommandSystem_RegisterCommand("jump", "JumpHandler");
    */
    public void RegisterCommandForce(string name, string handler, force target) {
        // строки должны быть значимыми
        if (CheckString(name) or CheckString(handler)) { 
            if (not HasCommand(name)) { 
                SaveStr(database, CommandKey, StringHash(name), handler);
                // установка доступа
                ResetAccess(name, (target == null));
                
                if (target != null) {
                    command = name;
                    ForForce(target, lambda void function() {
                        SetAccess(command, GetEnumPlayer(), true);
                    });
                    // используется данная переменная, т.к для типа force не зарезервирована соответсвующая
                    if (bj_wantDestroyGroup) {
                        DestroyForce(target);
                    }
                }
            
                CommandCount++; 
            }
        }
    
    }
    
    public void RegisterCommand(string name, string handler) {
        RegisterCommandForce(name, handler, null);
    }
    
    /* [RemoveCommand] returns nothing
       | Описание: удаляет указанную команду из системы
       | Параметры:
       |     ~ name [string] - имя команды (без префикса)
       | Пример вызова:
       |    CommandSystem_RemoveCommand("useless");
    */
    public void RemoveCommand(string name) {
        if (HasCommand(name)) {
            SaveStr(database, CommandKey, StringHash(name), null);
            ResetAccess(name, true);
            
            CommandCount--;
        }
    }
    
    /* [RenameCommand] returns trigger
       | Описание: изменяет имя указанной команды
       | Параметры:
       |     ~ name [string] - исходное имя (без префикса)
       |     ~ newName [string] - целевое имя (без префикса)
       | Пример вызова:
       |    CommandSystem_RenameCommand("goto", "togo");
    */
    public void RenameCommand(string name, string newName) {
        if (HasCommand(name) and CheckString(newName)) {
            command = GetCommand(name);
            RegisterCommand(newName, command);
        }
    }
    
    /* [ChangeHandler] returns nothing
       | Описание: обменивает команды с указанными названиями их обработчиками
       | Параметры:
       |     ~ name [string] - имя команды (без префикса)
       |     ~ handler [string] - название функции-обработчика (без префикса)
       |     ~ check [boolean] - следует ли проверять наличие функции в системе
       | Пример вызова:
       |    CommandSystem_SwapCommands("goto", "togo");
    */
    public void ChangeHandler(string name, string handler, bool check) {
        if (not check or (HasCommand(name) and CheckString(handler))) {
            SaveStr(database, CommandKey, StringHash(name), handler);
        }
    }
    
    /* [SwapCommands] returns nothing
       | Описание: обменивает команды с указанными названиями их обработчиками
       | Параметры:
       |     ~ name1 [string] - имя команды 1 (без префикса)
       |     ~ name2 [string] - имя команды 2 (без префикса)
       | Пример вызова:
       |    CommandSystem_SwapCommands("goto", "togo");
    */
    public void SwapCommands(string name1, string name2) {
        if (HasCommand(name1) and HasCommand(name2)) {
            string c1 = GetCommand(name1);
            string c2 = GetCommand(name2);
        
            ChangeHandler(name1, c2, false);
            ChangeHandler(name2, c1, false);
        }
    }
   
    /* [ExecuteCommand] returns nothing
       | Описание: запускает указанную команду (при выполнении ее требований)
       | Параметры:
       |     ~ name [string] - имя команды для запуска
       |     ~ source [player] - игрок, вызвавший команду
       | Пример вызова:
       |    CommandSystem_ExecuteCommand("run", Player(2));
    */
    public void ExecuteCommand(string name, player source) {
        command = GetCommand(name);
        if (CheckString(command)) {
            if (HasAccess(name, source)) {
                if (IsCommandEnabled(name)) {
                    ExecuteFunc(command);
                } else {
                    DisplayMessage(source, DisabledException);
                }
            } else {
                DisplayMessage(source, PermissionException);
            }
        } else {
            DisplayMessage(source, CommandException);
        }
    }
    
    /* [SetListeningTo] returns nothing
       | Описание: устанавливает состояние наблюдения за сообщениями игрока
       | Параметры:
       |     ~ p [player] - игрок, вызвавший команду
       |     ~ enabled [boolean] - true для включения, false для отключения
       | Пример вызова:
       |    CommandSystem_SetListeningTo(Player(5), true);
    */
    public void SetListeningTo(player p, bool enabled) {
        if (p != null and GetPlayerId(p) < 12) { 
            if (enabled and not IsPlayerInForce(p, RegistredPlayers)) {
                ForceAddPlayer(RegistredPlayers, p);
                TriggerRegisterPlayerChatEvent(CommandDetector, p, CommandPrefix, false);
                
                if (ShowListeningMessage) { DisplayMessage(p, ListeningEnabled); }
            }
            if (not enabled and IsPlayerInForce(p, RegistredPlayers)) {
                ForceRemovePlayer(RegistredPlayers, p);
            
                if (ShowListeningMessage) { DisplayMessage(p, ListeningDisabled); }
            }
        }
    }
    
    private void ProcessMessage() {
        if (not IsPlayerInForce(GetTriggerPlayer(), RegistredPlayers)) { return; }
        // пробел добавляется для корректного отделения параметров
        string input = GetEventPlayerChatString() + " ";
        int length = StringLength(input);
    
        if (length < MinInputLength) { return; }
        // проверка на префикс
        if (SubString(input, 0, StringLength(CommandPrefix)) == CommandPrefix) {
            set Source = GetTriggerPlayer();
            set ParamCount = 0;
            bool found = false; // была ли команда отделена от параметров
            int pos = 1; int whitespace = 0; 
            
            loop { exitwhen (pos==length) or (ParamCount==MaxParamCount);
                // поиск пробелов
                if (SubString(input, pos, pos+1) == " ") {
                    if (whitespace != (pos-1)) {
                        if (found) {
                            Params[ParamCount] = SubString(input, whitespace + 1, pos);
                            ParamCount++;
                        } else {
                            Command = SubString(input, 1, pos); 
                            found   = true;
                        }
                    }
                    whitespace = pos;
                } pos++;
            }
            // если за этот проход не удалось отделить команду, то выделяем все символы, кроме последнего пробела
            if (!found) { Command = SubString(input, 1, length-1); }
            if (ParamCount > 0) { HasParams = true; } else { HasParams = false; }
            
            ExecuteCommand(Command, Source);
            
            Source = null;
            Command = null;
        }
    }
   
     private void init() {
        set database = InitHashtable();
        
        set CommandDetector = CreateTrigger();
        set CommandCount = 0;

        TriggerAddAction(CommandDetector, function ProcessMessage);
        // если требуется обработка команд только от определенных игроков, то 
        // замените следующий участок кода на свой
        RegistredPlayers = bj_FORCE_ALL_PLAYERS;
        // Пример:
        // RegistredPlayers = CreateForce();
        // ForceAddPlayer(RegistredPlayers, Player(0));
        // ForceAddPlayer(RegistredPlayers, Player(1));
        // ForceAddPlayer(RegistredPlayers, Player(2));
        ForForce(RegistredPlayers, lambda void function() {
            TriggerRegisterPlayerChatEvent(CommandDetector, GetEnumPlayer(), CommandPrefix, false);
        });
    }
}

void SpawnHandler() {
    if (CommandSystem_HasParams) {    // если у команды имеются параметры
        // отсчет в массиве начинается с нулевого индекса
        if (CommandSystem_Params[0] == "knight") { 
            CreateUnitAtLoc(CommandSystem_Source, 'hkni', GetRandomLocInRect(GetPlayableMapRect()), 0);
        }
        if (CommandSystem_Params[0] == "horse") {
            CreateUnitAtLoc(CommandSystem_Source, 'hhdl', GetRandomLocInRect(GetPlayableMapRect()), 0);
        }
    }
}

RegistredPlayers = bj_FORCE_ALL_PLAYERS;

 // Пример:
 RegistredPlayers = CreateForce();

 ForceAddPlayer(RegistredPlayers, Player(0));
 ForceAddPlayer(RegistredPlayers, Player(1));
 ForceAddPlayer(RegistredPlayers, Player(2));