AlliedModders - [L4D/L4D2]Weapon Cleaner (2.2.5)

AlliedModders (https://forums.alliedmods.net/index.php)

- Plugins (https://forums.alliedmods.net/forumdisplay.php?f=108)

- - [L4D/L4D2]Weapon Cleaner (2.2.5) (https://forums.alliedmods.net/showthread.php?t=315058)

[L4D/L4D2]Weapon Cleaner (2.2.5)

Intro

The idea of this plugin arises from the fact of avoiding the excess of weapons. This usually happens when players abuse weapons spawn. In addition to other plugins that generate weapons which several of these are abandoned.
Since also the excess of these weapons on the map can cause the server to warp or even crash due to excess entities.

This plugin consists of an independent timer countdown for each weapon, and this is activated when the weapon is left on the ground, similar to KF2.

Feature list:

clear weapons manually by admin commands
cleaning weapons drop,by player dead,by player(bot) kicked
cleaning all weapons spawned in game (except map weapons)
filter the weapons for visibility
set effects on weapons with the timer (blink/glow)
choose class name weapons in the WhiteList Attachment 178642

Cvars:

PHP Code:


		
			
// 0:Disable, 1:Enable Plugin

// Default: "1"

weapon_cleaner_enable "1"



// 0: Clean all weapons not equipped in the game, 1: Clean only dropped weapons when taking another weapon

// Default: "0"

weapon_cleaner_drop "0"



//"0:Detect all weapons when spawned, 1:Ignore weapons spawned by map, 2: Ignore weapons when the round starts (thirparty plugins)"

// Default: "2"

weapon_cleaner_spawn "2", 



// 1:Clean only Weapons that do not belong to the spawn class, 2:Clean only Weapons of the class with suffix: "_spawn", 3:All weapons with any class name("weapon_*")

// Default: "1"

// Minimum: "1.000000"

// Maximum: "3.000000"

weapon_cleaner_class "1"



//"0:Ignore prop_physics weapons(no detect gascans), 1:Allow detect prop_physics (gnome, cola_bottles,...)"

// Default: "0"

weapon_cleaner_physics "0"



//"0:Ignore ammo pile, 1:Allow detect ammo pile(weapon_ammo_spawn)"

// Default: "0"

weapon_cleaner_ammo "0" 



// Set delay to clean each weapon in seconds

// Default: "300"

// Minimum: "1.000000"

weapon_cleaner_delay "300"



// 0:Disable, 1:Enable visibility filter on weapons

// Default: "0"

weapon_cleaner_visible "0"



// 0:Pause timer if is visible weapon , 1:Pause timer if someone is aiming at the weapon, 2:Reset timer if is visible weapon, 3:Reset timer if someone is aiming at the weapon

// Default: "0"

// Minimum: "0.000000"

// Maximum: "3.000000"

weapon_cleaner_visible_mode "0"



// 0:Disable effects on weapons in timer cleaning, 1:Set blink effect(RenderFx), 2:Set glow effect(L4D2), 3:All effects modes

// Default: "1"

weapon_cleaner_effect_mode "1"



// Set percentage of delay time to activate effects on weapons, ex:("0.2")=>(0.2*delay=0.2*300s=60s) or Set time in seconds value if: (value >= 1), ex:("60")s

// Default: "0.8"

// Minimum: "0.010000"

weapon_cleaner_effect_time "0.8"



// Set glow color in RGB Format (L4D2)

// Default: "128,128,128"

weapon_cleaner_effect_glowcolor "128,128,128"



// Set maximum range of glow (L4D2)

// Default: "1000"

weapon_cleaner_effect_glowrange "1000"

Admin Commands:

PHP Code:


		
			
"sm_wc_reload" //reload config data Whitelist



"sm_wclean" //clean weapons no equipped by name or classname



"sm_wcleanall" //clean all weapons no equipped



"sm_wclear" //clear weapons all weapons by name or classname



"sm_wclearall" //clear all weapons

Changelog

Code:

2021-02-03 (v2.2.5)

*Fixed fake drop weapon when weapon can use 

*Added detect for new scavenge gascans (Last Stand update)

*Fixed filter "weapon_first_aid_kit_spawn" in Whitelist

(ty Hnt for reporting)



2020-03-30 (v2.2)

*Improved method detect weapon dropped

*Fixed support on player disconnect

*Changed cvar "weapon_cleaner_map" to "weapon_cleaner_spawn"

and add new option to ignore weapons

*



2020-02-13 (v2.1)

*Improved commands to clean weapons

*Fixed method get equipped weapon name



2020-02-10 (v2.0)

*Added admin commands for to clean weapons manually

*Added admin command for reload Whitelist

*Changed method visibility for camera visibility

*Changed Renderfx types to effect weapons

*Optimized/improved code



2020-01-15 (v1.4.9.7)

*Fixed weapon spawn class method

*Fixed function (IsWeaponInUse) 



2020-01-14 (v1.4.9)

*Fixed invalid prop in function(IsWeaponSpawn) 



2020-01-13 (v1.4.8)

*Semifixed cvar: weapon_cleaner_ammo

*Ignore weapon_scavenge_item_spawn

(ty valve...and Voevoda for your patience)





2020-01-10 (v1.4.7)

*Fixed no detect valid item in whitelist

*Ignore scavenge gascans

(ty Marttt)



2020-01-09 (v1.4.6)

*Fix remove default glows in gascans

(ty Voevoda for report)



2019-12-25 (v1.4.5)

*New cvar: weapon_cleaner_ammo

(request by Voevoda)



2019-12-22 (v1.4.0)

*New cvar: weapon_cleaner_physics

*Added detect carry weapons(gascan,gnome,..etc) in Whitelist



2019-12-20 (v1.3.3)

*Fixed Invalid key value handle OnPluginStart

(thanks Voevoda for report)



2019-12-13 (v1.3.2)

*Fixed no reset timer on weapon equipped



2019-12-6 (v1.3.0)

*Converted to a new syntax and methodmaps.

*New cfg file WhiteList added (replaces old cvar: exclude_weapons)

(credits to Dragokas/BHaType and thanks Veovoda for report)



2019-12-2 (v1.2.7)

*New cvar: "weapon_cleaner_map"

*Fix errors Property "m_hOwner" not found

*Added detect weapons spawn classes for Whitelist

(thanks Voevoda and Lux for report)



2019-11-30 (v1.2.5)

*Fix errors log by invalid entity OnPluginUnload

*Added WhiteList melee weapon names support 

(thanks Voevoda for report)



2019-05-12 (v1.2.0)

*Fix errors log by killing timer fuction and entities with classname "trigger_active_weapon_detect"

*Changed cvar: weapon_cleaner_mode -> weapon_cleaner_drop

*Add new cvar: weapon_cleaner_effect_glowrange



2019-04-07 (v1.1.5)

*Fix error log in timer:Array index is out of bounds

*Change format HEX color to RGB color in cvar:weapon_cleaner_effect_glowcolor



2019-03-23 (v1.1.0)

*Fix remove effects on weapon equip(L4D2)

*Fix WhiteList in cvar:weapon_cleaner_exclude

(ty yagura40977)

*Improved check weapons on spawn

*Add new cvar: weapon_cleaner_mode 

(ty Dragokas)

*Add new cvar: weapon_cleaner_class

(ty Lux)



2019-03-21 (v1.0.5)

* Fix timer reset in cvar:weapon_cleaner_visible_mode 3 

* Improved verification the weapon on timer function

(thanks Dragokas)

 

2019-03-19 (v1.0.0)

* Initial release.

Notes:
-if you wish to compile a version yourself, l4dstocks is required.
-for to use the WhiteList cfg, you must set the value to "1" for exclude your weapon
-for now the cvar:weapon_cleaner_physics can't detect gascans, you can exclude in Whitelist

credits
zipcore
Mr. Zero
AtomicStryker
berni
Bacardi
KissLick

Special Thanks

pd: sorry for my bad English :/

Re: [L4D/L4D2]Weapon Cleaner

Thanks. Nice idea.

Quote:

-if you wish to compile a version yourself, l4dstocks is required.

Quote:

There was an error getting resource 'downloads':

401: Anonymous caller does not have storage.objects.get access to google-code-archive/v2/code.google.com/l4dstocks/downloads-page-1.json.

Re: [L4D/L4D2]Weapon Cleaner

I uploaded the l4dstocks repo-archive in case others are having download problems.

Re: [L4D/L4D2]Weapon Cleaner

Lux, thanks.
xZk, can I ask you something about your code.

In OnEntityCreated you are using:

PHP Code:


		
			
SDKHook(entity, SDKHook_ThinkPost, OnThinkPost);

instead of SDKHook_OnSpawn to begin check for weapon and tracking.
Is it roughly speaking almost identical events in time for _weapon class to safe check its props?

PHP Code:


		
			
    HookEvent("round_start", Event_RoundReset);
    HookEvent("round_end", Event_RoundReset);
    HookEvent("round_freeze_end", Event_RoundFreezeEnd);

you are using "round_freeze_end" to begin tracking. This event is happen slightly later than "round_start".
What kind of error that case prevents?

And a recommendation:
Use EntIndexToEntRef when you pass entity index to a timer function.
Like:

PHP Code:


		
			
DelayClean[entity] = CreateTimer(1.0, CleanWeapon, EntIndexToEntRef(entity), TIMER_REPEAT);
...
public Action:CleanWeapon(Handle:timer, any:entRef) { 
    int weapon = EntRefToEntIndex(entRef);    
    if (weapon == 0 || weapon == INVALID_ENT_REFERENCE || !IsValidEntity(weapon))
        return Plugin_Stop;

Also, it looks like TIMER_FLAG_NO_MAPCHANGE flag is missing.

PHP Code:


		
			
                case 3: {  //Reset Timer on aiming
                    if (IsAimToPlayers(weapon)) {
                        _debug("Time: %d", ItemTime[weapon]);
                        return Plugin_Continue;
                    }
                }

you missed:

PHP Code:


		
			
ItemTime[weapon] = delayclear;

Quote:

OnEntityCreated => tracking
OnWeaponDrop => tracking

Request.
Maybe, add ConVar to track only the case when weapon dropped (do not track all spawned entities). To increase CPU performance.

Re: [L4D/L4D2]Weapon Cleaner

Gun does not work

"weapon_rifle_ak47,rifle_ak47"

Re: [L4D/L4D2]Weapon Cleaner

Quote:

Originally Posted by Dragokas (Post 2644159)

instead of SDKHook_OnSpawn to begin check for weapon and tracking.
Is it roughly speaking almost identical events in time for _weapon class to safe check its props?

At the beginning I used SDKHook_OnSpawn, but then i realized, I had to check the weapons that are left when a survivor (bot) is kicked, so that's why i only use event SDKHook_ThinkPost, since i also verified when the weapon on spawn. Although I was never suggesting how I should correctly verify those weapons, so i consider myself a newbie using SDKHooks :cry:

Quote:

Originally Posted by Dragokas (Post 2644159)

you are using "round_freeze_end" to begin tracking. This event is happen slightly later than "round_start".
What kind of error that case prevents?

is the simplest method I can think of, to exclude the weapons spawn on the map, example: weapon that are added using Stripper, weapons that do not belong to the class "weapon_spawn"

Quote:

Originally Posted by Dragokas (Post 2644159)

Also, it looks like TIMER_FLAG_NO_MAPCHANGE flag is missing.

About this I am not sure it is necessary, since I use the round_end event to stop the timers, also according to this forum the TIMER_FLAG_NO_MAPCHANGE can cause logs error with the KillTimer () function.

Quote:

Originally Posted by Dragokas (Post 2644159)

you missed:

thank you, fixed.

In the next version i will try to add a cvar to optionally detect the weapon spawned(do not track all spawned entities), the time did not give me to add it in this version :/, thanks for the suggestions Dragokas ☺

Re: [L4D/L4D2]Weapon Cleaner

Quote:

Originally Posted by yagura40977 (Post 2644247)

Gun does not work
"weapon_rifle_ak47,rifle_ak47"

I think you mean to exclude the ak47, so that it is not cleaned ?, then you just have to assign the cvar:

PHP Code:


		
			
weapon_cleaner_exclude "rifle_ak47"

pd:the prefix "weapon_" is not necessary. you can also exclude several weapons assigned their names in the same cvar example:
weapon_cleaner_exclude "shotgun_spas, sniper_military, rifle_ak47"

Re: [L4D/L4D2]Weapon Cleaner

xZk, thank you for explanation.

Quote:

So, in such case, you are right.

Re: [L4D/L4D2]Weapon Cleaner

Sorry I misunderstood Features

thank you for the explanation
normal work

[L4D2] Infected Loot Drops (2.3d)
https://forums.alliedmods.net/showthread.php?p=1099583

Generated item
Must discard items in order to work

Re: [L4D/L4D2]Weapon Cleaner

Quote:

Originally Posted by yagura40977 (Post 2644305)

I would recommend not using that plugin it leaks "weapon_spawn" entities because it does not remove them after spawning something from them.

PHP Code:


		
			
WeaponFactoryCreate(String:name[], bool:sim, Float:location[3])

{

    Log(sim, "Weapon Factory Creating: %s", name);

    

    if (!sim)

    {

        new entity = SpawnItem(_, _, _, "weapon_spawn", _, true);

        

        // Mod location so it spawns around mid level of model.

        location[2] += 10.0;

        

        // Create random velocity

        new Float:vel[3];

        vel[0] = GetRandomFloat(-80.0, 80.0);

        vel[1] = GetRandomFloat(-80.0, 80.0);

        vel[2] = GetRandomFloat(40.0, 80.0);

        

        DispatchKeyValueVector(entity, "origin", location);

        DispatchKeyValue(entity, "weapon_selection", name);

        DispatchKeyValue(entity, "spawnflags", "1");

        DispatchKeyValue(entity, "solid", "6");

        DispatchKeyValue(entity, "count", "1");

        DispatchKeyValue(entity, "body", "0");

        DispatchKeyValue(entity, "spawn_without_director", "1");

        

        SpawnItemFinish(entity, _, _, vel);

        AddThingCount(name, FACTORYNAME_WEAPON, 1);

    }

}



MeleeFactoryCreate(String:name[], bool:sim, Float:location[3])

{

    Log(sim, "Melee Factory Creating: %s", name);

    

    if (!sim)

    {

        new entity = SpawnItem(_, _, _, "weapon_melee_spawn", _, true);

        

        // Mod location so it spawns around mid level of model.

        location[2] += 10.0;

        

        // Create random velocity

        new Float:vel[3];

        vel[0] = GetRandomFloat(-80.0, 80.0);

        vel[1] = GetRandomFloat(-80.0, 80.0);

        vel[2] = GetRandomFloat(40.0, 80.0);

        

        DispatchKeyValueVector(entity, "origin", location);

        DispatchKeyValue(entity, "spawnflags", "1");

        DispatchKeyValue(entity, "solid", "6");

        DispatchKeyValue(entity, "count", "1");

        DispatchKeyValue(entity, "body", "0");

        DispatchKeyValue(entity, "melee_weapon", name);

        

        SpawnItemFinish(entity, _, _, vel);

        AddThingCount(name, FACTORYNAME_MELEE, 1);

    }

}

If a person picks up the weapon the weapon_spawn entity still exists because of how the game works.