Skip to content

Improved text handling and keyboard input functionality for UITextBox #900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TerameTechYT wants to merge 2 commits into
base: main
Choose a base branch
from
+114 −14
Open

Improved text handling and keyboard input functionality for UITextBox #900

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c2777b
Refactor UITextBox for improved text handling and keyboard input func…
TerameTechYT Feb 3, 2026
66972c0
use cut paste copy sounds
TerameTechYT Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 114 additions & 14 deletions source/funkin/editors/ui/UITextBox.hx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,27 +60,27 @@ class UITextBox extends UISliceSprite implements IUIFocusable {

var selected = selectable && focused;
if (autoAlpha) {
if(selectable) {
if (selectable) {
alpha = label.alpha = 1;
} else {
alpha = label.alpha = 0.4;
}
}

var off = multiline ? 4 : ((bHeight - label.height) / 2);
label.follow(this, label.autoSize ? (bWidth-label.textField.width)/2 : 4, off);
label.follow(this, label.autoSize ? (bWidth - label.textField.width) / 2 : 4, off);
framesOffset = (selected ? 18 : (hovered ? 9 : 0));
@:privateAccess {
if (selected) {
__wasFocused = true;
caretSpr.alpha = (FlxG.game.ticks % 666) >= 333 ? 1 : 0;

var curPos = switch(position) {
var curPos = switch (position) {
case 0:
FlxPoint.get(0, 0);
default:
if (position >= label.text.length) {
label.textField.__getCharBoundaries(label.text.length-1, cacheRect);
label.textField.__getCharBoundaries(label.text.length - 1, cacheRect);
FlxPoint.get(cacheRect.x + cacheRect.width, cacheRect.y);
} else {
label.textField.__getCharBoundaries(position, cacheRect);
Expand All @@ -100,60 +100,160 @@ class UITextBox extends UISliceSprite implements IUIFocusable {
}
}

private static var seperators:Array<String> = [
" ", "\n", "\t", "\r", "-", "_", "=", "+", "/", "\\", "|", ",", ".", ";", ":", "!", "?", "@", "#", "$", "%", "^", "&", "*", "(", ")", "[", "]", "{",
"}",
];

public inline static function isSeperator(char:String):Bool
return seperators.contains(char);

public inline static function findWholeWord(text:String, pos:Int, ?isDelete:Bool = false):Null<Array<Int>> {
if (text.length == 0)
return null;

var start = pos;
var end = pos;

while (!isDelete && start > 0 && !isSeperator(text.charAt(start - 1)))
start--;

while (end < text.length && !isSeperator(text.charAt(end)))
end++;

if (end == pos && isSeperator(text.charAt(end - 1)))
start--;

return [start, end];
}

public function onKeyDown(e:KeyCode, modifier:KeyModifier) {
switch(e) {
switch (e) {
case RETURN:
focused = false;
if (onChange != null) onChange(label.text);
if (onChange != null)
onChange(label.text);
case LEFT:
if (modifier.ctrlKey) {
if (position == 0)
return;

var wordBounds = findWholeWord(label.text, position);
if (wordBounds != null) {
position = position == wordBounds[0] ? wordBounds[0] - 1 : wordBounds[0];
} else {
position = 0;
}

return;
}

changeSelection(-1);
case RIGHT:
if (modifier.ctrlKey) {
if (position == label.text.length)
return;

var wordBounds = findWholeWord(label.text, position);
if (wordBounds != null) {
position = position == wordBounds[1] ? wordBounds[1] + 1 : wordBounds[1];
} else {
position = label.text.length;
}

return;
}

changeSelection(1);
case BACKSPACE:
FlxG.sound.play(Paths.sound(Flags.DEFAULT_EDITOR_TEXTREMOVE_SOUND));

if (modifier.ctrlKey) {
var wordBounds = findWholeWord(label.text, position);
if (wordBounds != null) {
label.text = label.text.substr(0, wordBounds[0]) + label.text.substr(wordBounds[1]);
position = wordBounds[0];
}
return;
}

if (position > 0) {
label.text = label.text.substr(0, position-1) + label.text.substr(position);
label.text = label.text.substr(0, position - 1) + label.text.substr(position);
changeSelection(-1);
}
case DELETE:
FlxG.sound.play(Paths.sound(Flags.DEFAULT_EDITOR_TEXTREMOVE_SOUND));

if (modifier.ctrlKey) {
var wordBounds = findWholeWord(label.text, position, true);
if (wordBounds != null) {
label.text = label.text.substr(0, wordBounds[0]) + label.text.substr(wordBounds[1]);
position = wordBounds[0];
}
return;
}

if (position < label.text.length) {
label.text = label.text.substr(0, position) + label.text.substr(position + 1);
}
case HOME:
position = 0;
case END:
position = label.text.length;
case V:
FlxG.sound.play(Paths.sound(Flags.DEFAULT_EDITOR_TEXTTYPE_SOUND));
FlxG.sound.play(Paths.sound(Flags.DEFAULT_EDITOR_PASTE_SOUND));
// Hey lj here, fixed copying because before we checked if the modifier was left or right ctrl
// but somehow it gave a int outside of the KeyModifier's range :sob:
// apparently there is a boolean that just checks for you. yw :D

// if we are not holding ctrl, ignore
if (!modifier.ctrlKey) return;
if (!modifier.ctrlKey)
return;
// we pasting
var data:String = Clipboard.generalClipboard.getData(TEXT_FORMAT);
if (data != null) onTextInput(data);
if (data != null)
onTextInput(data);
case C:
FlxG.sound.play(Paths.sound(Flags.DEFAULT_EDITOR_TEXTTYPE_SOUND));
FlxG.sound.play(Paths.sound(Flags.DEFAULT_EDITOR_COPY_SOUND));
// if we are not holding ctrl, ignore
if (!modifier.ctrlKey) return;
if (!modifier.ctrlKey)
return;

// copying
Clipboard.generalClipboard.setData(TEXT_FORMAT, label.text);
case X:
FlxG.sound.play(Paths.sound(Flags.DEFAULT_EDITOR_CUT_SOUND));

// if we are not holding ctrl, ignore
if (!modifier.ctrlKey)
return;

// cutting
Clipboard.generalClipboard.setData(TEXT_FORMAT, label.text);
position = 0;
label.text = "";
default:
if (modifier.ctrlKey || modifier.altKey || modifier.shiftKey)
return;

FlxG.sound.play(Paths.sound(Flags.DEFAULT_EDITOR_TEXTTYPE_SOUND));
}
}

public function changeSelection(change:Int) {
position = FlxMath.wrap(position + change, 0, label.text.length);
position = Std.int(FlxMath.bound(position + change, 0, label.text.length));
}

public function onKeyUp(e:KeyCode, modifier:KeyModifier) {}

public function onTextInput(text:String):Void {
label.text = label.text.substr(0, position) + text + label.text.substr(position);
position += text.length;
}

// untested, but this should be a fix for if the text wont type
public function onTextEdit(text:String, start:Int, end:Int):Void {
label.text = label.text.substr(0, position) + text + label.text.substr(position);
position += text.length;
}
}
}