parameter

Represents a Tangent Parameter

API Overview

API Documentation

Functions

is

Signature

plugins.core.tangent.manager.parameter.is(other) -> boolean

Type

Function

Description

Checks if the other is a parameter instance.

Parameters

Returns

Constructors

new

Signature

plugins.core.tangent.manager.parameter.new(id[, name[, parent]) -> parameter

Type

Constructor

Description

Creates a new Parameter instance.

Parameters

Returns

Methods

change

Signature

plugins.core.tangent.manager.parameter:change(amount) -> number

Type

Method

Description

Executes the change function if present, and returns the new result. If

Parameters

Returns

controls

Signature

plugins.core.tangent.manager.parameter:controls()

Type

Method

Description

Returns the controls the parameter belongs to.

Parameters

Returns

get

Signature

plugins.core.tangent.manager.parameter:get() -> number

Type

Method

Description

Executes the get function if present, and returns the result. If

Parameters

Returns

maxValue

Signature

`plugins.core.tangent.manager.parameter:maxValue([value]) -> number

self` </span>

Type

Method

Description

Gets or sets the maximum value for the parameter.

Parameters

Returns

minValue

Signature

`plugins.core.tangent.manager.parameter:minValue([value]) -> number

self` </span>

Type

Method

Description

Gets or sets the minimum value for the parameter.

Parameters

Returns

onChange

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

Returns

onGet

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

Returns

onReset

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

Returns

parent

Signature

`plugins.core.tangent.manager.parameter:parent() -> group

controls` </span>

Type

Method

Description

Returns the group or controls that contains this parameter.

Parameters

Returns

press

Signature

plugins.core.tangent.manager.parameter:press() -> nil

Type

Method

Description

Executes the press function, if present.

Parameters

Returns

release

Signature

plugins.core.tangent.manager.parameter:release() -> nil

Type

Method

Description

Executes the release function, if present.

Parameters

Returns

reset

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

Returns

stepSize

Signature

`plugins.core.tangent.manager.parameter:stepSize([value]) -> number

self` </span>

Type

Method

Description

Gets or sets the step size for the parameter.

Parameters

Returns

xml

Signature

plugins.core.tangent.manager.parameter:xml() -> cp.web.xml

Type

Method

Description

Returns the xml configuration for the Parameter.

Parameters

Returns