checkDuration - 18684092/Steering-Wheel-Project GitHub Wiki

CheckDuration

Access: Private

Prototype: bool checkDuration(Uint32 mS)

Parameters: Uint32 is a time in milli Seconds.

Return Value: Boolean true if within range, false otherwise.

Description: This is the duration of the effect. The effect is either applied for this amount of time or, in the case of a period effect like sine, it will repeat for this amount of time.

MIN_DURATION >= mS <= SDL_MAX_UINT32

Note: The duration can also be the constant FOREVER. The G27 will take very small durations such as 1 or 10 mS but the SimSteering behaves oddly with such small durations. You may wish to change the MIN_DURATION value. SimSteering accepts 50mS but a better approach is to run the effect for much longer and simply stopEffect() rather than use this duration parameter.

Related Functions: checkDuration, checkDelay, checkAttackLength(), checkFadeLength(), checkEnvelopeTime(), checkIterations(), checkLevel(), checkFadeLevel(), checkSatLevel(), checkCoEfLevel(), checkDeadband(), checkCentre(), checkAttackLevel(), checkEffectNumber(), checkHaptic(), checkParamsConstant(), checkParamsEnvelope(), checkParamsPeriod(), checkParamsCondition(), checkDirection(), checkPeriodType(), checkConditionType(), checkGain()