Skip to content

Commit f61589f

Browse files
authored
Update README.md
1 parent 1d4b67e commit f61589f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,13 @@ Split a word into it's characters, including the creation of the gui nodes. Each
301301

302302

303303
### richtext.on_click(words, action)
304-
Call this function when a click/touch has been detected and your text contains words with an `a` tag. These words act as "hyperlinks" and will generate a message when clicked.
304+
Call this function when a click/touch has been detected and your text contains words with an `a` tag. These words act as "hyperlinks" and will generate a message when clicked. The generated message will contain the following values:
305+
306+
* `node_id` (hash) - Id of the node which was clicked
307+
* `text` (string) - Text of the clicked word
308+
* `screen_x` (number) - Horizontal position of the click
309+
* `screen_y` (number) - Vertical position of the click
310+
* `tags` (table) - All tags on the clicked word
305311

306312
**PARAMETERS**
307313
* `words` (table) - A list of words, as received from `richtext.create()` or `richtext.tagged()`.

0 commit comments

Comments
 (0)