SCR_SightsZoomFOVInfo Class Reference

Inheritance diagram for SCR_SightsZoomFOVInfo:

Protected Member Functions
override int	GetCount ()
	Returns the number of available elements.
override int	GetCurrentIndex ()
	Returns currently selected element or -1 if none.
override void	SetIndex (int index)
override void	OnInit (IEntity owner, BaseSightsComponent sights)
override void	OnUpdate (IEntity owner, BaseSightsComponent sights, float timeSlice)
override float	GetCurrentFOV ()
array< float >	ZoomsToArray ()
	Get array of each zoom based on min-max and steps in between.
void	InsertFov (float fov)
	Add new fov based on reticle range and zoom.
int	GetStepsCount ()
void	SetCurrentFov (float fov)
float	GetZoom (int i, int count)
float	GetCurrentZoom ()
float	GetBaseZoom ()
override float	GetBaseFOV ()
override bool	IsAdjusting ()
	Returns true when current FOV of the optic does not match the target FOV.
void	ForceUpdate (IEntity owner, BaseSightsComponent sights, float timeSlice)

Protected Attributes
float	m_fBaseZoom
float	m_fZoomMax
float	m_fStepZoomSize
float	m_fInterpolationSpeed
ref array< float >	m_aFOVs = new array<float>
int	m_iStepsCount = 1
float	m_fCurrentFOV
	Immediate field of view value.
int	m_iCurrentIndex = 0
	Currently selected FOV or 0 (as base fov) if none.
ref ScriptInvoker< float, float >	event_OnZoomChanged
return	event_OnZoomChanged

Detailed Description

Definition at line 6 of file SCR_SightsZoomFOVInfo.c.

Member Function Documentation

ForceUpdate()

void SCR_SightsZoomFOVInfo::ForceUpdate ( IEntity owner, BaseSightsComponent sights, float timeSlice )

inlineprotected

Definition at line 202 of file SCR_SightsZoomFOVInfo.c.

GetBaseFOV()

override float SCR_SightsZoomFOVInfo::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 184 of file SCR_SightsZoomFOVInfo.c.

GetBaseZoom()

float SCR_SightsZoomFOVInfo::GetBaseZoom ( )

inlineprotected

Definition at line 168 of file SCR_SightsZoomFOVInfo.c.

GetCount()

override int SCR_SightsZoomFOVInfo::GetCount ( )

inlineprotected

Returns the number of available elements.

Definition at line 33 of file SCR_SightsZoomFOVInfo.c.

GetCurrentFOV()

override float SCR_SightsZoomFOVInfo::GetCurrentFOV ( )

inlineprotected

Returns current field of view provided by this info.

Returns

Returns field of view in degrees.

Definition at line 93 of file SCR_SightsZoomFOVInfo.c.

GetCurrentIndex()

override int SCR_SightsZoomFOVInfo::GetCurrentIndex ( )

inlineprotected

Returns currently selected element or -1 if none.

Definition at line 37 of file SCR_SightsZoomFOVInfo.c.

GetCurrentZoom()

float SCR_SightsZoomFOVInfo::GetCurrentZoom ( )

inlineprotected

Definition at line 154 of file SCR_SightsZoomFOVInfo.c.

GetStepsCount()

int SCR_SightsZoomFOVInfo::GetStepsCount ( )

inlineprotected

Definition at line 133 of file SCR_SightsZoomFOVInfo.c.

GetZoom()

float SCR_SightsZoomFOVInfo::GetZoom ( int i, int count )

inlineprotected

Definition at line 145 of file SCR_SightsZoomFOVInfo.c.

InsertFov()

void SCR_SightsZoomFOVInfo::InsertFov ( float fov )

inlineprotected

Add new fov based on reticle range and zoom.

Definition at line 127 of file SCR_SightsZoomFOVInfo.c.

IsAdjusting()

override bool SCR_SightsZoomFOVInfo::IsAdjusting ( )

inlineprotected

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

Definition at line 194 of file SCR_SightsZoomFOVInfo.c.

OnInit()

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

inlineprotected

Definition at line 51 of file SCR_SightsZoomFOVInfo.c.

OnUpdate()

override void SCR_SightsZoomFOVInfo::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 72 of file SCR_SightsZoomFOVInfo.c.

SetCurrentFov()

void SCR_SightsZoomFOVInfo::SetCurrentFov ( float fov )

inlineprotected

Definition at line 139 of file SCR_SightsZoomFOVInfo.c.

SetIndex()

override void SCR_SightsZoomFOVInfo::SetIndex ( int index )

inlineprotected

Set provided element as the current one.

Parameters

index

Index of FOV element.

Definition at line 44 of file SCR_SightsZoomFOVInfo.c.

ZoomsToArray()

array< float > SCR_SightsZoomFOVInfo::ZoomsToArray ( )

inlineprotected

Get array of each zoom based on min-max and steps in between.

Definition at line 100 of file SCR_SightsZoomFOVInfo.c.

Member Data Documentation

event_OnZoomChanged [1/2]

return SCR_SightsZoomFOVInfo::event_OnZoomChanged

protected

Initial value:

{
        if (!event_OnZoomChanged)
            event_OnZoomChanged = new ScriptInvoker()

Definition at line 217 of file SCR_SightsZoomFOVInfo.c.

event_OnZoomChanged [2/2]

ref ScriptInvoker<float, float> SCR_SightsZoomFOVInfo::event_OnZoomChanged

protected

Definition at line 29 of file SCR_SightsZoomFOVInfo.c.

m_aFOVs

ref array<float> SCR_SightsZoomFOVInfo::m_aFOVs = new array<float>

protected

Definition at line 20 of file SCR_SightsZoomFOVInfo.c.

m_fBaseZoom

float SCR_SightsZoomFOVInfo::m_fBaseZoom

protected

Definition at line 9 of file SCR_SightsZoomFOVInfo.c.

m_fCurrentFOV

float SCR_SightsZoomFOVInfo::m_fCurrentFOV

protected

Immediate field of view value.

Definition at line 24 of file SCR_SightsZoomFOVInfo.c.

m_fInterpolationSpeed

float SCR_SightsZoomFOVInfo::m_fInterpolationSpeed

protected

Definition at line 18 of file SCR_SightsZoomFOVInfo.c.

m_fStepZoomSize

float SCR_SightsZoomFOVInfo::m_fStepZoomSize

protected

Definition at line 15 of file SCR_SightsZoomFOVInfo.c.

m_fZoomMax

float SCR_SightsZoomFOVInfo::m_fZoomMax

protected

Definition at line 12 of file SCR_SightsZoomFOVInfo.c.

m_iCurrentIndex

int SCR_SightsZoomFOVInfo::m_iCurrentIndex = 0

protected

Currently selected FOV or 0 (as base fov) if none.

Definition at line 27 of file SCR_SightsZoomFOVInfo.c.

m_iStepsCount

int SCR_SightsZoomFOVInfo::m_iStepsCount = 1

protected

Definition at line 21 of file SCR_SightsZoomFOVInfo.c.

---

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

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