SCR_VariableSightsFOVInfo Class Reference

Inheritance diagram for SCR_VariableSightsFOVInfo:

Protected Member Functions
override int	GetCount ()
override int	GetCurrentIndex ()
override void	SetIndex (int index)
override void	OnInit (IEntity owner, BaseSightsComponent sights)
override void	OnUpdate (IEntity owner, BaseSightsComponent sights, float timeSlice)
override bool	IsAdjusting ()
	Returns true when current FOV of the optic does not match the target FOV.
override float	GetCurrentFOV ()
override float	GetBaseFOV ()

Protected Attributes
ref array< float >	m_aFOVs
float	m_fInterpolationSpeed
float	m_fCurrentFOV = 60.0
	Immediate field of view value.
int	m_iCurrentIndex = -1
	Currently selected FOV or -1 if none.

Detailed Description

Definition at line 1 of file SCR_VariableSightsFOVInfo.c.

Member Function Documentation

GetBaseFOV()

override float SCR_VariableSightsFOVInfo::GetBaseFOV ( )

inlineprotected

Returns max field of view provided by this info. Assumes that first FOV is the largest one. Returns zero if FOVs array is empty.

Returns

Returns field of view in degrees.

Definition at line 104 of file SCR_VariableSightsFOVInfo.c.

GetCount()

override int SCR_VariableSightsFOVInfo::GetCount ( )

inlineprotected

Returns the number of available elements.

Definition at line 19 of file SCR_VariableSightsFOVInfo.c.

GetCurrentFOV()

override float SCR_VariableSightsFOVInfo::GetCurrentFOV ( )

inlineprotected

Returns current field of view provided by this info.

Returns

Returns field of view in degrees.

Definition at line 92 of file SCR_VariableSightsFOVInfo.c.

GetCurrentIndex()

override int SCR_VariableSightsFOVInfo::GetCurrentIndex ( )

inlineprotected

Returns currently selected element or -1 if none.

Definition at line 28 of file SCR_VariableSightsFOVInfo.c.

IsAdjusting()

override bool SCR_VariableSightsFOVInfo::IsAdjusting ( )

inlineprotected

Returns true when current FOV of the optic does not match the target FOV.

Definition at line 79 of file SCR_VariableSightsFOVInfo.c.

OnInit()

override void SCR_VariableSightsFOVInfo::OnInit ( IEntity owner, BaseSightsComponent sights )

inlineprotected

Called on initialization.

Parameters

owner	Parent weapon entity.
sights	Parent sights component.

Definition at line 49 of file SCR_VariableSightsFOVInfo.c.

OnUpdate()

override void SCR_VariableSightsFOVInfo::OnUpdate ( IEntity owner, BaseSightsComponent sights, float timeSlice )

inlineprotected

Called every frame when active to update current state.

Parameters

owner	Parent weapon entity.
sights	Parent sights component.
timeSlice	Delta of time since last update.

Definition at line 68 of file SCR_VariableSightsFOVInfo.c.

SetIndex()

override void SCR_VariableSightsFOVInfo::SetIndex ( int index )

inlineprotected

Set provided element as the current one.

Parameters

index

Index of FOV element.

Definition at line 38 of file SCR_VariableSightsFOVInfo.c.

Member Data Documentation

m_aFOVs

ref array<float> SCR_VariableSightsFOVInfo::m_aFOVs

protected

Definition at line 4 of file SCR_VariableSightsFOVInfo.c.

m_fCurrentFOV

float SCR_VariableSightsFOVInfo::m_fCurrentFOV = 60.0

protected

Immediate field of view value.

Definition at line 10 of file SCR_VariableSightsFOVInfo.c.

m_fInterpolationSpeed

float SCR_VariableSightsFOVInfo::m_fInterpolationSpeed

protected

Definition at line 7 of file SCR_VariableSightsFOVInfo.c.

m_iCurrentIndex

int SCR_VariableSightsFOVInfo::m_iCurrentIndex = -1

protected

Currently selected FOV or -1 if none.

Definition at line 13 of file SCR_VariableSightsFOVInfo.c.

---

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

• scripts/Game/Weapon/Sights/SightsFOVInfo/SCR_VariableSightsFOVInfo.c