⇐ Index

GetPause

GetPause ->isPaused

Description

Returns a boolean indicating if the game is paused (for any reason). Different things can pause the game and some pauses 'stack' This call will return true if the game is paused for any reason. Note that scripts usually don't run while the game is paused, so this call is most useful in scripts that are set to run when the game is paused.

:NOTE: This also applies to the game pausing when opening the ESC menu.

Examples

   if (GetPause)
      Print("Game is paused")
   endif

⇐ Index