# plugins.core.tangent.manager.controls

Represents a Tangent Group

# API Overview

Constructors - API calls which return an object, typically one that offers API methods

  • controls

Fields - Variables which can only be accessed from an object returned by a constructor

  • active
  • enabled

Methods - API calls which can only be made on an object returned by a constructor

  • action
  • controls
  • findByID
  • group
  • menu
  • parameter
  • parent
  • register
  • tangent
  • unregister
  • xml

# API Documentation

# Constructors

# controls

Signature plugins.core.tangent.manager.controls(manager) -> Group
Type Constructor
Description Creates a new Group instance.
Parameters
  • manager - The manager
Returns
  • A new Group object
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 22

# Fields

# active

Signature plugins.core.tangent.manager.controls.active <cp.prop: boolean; read-only>
Type Field
Description Indicates if the controls are active. They will be active if enabled is true.
Notes None
Source src/plugins/core/tangent/manager/controls.lua line 56

# enabled

Signature plugins.core.tangent.manager.controls.enabled <cp.prop: boolean>
Type Field
Description Indicates if the controls are enabled.
Notes None
Source src/plugins/core/tangent/manager/controls.lua line 49

# Methods

# action

Signature plugins.core.tangent.manager.controls:action(id[, name]) -> action
Type Method
Description Adds an action to this controls.
Parameters
  • id - The ID number of the new action
  • name - The name of the action.
Returns
  • The new action
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 163

# controls

Signature plugins.core.tangent.manager.controls:controls() -> controls
Type Method
Description Returns this controls instance.
Parameters
  • None
Returns
  • The `controls instance.
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 76

# findByID

Signature plugins.core.tangent.manager.controls:findByID(id) -> table
Type Method
Description Finds a control (Action/Parameter/Mode) by its unique ID.
Parameters
  • id - the ID to search by
Returns
  • The control, or nil if not found.
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 128

# group

Signature plugins.core.tangent.manager.controls:group(name) -> group
Type Method
Description Adds a subgroup to this group.
Parameters
  • name - the name of the new sub-group
Returns
  • The new group
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 141

# menu

Signature plugins.core.tangent.manager.controls:menu(id[, name]) -> menu
Type Method
Description Adds an menu to this controls.
Parameters
  • id - The ID number of the new menu
  • name - The name of the menu.
Returns
  • The new menu
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 211

# parameter

Signature plugins.core.tangent.manager.controls:parameter(id[, name]) -> parameter
Type Method
Description Adds an parameter to this controls.
Parameters
  • id - The ID number of the new parameter
  • name - The name of the parameter.
Returns
  • The new parameter
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 187

# parent

Signature plugins.core.tangent.manager.controls:parent() -> nil
Type Method
Description Always returns nil, sinces controls have no parent.
Parameters
  • None
Returns
  • nil.
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 63

# register

Signature plugins.core.tangent.manager.controls:register(control) -> self
Type Method
Description Registers a control (Action/Parameter/Menu) with it's ID. This allows efficient retrieval via the findById(...) method, as well as checking that ID is unique.
Parameters
  • control - The Action/Parameter/Menu to register
Returns
  • self
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 89

# tangent

Signature plugins.core.tangent.manager.controls:tangent() -> hs.tangent
Type Method
Description The hs.tangent connection.
Parameters
  • None
Returns
  • The hs.tangent.
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 36

# unregister

Signature plugins.core.tangent.manager.controls:unregister(control) -> self
Type Method
Description Unregisters a control (Action/Parameter/Menu) with it's ID
Parameters
  • control - The Action/Parameter/Menu to unregister
Returns
  • self
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 109

# xml

Signature plugins.core.tangent.manager.controls:xml() -> cp.web.xml
Type Method
Description Returns the xml configuration for the Group.
Parameters
  • None
Returns
  • The xml for the Group.
Notes None
Examples None
Source src/plugins/core/tangent/manager/controls.lua line 235

© Copyright 2024 LateNite Films Pty Ltd. All rights reserved.