Phantasmal Site > Phantasmal API > API Listing > send_system_phrase

API Function: send_system_phrase

Summary:

send a standard system Phantasmal phrase object to the user

Defined In LPC Object:

/usr/System/obj/user.c

Prototype:

int send_system_phrase(string str)

Can Be Called By:

System, Common, Game

Description:

Send the user the phrase in question, filtered by the state stack and localized to the user. The phrase is specified by a string. If you're not familiar with the System phrases, you should skip this function in favor of another.

Return Value:

The number of bytes sent.

Errors:

Return -1 if unable to send

See Also:

message , send_phrase