Phantasmal MUD Lib for DGD

Phantasmal Site > Phantasmal API > API Listing > get_shutdown_message

API Function: get_shutdown_message

Summary:
get the text of the shutdown message

Defined In LPC Object:
/usr/common/sys/configd.c

Prototype:
string get_shutdown_message(void)

Can Be Called By:
System, Common, Game

Description:

Get the system shutdown message. This message will be sent to incoming connections when the MUD is in the process of shutting down.

Return Value:

A string with the shutdown message.

Errors:
Normally none.

See Also:
get_welcome_message , set_shutdown_message , get_suspended_message