Component:VirtualKeyboard: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
Line 3: Line 3:
|Name=Virtual Keyboard
|Name=Virtual Keyboard
}}
}}
{{stub}}
The Virtual Keyboard is a component that groups many [[Component:VirtualKey|Keys]], [[Component:VirtualModifierKey|Modifier Keys]], and [[Component:VirtualMultiKey|Multi Keys]] together.


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|ShiftActive|Bool|
|ShiftActive|Bool| Whether the Shift modifier key is active.
|HoldShift|Bool|
|HoldShift|Bool| Whether the Shift key is held.
|TextPreviewActive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv2=true|
|TextPreviewActive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| drives the visibility of the preview text display.
|TextPreview|IText|
|TextPreview|IText| The text preview object that shows what the user is typing.
}}
}}
== Behavior ==


== Examples ==
== Examples ==
Used in the default keyboard every user comes with, and


== See Also ==
== See Also ==
* [[Component:VirtualKey|Virtual Key]]
* [[Component:VirtualModifierKey|Virtual Modifier Key]]
* [[Component:VirtualMultiKey|Virtual Multi Key]]


[[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]]
[[Category:ComponentStubs]]

Revision as of 23:58, 16 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 Shift modifier key is active.
HoldShift Bool Whether the 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