Component:VirtualKeyboard: Difference between revisions

From Resonite Wiki
add info
add related types and info
 
Line 7: Line 7:
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|ShiftActive|Bool| Whether the Shift modifier key is active.
|ShiftActive|Bool| Whether the [[Component:VirtualShift|Virtual Shift]] key is toggled to pressed.
|HoldShift|Bool| Whether the Shift key is held.
|HoldShift|Bool| Whether the [[Component:VirtualShift|Virtual Shift]] key is held.
|TextPreviewActive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| drives the visibility of the preview text display.
|TextPreviewActive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| drives the visibility of the preview text display.
|TextPreview|IText| The text preview object that shows what the user is typing.
|TextPreview|IText| The text preview object that shows what the user is typing.
Line 18: Line 18:
== See Also ==
== See Also ==
* [[Component:VirtualKey|Virtual Key]]
* [[Component:VirtualKey|Virtual Key]]
* [[Component:VirtualKeyboard|Virtual Keyboard]]
* [[Component:VirtualModifierKey|Virtual Modifier Key]]
* [[Component:VirtualModifierKey|Virtual Modifier Key]]
* [[Component:VirtualMultiKey|Virtual Multi Key]]
* [[Component:VirtualMultiKey|Virtual Multi Key]]
* [[Component:VirtualShift|Virtual Shift]]
* [[Component:VirtualCloseKey|Virtual Close Key]]
* [[Component:VirtualKeyTextDrive|Virtual Key Text Drive]]
* [[Component:VirtualShiftColorDriver|Virtual Shift Color Driver]]


[[Category:Components:Userspace:Virtual Keyboard{{#translation:}}|Virtual Keyboard]]
[[Category:Components:Userspace:Virtual Keyboard{{#translation:}}|Virtual Keyboard]]
[[Category:Components{{#translation:}}|Virtual Keyboard]]
[[Category:Components{{#translation:}}|Virtual Keyboard]]

Latest revision as of 00:03, 17 October 2024

Component image 
Virtual Keyboard component as seen in the Scene Inspector

The Virtual Keyboard is a component that groups many Keys, Modifier Keys, and Multi Keys together.

Usage

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.
ShiftActive Bool Whether the Virtual Shift key is toggled to pressed.
HoldShift Bool Whether the Virtual Shift key is held.
TextPreviewActive field drive of Bool drives the visibility of the preview text display.
TextPreview IText The text preview object that shows what the user is typing.

Examples

Used in the default keyboard every user comes with, and

See Also