Skip to main content

EndlessElement

Editor typing

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

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

EndlessElement:endless_value​

Returns (or sets) the current endless potentiometer value.

EndlessElement:endless_value(value: integer?): integer
@param value — If provided, sets the value
@return value — Current value

EndlessElement:endless_min​

Returns (or sets) the minimum endless potentiometer value.

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

EndlessElement:endless_max​

Returns (or sets) the maximum endless potentiometer value.

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

EndlessElement:endless_mode​

Returns (or sets) the endless potentiometer mode.

EndlessElement:endless_mode(value: integer?): integer
@param value — If provided, sets the mode
@return mode — Mode value

EndlessElement:endless_state​

Returns the endless potentiometer state.

EndlessElement:endless_state(): integer
@return state — Current state

EndlessElement:endless_velocity​

Returns the endless potentiometer velocity.

EndlessElement:endless_velocity(): integer
@return velocity — Rotation velocity

EndlessElement:endless_direction​

Returns the endless potentiometer direction.

EndlessElement:endless_direction(): integer
@return direction — Rotation direction

EndlessElement:endless_sensitivity​

Returns (or sets) the endless potentiometer sensitivity.

EndlessElement:endless_sensitivity(value: integer?): integer
@param value — If provided, sets the sensitivity
@return sensitivity — Sensitivity value

EndlessElement:led_offset​

Returns the LED offset for this endless element.

EndlessElement:led_offset(value: integer?): integer
@param value — If provided, sets the offset
@return offset — LED offset

EndlessElement:button_value​

Returns (or sets) the current button value.

EndlessElement:button_value(value: integer?): integer
@param value — If provided, sets the button value
@return value — Current button value

EndlessElement:button_min​

Returns (or sets) the minimum button value.

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

EndlessElement:button_max​

Returns (or sets) the maximum button value.

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

EndlessElement:button_mode​

Returns (or sets) the button mode. 0 = momentary.

EndlessElement:button_mode(value: integer?): integer
@param value — If provided, sets the mode
@return mode — Button mode

EndlessElement:button_state​

Returns the button state. 0 = released, 127 = pressed.

EndlessElement:button_state(): integer
@return state — Button state (0 or 127)

EndlessElement:button_elapsed_time​

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

EndlessElement:button_elapsed_time(): integer
@return ms — Elapsed time in milliseconds

EndlessElement:button_step​

Calculates the button step based on mode, min, max, and value.

EndlessElement:button_step(): boolean | integer
@return step — Current step, or false if mode is 0