.. _omni_graph_action_Countdown_1:

.. _omni_graph_action_Countdown:

.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================

:orphan:

.. meta::
    :title: Countdown
    :keywords: lang-en omnigraph node graph:action,flowControl action countdown


Countdown
=========

.. <description>

Delays for a number of updates (the duration) while firing output tick activations with a given period. When the countdown is complete it triggers the finished output. The first compute does not generate a tick output.

.. </description>


Installation
------------

To use this node enable :ref:`omni.graph.action<ext_omni_graph_action>` in the Extension Manager.


Inputs
------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "inputs:duration", "``int``", "The duration of the delay in ticks", "5"
    "inputs:execIn", "``execution``", "The input execution", "None"
    "inputs:period", "``int``", "The period of the pulse in ticks", "1"


Outputs
-------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "outputs:alpha", "``float``", "normalized progress in the range IE 'tickValue'/'duration'", "None"
    "outputs:finished", "``execution``", "Triggered after duration ticks is finished", "None"
    "outputs:tick", "``execution``", "Triggered every 'period' ticks", "None"
    "outputs:tickValue", "``int``", "The current tick value in the range [1, duration]", "None"


State
-----
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "state:count", "``int``", "The number of ticks elapsed, the first tick is 0", "-1"


Metadata
--------
.. csv-table::
    :header: "Name", "Value"
    :widths: 30,70

    "Unique ID", "omni.graph.action.Countdown"
    "Version", "1"
    "Extension", "omni.graph.action"
    "Has State?", "True"
    "Implementation Language", "Python"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "tests"
    "uiName", "Countdown"
    "Categories", "graph:action,flowControl"
    "Generated Class Name", "OgnCountdownDatabase"
    "Python Module", "omni.graph.action"

