OnHitAimModifier Interface Reference

ONHIT AIM MODIFIER. More...

Inheritance diagram for OnHitAimModifier:

Public Member Functions
void	OnDamage (BaseDamageContext damageContext)
override 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.

Static Public Attributes
const float	m_fEffectScale = 80

Protected Member Functions
override void	OnInit (IEntity weaponEnt)
override void	OnActivated (IEntity weaponOwner)
	Called when owner weapon is enabled via parent owner (taken into hands, manned...)
override void	OnDeactivated (IEntity weaponOwner)
	Called when owner weapon is disabled via parent owner (dropped, changed, unmanned ...)
vector	VectorSpring (vector current, vector target, inout vector velocity, float spring, float damping, float dt)
Protected Member Functions inherited from ScriptedWeaponAimModifier
void	OnWeaponFired ()

Protected Attributes
float	m_fLinearScale
float	m_fAngularScale
float	m_fSpring
float	m_fDamping
float	m_fSpringSpeed
float	m_fDecaySpeed
float	m_fRollRotationIntensity
float	m_fYawRotationIntensity
float	m_fPitchRotationIntensity
IEntity	m_pOwner

Detailed Description

ONHIT AIM MODIFIER.

Member Function Documentation

OnActivated()

override void OnHitAimModifier.OnActivated ( IEntity weaponOwner )

protected

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

Parameters

weaponOwner

Entity that activated this weapon

Implements ScriptedWeaponAimModifier.

OnCalculate()

override void OnHitAimModifier.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.

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>

Implements ScriptedWeaponAimModifier.

OnDamage()

void OnHitAimModifier.OnDamage

(

BaseDamageContext

damageContext

)

OnDeactivated()

override void OnHitAimModifier.OnDeactivated ( IEntity weaponOwner )

protected

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

Parameters

weaponOwner

Entity that lost (deactivated) this weapon

Implements ScriptedWeaponAimModifier.

OnInit()

override void OnHitAimModifier.OnInit ( IEntity weaponEnt )

protected

Implements ScriptedWeaponAimModifier.

VectorSpring()

vector OnHitAimModifier.VectorSpring ( vector current, vector target, inout vector velocity, float spring, float damping, float dt )

protected

Member Data Documentation

m_fAngularScale

float OnHitAimModifier.m_fAngularScale

protected

m_fDamping

float OnHitAimModifier.m_fDamping

protected

m_fDecaySpeed

float OnHitAimModifier.m_fDecaySpeed

protected

m_fEffectScale

const float OnHitAimModifier.m_fEffectScale = 80

static

m_fLinearScale

float OnHitAimModifier.m_fLinearScale

protected

m_fPitchRotationIntensity

float OnHitAimModifier.m_fPitchRotationIntensity

protected

m_fRollRotationIntensity

float OnHitAimModifier.m_fRollRotationIntensity

protected

m_fSpring

float OnHitAimModifier.m_fSpring

protected

m_fSpringSpeed

float OnHitAimModifier.m_fSpringSpeed

protected

m_fYawRotationIntensity

float OnHitAimModifier.m_fYawRotationIntensity

protected

m_pOwner

IEntity OnHitAimModifier.m_pOwner

protected

---

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

• GameCode/Weapon/OnHitAimModifier.c