ScriptedWeaponAimModifier Class Reference

Inheritance diagram for ScriptedWeaponAimModifier:

Protected Member Functions
void	OnInit (IEntity weaponEnt)
void	OnActivated (IEntity weaponOwner)
void	OnDeactivated (IEntity weaponOwner)
void	OnCalculate (IEntity owner, WeaponAimModifierContext context, float timeSlice, out vector translation, out vector rotation, out vector turnOffset)
void	OnWeaponFired ()
void	OnInit (IEntity weaponEnt)
void	OnActivated (IEntity weaponOwner)
void	OnDeactivated (IEntity weaponOwner)
void	OnCalculate (IEntity owner, WeaponAimModifierContext context, float timeSlice, out vector translation, out vector rotation, out vector turnOffset)
void	OnWeaponFired ()

Detailed Description

Definition at line 12 of file ScriptedWeaponAimModifier.c.

Member Function Documentation

OnActivated() [1/2]

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

OnActivated() [2/2]

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

OnCalculate() [1/2]

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>

OnCalculate() [2/2]

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>

OnDeactivated() [1/2]

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

OnDeactivated() [2/2]

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

OnInit() [1/2]

void ScriptedWeaponAimModifier::OnInit ( IEntity weaponEnt )

protected

OnInit() [2/2]

void ScriptedWeaponAimModifier::OnInit ( IEntity weaponEnt )

protected

OnWeaponFired() [1/2]

void ScriptedWeaponAimModifier::OnWeaponFired ( )

protected

OnWeaponFired() [2/2]

void ScriptedWeaponAimModifier::OnWeaponFired ( )

protected

---

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

• scripts/Game/generated/Weapon/ScriptedWeaponAimModifier.c