SmartFoxServer Documentation

_server.sendModeratorMessage()

Availability:

SmartFoxServer PRO 1.4.5

Usage:

_server.sendModeratorMessage(message, sender, type, id)

Description:

This method sends a moderator message to an entire Zone, a Room or a single User.
The client (sender) requesting this functionality must have moderator privileges in order to successfuly send the message.
Clients will handle the message through the onModeratorMessage event handler.

Properties:

message		the text message
sender		the sender User object
type		any of the follwing constant: _server.MOD_MESSAGE_TO_ZONE _server.MOD_MESSAGE_TO_ROOM _server.MOD_MESSAGE_TO_USER

Returns:

Nothing

Example:

/*
* Handles a client extension request and sends a mod message
* NOTE: the client must have moderator privileges
*/
function handleRequest(cmd, params, user, fromRoom)
{
	if (cmd = "modMsg")
	{
		_server.sendModeratorMessage("This is a MOD Message!", user, _server.MOD_MESSAGE_TO_ZONE)
	}		
}