mux.session on StompyMUX Documentation

connected_players

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

Lists player connections visible to the normal who command.

Function

Synopsis

mux.session.connected_players( )

Arguments

None.

Returns

table players: An array of connection records.

Examples

for _, player in ipairs(mux.session.connected_players()) do
 mux.world.pemit(ctx.enactor, player.name)
end

Notes

Each record contains object (Object), name (string), connected_for (elapsed seconds), and idle_for (elapsed seconds). Hidden players and privileged connection details are omitted.

flow_start

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

Attaches an interactive flow to a descriptor and shows its first prompt.

Function

Synopsis

mux.session.flow_start( descriptor, module, first_step )

Arguments

number descriptor: A live descriptor ID, normally ctx.descriptor.
string module: The flow module path, resolved like require.
string first_step: A key in the module’s flows table.

Returns

Nothing.

Examples

mux.session.flow_start(ctx.descriptor, "confirm_delete.lua", "confirm")

Errors and availability

Raises mux.connection.invalid if the descriptor does not exist, mux.connection.unavailable if it already has a flow or flow support is not available, and mux.module.invalid if the module cannot be loaded or lacks the requested step. This function raises mux.unavailable.checking during @lua/check.

who_summary

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

Returns the non-privileged WHO summary.

Function

Synopsis

mux.session.who_summary( )

Arguments

None.

Returns

table summary: A table with hidden, record, and maximum fields.

Examples

local summary = mux.session.who_summary()
local maximum = summary.maximum or "no"

Notes

hidden and record are numbers. maximum is a number or nil when the game has no player limit.

mux.session on StompyMUX Documentation

connected_players

Function

Synopsis

Arguments

Returns

Examples

Notes

See Also

flow_start

Function

Synopsis

Arguments

Returns

Examples

Errors and availability

who_summary

Function

Synopsis

Arguments

Returns

Examples

Notes

See Also