Module navigation

Menu/phone tree navigation.

This module provides actions that help with navigating menus and phone trees.

The actions in this module are most often used directly when responding to user input, see Capturing user key input for more information.

Info:

  • Copyright: 2011-2015 Chad Phillips
  • Author: Chad Phillips

Actions

navigation_add Add a sequence to the navigation path.
navigation_beginning Move to the beginning of the navigation path.
navigation_clear Clear the navigation path.
navigation_previous Move to the previous item on the navigation path.
navigation_reset Set the current sequence as the new navigation path beginning.


Actions

navigation_add
Add a sequence to the navigation path.

This action adds a sequence to the navigation path. It can be used for tracking when a channel moves deeper into a menu tree. Adding a sequence to the path allows for using the navigation actions to traverse through previous additions to the path.

  • action string navigation_add
  • sequence string (Optional) The sequence to add to the path. Defaults to the currently running sequence.

Usage:

    {
      action = "navigation_add",
      sequence = "some_sequence",
    }
navigation_beginning
Move to the beginning of the navigation path.

This action clears the navigation path, and executes the first item from the old path, placing it at the beginning of the new path. It can be used for providing 'return to beginning' functionality in phone trees.

This action is most often used in the 'keys' array like so:

keys = {
  ["9"] = "@navigation_beginning",
}

It can however be used in a regular sequence as well.

  • action string navigation_beginning

Usage:

    {
      action = "navigation_beginning",
    }
navigation_clear
Clear the navigation path.

This action clears the navigation path. No sequences will be left on the path after this operation.

  • action string navigation_clear

Usage:

    {
      action = "navigation_clear",
    }
navigation_previous
Move to the previous item on the navigation path.

This action pops the current action off the navigation path, and executes the previously added item in the path. It can be used for providing 'previous menu' functionality in phone trees.

This action is most often used in the 'keys' array like so:

keys = {
  ["9"] = "@navigation_previous"
}

It can however be used in a regular sequence as well.

  • action string navigation_previous

Usage:

    {
      action = "navigation_previous",
    }
navigation_reset
Set the current sequence as the new navigation path beginning.

This action clears the navigation path, and sets the last item in the old path to be the first item in the new path. It can be used to set a new beginning for the navigation path.

  • action string navigation_reset

Usage:

    {
      action = "navigation_reset",
    }
generated by LDoc 1.4.6 Last updated 2018-11-07 21:33:15