Phantasmal Site > Phantasmal API > API Listing > get_suspended_message

API Function: get_suspended_message

Summary:

get the text of the suspended message

Defined In LPC Object:

/usr/common/sys/configd.c

Prototype:

string get_suspended_message(void)

Can Be Called By:

System, Common, Game

Description:

Get 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:

A string with the suspended message.

Errors:

Normally none.

See Also:

get_welcome_message , get_shutdown_message , set_suspended_message