Scripting/Squirrel/Functions/PrivMessageAll: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
(Created page with "This function will send a private message to everyone in the server. == Syntax == <pre>PrivMessageAll( message )</pre> == Arguments == * ''string'' '''message''' - The mes...")
 
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 2: Line 2:


== Syntax ==
== Syntax ==
 
<pre>PrivMessageAll(message)</pre>
<pre>PrivMessageAll( message )</pre>


== Arguments ==
== Arguments ==
* ''string'' '''message''' - The message to send
* ''string'' '''message''' - The message to send


== Example ==
== Example ==
 
The following example send a personal message to all saying '''Hey you, have fun here!''':
{{Scripting/Needs_Example}}
<source lang=squirrel>
function onPlayerCommand(player, cmd, text)
{
if (cmd == "privmsgtoall")
{
  PrivMessageAll("Hey all, have fun here!");
}
}
</source>


=== Notes ===
=== Notes ===
 
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 everyone in the server.

Syntax

PrivMessageAll(message)

Arguments

  • string message - The message to send

Example

The following example send a personal message to all saying Hey you, have fun here!:

function onPlayerCommand(player, cmd, text)
{
	if (cmd == "privmsgtoall")
 	{
  		PrivMessageAll("Hey all, have fun here!");
 	}
}

Notes

Call onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Functions