[Chdata]

[TF2] Spy's Throwable Sapper
Before you give a suggestion, read the TODO list. It's probably already there.

Description:

• This plugin allows spies to throw a sapper by using +attack3 or +reload (defaults to mouse3 which defaults to your scroll wheel or the "r" key).
  The thrown sapper will disable buildings within a set radius and deal continuous damage (up to around 50 damage or 1/3 of a dispenser and 1/2 of a mini sentry).
  Can only be used if not cloaked or ready to feign death.
  
  Just like from Meet the Spy!
  
  Demonstration video: http://youtu.be/W3RfPf8887U

CVARs:

• 1 = Enabled; 0 = Disabled;
• sm_throwsap_version "0x0X" - Throwsap Version (DO NOT CHANGE)
• sm_throwsap_enabled "1" - Enable/Disable throwsap plugin. (Applied on map change).
• sm_throwsap_sapradius "300.0" - Radius of effect for sappers

Installation:

• Make sure you have Sourcemod.
• Get Plugin below.
• throwsap.smx goes in tf/addons/sourcemod/plugins/
• plugin.throwsap.cfg goes in tf/cfg/sourcemod/
  - This file will be auto-generated by the plugin with the default values shown above. There's no real reason to DL this yet.
• throwsap.sp is only needed for programmers.

Changelist:

0x06 (10/10/2014 | 11:29AM CDT) * Added The Snack Attack. Except it's glitchy and won't move. So it becomes a normal sapper. * Plugin fixed after almost a year of inactivity! * Skipped version 0x05 because it was a broken update I never released * Fixed various entref related errors. * Fixed compatibility with Building Godmode. * Thrown sappers no longer sap godmode buildings. * Fixed teleporter electricity offsets. 0x04 (12/21/2013) * Added Festive Sapper. * Throwing your sapper loses your disguise. * Throwing your sapper loses your sapper. (Must visit resupply locker). * Can use +reload or +attack3 to throw sapper. * Can only throw one sapper a time for now. * Removed charge timer hud thing. * Rewrote most of the plugin to make it better. 0x03 (12/19/2013) - Minutes after that release * Fixed the sapper sound getting stuck to dispensers occasionally. 0x02 (12/19/2013) - An hour after initial release * Fixed a timer related confliction. 0x01 (12/19/2013) * Initial release - Also my first plugin submission * Isolated throw sapper code. * If using the red-tape recorder or Wheatley, throw that instead. * Cannot throw if cloaked or ready to feign death. * Changed the lightning color of the rings to a better color. * Fixed a HUD glitch that made it disappear constantly. * Fixed sapping buildings that were spawn solely by the map with no owner. * Fixed the plugin trying to sap non-building objects. * Fixed the plugin keeping dead sappers. * Fixed a timer related memory leak. * Cloak can no longer be sapped to negative values.

TODO:

Spoiler

Glitches:

[FIXED?] Sometimes, it won't drain the owner's cloak.
[FIXED?] Suspected confliction with bgod plugin (Building Godmode).
[FIXED?] Rare glitch where you can't spawn a sapper anymore?
[FIXED?] Do not add new effects to an already sapped building.

CVARs to add:

* Does it recharge? (Or must you resupply locker)?
* How fast does it recharge? Or, how does it get resupplied?
* Sapper duration
* Damage vs buildings
* Cloak drain rate
* Does it even sap
* Do you lose it after throwing it?
* How many buildings can it sap at once?
* Can you throw it while disguised?
* If you throw it while disguised, does it remove your disguise?
* What button do you use to activate it?
* Should the last sapper be destroyed when a new one is destroyed?
* How many sappers does a spy carry at once? (default: 3)
* Friendly Fire sapping

Other changes to make:
* Change the throwing velocity
* Add decloak sound ... to something?
* Add support for throwing multiple sappers
* Change behavior of throwing a red-tape recorder
* Show dispenser HP in upper left
* Building destroyed event in upper right
* Smoothen cloak drain
* Custom client side models?
* Remake the .inc for ThrowSapper(); & use include files
* Be able to destroy the sapper
* MVM support
* Short circuit can destroy it

Planned default interactions:
* The Red-Tape Recorder doesn't do damage, but degenerates buildings.
* Play sounds related to the Red-Tape Recorder and Wheatley.
* Play sound when unable to throw a sapper.

Credits:

• Tak (Chaosxk) who made playpoints from which I used code from.
• RIKUSYO who originally created the RMF ability pack.

Want support?

• Post questions and...
  Join TF2Data if you have questions not related to this plugin.

Wanna support me?

• Post suggestions (read the TODO list first) and...
  Join TF2Data, play on our servers, or donate! ;p
  (See siggy for links!)

For people interested in GitHub:
https://github.com/Chdata/TF2-Throwable-Sapper

[Sreaper]

Epic! Thanks for sharing!
Bug 1: Sometimes the sapping sound gets stuck looping.
Bug 2: The Red Tape Recorder doesn't deupgrade buildings when thrown.
Suggestion: Remove the hud timer, and make the sapper unequiptable until it's recharged. Maybe have a hud message flash saying it's ready if necessary.

[Chdata]

I haven't actually got anyone to help me bug test it whenever I want, mind if I join you so I can see? (Add on steam or PM).

I've so far only tested this with friends who happened to be available and in a map that spawns buildings (arena_mariokart_pb1).

Edit: I see the problem already though.

Bug 2: That's on my TODO list as a feature.
Suggestion: Also already on my TODO list. (See: Planned default interactions)

Edit 2: The sound bug should be fixed now.

Just curious but... I'm using Nyansapper which replaces a c_model which is the only reason I used the w_model for this plugin, cause the custom skin makes the c_model invisible if spawned with code. Any way around this? I'd assume not cause it's a client side mod.

Edit 3: Actually, I might have to release another fix related to the sound. In other words, I've been planning to rewrite how this works anyway cause it's not set up very well for my tastes.

[MafiaBoss]

Very nice! Would you be able to have another version whereby only root flagged admins are able to enable this on any player via a command? I'm sure some people like it this way too Oh and it would be great if it can be binded to any key

[Chdata]

I considered making an admin only flag and related command, but for now I think I dislike the idea of giving some people an advantage over each other and not others, even if the intended use is just a for fun thing like in my Hale server.

And keybind is on the TODO list ;p

[MafiaBoss]

Ha yea, its for the fun part especially ach servers, looking forward to that version

[Marverlous]

Perhaps let the sapper recharge over time instead of having to visit resupply locker? Since arena mode don't have the lockers.

[Chdata]

Already on the TODO list ;p

I haven't made much MvM, I might try to make it work similar to however that works I suppose.

Or I could make it do more damage and be like a caber ;p

Or both!

[Blackglade]

OH MY GOD YES!!! This is an amazing plugin!!! I am going to soon implement this specifically for donors up as it seems cool.

Something I'd like to respond on:
As far as your advantage morale goes.. I too disagree with giving donors a better chance in the game than others which is why i only apply aesthetical mods. However, that being said, in the video it seems as if throwing the sapper is actually more work than straight up going to the sentry and sapping it. The idea that it does less damage on the sentry than a normal sapper, has a recharge rate so you can't retrieve it through any ammo packs, and uncloaks/exposes you, would make it seem harder than simply just using your sapper as
intended...

Some Questions:
Players who have auto reloading enabled in TF2... will this then auto throw it as soon as you select it or is it only when you press the +reload button?
Does it only work for the Red-Tape Recorder or all sappers?

Now since thats clear, I would love it if you could add some extra features to the plugin:
ConVar for Damage Rate
Admin Flag Support
ConVar for Recharge Time w/ HUD support

Gonna hold off a bit on installing this until you develop it more... but seriously.. GREAT JOB!

[Chdata]

Indeed, I already know it's actually much weaker than just sapping things.

I was thinking of just doubling the damage it does, which'd nearly destroy most buildings. It can't be stopped at all once it's been thrown, after all.

I was going to make an aesthetic mode if it can only be used by some people and not others.

It works for -all- sappers. If you wanna throw away your festive sappers, this is your plugin!

As for the cvars, those are in the TODO.