Skip to content

Commit 84a4fc2

Browse files
committed
Improved docs
1 parent 8f78e40 commit 84a4fc2

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,6 @@ The RichText library will create gui text nodes representing the markup in the t
7474
bold = hash("Roboto-Bold"),
7575
bold_italic = hash("Roboto-BoldItalic"),
7676
},
77-
VeraMo = {
78-
regular = hash("VeraMo"),
79-
},
8077
Nanum = {
8178
regular = hash("Nanum-Regular"),
8279
},
@@ -85,8 +82,16 @@ The RichText library will create gui text nodes representing the markup in the t
8582
position = vmath.vector3(0, 0, 0),
8683
parent = gui.get_node("parent"),
8784
}
88-
self.nodes = richtext.create("Lorem <b>ipsum</b> dolor <color=red>sit</color> amet.", "Roboto", settings)
8985

86+
local text = "<size=3>RichText</size>Lorem <color=0,0.5,0,1>ipsum </color>dolor <color=red>sit </color><color=#ff00ffff>amet, </color><size=1.15><font=Nanum>consectetur </font></size>adipiscing elit. <b>Nunc </b>tincidunt <b><i>mattis</i> libero</b> <i>non viverra</i>. Nullam ornare accumsan rhoncus. Nunc placerat nibh a purus auctor, id scelerisque massa rutrum."
87+
88+
self.nodes = richtext.create(text, "Roboto", settings)
89+
90+
This would result in the following output:
91+
92+
![](docs/example.png)
93+
94+
## API
9095
### richtext.create(text, settings)
9196
Creates rich text gui nodes from a text containing markup.
9297

docs/example.png

34.9 KB
Loading

example/example.gui_script

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
local richtext = require "richtext.richtext"
22

3-
local TEXT = "Lorem <color=0,0.5,0,1>ipsum </color>dolor <color=red>sit </color><color=#ff00ffff>amet, </color><size=1.75><font=Nanum>consectetur </font></size>adipiscing elit. <b>Nunc </b>tincidunt <b><i>mattis</i> libero</b> <i>non viverra</i>. Nullam ornare accumsan rhoncus. Nunc placerat nibh a purus auctor, id scelerisque massa rutrum. Phasellus dui nulla, finibus eu neque sit amet, interdum suscipit mauris. Phasellus mattis sem sed leo pretium, eu eleifend quam bibendum."
3+
local TEXT = "<size=3>RichText</size>Lorem <color=0,0.5,0,1>ipsum </color>dolor <color=red>sit </color><color=#ff00ffff>amet, </color><size=1.15><font=Nanum>consectetur </font></size>adipiscing elit. <b>Nunc </b>tincidunt <b><i>mattis</i> libero</b> <i>non viverra</i>. Nullam ornare accumsan rhoncus. Nunc placerat nibh a purus auctor, id scelerisque massa rutrum."
44

55
function init(self)
66
local settings = {
@@ -11,9 +11,6 @@ function init(self)
1111
bold = hash("Roboto-Bold"),
1212
bold_italic = hash("Roboto-BoldItalic"),
1313
},
14-
VeraMo = {
15-
regular = hash("VeraMo"),
16-
},
1714
Nanum = {
1815
regular = hash("Nanum-Regular"),
1916
},

0 commit comments

Comments
 (0)