Skip to content

Disable Region

Disable a Region in the current FSM.

When the Region is disabled, it can either suspend its active state or exit it completely.

Parameters

Parameter Description
Region The Region to disable. The Region must belong to the same FSM as this action.
Disable Behavior How to stop the Region when disabling it.

Disable Behavior

Option Description
Suspend Pause the Region in its current active state so it can continue from the same state when resumed.
Exit Exit the current active state and stop its running actions.

Notes

  • Use Suspend when you want the Region to remember where it was.
  • Use Exit when disabling the Region should cleanly stop the active state.
  • Disabled Regions do not update or process events.
  • If the target Region is already disabled, this action does nothing.