Murmur
Overview
module Murmur
Information and control of the murmur server. Each server has
one Meta interface that controls global information, and
each virtual server has a Server interface.
Class Index
- Tree
-
Player and subchannel state.
Interface Index
- Meta
-
This is the meta interface.
- MetaCallback
-
Callback interface for Meta.
- Server
-
Per-server interface.
- ServerAuthenticator
-
Callback interface for server authentication.
- ServerCallback
-
Callback interface for servers.
- ServerContextCallback
-
Callback interface for context actions.
- ServerUpdatingAuthenticator
-
Callback interface for server authentication and registration.
Exception Index
- InvalidCallbackException
-
This is thrown when you supply an invalid callback.
- InvalidChannelException
-
This is thrown when you specify an invalid channel id.
- InvalidPlayerException
-
This is thrown when you specify an invalid playerid.
- InvalidServerException
-
This is thrown when you try to do an operation on a server that does not exist.
- InvalidSessionException
-
This is thrown when you specify an invalid session.
- InvalidTextureException
-
This is thrown when you try to set an invalid texture.
- MurmurException
-
- ServerBootedException
-
This happens if you try to fetch player or channel state on a stopped server, if you try to stop an already stopped server or start an already started server.
- ServerFailureException
-
This is thrown if Server::start fails, and should generally be the cause for some concern.
Structure Index
- ACL
-
Access Control List for a channel.
- Ban
-
A single ip mask for a ban.
- Channel
-
A channel.
- Group
-
A group.
- LogEntry
-
A entry in the log.
- Player
-
A connected player.
- RegisteredPlayer
-
A registered player.
Sequence Index
- ACLList
-
- BanList
-
- ChannelList
-
- GroupList
-
- GroupNameList
-
- IdList
-
- IntList
-
- LogList
-
- NameList
-
- PlayerList
-
- RegisteredPlayerList
-
- ServerList
-
- Texture
-
- TreeList
-
Dictionary Index
- ChannelMap
-
- ConfigMap
-
- IdMap
-
- NameMap
-
- PlayerMap
-
Constant Index
- ContextChannel
-
Context for actions in the Channel menu.
- ContextPlayer
-
Context for actions in the Player menu.
- ContextServer
-
Context for actions in the Server menu.
- PermissionAltSpeak
-
Alt-speak in channel.
- PermissionEnter
-
Enter channel.
- PermissionLinkChannel
-
Link this channel.
- PermissionMakeChannel
-
Make new channel as a subchannel of this channel.
- PermissionMoveKick
-
Move and Kick players from channel.
- PermissionMuteDeafen
-
Mute and deafen other players in this channel.
- PermissionSpeak
-
Speak in channel.
- PermissionTraverse
-
Traverse channel.
- PermissionWrite
-
Write access to channel control.
Sequences
-
sequence<ACL> ACLList
-
Used By
- Server::getACL
- Server::setACL
-
sequence<Ban> BanList
-
Used By
- Server::getBans
- Server::setBans
-
sequence<Channel> ChannelList
-
sequence<Group> GroupList
-
Used By
- Server::getACL
- Server::setACL
-
sequence<string> GroupNameList
-
Used By
- ServerAuthenticator::authenticate
-
sequence<int> IdList
-
Used By
- Server::getPlayerNames
-
sequence<int> IntList
-
Used By
- Channel::links
- Group::add
- Group::members
- Group::remove
-
sequence<LogEntry> LogList
-
Used By
- Server::getLog
-
sequence<string> NameList
-
Used By
- Server::getPlayerIds
-
sequence<Player> PlayerList
-
Used By
- Tree::players
-
sequence<RegisteredPlayer> RegisteredPlayerList
-
Used By
- Server::getRegisteredPlayers
- ServerUpdatingAuthenticator::getRegisteredPlayers
-
sequence<Server*> ServerList
-
Used By
- Meta::getAllServers
- Meta::getBootedServers
-
sequence<byte> Texture
-
Used By
- Server::getTexture
- Server::setTexture
- ServerAuthenticator::idToTexture
- ServerUpdatingAuthenticator::setTexture
-
sequence<Tree> TreeList
-
Used By
- Tree::children
Dictionaries
-
dictionary<int, Channel> ChannelMap
-
Used By
- Server::getChannels
-
dictionary<string, string> ConfigMap
-
Used By
- Meta::getDefaultConf
- Server::getAllConf
-
dictionary<string, int> IdMap
-
Used By
- Server::getPlayerIds
-
dictionary<int, string> NameMap
-
Used By
- Server::getPlayerNames
-
dictionary<int, Player> PlayerMap
-
Used By
- Server::getPlayers
Constants
-
const int ContextChannel = 0x02;
-
Context for actions in the Channel menu.
-
const int ContextPlayer = 0x04;
-
Context for actions in the Player menu.
-
const int ContextServer = 0x01;
-
Context for actions in the Server menu.
-
const int PermissionAltSpeak = 0x100;
-
Alt-speak in channel. This is different from Speak, so you can set up different permissions.
-
const int PermissionEnter = 0x04;
-
Enter channel.
-
const int PermissionLinkChannel = 0x80;
-
Link this channel. You need this permission in both the source and destination channel to link channels, or in either channel to unlink them.
-
const int PermissionMakeChannel = 0x40;
-
Make new channel as a subchannel of this channel.
-
const int PermissionMoveKick = 0x20;
-
Move and Kick players from channel. You need this permission in both the source and destination channel to move another player.
If you have this privilege on the root channel, you can ban players.
-
const int PermissionMuteDeafen = 0x10;
-
Mute and deafen other players in this channel.
-
const int PermissionSpeak = 0x08;
-
Speak in channel.
-
const int PermissionTraverse = 0x02;
-
Traverse channel. Without this, a client cannot reach subchannels, no matter which privileges he has there.
-
const int PermissionWrite = 0x01;
-
Write access to channel control. Implies all other permissions (except Speak).