This wiki is archived and useful information is being migrated to the main bzflag.org website
bz sendTextMessage
From BZFlagWiki
BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server. |
BZFS API Function. This page documents a BZFS_API Function, that is provided by the BZFS game server for plug-ins to call. |
Contents
Prototype
BZF_API bool bz_sendTextMessage (int from, int to, const char* message); BZF_API bool bz_sendTextMessage (int from, bz_eTeamType to, const char* message);
Parameters
- int from: From which player do we need to pretend this message is coming from?
- int to: To which player or team are we sending this message?
- const char* message: The message to be sent
Description
This API function will cause the server to send a message to a player or team
Usage
If you want to send a message, use this function. This can be used for private messages based on previous input.
Notes
Want to send a message coming from the server, and not pretend to be someone else? Use BZ_SERVER for the from argument.