Virtual Buttons and DPad

Aloe Guvner · 2018-04-18T03:48:56+0900

Virtual Buttons and DPad by Aloe Guvner Download Link Note: This plugin is not under active maintenance. Background: This plugin focuses on improving the user interface for mobile games created in RPG Maker MV, by allowing the developer to have virtual buttons on the screen that interact with touch input. The emphasis is on maximum flexibility for the developer, you can add as many or as few buttons as you want to the screen, and you can add these buttons on whichever screens you would like (i.e. map, menu, credits, title, etc.). Functionality: This plugin can create 3 different types of buttons: 1.) Directional Pad A single picture which is used for up, left, right, and down movement (also support diagonal movement when combined with a Diagonal Movement plugin). You control what scenes the DPad appears in. This button is optional. 2.) Key buttons These buttons can be used to represent any key. Common keys to use would be "ok" , "escape", "pagedown", "pageup". These can be any key, and there can be as many or as few as the developer would like, and you control what scenes they appear in. Buttons can run Common Events. You can also write custom code that will be run when the button is pressed! You may specify the type of input this button responds to: Triggered: Execute once when pressed (default) Pressed: Execute every frame while pressed Repeated: After 24 frames, execute every 6 frames while pressed Long Pressed: After 24 frames, execute every frame while pressed Released: Execute once when button is released 3.) Control button The control button, if pressed, will collapse and hide all other buttons on the screen. If pressed again, it will expand and show all other buttons on the screen. This allows the player to decide between using the virtual buttons or the standard touch input. The scenes that this button appears in can be defined. This button is optional. Use Cases and Screenshots: {clearly placeholder art below } Spoiler: Use Case example #1 This example uses the DPad and two Key Buttons ("ok" and "escape") to put simple keyboard controls as virtual buttons on the map screen (Scene_Map). Spoiler: Use Case example #2 This example uses buttons with the functionality of "pageup" and "pagedown" in the status screen. These buttons can be put in whichever screen you like. Page Up and Page Down move between actors in the menu, so this would make sense to go in the Status, Equip, and Skill screens (Scene_Status, Scene_Equip, Scene_Skill). Spoiler: Use Case example #3 A virtual button can call custom Javascript code. If you are familiar with the engine, this can be extremely flexible and powerful. In this simple use case, the item screen is opened by pressing the button. Setup: The setup requires a new folder to be created within the img folder of the project. This folder must be named "VirtualButtons". Put all virtual button images in this folder, and then they may be accessed in the plugin parameters. Plugin Commands: * All plugin commands begin with VirtualButtons (MobileUI is also valid, for backwards-compatibility). * All plugin commands are not case sensitive (i.e. "DPad" is the same as "dpad") hide Description: hides the specified button Allowed arguments: DPad Any key button defined by you Control All Examples: VirtualButtons hide DPad virtualbuttons hide Ok MobileUI hide PageDown show Description: shows the specified button Allowed arguments: DPad Any key button defined by you Control All Examples: VirtualButtons show DPad virtualbuttons show Ok MobileUI show PageDown opacity Description: change the opacity of a button Allowed arguments: DPad Any key button defined by you Control All Examples: VirtualButtons opacity dpad 100 VirtualButtons opacity all 50 Terms of Use: Free for use in commercial or non-commercial projects. Credits required to: Aloe Guvner Version History: v2.0.1 (May 13 2019) Fix bug where DPad input wasn't cleared in menus v2.0.0 (May 4 2019) Clears input state on transfer to mitigate stuck DPad input bug Improves clearing of input state each frame to mitigate bug Buttons hidden via plugin command will stay hidden until the show plugin command Key buttons can trigger common events Option to use a "hot" image that shows when the button is pressed Delay parameter to fade-in Plugin command option to show all buttons Plugin command option to hide all buttons Plugin command to change button opacity Add plugin parameter to toggle whether the buttons are hidden during dialogue Fix bug where the DPad would not clear the direction after a parallel event checking for a input direction triggered a Show Choices event command v1.4.0 (December 13 2018) Added ability to configure which buttons are affected by the "control" button Can be used to create dynamic menus v1.3.1 (October 30 2018) Added a parameter to control whether diagonal movement is detected as a possible fix for a hard to reproduce movement bug. v1.3.0 (September 27 2018) Added a parameter to choose to disable the normal touch inpu…

● ARCHIVED · READ-ONLY

Started by Aloe Guvner Apr 17, 2018, 06:48 PM 229 posts Page 5 of 12 View original ↗

Aloe Guvner

#81 Mar 28, 2019, 05:22 PM Source

Thanks for the apk! Hopefully I will have some time this weekend.

The new features can definitely be implemented. I will focus on solving the bug first.

Eliaquim said:
- Change the opacity of the buttons image inside the game;

Do you mean with a plugin command? Or in response to some action?
Eliaquim

#82 Mar 28, 2019, 05:33 PM Source

Aloe Guvner said:
Thanks for the apk! Hopefully I will have some time this weekend.

The new features can definitely be implemented. I will focus on solving the bug first.

Do you mean with a plugin command? Or in response to some action?
Thank you @Aloe Guvner !! ^^

In the opacity case, i mean with a plugin command, or with a script call. I was looking into the code and i see something about opacity of the sprite button. I will test some commands to see if i can already do this and will return the results to you here.
TenTranVN

#83 Mar 29, 2019, 01:12 AM Source

Eliaquim said:
Hi @Aloe Guvner
Thinking about the issue, i uploaded an APK for you to see the problem.
As soon as the game start, you only have to enter in the door above and out, and repeat the process.
You will see that the player will keep going up. When you press other directions, they will return Up again. It only stops when you press UP again.
Same thing when you exit the room, but instead going Up, it will going down.
https://www.dropbox.com/s/po6ma59tui9r7nf/Aloe Issue.apk?dl=0

Also, i have been thinking if you can implement two things:
- Change the opacity of the buttons image inside the game;
- Add an animation to the button when it is pressed (it can be a dark or light flash).
Like this video for example:

good idea
pedrohp3

#84 Apr 19, 2019, 08:31 PM Source

Thanks @Aloe Guvner and @Eliaquim! That's exactly the issue I'm facing! I really look forward to seeing an update :)
jkweath

#85 Apr 20, 2019, 02:19 PM Source

@Aloe Guvner Great plugin! I was using Yanfly's Picture Common events before as a mobile UI, but your setup works much better.

There's a couple things I wanted to ask:

1. Not sure if this is a bug or intended behavior: the "mobileui hide" plugin commands work just fine, but after any dialogue appears, the buttons re-enable themselves by default.

2. I was wondering if there's a simple way to add a delay between when a message box disappears and when the mobileUI re-appears. I ask this because my game uses a Bust plugin, and to have it work optimally, I have to add a 15 frame wait timer between each message box that uses a bust. It's not a big deal, but having that 15 frame wait means that the mobileUI awkwardly re-appears between each message box.
Aloe Guvner

#86 Apr 20, 2019, 03:16 PM Source

@jkweath good ideas

I didn't have access to my computer with RPG Maker for several weeks but I do again. My first priority will be fixing the annoying bug with the Dpad reported by other users.

For your suggestions:
1. I can create a option in the configuration, you can choose whether the plugin "remembers" if you've used the plugin command or not. If you've used it, the buttons won't re-appear until you use the "show" plugin command.

2. There's a setting that controls the duration of the fade-in & fade-out, does that work for you? I understand a delay setting is different than a duration setting. It's probably valuable to have both.

By the way, the next update will be big and I'm going to rename this plugin to "Virtual Buttons and Dpad", since it can be used on desktop too. I'm going to include something that automatically copies your settings so you don't have to change anything.
jkweath

#87 Apr 20, 2019, 04:43 PM Source

@Aloe Guvner Adding an option to remember the plugin command would work for sure.

As for the delay problem, I experimented with the fade duration and didn't have any luck. I tried going into the code itself and modifying the fade-in duration specifically to be longer. It technically works, but then the buttons take too long to re-appear and be usable again.

I hope adding a delay option would be useful for more people than just me. Besides that, keep up the great work!
Eliaquim

#88 Apr 20, 2019, 10:24 PM Source
jkweath said:
@Aloe Guvner Great plugin! I was using Yanfly's Picture Common events before as a mobile UI, but your setup works much better.

There's a couple things I wanted to ask:

1. Not sure if this is a bug or intended behavior: the "mobileui hide" plugin commands work just fine, but after any dialogue appears, the buttons re-enable themselves by default.

2. I was wondering if there's a simple way to add a delay between when a message box disappears and when the mobileUI re-appears. I ask this because my game uses a Bust plugin, and to have it work optimally, I have to add a 15 frame wait timer between each message box that uses a bust. It's not a big deal, but having that 15 frame wait means that the mobileUI awkwardly re-appears between each message box.

Old
I think you can handle this editing the parte on the code between lines:

1092 and 1106. At least the first question i think its possible. There you can find the part of the code that deals with the show mobile ui during the message box.
For the 15 frames thing i dont know for sure.

@jkweath hey! I found a solution for you for a while.
Replace all the codes between and include the lines 1092 and 1106 with this code:
Code:
Alias.Window_Message_update = Window_Message.prototype.update; Window_Message.prototype.update = function() { if ($gameSwitches.value(X) == true) { SceneManager._scene.hideMobileUI(); } else if ($gameMessage.isBusy() && $gameSwitches.value(X) == false) { SceneManager._scene.hideMobileUI(); } else if (!$gameMessage.isBusy() && $gameSwitches.value(X) == false) { SceneManager._scene.showMobileUI(); } Alias.Window_Message_update.call(this); };
Change all the "X" value in the code for the number of switch you desire.

This code will make the, when switch X is ON, game will hide the controls. Then you can make the cutscenes etc. to make the controls appear again, just turn the switch off.

But, also, if this switch is OFF and the message window is active the controls will hide. When the message window is closed(and the switch still OFF), the controls will be showed again in the speed that you define in the parameters.
jkweath

#89 Apr 27, 2019, 01:11 AM Source

@Eliaquim thanks a bunch! I'll try this out when I get the chance.

@Aloe Guvner I've been playtesting my game on mobile with your plugin and wanted to give some more feedback:

1. There was a time when I transferred between maps that the "up" direction seemingly got stuck and I couldn't input any other direction for a few seconds. I think this was mentioned elsewhere in the thread, but I just wanted to mention it so you know more than one person is having the issue. Not sure if it can happen with other directions or not.

EDIT: @Aloe Guvner Wanted to add a couple more things about this bug. For one, it can trigger any time the player is transferred, including if it's on the same map. It doesn't always seem to be the direction the player is holding as he is transferred.

The big thing to report (if it hasn't been already) is that the bug is easily fixed by tapping the direction the player is stuck moving in. I imagine the way to solve this bug would be to somehow "clear out" all movement commands upon a player transfer.

2. I'm using Yanfly's Battle Status Window, and despite having touch controls disabled for battle scenes, they seem to turn back on when I'm using an ability that selects other actors. I'm not sure if this is a compatibility thing or not, I need to test it more.

3. I've seen some people mention adding a script/plugin call to adjust button opacity on the fly. I second that idea.

That's all for now!
siuleeboss

#90 Apr 30, 2019, 04:50 AM Source

can not be used
What's the problem?
RMMV Version 1.6.2
Aloe Guvner

#91 Apr 30, 2019, 12:33 PM Source

@aroha You have a space at the end of the filename. Make sure not to rename the file.
siuleeboss

#92 Apr 30, 2019, 02:58 PM Source

@Aloe Guvner Thank you.It can be work when I remove the space.
But I can't do anything when I open the menu in the game.And the button picture is gone.
What's the problem?
Aloe Guvner

#93 May 1, 2019, 04:16 AM Source

aroha said:
But I can't do anything when I open the menu in the game.

In your settings, do you have "Disable Touch Selectable Windows" include Scene_Menu? This would mean that touch selectable windows are disabled in the menu scene.

aroha said:
And the button picture is gone.

What settings did you make for the button?
siuleeboss

#94 May 1, 2019, 05:04 PM Source

@Aloe Guvner
It can be work when I include Scene_Menu to the button text list.
But another problem has arisen. When I talked to the event, all the buttons disappeared.
And I tested and found that it was a conflict with other plugins.
My English is so bad,I hope you can read to understand this.
Thank you.
siuleeboss

#95 May 1, 2019, 09:27 PM Source

@Aloe Guvner
I found another problem. When I talk to the event, it doesn't display the button image, only the touch operation. What's even worse: if you use the down button to make a selective dialogue in the story, it will Keep pressing the down button, which means I can't choose another option.
Aloe Guvner

#96 May 1, 2019, 10:55 PM Source

aroha said:
When I talked to the event, all the buttons disappeared.
That is intentional. If people want, I can create a setting to toggle that.

aroha said:
What's even worse: if you use the down button to make a selective dialogue in the story, it will Keep pressing the down button, which means I can't choose another option.
Is the "down button" on the keyboard? Or a virtual button?
Can you make a screenshot, video, or gif of that issue?
jkweath

#97 May 2, 2019, 12:20 AM Source

@Aloe Guvner just curious, is version 2.0 actually out yet? It says on the original post that you released it on April 25th but the download is still only for version 1.4.
Aloe Guvner

#98 May 2, 2019, 02:49 AM Source

@jkweath You're right, that's a mistake. I fixed the Dpad bug and added a couple features which are available on a separate branch in Github. I still have a few more features to add, but probably won't have time until the weekend. So I'm targeting this Saturday
siuleeboss

#99 May 2, 2019, 06:52 AM Source

Aloe Guvner said:
That is intentional. If people want, I can create a setting to toggle that.
I want it ,please create a setting to toggle that.

Aloe Guvner said:
Is the "down button" on the keyboard? Or a virtual button?
Can you make a screenshot, video, or gif of that issue?

It is that problem."down button" is a virtual button
Aloe Guvner

#100 May 2, 2019, 01:04 PM Source

That's definitely a bug. Can you PM me that MapXXX.json file? You can find that file in the "data" folder of your project.