;---
;Main function to dynamically calculate the speed, braking and turning angle corrector, as well as set the flags for timers speed and braking
;---Beginning of function fnGearSpdBrk
fnGearSpdBrk(vParam0, vSpdBrk) ;The values for vSpdBrk (0 - no matter, 1 - speed of the timer, 2 - braking of the timer, 3 and higher - the other subprogramme)
{
;The constants function fnGearSpdBrk and all the subprogrammes who is calling, they are defined above under subprogramme "lVarGameTHQ".
;cFnSB_Learn||cFnSB_Speed||cFnSB_Brake||cFnSB_GT||cFnSB_Boost||cFnSB_Sharp||cFnSB_Turn||cFnSB_Above||
;          1            2            3         4            5            6           7            8

global ;All variables in the function will be global, it is necessary to comment to engage the directive "global" - should not be an empty string.
local fSpdBrk, vMComp, sLabel, vRetFn, vRetResult
static arSpdBrk := ["lFnSB_Learn","lFnSB_Speed","lFnSB_Brake","lFnSB_GT","lFnSB_Boost","lFnSB_Sharp","lFnSB_Turn","lFnSB_Above"] 
static cErFun := "Error in the function `" fnGearSpdBrk `". `n" 
static fRetDone := 0, fRetErr := -1 
  
  sLabel := arSpdBrk[vSpdBrk]
  if (!IsLabel(sLabel))
   {
		 msgbox, % vMsgOptionsEr 
							,Saints Row: The Third
              , %cErFun% Dynamic label with name = "%sLabel%" does not exist.`n`n %сErrOfExit%
              ,30
     ExitApp
    }
  ;a  := arSpdBrk[vSpdBrk]
  ;tooltip %a% = %vSpdBrk%
  vRetFn := fRetDone
  gosub, % arSpdBrk[vSpdBrk]
  if (vRetFn = fRetErr)
    {
		 sbLabel := SubStr(sLabel, 2)
     msgbox, % vMsgOptionsEr 
							,Saints Row: The Third
              , %cErFun% Semantic error in the sub-function = "%sbLabel%" `n`n %сErrOfExit%
              ,30
     ExitApp
    }  

return vRetResult
  
;Fast distillation the car
; cFnSB_Boost := 4
lFnSB_Boost:
  if (fKeyUpTimer) 
      {
        vBoostSpeed++
        if (vBoostSpeed>cBoostSpeed)
            {
              fKeyUpTimer:=false
              gosub lGearAddUp              
              vBoostSpeed := 0
              fKeyUpTimer:=true
              return vRetResult:=false
            }
          else
            return vRetResult:=true
      }
     else
      return vRetResult:=true
      
return vRetFn:=fRetErr

;Fast braking the car
; cFnSB_Sharp := 5
lFnSB_Sharp:
  if (fKeyDnTimer)
      {
        vSharpBrake++
        if (vSharpBrake>cSharpBrake)
            {
              fKeyDnTimer:=false
              gosub lGearAddDn             
              vSharpBrake := 0
              fKeyDnTimer:=true
              return vRetResult:=false ;Allow the timer subroutine work - the speed has changed.
            }
          else
            return vRetResult:=true    ;Forbid the timer subroutine work - speed does not change.        
      }
     else
      return vRetResult:=true         ;If fKeyDnTimer:=false flag allow or deny? As long as I think will be correct - forbid.
          
return vRetFn:=fRetErr

;Block of the control gear shifting
; cFnSB_GT    := 3
lFnSB_GT:
  if (!vRShX)
        return
  if (iGear<>iGearTrc)
        gosub lSetTimerOff
      else
        return
  if (iGear=1)
      {
        fnPlaySoundTHQ(iSoundSpeedMin)
        Goto, lFnSB_GT_Exit 
      }
  if (iGear=cMaxGear)
      {
        fnPlaySoundTHQ(iSoundSpeedMax)
        Goto, lFnSB_GT_Exit
      }  
  if (iGear>=iGearTrc)		
        fnPlaySoundTHQ(iSoundSpeedUp)
      else
        fnPlaySoundTHQ(iSoundSpeedDn)
  lFnSB_GT_Exit:            
      iGearTrc:=iGear			 
      gosub lSetTimerOn
  return     

return vRetFn:=fRetErr

;The block checks the flags and the initial values for the correction of the rotation.
lFnSB_Turn:
    ;fUDLR := True
      Send, {%vParam0% Down}
        sleep %td20_Sleep%
      Send, {%vParam0% Up}    
    ;fUDLR := False    
  return 
      
return vRetFn:=fRetErr
      
;Block checking and setting lock timer - do not touch hands. I'm kidding it
; cFnSB_Speed := 1
; cFnSB_Brake := 2
lFnSB_Speed:
lFnSB_Brake:
  if ((vSpdBrk=cFnSB_Speed) || (vSpdBrk=cFnSB_Brake)) 
      {
        if (fScepl || fUDLR)
            fSpdBrk := true
          else
            fSpdBrk := false

        if ((vSpdBrk=cFnSB_Speed) && (iGear=cMaxGear))
            SetTimer lMoveBrk, off
          else
            SetTimer lMoveBrk, %cTimerBrk%
            
        if ((vSpdBrk=cFnSB_Brake) && (iGear=1))
            SetTimer lMoveUp, off
          else
            SetTimer lMoveUp, %cTimerSpd%
            
        vGearSpdTimer:=vGearSpd//2
        vGearBrkTimer:=vGearBrk//2        
        
        return vRetResult:=fSpdBrk
      }
return vRetFn:=fRetErr
   
;Common subprogramme is not to be verified
; cFnSB_Learn := 0
lFnSB_Learn:
    vGearSpd := (arGear[iGear]+vGearSpd)//2
    vGearBrk := (arGear[iGear]+vGearBrk)//2
    vGearSpdTimer:=vGearSpd//2
    vGearBrkTimer:=vGearBrk//2
    return       
  return vRetFn:=fRetDone

return vRetFn:=fRetErr
      
;While not using - stopgap
; cFnSB_Above := 6
lFnSB_Above: 
return vRetFn:=fRetErr
}
;---End of function fnGearSpdBrk
;---