#plugins.core.tangent.manager.binding

Represents a Tangent Binding


#API Overview

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

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


#API Documentation

#Constructors

Signatureplugins.core.tangent.manager.binding(name) -> binding
TypeConstructor
DescriptionCreates a new Binding instance.
Parameters
  • name - The name of the binding.
Returns
  • the new binding.
NotesNone
ExamplesNone
Sourcesrc/plugins/core/tangent/manager/binding.lua line 16

#Methods

Signatureplugins.core.tangent.manager.binding:member(parameter) -> self
TypeMethod
DescriptionAdds a parameter as a member of the Binding group. The order is significant - it will determine the order the parameters are applied to group controls in the Mapper.
Parameters
  • param - The parameter to add to the binding.
Returns
  • The binding instance.
NotesNone
ExamplesNone
Sourcesrc/plugins/core/tangent/manager/binding.lua line 43

Signatureplugins.core.tangent.manager.binding:members(...) -> self
TypeMethod
DescriptionAdds the list of parameters to this binding.
Parameters
  • ... - the list of parameters to bind.
Returns
  • The binding instance.
NotesNone
ExamplesNone
Sourcesrc/plugins/core/tangent/manager/binding.lua line 58

Signatureplugins.core.tangent.manager.binding:name() -> string
TypeMethod
DescriptionReturns the name of this binding.
Parameters
  • None
Returns
  • The name.
NotesNone
ExamplesNone
Sourcesrc/plugins/core/tangent/manager/binding.lua line 30

Signatureplugins.core.tangent.manager.binding:xml() -> cp.web.xml
TypeMethod
DescriptionReturns the xml configuration for the Binding.
Parameters
  • None
Returns
  • The xml for the Binding.
NotesNone
ExamplesNone
Sourcesrc/plugins/core/tangent/manager/binding.lua line 74