mux.text on StompyMUX Documentation

is_printable_ascii

Mon, 01 Jan 0001 00:00:00 +0000

Tests whether every byte in a string is printable ASCII.

Function

Synopsis

mux.text.is_printable_ascii( value )

Arguments

string value: The byte string to inspect.

Returns

boolean printable: Whether every byte is between space (0x20) and ~ (0x7e), inclusive.

Examples

assert(mux.text.is_printable_ascii("Atlas-1"))
assert(not mux.text.is_printable_ascii("café"))

Notes

The empty string is valid. Control bytes, embedded NUL bytes, DEL, and non-ASCII UTF-8 characters return false.

markup

Mon, 01 Jan 0001 00:00:00 +0000

Validates styled-text markup and returns it unchanged.

Function

Synopsis

mux.text.markup( value )

Arguments

string value: Styled-text markup to validate.

Returns

string markup: The validated input string.

Examples

local warning = mux.text.markup("[fg=#ff7000][bold]Warning[/][/]")
local look = mux.text.markup('[send="look"]Look[/]')

Notes

Invalid tags, colors, link targets, or nesting raise a Lua error. [send] and [prompt] targets are percent-encoded during rendering; [link] accepts http:, https:, and ftp: URIs.

strip_style

Mon, 01 Jan 0001 00:00:00 +0000

Removes styled-text markup and ANSI styling from a string.

Function

Synopsis

mux.text.strip_style( value )

Arguments

string value: Styled or unstyled text.

Returns

string plain: The visible unstyled text.

Examples

local command = mux.text.strip_style(styled_name)

Notes

This is useful before using player-facing text as a command or identifier.

style

Mon, 01 Jan 0001 00:00:00 +0000

Applies styled-text markup described by an options table.

Function

Synopsis

mux.text.style( value, options )

Arguments

string value: The text to style; it must not contain an embedded NUL byte.
table options: Style fields to apply.

Returns

string styled: The input wrapped in validated styled-text markup.

Examples

local heading = mux.text.style("Warning", {
 foreground = "#ff7000",
 bold = true,
})

Notes

options.foreground and options.background accept a built-in or configured color name or #RRGGBB. bold, underline, and inverse are booleans. Missing fields have no effect; invalid types and colors raise an error.

truncate

Mon, 01 Jan 0001 00:00:00 +0000

Truncates styled text to a maximum visible width.

Function

Synopsis

mux.text.truncate( value, width )

Arguments

string value: Styled or unstyled text.
number width: A non-negative maximum visible byte width.

Returns

string truncated: The safely truncated text, including any resets needed for active styles.

Examples

local label = mux.text.truncate(mux.text.style("Atlas", { bold = true }), 3)

Notes

A negative width raises a Lua error. Markup and ANSI sequences do not count toward the limit.

width

Mon, 01 Jan 0001 00:00:00 +0000

Measures the visible byte width of styled text.

Function

Synopsis

mux.text.width( value )

Arguments

string value: Styled or unstyled text.

Returns

number width: The number of visible bytes, excluding markup and ANSI styling.

Notes

The result is a byte width, not a Unicode display-cell calculation.

mux.text on StompyMUX Documentation

is_printable_ascii

Function

Synopsis

Arguments

Returns

Examples

Notes

See Also

markup

Function

Synopsis

Arguments

Returns

Examples

Notes

See Also

strip_style

Function

Synopsis

Arguments

Returns

Examples

Notes

See Also

style

Function

Synopsis

Arguments

Returns

Examples

Notes

truncate

Function

Synopsis

Arguments

Returns

Examples

Notes

See Also

width

Function

Synopsis

Arguments

Returns

Notes

See Also