ButtonElement

• supers: Element

---

Editor typing

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

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

ButtonElement:button_value

---

Returns (or sets) the current button value.

ButtonElement:button_value(value: integer?): integer

@param value — If provided, sets the button value

@return value — Current button value

ButtonElement:button_min

---

Returns (or sets) the minimum button value.

ButtonElement:button_min(value: integer?): integer

@param value — If provided, sets the minimum

@return min — Minimum value

ButtonElement:button_max

---

Returns (or sets) the maximum button value.

ButtonElement:button_max(value: integer?): integer

@param value — If provided, sets the maximum

@return max — Maximum value

ButtonElement:button_mode

---

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

ButtonElement:button_mode(value: integer?): integer

@param value — If provided, sets the mode

@return mode — Button mode

ButtonElement:button_state

---

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

ButtonElement:button_state(): integer

@return state — Button state (0 or 127)

ButtonElement:button_elapsed_time

---

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

ButtonElement:button_elapsed_time(): integer

@return ms — Elapsed time in milliseconds

ButtonElement:button_step

---

Calculates the button step based on mode, min, max, and value. Returns false if button mode is 0 (momentary), otherwise returns the current step number.

ButtonElement:button_step(): boolean | integer

@return step — Current step, or false if mode is 0