|
|
|
|
|
|
|
Difference between revisions of "Buttons"
Jump to navigation
Jump to search
m (Added minor information regarding the new buttontypes and fields.) |
|||
| Line 12: | Line 12: | ||
<br> | <br> | ||
<br> | <br> | ||
Universally there are two types of buttons that are commonly used; hybrid buttons and small buttons. Both have | Universally there are two types of buttons that are commonly used; hybrid buttons and small buttons. Both have adjustable interaction styles.<br> | ||
Hybrid buttons are modular, and can connect to adjacent [[modular displays]]. Small buttons have their own cable port. | Hybrid buttons are modular, and can connect to adjacent [[modular displays]]. Small buttons have their own cable port. | ||
| Line 18: | Line 18: | ||
Configuring a button: | Configuring a button: | ||
* Set the '''ButtonState''' field's name to match the device field you want to control. | * Set the '''ButtonState''' field's name to match the device field you want to control.<br> | ||
* Set the On- and Off-state values. | * Set the On- and Off-state values.<br> | ||
* Pressing the button changes its state depending on '''ButtonStyle''' -field value. | * Pressing the button changes its state depending on '''ButtonStyle''' -field value.<br> | ||
* Buttons with the "ButtonColor" field can have a different buttoncolor depending on the value of this field. <br> | |||
* There are different types of buttons with varrying size. However they all share most of their fields and behavior. <br> | |||
== Device fields == | == Device fields == | ||
| Line 49: | Line 51: | ||
| Controls the interaction style of the button | | Controls the interaction style of the button | ||
| '''0:''' Hold down and release '''1:''' Basic Toggle (in-game button remains down while it is "on") '''2:''' 4-state switch (in-game button returns to the unpressed position whether it is "on" or "off") | | '''0:''' Hold down and release '''1:''' Basic Toggle (in-game button remains down while it is "on") '''2:''' 4-state switch (in-game button returns to the unpressed position whether it is "on" or "off") | ||
|} | |||
Some Buttons have additional fields, which are listed below. | |||
{|class="wikitable" | |||
! YOLOL field | |||
! description | |||
! range | |||
|- | |||
! '''ButtonColor''' | |||
| Depending on this field the Button will appear in a different color. | |||
| 1 = orange; 2 = green; 3= blue; any other number = red | |||
|- | |||
! '''ButtonEnableBlink''' | |||
| When enabled the button will light up periodicaly. | |||
| 0 = no blinking; 1 = blinking. | |||
|} | |} | ||
[[Category:Devices and machines|Buttons]] | [[Category:Devices and machines|Buttons]] | ||
Revision as of 14:48, 28 February 2021
Summary
Universally there are two types of buttons that are commonly used; hybrid buttons and small buttons. Both have adjustable interaction styles.
Hybrid buttons are modular, and can connect to adjacent modular displays. Small buttons have their own cable port.
Basic information
Configuring a button:
- Set the ButtonState field's name to match the device field you want to control.
- Set the On- and Off-state values.
- Pressing the button changes its state depending on ButtonStyle -field value.
- Buttons with the "ButtonColor" field can have a different buttoncolor depending on the value of this field.
- There are different types of buttons with varrying size. However they all share most of their fields and behavior.
Device fields
To learn more about the usage of fields, consult these wiki pages:
| YOLOL field | description | range |
|---|---|---|
| ButtonState | The name of the field of which value the button modifies | |
| ButtonOnStateValue | Controls the value when pressed | |
| ButtonOffStateValue | Controls the value when released | |
| ButtonStyle | Controls the interaction style of the button | 0: Hold down and release 1: Basic Toggle (in-game button remains down while it is "on") 2: 4-state switch (in-game button returns to the unpressed position whether it is "on" or "off") |
Some Buttons have additional fields, which are listed below.
| YOLOL field | description | range |
|---|---|---|
| ButtonColor | Depending on this field the Button will appear in a different color. | 1 = orange; 2 = green; 3= blue; any other number = red |
| ButtonEnableBlink | When enabled the button will light up periodicaly. | 0 = no blinking; 1 = blinking. |