mux package

mux is the built-in server API available to every Lua module. It is supplied by the game server rather than loaded with require. Lua callbacks and commands run with the server’s #1 authority model; scripts should still use the callback context to identify the object and enactor that triggered them.

Functions

Objects and state

Function	Description
`mux.object`	Creates a validated handle for a database object.

Styled text

Function	Description
`mux.is_printable_ascii`	Tests whether a string contains only printable ASCII bytes.
`mux.markup`	Validates styled-text markup.
`mux.style`	Applies styles described by an options table.
`mux.strip_style`	Removes markup and ANSI styling.
`mux.text_width`	Returns the visible byte width of styled text.
`mux.truncate_text`	Truncates styled text to a visible width.

Connections and flows

Function	Description
`mux.notify`	Sends a message to an object.
`mux.connected_players`	Lists player connections visible to the normal `who` command.
`mux.who_summary`	Returns the non-privileged WHO summary.
`mux.telnet_environment_has`	Tests whether a NEW-ENVIRON variable is defined.
`mux.telnet_environment_get`	Gets a NEW-ENVIRON variable.
`mux.flow_start`	Starts an interactive flow on a descriptor.

Types

Type	Description
`Object`	A validated handle for a native database object.
`Attribute`	Access to an object’s supported native attributes.
`State`	Typed, persistent state in one object namespace.

Availability and limits

Runtime database operations are unavailable during @lua/check. The Lua sandbox does not expose filesystem, operating-system, debugger, FFI, coroutine, or dynamic code-loading APIs. VM memory and persistent-state limits still apply while using these functions.