From 918a050aa8de7794981e213391dc5c0d146f000e Mon Sep 17 00:00:00 2001 From: Eiyeron Date: Tue, 17 Apr 2018 10:41:02 +0200 Subject: [PATCH] Version 0.0.1 --- CHANGELOG.md | 11 +++++++++++ README.md | 8 ++++++-- 2 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d7987df --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + +## 0.0.1 - 2018-04-17 +### Added +- Initial versioning. +- Added a sample (decorating) +### Changed +- Textbox callback members are now callback arrays to handle multiple callbacks. +- Sample folder structure and name (`sample -> samples`) +- The first sample is now in `samples/demo` +- Changed demo sample to use the new callback type. \ No newline at end of file diff --git a/README.md b/README.md index 30a195f..8b441e3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # A Haxeflixel unnamed textbox library +**NOTE** : Even though the API shouldn't change a lot for now, this project is still a bit in WIP. ![Demo](readme_files/demo.gif) + ## Features - "Character-per-character"-style textbox for [Haxeflixel](https://haxeflixel.com/). - Correct word-wrapping : a being written word won't jump from a line to another if it's too big for the current line @@ -37,10 +39,12 @@ Callbacks are useful as they allow you to extend the textbox without touching it A few callback ideas (chaining boxes, sound-per-character, text character) are shown in the given sample project. -- `statusChangeCallback (Status)` : if the textbox's state changes, this callback is called. Here a list of the expected behavior to be notifed of: +- `statusChangeCallbacks (Status)` : if the textbox's state changes, this callback is called. Here a list of the expected behavior to be notifed of: + `FULL` : the textbox is full. Coupled with `continueWriting` you can make stuff like waiting a button press to resume writing. + `DONE` : the textbox finished writing its content. You can `dismiss` it or set it with new text. -- `characterDisplayCallback (textbox.Text)` : This callback is added each time a character is added to the box. Use this if you need features like an audio sample played for every character, a text cursor following the input, etc etc... +- `characterDisplayCallbacks (textbox.Text)` : This callback is added each time a character is added to the box. Use this if you need features like an audio sample played for every character, a text cursor following the input, etc etc... + +Those textbox callback facilities are just callback arrays, to add or remove your own callback, just use `push` or `pop` on those members. ### Settings object (Check for textbox/Settings.hx to see what kind of parametters you can override.)