pho3nix90 / minicopteroptions Goto Github PK

Allows for the configuration of additional Mini-Copter options, including the addition of storage containers to the Mini-Copter.

If you like the plugin, don't forget to donate for further development, and to keep it free. Donate here

• Increase the Lift Fraction to increase the take off speed.
• Increase the Pitch/Roll/Yaw Torque Scale in order to make the Mini-Copter response to controls faster.
• Setting Fuel per Second to 0 will make the Mini-Copter use no fuel, but still requires 1 fuel to be placed into the fuel storage in order to run the Mini-Copter. This is a client side requirement.

Set Restore Defaults to true to restore the default movement and fuel consumption values on plugin unload. Storage Containers will remain unless Reload Storage is set to true. Warning: Unloading or reloading the plugin with Reload Storage set to true will destroy any player items contained in the Mini-Copter storage stashes.

Warning about high Lift Fraction values: Setting a high lift fraction can increase the risk of FlyHack kicks when a player has crashed the Mini-Copter. Seconds to pause flyhack when dismount from heli.: should solve the issue.

• The pilot can turn the search light on and off with flashlight key

The default configuration mimics the default Rust values.

{
  "Fuel per Second": 0.5,
  "Lift Fraction": 0.25,
  "Pitch Torque Scale": 400.0,
  "Yaw Torque Scale": 400.0,
  "Roll Torque Scale": 200.0,
  "Storage Containers": 0,
  "Large Storage Containers": 0,
  "Restore Defaults": true,
  "Reload Storage": false,
  "Drop Storage Loot On Death": true,
  "Large Storage Lockable": true,
  "Large Storage Size (Max 48)": 48,
  "Seconds to pause flyhack when dismount from heli.": 1,
  "Add auto turret to heli": false,
  "Auto turret targets players": true,
  "Auto turret targets NPCs": true,
  "Auto turret targets animals": true,
  "Mini Turret Range (Default 30)": 30.0,
  "Light: Add Searchlight to heli": true,
  "Light: Add Nightitme Tail Light": false
}

object OnMiniCopterOptions(Minicopter mini)

• Called when the plugin wants to modify a minicopter
• Returning false will prevent the minicopter from being modified
• Returning null will allow the minicopter to be modified, unless blocked by another plugin

object OnMinicopterFuelPerSecChange(Plugin plugin, Minicopter copter, float[] fuelPerSec) 

• Called when the plugin wants to modify the fuelPerSec property of a specific minicopter
• Returning false will prevent the fuelPerSec property from being modified
• Returning null will allow the fuelPerSec property to be modified to the value in fuelPerSec[0] (which you can modify if you want), unless blocked by another plugin
• When used correctly, multiple plugins can stack buffs/debuffs

Example usage to reduce fuel consumption by 50%:

void OnMinicopterFuelPerSecChange(Plugin plugin, Minicopter copter, float[] fuelPerSec)
{
    // Note: Ideally you want to make this adjustment conditional according to which minicopter it is or who is mounted to it.
    fuelPerSec[0] /= 2;
}

object OnMinicopterLiftFractionChange(Plugin plugin, Minicopter copter, float[] liftFraction)

• Called when the plugin wants to modify the liftFraction property of a specific minicopter
• Returning false will prevent the liftFraction property from being modified
• Returning null will allow the liftFraction property to be modified to the value in liftFraction[0] (which you can modify if you want), unless blocked by another plugin
• When used correctly, multiple plugins can stack buffs/debuffs

Example usage to multiply lift fraction by 2:

void OnMinicopterLiftFractionChange(Plugin plugin, Minicopter copter, float[] liftFraction)
{
    // Note: Ideally you want to make this adjustment conditional according to which minicopter it is or who is mounted to it.
    liftFraction[0] *= 2;
}

• Diametric, the original plugin author
• WhiteThunder, active maintainer