Skip to content

fText: Examples

Damian Monogue edited this page Feb 7, 2021 · 1 revision

Let's format some text y'all

All the code below assumes you've run the following (or equivalent) in the same script.

local ftext = require("MDK.ftext")

Centered, mirrored caps, spacer inside

cecho(ftext.fText("some text", {alignment = "center", width = 30, cap = "{[[", spacer = "=", inside = true, mirror = true}))

Centered, mirror caps, spacer outside

cecho(ftext.fText("some text", {alignment = "center", width = 30, cap ="{[[", spacer = "=", inside = false, mirror = true})

Centered, no mirroring, spacer inside

cecho(ftext.fText("some text", {alignment = "center", width = 30, cap = "[Bal]", spacer = "=", inside = true, mirror = false}))

Centered, no mirroring, spacer outside

cecho(ftext.fText("some text", {alignment = "center", width = 30, cap = "[Bal]", spacer = "=", inside = false, mirror = false}))

Left Aligned, spacer inside, <green> capColor, <purple> spacerColor, <red> textColor

cecho(ftext.fText("some text", {alignment = "left", width = 30, cap = "|", spacer = ".", inside = true, capColor = "<green>", spacerColor = "<purple>", textColor = "<red>", formatType = 'c'}))
--or alternately
cecho(ftext.cfText("some text", {alignment = "left", width = 30, cap = "|", spacer = ".", inside = true, capColor = "<green>", spacerColor = "<purple>", textColor = "<red>"}))

Right Aligned, spacer inside, <green> capColor, <purple> spacerColor, <red> textColor

cecho(ftext.fText("some text", {alignment = "right", width = 30, cap = "|", spacer = ".", inside = true, capColor = "<green>", spacerColor = "<purple>", textColor = "<red>", formatType = 'c'}))
--or alternately
cecho(ftext.fText("some text", {alignment = "right", width = 30, cap = "|", spacer = ".", inside = true, capColor = "<green>", spacerColor = "<purple>", textColor = "<red>"}))

For more information, please see fText