SCR_WeaponAttachmentAttributes Interface Reference

Inheritance diagram for SCR_WeaponAttachmentAttributes:

Public Member Functions
bool	ApplyModifiers (BaseWeaponStatsManagerComponent statsManager, int muzzleIndex, IEntity attachedEntity)
	Apply Modifiers to weapon on attach.
void	ClearModifiers (BaseWeaponStatsManagerComponent statsManager, int muzzleIndex, IEntity attachedEntity)
	Clear the modifiers from a weapon on detach This is called before an attachment is removed from a weapon.
Public Member Functions inherited from AttachmentAttributes
proto external BaseAttachmentType	GetAttachmentType ()

Member Function Documentation

ApplyModifiers()

bool SCR_WeaponAttachmentAttributes.ApplyModifiers	(	BaseWeaponStatsManagerComponent	statsManager,
		int	muzzleIndex,
		IEntity	attachedEntity )

Apply Modifiers to weapon on attach.

This is called when an attachment has been attached to a weapon.

Parameters

statsManager	The stats manager that called this function. All modifiers should be set through this
muzzleIndex	The index of the muzzle, if applicable. This has no real meaning to this function except that it should be passed on to muzzle related functions. Can be -1 (which indicates that this attachment was done on a non-muzzle attachment slot) or a non-zero integer. See below
attachedEntity	The entity being attached

The muzzle index can be interpreted only as a far as -1 means that the attachment was not attached to a muzzle. Other than that, the index should be passed on to functions without modification.

Implemented in SCR_WeaponAttachmentBayonetAttributes, and SCR_WeaponAttachmentSuppressorAttributes.

ClearModifiers()

void SCR_WeaponAttachmentAttributes.ClearModifiers	(	BaseWeaponStatsManagerComponent	statsManager,
		int	muzzleIndex,
		IEntity	attachedEntity )

Clear the modifiers from a weapon on detach This is called before an attachment is removed from a weapon.

Parameters

statsManager	The stats manager that called this function. All modifiers should be set through this
muzzleIndex	The index of the muzzle, if applicable. This has no real meaning to this function except that it should be passed on to muzzle related functions. Can be -1 (which indicates that this attachment was done on a non-muzzle attachment slot) or a non-zero integer.
attachedEntity	The entity being detached

See also ApplyModifiers

Implemented in SCR_WeaponAttachmentBayonetAttributes, and SCR_WeaponAttachmentSuppressorAttributes.

---

The documentation for this interface was generated from the following file:

• Game/Inventory/SCR_WeaponAttachmentAttributes.c