Channel on StompyMUX Documentation

add_player

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

Adds a player to this channel and registers a player-local command alias.

Function

Synopsis

channel:add_player( player, alias, quiet )

Arguments

number or Object player: The player to add.
string alias: A player-local alias containing 1–5 printable ASCII characters without spaces.
boolean quiet: When true, suppresses the channel-wide join announcement.

Returns

Nothing.

Raises

mux.unavailable.checking during @lua/check.
mux.channel.invalid if the channel is stale.
mux.object.invalid if the object reference is invalid or is not a player.
mux.object.unavailable if the player is being destroyed.
mux.arg.invalid if the alias is invalid or already in use, or if quiet is not a boolean.
mux.internal if the alias collection cannot be expanded.

Notes

This trusted administrative operation bypasses the channel join lock. The alias is added to the player’s normal channel aliases and can be used for channel commands. A quiet join still sends the player the normal direct join and alias confirmations.

boot_player

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

Boots an object from this channel using native alias-removal side effects.

Function

Synopsis

channel:boot_player( object )

Arguments

number or Object object: A current member of the channel.

Returns

Nothing.

Raises

mux.unavailable.checking during @lua/check.
mux.channel.invalid if the channel is stale or the object is not a member.
mux.object.invalid if the object reference is invalid.

Notes

The operation announces a God-administered boot, removes the member’s channel aliases, and preserves the native departure side effects.

emit

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

Emits an administrative channel message through native delivery, history, receive-lock, and message-count behavior.

Function

Synopsis

channel:emit( message [, options] )

Arguments

string message

Valid UTF-8 text without embedded NUL bytes.

table or nil options

Optional settings. The exact options table accepts one field:

Field	Type	Description
`no_header`	boolean	Omits the usual `[channel]` prefix.

Unknown option fields are rejected.

Returns

Nothing.

Raises

mux.unavailable.checking during @lua/check.
mux.channel.invalid if the channel handle is stale.
mux.arg.invalid for invalid UTF-8, embedded NUL bytes, or invalid options.

Example

channel:emit("The scheduled maintenance begins now.", { no_header = true })

flags

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

Creates a typed flag collection for this channel.

Function

Synopsis

local flags = channel:flags()

Returns

ChannelFlags flags: A live administrative flag collection for the channel.

The channel must be live. The returned collection becomes stale when the channel is destroyed.

Raises

mux.unavailable.checking during @lua/check.
mux.channel.invalid if the channel handle is stale.

max_user_count

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

Returns this channel’s currently allocated membership capacity.

Function

Synopsis

channel:max_user_count( )

Arguments

None.

Returns

integer count: The allocated membership capacity.

Raises

mux.unavailable.checking during @lua/check.
mux.channel.invalid if the channel handle is stale.

message_count

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

Returns this channel’s lifetime delivered-message count.

Function

Synopsis

channel:message_count( )

Arguments

None.

Returns

integer count: The number of messages delivered through the channel during its lifetime.

Raises

mux.unavailable.checking during @lua/check.
mux.channel.invalid if the channel handle is stale.

name

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

Returns this channel’s exact name.

Function

Synopsis

channel:name( )

Arguments

None.

Returns

string name: The channel’s canonical name.

Raises

mux.unavailable.checking during @lua/check.
mux.channel.invalid if the channel handle is stale.

object

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

Returns the object that supplies this channel’s description and locks.

Function

Synopsis

channel:object( )

Arguments

None.

Returns

Object or nil object: The attached object, or nil when the channel has no attached object.

Raises

mux.unavailable.checking during @lua/check.
mux.channel.invalid if the channel handle is stale.
mux.object.invalid if the attached object no longer exists.

set_object

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

Attaches or detaches the object supplying this channel’s locks and description.

Function

Synopsis

channel:set_object( object )

Arguments

number, Object, or nil object: A live object to attach. This argument is required; pass nil explicitly to detach the current object.

Returns

Nothing.

Raises

mux.unavailable.checking during @lua/check.
mux.arg.invalid if object is omitted.
mux.channel.invalid if the channel handle is stale.
mux.object.invalid if the object reference is invalid.
mux.object.unavailable if the object is being destroyed.

user_count

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

Returns the number of membership records on this channel.

Function

Synopsis

channel:user_count( )

Arguments

None.

Returns

integer count: The number of channel membership records.

Raises

mux.unavailable.checking during @lua/check.
mux.channel.invalid if the channel handle is stale.

who

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

Returns structured channel membership records.

Function

Synopsis

channel:who( options? )

Arguments

table or nil options

Optional settings. The exact options table accepts one field:

Field	Type	Description
`all`	boolean	Includes inactive membership records.

Unknown option fields are rejected.

Returns

table members: A dense array of records shaped as { object = Object, listening = boolean }.

Raises

mux.unavailable.checking during @lua/check.
mux.channel.invalid if the channel handle is stale.
mux.arg.invalid for invalid options.

Notes

Without all, the native active-member test is applied. Trusted Lua does not apply actor-relative hidden-member filtering. { all = true } corresponds to @chan/who <name>/all.

Channel on StompyMUX Documentation

add_player

Function

Synopsis

Arguments

Returns

Raises

Notes

boot_player

Function

Synopsis

Arguments

Returns

Raises

Notes

emit

Function

Synopsis

Arguments

Returns

Raises

Example

See Also

flags

Function

Synopsis

Returns

Raises

See Also

max_user_count

Function

Synopsis

Arguments

Returns

Raises

See Also

message_count

Function

Synopsis

Arguments

Returns

Raises

See Also

name

Function

Synopsis

Arguments

Returns

Raises

See Also

object

Function

Synopsis

Arguments

Returns

Raises

See Also

set_object

Function

Synopsis

Arguments

Returns

Raises

See Also

user_count

Function

Synopsis

Arguments

Returns

Raises

See Also

who

Function

Synopsis

Arguments

Returns

Raises

Notes