SCR_CharacterSprintingCondition Interface Reference

Returns true if character is sprinting. More...

Inheritance diagram for SCR_CharacterSprintingCondition:

Public Member Functions
override bool	IsAvailable (SCR_AvailableActionsConditionData data)
	Override and implement this method in any inherited conditions.
Public Member Functions inherited from SCR_AvailableActionCondition
bool	IsEnabled ()
	Getter for an enabled flag, disabled conditions are skipped, not evaluated at all.
bool	IsAvailable (SCR_AvailableActionsConditionData data)
	Override and implement this method in any inherited conditions.

Protected Attributes
float	m_fMinimumTime
Protected Attributes inherited from SCR_AvailableActionCondition
bool	m_bEnabled
bool	m_bNegateCondition

Additional Inherited Members
Protected Member Functions inherited from SCR_AvailableActionCondition
bool	GetReturnResult (bool desiredResult)
	Based on the state of m_bNegateCondition returns our desired result.

Detailed Description

Returns true if character is sprinting.

Set minimum time over zero to track temporary sprinting only. Set minimum time to zero to track both temporary and persistent sprinting. Set minimum time below zero to track persistent sprinting only.

Member Function Documentation

IsAvailable()

override bool SCR_CharacterSprintingCondition.IsAvailable

(

SCR_AvailableActionsConditionData

data

)

Override and implement this method in any inherited conditions.

Use GetReturnResult prior to returning the value to take m_bNegateCondition into account

Parameters

data

Returns

availability

Implements SCR_AvailableActionCondition.

Member Data Documentation

m_fMinimumTime

float SCR_CharacterSprintingCondition.m_fMinimumTime

protected

---

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

• Game/UI/HUD/AvailableActions/Conditions/Game/Character/SCR_CharacterSprintingCondition.c