Vice City Multiplayer - User contributions [en]

Scripting/Squirrel/Functions/Player.Action

2016-11-14T15:00:36Z

ProsuWANTED: Argument fix

This function returns the action of any player as integer.

== Syntax ==
<pre>Player.Action</pre>

== Arguments ==
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - the instance of the player.

== Example ==

This example shows the current action of you.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "action" )
{
ClientMessage( "Your current action "+player.Action , player,255,255,255 );
}
}
</source>

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

User:ProsuWANTED

2016-11-14T14:59:18Z

ProsuWANTED:

A person that likes video games.

== About ==

Who cares.

== Stuff I want to be in the wiki ==

=== Functions ===
*[[Scripting/Squirrel/Functions/FindObject|FindObject]] ✓ (Done in 7th of August 2015, supposedly inspired by my [[Scripting/Squirrel/Functions/FindPickup|FindPickup page]])
*[[Scripting/Squirrel/Functions/Player.Colour|Player.Colour]] ✓ (Done in 4th of March 2016)
*[[Scripting/Squirrel/Functions/Player.AimPos|Player.AimPos]]
*[[Scripting/Squirrel/Functions/Player.Action|Player.Action]] ✓
*[[Scripting/Squirrel/Functions/Player.SetWeapon|Player.SetWeapon]] ✓ (Created in 13th of February 2016, but is barely done.)

=== Events ===
*'''''None'''''

OnPlayerCommand

2016-11-14T14:56:49Z

ProsuWANTED:

__NOTOC__
This is called when a player uses a command.

== Syntax ==

<pre>function onPlayerCommand( player, cmd, parameters )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that used the command.
* ''string'' '''cmd''' - The command that player used.
* ''string'' '''text''' - List of command parameters as string.

== Example ==

This example command heal the player if they type '''/heal'''.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "heal" )
{
if ( player.Health == 100 ) PrivMessage( player, "You have the health to maximum.");
else
{
PrivMessage( player, "You healed successfully.");
player.Health = 100;
}
}
</source>

=== Notes ===

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

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

OnPlayerCommand

2016-11-14T14:56:03Z

ProsuWANTED: Fixed arguments. (again)

__NOTOC__
This is called when a player uses a command.

== Syntax ==

<pre>function onPlayerCommand( player, cmd, parameters )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that used the command.
* ''string'' '''cmd''' - The command that player used.
* ''string'' '''parameters''' - List of command parameters as string.

== Example ==

This example command heal the player if they type '''/heal'''.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "heal" )
{
if ( player.Health == 100 ) PrivMessage( player, "You have the health to maximum.");
else
{
PrivMessage( player, "You healed successfully.");
player.Health = 100;
}
}
</source>

=== Notes ===

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

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

Scripting/Squirrel/Functions/Vehicle.Wrecked

2016-11-14T13:29:06Z

ProsuWANTED: removed signature.

This function returns if Vehicle is wrecked or not.

== Syntax ==
'''Vehicle.Wrecked'''

== Arguements ==
'''N/A'''

== Return value ==

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

== Example ==
<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "checkcar" )
{
if ( !text ) MessagePlayer("Syntax: /" + cmd + " [Vehicle ID]", player );
else {
local veh = FindVehicle( text.tointeger() );
if ( !veh ) MessagePlayer("ERROR --> Invalid Vehicle/ID.", player );
else{
MessagePlayer(veh.Wrecked+"",player);
}
}
}
}
</source>

Scripting/Squirrel/Functions/FindSphere

2016-03-14T20:41:49Z

ProsuWANTED:

Retrieve a sphere object from sphere's ID.

== Syntax ==

<pre>FindSphere( id )</pre>

== Arguments ==

* ''int'' '''id''' - The sphere's ID.

== Example ==
<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "sphere" )
{
local sphere = FindSphere( text );

if ( !sphere ) MessagePlayer( "[#ffffff]Can't find sphere " + text + ".", player );
else player.Pos = sphere.Pos;
MessagePlayer( "[#ffffff] Teleport to sphere " + text + ".", player );
}
}
</source>

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Sphere_Functions}}

User:ProsuWANTED

2016-03-11T17:09:11Z

ProsuWANTED:

A person that likes video games.

== About ==

I'm a '''fat person''' and I like to play GTA:VC.
Why am I alive? IDK.

== Stuff I want to be in the wiki ==

=== Functions ===
*[[Scripting/Squirrel/Functions/FindObject|FindObject]] ✓ (Done in 7th of August 2015, supposedly inspired by my [[Scripting/Squirrel/Functions/FindPickup|FindPickup page]])
*[[Scripting/Squirrel/Functions/Player.Colour|Player.Colour]] ✓ (Done in 4th of March 2016)
*[[Scripting/Squirrel/Functions/Player.AimPos|Player.AimPos]]
*[[Scripting/Squirrel/Functions/Player.Action|Player.Action]]
*[[Scripting/Squirrel/Functions/Player.SetWeapon|Player.SetWeapon]] ✓ (Created in 13th of February 2016, but is barely done.)

=== Events ===
*'''''None'''''

User:ProsuWANTED

2016-03-11T17:07:33Z

ProsuWANTED:

A person that likes video games.

== About ==

I'm a '''fat person''' and I like to play GTA:VC.
Why am I alive? IDK.

== Stuff I want to be in the wiki ==

=== Functions ===
*[[Scripting/Squirrel/Functions/FindObject|FindObject]] ✓ (Done in 7th of August 2015, supposedly inspired by my [[Scripting/Squirrel/Functions/FindPickup|FindPickup page]])
*[[Scripting/Squirrel/Functions/Player.Colour|Player.Colour]] ✓ (Done in 4th of March 2016)
*[[Scripting/Squirrel/Functions/Player.AimPos|Player.AimPos]]
*[[Scripting/Squirrel/Functions/Player.Action|Player.Action]]
*[[Scripting/Squirrel/Functions/Player.SetWeapon|Player.SetWeapon]] ✓ (Created, but is barely done in 13th of February 2016)

=== Events ===
*'''''None'''''

Scripting/Squirrel/Functions/NewTimer

2015-10-30T15:57:47Z

ProsuWANTED:

== Syntax ==

<pre>NewTimer( func, time, repeat, ... );</pre>

== Arguments ==

* ''string'' '''func''' - the function to call when the timer ends (in a string format)
* ''int'' '''time''' - the time before the function call
* ''int'' '''repeat''' - how many times to repeat the process (1 just to execute once)
* '''...''' - function (func) parameters

== Example ==

<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "count" )
{
Message( "[#ffffff]<<<Odliczanie>>>>" );
NewTimer( "ClientMessageToAll", 1000, 1, "-> 3",28, 255, 11 );
NewTimer( "ClientMessageToAll", 2000, 1, "-> 2",24, 255, 241 );
NewTimer( "ClientMessageToAll", 3000, 1, "-> 1",249, 57, 56 );
NewTimer( "ClientMessageToAll", 4000, 1, "-----> START <------",1000, 1500, 300 );
}
}
</source>

=== Notes ===

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

== Related Functions ==

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

Category:Pages with broken file links

2015-09-17T10:42:18Z

ProsuWANTED: Created page with "These pages have one or more broken file links."

These pages have one or more broken file links.

OnPlayerDeath

2015-09-17T10:32:35Z

ProsuWANTED: Added constants.

This is called when a player dies. e.g.: drowned or self-kill.

== Syntax ==

<pre>function onPlayerDeath( player, reason )</pre>

== Arguments ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that died
* ''int'' '''reason''' - [[OnPlayerDeath#Death_Reasons|Death reason]]

=== Death Reasons ===

* '''''Death from falling''''' - 44 '''(WEP_FALL)'''
* '''''Death from an explosion''''' - 41
* '''''Death from drowning''''' - 43 '''(WEP_DROWNED)'''
* '''''Death from dying in a car''''' - 39 '''(WEP_VEHICLE)'''
* '''''Suicide''''' - 70 '''(WEP_SUICIDE)'''

== Example ==

<source lang="squirrel">
function onPlayerDeath( player, reason )
{
switch (reason)
{
case 44:
{
Message(player.Name + " fell down and died.");
break;
}
case 41:
{
Message(player.Name + " exploded to bits!");
break;
}
case 43:
{
Message(player.Name + " drowned to death.");
break;
}
case 39:
{
Message(player.Name + " died in a car accident.");
break;
}
case 70:
{
Message(player.Name + " suicided.");
break;
}
}
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Message|Message]] and [[Scripting/Squirrel/Functions/Player.Name|Player.Name]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}

Scripting/Squirrel/Functions/BindKey

2015-08-03T14:00:06Z

ProsuWANTED:

== Syntax ==

<pre>BindKey(press, key, args1, args2)</pre>

== Arguments ==

*''bool'' '''press''' - This is the bool for the key function to be called once the key is 'pressed' or 'released'

*''int'' '''key''' - The key you bind it to, you can get the key codes from [http://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx| here]

*''int'' '''args1''' You can set it to 0

*''int'' '''args2''' You can set it to 0

== Example ==

The following example will bind the left-shift key for a player and will send him a message when he player presses that key:

<source lang=squirrel>
function onScriptLoad()
{
lshift <- BindKey(true, 0xA0, 0, 0);
}

function onKeyDown( player, key )
{
if( key == lshift )
{
MessagePlayer( ">> You pressed the left shift key", player );
}
}
</source>

=== Notes ===

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

Scripting/Squirrel/Functions/NewTimer

2015-08-03T13:48:22Z

ProsuWANTED:

== Syntax ==

<pre>NewTimer( func, time, repeat, ...);</pre>

== Arguments ==

* ''string'' '''func''' - the function to call when the timer ends (in a string format)
* ''int'' '''time''' - the time before the function call
* ''int'' '''repeat''' - how many times to repeat the process (1 just to execute once)
* '''...''' - function (func) parameters

== Example ==

<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "count" )
{
Message( "[#ffffff]<<<Odliczanie>>>>" );
NewTimer( "ClientMessageToAll", 1000, 1, "-> 3",28, 255, 11 );
NewTimer( "ClientMessageToAll", 2000, 1, "-> 2",24, 255, 241 );
NewTimer( "ClientMessageToAll", 3000, 1, "-> 1",249, 57, 56 );
NewTimer( "ClientMessageToAll", 4000, 1, "-----> START <------",1000, 1500, 300 );
}
}
</source>

=== Notes ===

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

== Related Functions ==

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

Scripting/Squirrel/Functions/NewTimer

2015-08-03T10:37:45Z

ProsuWANTED:

== Syntax ==

<pre>NewTimer( func, time, repeat, ...);</pre>

== Arguments ==

* ''function'' '''func''' - the function to call when the timer ends
* ''int'' '''time''' - the time before the function call
* ''int'' '''repeat''' - how many times to repeat the process (1 just to execute once)
* '''...''' - function (func) parameters

== Example ==

<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "count" )
{
Message( "[#ffffff]<<<Odliczanie>>>>" );
NewTimer( "ClientMessageToAll", 1000, 1, "-> 3",28, 255, 11 );
NewTimer( "ClientMessageToAll", 2000, 1, "-> 2",24, 255, 241 );
NewTimer( "ClientMessageToAll", 3000, 1, "-> 1",249, 57, 56 );
NewTimer( "ClientMessageToAll", 4000, 1, "-----> START <------",1000, 1500, 300 );
}
}
</source>

=== Notes ===

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Vehicle.Fix

2015-08-03T08:26:18Z

ProsuWANTED:

This function will fix the vehicle.

== Syntax ==

<pre>vehicle.Fix()</pre>

== Arguments ==

'''N/A'''

== Example ==

<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "fix" )
{
local veh = player.Vehicle;

if ( veh ) {

MessagePlayer( "Your vehicle has been fixed.", player );
veh.Fix();
}

else MessagePlayer( "You must be in the vehicle you want to fix.", player );
}
}
</source>

=== Notes ===

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

== Related Functions ==

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

Scripting/Squirrel/Functions/NewTimer

2015-08-02T17:32:22Z

ProsuWANTED:

== Syntax ==

<pre>NewTimer( func, time, 1, ...);</pre>

== Arguments ==

* ''function'' '''func''' - the function to call when the timer ends
* ''int'' '''time''' - the time before the function call
* '''...''' - function (func) parameters

== Example ==

<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "count" )
{
Message( "[#ffffff]<<<Odliczanie>>>>" );
NewTimer( "ClientMessageToAll", 1000, 1, "-> 3",28, 255, 11 );
NewTimer( "ClientMessageToAll", 2000, 1, "-> 2",24, 255, 241 );
NewTimer( "ClientMessageToAll", 3000, 1, "-> 1",249, 57, 56 );
NewTimer( "ClientMessageToAll", 4000, 1, "-----> START <------",1000, 1500, 300 );
}
}
</source>

=== Notes ===

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

== Related Functions ==

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

Category:Deprecated

2015-08-02T15:41:03Z

ProsuWANTED: Created page with "These functions are deprecated and wont be used in next versions of VC:MP."

These functions are deprecated and wont be used in next versions of VC:MP.

Scripting/Squirrel/Functions/GetWeaponDataValue

2015-08-02T11:14:15Z

ProsuWANTED:

This function will return a data value of a weapon. (damage, range, etc)

== Syntax ==

<pre>GetWeaponDataValue( weaponID , fieldID )</pre>

== Arguments ==

* ''int'' '''weaponID''' - model ID of weapon
* ''int'' '''fieldID''' - [[WeaponDataValue|field ID]] of data you want to get

== Example ==

The following example will change stubby shotgun's range to minigun's one.
<source lang=squirrel>
function onScriptLoad()
{
SetWeaponDataValue( 21, 2, GetWeaponDataValue( 33, 2 ) );
}
</source>

=== Notes ===

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

== Related Functions ==

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

Scripting/Squirrel/Functions

2015-08-02T09:26:12Z

ProsuWANTED:

== 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}}

== Sphere Functions ==
{{Scripting/Squirrel/Functions/Sphere Functions}}

== Sprite Functions ==
{{Scripting/Squirrel/Functions/Sprite Functions}}

== Textdraw Functions ==
{{Scripting/Squirrel/Functions/Textdraw 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}}

Template:Scripting/Squirrel/Functions/Deprecated

2015-08-02T09:25:49Z

ProsuWANTED:

* [[Scripting/Squirrel/Functions/GetTime|GetTime]]
* [[Scripting/Squirrel/Functions/GetFullTime|GetFullTime]]
* [[Scripting/Squirrel/Functions/SetWeatherLock|SetWeatherLock]]
* [[Scripting/Squirrel/Functions/GetWeatherLock|GetWeatherLock]]

GetFullTime

2015-08-02T09:23:55Z

ProsuWANTED: Redirected page to Scripting/Squirrel/Functions/GetFullTime

#REDIRECT [[Scripting/Squirrel/Functions/GetFullTime]]

Scripting/Squirrel/Functions/GetFullTime

2015-08-02T09:23:29Z

ProsuWANTED: Created page with "{{Scripting/Deprecated}} This function will get the time and the date. == Syntax == <pre>GetFullTime()</pre> == Arguments == '''N/A''' == Return value == * ''string'' ''..."

{{Scripting/Deprecated}}
This function will get the time and the date.

== Syntax ==

<pre>GetFullTime()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''string'' '''time''' - The time and the date

== Example ==

<source language="squirrel">
function onPlayerCommand( plr, cmd, text )
{
if ( cmd == "date" )
{
ClientMessage( "The time is now: " + GetFullTime(), plr, 135, 210, 40 );
}

return 1;
}
</source>

=== Notes ===

== Related Functions ==

{{Scripting/Squirrel/Functions/Deprecated}}

GetTime

2015-08-02T09:21:00Z

ProsuWANTED: Redirected page to Scripting/Squirrel/Functions/GetTime

#REDIRECT [[Scripting/Squirrel/Functions/GetTime]]

Scripting/Squirrel/Functions/GetTime

2015-08-02T09:20:44Z

ProsuWANTED: Created page with "{{Scripting/Deprecated}} GetTime is to used to find out what is the current time of your server. == Syntax == <pre>GetTime()</pre> == Arguments == '''N/A''' == Return Val..."

{{Scripting/Deprecated}}
GetTime is to used to find out what is the current time of your server.

== Syntax ==

<pre>GetTime()</pre>

== Arguments ==

'''N/A'''

== Return Value ==

*''int'' '''time''' - the time

== Example ==

{{Scripting/Needs_Example}}

=== Notes ===

== Related Functions ==

{{Scripting/Squirrel/Functions/Deprecated}}

Scripting/Squirrel/Functions/SetWastedSettings

2015-08-01T22:08:40Z

ProsuWANTED:

This function will set the appearence of the wasted screen when a player dies.

== Syntax ==

<pre>SetWastedSettings( deathTime, fadeTime, fadeInSpeed, fadeOutSpeed, colour, corpseFadeDelay, corpseFadeTime )</pre>

== Arguments ==

* ''int'' '''deathTime''' - The death time
* ''int'' '''fadeTime''' - The fade time
* ''float'' '''fadeInSpeed''' - The fade in speed
* ''float'' '''fadeOutSpeed''' - The fade out speed
* [[Scripting/Squirrel/Functions/cRGB|''cRGB'']] '''colour''' - The colour
* ''int'' '''corpseFadeDelay'''
* ''int'' '''corpseFadeTime'''

== Example ==

The following example disables the wasted screen
<source lang="squirrel">
function onScriptLoad()
{
SetWastedSettings( 0, 0, 0, 0, RGB(0,0,0), 0, 0)
}
</source>

=== Notes ===

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Spawn_and_Wasted_Screen_Functions}}

GetTime

2015-08-01T22:00:38Z

ProsuWANTED:

Template:Scripting/Squirrel/Functions/Deprecated

2015-08-01T21:59:40Z

ProsuWANTED: Created page with "* GetTime * GetFullTime * SetWeatherLock * GetWeatherLock"

* [[GetTime]]
* [[GetFullTime]]
* [[Scripting/Squirrel/Functions/SetWeatherLock|SetWeatherLock]]
* [[Scripting/Squirrel/Functions/GetWeatherLock|GetWeatherLock]]

Scripting/Squirrel/Functions/GetWorldBounds

2015-08-01T15:36:51Z

ProsuWANTED:

This function will get the world bounds of the server.

== Syntax ==

<pre>GetWorldBounds()</pre>

== Arguments ==

'''N/A'''

== Return value ==

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

== Example ==

{{Scripting/Needs_Example}}

=== Notes ===

== Related Functions ==

{{Scripting/Squirrel/Functions/Game_Functions}}

Scripting/Squirrel/Functions/GetDistrictName

2015-08-01T15:18:34Z

ProsuWANTED: Added example.

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 ===

== Related Functions ==

{{Scripting/Squirrel/Functions/Game_Functions}}

GetTime

2015-08-01T14:56:19Z

ProsuWANTED:

Scripting/Squirrel/Functions/GetFlyingCars

2015-08-01T14:55:56Z

ProsuWANTED:

This function will return the current status of the flying cars ability.
== Syntax ==

<pre>GetFlyingCars()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''bool'' '''toggled'''

== Example ==

{{Scripting/Needs_Example}}

=== Notes ===

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/BanIP

2015-08-01T13:45:15Z

ProsuWANTED:

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 == "banip" )
{
BanIP( text );
MessagePlayer( "You have banned IP: " + text, player );
}
}
</source>

=== Notes ===

Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] and function [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Administrative_Functions}}

GetTime

2015-08-01T13:42:52Z

ProsuWANTED:

{{Scripting/Deprecated}}
GetTime is to used to find out what is the current time of your server.

== Syntax ==

<pre>GetTime()</pre>

== Arguments ==

'''N/A'''

== Return ==

*''int'' '''time''' - the time

== Example ==

{{Scripting/Needs_Example}}

=== Notes ===

GetTime

2015-08-01T13:41:18Z

ProsuWANTED:

{{Scripting/Deprecated}}
GetTime is to used to find out what is the current time of your server.

== Arguments ==

'''N/A'''

== Return ==

*''int'' '''time''' - the time

== Example ==

{{Scripting/Needs_Example}}

=== Notes ===

GetTime

2015-08-01T13:41:00Z

ProsuWANTED:

{{Scripting/Deprecated}}
GetTime is to used to find out what is the current time of your server.

== Arguments ==
'''N/A'''

== Return ==
*''int'' '''time''' - the time

== Example ==

{{Scripting/Needs_Example}}

=== Notes ===

Scripting/Squirrel/Functions/Player.Ping

2015-07-31T22:31:58Z

ProsuWANTED:

Use this function to get a player's ping. '''(Read only)'''

== Syntax ==

<pre>int player.Ping
</pre>

== Example ==
<source lang=squirrel>
function OnPlayerCommand(player, cmd, text)
{
if ( cmd == "ping" )
{
MessagePlayer("Your Ping: " + player.Ping, player);
}
}
</source>

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

Scripting/Squirrel/Functions/GetPlayerIDFromName

2015-07-31T22:26:16Z

ProsuWANTED:

== Syntax ==

<pre>GetPlayerIDFromName( string name )</pre>

== Arguments ==

* ''string'' '''name''' - Player Name

== Example ==

The Following example will tell a player's ID.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "id" )
{
if ( text ) // If player provides text.
{
if ( !IsNum( text )) // if text is not a integer/number.
{
local plr = FindPlayer( text ) // We Find other players by FindPlayer( playername or id )
if ( plr ) // If player is available/online
{
MessagePlayer( " " + plr.Name + " is online. ( ID : " + GetPlayerIDFromName( plr.Name ) + " ) ", player ); // Messages the ID of the plr.
} else MessagePlayer( "Player not online", player ); // Else messages player not online
}
else MessagePlayer( "text must be a name instead of IDs or Numbers", player );
}
else MessagePlayer( "/id < playername >", player ); // if ( text ) is not provided.
}
}
</source>

=== Notes ===

Calls [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]], [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]] & [[Scripting/Squirrel/Functions/Player.Name|Player.Name]] were used in this example. More info about them in the corresponding pages.

Scripting/Squirrel/Functions/PlaySound

2015-07-31T18:37:08Z

ProsuWANTED:

This function will play a sound at a certain position.

== Syntax ==

1
<pre>PlaySound( world, sound, pos )</pre>
2
<pre>PlaySound( world, sound, x, y, z )</pre>

== Arguments ==

* ''int'' '''world''' - The world ID
* ''int'' '''sound''' - The sound ID
* ''[[Scripting/Squirrel/Functions/Vector|Vector]]'' '''pos''' - The position of the sound to be played at

== Example ==
<source lang=squirrel>
function OnPlayerCommand( player,cmd , text )
{
if ( cmd == "sound" )
{
PlaySound( player.UniqueWorld , 30 , player.Pos );
}
}
</source>

=== Notes ===
Use [[Scripting/Squirrel/Functions/Player.UniqueWorld|Player.UniqueWorld]] to play sound for a specific player.

== Related Functions ==

{{Scripting/Squirrel/Functions/Game_Functions}}

Scripting/Squirrel/Functions/CreateCheckpoint

2015-07-31T14:17:29Z

ProsuWANTED: Oops.

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

== Syntax ==

<pre>CreateCheckpoint(player, world, 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
*[[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, 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/CreateCheckpoint

2015-07-31T14:16:24Z

ProsuWANTED: Fixed alot of things.

ID Reference

2015-07-02T20:19:44Z

ProsuWANTED:

{{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" | ID References
|-
| style="padding:10px;" |
Check out all available codes and IDs of game texts, vehicles, skins, weapons, etc. because you may need them when you are working on your server, or just playing in one ! :)

</div>
|-
|}

{| 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:10px;" |
*[[Game Text Codes and Styles]]
*[[Explosion Types]]
*[[Map Icons]]
*[[Skins]]
*[[Animations]]
*[[Sounds]]
*[[Weather]]
*[[Vehicles]]
*[[Weapons]]
*[[Pickup Models]]
*[[Car Colors]]
*[[Team Colors]]
*Interiors
</div>
|}

Scripting/Squirrel/Functions/cRGB

2015-07-02T16:49:10Z

ProsuWANTED: Fixed arguments.

Creates an instance and returns the pointer.

== Syntax ==

<pre>RGB( r, g, b )</pre>

== Arguments ==

* ''int'' (''byte'') '''r''' - Red
* ''int'' (''byte'') '''g''' - Green
* ''int'' (''byte'') '''b''' - Blue

== Example ==

<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if( cmd == "red" )
{
MessagePlayer("You're now red!", player);
player.Color = RGB(255, 0, 0);
}
else if ( cmd == "green" )
{
MessagePlayer("You're now green!", player);
player.Color = RGB(0, 255, 0);
}
else if ( cmd == "blue" )
{
MessagePlayer("You're now blue!", player);
player.Color = RGB(0, 0, 255);
}
}
</source>
=== Notes ===

Call [[onPlayerCommand]] was used in this example. More info in the page.

== Related Functions ==

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

Scripting/Squirrel/Functions/cRGB

2015-07-02T16:45:09Z

ProsuWANTED: Changed Color to RGB.

Creates an instance and returns the pointer.

== Syntax ==

<pre>RGB( r, g, b )</pre>

== Arguments ==

* ''int'' '''r''' - Red
* ''int'' '''g''' - Green
* ''int'' '''b''' - Blue

== Example ==

<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if( cmd == "red" )
{
MessagePlayer("You're now red!", player);
player.Color = RGB(255, 0, 0);
}
else if ( cmd == "green" )
{
MessagePlayer("You're now green!", player);
player.Color = RGB(0, 255, 0);
}
else if ( cmd == "blue" )
{
MessagePlayer("You're now blue!", player);
player.Color = RGB(0, 0, 255);
}
}
</source>
=== Notes ===

Call [[onPlayerCommand]] was used in this example. More info in the page.

== Related Functions ==

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

Scripting/Squirrel/Functions/cRGB

2015-07-02T16:40:50Z

ProsuWANTED: Uppercase fix & better example.

Creates an instance and returns the pointer.

== Syntax ==

<pre>RGB( r, g, b )</pre>

== Arguments ==

* ''int'' '''r''' - Red
* ''int'' '''g''' - Green
* ''int'' '''b''' - Blue

== Example ==

<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if( cmd == "red" )
{
MessagePlayer("You're now red!", player);
player.Color = Color(255, 0, 0);
}
else if ( cmd == "green" )
{
MessagePlayer("You're now green!", player);
player.Color = Color(0, 255, 0);
}
else if ( cmd == "blue" )
{
MessagePlayer("You're now blue!", player);
player.Color = Color(0, 0, 255);
}
}
</source>
=== Notes ===

Call [[onPlayerCommand]] was used in this example. More info in the page.

== Related Functions ==

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

Scripting/Squirrel/Functions/Vector

2015-07-02T16:32:41Z

ProsuWANTED: Uppercase fix.

This function will teleport to the player to any location.

== Syntax ==

<pre>Vector( x, y, z )</pre>

== Arguments ==

* ''float'' '''x''' - X coordinate
* ''float'' '''x''' - Y coordinate
* ''float'' '''y''' - Z coordinate

== Functions ==
<pre>Length()</pre>
<pre>Distance( vector )</pre>
<pre>Dot( vector )</pre>
== Example ==

In the following example the player will teleport to the coordinates represented in '''X''', '''Y''', '''Z'''.
<source lang=squirrel>
player.Pos = Vector( 190.12, -122.45, 455.32 );
</source>

=== Notes ===

[[Scripting/Squirrel/Functions/Player.Pos|Player.Pos]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

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

OnPlayerChat

2015-07-02T16:30:46Z

ProsuWANTED:

__NOTOC__
This is called when a player uses a command.

== Syntax ==

<pre>function onPlayerChat( player, message )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|Player]] '''player''' - The player.
* ''string'' '''message''' - This is the message that player sent.

== Example ==

This example command outputs the player messages.

<source lang=squirrel>
function onPlayerChat( player, message )
{
print("Player:"+player.Name+" Says:"+message);
}
</source>

=== Notes ===

The function print and call [[onPlayerChat]] were used in this example. More info about them in the corresponding pages.

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

OnPlayerDeath

2015-07-02T14:37:24Z

ProsuWANTED:

This is called when a player dies. e.g.: drowned or self-kill.

== Syntax ==

<pre>function onPlayerDeath( player, reason )</pre>

== Arguments ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that died
* ''int'' '''reason''' - [[OnPlayerDeath#Death_Reasons|Death reason]]

=== Death Reasons ===

* '''''Death from falling''''' - 44
* '''''Death from an explosion''''' - 41
* '''''Death from drowning''''' - 43
* '''''Death from dying in a car''''' - 39
* '''''Suicide''''' - 70

== Example ==

<source lang="squirrel">
function onPlayerDeath( player, reason )
{
switch (reason)
{
case 44:
{
Message(player.Name + " fell down and died.");
break;
}
case 41:
{
Message(player.Name + " exploded to bits!");
break;
}
case 43:
{
Message(player.Name + " drowned to death.");
break;
}
case 39:
{
Message(player.Name + " died in a car accident.");
break;
}
case 70:
{
Message(player.Name + " suicided.");
break;
}
}
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Message|Message]] and [[Scripting/Squirrel/Functions/Player.Name|Player.Name]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}

OnPlayerCommand

2015-07-02T14:32:46Z

ProsuWANTED: Fixed arguments.

__NOTOC__
This is called when a player uses a command.

== Syntax ==

<pre>function onPlayerCommand( player, cmd, parameters )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that use command.
* ''string'' '''cmd''' - This is the command that player used.
* ''string'' '''parameters''' - This is the list of the parameters as a string.

== Example ==

This example command heal the player if they type '''/heal'''.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "heal" )
{
if ( player.Health == 100 ) PrivMessage( player, "You have the health to maximum.");
else
{
PrivMessage( player, "You healed successfully.");
player.Health = 100;
}
}
</source>

=== Notes ===

The function [[PrivMessage]] and call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

OnPlayerDeath

2015-07-02T14:27:30Z

ProsuWANTED: Updated death reasons and example.

This is called when a player dies. e.g.: drowned or self-kill.

== Syntax ==

<pre>function onPlayerDeath( player, reason )</pre>

== Arguments ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that died
* ''int'' '''reason''' - [[OnPlayerDeath#Death_Reasons|Death reason]]

=== Death Reasons ===

* '''''Death from falling''''' - 44
* '''''Death from an explosion''''' - 41
* '''''Death from drowning''''' - 43
* '''''Death from dying in a car''''' - 39
* '''''Suicide''''' - 70

== Example ==

<source lang="squirrel">
function onPlayerDeath( player, reason )
{
Message(reason.tostring());
switch (reason)
{
case 44:
{
Message(player.Name + " fell down and died.");
break;
}
case 41:
{
Message(player.Name + " exploded to bits!");
break;
}
case 43:
{
Message(player.Name + " drowned to death.");
break;
}
case 39:
{
Message(player.Name + " died in a car accident.");
break;
}
case 70:
{
Message(player.Name + " suicided.");
break;
}
}
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Message|Message]] and [[Scripting/Squirrel/Functions/Player.Name|Player.Name]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}

Scripting/Squirrel/Functions/CreateMarker

2015-07-02T13:23:41Z

ProsuWANTED: Added the ID link and fixed related functions.

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 );
}
</source>
=== Notes ===
Call [[onPlayerJoin]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Game_Functions}}