SCR_RecoilCameraShakeParams Interface Reference

Inheritance diagram for SCR_RecoilCameraShakeParams:

Public Member Functions
float	GetStanceImpulseMagnitude (float dynamicStance)
	Returns impulse magnitude for dynamic character stance.
float	GetStanceMagnitude (float dynamicStance)
	Returns continuous magnitude for dynamic character stance.
float	GetFovScale (float progress01)
	Returns field of view scale <0, 1> based on input parameters.
vector	GetRandomTranslation (bool onSphere=false)
	Returns random translation in the right, up, forward format.
vector	GetRandomAnglesImpulse (bool onSphere=false)
vector	GetRandomYawPitchRollImpulse (bool onSphere=false)

Public Attributes
float	m_fBlendInTime
	The duration (or sharpness) of shake blend in transition.
float	m_fBlendOutTime
	The duration (or sharpness) of shake blend out transition.
float	m_fMaxVelocity
	Maximum velocity of smoothing.
float	m_fRecoilTarget
	The target value at which "shake" is considered to be at its peak.
float	m_fMaximumPercentage
	The final allowed scale of the recoil.
float	m_fMinImpulseThreshold
float	m_fMinImpulseRate
float	m_fImpulseCrouchMagnitudeModifier
float	m_fImpulseProneMagnitudeModifier
float	m_fCrouchMagnitudeModifier
float	m_fProneMagnitudeModifier

Protected Member Functions
float	GetMagnitude (float stance, float crouch, float prone, float erect)
float	RandomFloat (float min, float max)
	Generates a random float in both the positive and negative interval based on provided parameters.
vector	RandomVector (vector min, vector max)
	Generates random vector.
vector	RandomVectorSphere (vector min, vector max, bool uniform=true)
	Generates random vector using a random point on a sphere from provided parameters.

Protected Attributes
vector	m_vTranslationMin
vector	m_vTranslationMax
float	m_fFOVModifier
	The percentage of FOV used when shake is at max value.
vector	m_vRotationImpulseMin
vector	m_vRotationImpulseMax
ref RandomGenerator	m_pRandomGenerator = new RandomGenerator()
	Generator used for generating points and ranges of values fed into the shake function.

Member Function Documentation

GetFovScale()

float SCR_RecoilCameraShakeParams.GetFovScale

(

float

progress01

)

Returns field of view scale <0, 1> based on input parameters.

GetMagnitude()

float SCR_RecoilCameraShakeParams.GetMagnitude ( float stance, float crouch, float prone, float erect )

protected

GetRandomAnglesImpulse()

vector SCR_RecoilCameraShakeParams.GetRandomAnglesImpulse

(

bool

onSphere = false

)

GetRandomTranslation()

vector SCR_RecoilCameraShakeParams.GetRandomTranslation

(

bool

onSphere = false

)

Returns random translation in the right, up, forward format.

GetRandomYawPitchRollImpulse()

vector SCR_RecoilCameraShakeParams.GetRandomYawPitchRollImpulse

(

bool

onSphere = false

)

GetStanceImpulseMagnitude()

float SCR_RecoilCameraShakeParams.GetStanceImpulseMagnitude

(

float

dynamicStance

)

Returns impulse magnitude for dynamic character stance.

Parameters

dynamicStance

Dynamic stance value of character (0=prone, 0.5=crouch, 1=erect)

GetStanceMagnitude()

float SCR_RecoilCameraShakeParams.GetStanceMagnitude

(

float

dynamicStance

)

Returns continuous magnitude for dynamic character stance.

Parameters

dynamicStance

Dynamic stance value of character (0=prone, 0.5=crouch, 1=erect)

RandomFloat()

float SCR_RecoilCameraShakeParams.RandomFloat ( float min, float max )

protected

Generates a random float in both the positive and negative interval based on provided parameters.

RandomVector()

vector SCR_RecoilCameraShakeParams.RandomVector ( vector min, vector max )

protected

Generates random vector.

RandomVectorSphere()

vector SCR_RecoilCameraShakeParams.RandomVectorSphere ( vector min, vector max, bool uniform = true )

protected

Generates random vector using a random point on a sphere from provided parameters.

Member Data Documentation

m_fBlendInTime

float SCR_RecoilCameraShakeParams.m_fBlendInTime

The duration (or sharpness) of shake blend in transition.

m_fBlendOutTime

float SCR_RecoilCameraShakeParams.m_fBlendOutTime

The duration (or sharpness) of shake blend out transition.

m_fCrouchMagnitudeModifier

float SCR_RecoilCameraShakeParams.m_fCrouchMagnitudeModifier

m_fFOVModifier

float SCR_RecoilCameraShakeParams.m_fFOVModifier

protected

The percentage of FOV used when shake is at max value.

m_fImpulseCrouchMagnitudeModifier

float SCR_RecoilCameraShakeParams.m_fImpulseCrouchMagnitudeModifier

m_fImpulseProneMagnitudeModifier

float SCR_RecoilCameraShakeParams.m_fImpulseProneMagnitudeModifier

m_fMaximumPercentage

float SCR_RecoilCameraShakeParams.m_fMaximumPercentage

The final allowed scale of the recoil.

Clamps recoil after scaled by m_fRecoilTarget.

m_fMaxVelocity

float SCR_RecoilCameraShakeParams.m_fMaxVelocity

Maximum velocity of smoothing.

m_fMinImpulseRate

float SCR_RecoilCameraShakeParams.m_fMinImpulseRate

m_fMinImpulseThreshold

float SCR_RecoilCameraShakeParams.m_fMinImpulseThreshold

m_fProneMagnitudeModifier

float SCR_RecoilCameraShakeParams.m_fProneMagnitudeModifier

m_fRecoilTarget

float SCR_RecoilCameraShakeParams.m_fRecoilTarget

The target value at which "shake" is considered to be at its peak.

The maximum z translation that recoil is scaled against.

m_pRandomGenerator

ref RandomGenerator SCR_RecoilCameraShakeParams.m_pRandomGenerator = new RandomGenerator()

protected

Generator used for generating points and ranges of values fed into the shake function.

m_vRotationImpulseMax

vector SCR_RecoilCameraShakeParams.m_vRotationImpulseMax

protected

m_vRotationImpulseMin

vector SCR_RecoilCameraShakeParams.m_vRotationImpulseMin

protected

m_vTranslationMax

vector SCR_RecoilCameraShakeParams.m_vTranslationMax

protected

m_vTranslationMin

vector SCR_RecoilCameraShakeParams.m_vTranslationMin

protected

---

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

• Game/Camera/Shake/SCR_RecoilCameraShakeParams.c