## On this page

  

 

 # getHaltStatus

 Last update: 16.07.2025 

abstract fun [getHaltStatus](get-halt-status.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)

checks to see if the halt button has been pressed

#### Return

true if the halt button was pressed and the current actions should be halted

#### Throws

[ModelCenterException](../-model-center-exception/index.md)