From cf2aa4df58a907ef1b2d47717e81fd482ba5cd43 Mon Sep 17 00:00:00 2001 From: desktop-maesty/steve Date: Fri, 4 May 2018 17:55:33 +1000 Subject: [PATCH] Generated Docs for Priority Signals --- Docs/command_ref/priority signals_commands.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 Docs/command_ref/priority signals_commands.md diff --git a/Docs/command_ref/priority signals_commands.md b/Docs/command_ref/priority signals_commands.md new file mode 100644 index 00000000..138b9fbd --- /dev/null +++ b/Docs/command_ref/priority signals_commands.md @@ -0,0 +1,19 @@ +# Priority Signals commands # {#priority signals_commands} + +[TOC] +# Get Priority Count # {#GetPriorityCount} +Copy the value of the Priority Count to a local IntegerVariable, intended primarily to assist with debugging use of Priority. + +Defined in Fungus.FungusPriorityCount +# Priority Down # {#PriorityDown} +Decrease the FungusPriority count, causing the related FungusPrioritySignals to fire. Intended to be used to notify external systems that fungus is doing something important and they should perhaps resume. + +Defined in Fungus.FungusPriorityDecrease +# Priority Reset # {#PriorityReset} +Resets the FungusPriority count to zero. Useful if you are among logic that is hard to have matching increase and decreases. + +Defined in Fungus.FungusPriorityReset +# Priority Up # {#PriorityUp} +Increases the FungusPriority count, causing the related FungusPrioritySignals to fire. Intended to be used to notify external systems that fungus is doing something important and they should perhaps pause. + +Defined in Fungus.FungusPriorityIncrease