Module: command_warmup

Overview

Module

This module allows defining a cooldown before command execution.

Color Boxes

Note

The command_warmup module is before the command execution.

The command_cooldown module is after the command execution.

NOTE: Players with level permission 4 can bypass the command warmup.

Example

◉ Set up the warmup for all commands.

Regex: .+

The . character in regex means match any character.

The + character in regex means a quantifier, one or more times.

Example

◉ Set up the warmup for all commands, but specify a special setup for /back command.

You can just write the config section for /back command at the top of rules.

The rules are matched from up to down, and the first matched rule will be used.

So, you can just write the special rule at the top of other rules.

Example

◉ Set up the warmup for all command, except the /back command.

Regex: (?!back).+

The regex use the negative lookahead, to exclude the string that starts with back.

Example

◉ Share the same warmup setup for multiple commands.

Regex: (back)|(heal)|(feed)

You can use the alternative character | in regex.

Configurations

The following JSON content is provided for reference only. It must NOT be copied directly into the configuration directory, as it does not represent valid JSON syntax.

Config

• File Name: config.json
• File Content:

Click to see the default content...

config/fuji/modules/command_warmup/config.json

{
  /* Should we send a warning message for no movement? */
  "warn_for_move": true,
  "admin_players_can_bypass": true
  /* Defined `warmup` rules. */,
  "rules": [
    {
      "tags": [
        "default-tag-name"
      ]
      /* The `target command` and `warmup time in ms`. */,
      "command": {
        /* The `regex` expression used to match the `target command`. */
        "regex": "back"
        /* The `warmup time` in ms. */,
        "warmup_time_ms": 3000
      },
      "interruptible": {
        /* Is this request interruptible? */
        "enable": true
        /* The max distance to interrupt this request. */,
        "interrupt_distance": 3.0
        /* Interrupt this request when player damaged. */,
        "interrupt_on_damaged": true
        /* Interrupt this request if player in combat. */,
        "interrupt_in_combat": true
      }
    },
    {
      "tags": [
        "default-tag-name"
      ]
      /* The `target command` and `warmup time in ms`. */,
      "command": {
        /* The `regex` expression used to match the `target command`. */
        "regex": "heal"
        /* The `warmup time` in ms. */,
        "warmup_time_ms": 1000
      },
      "interruptible": {
        /* Is this request interruptible? */
        "enable": true
        /* The max distance to interrupt this request. */,
        "interrupt_distance": 3.0
        /* Interrupt this request when player damaged. */,
        "interrupt_on_damaged": true
        /* Interrupt this request if player in combat. */,
        "interrupt_in_combat": true
      }
    }
  ]
}