Component:VirtualModifierKey: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
No edit summary
Line 3: Line 3:
|Name=Virtual Modifier Key
|Name=Virtual Modifier Key
}}
}}
{{stub}}
Virtual Modifier Key is a way of making [[Component:VirtualKey|Virtual Keys]] change what they type when pressed.


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Keyboard|{{RootFieldType|RelayRef`1|[[Component:VirtualKeyboard|VirtualKeyboard]]}}|TypeAdv0=true|
|Keyboard|{{RootFieldType|RelayRef`1|[[Component:VirtualKeyboard|VirtualKeyboard]]}}|TypeAdv0=true|
|State|Bool|
|State|Bool| Whether this modifier key is active or not, kind of like if CAPSLOCK was active.
}}
}}
== Behavior ==


== Examples ==
== Examples ==
This can be used to make a button that when activated, makes all the keys on the VR keyboard append "CHEESE!" whenever a key is pressed. Keep in mind the key would need to be a part of a saved [[Favorites|favorite]] keyboard.


== See Also ==
== See Also ==
Line 19: Line 18:
[[Category:Components:Userspace:Virtual Keyboard{{#translation:}}|Virtual Modifier Key]]
[[Category:Components:Userspace:Virtual Keyboard{{#translation:}}|Virtual Modifier Key]]
[[Category:Components{{#translation:}}|Virtual Modifier Key]]
[[Category:Components{{#translation:}}|Virtual Modifier Key]]
[[Category:ComponentStubs]]

Revision as of 23:14, 16 October 2024

Component image 
Virtual Modifier Key component as seen in the Scene Inspector

Virtual Modifier Key is a way of making Virtual Keys change what they type when pressed.

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>
State Bool Whether this modifier key is active or not, kind of like if CAPSLOCK was active.

Examples

This can be used to make a button that when activated, makes all the keys on the VR keyboard append "CHEESE!" whenever a key is pressed. Keep in mind the key would need to be a part of a saved favorite keyboard.

See Also