add related, yet to add info |
add info |
||
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
|Name=Virtual Shift Color Driver | |Name=Virtual Shift Color Driver | ||
}} | }} | ||
The '''VirtualShiftColorDriver''' component is used to change a color field whenever a keyboard specified has its Shift key state changed. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Keyboard|{{RootFieldType|RelayRef`1|[[Component:VirtualKeyboard|VirtualKeyboard]]}}|TypeAdv0=true| | |Keyboard|{{RootFieldType|RelayRef`1|[[Component:VirtualKeyboard|VirtualKeyboard]]}}|TypeAdv0=true| The keyboard to monitor the shirt state for. | ||
|ColorTarget|'''[[Type:IField`1|IField`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv1=true| | |ColorTarget|'''[[Type:IField`1|IField`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv1=true| The field to set the color of depending on keyboard state. | ||
|NormalColor|ColorX| | |NormalColor|ColorX| The color to set the field in <code>ColorTarget</code> to when <code>Keyboard</code> is in default state. | ||
|ShiftColor|ColorX| | |ShiftColor|ColorX| The color to set the field in <code>ColorTarget</code> to when <code>Keyboard</code>'s Shift key is toggled on like capslock. | ||
|HoldColor|ColorX| | |HoldColor|ColorX| The color to set the field in <code>ColorTarget</code> to when <code>Keyboard</code>'s Shift key is being held down. | ||
}} | }} | ||
== | == Usage == | ||
Provide values for all the fields in this component in order for it to start working. | |||
== Examples == | == Examples == | ||
Used to make keys on the default keyboard change color when Shift is held, toggled, or released. | |||
== See Also == | == See Also == | ||
{{Template:KeyBoardTypes_SeeAlso}} | |||
[[Category:Components:Userspace:Virtual Keyboard{{#translation:}}|Virtual Shift Color Driver]] | [[Category:Components:Userspace:Virtual Keyboard{{#translation:}}|Virtual Shift Color Driver]] | ||
[[Category:Components{{#translation:}}|Virtual Shift Color Driver]] | [[Category:Components{{#translation:}}|Virtual Shift Color Driver]] | ||
Latest revision as of 20:55, 6 February 2025
Component image 
Virtual Shift Color Driver component as seen in the Scene Inspector
The VirtualShiftColorDriver component is used to change a color field whenever a keyboard specified has its Shift key state changed.
Fields
| Name | Type | Description |
|---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't. |
Keyboard
|
direct RelayRef`1<VirtualKeyboard> | The keyboard to monitor the shirt state for. |
ColorTarget
|
IField`1<ColorX> | The field to set the color of depending on keyboard state. |
NormalColor
|
ColorX | The color to set the field in ColorTarget to when Keyboard is in default state.
|
ShiftColor
|
ColorX | The color to set the field in ColorTarget to when Keyboard's Shift key is toggled on like capslock.
|
HoldColor
|
ColorX | The color to set the field in ColorTarget to when Keyboard's Shift key is being held down.
|
Usage
Provide values for all the fields in this component in order for it to start working.
Examples
Used to make keys on the default keyboard change color when Shift is held, toggled, or released.