Skip to main content

PotmeterElement

Editor typing

When editing code for a PotmeterElement, the Grid editor automatically types self, element, and ele as PotmeterElement - so you can call these functions directly:

self:potmeter_value()     -- on the current element
element[1]:potmeter_value() -- on a specific element from the array

PotmeterElement:potmeter_value​

Returns (or sets) the current potentiometer value.

PotmeterElement:potmeter_value(value: integer?): integer
@param value — If provided, sets the value
@return value — Current potentiometer value

PotmeterElement:potmeter_min​

Returns (or sets) the minimum potentiometer value.

PotmeterElement:potmeter_min(value: integer?): integer
@param value — If provided, sets the minimum
@return min — Minimum value

PotmeterElement:potmeter_max​

Returns (or sets) the maximum potentiometer value.

PotmeterElement:potmeter_max(value: integer?): integer
@param value — If provided, sets the maximum
@return max — Maximum value

PotmeterElement:potmeter_resolution​

Returns (or sets) the potentiometer resolution.

PotmeterElement:potmeter_resolution(value: integer?): integer
@param value — If provided, sets the resolution
@return resolution — Potentiometer resolution

PotmeterElement:potmeter_state​

Returns the potentiometer state.

PotmeterElement:potmeter_state(): integer
@return state — Current state

PotmeterElement:potmeter_elapsed_time​

Returns the time elapsed since the last potentiometer event (milliseconds).

PotmeterElement:potmeter_elapsed_time(): integer
@return ms — Elapsed time in milliseconds