SCR_BaseVariableSightsFOVInfo Class Reference

Inheritance diagram for SCR_BaseVariableSightsFOVInfo:

Protected Member Functions
int	GetNextIndex (bool allowOverflow=true)
int	GetPreviousIndex (bool allowUnderflow=true)
void	SetIndex (int index)
bool	SetNext (bool allowOverflow=true)
bool	SetPrevious (bool allowUnderflow=true)
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.

Detailed Description

Definition at line 1 of file SCR_BaseVariableSightsFOVInfo.c.

Member Function Documentation

GetBaseFOV()

float SCR_BaseVariableSightsFOVInfo::GetBaseFOV ( )

inlineprotected

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

Definition at line 116 of file SCR_BaseVariableSightsFOVInfo.c.

GetNextIndex()

int SCR_BaseVariableSightsFOVInfo::GetNextIndex ( bool allowOverflow = true )

inlineprotected

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.

Definition at line 21 of file SCR_BaseVariableSightsFOVInfo.c.

GetPreviousIndex()

int SCR_BaseVariableSightsFOVInfo::GetPreviousIndex ( bool allowUnderflow = true )

inlineprotected

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.

Definition at line 46 of file SCR_BaseVariableSightsFOVInfo.c.

IsAdjusting()

bool SCR_BaseVariableSightsFOVInfo::IsAdjusting ( )

inlineprotected

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

Definition at line 109 of file SCR_BaseVariableSightsFOVInfo.c.

SetIndex()

void SCR_BaseVariableSightsFOVInfo::SetIndex ( int index )

protected

Set provided element as the current one.

Parameters

index

Index of FOV element.

SetNext()

bool SCR_BaseVariableSightsFOVInfo::SetNext ( bool allowOverflow = true )

inlineprotected

Selects next available element.

Parameters

allowOverflow

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

Returns

True on success, false otherwise.

Definition at line 77 of file SCR_BaseVariableSightsFOVInfo.c.

SetPrevious()

bool SCR_BaseVariableSightsFOVInfo::SetPrevious ( bool allowUnderflow = true )

inlineprotected

Selects previous available element.

Parameters

allowUnderflow

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

Returns

True on success, false otherwise.

Definition at line 95 of file SCR_BaseVariableSightsFOVInfo.c.

---

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

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