Vice City Multiplayer - User contributions [en]

OnSphereEntered

2017-08-07T15:56:55Z

Decent 946:

This is called when a player enters any sphere.

== Syntax ==
function OnSphereEntered( player, sphere )

== Parameters ==
* ''Player'' Who enteres into the sphere.
* ''Sphere'' The Sphere in which player entered.

== Example ==
<source lang="squirrel">
function onSphereEntered( player, sphere )
{
MessagePlayer("You've entered in a sphere! ID: " + sphere.ID , player );
}
</source>

== Related Functions ==

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

SetWhiteScanLines

2017-08-04T19:48:42Z

Decent 946:

This function is used to set white scan lines for a specific player.

== Syntax ==

<pre>SetWhiteScanLines( player, true );
SetWhiteScanLines( player, false );</pre>

== Parameters ==
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] - ''Player'' to set whitescanlines for.
* ''bool'' - true/false.

== Example ==
In this example, we are going to set white scan lines when a player joins and remove them when the player spawns.

<source lang = squirrel>
function onPlayerJoin( player )
{
SetWhiteScanLines( player, true );
}

function onPlayerSpawn( player )
{
SetWhiteScanLines( player, false );
}
</source>

== Notes ==
call [[onPlayerJoin]] and [[onPlayerSpawn]] were used in this example.

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

SetGreenScanLines

2017-08-04T19:44:45Z

Decent 946:

This function is used to set green scan lines for the specific player. In single player when we enter the elavator of bank-2 we see these scanlines.

== Syntax ==

<pre>SetGreenScanLines( player, true ); and
SetGreenScanLines( player, false );</pre>

== Parameters ==
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] - ''Player'' to set greenscanlines for.
* ''bool'' - true/false.

== Example ==
In this example, we are going to set green scan lines when a player joins and remove them when the player spawns.

<source lang = squirrel>
function onPlayerJoin( player )
{
SetGreenScanLines( player, true );
}

function onPlayerSpawn( player )
{
SetGreenScanLines( player, false );
}
</source>

== Notes ==
call [[onPlayerJoin]] and [[onPlayerSpawn]] were used in this example.

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

SetCinematicBorder

2017-08-04T19:40:20Z

Decent 946:

This function is used to set cinematic borders for the specific player.

== Syntax ==

<pre>SetCinematicBorder( player, true );
SetCinematicBorder( player, false );</pre>

== Parameters ==
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] - ''Player'' to set borders for.
* ''bool'' - true/false.

== Example ==
In this example, we are going to set cinematic borders when a player joins and remove them when the player spawns.

<source lang = squirrel>
function onPlayerJoin( player )
{
SetCinematicBorder( player, true );
}

function onPlayerSpawn( player )
{
SetCinematicBorder( player, false );
}
</source>

== Notes ==
call [[onPlayerJoin]] and [[onPlayerSpawn]] were used in this example.

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

OnPlayerCommand

2017-08-04T19:28:24Z

Decent 946: /* Notes */

__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]] and functions [[Scripting/Squirrel/Functions/PrivMessage|PrivMessage]] + [[Scripting/Squirrel/Functions/Player.Health|player.Health]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.Typing

2017-08-04T19:22:24Z

Decent 946: /* Result */

This function will inform you whether a player is typing or not.

-> This function is triggered when a player starts typing.

== Syntax ==
player.Typing

player.Typing = true;

player.Typing = false;

== Result ==
Bool - true or false.

== Example ==
In this Example, We are going to check if the specified player is typing or not. it will either return as true or false. Where true means yes and false means not.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "istyping" )
{
if ( text == null ) PrivMessage( player, "SYNTAX: /istyping < player ID >" );
else if ( !IsNum(text) ) PrivMessage( player, "Error - Please Sepcify player's ID" ); //ID selects the distnict player.
else
{
local plr = FindPlayer( text.tointeger() );

if ( !plr ) PrivMessage( player, "No such player..." );
else
{
MessagePlayer( "Is "+plr+" typing: "+plr.Typing, player ); // true = yes & false = no.
}
}
}

}

</source>

== Notes ==
Call [[onPlayerCommand]], functions [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]], [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and [[Scripting/Squirrel/Functions/MessagePlayer|''MessagePlayer'']] were used in this example

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

Scripting/Squirrel/Functions/Player.Typing

2017-08-04T19:22:04Z

Decent 946: /* Syntax */

This function will inform you whether a player is typing or not.

-> This function is triggered when a player starts typing.

== Syntax ==
player.Typing

player.Typing = true;

player.Typing = false;

== Result ==
Toggle - true or false.

== Example ==
In this Example, We are going to check if the specified player is typing or not. it will either return as true or false. Where true means yes and false means not.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "istyping" )
{
if ( text == null ) PrivMessage( player, "SYNTAX: /istyping < player ID >" );
else if ( !IsNum(text) ) PrivMessage( player, "Error - Please Sepcify player's ID" ); //ID selects the distnict player.
else
{
local plr = FindPlayer( text.tointeger() );

if ( !plr ) PrivMessage( player, "No such player..." );
else
{
MessagePlayer( "Is "+plr+" typing: "+plr.Typing, player ); // true = yes & false = no.
}
}
}

}

</source>

== Notes ==
Call [[onPlayerCommand]], functions [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]], [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and [[Scripting/Squirrel/Functions/MessagePlayer|''MessagePlayer'']] were used in this example

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

Scripting/Squirrel/Functions/Player.Typing

2017-08-04T19:21:40Z

Decent 946: /* Syntax */

This function will inform you whether a player is typing or not.

-> This function is triggered when a player starts typing.

== Syntax ==
player.Typing
player.Typing = true;
player.Typing = false;

== Result ==
Toggle - true or false.

== Example ==
In this Example, We are going to check if the specified player is typing or not. it will either return as true or false. Where true means yes and false means not.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "istyping" )
{
if ( text == null ) PrivMessage( player, "SYNTAX: /istyping < player ID >" );
else if ( !IsNum(text) ) PrivMessage( player, "Error - Please Sepcify player's ID" ); //ID selects the distnict player.
else
{
local plr = FindPlayer( text.tointeger() );

if ( !plr ) PrivMessage( player, "No such player..." );
else
{
MessagePlayer( "Is "+plr+" typing: "+plr.Typing, player ); // true = yes & false = no.
}
}
}

}

</source>

== Notes ==
Call [[onPlayerCommand]], functions [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]], [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and [[Scripting/Squirrel/Functions/MessagePlayer|''MessagePlayer'']] were used in this example

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

Scripting/Squirrel/Functions/Player.GameKeys

2017-08-04T19:21:06Z

Decent 946: /* Result */

This function will inform you the ID(s) of they keys that player has pressed at the current moment.

-> This function is triggered whenever a player presses any key of keyboard.

--> It can also be used to check ID of any key of the keyboard in vcmp.

Note: Each keyborad key has its different gamekey ID.

== Syntax ==
player.GameKeys
player.GameKeys = ID(s)

== Parameterand result ==
ID(s) of the Key pressed.

== Example ==
In this Example, We are going to check Which key(s) are being pressed by the specified user at the current moment ( at the time of use of command ).

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "getkeys" )
{
if ( text == null ) PrivMessage( player, "SYNTAX: /getkeys < player ID >" );
else if ( !IsNum(text) ) PrivMessage( player, "Error - Please Sepcify player's ID" ); //ID selects the distnict player.
else
{
local plr = FindPlayer( text.tointeger() );

if ( !plr ) PrivMessage( player, "No such player..." );
else
{
MessagePlayer( "The ID(s) of the keys "+plr+" is pressing: "+plr.GameKeys, player );
}
}
}

}

</source>

== Notes ==
Call [[onPlayerCommand]], functions [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]], [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and [[Scripting/Squirrel/Functions/MessagePlayer|''MessagePlayer'']] were used in this example

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

Scripting/Squirrel/Functions/Player.GameKeys

2017-08-04T19:20:27Z

Decent 946: /* Syntax */

This function will inform you the ID(s) of they keys that player has pressed at the current moment.

-> This function is triggered whenever a player presses any key of keyboard.

--> It can also be used to check ID of any key of the keyboard in vcmp.

Note: Each keyborad key has its different gamekey ID.

== Syntax ==
player.GameKeys
player.GameKeys = ID(s)

== Result ==
ID(s) of the Key pressed.

== Example ==
In this Example, We are going to check Which key(s) are being pressed by the specified user at the current moment ( at the time of use of command ).

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "getkeys" )
{
if ( text == null ) PrivMessage( player, "SYNTAX: /getkeys < player ID >" );
else if ( !IsNum(text) ) PrivMessage( player, "Error - Please Sepcify player's ID" ); //ID selects the distnict player.
else
{
local plr = FindPlayer( text.tointeger() );

if ( !plr ) PrivMessage( player, "No such player..." );
else
{
MessagePlayer( "The ID(s) of the keys "+plr+" is pressing: "+plr.GameKeys, player );
}
}
}

}

</source>

== Notes ==
Call [[onPlayerCommand]], functions [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]], [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and [[Scripting/Squirrel/Functions/MessagePlayer|''MessagePlayer'']] were used in this example

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

Scripting/Squirrel/Functions/Player.GameKeys

2017-08-03T19:42:57Z

Decent 946: /* Result */

This function will inform you the ID(s) of they keys that player has pressed at the current moment.

-> This function is triggered whenever a player presses any key of keyboard.

--> It can also be used to check ID of any key of the keyboard in vcmp.

Note: Each keyborad key has its different gamekey ID.

== Syntax ==
player.GameKeys

== Result ==
ID(s) of the Key pressed.

== Example ==
In this Example, We are going to check Which key(s) are being pressed by the specified user at the current moment ( at the time of use of command ).

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "getkeys" )
{
if ( text == null ) PrivMessage( player, "SYNTAX: /getkeys < player ID >" );
else if ( !IsNum(text) ) PrivMessage( player, "Error - Please Sepcify player's ID" ); //ID selects the distnict player.
else
{
local plr = FindPlayer( text.tointeger() );

if ( !plr ) PrivMessage( player, "No such player..." );
else
{
MessagePlayer( "The ID(s) of the keys "+plr+" is pressing: "+plr.GameKeys, player );
}
}
}

}

</source>

== Notes ==
Call [[onPlayerCommand]], functions [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]], [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and [[Scripting/Squirrel/Functions/MessagePlayer|''MessagePlayer'']] were used in this example

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

Scripting/Squirrel/Functions/Player.Typing

2017-08-03T19:42:27Z

Decent 946:

This function will inform you whether a player is typing or not.

-> This function is triggered when a player starts typing.

== Syntax ==
player.Typing

== Result ==
Toggle - true or false.

== Example ==
In this Example, We are going to check if the specified player is typing or not. it will either return as true or false. Where true means yes and false means not.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "istyping" )
{
if ( text == null ) PrivMessage( player, "SYNTAX: /istyping < player ID >" );
else if ( !IsNum(text) ) PrivMessage( player, "Error - Please Sepcify player's ID" ); //ID selects the distnict player.
else
{
local plr = FindPlayer( text.tointeger() );

if ( !plr ) PrivMessage( player, "No such player..." );
else
{
MessagePlayer( "Is "+plr+" typing: "+plr.Typing, player ); // true = yes & false = no.
}
}
}

}

</source>

== Notes ==
Call [[onPlayerCommand]], functions [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]], [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and [[Scripting/Squirrel/Functions/MessagePlayer|''MessagePlayer'']] were used in this example

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

Scripting/Squirrel/Functions/Player.GameKeys

2017-08-03T19:40:11Z

Decent 946: Created page with "This function will inform you the ID(s) of they keys that player has pressed at the current moment. -> This function is triggered whenever a player presses any key of keyboar..."

This function will inform you the ID(s) of they keys that player has pressed at the current moment.

-> This function is triggered whenever a player presses any key of keyboard.

--> It can also be used to check ID of any key of the keyboard in vcmp.

Note: Each keyborad key has its different gamekey ID.

== Syntax ==
player.GameKeys

== Result ==
ID of the Key pressed.

== Example ==
In this Example, We are going to check Which key(s) are being pressed by the specified user at the current moment ( at the time of use of command ).

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "getkeys" )
{
if ( text == null ) PrivMessage( player, "SYNTAX: /getkeys < player ID >" );
else if ( !IsNum(text) ) PrivMessage( player, "Error - Please Sepcify player's ID" ); //ID selects the distnict player.
else
{
local plr = FindPlayer( text.tointeger() );

if ( !plr ) PrivMessage( player, "No such player..." );
else
{
MessagePlayer( "The ID(s) of the keys "+plr+" is pressing: "+plr.GameKeys, player );
}
}
}

}

</source>

== Notes ==
Call [[onPlayerCommand]], functions [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]], [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and [[Scripting/Squirrel/Functions/MessagePlayer|''MessagePlayer'']] were used in this example

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

Scripting/Squirrel/Functions/Player.Typing

2017-08-03T19:19:46Z

Decent 946: Created page with "__NOTOC__ This function will inform you whether a player is typing or not. -> This function is triggered when a player starts typing. == Syntax == player.Typing == Result =..."

__NOTOC__
This function will inform you whether a player is typing or not.

-> This function is triggered when a player starts typing.

== Syntax ==
player.Typing

== Result ==
Toggle - true or false.

== Example ==
In this Example, We are going to check if the specified player is typing or not. it will either return as true or false. Where true means yes and false means not.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "istyping" )
{
if ( text == null ) PrivMessage( player, "SYNTAX: /istyping < player ID >" );
else if ( !IsNum(text) ) PrivMessage( player, "Error - Please Sepcify player's ID" ); //ID selects the distnict player.
else
{
local plr = FindPlayer( text.tointeger() );

if ( !plr ) PrivMessage( player, "No such player..." );
else
{
MessagePlayer( "Is "+plr+" typing: "+plr.Typing, player ); // true = yes & false = no.
}
}
}

}

</source>

== Notes ==
Call [[onPlayerCommand]], functions [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]], [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and [[Scripting/Squirrel/Functions/MessagePlayer|''MessagePlayer'']] were used in this example

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

Scripting/Squirrel/Functions/Checkpoint.StreamedToPlayer

2017-08-03T18:40:17Z

Decent 946: /* Example */

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, false, 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}}
[[Category:Scripting/Squirrel/Functions/Checkpoint_Functions]]

Scripting/Squirrel/Functions/Checkpoint.Remove

2017-08-03T17:47:15Z

Decent 946: /* Example */

This function removes a checkpoint.

== Syntax ==

<pre>Checkpoint.Remove()</pre>

== Example ==

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

function onScriptUnload()
{
CheckpointGreen.Remove();
CheckpointWhite.Remove();
return 1;
}
</source>

=== Notes ===

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Checkpoint.Radius

2017-08-03T17:46:46Z

Decent 946: /* Example */

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, false, 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}}
[[Category:Scripting/Squirrel/Functions/Checkpoint_Functions]]

Scripting/Squirrel/Functions/Checkpoint.Pos

2017-08-03T17:45:54Z

Decent 946: /* Example */

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, false, 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}}
[[Category:Scripting/Squirrel/Functions/Checkpoint_Functions]]

Scripting/Squirrel/Functions/Checkpoint.Owner

2017-08-03T17:08:12Z

Decent 946:

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, false, player.Pos, RGB(255, 0, 255), 2);
ClientMessage("[#ffffff]Checkpoint Owner: " + CheckpointTest.Owner,player,255,255,255);
}
return 1;
}
</source>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Checkpoint.Owner

2017-08-03T17:06:42Z

Decent 946:

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, false, player.Pos, RGB(255, 0, 255), 2);
ClientMessage("[#ffffff]Checkpoint Owner: " + CheckpointTest.Owner,player,255,255,255);
}
return 1;
}
</source>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Checkpoint.ID

2017-08-03T17:05:43Z

Decent 946:

This function gets the checkpoint ID.

== Syntax ==

<pre>Checkpoint.ID</pre>

== Example ==

<source lang="squirrel">
function onScriptLoad()
{
CheckpointGreen <- CreateCheckpoint( null, 0, false, Vector( -378.79, -537.962, 17.2832 ), RGB(255, 0, 255), 2);
CheckpointWhite <- CreateCheckpoint( null, 0, true, Vector( 876.45, 432.54, 12.34 ), RGB(255, 255, 255), 2);
print("CheckpointGreen ID: " + CheckpointGreen.ID);
print("CheckpointWhite ID: " + CheckpointWhite.ID);
return 1;
}
</source>

=== Notes ===

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

== Related Functions ==

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

Player.Skin

2017-04-02T11:06:30Z

Decent 946: /* Example */

This method can be used to get a player's skin or set to a desired one

== Syntax ==
=== Type 1 - Getting the current skin a player has ===
<source lang=squirrel>PlayerInstance.Skin</source>

'''Arguments'''
* None

'''Returns'''
* Integer - An integer representing the skin ID player is having

=== Type 2 - Setting a player's skin to desired one ===
<source lang=squirrel>PlayerInstance.Skin = skin</source>

'''Arguments'''
* ''integer'' '''skin id''' - The skin ID you would want to set for the player

== Example ==

The following snippet will tell the player what skin id he is using

<source lang=D>
function onPlayerCommand(player, command, arguments) {
if( command == "myskin" ) {
MessagePlayer( "Your skin ID is: " + player.Skin, player );
}
}
</source>

The following will set the player's skin to the ID given

<source lang=D>
function onPlayerCommand(player, command, arguments) {
if( command == "skin" ) {
if( !text ) return MessagePlayer( "Syntax: /skin [ID]", player );
else if( !IsNum( text ) ) return MessagePlayer( "Skin ID must be an integer", player );
else {
player.Skin = text.tointeger();
MessagePlayer( "Your skin ID is: " + player.Skin, player );
}
}
}
</source>

== Related Functions ==

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

OnPlayerActionChange

2016-03-18T22:50:29Z

Decent 946:

__NOTOC__
This function is triggered when a player changes his action or we can say move!. ( not animation ).

== Syntax ==

<pre>function onPlayerActionChange( player, oldAction, newAction )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who changes the action.
* '''oldAction''' - Players old Action.
* '''newAction''' - Players new Action.

== Example ==

In this example i have chosen action "Fire/Shoot", when a player will Fire/shoot, his weapon will be automatically removed for temporary reason. ( the player won't be disarmed ), until he is firing/shooting, he won't be able to use weapons. unless he changes his action. the player will also receive a message "you can't shoot in a RPG server.".

<source lang=squirrel>
function onPlayerActionChange( player, oldAction, newAction )
{
if ( newAction == 16 ) // 16 is the id of firing/shooting action.
{
player.SetWeapon( 0, 0 ); //sets weapon to 0. which is nothing.
PrivMessage( player, "you can't shoot in a RPG server. );
}
}
</source>

you must be wondering how to get actions id?. use this to get ids :)
<source lang=squirrel>
function onPlayerActionChange( player, oldAction, newAction )
{
if ( newAction ) // it will check if the player goes in new action.
{
PrivMessage( player, "your Current Actions ID: "+newAction ); // it will print the id of the action player is in.
}
}
</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and function [[Scripting/Squirrel/Functions/Player.SetWeapon|''SetWeapon'']] were used in this example.

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

OnPlayerCrouchChange

2016-03-18T22:34:09Z

Decent 946: Created page with "__NOTOC__ This Function is trigged when a player is crouching. == Syntax == <pre>function onPlayerCrouchChange( player, isCrouchingNow )</pre> == Parameters == * Scripti..."

__NOTOC__
This Function is trigged when a player is crouching.

== Syntax ==

<pre>function onPlayerCrouchChange( player, isCrouchingNow )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who changes the action.
* ''Bool'' '''isCrouchingNow''' - checks if the player is crouching.

== Example ==
In this example, Whenever the player Will crouch, he will receive a message that "you are crouching now".
<source lang=squirrel>
function onPlayerCrouchChange( player, isCrouchingNow )
{
if ( isCrouchingNow ) //checks if the player is crouching.
{
PrivMessage( player, " you are crouching right now." );
}
}
</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] was used in this example.

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

OnPlayerActionChange

2016-03-18T22:09:33Z

Decent 946: Created page with "__NOTOC__ This function is triggered when a player changes his action or we can say move!. ( not animation ). == Syntax == <pre>function onPlayerActionChange( player, oldAct..."

__NOTOC__
This function is triggered when a player changes his action or we can say move!. ( not animation ).

== Syntax ==

<pre>function onPlayerActionChange( player, oldAction, newAction )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who changes the action.
* '''oldAction''' - Players old Action.
* '''newAction''' - Players new Action.

== Example ==

In this example i have chosen action "crouch", when a player will crouch, his weapon will be automatically removed for temporary reason. ( the player won't be disarmed ), until he is crouching, he won't be able to use weapons. unless he changes his action. the player will also receive a message "you can't shoot while crouching".

<source lang=squirrel>
function onPlayerActionChange( player, oldAction, newAction )
{
if ( newAction == 16 ) // 16 is the id of crouching action.
{
player.SetWeapon( 0, 0 ); //sets weapon to 0. which is nothing.
PrivMessage( player, "you can't shoot while crouching" );
}
}
</source>

you must be wondering how to get actions id?. use this to get ids :)
<source lang=squirrel>
function onPlayerActionChange( player, oldAction, newAction )
{
if ( newAction ) // it will check if the player goes in new action.
{
PrivMessage( player, "your Current Actions ID: "+newAction ); // it will print the id of the action player is in.
}
}
</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and function [[Scripting/Squirrel/Functions/Player.SetWeapon|''SetWeapon'']] were used in this example.

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

Scripting/Squirrel/Functions/Bounds

2016-03-17T08:05:13Z

Decent 946:

This Data type will hold world boundaries. You will get this Data Type when you use the [[Scripting/Squirrel/Functions/GetWorldBounds|GetWorldBounds]] function

== Syntax ==

<pre>Bounds( MaxX, MinX, MaxY, MinY )</pre>

== Arguments ==

* '''MaxX''' - The max X coordination of the boundary.
* '''MinX''' - The minimum X coordination of the boundary.
* '''MaxY''' - The max Y coordination of the boundary.
* '''MinY''' - The minimum Y coordination of the boundary.

== Example ==

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

=== Notes ===

The function [[Scripting/Squirrel/Functions/GetWorldBounds|GetWorldBounds]] and call [[OnScriptLoad]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

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

OnPlayerGameKeysChange

2016-03-17T07:48:26Z

Decent 946: Created page with "__NOTOC__ This function detects the players "Game Key". for example: To move FORWARD we usually use "W" or "UP_ARROW" key. But since its a game key & its ID is "32768". It wil..."

__NOTOC__
This function detects the players "Game Key". for example: To move FORWARD we usually use "W" or "UP_ARROW" key. But since its a game key & its ID is "32768".
It will detect that the player is moving forward. No matter what key/button player has set to move forward. Even if the player set the key "X".

== Syntax ==

<pre>function onPlayerGameKeysChange( player, oldKey, newKey )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who changes the keys.
* '''old''' - Player's old key which was pressed before pressing the new one.
* '''new''' - Players new key. recently pressed key.

== Example ==

In This Example, When a player will move "FORWARD", player will receive a message "you are moving forward"...no matter what button player has set to move forward...
If "BACKWARDS", player will receive a message "you are moving backward"...no matter what button player has set to move backwards...
If "RIGHT", player will receive a message "you are moving to right side" ... no matter what button player has set to move right side...
and If "LEFT", player will receive a message "you are moving to left side "... no matter what button player has set to move left side...

<source lang=squirrel>
function onPlayerGameKeysChange( player, oldKey, newKey )
{
if ( newKey == 32768 ) // this is the id of FORWARD game key.
{
PrivMessage( player, "you are moving forward" );
}
else if ( newKey == 16384 ) // this is the id of BACKWARDS game key.
{
PrivMessage( player, "you are moving backward" );
}
else if ( newKey == 4096 ) // this is the id of RIGHT game key.
{
PrivMessage( player, "you are moving to right side" );
}
else if ( newKey == 8192 ) // this is the id of LEFT game key.
{
PrivMessage( player, "you are moving to left side" );
}
}
</source>
To Get The Keys ID use this.
<source lang=squirrel>

function onPlayerGameKeysChange( player, oldKey, newKey )
{
if ( newKey )
{
PrivMessage( player, "recently pressed key's ID: "+newKey );
}
}
</source>

here are some constants by Gudio.
<source lang=squirrel>
KEY_ONFOOT_FORWARD
KEY_ONFOOT_BACKWARD
KEY_ONFOOT_LEFT
KEY_ONFOOT_RIGHT
KEY_ONFOOT_JUMP
KEY_ONFOOT_CROUCH
KEY_ONFOOT_PUNCH
KEY_ONFOOT_AIM
KEY_ONFOOT_FIRE
KEY_ONFOOT_NEXTWEP
KEY_ONFOOT_PREVWEP

KEY_INCAR_FORWARD
KEY_INCAR_BACKWARD
KEY_INCAR_LEFT
KEY_INCAR_RIGHT
KEY_INCAR_LOOKLEFT
KEY_INCAR_LOOKRIGHT
KEY_INCAR_LEANUP
KEY_INCAR_LEANDOWN
</source>
=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] was used in this example

To know more about this function. visit [[http://forum.vc-mp.org/?topic=212.msg1122#msg1122|''here'']]

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

OnKeyDown

2016-03-16T18:33:38Z

Decent 946: Created page with "__NOTOC__ This function allows the server to inform the player, that he pressed the key and and the key works like a command. == Syntax == <pre>function onKeyDown( player, k..."

__NOTOC__
This function allows the server to inform the player, that he pressed the key and and the key works like a command.

== Syntax ==

<pre>function onKeyDown( player, key )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who presses the key.
* '''key''' - The key player presses.

== Example ==

In this function i have chosen key "ENTER". When a player will press the key/button 'enter' it will inform the server that the player pressed the key. And the server will perform the work like a Command.

<source lang=squirrel>
function onScriptLoad()
{
enter <- BindKey( true, 0x0D, 0, 0 ); // The Key Code of enter is 0x0D . we will use bindkey function to set the key. And it is required.
}

function onKeyDown( player, key )
{
if ( key == enter )
{
PrivMessage( player, "you Successfully pressed the Key Enter." );
}
}
</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and function [[Scripting/Squirrel/Functions/BindKey|''BindKey'']] were used in this example.

you can Find the key codes [[https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx|''here'']]

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

Scripting/Squirrel/Functions/Sphere.ID

2016-03-15T17:00:35Z

Decent 946:

allows you to check Sphere's ID.

== Syntax ==

<pre>Sphere.ID</pre>

== Example ==

<source lang=D>
function onSphereEntered( player, Sphere )
{
MessagePlayer( "you have entered in a Sphere, Sphere's ID "+ Sphere.ID, player );
}
</source>
=== Notes ===
Call [[onSphereEntered]] was used in this example..

== Related Functions ==

{{Scripting/Squirrel/Functions/Sphere_Functions}}

Scripting/Squirrel/Functions/Sphere.Owner

2016-03-15T17:00:11Z

Decent 946:

allows you to check Sphere's Owner. where Owner stands for "creater of Sphere"

== Syntax ==

<pre>Sphere.Owner</pre>

== Example ==

<source lang=D>
function onSphereEntered( player, Sphere )
{
MessagePlayer( "Sphere's Owner: "+ Sphere.Owner, player );
}
</source>
=== Notes ===
Call [[onSphereEntered]] was used in this example..

== Related Functions ==

{{Scripting/Squirrel/Functions/Sphere_Functions}}

Scripting/Squirrel/Functions/Sphere.Radius

2016-03-15T16:59:27Z

Decent 946:

allows you to check Sphere's Radius.

== Syntax ==

<pre>Sphere.Radius</pre>

== Example ==

<source lang=D>
function onSphereEntered( player, Sphere )
{
MessagePlayer( "you have entered in a Sphere, Sphere's Radius: "+ Sphere.Radius, player );
}
</source>
=== Notes ===
Call [[onSphereEntered]] was used in this example..

== Related Functions ==

{{Scripting/Squirrel/Functions/Sphere_Functions}}

Scripting/Squirrel/Functions/Sphere.Pos

2016-03-15T16:59:06Z

Decent 946:

allows you to check Sphere's Position.

== Syntax ==

<pre>Sphere.Pos</pre>

== Example ==

<source lang=D>
function onSphereEntered( player, Sphere )
{
MessagePlayer( "you have entered in a Sphere, Sphere Pos X: "+ Sphere.Pos.x +", Y: "+ Sphere.Pos.y +", Z: "+ Sphere.Pos.z , player );
}
</source>
=== Notes ===
[[onSphereEntered]] was used in this example..

== Related Functions ==

{{Scripting/Squirrel/Functions/Sphere_Functions}}

Scripting/Squirrel/Functions/Sphere.Radius

2016-03-15T16:58:24Z

Decent 946:

Scripting/Squirrel/Functions/Sphere.World

2016-03-15T16:57:53Z

Decent 946:

allows you to check Sphere's World.

== Syntax ==

<pre>Sphere.World</pre>

== Example ==

<source lang=D>
function onSphereEntered( player, Sphere )
{
MessagePlayer( "you have entered in a Sphere, Sphere's World: "+ Sphere.World, player );
}
</source>
=== Notes ===
Call [[onSphereEntered]] was used in this example..

== Related Functions ==

{{Scripting/Squirrel/Functions/Sphere_Functions}}

Scripting/Squirrel/Functions/Sphere.Remove

2016-03-15T16:56:06Z

Decent 946:

allows you to Remove a Sphere.

== Syntax ==

<pre>Sphere.Remove()</pre>

== Example ==

<source lang=D>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "removesphere" )
{
if ( !text ) MessagePlayer( "SYNTAX: /"+cmd+" [Sphere ID]", player );
else
{
local Sphere = FindSphere( text.tointeger() );

if ( !IsNum ) MessagePlayer( "Sphere ID must be in numbers", player );
else if ( !Sphere ) MessagePlayer( "Sphere "+text+" is not created yet.", player );
else
{
Sphere.Remove();
MessagePlayer( "you removed the sphere ID: "+ Sphere.ID, player );
}
}
}
}
</source>
=== Notes ===
call [[onPlayerCommand]] and function [[Scripting/Squirrel/Functions/FindSphere|''FindSphere'']] were used in this example..

== Related Functions ==

{{Scripting/Squirrel/Functions/Sphere_Functions}}

OnPlayerCommand

2016-03-15T16:51:14Z

Decent 946:

__NOTOC__
This is called when a player uses a command.

== Syntax ==

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

== Parameters ==

* string '''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 ===

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

OnPlayerWeaponChange

2016-03-15T16:50:07Z

Decent 946: Created page with "__NOTOC__ When a player changes his weapon to newone or oldone. == Syntax == <pre>function onPlayerWeaponChange( player, oldwep, newwep )</pre> == Parameters == * Script..."

__NOTOC__
When a player changes his weapon to newone or oldone.

== Syntax ==

<pre>function onPlayerWeaponChange( player, oldwep, newwep )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who changes the weapon.
* '''oldwep''' - Players old weapon
* '''newwep''' - Players new weapon

== Example ==

If a player will try to change his weapon to "33" ( minigun ), this example will automatically set his weapons ammo to 0. and in result, he won't be able to use that weapon.

<source lang=squirrel>
function onPlayerWeaponChange( player, oldwep, newwep )
{
if ( newwep == 33 )
{
PrivMessage( player, "it is a blocked weapon" );
player.SetWeapon( 33,0 ); //sets weapons ammo to 0.
}
return 1; //returns true for other weapons.
}
</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and function [[Scripting/Squirrel/Functions/Player.SetWeapon|''SetWeapon'']] were used in this example.

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

OnPlayerCommand

2016-03-15T16:48:53Z

Decent 946:

OnPlayerCommand

2016-03-15T16:45:35Z

Decent 946:

OnPlayerPM

2016-03-14T15:06:26Z

Decent 946:

this function allows you to send a private Message ( PM ) to a player.

== Syntax ==

<pre>function onPlayerPM( player, playerTo, text )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that sends the message.
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''playerTo''' - The player to send the message.
* ''string'' '''text''' - this is the message to send.

== Example ==

<source lang=squirrel>
function onPlayerPM( player, playerTo, text )
{
if ( text )
{
PrivMessage( playerTo, "PrivateMessage From: [ "+player+" ] >> "+text+".");
PrivMessage( player, "PM: ["+text+"] was sent to "+ playerTo );
}
else PrivMessage( player, "SYNTAX: /msg [player's ID] [text]" );
return 0;
}
</source>

=== Notes ===

The function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and call [[onPlayerPM]] were used in this example. More info about them in the corresponding pages.

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

OnPlayerPM

2016-03-14T15:01:33Z

Decent 946:

this function allows you to send a private Message ( PM ) to a player.

== Syntax ==

<pre>function onPlayerPM( player, playerTo, text )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that sends the message.
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''playerTo''' - The player to send the message.
* ''string'' '''text''' - this is the message to send.

== Example ==

<source lang=squirrel>
function onPlayerPM( player, playerTo, text )
{
if ( text )
{
PrivMessage( playerTo, "PrivateMessage From: [ "+player+" ] >> "+text+".");
PrivMessage( player, "you successfully sent PM to player: "+ playerTo );
}
else PrivMessage( player, "SYNTAX: /msg [player's ID] [text]" );
return 0;
}
</source>

=== Notes ===

The function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and call [[onPlayerPM]] were used in this example. More info about them in the corresponding pages.

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

OnPlayerRequestSpawn

2016-03-14T14:49:35Z

Decent 946:

when a players requests to spawn.
== Syntax ==

<pre>function onPlayerRequestSpawn( player )</pre>

== Arguments ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The Pointer of the player.

== Example ==

<source lang=squirrel>
function onPlayerRequestSpawn( player )
{
PrivMessage( player, "you will be spawned in 3 seconds." );
NewTimer( "spawnplayer", 3000, 1, player.ID );
return 0;
}

// Timers Call Back
function spawnplayer( ID )
{
local player = FindPlayer( ID );
if ( player )
{
player.Spawn();
PrivMessage( player, "you have been spawned" );
}
else return 0;
}
</source>

== Notes ==

The function [[http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and call [[onPlayerRequestSpawn]] were used in this example. More info about them in corresponding pages.

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

OnPlayerRequestSpawn

2016-03-14T14:47:50Z

Decent 946:

when a players requests to spawn.
== Syntax ==

<pre>function onPlayerRequestSpawn( player )</pre>

== Arguments ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The Pointer of the player.

== Example ==

<source lang=squirrel>
function onPlayerRequestSpawn( player )
{
PrivMessage( player, "you will be spawned in 3 seconds." );
NewTimer( "spawnplayer", 3000, 1, player.ID );
return 0;
}

// Timers Call Back
function spawnplayer( ID )
{
local player = FindPlayer( ID );
if ( player )
{
player.Spawn();
PrivMessage( player, "you have been spawned" );
}
else return 0;
}
</source>

== Notes ==

The function [[Scripting/Squirrel/Functions/MessagePlayer|''MessagePlayer'']] and call [[onPlayerRequestSpawn]] were used in this example. More info about them in corresponding pages.

== Related Events ==

{{Scripting/Squirrel/Events/Player_Events}}

Scripting/Squirrel/Functions/Sphere.Remove

2016-03-14T14:36:20Z

Decent 946:

allows you to Remove a Sphere.

== Syntax ==

<pre>Sphere.Remove()</pre>

== Example ==

<source lang=D>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "removesphere" )
{
if ( !text ) MessagePlayer( "SYNTAX: /"+cmd+" [Sphere ID]", player );
else
{
local Sphere = FindSphere( text.tointeger() );

if ( !IsNum ) MessagePlayer( "Sphere ID must be in numbers", player );
else if ( !Sphere ) MessagePlayer( "Sphere "+text+" is not created yet.", player );
else
{
Sphere.Remove();
MessagePlayer( "you removed the sphere ID: "+ Sphere.ID, player );
}
}
}
}
</source>
=== Notes ===
[[http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Events/Player/onPlayerCommand|''onPlayerCommand'']], [[http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Functions/FindSphere|''FindSphere'']] was used in this example..

Scripting/Squirrel/Functions/Sphere.Remove

2016-03-14T14:33:13Z

Decent 946: Created page with "allows you to Remove a Sphere. == Syntax == <pre>Sphere.Remove()</pre> == Example == <source lang=D> function onPlayerCommand( player, cmd, text ) { if ( cmd == "removes..."

allows you to Remove a Sphere.

== Syntax ==

<pre>Sphere.Remove()</pre>

== Example ==

<source lang=D>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "removesphere" )
{
if ( !text ) MessagePlayer( "SYNTAX: /"+cmd+" [Sphere ID]", player );
else
{
local Sphere = FindSphere( text.tointeger() );

if ( !IsNum ) MessagePlayer( "Sphere ID must be in numbers", player );
else if ( !Sphere ) MessagePlayer( "Sphere "+text+" is not created yet.", player );
else
{
Sphere.Remove();
MessagePlayer( "you removed the sphere ID: "+ Sphere.ID, player );
}
}
}
}
</source>
=== Notes ===
[[http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Events/Player/onPlayerCommand|''onPlayerCommand'']] was used in this example..

Scripting/Squirrel/Functions/Sphere.World

2016-03-13T20:08:27Z

Decent 946: Created page with "allows you to check Sphere's World. == Syntax == <pre>Sphere.World</pre> == Example == <source lang=D> function onSphereEntered( player, Sphere ) { MessagePlayer( "you..."

allows you to check Sphere's World.

== Syntax ==

<pre>Sphere.World</pre>

== Example ==

<source lang=D>
function onSphereEntered( player, Sphere )
{
MessagePlayer( "you have entered in a Sphere, Sphere's World: "+ Sphere.World, player );
}
</source>
=== Notes ===
[[http://wiki.vc-mp.org/wiki/OnSphereEntered|''onSphereEntered'']] was used in this example..

Scripting/Squirrel/Functions/Sphere.Radius

2016-03-13T20:05:19Z

Decent 946:

allows you to check Sphere's Radius.

== Syntax ==

<pre>Sphere.Radius</pre>

== Example ==

<source lang=D>
function onSphereEntered( player, Sphere )
{
MessagePlayer( "you have entered in a Sphere, Sphere's Radius: "+ Sphere.Radius, player );
}
</source>
=== Notes ===
[[http://wiki.vc-mp.org/wiki/OnSphereEntered|''onSphereEntered'']] was used in this example..

Scripting/Squirrel/Functions/Sphere.Radius

2016-03-13T20:04:55Z

Decent 946: Created page with "allows you to check Sphere's Radius. == Syntax == <pre>Sphere.Radius</pre> == Example == <source lang=D> function onSphereEntered( player, Sphere ) { MessagePlayer( "y..."

allows you to check Sphere's Radius.

== Syntax ==

<pre>Sphere.Radius</pre>

== Example ==

<source lang=D>
function onSphereEntered( player, Sphere )
{
MessagePlayer( "you have entered in a Sphere, Sphere's Radius"+ Sphere.Radius, player );
}
</source>
=== Notes ===
[[http://wiki.vc-mp.org/wiki/OnSphereEntered|''onSphereEntered'']] was used in this example..

Scripting/Squirrel/Functions/Sphere.Pos

2016-03-13T20:02:46Z

Decent 946:

allows you to check Sphere's Position.

== Syntax ==

<pre>Sphere.Pos</pre>

== Example ==

<source lang=D>
function onSphereEntered( player, Sphere )
{
MessagePlayer( "you have entered in a Sphere, Sphere Pos X: "+ Sphere.Pos.x +", Y: "+ Sphere.Pos.y +", Z: "+ Sphere.Pos.z , player );
}
</source>
=== Notes ===
[[http://wiki.vc-mp.org/wiki/OnSphereEntered|''onSphereEntered'']] was used in this example..

Scripting/Squirrel/Functions/Sphere.Pos

2016-03-13T20:02:08Z

Decent 946:

allows you to check Sphere's Position.

== Syntax ==

<pre>Sphere.Pos</pre>

== Example ==

<source lang=D>
function onSphereEntered( player, Sphere )
{
MessagePlayer( "Sphere Pos X: "+ Sphere.Pos.x +", Y: "+ Sphere.Pos.y +", Z: "+ Sphere.Pos.z , player );
}
</source>
=== Notes ===
[[http://wiki.vc-mp.org/wiki/OnSphereEntered|''onSphereEntered'']] was used in this example..