Description

This is a fork of this plugin https://umod.org/plugins/night-lantern, author: k1lly0u
The fork was created to add new features requested by the community, on a plugin that has not been updated by the owner for years.

Night Lantern

Night Lantern automatically turns ON lanterns after sunset and then turns them OFF after sunrise.

Sunset and sunrise hours can be set in configuration file; default values are 7.5 and 18.5. These values determine when lights should be turned on and off.

Enable which light types you would like to have automated by changing "This type is enabled" for the various types in the configuration.

Choose to make lights consume fuel, or run free of charge by changing "This type consumes fuel" for the various light types in the configuration.

Allow players to toggle what types of lights they want to be automated by changing "This type can be toggled by the owner" in the config. This only affects lights they have placed themselves.

Option to require that only players with the correct permission can toggle their own lights type by changing "This type requires permission to be toggled by the owner" in the configuration.

When a player toggles on/off a light type all of their lights of that type will also be turned on/off (if within the automation time span).

Has inbuilt support for No Fuel Requirements

Permissions

This plugin uses the permission system. To assign a permission, use oxide.grant <user or group> <name or steam id>.
To remove a permission, use oxide.revoke <user or group> <name or steam id> <permission>.

• nightlantern.global– Required to toggle auto-lights across the entire server
• nightlantern.campfire – Required to toggle automation on campfires you own
• nightlantern.candle– Required to toggle automation on candle you own
• nightlantern.firepit – Required to toggle automation on firepits you own
• nightlantern.fireplace – Required to toggle automation on fireplaces you own
• nightlantern.furnace – Required to toggle automation on furnaces you own
• nightlantern.largefurnace – Required to toggle automation on large funacaes you own
• nightlantern.lanterns – Required to toggle automation on lanterns you own
• nightlantern.jackolantern – Required to toggle automation on jack’o’lanterns you own
• nightlantern.tunalight – Required to toggle automation on tuna can lamps you own
• nightlantern.searchlight – Required to toggle automation on searchlights you own
• nightlantern.refinery– Required to toggle automation on refineries you own
• nightlantern.cursedcauldren– Required to toggle automation on cursed cauldrens you own
• nightlantern.chineselantern– Required to toggle automation on chinese lanterns you own
• nightlantern.hobobarrel– Required to toggle automation on HoboBarrel you own
• nightlantern.torchHolder– Required to toggle automation on TorchHolder you own

Chat Commands

• /lantern global – Toggle lights and automation on/off across the whole server
• /lantern campfire – Toggle automation on campfires you own
• /lantern candle – Toggle automation on candle you own
• /lantern firepit – Toggle automation on firepits you own
• /lantern fireplace – Toggle automation on fireplaces you own
• /lantern furnace – Toggle automation on furnaces you own
• /lantern largefurnace – Toggle automation on large funaces you own
• /lantern lanterns – Toggle automation on lanterns you own
• /lantern jackolantern – Toggle automation on jack’o’lanterns you own
• /lantern tunalight – Toggle automation on tuna can lights you own
• /lantern searchlight – Toggle automation on searchlights you own
• /lantern refinery – Toggle automation on refineries you own
• /lantern cursedcauldren – Toggle automation on cursed cauldrens you own
• /lantern chineselantern – Toggle automation on chinese lanterns you own
• /lantern hobobarrel– Toggle automation on HoboBarrel you own
• /lantern torchHolder– Toggle automation on TorchHolder you own

Configuration

The settings and options can be configured in the NightLanternfile under the config directory.
The use of an editor and validator is recommended to avoid formatting issues and syntax errors.

{
   "Light Settings":{
      "Campfire":{
         "This type is enabled":true,
         "This type consumes fuel":false,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "Candle":{
         "This type is enabled":true,
         "This type consumes fuel":false,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "Firepit":{
         "This type is enabled":true,
         "This type consumes fuel":false,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "Fireplace":{
         "This type is enabled":true,
         "This type consumes fuel":false,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "Furnace":{
         "This type is enabled":true,
         "This type consumes fuel":false,
         "This type can be toggled by the owner":false,
         "This type requires permission to be toggled by the owner":false
      },
      "JackOLantern":{
         "This type is enabled":true,
         "This type consumes fuel":false,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "Lanterns":{
         "This type is enabled":true,
         "This type consumes fuel":false,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "LargeFurnace":{
         "This type is enabled":true,
         "This type consumes fuel":false,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "Searchlight":{
         "This type is enabled":true,
         "This type consumes fuel":false,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "TunaLight":{
         "This type is enabled":true,
         "This type consumes fuel":false,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "Refinery":{
         "This type is enabled":true,
         "This type consumes fuel":true,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "ChineseLantern":{
         "This type is enabled":true,
         "This type consumes fuel":true,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "CursedCauldren":{
         "This type is enabled":true,
         "This type consumes fuel":true,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "HoboBarrel":{
         "This type is enabled":true,
         "This type consumes fuel":true,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      },
      "TorchHolder":{
         "This type is enabled":true,
         "This type consumes fuel":true,
         "This type can be toggled by the owner":true,
         "This type requires permission to be toggled by the owner":true
      }
   },
   "Time autolights are disabled":7.5,
   "Time autolights are enabled":18.5,
   "Version":{
      "Major":2,
      "Minor":0,
      "Patch":9
   }
}

For Developers

Hooks

object OnNightLanternToggle(BaseEntity entity, bool toggleOn) // Called prior to toggling a light

Additional information

Product Enquiry