qcsrc/menu/mutators/events.qh

   1 #pragma once
   2
   3 #include <common/mutators/base.qh>
   4
   5 // register all possible hooks here
   6
   7 // to use a hook, first register your mutator using REGISTER_MUTATOR
   8 // then create your function using MUTATOR_HOOKFUNCTION
   9
  10 // globals
  11
  12 string cmd_name;
  13 int cmd_argc;
  14 string cmd_string;
  15
  16 /**
  17  * Called when a menu command is parsed
  18  * NOTE: hooks MUST start with if (MUTATOR_RETURNVALUE) return false;
  19  * NOTE: return true if you handled the command, return false to continue handling
  20  * NOTE: THESE HOOKS MUST NEVER EVER CALL tokenize()
  21  * // example:
  22  * MUTATOR_HOOKFUNCTION(foo, Menu_ConsoleCommand) {
  23  *     if (MUTATOR_RETURNVALUE) return false; // command was already handled
  24  *     if (cmd_name == "echocvar" && cmd_argc >= 2) {
  25  *         print(cvar_string(argv(1)), "\n");
  26  *         return true;
  27  *     }
  28  *     if (cmd_name == "echostring" && cmd_argc >= 2) {
  29  *         print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
  30  *         return true;
  31  *     }
  32  *     return false;
  33  * }
  34  */
  35 #define EV_Menu_ConsoleCommand(i, o) \
  36         /** command name */ i(string, cmd_name) \
  37         /** also, argv() can be used */ i(int, cmd_argc) \
  38         /** whole command, use only if you really have to */ i(string, cmd_string) \
  39         /**/
  40 MUTATOR_HOOKABLE(Menu_ConsoleCommand, EV_Menu_ConsoleCommand);
  41
  42 #define EV_ConfigureDialogs(i, o) \
  43         /** main window entity */ i(entity, MUTATOR_ARGV_0_entity) \
  44         /**/
  45 MUTATOR_HOOKABLE(ConfigureDialogs, EV_ConfigureDialogs);