.. _omni_graph_action_OnTick_1:

.. _omni_graph_action_OnTick:

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

:orphan:

.. meta::
    :title: On Tick
    :keywords: lang-en omnigraph node graph:action,event threadsafe action on-tick


On Tick
=======

.. <description>

Executes an output execution pulse at a regular multiple of the refresh rate

.. </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

    "Update Period (Ticks) (*inputs:framePeriod*)", "``uint``", "The number of updates between each output pulse. The default 0 means every update, 1 means every other update. This can be used to rate-limit updates.", "0"
    "", "*literalOnly*", "1", ""
    "Only Simulate On Play (*inputs:onlyPlayback*)", "``bool``", "When true, the node is only computed while Stage is being played.", "True"
    "", "*literalOnly*", "1", ""


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

    "Absolute Simulation Time (Seconds) (*outputs:absoluteSimTime*)", "``double``", "The accumulated total of elapsed times between rendered frames", "None"
    "Delta (Seconds) (*outputs:deltaSeconds*)", "``double``", "The number of seconds elapsed since the last output pulse", "None"
    "Animation Time (Frames) (*outputs:frame*)", "``double``", "The global animation time in frames, equivalent to (time * fps), during playback", "None"
    "Is Playing (*outputs:isPlaying*)", "``bool``", "True during global animation timeline playback", "None"
    "Tick (*outputs:tick*)", "``execution``", "The execution output", "None"
    "Animation Time (Seconds) (*outputs:time*)", "``double``", "The global animation time in seconds during playback", "None"
    "Time Since Start (Seconds) (*outputs:timeSinceStart*)", "``double``", "Elapsed time since the App started", "None"


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

    "state:accumulatedSeconds", "``double``", "Accumulated time since the last output pulse", "0"
    "state:frameCount", "``uint``", "Accumulated frames since the last output pulse", "0"


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

    "Unique ID", "omni.graph.action.OnTick"
    "Version", "1"
    "Extension", "omni.graph.action"
    "Has State?", "True"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "On Tick"
    "Categories", "graph:action,event"
    "Generated Class Name", "OgnOnTickDatabase"
    "Python Module", "omni.graph.action"

