Vice City Multiplayer - User contributions [en]

Scripting/Squirrel/Client Events/Script::ScriptProcess

2019-05-21T08:06:10Z

Dracc:

This event is called on every script update.

== Syntax ==
<source lang="squirrel">function Script::ScriptProcess()</source>

== Arguments ==

None.

== Example ==
This message is in 3D in a map position

<source lang="squirrel">
dx3DTextdrawPos <- GUI.WorldPosToScreen(Vector(497.132, -85.3217, 10.0307));
dxText <- null;

function Script::ScriptProcess() {
::dx3DTextdrawPos = GUI.WorldPosToScreen(Vector(497.132, -85.3217, 10.0307));
::dxText = GUILabel(VectorScreen(dx3DTextdrawPos.X, dx3DTextdrawPos.Y), Colour(255, 255, 0, 255), "Hello world");
::dxText.FontSize = 20;
}
</source>

=== Notes ===
This example sets the 3D position on every frame(?), quite inefficient. But there are few (none?) good use cases for this function.

== Related Functions ==
{{Scripting/Squirrel/Client_Events/Script_Events}}
[[Category:Scripting/Squirrel/Client_Events/Script_Events]]

OnObjectShot

2019-05-07T13:34:25Z

Dracc:

==Description==
This event is called when a player shoots an object.
==Syntax==
<source lang=squirrel>
onObjectShot(object,player,weapon);
</source>
==Example==
<source lang=squirrel>
function onObjectShot(object, player, weapon) {
MessagePlayer("You've shot object id " + object + " with weapon id " + weapon, player);
}
</source>
== Related Functions ==

{{Scripting/Squirrel/Events/Object_Events}}
[[Category:Scripting/Squirrel/Events/Object_Events]]

OnObjectShot

2019-05-07T13:33:54Z

Dracc:

==Description==
This event is called when a player shoots an object.
==Syntax==
<source lang=squirrel>
onObjectShot(object,player,weapon);
</source>
==Example==
<source lang=squirrel>
function onObjectShot(object,player,weapon ) {
MessagePlayer("You've shot object id "+object+" with weapon id "+weapon,player)
}
</source>
== Related Functions ==

{{Scripting/Squirrel/Events/Object_Events}}
[[Category:Scripting/Squirrel/Events/Object_Events]]

OnObjectBump

2019-05-07T13:32:42Z

Dracc:

==Description==
This event is called when the player touches a object!
==Syntax==

<pre>onObjectBump(object,player)</pre>

==Example==
<source lang=squirrel>
function onObjectBump(object,player) {
MessagePlayer("You've bumped in to object id: " + object, player)
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Events/Object_Events}}
[[Category:Scripting/Squirrel/Events/Object_Events]]

Scripting/Squirrel/Functions/BanIP

2019-05-02T06:06:05Z

Dracc: /* Example */

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) {
local params = split(text, " ");
local plr = FindPlayer(params[0]);
if (plr != null) {
if (params.len() >= 2) {
local reason = params[1];
} else {
reason = "None";
}
Message("[#EE82EE]** Admin " + player.Name + " Banned " + plr.Name + " Reason: " + reason);
MessagePlayer("You have been banned by: " + player.Name + ". Reason: " + reason, plr);
BanIP(plr.IP);
return 1;
} else {
MessagePlayer("[Error] - Player " + params[0] + " not found!", player);
return 1;
}
}
MessagePlayer("[Syntax] - /ban <Nick/ID> <Reason>", 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/Administrative_Functions}}
[[Category:Scripting/Squirrel/Functions/Administrative_Functions]]

Scripting/Squirrel/Functions/BanIP

2019-05-02T06:05:32Z

Dracc: Update the example

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) {
local params = split(text, " ");
local plr = FindPlayer(params[0]);
if (plr != null) {
if (params.len() >= 2) {
local reason = params[1];
} else {
reason = "None";
}
Message("[#EE82EE]** Admin " + player.Name + " Banned " + plr.Name + " Reason: " + reason);
MessagePlayer("You have been banned by: " + player.Name + ". Reason: " + reason, plr);
BanPlayer(plr);
return 1;
} else {
MessagePlayer("[Error] - Player " + params[0] + " not found!", player);
return 1;
}
}
MessagePlayer("[Syntax] - /ban <Nick/ID> <Reason>", 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/Administrative_Functions}}
[[Category:Scripting/Squirrel/Functions/Administrative_Functions]]

Scripting/Squirrel/Functions/Player.AddSpeed

2019-04-26T11:02:00Z

Dracc: /* Related Functions */

Add speed to a player.
== Syntax ==
<source lang=squirrel>
player.AddSpeed( Vector )
</source>

== Arguments ==
* ''Vector3'' '''Vector''' - Speed vector (x, y, z)

== Example ==
The command will boost the player to the sky with 5 additional speed.
<source lang=squirrel>
function onPlayerCommand(player, cmd) {
if (cmd == "up") {
player.AddSpeed(Vector(0, 0, 5));
}
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Functions/Player_Functions}}
[[Category:Scripting/Squirrel/Functions/Player_Functions]]

Scripting/Squirrel/Functions/Player.AddSpeed

2019-04-26T11:01:30Z

Dracc:

Add speed to a player.
== Syntax ==
<source lang=squirrel>
player.AddSpeed( Vector )
</source>

== Arguments ==
* ''Vector3'' '''Vector''' - Speed vector (x, y, z)

== Example ==
The command will boost the player to the sky with 5 additional speed.
<source lang=squirrel>
function onPlayerCommand(player, cmd) {
if (cmd == "up") {
player.AddSpeed(Vector(0, 0, 5));
}
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Functions/Game_Functions}}
[[Category:Scripting/Squirrel/Functions/Game_Functions]]

Scripting/Squirrel/Functions/Player.Admin

2019-04-26T10:59:04Z

Dracc: Restructure

This function is just a variable.
There are no built-in commands for admins, like they used to be in earlier versions.

== Syntax ==
<source lang="squirrel">
Player.Admin;
Player.Admin = toggle;
</source>

== Arguments ==
* ''bool'' '''toggle''' Set Admin true/false

== Example ==
<source lang="squirrel">
function onPlayerCommand(cmd, args, player) {
if (cmd == "heal") {
if(player.Admin) {
player.Health = 100;
}
}
}
</source>
=== Notes ===
Call [[onPlayerCommand]] was used in this example.

== Related Functions ==

{{Scripting/Squirrel/Functions/Game_Functions}}
[[Category:Scripting/Squirrel/Functions/Game_Functions]]

Scripting/Squirrel/Functions/Player.Redirect

2019-04-26T10:53:30Z

Dracc:

Send player to another server.
== Syntax ==
<source lang=squirrel>
player.Redirect(ip, port, nickname, serverpass, userpass);
</source>

== Arguments ==
* ''string'' '''ip''' Target server IP address
* ''integer'' '''port''' Target server port
* ''string'' '''nickname''' ?
* ''string'' '''serverpass''' Target server password
* ''string'' '''userpass''' User password

== Example ==
{{Scripting/Needs_Example}}

== Related Functions ==
{{Scripting/Squirrel/Functions/Player_Functions}}
[[Category:Scripting/Squirrel/Functions/Player_Functions]]

Scripting/Squirrel/Functions/Player.RemoveWeapon

2019-04-26T10:49:32Z

Dracc: /* Example */

==Usage==
Removes a weapon from the player's inventory. Returns void.

==Syntax==
<code> player.RemoveWeapon(int WEAPON_ID)</code>

==Example==
<source lang=squirrel>
function onPlayerCommand(player, cmd, text) {
if (cmd == "remweps") {
try {
for (local i = 0; i < 9; ++i) {
player.RemoveWeapon(i);
}
}
catch(e) {
}
}
}
</source>

Scripting/Squirrel/Functions/GetTaxiBoostJump

2019-04-26T10:46:31Z

Dracc: /* Example */

This function will return the current status of the taxi boost jump ability.

== Syntax ==

<pre>GetTaxiBoostJump()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''bool'' '''toggled''' - '''true''' or '''false'''

== Example ==
<source lang=squirrel>
function onPlayerCommand(player, cmd, text) {
if (cmd == "taxiboost") {
MessagePlayer("Status: " + GetTaxiBoostJump(), player);
}
}
</source>

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Scripting/Squirrel/Functions/GetTaxiBoostJump

2019-04-26T10:46:20Z

Dracc: /* Example */

This function will return the current status of the taxi boost jump ability.

== Syntax ==

<pre>GetTaxiBoostJump()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''bool'' '''toggled''' - '''true''' or '''false'''

== Example ==
<source lang=squirrel>
function onPlayerCommand(player, cmd, text) {
if(cmd == "taxiboost") {
MessagePlayer("Status: " + GetTaxiBoostJump(), player);
}
}
</source>

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Scripting/Squirrel/Functions/SetTaxiBoostJump

2019-04-26T10:45:34Z

Dracc: /* Example */

This function will toggle the taxi boost jump ability.

== Syntax ==

<pre>SetTaxiBoostJump( toggle )</pre>

== Arguments ==

* ''bool'' '''toggle''' - '''true''' or '''false'''.

== Example ==
<source lang=squirrel>
function onPlayerCommand(player, cmd, text) {
if (cmd == "settaxijump") {
if (GetTaxiBoostJump() == false) {
SetTaxiBoostJump(true);
MessagePlayer("Enabled", player);
} else {
SetTaxiBoostJump(false);
MessagePlayer("Disabled", player);
}
}
}
</source>
=== Notes ===

Calls [[onPlayerCommand]], [[Scripting/Squirrel/Functions/GetTaxiBoostJump|GetTaxiBoostJump]] and [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Scripting/Squirrel/Functions/SetTaxiBoostJump

2019-04-26T10:45:09Z

Dracc: /* Example */

This function will toggle the taxi boost jump ability.

== Syntax ==

<pre>SetTaxiBoostJump( toggle )</pre>

== Arguments ==

* ''bool'' '''toggle''' - '''true''' or '''false'''.

== Example ==
<source lang=squirrel>
function onPlayerCommand(player, cmd, text) {
if(cmd == "settaxijump") {
if(GetTaxiBoostJump() == false) {
SetTaxiBoostJump(true);
MessagePlayer("Enabled", player);
} else {
SetTaxiBoostJump(false);
MessagePlayer("Disabled", player);
}
}
}
</source>
=== Notes ===

Calls [[onPlayerCommand]], [[Scripting/Squirrel/Functions/GetTaxiBoostJump|GetTaxiBoostJump]] and [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Scripting/Squirrel/Functions/SetTaxiBoostJump

2019-04-26T10:42:35Z

Dracc: Example formatting

This function will toggle the taxi boost jump ability.

== Syntax ==

<pre>SetTaxiBoostJump( toggle )</pre>

== Arguments ==

* ''bool'' '''toggle''' - '''true''' or '''false'''.

== Example ==
<source lang=squirrel>
function onPlayerCommand(player,cmd,text) {
if(cmd=="settaxijump") {
if(GetTaxiBoostJump() == false) {
SetTaxiBoostJump(true);
MessagePlayer("Enabled,player);
} else {
SetTaxiBoostJump(false);
MessagePlayer("Disabled,player);
}
}
}
</source>
=== Notes ===

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Scripting/Squirrel/Functions/CreateVehicle

2019-04-26T10:40:33Z

Dracc: /* Example */

This function will create a vehicle.

== Syntax ==

'''1'''
<pre>CreateVehicle( model, pos, angle, col1, col2)</pre>
'''2'''
<pre>CreateVehicle( model, world, pos, angle, col1, col2 )</pre>
'''3'''
<pre>CreateVehicle( model, world, x, y, z, angle, col1 , col2 )</pre>
== Arguments ==

'''1'''
* ''int'' '''model''' - The model ID of the vehicle.
* ''[[Scripting/Squirrel/Functions/Vector|Vector]]'' '''pos''' - The position of the vehicle.
* ''float'' '''angle''' - The rotation angle of the vehicle.
* ''int'' '''col1''' - The Color1 of the vehicle.
* ''int'' '''col2''' - The Color2 of the vehicle.
'''2'''
* ''int'' '''model''' - The model ID of the vehicle.
* ''int'' '''world''' - The world of the vehicle.
* ''[[Scripting/Squirrel/Functions/Vector|Vector]]'' '''pos''' - The position of the vehicle.
* ''float'' '''angle''' - The rotation angle of the vehicle.
* ''int'' '''col1''' - The Color1 of the vehicle.
* ''int'' '''col2''' - The Color2 of the vehicle.
'''3'''
* ''int'' '''model''' - The model ID of the vehicle.
* ''int'' '''world''' - The world of the vehicle.
* ''float'' '''x''' - The x position of the vehicle.
* ''float'' '''y''' - The y position of the vehicle.
* ''float'' '''z''' - The z position of the vehicle.
* ''float'' '''angle''' - The rotation angle of the vehicle.
* ''int'' '''col1''' - The Color1 of the vehicle.
* ''int'' '''col2''' - The Color2 of the vehicle.

== Example ==
<source lang=squirrel>
function onServerStart(){
CreateVehicle( 171, 0, -848.975,-466.336,10.1645, 360.255, 68, 39 );
}
</source>

=== Notes ===
Call [[Scripting/Squirrel/Events/Player/onServerStart|onServerStart]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==
{{Scripting/Squirrel/Functions/Vehicle_Functions}}
[[Category:Scripting/Squirrel/Functions/Vehicle_Functions]]

Scripting/Squirrel/Functions/Vehicle.IsGhost

2019-04-26T10:39:34Z

Dracc: Add description and sloppy examples.

Get or Set the vehicle `IsGhost` boolean property.
Ghost cars don't collide with other vehicles or players but still interact with the world.

== Syntax ==
<source lang=squirrel>Vehicle.IsGhost</source>

== Arguments ==
* ''None''

== Example ==
1. Set vehicle to `ghost`
<source lang=squirrel>
Vehicle.IsGhost = true;
</source>
2. Unset vehicle `ghost` property
<source lang=squirrel>
Vehicle.IsGhost = false;
</source>
3. Probe to see whether or not a vehicle is a ghost
<source lang=squirrel>
local vehicleIsGhost = Vehicle.IsGhost;
</source>

== Related Functions ==
{{Scripting/Squirrel/Functions/Vehicle_Functions}}
[[Category:Scripting/Squirrel/Functions/Vehicle_Functions]]

Scripting/Squirrel/Functions/mysql connect

2019-04-26T10:30:57Z

Dracc: Add argument type declaration and cleanup the example.

This function will connect to a MySQL database on the server.

== Syntax ==
<source lang=squirrel>
mysql_connect( host, dbuser, dbpassword, dbname);
</source>

== Arguments ==
* ''string'' '''host''' - The host of the MySQL database (Most cases "localhost")
* ''string'' '''dbuser''' - The MySQL user name.
* ''string'' '''dbpassword''' - The MySQL user password.
* ''string'' '''dbname''' - The MySQL database name.

== Example ==
<source lang=squirrel>
function onScriptLoad() {
db <- mysql_connect( "localhost", "vcmp", "test123", "vcmpdb");
}
</source>

=== Notes ===
You can also remotely connect to a MySQL database, replace "localhost" with the remote host IP and make sure the host accepts remote connections.

== Related Functions ==
{{Scripting/Squirrel/Functions/MySQL Functions}}
[[Category:Scripting/Squirrel/Functions/Mysql_Functions]]

OnServerStart

2019-04-26T10:27:40Z

Dracc:

== Syntax ==
<source lang=squirrel>
onServerStart()
</source>

== Arguments ==
* ''None''

== Example ==
The following example will print "Hello World!" when the server is started.
<source lang=squirrel>
function onServerStart() {
print( "Hello World!" );
}
</source>

== Notes ==
Function print() was used in this example.The print() function outputs a formatted string on the console.

== Related Functions ==
{{Scripting/Squirrel/Events/Server_Events}}
[[Category:Scripting/Squirrel/Events/Server_Events]]

OnScriptUnload

2019-04-26T10:25:51Z

Dracc:

== Description ==
Executed when the script is removed from memory
== Example ==
<source lang="squirrel">
function onScriptUnload()
{
print( "== Unloaded Squirrel VC:MP Script ==" );
}
</source>
== Related Functions ==
{{Scripting/Squirrel/Events/Server_Events}}
[[Category:Scripting/Squirrel/Events/Server_Events]]

OnScriptLoad

2019-04-26T10:25:16Z

Dracc:

== Description ==
Executed whenever the script is loaded (including reload)

== Example ==
<source lang="squirrel">
function onScriptLoad()
{
print( "== Loaded Squirrel VC:MP Script ==" );
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Events/Server_Events}}
[[Category:Scripting/Squirrel/Events/Server_Events]]

Scripting/Squirrel/Functions/QuerySQL

2019-04-26T10:24:17Z

Dracc: Add an example and description

This function will send a query to the database.
== Syntax ==
<source lang=squirrel>QuerySQL(database, queryString);</source>

== Arguments ==
* ''SQLiteDB'' '''database''' - The database to query
* ''string'' '''queryString''' - The SQL query to send

== Example ==
<source lang=squirrel>
function onScriptLoad() {
db <- ConnectSQL("scripts/keybinds.db");
if (!db) {
print("ERROR: SQLite database file could not be opened");
}
QuerySQL(db, "CREATE TABLE IF NOT EXISTS players(name TEXT, password TEXT, " +
"level INTEGER, PRIMARY KEY(name,password));");
}
</source>
=== Notes ===
Calls [[onScriptLoad]], [[ConnectSQL]] and [[print]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/SQLite Functions}}
[[Category:Scripting/Squirrel/Functions/SQLite _Functions]]

Scripting/Squirrel/Functions/ConnectSQL

2019-04-26T10:14:21Z

Dracc: /* Usage */

== Usage ==
To use SQLite you need to first download the sqlite plugin from [https://bitbucket.org/stormeus/0.4-sqlite/downloads[here]]. Once you have downloaded it place the plugin in your plugins folder and load the plugin in your server.cfg by adding a line in plugins that is for 32 bit users it is '''sqlite04rel32''' and for 64 bit users it is '''sqlite04rel64'''

== Syntax ==
To connect a database you need to use something like
<source lang=javascript>function onScriptLoad()
{
db <- ConnectSQL( "Database.db" );
}</source>

== Adding tables to your database ==
You can add a table to your database by using the following function that is

<source lang=javascript>QuerySQL( db, "CREATE TABLE IF NOT EXISTS YOUR_TABLE_NAME( COLUMN1 TEXT, COLUMN2 TEXT )" );</source>

The Argument for your column can be used according to what you are storing/inserting to it. If you wished to insert/store a number you can change the TEXT to NUMERIC. If its a text you can use TEXT.

== Related Functions ==

{{Scripting/Squirrel/Functions/SQLite Functions}}
[[Category:Scripting/Squirrel/Functions/SQLite _Functions]]

Scripting/Squirrel/Functions/GetSQLNextRow

2019-04-26T10:13:13Z

Dracc: Cleanup example code

Calling GetSQLNextRow switches from the current row in a query to the next row, which allows you to read from that row with GetSQLColumnData.

== Syntax ==

<pre>function GetSQLNextRow( query )</pre>

== Arguments ==
* '''Query''' - A reference to the query that was previously executed.

== Example ==

<source lang="squirrel">
function GetAlias(uniqueid) {
// Select all the rows that has the same uniqueid as the entered value.
local query = QuerySQL(sdb, "SELECT namecolumn FROM tablename WHERE uniqueidcolumn = '" + uniqueid + "'");
// Store the first name.
local string = GetSQLColumnData(query, 0);

// Get the second name when the loop starts and continue getting the next row after that until no rows are left.
while (GetSQLNextRow(query)) {
string += ", " + GetSQLColumnData(query, 0);
}
string += ".";

// Return the string containing the aliases.
return string;
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Functions/SQLite Functions}}
[[Category:Scripting/Squirrel/Functions/SQLite _Functions]]