SCR_BaseVariableSightsFOVInfo Interface Reference

Inheritance diagram for SCR_BaseVariableSightsFOVInfo:

Public Member Functions
int	GetCount ()
	Returns the number of available elements.
int	GetCurrentIndex ()
	Returns currently selected element or -1 if none.
bool	SetNext (bool allowOverflow=true)
	Selects next available element.
bool	SetPrevious (bool allowUnderflow=true)
	Selects previous available element.
bool	IsAdjusting ()
	Returns true when current FOV of the optic does not match the target FOV.
float	GetBaseFOV ()
	Returns true when current FOV of the optic does not match the target FOV.
Public Member Functions inherited from SightsFOVInfo
proto external float	GetFOV ()
	Returns current field of view provided by this info.

Protected Member Functions
int	GetNextIndex (bool allowOverflow=true)
	Returns the index of next available element.
int	GetPreviousIndex (bool allowUnderflow=true)
	Returns the index of previous available element.
void	SetIndex (int index)
	Set provided element as the current one.
Protected Member Functions inherited from ScriptedSightsFOVInfo
void	OnInit (IEntity owner, BaseSightsComponent sights)
	Called on initialization.
void	OnUpdate (IEntity owner, BaseSightsComponent sights, float timeSlice)
	Called every frame when active to update current state.
float	GetCurrentFOV ()
	Return current field of view of this info.

Member Function Documentation

GetBaseFOV()

float SCR_BaseVariableSightsFOVInfo.GetBaseFOV

(

)

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

Implemented in SCR_SightsZoomFOVInfo, and SCR_VariableSightsFOVInfo.

GetCount()

int SCR_BaseVariableSightsFOVInfo.GetCount

(

)

Returns the number of available elements.

Implemented in SCR_SightsZoomFOVInfo, and SCR_VariableSightsFOVInfo.

GetCurrentIndex()

int SCR_BaseVariableSightsFOVInfo.GetCurrentIndex

(

)

Returns currently selected element or -1 if none.

Implemented in SCR_SightsZoomFOVInfo, and SCR_VariableSightsFOVInfo.

GetNextIndex()

int SCR_BaseVariableSightsFOVInfo.GetNextIndex ( bool allowOverflow = true )

protected

Returns the index of next available element.

Parameters

allowOverflow

When enabled the selection will be able to cycle start to end.

Returns

Next index or -1 if none.

GetPreviousIndex()

int SCR_BaseVariableSightsFOVInfo.GetPreviousIndex ( bool allowUnderflow = true )

protected

Returns the index of previous available element.

Parameters

allowUnderflow

When enabled the selection will be able to cycle start to end.

Returns

Next index or -1 if none.

IsAdjusting()

bool SCR_BaseVariableSightsFOVInfo.IsAdjusting

(

)

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

Implemented in SCR_SightsZoomFOVInfo, and SCR_VariableSightsFOVInfo.

SetIndex()

void SCR_BaseVariableSightsFOVInfo.SetIndex ( int index )

protected

Set provided element as the current one.

Parameters

index

Index of FOV element.

Implemented in SCR_SightsZoomFOVInfo, and SCR_VariableSightsFOVInfo.

SetNext()

bool SCR_BaseVariableSightsFOVInfo.SetNext

(

bool

allowOverflow = true

)

Selects next available element.

Parameters

allowOverflow

When enabled the selection will be able to cycle start to end.

Returns

True on success, false otherwise.

SetPrevious()

bool SCR_BaseVariableSightsFOVInfo.SetPrevious

(

bool

allowUnderflow = true

)

Selects previous available element.

Parameters

allowUnderflow

When enabled the selection will be able to cycle start to end.

Returns

True on success, false otherwise.

---

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

• Game/Weapon/Sights/SightsFOVInfo/SCR_BaseVariableSightsFOVInfo.c