This plugin provides a way to automate light control and toggle lights from the server console and via chat command using no fuel. There is a config to allow you to pick and choose what is toggle. There is also options to automate turning lights on and on at night.
A big thank you to Wulf and k1lly0u for their awesome lights plugins. If you need fine grained control of lights they are both superior options. If you want fuel use for lighting AutoFuel is a awesome choice. My understanding of lights came directly from reading these plugins and it inspired me to make this low load and slightly more inclusive of entities plugin. If it generates lights or effects I tried to include it. I include a lot of non-light devices (Fog Machine, Snow Machine, Spooky Speakers, Strobe Lights) to allow operators to have fun with players. With each update as new powered devices are added I will add them (Fluid Pump and Switches, Water Pumps, Electric Water Purifiers, Electric Heaters). Just Added Siren Light and Flasher Lights (Thank you FastBurn for the code). Added Smart Switches and Smart Alarms for when they actual become useful.
I left out turrets and SAMS as there are already plugins specifically for them.
lightson.allowedGranting that to a group or player allows them to toggle the lights with the /lights command (an admin command). For example:oxide.grant group admin lightson.allowed
If you want VIP support NightLanterns is a good alternative. I am trying to avoid the overhead of fine grained permissions.
Example:
Example:
Console Output set to false will stop message (other than errors and night toggles) from logging in the console.
These can be set to true or false in the json which lets you determine what is turned off and on automatically:
Hats do not use fuel is as the name suggests.
If the server lights are on (either via always on of the night toggle is on) and you place a light source you have selected to be on, it is turned on when placed. This avoids having to periodically turn the lights on to catch newly placed lights.
This alters fuel requirements to zero through the methods it is using to toggle the lights, since you removing player agency around fuel usage. Note: Furnaces etc. turned on will not process their contents, just look active and produce light. You are giving free light but not free processing. Simply turn them off and back on for normal processing. It is important to let players know this as they may initially be confused or frustrated.
Since this plugin is toggling animation flag states (where ever possible), it allows things like hobo barrels to light up with no fuel in them. It does some "hacky" flag settings to avoid needing fuel in other light sources. It is not elegant, but efficient.
If you just want free fuel NoFuelRequirements or AutoFuel are good solutions, this plugin tries to avoid altering the fuel level in entities where possible as it can be exploited. I only add fuel where the toggle of animation state trick is not working in that use case.
Hats and Jack O Lanterns usually require at least one fuel in them to allow players to toggle them. Toggling Lanterns (which includes Jack O Lanterns) with the commands does not need fuel.
If you are using the commands to turning a light source on and it is already on, it is not altered. If you are turning a light source off with the commands and it is already off, it is not altered. Toggling lights on should not mess up processing content, as their state is not changed. It will mess up processing if you toggle off and then back on for an entity that processes things (grills, furnaces, refineries, camp fires, fire pits and fireplaces). Since I added the Night Toggle feature, I also added Protection for light sources that also process contents. I would recommend you leave these to true. Doing so will not turn these off when dawn happens. That is to avoid annoying players by interrupting their processing. The side effect is they will always appear on if they set to automatically turn on in the configuration.
Choose carefully what you will configure to be controlled if you plan to use the off command or Night Toggle. If you are going to use the off command I recommend you do not include Furnaces, Grills or Refineries as it will stop processing if they are in legitimate use. If folks tend to cook in campfires, fire pits and fireplaces you may want to skip them as well if you plan to use the off command. Honest I normally just turn items not normally used to do processing on and leave them on as it has the smallest server load and will not annoy players. It is important to consider consequences of turning things off or toggling them on and off.
Check Frequency controls how often the plugin checks for night or to toggle the lights in seconds. It has a relatively small load unless there are lights to process. If you want the lights on at a very precise time then a lower number (more frequent check) will help increase the accuracy.
I like to light up all the hobo barrels on the map to give a nice effect, that is why I originally wrote this. It should cover all light sources, please let me know if any are missing. It will be interesting when electricity comes in, I will do my best to ensure this keeps functioning.
The light source name tries to match so "a" would match all light sources with "a" in their name. Use "all" to force all lights server wide regardless of configuration setting.
A big thank you to Wulf and k1lly0u for their awesome lights plugins. If you need fine grained control of lights they are both superior options. If you want fuel use for lighting AutoFuel is a awesome choice. My understanding of lights came directly from reading these plugins and it inspired me to make this low load and slightly more inclusive of entities plugin. If it generates lights or effects I tried to include it. I include a lot of non-light devices (Fog Machine, Snow Machine, Spooky Speakers, Strobe Lights) to allow operators to have fun with players. With each update as new powered devices are added I will add them (Fluid Pump and Switches, Water Pumps, Electric Water Purifiers, Electric Heaters). Just Added Siren Light and Flasher Lights (Thank you FastBurn for the code). Added Smart Switches and Smart Alarms for when they actual become useful.
I left out turrets and SAMS as there are already plugins specifically for them.
Permissions
This plugin uses the permission system. To assign a permission, use oxide.grant <user or group> <name or steam id> <permission>. To remove a permission, use oxide.revoke <user or group> <name or steam id> <permission>.lightson.allowedGranting that to a group or player allows them to toggle the lights with the /lights command (an admin command). For example:oxide.grant group admin lightson.allowed
If you want VIP support NightLanterns is a good alternative. I am trying to avoid the overhead of fine grained permissions.
Console Commands
- lights on -- Turn on any lights that are off and set to true in the config
- lights off -- Turn off any lights that are off and set to true in the config
Example:
- lights on fireplace -- Turn on all fireplaces regardless of the config settings
Chat Commands
- /lights on -- Turn on any lights that are off and set to true in the config
- /lights off -- Turn off any lights that are off and set to true in the config
Example:
- /lights on candle -- Turn on all candles regardless of the config settings
Configuration
The settings and options can be configured in the LightsOn file under the config directory. The use of an editor and validator is recommended to avoid formatting issues and syntax errors.Console Output set to false will stop message (other than errors and night toggles) from logging in the console.
These can be set to true or false in the json which lets you determine what is turned off and on automatically:
- BBQs
- Campfires
- Candles
- Cauldrons
- Ceiling Lights
- CCTVs
- Deluxe Christmas Lights
- Elevators
- Fire Pits
- Fireplaces
- Flasher Lights
- Fluid Splitters
- Fog Machines
- Furnaces
- Hobo Barrels
- Heaters
- Igniters
- Lanterns (which include Chinese Lanterns, Tuna Can Lamps, Lanterns, and Jack'O Lanterns)
- Mixing Tables
- Neon Signs
- Reactive Targets
- Refineries
- RF Broadcasters
- RF Recievers
- Searchlights
- Simple Lights
- Siren Lights
- Smart Alarm
- Smart Switch
- Snow Machine
- Spooky Speakers
- Storage Alarms
- Strobe Lights
- Telephones
- Vehicle Lifts
- Water Pumps
- Water Purifiers
- Electric Water Purifiers
- BBQs
- Campfires
- Cauldrons
- Fire Pits
- Fireplaces
- Furnaces
- Hobo Barrels
- Mixing Tables
- Refineries
- /lights off furnace
- Always on
- Night Toggle (please use either Always on or Night Toggle)
- Check Frequency (10-600)
- Dusk Time (0-24)
- Dawn Time (0-24)
- Hats do not use fuel
Hats do not use fuel is as the name suggests.
Notes
Heaters, Fluid Switches, Water Pumps, Electric Water Purifiers, CCTV, and Igniters do not have a day night toggle since they are not a light source, or a typical device. If set to true they will always be powered.If the server lights are on (either via always on of the night toggle is on) and you place a light source you have selected to be on, it is turned on when placed. This avoids having to periodically turn the lights on to catch newly placed lights.
This alters fuel requirements to zero through the methods it is using to toggle the lights, since you removing player agency around fuel usage. Note: Furnaces etc. turned on will not process their contents, just look active and produce light. You are giving free light but not free processing. Simply turn them off and back on for normal processing. It is important to let players know this as they may initially be confused or frustrated.
Since this plugin is toggling animation flag states (where ever possible), it allows things like hobo barrels to light up with no fuel in them. It does some "hacky" flag settings to avoid needing fuel in other light sources. It is not elegant, but efficient.
If you just want free fuel NoFuelRequirements or AutoFuel are good solutions, this plugin tries to avoid altering the fuel level in entities where possible as it can be exploited. I only add fuel where the toggle of animation state trick is not working in that use case.
Hats and Jack O Lanterns usually require at least one fuel in them to allow players to toggle them. Toggling Lanterns (which includes Jack O Lanterns) with the commands does not need fuel.
If you are using the commands to turning a light source on and it is already on, it is not altered. If you are turning a light source off with the commands and it is already off, it is not altered. Toggling lights on should not mess up processing content, as their state is not changed. It will mess up processing if you toggle off and then back on for an entity that processes things (grills, furnaces, refineries, camp fires, fire pits and fireplaces). Since I added the Night Toggle feature, I also added Protection for light sources that also process contents. I would recommend you leave these to true. Doing so will not turn these off when dawn happens. That is to avoid annoying players by interrupting their processing. The side effect is they will always appear on if they set to automatically turn on in the configuration.
Choose carefully what you will configure to be controlled if you plan to use the off command or Night Toggle. If you are going to use the off command I recommend you do not include Furnaces, Grills or Refineries as it will stop processing if they are in legitimate use. If folks tend to cook in campfires, fire pits and fireplaces you may want to skip them as well if you plan to use the off command. Honest I normally just turn items not normally used to do processing on and leave them on as it has the smallest server load and will not annoy players. It is important to consider consequences of turning things off or toggling them on and off.
Check Frequency controls how often the plugin checks for night or to toggle the lights in seconds. It has a relatively small load unless there are lights to process. If you want the lights on at a very precise time then a lower number (more frequent check) will help increase the accuracy.
I like to light up all the hobo barrels on the map to give a nice effect, that is why I originally wrote this. It should cover all light sources, please let me know if any are missing. It will be interesting when electricity comes in, I will do my best to ensure this keeps functioning.
The light source name tries to match so "a" would match all light sources with "a" in their name. Use "all" to force all lights server wide regardless of configuration setting.