#plugins.core.tangent.manager.parameter

Represents a Tangent Parameter control.

#API Overview

Functions - API calls offered directly by the extension

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


Signature	`plugins.core.tangent.manager.parameter.is(thing) -> boolean`
Type	Function
Description	Checks if the `thing` is a `parameter` instance.
Parameters	thing - The other object to test.
Returns	`true` if it is a `parameter`, `false` if not.
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 33


Signature	`plugins.core.tangent.manager.parameter:update()`
Type	Function
Description	Updates the Tangent with the current value of the parameter.
Parameters	None
Returns	Nothing.
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 221


Signature	`plugins.core.tangent.manager.parameter(id[, name[, parent]) -> parameter`
Type	Constructor
Description	Creates a new `Parameter` instance.
Parameters	id - The ID number of the parameter. name - The name of the parameter. parent - The parent of the parameter.
Returns	the new `parameter`.
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 18


Signature	`plugins.core.tangent.manager.parameter:change(amount) -> number`
Type	Method
Description	Executes the `change` function if present, and returns the new result. If none has been set, `nil` is returned.
Parameters	amount - The amount to change the parameter.
Returns	The current value, or `nil` if it can't be accessed.
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 162


Signature	`plugins.core.tangent.manager.parameter:get() -> number`
Type	Method
Description	Executes the `get` function if present, and returns the result. If none has been set, `nil` is returned.
Parameters	None
Returns	The current value, or `nil` if it can't be accessed.
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 122


Signature	`plugins.core.tangent.manager.parameter:maxValue([value]) -> number \| self`
Type	Method
Description	Gets or sets the maximum value for the parameter.
Parameters	value - The new value.
Returns	If `value` is `nil`, the current value is returned, otherwise returns `self`.
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 64


Signature	`plugins.core.tangent.manager.parameter:minValue([value]) -> number \| self`
Type	Method
Description	Gets or sets the minimum value for the parameter.
Parameters	value - The new value.
Returns	If `value` is `nil`, the current value is returned, otherwise returns `self`.
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 46


Signature	`plugins.core.tangent.manager.parameter:onChange(changeFn) -> self`
Type	Method
Description	Sets the function that will be called when the Tangent sends a 'parameter change' request.
Parameters	getFn - The function to call when the Tangent requests the parameter change.
Returns	The `parameter` instance.
Notes	This function should have this signature: `function(amount) -> number` The return value should be the new value of the parameter.
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 138


Signature	`plugins.core.tangent.manager.parameter:onGet(getFn) -> self`
Type	Method
Description	Sets the function that will be called when the Tangent sends a 'parameter value' request.
Parameters	getFn - The function to call when the Tangent requests the parameter value.
Returns	The `parameter` instance.
Notes	This function should have this signature: `function() -> number`
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 100


Signature	`plugins.core.tangent.manager.parameter:onReset(resetFn) -> self`
Type	Method
Description	Sets the function that will be called when the Tangent sends a 'parameter reset' request.
Parameters	resetFn - The function to call when the Tangent requests the parameter reset.
Returns	The `parameter` instance.
Notes	This function should have this signature: `function() -> nil`
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 183


Signature	`plugins.core.tangent.manager.parameter:press() -> nil`
Type	Method
Description	Executes the `press` function, if present.
Parameters	None
Returns	`nil`
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/action.lua line 85


Signature	`plugins.core.tangent.manager.parameter:release() -> nil`
Type	Method
Description	Executes the `release` function, if present.
Parameters	None
Returns	`nil`
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/action.lua line 122


Signature	`plugins.core.tangent.manager.parameter:reset() -> number`
Type	Method
Description	Executes the `reset` function if present. Returns the current value of the parameter after reset.
Parameters	None
Returns	The current value, or `nil` if it can't be accessed.
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 205


Signature	`plugins.core.tangent.manager.parameter:stepSize([value]) -> number \| self`
Type	Method
Description	Gets or sets the step size for the parameter.
Parameters	value - The new value.
Returns	If `value` is `nil`, the current value is returned, otherwise returns `self`.
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 82


Signature	`plugins.core.tangent.manager.parameter:xml() -> cp.web.xml`
Type	Method
Description	Returns the `xml` configuration for the Parameter.
Parameters	None
Returns	The `xml` for the Parameter.
Notes	None
Examples	None
Source	src/plugins/core/tangent/manager/parameter.lua line 239