ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Add ChatboxInputManager to provide a RuneScape styled input box

Browse Source
This commit is contained in:
Max Weber
2018-03-28 17:20:16 -06:00
committed by Adam
parent aa02da45c0
commit 44c740f21e
4 changed files with 291 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
runelite-api/src/main/java/net/runelite/api/ScriptID.java Normal file
View File

@@ -0,0 +1,30 @@
/*
* Copyright (c) 2018 Abex
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.api;
public final class ScriptID
{
public static final int RUNELITE_CHATBOX_INPUT_INIT = 10001;
}

112
runelite-client/src/main/java/net/runelite/client/game/ChatboxInputManager.java Normal file
View File

@@ -0,0 +1,112 @@
/*
* Copyright (c) 2018 Abex
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.client.game;
import com.google.common.eventbus.EventBus;
import com.google.common.eventbus.Subscribe;
import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.util.function.Consumer;
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.Client;
import net.runelite.api.ScriptID;
import net.runelite.api.events.ScriptCallbackEvent;
import net.runelite.client.callback.ClientThread;
@Singleton
@Slf4j
public class ChatboxInputManager
{
private final Client client;
private final ClientThread clientThread;
private Consumer<String> done;
@Inject
public ChatboxInputManager(Client client, ClientThread clientThread, EventBus eventBus)
{
this.client = client;
this.clientThread = clientThread;
eventBus.register(this);
}
/**
* Opens a RuneScape-style chatbox input
*
* @param text Text to show at the top of the window
* @param defaul Default text in the editable field
* @param done Callback when the text box has been exited, called with "" on esc
*/
public void openInputWindow(String text, String defaul, Consumer<String> done)
{
this.done = done;
clientThread.invokeLater(() -> client.runScript(
ScriptID.RUNELITE_CHATBOX_INPUT_INIT,
text,
defaul
));
}
@Subscribe
public void scriptCallback(ScriptCallbackEvent ev)
{
// This replaces script 74 and most of 112
if ("chatboxInputHandler".equals(ev.getEventName()))
{
int intStackSize = client.getIntStackSize();
int stringStackSize = client.getStringStackSize();
int typedKey = client.getIntStack()[--intStackSize];
String str = client.getStringStack()[--stringStackSize];
int retval = 0;
switch (typedKey)
{
case 27: // Escape
str = "";
// fallthrough
case '\n':
done.accept(str);
retval = 1;
break;
case '\b':
if (str.length() > 0)
{
str = str.substring(0, str.length() - 1);
}
default:
// If we wanted to do numbers only, we could add a limit here
if (typedKey >= 32)
{
str += Character.toString((char) typedKey);
}
}
client.getStringStack()[stringStackSize++] = str;
client.getIntStack()[intStackSize++] = retval;
client.setIntStackSize(intStackSize);
client.setStringStackSize(stringStackSize);
}
}
}

67
runelite-scripts/scripts/ChatboxInputHandler.rs2asm Normal file
View File

@@ -0,0 +1,67 @@
; Copyright (c) 2018 Abex
; All rights reserved.
;
; Redistribution and use in source and binary forms, with or without
; modification, are permitted provided that the following conditions are met:
;
; 1. Redistributions of source code must retain the above copyright notice, this
; list of conditions and the following disclaimer.
; 2. Redistributions in binary form must reproduce the above copyright notice,
; this list of conditions and the following disclaimer in the documentation
; and/or other materials provided with the distribution.
;
; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
; ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
; WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
; DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
; ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
; (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
; ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
;;
; Keylistener for ChatboxInputInit
;
; Script 112 Normal keylistener
;
; @param int pressedKey
; @param int typedKey
;;
.id 10002
.int_stack_count 1
.string_stack_count 1
.int_var_count 2
.string_var_count 1
; Discard zero presses
iload 0
load_int 0
if_icmpeq LABEL1
; Call runelite
iload 0
get_varc_string 22
load_string "chatboxInputHandler"
runelite_callback
istore 0
put_varc_string 22
; Check return value
iload 0
load_int 1
if_icmpne LABEL0
; Close the dialog
load_int 1
load_int 1
invoke 299
; Update UI
LABEL0:
load_string ""
invoke 222
LABEL1:
return

82
runelite-scripts/scripts/ChatboxInputInit.rs2asm Normal file
View File

@@ -0,0 +1,82 @@
; Copyright (c) 2018 Abex
; All rights reserved.
;
; Redistribution and use in source and binary forms, with or without
; modification, are permitted provided that the following conditions are met:
;
; 1. Redistributions of source code must retain the above copyright notice, this
; list of conditions and the following disclaimer.
; 2. Redistributions in binary form must reproduce the above copyright notice,
; this list of conditions and the following disclaimer in the documentation
; and/or other materials provided with the distribution.
;
; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
; ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
; WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
; DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
; ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
; (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
; ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
;;
; Creates a chatbox text input
;
; @param String Prompt text
; @param String Default value
;
; Script 752 GE input panel
; Script 103-111 various input panels
; Script 74 validates input
; script 112 key callback
;;
.id 10001
.int_stack_count 0
.string_stack_count 2
.int_var_count 0
.string_var_count 2
; Hide the chat pane
invoke 677
; Set current value
sload 1
put_varc_string 22
; Set text
sload 0
load_int 10616867 ; 162:35
widget_put_text_widget
; Init the widgets
load_string ""
invoke 222
; Register the key listener
load_int 10002
load_int -2147483639 ; typedKey
load_string "i"
load_int 10616868
widget_put_key_listener_widget
; Restore the chatbox on exit
load_int 299
load_int 1
load_int 1
load_string "ii"
load_int 10616868
widget_put_dialog_abort_listener_widget
; 70% sure this opens the keyboard on mobile
invoke 1972
load_int 1
if_icmpeq LABEL25
jump LABEL26
LABEL25:
invoke 1983
LABEL26:
return