Mirrors/StevesUEHelpers
1
0
Fork 0
mirror of https://github.com/sinbad/StevesUEHelpers.git synced 2025-02-23 17:45:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Expose device preference for input bindings in rich text decorator

Browse Source
This commit is contained in:
Steve Streeting 2022-02-01 15:04:40 +00:00
parent 05a1c1ab46
commit d6c5ab1f08
2 changed files with 43 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Source/StevesUEHelpers/Private/StevesUI/RichTextBlockInputImageDecorator.cpp
View File

@ -20,6 +20,9 @@ struct FRichTextInputImageParams
FKey Key; FKey Key;
/// Player index, if binding type is action or axis /// Player index, if binding type is action or axis
int PlayerIndex; int PlayerIndex;
/// Where there are multiple mappings, which to prefer
EInputImageDevicePreference DevicePreference = EInputImageDevicePreference::Auto;
/// Initial Sprite to use /// Initial Sprite to use
UPaperSprite* InitialSprite; UPaperSprite* InitialSprite;
/// Parent decorator, for looking up things later /// Parent decorator, for looking up things later
@ -37,6 +40,8 @@ protected:
FKey Key; FKey Key;
/// Player index, if binding type is action or axis /// Player index, if binding type is action or axis
int PlayerIndex = 0; int PlayerIndex = 0;
/// Where there are multiple mappings, which to prefer
EInputImageDevicePreference DevicePreference = EInputImageDevicePreference::Auto;
/// Parent decorator, for looking up things later /// Parent decorator, for looking up things later
URichTextBlockInputImageDecorator* Decorator = nullptr; URichTextBlockInputImageDecorator* Decorator = nullptr;
@ -59,6 +64,7 @@ public:
{ {
BindingType = InParams.BindingType; BindingType = InParams.BindingType;
ActionOrAxisName = InParams.ActionOrAxisName; ActionOrAxisName = InParams.ActionOrAxisName;
DevicePreference = InParams.DevicePreference;
Key = InParams.Key; Key = InParams.Key;
PlayerIndex = InParams.PlayerIndex; PlayerIndex = InParams.PlayerIndex;
Decorator = InParams.Decorator; Decorator = InParams.Decorator;
@ -122,7 +128,7 @@ public:
if (GS) if (GS)
{ {
// Can only support default theme, no way to edit theme in decorator config // Can only support default theme, no way to edit theme in decorator config
auto Sprite = GS->GetInputImageSprite(BindingType, ActionOrAxisName, Key, EInputImageDevicePreference::Auto, PlayerIndex); auto Sprite = GS->GetInputImageSprite(BindingType, ActionOrAxisName, Key, DevicePreference, PlayerIndex);
if (Sprite && Brush.GetResourceObject() != Sprite) if (Sprite && Brush.GetResourceObject() != Sprite)
{ {
UStevesGameSubsystem::SetBrushFromAtlas(&Brush, Sprite, true); UStevesGameSubsystem::SetBrushFromAtlas(&Brush, Sprite, true);
@ -207,6 +213,26 @@ protected:
Params.ActionOrAxisName = **AxisStr; Params.ActionOrAxisName = **AxisStr;
} }
if (const FString* PreferStr = RunInfo.MetaData.Find(TEXT("prefer")))
{
if (PreferStr->Equals("auto", ESearchCase::IgnoreCase))
{
Params.DevicePreference = EInputImageDevicePreference::Auto;
}
else if (PreferStr->Equals("gkm", ESearchCase::IgnoreCase))
{
Params.DevicePreference = EInputImageDevicePreference::Gamepad_Keyboard_Mouse;
}
else if (PreferStr->Equals("gmk", ESearchCase::IgnoreCase))
{
Params.DevicePreference = EInputImageDevicePreference::Gamepad_Mouse_Keyboard;
}
else if (PreferStr->Equals("gmkbutton", ESearchCase::IgnoreCase))
{
Params.DevicePreference = EInputImageDevicePreference::Gamepad_Keyboard_Mouse_Button;
}
}
// Look up the initial sprite here // Look up the initial sprite here
// The Slate widget can't do it in Construct because World pointer doesn't work (thread issues?) // The Slate widget can't do it in Construct because World pointer doesn't work (thread issues?)
// Also annoying: can't keep Brush on this class because this method is const. UGH // Also annoying: can't keep Brush on this class because this method is const. UGH
@ -214,7 +240,7 @@ protected:
if (GS) if (GS)
{ {
// Can only support default theme, no way to edit theme in decorator config // Can only support default theme, no way to edit theme in decorator config
Params.InitialSprite = GS->GetInputImageSprite(Params.BindingType, Params.ActionOrAxisName, Params.Key, EInputImageDevicePreference::Auto, Params.PlayerIndex); Params.InitialSprite = GS->GetInputImageSprite(Params.BindingType, Params.ActionOrAxisName, Params.Key, Params.DevicePreference, Params.PlayerIndex);
} }
else else
{ {

15
doc/RichTextInputDecorator.md
View File

@ -81,6 +81,21 @@ derive the width from that based on the aspect ratio.
It's generally best just to set the height and not the width as well, since It's generally best just to set the height and not the width as well, since
setting both can cause the image to be distorted if it's not the same aspect ratio. setting both can cause the image to be distorted if it's not the same aspect ratio.
### Device Preference
For the `action` and `axis` types, which device to prefer to show the image for
can be specified with the `prefer="x"` attribute. The default is `prefer="auto"`, which means:
1. Gamepad, if the last used device was gamepad
2. If an Action (button/key), prefer Keyboard over Mouse buttons
3. If an Axis, prefer Mouse over Keyboard
Alternatives are:
* `prefer="gkm"`: prefer Gamepad, then Keyboard, then Mouse
* `prefer="gmk"`: prefer Gamepad, then Mouse, then Keyboard
* `prefer="gmkbutton"`: prefer Gamepad, then whichever of Mouse ot Keyboard last had a button pressed
## See Also ## See Also
* [Input Image](InputImage.md) * [Input Image](InputImage.md)