ScriptedWeaponAimModifier Interface Reference

Inheritance diagram for ScriptedWeaponAimModifier:

Protected Member Functions
void	OnInit (IEntity weaponEnt)
void	OnActivated (IEntity weaponOwner)
	Called when owner weapon is enabled via parent owner (taken into hands, manned...)
void	OnDeactivated (IEntity weaponOwner)
	Called when owner weapon is disabled via parent owner (dropped, changed, unmanned ...)
void	OnCalculate (IEntity owner, WeaponAimModifierContext context, float timeSlice, out vector translation, out vector rotation, out vector turnOffset)
	This method is ticked each frame as long as the aim modifier is active.
void	OnWeaponFired ()

Member Function Documentation

OnActivated()

void ScriptedWeaponAimModifier.OnActivated ( IEntity weaponOwner )

protected

Called when owner weapon is enabled via parent owner (taken into hands, manned...)

Parameters

weaponOwner

Entity that activated this weapon

Implemented in OnHitAimModifier, and TestAimModifier.

OnCalculate()

void ScriptedWeaponAimModifier.OnCalculate ( IEntity owner, WeaponAimModifierContext context, float timeSlice, out vector translation, out vector rotation, out vector turnOffset )

protected

This method is ticked each frame as long as the aim modifier is active.

Parameters

owner	Owner of this modifier. Not parent manager, but weapon itself.
context	Context that defines circumstances for this aim modifier or null if none.
timeSlice	Delta time since last update
translation	Out translation in meters
rotation	Out rotation in degrees in <yaw, pitch, roll> format
turnOffset	Out aiming rotation change in degrees <pitch, yaw, unused>

Implemented in OnHitAimModifier, and TestAimModifier.

OnDeactivated()

void ScriptedWeaponAimModifier.OnDeactivated ( IEntity weaponOwner )

protected

Called when owner weapon is disabled via parent owner (dropped, changed, unmanned ...)

Parameters

weaponOwner

Entity that lost (deactivated) this weapon

Implemented in OnHitAimModifier.

OnInit()

void ScriptedWeaponAimModifier.OnInit ( IEntity weaponEnt )

protected

Implemented in OnHitAimModifier, SCR_RecoilForceAimModifier, and TestAimModifier.

OnWeaponFired()

void ScriptedWeaponAimModifier.OnWeaponFired ( )

protected

Implemented in SCR_RecoilForceAimModifier, and TestAimModifier.

---

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

• Game/generated/Weapon/ScriptedWeaponAimModifier.c