Skip to content

Warmup and Cooldown

xZise edited this page Aug 2, 2011 · 3 revisions

To prevent the users from warping all the day, it is possible to add warmups and cooldowns.

Warmup

The warmup is the time before the command gets executed. It is possible to define in the settings if the warmup will be canceled if the user moves/get hurt.

Note that if the warmup time is low it is possible, that the warm up doesn't get canceled. At the moment this was only seen by one seconds warm ups.

Cooldown

The cooldown is the time after the warp which determines, how many seconds the player has to wait, before the player could warp again.

How to setup

The warmups and cooldowns uses the Permissions plugin. To define a warmup time to a special type of warp simply add warp.timers.warmup.<visibility>: <time in seconds> to the info section. For cooldowns replace the warmup with cooldown.

By default all variables are 0 (zero) seconds.

Example

Here a simple example:

groups:
  foo:
    default: true
    [...]
    info:
      warp:
        timers:
          warmup:
            private: 10
            public: 10
          cooldown:
            private: 30
            public: 30
  bar:
    default: false
    inheritance: foo
    info:
      warp:
        timers:
          cooldown:
            public: 20
  snafu:
    default: false
    inheritance: bar
    info:
      warp:
        timers:
          warmup:
            public: 0
          cooldown:
            public: 0
users:
  somebody:
    group: foo
  nobody:
    group: bar
  everybody:
    group: snafu
  superduper:
    group: bar
    info:
      warp:
        timers:
          warmup:
            private: 0
          cooldown:
            private: 0

Like Creation limits each the time will be searched in this order:

  1. User itself
  2. Group of the user
  3. Inheritance group of the group
  4. No inheritance: Default = 0
  5. Inheritance: Go to 3. :P

So it will select the first definition of the variable. If it wasn't found it will select the default value. This is for all types none (0 seconds).

So the user “Somebody” has no definitions. It will check the group of the user (foo) and find definitions for private and public warps. So the warmup for Somebody to private or public warps are 10 seconds. The cooldown afterwards is half a minute. To warp to global warps the user hasn't to wait.

The next user “Nobody“ has no definitions too. Like “Somebody” it will search in the users's group (“bar” this time) and find definitions for the cooldown time of public warps. So after a warp to a public warp the user (and everybody else in the group bar) has to wait 20 seconds. The rest will be loaded from the parent group (“foo”). So warmup for public and private warps is 10 seconds and after a warp to a private warp, the user has to wait 30 seconds. And global warps hasn't any penalty.

For the user “Everybody” apply similar rules. The difference to “Nobody” is only that the user hasn't any penalty for public warps too.

“Superduper” now has personally permissions which will be read first. The user has no penalty for private warps. But for all other values, those from the group “bar” will apply.

Warp specific cooldown/warmup

In xWarp 3.0.0 every warp could have a own cooldown/warmup. At the moment there are no commands to change these values, but they will be added at least in 3.1.0. The warp specific value overrides then the value defined in the permissions.

Clone this wiki locally