Vice City Multiplayer - User contributions [en]

Scripting/Squirrel/Functions

2016-04-29T16:22:35Z

Pun1sh3r:

== Administrative Functions ==
{{Scripting/Squirrel/Functions/Administrative Functions}}

== Checkpoint Functions ==
{{Scripting/Squirrel/Functions/Checkpoint Functions}}

== Data Structures ==
{{Scripting/Squirrel/Functions/Data Structures}}

== Game Functions ==
{{Scripting/Squirrel/Functions/Game Functions}}

== Hashing Functions (In the "Hashing" plugin) ==
{{Scripting/Squirrel/Functions/Hashing Functions}}

== INI Functions (In the "INIParser" plugin) ==
{{Scripting/Squirrel/Functions/INI Functions}}

== Messages ==
{{Scripting/Squirrel/Functions/Messages}}

== MySQL Functions (In the "MySQL" plugin) ==
{{Scripting/Squirrel/Functions/MySQL Functions}}

== Object Functions ==
{{Scripting/Squirrel/Functions/Object Functions}}

== Pickup Functions ==
{{Scripting/Squirrel/Functions/Pickup Functions}}

== Player Functions ==
{{Scripting/Squirrel/Functions/Player Functions}}

== SQLite Functions (In the "SQLite" plugin) ==
{{Scripting/Squirrel/Functions/SQLite Functions}}

== Server Settings ==
{{Scripting/Squirrel/Functions/Server Settings}}

== Socket Functions (In the "Socket" plugin) ==
{{Scripting/Squirrel/Functions/Socket Functions}}

== Spawn and Wasted Screen Functions ==
{{Scripting/Squirrel/Functions/Spawn and Wasted Screen Functions}}

== Timer Functions ==
{{Scripting/Squirrel/Functions/Timer Functions}}

== Vehicle Functions ==
{{Scripting/Squirrel/Functions/Vehicle Functions}}

== Weapon Functions ==
{{Scripting/Squirrel/Functions/Weapon Functions}}

== Deprecated Functions ==
''These functions are for compatibility, but may be removed in future versions.''
{{Scripting/Squirrel/Functions/Deprecated}}

Scripting/Squirrel/Functions/Player.State

2016-04-29T15:32:31Z

Pun1sh3r:

== Syntax ==

<pre>player.State (The player's current state as an integer)</pre>

== Example ==

<pre>
function onPlayerCommand( player, cmd, text )
{
if(cmd == "state")
{
ClientMessage("Your current State: "+player.State+" (state as integer)",player,255,255,255);
}
}
</pre>

=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Player State list ==
<div>
{| class="wikitable"
!State ID
!Description
|-
|0
|Player State None
|-
|1
|Player State OnFoot
|-
|2
|Player State Aim
|-
|3
|Player State Driver
|-
|4
|Player State Passenger
|-
|5
|Player State Enter Vehicle
|-
|6
|Player State Enter Passenger
|-
|7
|Player State Exit Vehicle
|-
|8
|Player State Not Spawned
|}
</div>

Scripting/Squirrel/Functions

2016-04-26T17:08:16Z

Pun1sh3r:

Server-side Scripting Resources

2016-04-26T16:49:19Z

Pun1sh3r:

{{Main Page giant banner}}

{| style="width:100%; background:none; border:none; margin:0.5em 0; padding:none;" cellspacing="0" cellpadding="0"
|-
| style="width:auto; background:#FEFBF6; border:1px solid #79542B;" valign="top" |
<div id="mf-index">
{| style="padding:0; width:100%;" |
! class="mp-content-header mp-title-gradient" | Scripting Resources
|-
| style="padding:10px;" |
</div>
|-
|}

{| style="width:100%; background:none; border:none; margin:0.5em 0; padding:none;" cellspacing="0" cellpadding="0"
<div id="mf-index">
|-
| style="padding:10px;" |
==Introduction==

Squirrel is a high level imperative/OO programming language, designed to be a powerful scripting tool that fits in the size, memory bandwidth, and real-time requirements of applications like games.

Squirrel is inspired by languages like Python, Javascript and expecially Lua.

Squirrel's syntax is similar to C/C++/Java etc... but the language has a very dynamic nature like Python/Lua.

== Scripts ==

The following is a list of example Squirrel scripts

* [https://bitbucket.org/stormeus/vl8-pb400 0.4 Public Beta (#2 and #3) Script]
* [http://forum.vc-mp.org/?topic=332.0 ADM Script]
* [http://forum.vc-mp.org/?topic=418.0 Doomplay match]
* [http://forum.vc-mp.org/?topic=1303.0 VC:MP Ingame Map Editor]

== Reference ==

* [[Scripting/Squirrel/Functions|Server Functions]]
* [[Scripting/Squirrel/Events|Server Events]]
* [[Scripting/Squirrel/Constants|Constants]]

== Tutorials / Documentation ==

This is a list of available tutorials and documents on Squirrel scripting in general.
These list all available squirrel commands aside from things added by the VC:MP Squirrel module, and are not listed on this wiki.

'''''VC:MP Squirrel Scripting'''''
* [http://forum.vc-mp.org/?topic=717.0 -WIP- Scripting Video Tutorials (by S.L.C)]

'''''General Squirrel Scripting'''''
* [http://squirrel-lang.org/doc/squirrel3.html Squirrel Reference Manual]
* [http://squirrel-lang.org/doc/sqstdlib3.html Squirrel Standard Libraries Manual]

== Official plugins ==
* [https://bitbucket.org/stormeus/0.4-announce/downloads Announce]
* [https://bitbucket.org/stormeus/0.4-confloader/downloads ConfLoader]
* [https://bitbucket.org/stormeus/0.4-hashing-algorithms/downloads Hashing Algorithms]
* [https://bitbucket.org/stormeus/0.4-iniparser/downloads INIParser]
* [https://bitbucket.org/stormeus/0.4-mysql/downloads MySQL]
* [https://bitbucket.org/stormeus/0.4-sockets/downloads Sockets]
* [https://bitbucket.org/stormeus/0.4-sqlite/downloads SQLite]
* [https://bitbucket.org/stormeus/0.4-squirrel/downloads Squirrel]

Plugin packages are also available for compact downloading and updating.
* [http://v04.maxorator.com/files/plugins/mp04rc2_plugins32_windows.zip Windows (x86) Package]
* [http://v04.maxorator.com/files/plugins/mp04rc2_plugins64_windows.zip Windows (x64) Package]
* [http://v04.maxorator.com/files/plugins/mp04rc2_plugins32_linux.zip Linux (x86) Package]
* [http://v04.maxorator.com/files/plugins/mp04rc2_plugins64_linux.zip Linux (x64) Package]
</div>
|}

Scripting/Squirrel/Functions/CreateCheckpoint

2016-04-26T16:25:53Z

Pun1sh3r:

CreateCheckpoint is a function that creates a checkpoint. Checkpoints are used in racing.

== Syntax ==

<pre>CreateCheckpoint(player, world, isSphere, pos, rgb, radius)</pre>

== Arguments ==

*[[Scripting/Squirrel/Functions#Player_Functions|''Player'']] | ''null'' '''player''' - The player to stream this checkpoint to. If the variable is null, it will be shown to everyone
*''int'' '''world''' - The world id
*''bool'' '''isSphere''' - 'true' for is Sphere and 'false' for not '''(Added in 04rel004 will not work in earlier versions!)'''
*[[Scripting/Squirrel/Functions/Vector|''Vector'']] '''pos''' - The checkpoint position
*[[Scripting/Squirrel/Functions/cRGB|''cRGB'']] '''rgb''' - The checkpoint color
*''int'' '''radius''' - The diameter of the checkoint

== Example ==

The following example will create a checkpoint:

<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "createcheckpoint" )
{
CreateCheckpoint( null, 0, false, player.Pos, RGB(255, 0, 255), 2);
}
}
</source>

=== Notes ===

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Checkpoint_Functions}}

Scripting/Squirrel/Functions/SendPlayerMessage

2016-04-25T16:54:00Z

Pun1sh3r: /* Notes */

This function will send a fake private message from one player to another.

== Syntax ==
<pre>SendPlayerMessage(playerToFake, playerTo, message)</pre>

== Arguments ==
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerToFake''' - The player to send the message as
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerTo''' - The player to send the message to
* ''string'' '''message''' - The message to send

== Example ==
The following example send a fake message from killer to player.
<source lang=squirrel>
function onPlayerKill(killer, player, reason, bodypart)
{
SendPlayerMessage(killer, player, "hahaha, begginer I killed you.");
return 1;
}
</source>

=== Notes ===
Call [[onPlayerKill]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/PrivMessageAll

2016-04-25T16:53:38Z

Pun1sh3r: /* Notes */

This function will send a private message to everyone in the server.

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

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

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

=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/PrivMessage

2016-04-25T16:53:21Z

Pun1sh3r: /* Notes */

This function will send a private message to the player specified.

== Syntax ==
<pre>PrivMessage(player, message)</pre>

== Arguments ==
* ''[[Scripting/Squirrel/Functions#Player Functions|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!''':
<source lang=squirrel>
function onPlayerCommand(player, cmd, text)
{
if(cmd == "privatemsg")
{
PrivMessage(player, "Hey you, have fun here!");
}
return 1;
}
</source>

=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/MessagePlayer

2016-04-25T16:53:04Z

Pun1sh3r: /* Notes */

This function will send a simple message to the player specified.

== Syntax ==
<pre>MessagePlayer(message, player)</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''player''' - The player to send the message to

== Example ==
The following example send a personal message saying '''Hey you, have fun here'''!:
<source lang=squirrel>
function onPlayerCommand(player, cmd, text)
{
if(cmd == "playermsg")
{
MessagePlayer("Hey you, have fun here!", player);
}
return 1;
}
</source>

=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/MessageAllExcept

2016-04-25T16:52:47Z

Pun1sh3r: /* Notes */

This function will send a simple message to everyone but the player specified.

== Syntax ==
<pre>MessageAllExcept(message, player)</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''player''' - The player not to send the message to

== Example ==
The following example message to all except yourself saying '''Hello all except myself, have fun here'''!:
<source lang=squirrel>
function onPlayerCommand(player, cmd, text)
{
if(cmd == "msg")
{
MessageAllExcept("Hello all except myself, have fun here!", player );
}
return 1;
}
</source>

=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/Message

2016-04-25T16:52:27Z

Pun1sh3r:

This function will send a simple message to everyone in the server.

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

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

== Example ==
<source lang=squirrel>
function onPlayerCommand(player, cmd, text)
{
if(cmd == "msg")
{
Message("Hello, have fun here!");
}
return 1;
}
</source>

=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/AnnounceAll

2016-04-25T16:52:02Z

Pun1sh3r:

This function will send a big message on the screen to every player.

== Syntax ==
<pre>AnnounceAll(message, type)</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''int'' '''[[Game_Text_Codes_and_Styles|type]]''' - The type of the message

== Example ==
<source lang=squirrel>
function onPlayerCommand(player, command, arguments)
{
if (cmd == "ann" || cmd == "announce")
{
if(!text)
{
PrivMessage(player, "Use /" + cmd + " <message>");
}
else
{
AnnounceAll ( text + "", 3);
MessagePlayer(">> You have announced: " + text,player )
}
}
return 1;
}
</source>

=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/Announce

2016-04-25T16:51:29Z

Pun1sh3r:

This function will send a big message on the screen to a player.

== Syntax ==
<pre>Announce(message, playerTo, type)</pre>

== Arguments ==
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerTo''' - The player to send the message to
* ''string'' '''message''' - The message to send
* ''int'' '''[[Game_Text_Codes_and_Styles|type]]''' - The type of the message

== Example ==
<source lang=squirrel>
function onPlayerJoin(player)
{
Announce("Welcome to our server", player, 0);
return 1;
}
</source>

=== Notes ===
Call [[onPlayerTeamKill]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/ClientMessageToAll

2016-04-25T16:51:10Z

Pun1sh3r:

This function will send a coloured message to every player in the server.

== Syntax ==
1
<pre>ClientMessageToAll(message, r, g, b)</pre>
2
<pre>ClientMessageToAll(message, r, g, b, a)</pre>

== Arguments ==
1
* ''string'' '''message''' - The message to send
* ''int'' '''r''' - The amount of red
* ''int'' '''g''' - The amount of green
* ''int'' '''b''' - The amount of blue
2
* ''string'' '''message''' - The message to send
* ''int'' '''r''' - The amount of red
* ''int'' '''g''' - The amount of green
* ''int'' '''b''' - The amount of blue
* ''int'' '''a''' - The amount of alpha

== Example ==
<source lang=squirrel>
function onPlayerTeamKill(killer, player, reason, bodypart)
{
ClientMessageToAll(killer+" killed team-mate "+ player, 85, 107, 47);
return 1;
}
</source>

=== Notes ===
Call [[onPlayerTeamKill]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/ClientMessage

2016-04-25T16:50:50Z

Pun1sh3r:

This function will send a coloured message to a player.

== Syntax ==
<pre>ClientMessage(message, player, R, G, B)</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerTo''' - The player to send the message to
* ''int'' '''R''' - The amount of red
* ''int'' '''G''' - The amount of green
* ''int'' '''B''' - The amount of blue

== Example ==
<source lang=squirrel>
function onPlayerJoin(player)
{
ClientMessage("Welcome to our server, [#B200FF]and have fun!",player,12,255,245);
return 1;
}
</source>

=== Notes ===
Call [[onPlayerJoin]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/CreateMarker

2016-04-25T16:49:35Z

Pun1sh3r:

This function will create a map icon on the radar.

== Syntax ==

<pre>CreateMarker( world, pos, scale, color, SpriteId )</pre>

== Arguments ==

* ''int'' '''world''' - The world ID
* ''[[Scripting/Squirrel/Functions/Vector|Vector]]'' '''pos''' - The position of the marker to be created
* ''int'' '''scale''' - The marker's size
* ''[[Scripting/Squirrel/Functions/cRGB|cRGB]]'' '''color''' - The marker's color
* ''int'' '''SpriteId''' - The [[Map_Icons|ID]] of custom map icon

== Example ==
<source lang=squirrel>
function onPlayerJoin( player )
{
CreateMarker(player.UniqueWorld, Vector( -1734, -715, 5.8680 ), 5, RGB(0, 0, 0), 26 );
return 1;
}
</source>

=== Notes ===
Call [[onPlayerJoin]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Game_Functions}}

Scripting/Squirrel/Functions/UnbindAll

2016-04-25T16:48:57Z

Pun1sh3r:

'''UnbindAll''' removes all binded server keys.

== Syntax ==

<pre>UnbindAll()</pre>

== Example ==

The following example will unbind all server keys

<source lang=squirrel>
function onScriptUnload()
{
UnbindAll();
return 1;
}

</source>

=== Notes ===
* Call [[onScriptUnload]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Game_Functions}}

Scripting/Squirrel/Functions/GetDistrictName

2016-04-25T16:47:22Z

Pun1sh3r:

This function will return the district name of a given position.

== Syntax ==

<pre>GetDistrictName( x, y )</pre>

== Arguments ==

* ''float'' '''x''' - The '''x''' coordinate
* ''float'' '''y''' - The '''y''' coordinate

== Return value ==

* ''string'' '''name''' - The name of the district

== Example ==
<source lang="squirrel">
function onPlayerCommand(player, cmd, text)
{
if(cmd == "district")
{
MessagePlayer("[#FFFFFF]Your district is [#FFFF00]"+GetDistrictName(player.Pos.x, player.Pos.y), player);
}
}
</source>

=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Game_Functions}}

Scripting/Squirrel/Functions/GetWorldBounds

2016-04-25T16:46:16Z

Pun1sh3r:

This function will get the world bounds of the server.

== Syntax ==

<pre>GetWorldBounds()</pre>

== Return value ==
*[[Scripting/Squirrel/Functions/Bounds|''Bounds'']] '''worldbounds''' - the bounds

== Example ==
<source lang="squirrel">
function onScriptLoad()
{
local boundaries = GetWorldBounds();
print( "Worldboundaries has been set to :" + boundaries.MaxX + "," + boundaries.MinX + "," + boundaries.MaxY + "," + boundaries.MinY );
return 1;
}
</source>

=== Notes ===
Call [[OnScriptLoad]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Game_Functions}}

Scripting/Squirrel/Functions/DestroyRadioStream

2016-04-25T16:45:53Z

Pun1sh3r:

This function will destroy a radio stream.

== Syntax ==

<pre>DestroyRadioStream(streamID)</pre>

== Arguments ==

* ''int'' '''streamID''' - The radio ID.

== Example ==

<source lang=squirrel>
function onScriptUnload()
{
DestroyRadioStream(1);//1 = the ID you used in CreateRadioStream
return 1;
}
</source>

=== Notes ===

Call [[onScriptUnload]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Game_Functions}}

Scripting/Squirrel/Functions/FindCheckpoint

2016-04-25T16:26:27Z

Pun1sh3r:

== Syntax ==

<pre>FindCheckpoint(ID)</pre>

== Arguments ==

*''int'' '''ID''' - The ID of the Checkpoint to find

== Example ==

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if(cmd == "findcp")
{
local cp = FindCheckpoint(text.tointeger());
if (cp)
{
MessagePlayer("[#00FF00]Checkpoint has been found!", player);
}
else
{
MessagePlayer("[#FF0000]Checkpoint has not been found!", player);
}
}
return 1;
}
</source>

=== Notes ===
Call [[onPlayerCommand]] was used in this example. More info about it in the page.

== Related Functions ==
{{Scripting/Squirrel/Functions/Checkpoint_Functions}}

Scripting/Squirrel/Functions/BanIP

2016-04-25T16:25:44Z

Pun1sh3r:

This function will ban an IP from the server.

== Syntax ==
<pre>BanIP(ip)</pre>

== Arguments ==
* ''string'' '''ip''' - This is the IP address to be banned

== Example ==
<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "ban" )
{
if ( !text )
{
MessagePlayer( "[Syntax] - /ban <Nick/ID> <Reason>", player );
}
else
{
local plr = FindPlayer( GetTok( text, " ", 1 ) );
if ( !plr )
{
MessagePlayer( "[Error] - Unknown Player..", player );
}
else
{
local reason = GetTok( text, " ", 2 NumTok( text, " " ) );
local ip = plr.IP;
local sub = split( ip, "." );
if ( reason == null ) reason = "None";
Message( "[#EE82EE]** Admin " + player.Name + " Banned " + plr.Name + " Reason: " + reason );
BanPlayer( plr );
}
}
}
return 1;
}
</source>

=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Administrative_Functions}}

Scripting/Squirrel/Functions/IsIPBanned

2016-04-25T16:25:26Z

Pun1sh3r:

This function will check if an IP is banned from the server.

== Syntax ==

<pre>IsIPBanned( ip )</pre>

== Arguments ==

* ''string'' '''ip''' - The IP to be checked

== Return value ==

* ''bool'' '''isbanned''' - '''true''' or '''false'''

== Example ==
<source lang="squirrel">
function onPlayerCommand( player, command, arguments )
{
if (cmd == "checkip")
{
if(!IsIPBanned(text) == true)
{
ClientMessage("Provided IP '" + text + "' was not banned previously",player,255,255,255);
}
else
{
ClientMessage("Provided IP '" + text + "' is banned.",player,255,255,255);
}
}
return 1;
}
</source>

=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Administrative_Functions}}

Scripting/Squirrel/Functions/Checkpoint.Owner

2016-04-25T16:23:40Z

Pun1sh3r:

This function gets the Owner of a checkpoint.

== Syntax ==
<pre>Checkpoint.Owner</pre>

== Example ==
Note: If there is no Owner set for the Checkpoint this function will return: (null : 0x0000000000000000)
<source lang="squirrel">
function onPlayerCommand(player, command, arguments)
{
if(cmd == "playercp")
{
CheckpointTest <- CreateCheckpoint(player, 0, player.Pos, RGB(255, 0, 255), 2);
ClientMessage("[#ffffff]Checkpoint Owner: " + CheckpointTest.Owner,player,255,255,255);
}
return 1;
}
</source>

=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Checkpoint_Functions}}

Scripting/Squirrel/Functions/ClientMessage

2016-04-24T21:53:45Z

Pun1sh3r:

This function will send a coloured message to a player.

== Syntax ==
<pre>ClientMessage(message, player, R, G, B)</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerTo''' - The player to send the message to
* ''int'' '''R''' - The amount of red
* ''int'' '''G''' - The amount of green
* ''int'' '''B''' - The amount of blue

== Example ==
<source lang=squirrel>
function onPlayerJoin(player)
{
ClientMessage("Welcome to our server, [#B200FF]and have fun!",player,12,255,245);
return 1;
}
</source>

== Notes ==
Call [[onPlayerJoin]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/ClientMessageToAll

2016-04-24T21:52:47Z

Pun1sh3r:

This function will send a coloured message to every player in the server.

== Syntax ==
1
<pre>ClientMessageToAll(message, r, g, b)</pre>
2
<pre>ClientMessageToAll(message, r, g, b, a)</pre>

== Arguments ==
1
* ''string'' '''message''' - The message to send
* ''int'' '''r''' - The amount of red
* ''int'' '''g''' - The amount of green
* ''int'' '''b''' - The amount of blue
2
* ''string'' '''message''' - The message to send
* ''int'' '''r''' - The amount of red
* ''int'' '''g''' - The amount of green
* ''int'' '''b''' - The amount of blue
* ''int'' '''a''' - The amount of alpha

== Example ==
<source lang=squirrel>
function onPlayerTeamKill(killer, player, reason, bodypart)
{
ClientMessageToAll(killer+" killed team-mate "+ player, 85, 107, 47);
return 1;
}
</source>

== Notes ==
Call [[onPlayerTeamKill]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/Announce

2016-04-24T21:51:55Z

Pun1sh3r:

This function will send a big message on the screen to a player.

== Syntax ==
<pre>Announce(message, playerTo, type)</pre>

== Arguments ==
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerTo''' - The player to send the message to
* ''string'' '''message''' - The message to send
* ''int'' '''[[Game_Text_Codes_and_Styles|type]]''' - The type of the message

== Example ==
<source lang=squirrel>
function onPlayerJoin(player)
{
Announce("Welcome to our server", player, 0);
return 1;
}
</source>

== Notes ==
Call [[onPlayerTeamKill]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/MessageAllExcept

2016-04-24T21:49:40Z

Pun1sh3r:

This function will send a simple message to everyone but the player specified.

== Syntax ==
<pre>MessageAllExcept(message, player)</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''player''' - The player not to send the message to

== Example ==
The following example message to all except yourself saying '''Hello all except myself, have fun here'''!:
<source lang=squirrel>
function onPlayerCommand(player, cmd, text)
{
if(cmd == "msg")
{
MessageAllExcept("Hello all except myself, have fun here!", player );
}
return 1;
}
</source>

== Notes ==
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/MessagePlayer

2016-04-24T21:48:48Z

Pun1sh3r:

This function will send a simple message to the player specified.

== Syntax ==
<pre>MessagePlayer(message, player)</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''player''' - The player to send the message to

== Example ==
The following example send a personal message saying '''Hey you, have fun here'''!:
<source lang=squirrel>
function onPlayerCommand(player, cmd, text)
{
if(cmd == "playermsg")
{
MessagePlayer("Hey you, have fun here!", player);
}
return 1;
}
</source>

== Notes ==
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/PrivMessage

2016-04-24T21:48:11Z

Pun1sh3r:

This function will send a private message to the player specified.

== Syntax ==
<pre>PrivMessage(player, message)</pre>

== Arguments ==
* ''[[Scripting/Squirrel/Functions#Player Functions|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!''':
<source lang=squirrel>
function onPlayerCommand(player, cmd, text)
{
if(cmd == "privatemsg")
{
PrivMessage(player, "Hey you, have fun here!");
}
return 1;
}
</source>

== Notes ==
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/SendPlayerMessage

2016-04-24T21:47:26Z

Pun1sh3r:

This function will send a fake private message from one player to another.

== Syntax ==
<pre>SendPlayerMessage(playerToFake, playerTo, message)</pre>

== Arguments ==
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerToFake''' - The player to send the message as
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerTo''' - The player to send the message to
* ''string'' '''message''' - The message to send

== Example ==
The following example send a fake message from killer to player.
<source lang=squirrel>
function onPlayerKill(killer, player, reason, bodypart)
{
SendPlayerMessage(killer, player, "hahaha, begginer I killed you.");
return 1;
}
</source>

== Notes ==
Call [[onPlayerKill]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/SendPlayerMessage

2016-04-24T21:45:21Z

Pun1sh3r:

This function will send a fake private message from one player to another.

== Syntax ==
<pre>SendPlayerMessage(playerToFake, playerTo, message)</pre>

== Arguments ==
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerToFake''' - The player to send the message as
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerTo''' - The player to send the message to
* ''string'' '''message''' - The message to send

== Example ==
The following example send a fake message from killer to player.
<source lang=squirrel>
function onPlayerKill( killer, player, reason, bodypart );
{
SendPlayerMessage(killer, player, "hahaha, begginer I killed you.");
return 1;
}
</source>

== Notes ==
Call [[onPlayerKill]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/PrivMessageAll

2016-04-24T21:44:07Z

Pun1sh3r:

This function will send a private message to everyone in the server.

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

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

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

== Notes ==
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/PrivMessage

2016-04-24T21:42:44Z

Pun1sh3r:

This function will send a private message to the player specified.

== Syntax ==
<pre>PrivMessage(player, message)</pre>

== Arguments ==
* ''[[Scripting/Squirrel/Functions#Player Functions|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!''':
<source lang=squirrel>
function onPlayerCommand(player, cmd, text);
{
if ( cmd == "privatemsg" )
{
PrivMessage(player, "Hey you, have fun here!");
}
return 1;
}
</source>

== Notes ==
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/MessagePlayer

2016-04-24T21:41:28Z

Pun1sh3r:

This function will send a simple message to the player specified.

== Syntax ==
<pre>MessagePlayer(message, player)</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''player''' - The player to send the message to

== Example ==
The following example send a personal message saying '''Hey you, have fun here'''!:
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "playermsg" )
{
MessagePlayer("Hey you, have fun here!", player);
}
return 1;
}
</source>

== Notes ==
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/MessagePlayer

2016-04-24T21:41:04Z

Pun1sh3r:

This function will send a simple message to the player specified.

== Syntax ==
<pre>MessagePlayer(message, player)</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''player''' - The player to send the message to

== Example ==
The following example send a personal message saying '''Hey you, have fun here'''!:
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "SendMessagePlayer" )
{
MessagePlayer("Hey you, have fun here!", player);
}
return 1;
}
</source>

== Notes ==
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/MessageAllExcept

2016-04-24T21:39:39Z

Pun1sh3r:

This function will send a simple message to everyone but the player specified.

== Syntax ==
<pre>MessageAllExcept(message, player)</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''player''' - The player not to send the message to

== Example ==
The following example message to all except yourself saying '''Hello all except myself, have fun here'''!:
<source lang=squirrel>
function onPlayerCommand(player, cmd, text);
{
if ( cmd == "msg" )
{
MessageAllExcept("Hello all except myself, have fun here!", player );
}
return 1;
}
</source>

== Notes ==
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/Message

2016-04-24T21:37:37Z

Pun1sh3r:

This function will send a simple message to everyone in the server.

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

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

== Example ==
<source lang=squirrel>
function onPlayerCommand(player, cmd, text)
{
if(cmd == "msg")
{
Message("Hello, have fun here!");
}
return 1;
}
</source>

== Notes ==
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/AnnounceAll

2016-04-24T21:35:02Z

Pun1sh3r:

This function will send a big message on the screen to every player.

== Syntax ==
<pre>AnnounceAll(message, type)</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''int'' '''[[Game_Text_Codes_and_Styles|type]]''' - The type of the message

== Example ==
<source lang=squirrel>
function onPlayerCommand(player, command, arguments)
{
if (cmd == "ann" || cmd == "announce")
{
if(!text)
{
PrivMessage(player, "Use /" + cmd + " <message>");
}
else
{
AnnounceAll ( text + "", 3);
MessagePlayer(">> You have announced: " + text,player )
}
}
return 1;
}
</source>

== Notes ==
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/ClientMessageToAll

2016-04-24T21:29:53Z

Pun1sh3r:

This function will send a coloured message to every player in the server.

== Syntax ==
1
<pre>ClientMessageToAll( message, r, g, b )</pre>
2
<pre>ClientMessageToAll( message, r, g, b, a )</pre>

== Arguments ==
1
* ''string'' '''message''' - The message to send
* ''int'' '''r''' - The amount of red
* ''int'' '''g''' - The amount of green
* ''int'' '''b''' - The amount of blue
2
* ''string'' '''message''' - The message to send
* ''int'' '''r''' - The amount of red
* ''int'' '''g''' - The amount of green
* ''int'' '''b''' - The amount of blue
* ''int'' '''a''' - The amount of alpha

== Example ==
<source lang=squirrel>
function onPlayerTeamKill( killer, player, reason, bodypart )
{
ClientMessageToAll( killer+" killed team-mate "+ player, 85, 107, 47 );
return 1;
}
</source>

== Notes ==
Call [[onPlayerTeamKill]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/Announce

2016-04-24T21:29:25Z

Pun1sh3r:

This function will send a big message on the screen to a player.

== Syntax ==
<pre>Announce( message, playerTo, type )</pre>

== Arguments ==
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerTo''' - The player to send the message to
* ''string'' '''message''' - The message to send
* ''int'' '''[[Game_Text_Codes_and_Styles|type]]''' - The type of the message

== Example ==
<source lang=squirrel>
function onPlayerJoin( player )
{
Announce( "Welcome to our server", player, 0 );
return 1;
}
</source>

== Notes ==
Call [[onPlayerTeamKill]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/Announce

2016-04-24T21:17:35Z

Pun1sh3r:

This function will send a big message on the screen to a player.

== Syntax ==
<pre>Announce( message, playerTo, type )</pre>

== Arguments ==
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerTo''' - The player to send the message to
* ''string'' '''message''' - The message to send
* ''int'' '''type''' - The type of the message

== Example ==
<source lang=squirrel>
function onPlayerJoin( player )
{
Announce( "Welcome to our server", player, 0 );
return 1;
}
</source>

== Notes ==
Call [[onPlayerTeamKill]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/ClientMessageToAll

2016-04-24T21:16:02Z

Pun1sh3r:

This function will send a coloured message to every player in the server.

== Syntax ==
1
<pre>ClientMessageToAll( message, r, g, b )</pre>
2
<pre>ClientMessageToAll( message, r, g, b, a )</pre>

== Arguments ==
1
* ''string'' '''message''' - The message to send
* ''int'' '''r''' - The amount of red
* ''int'' '''g''' - The amount of green
* ''int'' '''b''' - The amount of blue
2
* ''string'' '''message''' - The message to send
* ''int'' '''r''' - The amount of red
* ''int'' '''g''' - The amount of green
* ''int'' '''b''' - The amount of blue
* ''int'' '''a''' - The amount of alpha

== Example ==
<source lang=squirrel>
function onPlayerTeamKill( killer, player, reason, bodypart )
{
ClientMessageToAll( killer+" killed team-mate "+ player, 85, 107, 47 );
return 1;
}
</source>

=== Notes ===
Call [[onPlayerTeamKill]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/ClientMessage

2016-04-24T21:14:45Z

Pun1sh3r:

This function will send a coloured message to a player.

== Syntax ==
<pre>ClientMessage( message, player, R, G, B )</pre>

== Arguments ==
* ''string'' '''message''' - The message to send
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerTo''' - The player to send the message to
* ''int'' '''R''' - The amount of red
* ''int'' '''G''' - The amount of green
* ''int'' '''B''' - The amount of blue

== Example ==
<source lang=squirrel>
function onPlayerJoin(player)
{
ClientMessage("Welcome to our server, [#B200FF]and have fun!",player,12,255,245);
return 1;
}
</source>

== Notes ==
Call [[onPlayerJoin]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Messages}}

Scripting/Squirrel/Functions/Checkpoint.Owner

2016-04-23T21:30:59Z

Pun1sh3r: Created page with "This function gets the Owner of a checkpoint. == Syntax == <pre>Checkpoint.Owner</pre> == Example == <source lang="squirrel"> </source> === Notes === == Related Function..."

This function gets the Owner of a checkpoint.

== Syntax ==

<pre>Checkpoint.Owner</pre>

== Example ==

<source lang="squirrel">
</source>

=== Notes ===

== Related Functions ==

{{Scripting/Squirrel/Functions/Checkpoint_Functions}}

Scripting/Squirrel/Functions/Checkpoint.StreamedToPlayer

2016-04-23T21:21:26Z

Pun1sh3r: Created page with "This function checks if a checkpoint is only streamed for a Player or for everyone. == Syntax == <pre>Checkpoint.StreamedToPlayer</pre> == Example == <source lang="squirre..."

This function checks if a checkpoint is only streamed for a Player or for everyone.

== Syntax ==

<pre>Checkpoint.StreamedToPlayer</pre>

== Example ==

<source lang="squirrel">
function onScriptLoad()
{
CheckpointWhite <- CreateCheckpoint( null, 0, Vector( 876.45, 432.54, 12.34 ), RGB(255, 255, 255), 2);

if(CheckpointWhite.StreamedToPlayer == true)
{
print("This Checkpoint is only Streamed for a Player.");
}
else
{
print("This Checkpoint is Streamed for everyone.");
}
return 1;
}
</source>

=== Notes ===

Call [[onScriptLoad]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Checkpoint_Functions}}

Scripting/Squirrel/Functions/Checkpoint.Pos

2016-04-23T20:54:03Z

Pun1sh3r:

This function changes the Position of a Checkpoint.

== Syntax ==
<pre>Checkpoint.Pos</pre>

== Arguments ==
*[[Scripting/Squirrel/Functions/Vector|''Vector'']] '''pos''' - The checkpoint position

== Example ==
<source lang="squirrel">
function onScriptLoad()
{
CheckpointGreen <- CreateCheckpoint( null, 0, Vector( -378.79, -537.962, 17.2832 ), RGB(255, 0, 255), 2);
return 1;
}

function onPlayerCommand( player, command, arguments )
{
if(cmd == "setcppos")
{
CheckpointGreen.Pos = Vector(player.Pos.x, player.Pos.y, player.Pos.z);
//NOTE: The Checkpoint might disappear use /kill to respawn, the Checkpoint will be visible again and the Position will be updated
}
return 1;
}
</source>

=== Notes ===

Call [[onScriptLoad]] and [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Checkpoint_Functions}}

Scripting/Squirrel/Functions/Checkpoint.Radius

2016-04-23T20:48:26Z

Pun1sh3r:

This function changes the size of a Checkpoint.

== Syntax ==
<pre>Checkpoint.Radius</pre>

== Arguments ==
*''int'' '''Radius''' - The size/Radius of the checkpoint

== Example ==
<source lang="squirrel">
function onScriptLoad()
{
CheckpointGreen <- CreateCheckpoint( null, 0, Vector( -378.79, -537.962, 17.2832 ), RGB(255, 0, 255), 2);
return 1;
}

function onPlayerCommand( player, command, arguments )
{
if(cmd == "setcpsize")
{
CheckpointGreen.Radius = 5;
//NOTE: The Checkpoint might disappear use /kill to respawn, the Checkpoint will be visible again and the size will be updated
}
return 1;
}
</source>

=== Notes ===

Call [[onScriptLoad]] and [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Checkpoint_Functions}}

Scripting/Squirrel/Functions/Checkpoint.Radius

2016-04-23T20:47:53Z

Pun1sh3r:

This function changes the size of a Checkpoint.

== Syntax ==
<pre>Checkpoint.Radius</pre>

== Arguments ==
*''int'' '''Radius''' - The size/Radius of the checkpoint

== Example ==
<source lang="squirrel">
function onScriptLoad()
{
CheckpointGreen <- CreateCheckpoint( null, 0, Vector( -378.79, -537.962, 17.2832 ), RGB(255, 0, 255), 2);
return 1;
}

function onPlayerCommand( player, command, arguments )
{
if(cmd == "setcpsize")
{
CheckpointGreen.Radius = 5;
//NOTE: The Checkpoint might disappear, use /kill to respawn, the Checkpoint will be visible again and the size will be updated
}
return 1;
}
</source>

=== Notes ===

Call [[onScriptLoad]] and [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Checkpoint_Functions}}

Scripting/Squirrel/Functions/Checkpoint.Color

2016-04-23T20:35:05Z

Pun1sh3r:

This function changes the Color of a checkpoint.

== Syntax ==
<pre>Checkpoint.Color</pre>

== Arguments ==
*[[Scripting/Squirrel/Functions/cRGB|''cRGB'']] '''rgb''' - The checkpoint color

== Example ==
<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "setcpcolor" )
{
FindCheckpoint(0).Color = RGB(255,255,255);
}
}
</source>

=== Notes ===

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Checkpoint_Functions}}