output.h File Reference

Text related output functions for scripts. More...

#include "PhasorAPI.h"

Go to the source code of this file.

Functions
void	l_hprintf (PHASOR_API_ARGS)
	Outputs a string to the server console.
void	l_say (PHASOR_API_ARGS)
	Sends a chat message to the entire server.
void	l_privatesay (PHASOR_API_ARGS)
	Sends a chat message to the specified player.
void	l_sendconsoletext (PHASOR_API_ARGS)
	Sends the specified player a console message.
void	l_respond (PHASOR_API_ARGS)
	Responds to the person executing the current command.
void	l_log_msg (PHASOR_API_ARGS)
	Sends output to the specified logging stream.

Detailed Description

Text related output functions for scripts.

Provides the textual output related Phasor scripting functions.

Notes: All messages can contain numerous line ends (\n) which force the message to be sent as distinct messages.

For example, the below are equivalent

say("Hello\nHow are you?") -- outputs the same as the below two
say("Hello")
say("How are you?")

All messages support placeholders for player names. To insert a player's name into a message include '{<memory id>}' somewhere.

For example, the following code will output "Welcome to player New001" if player_id is the id for a player named New001.

say("Welcome to player {" . player_id . "}!)

The purpose of this is to fix broken player names from previous versions.