Phantasmal Site > Phantasmal API > API Listing > set_suspended_message

API Function: set_suspended_message

Summary:

set the text of the suspended message

Defined In LPC Object:

/usr/common/sys/configd.c

Prototype:

void set_suspended_message(string new_message)

Can Be Called By:

System, Common, Game

Description:

Set the system suspended message. This message is used by the MUD during on-the-fly recompiles and other times when (briefly) new connections aren't allowed. Being suspended, unlike shutdown, normally lasts only a few seconds.

Return Value:

None.

Errors:

Normally none.

See Also:

set_welcome_message , set_shutdown_message , get_suspended_message