Module: Environment - Module ID: environment

Introduction

The Environment module allows for the manipulation of natrual forces in the world, specifically the time and the weather.

Manipulating the Weather

Nucleus has two commands for manipulating the weather, changing it, and locking it.

Changing the weather

The command /weather [world] <weather> [duration] changes the current climate for the specified time. If no world is specified, the current world is used.

The weather may be one of:

  • sun, clear, c for clear weather
  • rain, r for rain/snow
  • storm, thunder, t for a thunderstorm (as well as rain/snow)

The duration may be a number, which will be taken to be in seconds, or of the form of a timespan. This timespan can be limited in main.conf, under environment.maximum-weather-timespan, which can be bypassed using the nucleus.weather.exempt.length permission.

Locking the weather

The command /lockweather [world] [true/false] locks or unlocks the weather to the current climate on the specified (or current) world.

Changing Time

The world time can be seen by simply running the command /time [world]. If the world is not specified, the current world time is displayed.

Setting Time

The world time can be set through the use of the command /time set [world] <time>. The time can be in one of the following formats:

  • Ticks - there are 24000 ticks per day, where 0 ticks is 6am/0600, and 1000 ticks represents an hour.
  • [0-23]h, for 24 hour time (e.g. 12h for midday).
  • [1-12][am|pm], for 12 hour time (e.g. 12pm for midday).

It can also be a predefined keyword:

  • dawn, sunrise: 0 ticks (6 am)
  • day, daytime, morning: 1000 ticks (7 am)
  • noon, afternoon: 6000 ticks (12 pm)
  • dusk, evening, sunset: 12000 ticks (6 pm)
  • night: 14000 ticks (8 pm)
  • midnight: 18000 ticks (12 am)
/lockweather
Module: environment
Locks the weather on the specified world.

Aliases: lockweather killweather

Root command aliases: /nlockweather

Usage: /lockweather [<world>] [<true|false>]

Default Role: ADMIN

Basic Command Permission: nucleus.lockweather.base

Permissions

  • nucleus.lockweather.base - Default Role: ADMIN
    Allows the user to run the command /lockweather
/time
Module: environment
Gets the time for the specified world.

Aliases: time

Root command aliases: /ntime

Usage: /time [<world>]

Available subcommands: set

Default Role: USER

Basic Command Permission: nucleus.time.base

Permissions

  • nucleus.time.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /time
  • nucleus.time.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /time
  • nucleus.time.base - Default Role: USER
    Allows the user to run the command /time
  • nucleus.time.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /time

This command is similar to the following command(s) found in Essentials: /time

Essentials Migration Notes: This just displays the time. Use '/time set' to set the time.

/time set
Module: environment
Sets the time for the specified world.

Aliases: time set

Root command aliases: /settime /timeset

Usage: /time set [<world>] <time>

Default Role: ADMIN

Basic Command Permission: nucleus.time.set.base

Permissions

  • nucleus.time.set.base - Default Role: ADMIN
    Allows the user to run the command /time set
  • nucleus.time.set.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /time set
  • nucleus.time.set.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /time set
  • nucleus.time.set.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /time set

This command is similar to the following command(s) found in Essentials: /time, /day, /night

Essentials Migration Notes: A time MUST be specified.

/weather
Module: environment
Sets the weather on the specified world.

Aliases: weather

Root command aliases: /nweather

Usage: /weather [<world>] <weather> [<duration>]

Default Role: ADMIN

Basic Command Permission: nucleus.weather.base

Permissions

  • nucleus.weather.exempt.length - Default Role: ADMIN
    Allows the user to bypass the maximum weather length.
  • nucleus.weather.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /weather
  • nucleus.weather.base - Default Role: ADMIN
    Allows the user to run the command /weather
  • nucleus.weather.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /weather
  • nucleus.weather.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /weather

This command is an equivalent to the following command(s) in Essentials: /thunder, /sun, /weather, /sky, /storm, /rain

Permission Suggested Role Description
nucleus.lockweather.base ADMIN Allows the user to run the command /lockweather
nucleus.time.base USER Allows the user to run the command /time
nucleus.time.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /time
nucleus.time.exempt.cost ADMIN Allows the user to bypass the cost for /time
nucleus.time.exempt.warmup ADMIN Allows the user to bypass the warmup for /time
nucleus.time.set.base ADMIN Allows the user to run the command /time set
nucleus.time.set.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /time set
nucleus.time.set.exempt.cost ADMIN Allows the user to bypass the cost for /time set
nucleus.time.set.exempt.warmup ADMIN Allows the user to bypass the warmup for /time set
nucleus.weather.base ADMIN Allows the user to run the command /weather
nucleus.weather.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /weather
nucleus.weather.exempt.cost ADMIN Allows the user to bypass the cost for /weather
nucleus.weather.exempt.length ADMIN Allows the user to bypass the maximum weather length.
nucleus.weather.exempt.warmup ADMIN Allows the user to bypass the warmup for /weather
The following configuration is the default for this module:
# The maximum amount of time that the weather can be set to last, in seconds. Set to -1 for no restriction.
maximum-weather-timespan=-1