Scripting/Squirrel/Functions/PrivMessage: Difference between revisions
Jump to navigation
Jump to search
This wiki is using an old backup from 2020
Some information may be old/missing
(→Syntax) |
No edit summary |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
== Syntax == | == Syntax == | ||
<pre>PrivMessage(player, message)</pre> | |||
<pre>PrivMessage( player, message )</pre> | |||
== Arguments == | == Arguments == | ||
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''player''' - The player to send the message to | * ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''player''' - The player to send the message to | ||
* ''string'' '''message''' - The message to send | * ''string'' '''message''' - The message to send | ||
| Line 13: | Line 11: | ||
The following example send a personal message saying '''Hey you, have fun here!''': | The following example send a personal message saying '''Hey you, have fun here!''': | ||
<source lang=squirrel> | <source lang=squirrel> | ||
function onPlayerCommand( player, cmd, text ) | function onPlayerCommand(player, cmd, text) | ||
{ | { | ||
if(cmd == "privatemsg") | |||
{ | |||
PrivMessage(player, "Hey you, have fun here!"); | |||
} | |||
return 1; | |||
} | } | ||
</source> | </source> | ||
=== Notes === | === Notes === | ||
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages. | Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages. | ||
== Related Functions == | == Related Functions == | ||
{{Scripting/Squirrel/Functions/Messages}} | {{Scripting/Squirrel/Functions/Messages}} | ||
[[Category:Scripting/Squirrel/Functions/Message_Functions]] | |||
Latest revision as of 18:19, 30 January 2017
This function will send a private message to the player specified.
Syntax
PrivMessage(player, message)
Arguments
- Player player - The player to send the message to
- string message - The message to send
Example
The following example send a personal message saying Hey you, have fun here!:
function onPlayerCommand(player, cmd, text)
{
if(cmd == "privatemsg")
{
PrivMessage(player, "Hey you, have fun here!");
}
return 1;
}Notes
Call onPlayerCommand were used in this example. More info about them in the corresponding pages.