Skip to main content

EncoderElement

Editor typing

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

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

EncoderElement:encoder_value​

Returns (or sets) the current encoder value.

EncoderElement:encoder_value(value: integer?): integer
@param value — If provided, sets the encoder value
@return value — Current encoder value

EncoderElement:encoder_min​

Returns (or sets) the minimum encoder value.

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

EncoderElement:encoder_max​

Returns (or sets) the maximum encoder value.

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

EncoderElement:encoder_mode​

Returns (or sets) the encoder mode.

EncoderElement:encoder_mode(value: integer?): integer
@param value — If provided, sets the mode
@return mode — Encoder mode

EncoderElement:encoder_state​

Returns the encoder state (rotation direction). Values <64 = left, >63 = right.

EncoderElement:encoder_state(): integer
@return state — Encoder state

EncoderElement:encoder_velocity​

Returns the encoder velocity.

EncoderElement:encoder_velocity(value: integer?): integer
@param value — If provided, sets the velocity
@return velocity — Rotation velocity

EncoderElement:encoder_sensitivity​

Returns (or sets) the encoder sensitivity.

EncoderElement:encoder_sensitivity(value: integer?): integer
@param value — If provided, sets the sensitivity
@return sensitivity — Encoder sensitivity

EncoderElement:encoder_elapsed_time​

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

EncoderElement:encoder_elapsed_time(): integer
@return ms — Elapsed time in milliseconds

EncoderElement:button_value​

Returns (or sets) the current button value.

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

EncoderElement:button_min​

Returns (or sets) the minimum button value.

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

EncoderElement:button_max​

Returns (or sets) the maximum button value.

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

EncoderElement:button_mode​

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

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

EncoderElement:button_state​

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

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

EncoderElement:button_elapsed_time​

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

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

EncoderElement:button_step​

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

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