Component:VirtualShift: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
No edit summary
 
Line 3: Line 3:
|Name=Virtual Shift
|Name=Virtual Shift
}}
}}
{{stub}}
Simulates pressing or holding onto the shift key on a normal physical keyboard.


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Keyboard|{{RootFieldType|RelayRef`1|[[Component:VirtualKeyboard|VirtualKeyboard]]}}|TypeAdv0=true|
|Keyboard|{{RootFieldType|RelayRef`1|[[Component:VirtualKeyboard|VirtualKeyboard]]}}|TypeAdv0=true| The keyboard which the keys should be set or unset from the holding shift state.
|HoldPressInterval|Float|
|HoldPressInterval|Float| what value <code>_lastPress</code> has to be below when the button is pressed again to enable <code>AlwaysHold</code> field.
|AlwaysHold|Bool|
|AlwaysHold|Bool| Whether the user has double clicked shift and enabled a constant hold shift state.
|_lastPress|Double|
|_lastPress|Double| Internal, how many seconds has passed since this button was last pressed. is used to handle enabling/disabling <code>AlwaysHold</code> field.
}}
}}
== Behavior ==


== Examples ==
== Examples ==
Is used in the default keyboard to make the shift key function.


== See Also ==
== See Also ==
* [[Component:VirtualKey|Virtual Key]]
* [[Component:VirtualKeyboard|Virtual Keyboard]]
* [[Component:VirtualModifierKey|Virtual Modifier 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 Shift]]
[[Category:Components:Userspace:Virtual Keyboard{{#translation:}}|Virtual Shift]]
[[Category:Components{{#translation:}}|Virtual Shift]]
[[Category:Components{{#translation:}}|Virtual Shift]]
[[Category:ComponentStubs]]

Latest revision as of 00:25, 17 October 2024

Component image 
Virtual Shift component as seen in the Scene Inspector

Simulates pressing or holding onto the shift key on a normal physical keyboard.

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.
Keyboard direct RelayRef`1<VirtualKeyboard> The keyboard which the keys should be set or unset from the holding shift state.
HoldPressInterval Float what value _lastPress has to be below when the button is pressed again to enable AlwaysHold field.
AlwaysHold Bool Whether the user has double clicked shift and enabled a constant hold shift state.
_lastPress Double Internal, how many seconds has passed since this button was last pressed. is used to handle enabling/disabling AlwaysHold field.

Examples

Is used in the default keyboard to make the shift key function.

See Also