[Silvers]

Features:

• Allows 3rd party plugins to attach stuff to weapons viewmodel/worldmodel.
• Detects when a player changes model and fixes attachments to their player model and weapons.

About:

• Creates hidden replicas of clients weapon worldmodel when required by other plugins, to save multiple duplicated entities and resources.
• Fixes attachments to Weapons as required, by dropping the weapon for 0.1 seconds (set by attachments_api_equip cvar) and re-equipping.
• Fixes attachments to player models by changing the attachment index when a players old/new model attachment name match. Checks every 0.1 seconds (set by attachments_api_check cvar)
  (currently only supports and required by L4D1 & L4D2. For example CS:GO needs data/attachments_api.csgo.cfg config data filling out if any plugins change players model, request support if required).

Thanks:

• "Lux" - Various ideas and code.
• "Voevoda" - Testing and bug reports.

Plugins using Attachment_API:

• [CS:GO/L4D1/L4D2] Weapon Charms
• [L4D & L4D2] Glare

Known plugins this fixes (plugins that attach items to players):

• [L4D & L4D2] Extinguisher & Flamethrower
• [L4D & L4D2] Flare
• [L4D & L4D2] Flashlight
• [L4D & L4D2] Glare
• [L4D & L4D2] Hats

Known plugins (model changers) causing attachment bugs on players:

• [L4D & L4D2] Character Select Menu
• [L4D2] Swap Character

Natives and Information for developers:

Spoiler

Extracting Attachment Names:
To support additional models for the attachment fix when changing player models.

1. Use GCFScape or other VPK extractor to open pak01_dir.vpk etc.
2. Extract the .mdl files you want to get the attachment points from.
3. Use Crowbar to decompile the .mdl files to retrieve the .qc files.
4. Put those .qc files somewhere in your server e.g. left4dead2/models/QC.
5. Run the command sm_attachment_qc "models/QC" specifying the path to your QC folder.
6. This will save the model attachments data to sourcemod/data/attachments_new.cfg.
7. Merge this data with the main config attachments_api.<game>.cfg file (avoid duplicate model entries).
8. Please post any missing models/data so others can benefit.

About:

• This plugin creates a hidden replica of the clients weapon viewmodel and worldmodel. Only when required.
• This is the only way to attach entities to weapons otherwise they would be invisible.
• This method saves other plugins from creating multiple duplicated entities when we only need one.
• This method also handles fixing attachments when a clients model changes (CSM plugin in L4D1/L4D2) to prevent extra duplicated code and wasted resources.
• The natives allow retrieving the entity index to attach to. The forwards allow you to change or fix your attachments.
• See the "Glare" and "Weapon Charms" plugins I created for usage examples.

PHP Code:

/**
 * Creates or retrieves the specified clients weapon worldmodel entity for attaching other entities to.
 * @remarks            Never delete the returned entity index. Use ClearParent input on your entity instead and delete your attached entity.
 *
 * @param client       Client index to affect.
 * @param weapon       Weapon index to affect.
 *
 * @return             Entity index for attachments.
 */
native int Attachments_GetViewModel(int client, int weapon);

/**
 * Creates or retrieves the specified clients weapon worldmodel entity for attaching other entities to.
 * @remarks            Never delete the returned entity index. Use ClearParent input on your entity instead and delete your attached entity.
 *
 * @param client       Client index to affect.
 * @param weapon       Weapon index to affect.
 *
 * @return             Entity index for attachments.
 */
native int Attachments_GetWorldModel(int client, int weapon);



/**
 * @brief              Called whenever a client switches weapons
 * @remarks            This happens after Attachments_API has changed the replica model and re-attached to the weapon.
 *
 * @param client       The clients entity index
 * @param weapon       The weapons entity index or -1 if missing
 * @param ent_views    The ViewModel entity index or -1 if missing
 * @param ent_world    The WorldModel entity index or -1 if missing
 */
forward void Attachments_OnWeaponSwitch(int client, int weapon, int ent_views, int ent_world);

/**
 * @brief              Called whenever a clients model changes (requires cvar "attachments_api_models" value "1" to enable)
 *
 * @param client       The clients entity index
 */
forward void Attachments_OnModelChanged(int client);

/**
 * @brief              Called whenever the plugin is unloading so other plugins can delete their attachments.
 *
 */
forward void Attachments_OnPluginEnd();

/**
 * @brief              Called whenever the plugin is late loaded so other plugins can attach their stuff.
 *
 */
forward void Attachments_OnLateLoad(); 


Admin Commands: (requires "z" flag)

PHP Code:

sm_attachment_qc        // Parses .qc files to get model attachment names. Usage: sm_parse_qc <folder path to .qc files>. Saves to sourcemod/data/attachments_new.cfg.
sm_attachment_reload    // Reload the attachments config: sourcemod/data/attachments_api.<game>.cfg 


CVars:

Saved to attachments_api.cfg in your servers \cfg\sourcemod\ folder.

PHP Code:

// How often to check if a players model has changed. Requires "attachments_api_models" value "1" to enable.
attachments_api_check "0.1"

// When weapons have attachments and a players model has changed, how long to drop the weapon before re-equipping to fix.
attachments_api_equip "0.1"

// 0=Off, 1=Detect when a players model changes to fix attachments to players (required by plugins attaching stuff to players).
attachments_api_models "1" in L4D1/L4D2. "0" in other games (change if required, see "Information for developers" for adding attachment names).

// 0=Off, 1=Detect when a players model changes to fix attachments to weapons (required by plugins attaching stuff to weapons).
attachments_api_weapons "1" in L4D1/L4D2. "0" in other games (change if required, see "Information for developers" for adding attachment names).

// Attachments API plugin version.
attachments_api_version 


Changes:

1.17 (22-Nov-2023)
    - L4D & L4D2: Fixed error when a client has no weapon. Thanks to "Krufftys Killers" for reporting.

1.16 (01-Oct-2023)
    - Delayed model changed detection on player spawn to prevent attachment issues. Thanks to "little_froy" for reporting.

1.15 (28-Sep-2023)
    - L4D and L4D2: Fixed dual pistols creating an extra weapon when changing player skins. Thanks to "kochiurun119" for reporting.

1.14 (25-Sep-2023)
    - L4D and L4D2: Fixed invalid property errors. Thanks to "ur5efj" for reporting.

1.13 (25-Sep-2023)
    - L4D and L4D2: Fixed dual pistols not carrying over on model change. Thanks to "kochiurun119" for reporting.

1.12 (05-Sep-2023)
    - Fixed invalid handle error. Thanks to "Voevoda" for reporting.

1.11 (31-Mar-2023)
    - Fix to detect model change on team swap. Thanks to "Voevoda" for reporting.

1.10 (30-Jul-2022)
    - Changes to fix the incorrect weapon showing in OnWeaponSwitch when spawning.
    - Changes to clean up some variables on round end. Probably not required.

1.9 (04-Dec-2021)
    - Changes to fix warnings when compiling on SourceMod 1.11.
    - Fixed leaking 1 handle.

1.8 (27-Jun-2021)
    - Fixed and cleaned some of the plugin code.

    - L4D2: Updated "data/attachments_api.l4d2.cfg" to support changes from the latest update.
    - This fixes model attachment positions which otherwise was broken.

1.7 (20-Apr-2021)
    - Fixed a "Client is not in game" error being thrown. Thanks to "Krufftys Killers" for reporting.

1.6 (01-Oct-2020)
    - Added support for following weapons "m_nSkin" value. Fixes L4D2 new weapon skins.
    - Changes attempting to fix the "prop_dynamic_override" blocking players +USE ability. Thanks to "Lux".

1.5 (25-Jul-2020)
    - Fixed picking up weapons not always triggering "Attachments_OnWeaponSwitch" (game bug).

1.4 (20-Jul-2020)
    - L4D2: Added a fix for climbing ladders, plugin deletes the weapon viewmodel when climbing.
    - This ladder fix will break other plugins using the "Attachments_API" weapon viewmodel.
    - This ladder fix sends out the "Attachments_OnWeaponSwitch" forward with the weapon index -1.
    - Plugins attaching to the viewmodel should be accounting for "Attachments_OnWeaponSwitch" to -1 anyway.
    - Other games that hide weapons when climbing ladders need adding, please report if required.

1.3 (11-Jul-2020)
    - Fixed not triggering weapon equip when a player dropped their last weapon and equipped the same one again.

1.2 (05-Jul-2020)
    - Fixed invalid entity errors from version 1.1 update. Thanks to "Krufftys Killers" for reporting.

1.1 (04-Jul-2020)
    - Changed weapon switch to detect the actual current weapon, fixes some issues where the wrong weapon was being detected.
    - Fixed weapon switch forward triggering multiple times for the same weapon.
    - Fixed "attachments_api.cfg" cvars config not being generated.
    - Removed accidental IsFakeClient line that prevented monitoring bots for changing model. Thanks to "Alex101192" for reporting.

1.0 (01-Jul-2020)
    - Initial release.

Installation:

1. Download the .zip and extract the files to their respective folders in your servers \addons\sourcemod\ folder.

[Silvers]

Reserved.

[Alex101192]

So this plugin will fix survivors' weapons not being positioned correctly after somebody changes character with csm? Or just attachments to weapons? Not sure about it.

[Alex101192]

I tested this plugin very quick. The glare position is pretty much perfect. It lines up perfectly with the guns and changing characters does not break it or anything.

However the position of the gun itself is not correct. When changing characters using csm, it becomes incorrect as it was before.

[SkiPlix]

L4D2 Issue:
Switching to the First aid kit/defib/ammo packs then changing thirdperson on and off,
Creates a second model (only in first person, and barely visible with cl_viewmodelfovsurvivor 90)

[Alex101192]

I used !csc to change bots models in those pics so maybe the plugin only works with !csm and that's why the wrong weapon position seems to be happening only with csc. I didn't see any problems when players used !csm.

[Silvers]

Originally Posted by SkiPlix L4D2 Issue: Switching to the First aid kit/defib/ammo packs then changing thirdperson on and off, Creates a second model (only in first person, and barely visible with cl_viewmodelfovsurvivor 90)

Are you using Glare or Charms or both plugins with this? Maybe a conflict with another plugin that's resetting "m_bDrawViewmodel". I don't know of an alternate method to hiding the viewmodel (SetEntityRenderMode doesn't work on viewmodels, and SetTransmit would block from the client which isn't good and causes problems with them shooting the weapon). Are you using the ThirdPersonShoulder_Detect plugin? How are you changing to 3rd person view?

Originally Posted by Alex101192 I used !csc to change bots models in those pics so maybe the plugin only works with !csm and that's why the wrong weapon position seems to be happening only with csc. I didn't see any problems when players used !csm.

Ahh thanks for the report, I just noticed I left in the "IsFakeClient" line by accident, it's not supposed to be there so that's the reason it's failing for bots. Will update soon (you can search for "IsFakeClient", delete the line and recompile to fix).

[Alex101192]

Originally Posted by Silvers Ahh thanks for the report, I just noticed I left in the "IsFakeClient" line by accident, it's not supposed to be there so that's the reason it's failing for bots. Will update soon (you can search for "IsFakeClient", delete the line and recompile to fix).

Ah nice. Great to see this annoying issue being fixed after 10 years. Thank you so much for your work.

[Silvers]

Updated, required for Charms/Glare plugins (and any others using this).

1.1 (04-Jul-2020)
    - Changed weapon switch to detect the actual current weapon, fixes some issues where the wrong weapon was being detected.
    - Fixed weapon switch forward triggering multiple times for the same weapon.
    - Fixed "attachments_api.cfg" cvars config not being generated.
    - Removed accidental IsFakeClient line that prevented monitoring bots for changing model. Thanks to "Alex101192" for reporting.

[Krufftys Killers]

Getting this error
L 07/04/2020 - 00:54:15: SourceMod error session started
L 07/04/2020 - 00:54:15: Info (map "ch03_pripyat02") (file "C:\servers\killerrs\left4dead2\addons\source mod\logs\errors_20200704.log")
L 07/04/2020 - 00:54:15: [SM] Exception reported: Entity -1 (-1) is invalid
L 07/04/2020 - 00:54:15: [SM] Blaming: attachments_api.smx
L 07/04/2020 - 00:54:15: [SM] Call stack trace:
L 07/04/2020 - 00:54:15: [SM] [0] GetEntProp
L 07/04/2020 - 00:54:15: [SM] [1] Line 893, C:\Servers\L4D2\left4dead2\addons\sourcemod\s cripting\attachments_api.sp::OnWeaponSwitch
L 07/04/2020 - 01:098: Error log file session closed.