Phantasmal Site > Phantasmal API > API Listing > set_welcome_message

API Function: set_welcome_message

Summary:

set the text of the login banner

Defined In LPC Object:

/usr/common/sys/configd.c

Prototype:

void set_welcome_message(string new_message)

Can Be Called By:

System, Common, Game

Description:

Set the system welcome message. This is the banner that is sent to a new connection immediately, as soon as the connection is established. It should end with a message like "login:" or "Name?" or "By what name shall ye be known?". Note that a carriage return at the end of this file will be treated as a carriage return at the end of the welcome message, so be sure whether or not you want one.

Return Value:

None.

Errors:

Normally none.

See Also:

get_welcome_message , set_shutdown_message , set_suspended_message