Arma Reforger Script API
Loading...
Searching...
No Matches
Protected Member Functions | List of all members
ScriptedWeaponAimModifier Interface Reference
Inheritance diagram for ScriptedWeaponAimModifier:
[legend]

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
weaponOwnerEntity that activated this weapon

Implemented in TestAimModifier, and OnHitAimModifier.

◆ 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
ownerOwner of this modifier. Not parent manager, but weapon itself.
contextContext that defines circumstances for this aim modifier or null if none.
timeSliceDelta time since last update
translationOut translation in meters
rotationOut rotation in degrees in <yaw, pitch, roll> format
turnOffsetOut aiming rotation change in degrees <pitch, yaw, unused>

Implemented in TestAimModifier, and OnHitAimModifier.

◆ OnDeactivated()

void ScriptedWeaponAimModifier.OnDeactivated ( IEntity  weaponOwner)
protected

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

Parameters
weaponOwnerEntity that lost (deactivated) this weapon

Implemented in OnHitAimModifier.

◆ OnInit()

void ScriptedWeaponAimModifier.OnInit ( IEntity  weaponEnt)
protected

Implemented in TestAimModifier, and OnHitAimModifier.

◆ OnWeaponFired()

void ScriptedWeaponAimModifier.OnWeaponFired ( )
protected

Implemented in TestAimModifier.


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