Project

General

Profile

Actions

Emulator Issues #13438

open

Advanced input expression function usage (e.g. "tap") is not well documented

Added by KKC_Tauboss 4 months ago. Updated about 1 month ago.

Status:
Accepted
Priority:
Normal
Assignee:
-
% Done:

0%

Operating system:
N/A
Issue type:
Bug
Milestone:
Regression:
No
Relates to usability:
Yes
Relates to performance:
No
Easy:
No
Relates to maintainability:
No
Regression start:
Fixed in:

Description

Game Name?

[Dolphin Hotkey Settings]

Game ID? (right click the game in the game list, Properties, Info tab)

[None]

MD5 Hash? (right click the game in the game list, Properties, Verify tab, Verify Integrity button)

[None]

What's the problem? Describe what went wrong.

[The "tap" function, which is located in the advanced hotkey options for any key (right-clicking a hotkey), does not work. It does not trigger any input no matter which formatting is used or if used standalone or in combination with an if statement.]

What steps will reproduce the problem?

[Open Dolphin -> Settings -> Hotkey Settings -> Right-click Any Hotkey Entry -> Try to write any "tap" function.]

Is the issue present in the latest development version? For future reference, please also write down the version number of the latest development version.

[Yes, the latest dev build: 5.0-20814]

Is the issue present in the latest stable version?

[Yes]

Actions #1

Updated by Dentomologist 4 months ago

When I set the expression to tap(`Click 0`, 5, 3) it behaves as follows:

Clicking once starts a five second input window without triggering the input. Clicking a second time within that window has no visible effect (but increments the counter). Clicking a third time within the window triggers the input for as long as the click is held. Any following clicks are ignored until the end of the window.

When the window ends all clicks are forgotten whether the input was triggered or not (unless you're still holding the triggering click, which lasts until you release it). That means that clicking once, then a second time after 4 seconds, then twice more at 6 seconds won't trigger an input but instead start a new window with 2 clicks that ends 11 seconds after the original input and needs only one more click to trigger the input.

Does that match what you're seeing? Either way, those functions could definitely use some documentation in the UI.

Actions #2

Updated by KKC_Tauboss 4 months ago

Dentomologist wrote in #note-1:

When I set the expression to tap(`Click 0`, 5, 3) it behaves as follows:

Clicking once starts a five second input window without triggering the input. Clicking a second time within that window has no visible effect (but increments the counter). Clicking a third time within the window triggers the input for as long as the click is held. Any following clicks are ignored until the end of the window.

When the window ends all clicks are forgotten whether the input was triggered or not (unless you're still holding the triggering click, which lasts until you release it). That means that clicking once, then a second time after 4 seconds, then twice more at 6 seconds won't trigger an input but instead start a new window with 2 clicks that ends 11 seconds after the original input and needs only one more click to trigger the input.

Does that match what you're seeing? Either way, those functions could definitely use some documentation in the UI.

Hello and thank you for the quick response. If you do the formatting this way it actually does work. The issue is then, that the tooltip shows the wrong formatting required. Entering the tap function yields "expected arguments: tap (input, seconds, taps=2) which to me suggests that you should type (Click 0, 5, taps = 3) when instead it is as you say (Click 0, 5, 3). Adjusting the tooltip could be beneficial to remove this confusion. Overall, I agree that the extended hotkey section could use more documentation as it currently is very trial and error.

Actions #3

Updated by JosJuice 4 months ago

  • Relates to usability changed from No to Yes

I think this is something that is more obvious to programmers than to regular users. In many programming languages, declaring a parameter like taps = 2 means that the number of taps will be 2 if you don't specify a value for the parameter but that you can specify a value of your own if you want to. I can't think of a better way to convey this in a way that's as succinct, but it would be great if we could have more detailed explanations somewhere, either in the UI or at https://wiki.dolphin-emu.org/index.php?title=Input_Syntax.

Actions #4

Updated by Billiard26 about 1 month ago

  • Subject changed from The "tap" function within the advanced hotkey settings does not work. to Advanced input expression function usage (e.g. "tap") is not well documented
  • Status changed from New to Accepted
Actions

Also available in: Atom PDF