# plugins.core.tangent.manager.named

Provides common functions for 'named' Tangent nodes

Tables with named in it's metatable chain will have name methods added as described below.

# API Overview

Functions - API calls offered directly by the extension

  • is
  • xml

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

  • named

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

  • controls
  • name
  • nameX
  • parent
  • tangent

# API Documentation

# Functions

# is

Signature plugins.core.tangent.manager.named.is(thing) -> boolean
Type Function
Description Check if the thing is a named table.
Parameters
  • thing - The thing to check.
Returns
  • true if it is `named.
Notes None
Examples None
Source src/plugins/core/tangent/manager/named.lua line 238

# xml

Signature plugins.core.tangent.manager.named.xml(thing) -> cp.web.xml
Type Function
Description Returns the xml configuration for the Action.
Parameters
  • thing - The thing to retrieve the names from.
Returns
  • The xml for the Action.
Notes None
Examples None
Source src/plugins/core/tangent/manager/named.lua line 205

# Constructors

# named

Signature plugins.core.tangent.manager.named(id, name, parent) -> named
Type Constructor
Description Creates a new named instance, with the specified base name.
Parameters
  • id - the unique ID for the value.
  • name - The base name of the
  • parent - the parent
Returns
  • None
Notes None
Examples None
Source src/plugins/core/tangent/manager/named.lua line 24

# Fields

# active

Signature plugins.core.tangent.manager.named.active <cp.prop: boolean; read-only>
Type Field
Description Indicates if the parameter is active. It will only be active if
Notes None
Source src/plugins/core/tangent/manager/named.lua line 48

# enabled

Signature plugins.core.tangent.manager.named.enabled <cp.prop: boolean>
Type Field
Description Indicates if the parameter is enabled.
Notes None
Source src/plugins/core/tangent/manager/named.lua line 41

# Methods

# controls

Signature plugins.core.tangent.manager.named:controls()
Type Method
Description Returns the controls the parameter belongs to.
Parameters
  • None
Returns
  • The controls, or nil if not specified.
Notes None
Examples None
Source src/plugins/core/tangent/manager/named.lua line 83

# name

Signature plugins.core.tangent.manager.named:name(value) -> string | self
Type Method
Description Gets or sets the full name.
Parameters
  • value - The new name value.
Returns
  • The current value, or self if a new value was provided.
Notes None
Examples None
Source src/plugins/core/tangent/manager/named.lua line 133

# nameX

Signature plugins.core.tangent.manager.named:nameX(value) -> string | self
Type Method
Description Sets the name X, where X is a number as defined when the named was created.
Parameters
  • value - The new name value.
Returns
  • The current value, or self if a new value was provided.
Notes None
Examples None
Source src/plugins/core/tangent/manager/named.lua line 170

# parent

Signature plugins.core.tangent.manager.named:parent() -> group | controls
Type Method
Description Returns the group or controls that contains this parameter.
Parameters
  • None
Returns
  • The parent.
Notes None
Examples None
Source src/plugins/core/tangent/manager/named.lua line 57

# tangent

Signature plugins.core.tangent.manager.named:tangent() -> hs.tangent
Type Method
Description The Tangent Hub connection for this value, from the parent.
Parameters
  • None
Returns
  • The hs.tangent, if available.
Notes None
Examples None
Source src/plugins/core/tangent/manager/named.lua line 70

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