Vice City Multiplayer - User contributions [en]

Scripting/Squirrel/Functions/Player.PlaySound

2018-12-17T21:00:33Z

Sseebbyy:

This function will play a sound for a specific player

== Syntax ==

<pre>Player.PlaySound( sound )</pre>

== Arguments ==

* ''instance'' '''Player''' - The player to play sound for
* ''int'' '''sound''' - The sound ID

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.Admin

2018-12-12T14:32:39Z

Sseebbyy:

== Syntax ==

*''Sets player as admin''
<pre>Player.Admin
Player.Admin = true (1) / false (0)</pre>

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

== Example ==

So you can make a player admin, then create command for him, like:
<pre>
if( cmd == "heal" )
{
if( player.Admin )
{
player.Health = 100;
}
}
</pre>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.Admin

2018-12-12T14:32:10Z

Sseebbyy:

== Syntax ==

*''Sets player as admin''
<pre>Player.Admin
Player.Admin = true (1) / false (0)</pre>

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

So you can make a player admin, then create command for him, like:
if( cmd == "heal" )
{
if( player.Admin )
{
player.Health = 100;
}
}
</pre>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.Admin

2018-12-12T14:30:57Z

Sseebbyy: Created page with "== Syntax == *''Set's player as admin'' <pre>Player.Admin Player.Admin = true (1) / false (0)</pre> == Description == <pre> This function is just a variable. There are no b..."

== Syntax ==

*''Set's player as admin''
<pre>Player.Admin
Player.Admin = true (1) / false (0)</pre>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.Speed

2018-12-12T14:25:15Z

Sseebbyy:

== Syntax ==
<pre>
read - player.Speed
set - player.Speed = Vector( x, y, z )
</pre>

== Description ==
This function is setting or returning player's speed.

== Example ==
<source lang=squirrel>
function onPlayerCommand( player, cmd )
{
if( cmd == "up" )
{
player.Speed.z += 5;
}
}

</source>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.AddSpeed

2018-12-12T14:24:25Z

Sseebbyy: Created page with "== Syntax == Adds speed to a player. <pre> player.AddSpeed( Vector ) </pre> == Description == This function is adding speed to a player. == Example == The command will boost..."

== Syntax ==
Adds speed to a player.
<pre>
player.AddSpeed( Vector )
</pre>

== Description ==
This function is adding speed to a player.

== Example ==
The command will boost the player to the sky, with 5 more 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.Speed

2018-12-12T14:17:21Z

Sseebbyy:

This function will get the vehicle name from the given ID.

== Syntax ==
<pre>
read - player.Speed
set - player.Speed = Vector( x, y, z )
</pre>

== Description ==
This function is setting or returning player's speed.

== Example ==
<source lang=squirrel>
function onPlayerCommand( player, cmd )
{
if( cmd == "up" )
{
player.Speed.z += 5;
}
}

</source>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.Speed

2018-12-12T14:16:55Z

Sseebbyy:

This function will get the vehicle name from the given ID.

== Syntax ==
<pre>
player.Speed '''- read'''
player.Speed = Vector( x, y, z ) '''- set'''
</pre>

== Description ==
This function is setting or returning player's speed.

== Example ==
<source lang=squirrel>
function onPlayerCommand( player, cmd )
{
if( cmd == "up" )
{
player.Speed.z += 5;
}
}

</source>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.Speed

2018-12-12T14:16:26Z

Sseebbyy: Created page with "This function will get the vehicle name from the given ID. == Syntax == player.Speed '''- read''' player.Speed = Vector( x, y, z ) '''- set''' == Description == This functio..."

This function will get the vehicle name from the given ID.

== Syntax ==
player.Speed '''- read'''
player.Speed = Vector( x, y, z ) '''- set'''

== Description ==
This function is setting or returning player's speed.

== Example ==
<source lang=squirrel>
function onPlayerCommand( player, cmd )
{
if( cmd == "up" )
{
player.Speed.z += 5;
}
}

</source>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.ShowMarkers

2018-12-12T14:08:56Z

Sseebbyy:

== Syntax ==

<pre>player.ShowMarkers = bool</pre>

*'''player''': player instance
*'''bool''': true (1) / false (0)

== Description ==
This function will show or hide all markers of all players, for a player you set.

== Example ==

This function will hide markers for the player who writes the command.

<source lang=squirrel>
function onPlayerCommand( player, cmd, wantedLevel )
{
if ( cmd == "hidemarkers" )
{
player.ShowMarkers = false;
MessagePlayer( "You hidden all players' markers from map and radar", player );
}
}
</source>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.ShowMarkers

2018-12-12T14:08:28Z

Sseebbyy:

== Syntax ==

<pre>player.ShowMarkers = bool</pre>

*'''player''': player instance
*'''bool''': true (1) / false (0)

== Description ==
This function will show or hide all markers of all players, for a player you set.

== Example ==

<source lang=squirrel>
This function will hide markers for the player who writes the command.
<pre>
function onPlayerCommand( player, cmd, wantedLevel )
{
if ( cmd == "hidemarkers" )
{
player.ShowMarkers = false;
MessagePlayer( "You hidden all players' markers from map and radar", player );
}
}
</source>
</pre>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.ShowMarkers

2018-12-12T14:07:07Z

Sseebbyy: Created page with "== Syntax == <pre>player.ShowMarkers = bool</pre> *'''player''': player instance *'''bool''': true (1) / false (0) == Description == This function will show or hide all mar..."

== Syntax ==

<pre>player.ShowMarkers = bool</pre>

*'''player''': player instance
*'''bool''': true (1) / false (0)

== Description ==
This function will show or hide all markers of all players, for a player you set.

== Example ==

<source lang=squirrel>
function onPlayerCommand( player, cmd, wantedLevel )
{
if ( cmd == "hidemarkers" )
{
player.ShowMarkers = false;
MessagePlayer( "You hidden all players' markers from map and radar", player );
}
}
</source>

== Related Functions ==

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

Template:Scripting/Squirrel/Functions/Player Functions

2018-12-12T14:02:05Z

Sseebbyy:

* [[Scripting/Squirrel/Functions/BanPlayer|BanPlayer]]
* [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]]
* [[Scripting/Squirrel/Functions/GetPlayerIDFromName|GetPlayerIDFromName]]
* [[Scripting/Squirrel/Functions/IsWorldCompatibleWithPlayer|IsWorldCompatibleWithPlayer]]
* [[Scripting/Squirrel/Functions/KickPlayer|KickPlayer]]
* [[Scripting/Squirrel/Functions/PlaySoundForPlayer|PlaySoundForPlayer]]
* [[Scripting/Squirrel/Functions/Player.Action|Player.Action]]
* [[Scripting/Squirrel/Functions/Player.AddSpeed|Player.AddSpeed]]
* [[Scripting/Squirrel/Functions/Player.Admin|Player.Admin]]
* [[Scripting/Squirrel/Functions/Player.AimDir|Player.AimDir]]
* [[Scripting/Squirrel/Functions/Player.AimPos|Player.AimPos]]
* [[Scripting/Squirrel/Functions/Player.Alpha|Player.Alpha]]
* [[Scripting/Squirrel/Functions/Player.Ammo|Player.Ammo]]
* [[Scripting/Squirrel/Functions/Player.Angle|Player.Angle]]
* [[Scripting/Squirrel/Functions/Player.Armour|Player.Armour]]
* [[Scripting/Squirrel/Functions/Player.Away|Player.Away]]
* [[Scripting/Squirrel/Functions/Player.Ban|Player.Ban]]
* [[Scripting/Squirrel/Functions/Player.CameraLocked|Player.CameraLocked]]
* [[Scripting/Squirrel/Functions/Player.CanAttack|Player.CanAttack]]
* [[Scripting/Squirrel/Functions/Player.CanDriveby|Player.CanDriveby]]
* [[Scripting/Squirrel/Functions/Player.Cash|Player.Cash]]
* [[Scripting/Squirrel/Functions/Player.Class|Player.Class]]
* [[Scripting/Squirrel/Functions/Player.Colour|Player.Colour]]
* [[Scripting/Squirrel/Functions/Player.Disarm|Player.Disarm]]
* [[Scripting/Squirrel/Functions/Player.Eject|Player.Eject]]
* [[Scripting/Squirrel/Functions/Player.FPS|Player.FPS]]
* [[Scripting/Squirrel/Functions/Player.Frozen|Player.Frozen]]
* [[Scripting/Squirrel/Functions/Player.GameKeys|Player.GameKeys]]
* [[Scripting/Squirrel/Functions/Player.GetAmmoAtSlot|Player.GetAmmoAtSlot]]
* [[Scripting/Squirrel/Functions/Player.GetWeaponAtSlot|Player.GetWeaponAtSlot]]
* [[Scripting/Squirrel/Functions/Player.GiveMoney|Player.GiveMoney]]
* [[Scripting/Squirrel/Functions/Player.GiveWeapon|Player.GiveWeapon]]
* [[Scripting/Squirrel/Functions/Player.GreenScanlines|Player.GreenScanlines]]
* [[Scripting/Squirrel/Functions/Player.HasChatTags|Player.HasChatTags]]
* [[Scripting/Squirrel/Functions/Player.HasMarker|Player.HasMarker]]
* [[Scripting/Squirrel/Functions/Player.Health|Player.Health]]
* [[Scripting/Squirrel/Functions/Player.ID|Player.ID]]
* [[Scripting/Squirrel/Functions/Player.Immunity|Player.Immunity]]
* [[Scripting/Squirrel/Functions/Player.IP|Player.IP]]
* [[Scripting/Squirrel/Functions/Player.IsCrouching|Player.IsCrouching]]
* [[Scripting/Squirrel/Functions/Player.IsDrunk|Player.IsDrunk]]
* [[Scripting/Squirrel/Functions/Player.IsOnFire|Player.IsOnFire]]
* [[Scripting/Squirrel/Functions/Player.IsOnRadar|Player.IsOnRadar]]
* [[Scripting/Squirrel/Functions/Player.IsSpawned|Player.IsSpawned]]
* [[Scripting/Squirrel/Functions/Player.Key|Player.Key]]
* [[Scripting/Squirrel/Functions/Player.Kick|Player.Kick]]
* [[Scripting/Squirrel/Functions/Player.Name|Player.Name]]
* [[Scripting/Squirrel/Functions/Player.Ping|Player.Ping]]
* [[Scripting/Squirrel/Functions/Player.PlaySound|Player.PlaySound]]
* [[Scripting/Squirrel/Functions/Player.Pos|Player.Pos]]
* [[Scripting/Squirrel/Functions/Player.Redirect|Player.Redirect]]
* [[Scripting/Squirrel/Functions/Player.RestoreCamera|Player.RestoreCamera]]
* [[Scripting/Squirrel/Functions/Player.RemoveMarker|Player.RemoveMarker]]
* [[Scripting/Squirrel/Functions/Player.RemoveWeapon|Player.RemoveWeapon]]
* [[Scripting/Squirrel/Functions/Player.Score|Player.Score]]
* [[Scripting/Squirrel/Functions/Player.SecWorld|Player.SecWorld]]
* [[Scripting/Squirrel/Functions/Player.Select()|Player.Select()]]
* [[Scripting/Squirrel/Functions/Player.SetAlpha|Player.SetAlpha]]
* [[Scripting/Squirrel/Functions/Player.SetAnim|Player.SetAnim]]
* [[Scripting/Squirrel/Functions/Player.SetDrunkLevel|Player.SetDrunkLevel]]
* [[Scripting/Squirrel/Functions/Player.SetCameraPos|Player.SetCameraPos]]
* [[Scripting/Squirrel/Functions/Player.SetInterior|Player.SetInterior]]
* [[Scripting/Squirrel/Functions/Player.SetMarker|Player.SetMarker - bugged]]
* [[Scripting/Squirrel/Functions/Player.SetWantedLevel|Player.SetWantedLevel]]
* [[Scripting/Squirrel/Functions/Player.SetWeapon|Player.SetWeapon]]
* [[Scripting/Squirrel/Functions/Player.ShowMarkers|Player.ShowMarkers]]
* [[Scripting/Squirrel/Functions/Player.Slot|Player.Slot]]
* [[Scripting/Squirrel/Functions/Player.Skin|Player.Skin]]
* [[Scripting/Squirrel/Functions/Player.Spawn|Player.Spawn]]
* [[Scripting/Squirrel/Functions/Player.SpectateTarget|Player.SpectateTarget]]
* [[Scripting/Squirrel/Functions/Player.Speed|Player.Speed]]
* [[Scripting/Squirrel/Functions/Player.StandingOnObject|Player.StandingOnObject]]
* [[Scripting/Squirrel/Functions/Player.StandingOnVehicle|Player.StandingOnVehicle]]
* [[Scripting/Squirrel/Functions/Player.State|Player.State]]
* [[Scripting/Squirrel/Functions/Player.StreamedToPlayer|Player.StreamedToPlayer]]
* [[Scripting/Squirrel/Functions/Player.Typing|Player.Typing]]
* [[Scripting/Squirrel/Functions/Player.Team|Player.Team]]
* [[Scripting/Squirrel/Functions/Player.UniqueID|Player.UniqueID]]
* [[Scripting/Squirrel/Functions/Player.UniqueID2 |Player.UniqueID2]]
* [[Scripting/Squirrel/Functions/Player.UniqueWorld|Player.UniqueWorld]]
* [[Scripting/Squirrel/Functions/Player.Vehicle|Player.Vehicle]]
* [[Scripting/Squirrel/Functions/Player.VehicleSlot|Player.VehicleSlot]]
* [[Scripting/Squirrel/Functions/Player.VehicleStatus|Player.VehicleStatus]]
* [[Scripting/Squirrel/Functions/Player.WantedLevel|Player.WantedLevel]]
* [[Scripting/Squirrel/Functions/Player.Weapon|Player.Weapon]]
* [[Scripting/Squirrel/Functions/Player.WhiteScanlines|Player.WhiteScanlines]]
* [[Scripting/Squirrel/Functions/Player.Widescreen|Player.Widescreen]]
* [[Scripting/Squirrel/Functions/Player.World|Player.World]]
* [[Scripting/Squirrel/Functions/Player.PutInVehicleSlot|Player.PutInVehicleSlot]]

=== Player Game Functions ===
''These functions exist for compatibility with the R2 Squirrel server.''
* [[GetCinematicBorder]]
* [[GetGreenScanLines]]
* [[GetWhiteScanLines]]
* [[SetCinematicBorder]]
* [[SetGreenScanLines]]
* [[SetWhiteScanLines]]

Scripting/Squirrel/Functions/Player.Slot

2018-12-12T13:51:28Z

Sseebbyy: Created page with "== Syntax == <pre>int player.Slot</pre> == Description == Sets or Returns player's weapon slot. == Example == This sets player's weapon to fist/punch ( or brass knuckles )..."

== Syntax ==
<pre>int player.Slot</pre>

== Description ==
Sets or Returns player's weapon slot.

== Example ==
This sets player's weapon to fist/punch ( or brass knuckles )

<pre>function onPlayerCommand( player, cmd, text )
{
if ( cmd == "hideweps" )
{
player.Slot = 0;
MessagePlayer( "You've set your weapon slot to fist/brass", player );
}
}</pre>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.StandingOnObject

2018-12-12T13:44:29Z

Sseebbyy:

== Syntax ==
<pre>player.StandingOnObject</pre>

== Description ==

This function will return the instance of the object player is standing on, if it was created via '''CreateObject'''

== Example ==

<pre>
function onPlayerCommand( player, cmd, text )
{
if( cmd == "manipobj" )
{
local obj = player.StandingOnObject;
if( obj ) return MessagePlayer( "The object you are standing on, is manipulable by script", player );
else return MessagePlayer( "There is no object created by script, under your feet", player );
}
}
</pre>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.StandingOnVehicle

2018-12-12T13:43:59Z

Sseebbyy:

== Syntax ==
<pre>player.StandingOnVehicle</pre>

== Description ==

This function will return the instance of the vehicle player is standing on.

== Example ==

<pre>
function onPlayerCommand( player, cmd, text )
{
if( cmd == "model" )
{
local veh = player.StandingOnVehicle;
if( veh ) return MessagePlayer( "The vehicle model you are standing on: " + GetVehicleNameFromModel( veh.Model ), player );
else return MessagePlayer( "There is no vehicle under your feet.", player );
}
}
</pre>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.StandingOnVehicle

2018-12-12T13:43:30Z

Sseebbyy: Created page with "== Syntax == *'''Returns the instance of the vehicle player is standing on.''' <pre>player.StandingOnVehicle</pre> == Description == This function will return the instance..."

== Syntax ==

*'''Returns the instance of the vehicle player is standing on.'''

<pre>player.StandingOnVehicle</pre>

== Description ==

This function will return the instance of the vehicle player is standing on.

== Example ==

<pre>
function onPlayerCommand( player, cmd, text )
{
if( cmd == "model" )
{
local veh = player.StandingOnVehicle;
if( veh ) return MessagePlayer( "The vehicle model you are standing on: " + GetVehicleNameFromModel( veh.Model ), player );
else return MessagePlayer( "There is no vehicle under your feet.", player );
}
}
</pre>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.StandingOnObject

2018-12-12T13:40:20Z

Sseebbyy: Created page with "== Syntax == *'''Returns the instance of the object player is standing on.''' <pre>player.StandingOnObject</pre> == Description == This function will return the instance o..."

== Syntax ==

*'''Returns the instance of the object player is standing on.'''

<pre>player.StandingOnObject</pre>

== Description ==

This function will return the instance of the object player is standing on, if it was created via '''CreateObject'''

== Example ==

<pre>
function onPlayerCommand( player, cmd, text )
{
if( cmd == "manipobj" )
{
local obj = player.StandingOnObject;
if( obj ) return MessagePlayer( "The object you are standing on, is manipulable by script", player );
else return MessagePlayer( "There is no object created by script, under your feet", player );
}
}
</pre>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.SecWorld

2018-12-12T13:32:09Z

Sseebbyy:

== Syntax ==

*'''Set/Get player's Second World'''

<pre>player.SecWorld;</pre>

== Description ==
<pre>
Many scripters don't know, but this function mixes player.World with the second world you set.
Let's say you create an object/pickup in world 55 while player's world is 0.
If you set player's second world to 55, he will also see that object/pickup, while nobody else will.
</pre>

*'''Note:''' If a player makes contact with an object from it's second world, player will dissappear from others' screen.

== Example ==
<pre>
function onPlayerJoin( player )
{
player.SecWorld = 5000 + player.ID;
}

function onPlayerCommand( player, cmd, text )
{
if ( cmd == "ramp" )
{
CreateObject( 371, player.SecWorld, player.Pos, 255 );
MessagePlayer( "You got your own ramp that nobody else can see!", player );
}
}
</pre>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.SecWorld

2018-12-12T13:31:04Z

Sseebbyy:

== Syntax ==

*'''Set/Get player's Second World'''

<pre>player.SecWorld;</pre>

== Description ==
<pre>
Many scripters don't know, but this function mixes player.World with the second world you set.
Let's say you create an object/pickup in world 55 while player's world is 0.
If you set player's second world to 55, he will also see that object/pickup, while nobody else will.

*'''Note:''' If a player makes contact with an object from it's second world, player will dissappear from others' screen.
</pre>

== Example ==
<pre>
function onPlayerJoin( player )
{
player.SecWorld = 5000 + player.ID;
}

function onPlayerCommand( player, cmd, text )
{
if ( cmd == "ramp" )
{
CreateObject( 371, player.SecWorld, player.Pos, 255 );
MessagePlayer( "You got your own ramp that nobody else can see!", player );
}
}
</pre>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.SecWorld

2018-12-12T13:30:30Z

Sseebbyy:

== Syntax ==

*'''Set/Get player's Second World'''

<pre>player.SecWorld;</pre>

== Description ==
<pre>
Many scripters don't know, but this function mixes player.World with the second world you set.
Let's say you create an object/pickup in world 55 while player's world is 0.
If you set player's second world to 55, he will also see that object/pickup, while nobody else will.

*'''Note:''' If a player makes contact with an object from it's second world, player will dissappear from others' screen.
</pre>

== Example ==
<pre>
function onPlayerJoin( player )
{
player.SecWorld = 5000 + player.ID;
}

function onPlayerCommand( player, cmd, text )
{
if ( cmd == "ramp" )
{
CreateObject( 371, player.SecWorld, player.Pos, 255 );
MessagePlayer( "You got your own ramp that none else can see!", player );
}
}
</pre>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.SecWorld

2018-12-12T13:30:08Z

Sseebbyy:

== Syntax ==

*'''Set/Get player's Second World'''

<pre>player.SecWorld;</pre>

== Description ==
Many scripters don't know, but this function mixes player.World with the second world you set.
Let's say you create an object/pickup in world 55 while player's world is 0.
If you set player's second world to 55, he will also see that object/pickup, while nobody else will.

*'''Note:''' If a player makes contact with an object from it's second world, player will dissappear from others' screen.

== Example ==
<pre>
function onPlayerJoin( player )
{
player.SecWorld = 5000 + player.ID;
}

function onPlayerCommand( player, cmd, text )
{
if ( cmd == "ramp" )
{
CreateObject( 371, player.SecWorld, player.Pos, 255 );
MessagePlayer( "You got your own ramp that none else can see!", player );
}
}
</pre>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.SecWorld

2018-12-12T13:29:27Z

Sseebbyy: Created page with "== Syntax == *'''Set/Get player's Second World''' <pre>player.SecWorld;</pre> == Description == <pre> Many scripters don't know, but this function mixes player.World with t..."

== Syntax ==

*'''Set/Get player's Second World'''

<pre>player.SecWorld;</pre>

== Description ==
<pre>
Many scripters don't know, but this function mixes player.World with the second world you set.
Let's say you create an object/pickup in world 55 while player's world is 0.
If you set player's second world to 55, he will also see that object/pickup, while nobody else will.

*'''Note:''' If a player makes contact with an object from it's second world, player will dissappear from others' screen.
</pre>

== Example ==
<pre>
function onPlayerJoin( player )
{
player.SecWorld = 5000 + player.ID;
}

function onPlayerCommand( player, cmd, text )
{
if ( cmd == "ramp" )
{
CreateObject( 371, player.SecWorld, player.Pos, 255 );
MessagePlayer( "You got your own ramp that none else can see!", player );
}
}

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.Select()

2018-12-12T12:54:54Z

Sseebbyy: Created page with "== Syntax == *'''Sends a player to the Selecting Room ( aka Request Class )''' <pre>player.Select();</pre> == Example == The following example sends a specified player to t..."

== Syntax ==

*'''Sends a player to the Selecting Room ( aka Request Class )'''

<pre>player.Select();</pre>

== Example ==
The following example sends a specified player to the Selecting Room. ( aka Request Class )
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "select" )
{
local plr = FindPlayer( text );
plr.Select();
MessagePlayer( plr.Name+" has been sent to the Request Class.", player );
}
}
</source>

== Arguments ==

* ''int'' '''player''' - Player to be sent

== Related Functions ==

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

Template:Scripting/Squirrel/Functions/Player Functions

2018-12-12T12:47:57Z

Sseebbyy:

* [[Scripting/Squirrel/Functions/BanPlayer|BanPlayer]]
* [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]]
* [[Scripting/Squirrel/Functions/GetPlayerIDFromName|GetPlayerIDFromName]]
* [[Scripting/Squirrel/Functions/IsWorldCompatibleWithPlayer|IsWorldCompatibleWithPlayer]]
* [[Scripting/Squirrel/Functions/KickPlayer|KickPlayer]]
* [[Scripting/Squirrel/Functions/PlaySoundForPlayer|PlaySoundForPlayer]]
* [[Scripting/Squirrel/Functions/Player.Action|Player.Action]]
* [[Scripting/Squirrel/Functions/Player.AddSpeed|Player.AddSpeed]]
* [[Scripting/Squirrel/Functions/Player.Admin|Player.Admin]]
* [[Scripting/Squirrel/Functions/Player.AimDir|Player.AimDir]]
* [[Scripting/Squirrel/Functions/Player.AimPos|Player.AimPos]]
* [[Scripting/Squirrel/Functions/Player.Alpha|Player.Alpha]]
* [[Scripting/Squirrel/Functions/Player.Ammo|Player.Ammo]]
* [[Scripting/Squirrel/Functions/Player.Angle|Player.Angle]]
* [[Scripting/Squirrel/Functions/Player.Armour|Player.Armour]]
* [[Scripting/Squirrel/Functions/Player.Away|Player.Away]]
* [[Scripting/Squirrel/Functions/Player.Ban|Player.Ban]]
* [[Scripting/Squirrel/Functions/Player.CameraLocked|Player.CameraLocked]]
* [[Scripting/Squirrel/Functions/Player.CanAttack|Player.CanAttack]]
* [[Scripting/Squirrel/Functions/Player.CanDriveby|Player.CanDriveby]]
* [[Scripting/Squirrel/Functions/Player.Cash|Player.Cash]]
* [[Scripting/Squirrel/Functions/Player.Class|Player.Class]]
* [[Scripting/Squirrel/Functions/Player.Colour|Player.Colour]]
* [[Scripting/Squirrel/Functions/Player.Disarm|Player.Disarm]]
* [[Scripting/Squirrel/Functions/Player.Eject|Player.Eject]]
* [[Scripting/Squirrel/Functions/Player.FPS|Player.FPS]]
* [[Scripting/Squirrel/Functions/Player.Frozen|Player.Frozen]]
* [[Scripting/Squirrel/Functions/Player.GameKeys|Player.GameKeys]]
* [[Scripting/Squirrel/Functions/Player.GetAmmoAtSlot|Player.GetAmmoAtSlot]]
* [[Scripting/Squirrel/Functions/Player.GetWeaponAtSlot|Player.GetWeaponAtSlot]]
* [[Scripting/Squirrel/Functions/Player.GiveMoney|Player.GiveMoney]]
* [[Scripting/Squirrel/Functions/Player.GiveWeapon|Player.GiveWeapon]]
* [[Scripting/Squirrel/Functions/Player.GreenScanlines|Player.GreenScanlines]]
* [[Scripting/Squirrel/Functions/Player.HasChatTags|Player.HasChatTags]]
* [[Scripting/Squirrel/Functions/Player.HasMarker|Player.HasMarker]]
* [[Scripting/Squirrel/Functions/Player.Health|Player.Health]]
* [[Scripting/Squirrel/Functions/Player.ID|Player.ID]]
* [[Scripting/Squirrel/Functions/Player.Immunity|Player.Immunity]]
* [[Scripting/Squirrel/Functions/Player.IP|Player.IP]]
* [[Scripting/Squirrel/Functions/Player.IsCrouching|Player.IsCrouching]]
* [[Scripting/Squirrel/Functions/Player.IsDrunk|Player.IsDrunk]]
* [[Scripting/Squirrel/Functions/Player.IsOnFire|Player.IsOnFire]]
* [[Scripting/Squirrel/Functions/Player.IsOnRadar|Player.IsOnRadar]]
* [[Scripting/Squirrel/Functions/Player.IsSpawned|Player.IsSpawned]]
* [[Scripting/Squirrel/Functions/Player.Key|Player.Key]]
* [[Scripting/Squirrel/Functions/Player.Kick|Player.Kick]]
* [[Scripting/Squirrel/Functions/Player.Name|Player.Name]]
* [[Scripting/Squirrel/Functions/Player.Ping|Player.Ping]]
* [[Scripting/Squirrel/Functions/Player.PlaySound|Player.PlaySound]]
* [[Scripting/Squirrel/Functions/Player.Pos|Player.Pos]]
* [[Scripting/Squirrel/Functions/Player.Redirect|Player.Redirect]]
* [[Scripting/Squirrel/Functions/Player.RestoreCamera|Player.RestoreCamera]]
* [[Scripting/Squirrel/Functions/Player.RemoveMarker|Player.RemoveMarker]]
* [[Scripting/Squirrel/Functions/Player.RemoveWeapon|Player.RemoveWeapon]]
* [[Scripting/Squirrel/Functions/Player.Score|Player.Score]]
* [[Scripting/Squirrel/Functions/Player.SecWorld|Player.SecWorld]]
* [[Scripting/Squirrel/Functions/Player.Select()|Player.Select()]]
* [[Scripting/Squirrel/Functions/Player.SetAlpha|Player.SetAlpha]]
* [[Scripting/Squirrel/Functions/Player.SetAnim|Player.SetAnim]]
* [[Scripting/Squirrel/Functions/Player.SetDrunkLevel|Player.SetDrunkLevel]]
* [[Scripting/Squirrel/Functions/Player.SetCameraPos|Player.SetCameraPos]]
* [[Scripting/Squirrel/Functions/Player.SetInterior|Player.SetInterior]]
* [[Scripting/Squirrel/Functions/Player.SetMarker|Player.SetMarker]]
* [[Scripting/Squirrel/Functions/Player.SetWantedLevel|Player.SetWantedLevel]]
* [[Scripting/Squirrel/Functions/Player.SetWeapon|Player.SetWeapon]]
* [[Scripting/Squirrel/Functions/Player.ShowMarkers|Player.ShowMarkers]]
* [[Scripting/Squirrel/Functions/Player.Slot|Player.Slot]]
* [[Scripting/Squirrel/Functions/Player.Skin|Player.Skin]]
* [[Scripting/Squirrel/Functions/Player.Spawn|Player.Spawn]]
* [[Scripting/Squirrel/Functions/Player.SpectateTarget|Player.SpectateTarget]]
* [[Scripting/Squirrel/Functions/Player.Speed|Player.Speed]]
* [[Scripting/Squirrel/Functions/Player.StandingOnObject|Player.StandingOnObject]]
* [[Scripting/Squirrel/Functions/Player.StandingOnVehicle|Player.StandingOnVehicle]]
* [[Scripting/Squirrel/Functions/Player.State|Player.State]]
* [[Scripting/Squirrel/Functions/Player.StreamedToPlayer|Player.StreamedToPlayer]]
* [[Scripting/Squirrel/Functions/Player.Typing|Player.Typing]]
* [[Scripting/Squirrel/Functions/Player.Team|Player.Team]]
* [[Scripting/Squirrel/Functions/Player.UniqueID|Player.UniqueID]]
* [[Scripting/Squirrel/Functions/Player.UniqueID2 |Player.UniqueID2]]
* [[Scripting/Squirrel/Functions/Player.UniqueWorld|Player.UniqueWorld]]
* [[Scripting/Squirrel/Functions/Player.Vehicle|Player.Vehicle]]
* [[Scripting/Squirrel/Functions/Player.VehicleSlot|Player.VehicleSlot]]
* [[Scripting/Squirrel/Functions/Player.VehicleStatus|Player.VehicleStatus]]
* [[Scripting/Squirrel/Functions/Player.WantedLevel|Player.WantedLevel]]
* [[Scripting/Squirrel/Functions/Player.Weapon|Player.Weapon]]
* [[Scripting/Squirrel/Functions/Player.WhiteScanlines|Player.WhiteScanlines]]
* [[Scripting/Squirrel/Functions/Player.Widescreen|Player.Widescreen]]
* [[Scripting/Squirrel/Functions/Player.World|Player.World]]
* [[Scripting/Squirrel/Functions/Player.PutInVehicleSlot|Player.PutInVehicleSlot]]

=== Player Game Functions ===
''These functions exist for compatibility with the R2 Squirrel server.''
* [[GetCinematicBorder]]
* [[GetGreenScanLines]]
* [[GetWhiteScanLines]]
* [[SetCinematicBorder]]
* [[SetGreenScanLines]]
* [[SetWhiteScanLines]]

Scripting/Squirrel/Functions/Player.VehicleStatus

2018-12-12T12:45:40Z

Sseebbyy:

== Syntax ==

*'''Returns player's current Vehicle Status, as integer.'''

<pre>player.VehicleStatus</pre>

== Example ==

<pre>
function onPlayerCommand( player, cmd, text )
{
if(cmd == "vehstatus")
{
MessagePlayer( "Your current Vehicle Status: " + player.VehicleStatus + " ( status as integer )", player );
}
}
</pre>

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

== Player's Vehicle Status list ==
<div>
{| class="wikitable"
!State ID
!Description
|-
|0
|No Vehicle
|-
|1
|Entering Vehicle
|-
|2
|???
|-
|3
|In Vehicle
|}
</div>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.VehicleSlot

2018-12-12T12:44:55Z

Sseebbyy:

== Syntax ==

*'''Returns player's current Vehicle Slot, as integer.'''

<pre>player.VehicleSlot</pre>

== Example ==

<pre>
function onPlayerCommand( player, cmd, text )
{
if( cmd == "vehslot" )
{
MessagePlayer( "Your current Vehicle Slot: " + player.VehicleSlot + " (slot as integer)", player );
}
}
</pre>

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

== Vehicle Slot list ==
<div>
{| class="wikitable"
!Slot ID
!Description
|-
| -1
|Not in a vehicle
|-
|0
|Driver
|-
|1
|Second Passenger
|-
|2
|Third Passenger
|-
|3
|Fourth Passenger
|}
</div>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.VehicleStatus

2018-12-12T12:44:07Z

Sseebbyy: Created page with "== Syntax == '''Returns player's current Vehicle Status, as integer.''' <pre>player.VehicleStatus</pre> == Example == <pre> function onPlayerCommand( player, cmd, text ) {..."

== Syntax ==

'''Returns player's current Vehicle Status, as integer.'''

<pre>player.VehicleStatus</pre>

== Example ==

<pre>
function onPlayerCommand( player, cmd, text )
{
if(cmd == "vehstatus")
{
MessagePlayer( "Your current Vehicle Status: " + player.VehicleStatus + " ( status as integer )", player );
}
}
</pre>

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

== Player's Vehicle Status list ==
<div>
{| class="wikitable"
!State ID
!Description
|-
|0
|No Vehicle
|-
|1
|Entering Vehicle
|-
|2
|???
|-
|3
|In Vehicle
|}
</div>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.VehicleSlot

2018-12-12T12:34:27Z

Sseebbyy: Created page with "Returns player's current Vehicle Slot, as integer. == Syntax == <pre>player.VehicleSlot</pre> == Example == <pre> function onPlayerCommand( player, cmd, text ) { if( c..."

Returns player's current Vehicle Slot, as integer.

== Syntax ==

<pre>player.VehicleSlot</pre>

== Example ==

<pre>
function onPlayerCommand( player, cmd, text )
{
if( cmd == "vehslot" )
{
MessagePlayer( "Your current Vehicle Slot: " + player.VehicleSlot + " (slot as integer)", player );
}
}
</pre>

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

== Vehicle Slot list ==
<div>
{| class="wikitable"
!Slot ID
!Description
|-
| -1
|Not in a vehicle
|-
|0
|Driver
|-
|1
|Second Passenger
|-
|2
|Third Passenger
|-
|3
|Fourth Passenger
|}
</div>

== Related Functions ==

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

Template:Scripting/Squirrel/Functions/Player Functions

2018-12-12T12:21:08Z

Sseebbyy:

* [[Scripting/Squirrel/Functions/BanPlayer|BanPlayer]]
* [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]]
* [[Scripting/Squirrel/Functions/GetPlayerIDFromName|GetPlayerIDFromName]]
* [[Scripting/Squirrel/Functions/IsWorldCompatibleWithPlayer|IsWorldCompatibleWithPlayer]]
* [[Scripting/Squirrel/Functions/KickPlayer|KickPlayer]]
* [[Scripting/Squirrel/Functions/PlaySoundForPlayer|PlaySoundForPlayer]]
* [[Scripting/Squirrel/Functions/Player.Action|Player.Action]]
* [[Scripting/Squirrel/Functions/Player.AddSpeed|Player.AddSpeed]]
* [[Scripting/Squirrel/Functions/Player.Admin|Player.Admin]]
* [[Scripting/Squirrel/Functions/Player.AimDir|Player.AimDir]]
* [[Scripting/Squirrel/Functions/Player.AimPos|Player.AimPos]]
* [[Scripting/Squirrel/Functions/Player.Alpha|Player.Alpha]]
* [[Scripting/Squirrel/Functions/Player.Ammo|Player.Ammo]]
* [[Scripting/Squirrel/Functions/Player.Angle|Player.Angle]]
* [[Scripting/Squirrel/Functions/Player.Armour|Player.Armour]]
* [[Scripting/Squirrel/Functions/Player.Away|Player.Away]]
* [[Scripting/Squirrel/Functions/Player.Ban|Player.Ban]]
* [[Scripting/Squirrel/Functions/Player.CameraLocked|Player.CameraLocked]]
* [[Scripting/Squirrel/Functions/Player.CanAttack|Player.CanAttack]]
* [[Scripting/Squirrel/Functions/Player.CanDriveby|Player.CanDriveby]]
* [[Scripting/Squirrel/Functions/Player.Cash|Player.Cash]]
* [[Scripting/Squirrel/Functions/Player.Class|Player.Class]]
* [[Scripting/Squirrel/Functions/Player.Colour|Player.Colour]]
* [[Scripting/Squirrel/Functions/Player.Disarm|Player.Disarm]]
* [[Scripting/Squirrel/Functions/Player.Eject|Player.Eject]]
* [[Scripting/Squirrel/Functions/Player.FPS|Player.FPS]]
* [[Scripting/Squirrel/Functions/Player.Frozen|Player.Frozen]]
* [[Scripting/Squirrel/Functions/Player.GameKeys|Player.GameKeys]]
* [[Scripting/Squirrel/Functions/Player.GetAmmoAtSlot|Player.GetAmmoAtSlot]]
* [[Scripting/Squirrel/Functions/Player.GetWeaponAtSlot|Player.GetWeaponAtSlot]]
* [[Scripting/Squirrel/Functions/Player.GiveMoney|Player.GiveMoney]]
* [[Scripting/Squirrel/Functions/Player.GiveWeapon|Player.GiveWeapon]]
* [[Scripting/Squirrel/Functions/Player.GreenScanlines|Player.GreenScanlines]]
* [[Scripting/Squirrel/Functions/Player.HasChatTags|Player.HasChatTags]]
* [[Scripting/Squirrel/Functions/Player.HasMarker|Player.HasMarker]]
* [[Scripting/Squirrel/Functions/Player.Health|Player.Health]]
* [[Scripting/Squirrel/Functions/Player.ID|Player.ID]]
* [[Scripting/Squirrel/Functions/Player.Immunity|Player.Immunity]]
* [[Scripting/Squirrel/Functions/Player.IP|Player.IP]]
* [[Scripting/Squirrel/Functions/Player.IsCrouching|Player.IsCrouching]]
* [[Scripting/Squirrel/Functions/Player.IsDrunk|Player.IsDrunk]]
* [[Scripting/Squirrel/Functions/Player.IsOnFire|Player.IsOnFire]]
* [[Scripting/Squirrel/Functions/Player.IsOnRadar|Player.IsOnRadar]]
* [[Scripting/Squirrel/Functions/Player.IsSpawned|Player.IsSpawned]]
* [[Scripting/Squirrel/Functions/Player.Key|Player.Key]]
* [[Scripting/Squirrel/Functions/Player.Kick|Player.Kick]]
* [[Scripting/Squirrel/Functions/Player.Name|Player.Name]]
* [[Scripting/Squirrel/Functions/Player.Ping|Player.Ping]]
* [[Scripting/Squirrel/Functions/Player.PlaySound|Player.PlaySound]]
* [[Scripting/Squirrel/Functions/Player.Pos|Player.Pos]]
* [[Scripting/Squirrel/Functions/Player.Redirect|Player.Redirect]]
* [[Scripting/Squirrel/Functions/Player.RestoreCamera|Player.RestoreCamera]]
* [[Scripting/Squirrel/Functions/Player.RemoveMarker|Player.RemoveMarker]]
* [[Scripting/Squirrel/Functions/Player.RemoveWeapon|Player.RemoveWeapon]]
* [[Scripting/Squirrel/Functions/Player.Score|Player.Score]]
* [[Scripting/Squirrel/Functions/Player.SecWorld|Player.SecWorld]]
* [[Scripting/Squirrel/Functions/Player.Select()|Player.Select]]
* [[Scripting/Squirrel/Functions/Player.SetAlpha|Player.SetAlpha]]
* [[Scripting/Squirrel/Functions/Player.SetAnim|Player.SetAnim]]
* [[Scripting/Squirrel/Functions/Player.SetDrunkLevel|Player.SetDrunkLevel]]
* [[Scripting/Squirrel/Functions/Player.SetCameraPos|Player.SetCameraPos]]
* [[Scripting/Squirrel/Functions/Player.SetInterior|Player.SetInterior]]
* [[Scripting/Squirrel/Functions/Player.SetMarker|Player.SetMarker]]
* [[Scripting/Squirrel/Functions/Player.SetWantedLevel|Player.SetWantedLevel]]
* [[Scripting/Squirrel/Functions/Player.SetWeapon|Player.SetWeapon]]
* [[Scripting/Squirrel/Functions/Player.ShowMarkers|Player.ShowMarkers]]
* [[Scripting/Squirrel/Functions/Player.Slot|Player.Slot]]
* [[Scripting/Squirrel/Functions/Player.Skin|Player.Skin]]
* [[Scripting/Squirrel/Functions/Player.Spawn|Player.Spawn]]
* [[Scripting/Squirrel/Functions/Player.SpectateTarget|Player.SpectateTarget]]
* [[Scripting/Squirrel/Functions/Player.Speed|Player.Speed]]
* [[Scripting/Squirrel/Functions/Player.StandingOnObject|Player.StandingOnObject]]
* [[Scripting/Squirrel/Functions/Player.StandingOnVehicle|Player.StandingOnVehicle]]
* [[Scripting/Squirrel/Functions/Player.State|Player.State]]
* [[Scripting/Squirrel/Functions/Player.StreamedToPlayer|Player.StreamedToPlayer]]
* [[Scripting/Squirrel/Functions/Player.Typing|Player.Typing]]
* [[Scripting/Squirrel/Functions/Player.Team|Player.Team]]
* [[Scripting/Squirrel/Functions/Player.UniqueID|Player.UniqueID]]
* [[Scripting/Squirrel/Functions/Player.UniqueID2 |Player.UniqueID2]]
* [[Scripting/Squirrel/Functions/Player.UniqueWorld|Player.UniqueWorld]]
* [[Scripting/Squirrel/Functions/Player.Vehicle|Player.Vehicle]]
* [[Scripting/Squirrel/Functions/Player.VehicleSlot|Player.VehicleSlot]]
* [[Scripting/Squirrel/Functions/Player.VehicleStatus|Player.VehicleStatus]]
* [[Scripting/Squirrel/Functions/Player.WantedLevel|Player.WantedLevel]]
* [[Scripting/Squirrel/Functions/Player.Weapon|Player.Weapon]]
* [[Scripting/Squirrel/Functions/Player.WhiteScanlines|Player.WhiteScanlines]]
* [[Scripting/Squirrel/Functions/Player.Widescreen|Player.Widescreen]]
* [[Scripting/Squirrel/Functions/Player.World|Player.World]]
* [[Scripting/Squirrel/Functions/Player.PutInVehicleSlot|Player.PutInVehicleSlot]]

=== Player Game Functions ===
''These functions exist for compatibility with the R2 Squirrel server.''
* [[GetCinematicBorder]]
* [[GetGreenScanLines]]
* [[GetWhiteScanLines]]
* [[SetCinematicBorder]]
* [[SetGreenScanLines]]
* [[SetWhiteScanLines]]

Template:Scripting/Squirrel/Functions/Player Functions

2018-12-12T12:20:38Z

Sseebbyy:

* [[Scripting/Squirrel/Functions/BanPlayer|BanPlayer]]
* [[Scripting/Squirrel/Functions/FindPlayer|FindPlayer]]
* [[Scripting/Squirrel/Functions/GetPlayerIDFromName|GetPlayerIDFromName]]
* [[Scripting/Squirrel/Functions/IsWorldCompatibleWithPlayer|IsWorldCompatibleWithPlayer]]
* [[Scripting/Squirrel/Functions/KickPlayer|KickPlayer]]
* [[Scripting/Squirrel/Functions/PlaySoundForPlayer|PlaySoundForPlayer]]
* [[Scripting/Squirrel/Functions/Player.Action|Player.Action]]
* [[Scripting/Squirrel/Functions/Player.AddSpeed|Player.AddSpeed]]
* [[Scripting/Squirrel/Functions/Player.Admin|Player.Admin]]
* [[Scripting/Squirrel/Functions/Player.AimDir|Player.AimDir]]
* [[Scripting/Squirrel/Functions/Player.AimPos|Player.AimPos]]
* [[Scripting/Squirrel/Functions/Player.Alpha|Player.Alpha]]
* [[Scripting/Squirrel/Functions/Player.Ammo|Player.Ammo]]
* [[Scripting/Squirrel/Functions/Player.Angle|Player.Angle]]
* [[Scripting/Squirrel/Functions/Player.Armour|Player.Armour]]
* [[Scripting/Squirrel/Functions/Player.Away|Player.Away]]
* [[Scripting/Squirrel/Functions/Player.Ban|Player.Ban]]
* [[Scripting/Squirrel/Functions/Player.CameraLocked|Player.CameraLocked]]
* [[Scripting/Squirrel/Functions/Player.CanAttack|Player.CanAttack]]
* [[Scripting/Squirrel/Functions/Player.CanDriveby|Player.CanDriveby]]
* [[Scripting/Squirrel/Functions/Player.Cash|Player.Cash]]
* [[Scripting/Squirrel/Functions/Player.Class|Player.Class]]
* [[Scripting/Squirrel/Functions/Player.Colour|Player.Colour]]
* [[Scripting/Squirrel/Functions/Player.Disarm|Player.Disarm]]
* [[Scripting/Squirrel/Functions/Player.Eject|Player.Eject]]
* [[Scripting/Squirrel/Functions/Player.FPS|Player.FPS]]
* [[Scripting/Squirrel/Functions/Player.Frozen|Player.Frozen]]
* [[Scripting/Squirrel/Functions/Player.GameKeys|Player.GameKeys]]
* [[Scripting/Squirrel/Functions/Player.GetAmmoAtSlot|Player.GetAmmoAtSlot]]
* [[Scripting/Squirrel/Functions/Player.GetWeaponAtSlot|Player.GetWeaponAtSlot]]
* [[Scripting/Squirrel/Functions/Player.GiveMoney|Player.GiveMoney]]
* [[Scripting/Squirrel/Functions/Player.GiveWeapon|Player.GiveWeapon]]
* [[Scripting/Squirrel/Functions/Player.GreenScanlines|Player.GreenScanlines]]
* [[Scripting/Squirrel/Functions/Player.HasChatTags|Player.HasChatTags]]
* [[Scripting/Squirrel/Functions/Player.HasMarker|Player.HasMarker]]
* [[Scripting/Squirrel/Functions/Player.Health|Player.Health]]
* [[Scripting/Squirrel/Functions/Player.ID|Player.ID]]
* [[Scripting/Squirrel/Functions/Player.Immunity|Player.Immunity]]
* [[Scripting/Squirrel/Functions/Player.IP|Player.IP]]
* [[Scripting/Squirrel/Functions/Player.IsCrouching|Player.IsCrouching]]
* [[Scripting/Squirrel/Functions/Player.IsDrunk|Player.IsDrunk]]
* [[Scripting/Squirrel/Functions/Player.IsOnFire|Player.IsOnFire]]
* [[Scripting/Squirrel/Functions/Player.IsOnRadar|Player.IsOnRadar]]
* [[Scripting/Squirrel/Functions/Player.IsSpawned|Player.IsSpawned]]
* [[Scripting/Squirrel/Functions/Player.Key|Player.Key]]
* [[Scripting/Squirrel/Functions/Player.Kick|Player.Kick]]
* [[Scripting/Squirrel/Functions/Player.Name|Player.Name]]
* [[Scripting/Squirrel/Functions/Player.Ping|Player.Ping]]
* [[Scripting/Squirrel/Functions/Player.PlaySound|Player.PlaySound]]
* [[Scripting/Squirrel/Functions/Player.Pos|Player.Pos]]
* [[Scripting/Squirrel/Functions/Player.Redirect|Player.Redirect]]
* [[Scripting/Squirrel/Functions/Player.RestoreCamera|Player.RestoreCamera]]
* [[Scripting/Squirrel/Functions/Player.RemoveMarker|Player.RemoveMarker]]
* [[Scripting/Squirrel/Functions/Player.RemoveWeapon|Player.RemoveWeapon]]
* [[Scripting/Squirrel/Functions/Player.Score|Player.Score]]
* [[Scripting/Squirrel/Functions/Player.SecWorld|Player.SecWorld]]
* [[Scripting/Squirrel/Functions/Player.Select()|Player.Select]]
* [[Scripting/Squirrel/Functions/Player.SetAlpha|Player.SetAlpha]]
* [[Scripting/Squirrel/Functions/Player.SetAnim|Player.SetAnim]]
* [[Scripting/Squirrel/Functions/Player.SetDrunkLevel|Player.SetDrunkLevel]]
* [[Scripting/Squirrel/Functions/Player.SetCameraPos|Player.SetCameraPos]]
* [[Scripting/Squirrel/Functions/Player.SetInterior|Player.SetInterior]]
* [[Scripting/Squirrel/Functions/Player.SetMarker|Player.SetMarker]]
* [[Scripting/Squirrel/Functions/Player.SetWantedLevel|Player.SetWantedLevel]]
* [[Scripting/Squirrel/Functions/Player.SetWeapon|Player.SetWeapon]]
* [[Scripting/Squirrel/Functions/Player.ShowMarkers|Player.ShowMarkers]]
* [[Scripting/Squirrel/Functions/Player.Slot|Player.Slot]]
* [[Scripting/Squirrel/Functions/Player.Skin|Player.Skin]]
* [[Scripting/Squirrel/Functions/Player.Spawn|Player.Spawn]]
* [[Scripting/Squirrel/Functions/Player.SpectateTarget|Player.SpectateTarget]]
* [[Scripting/Squirrel/Functions/Player.Speed|Player.Speed]]
* [[Scripting/Squirrel/Functions/Player.StandingOnObject|Player.StandingOnObject]]
* [[Scripting/Squirrel/Functions/Player.StandingOnVehicle|Player.StandingOnVehicle]]
* [[Scripting/Squirrel/Functions/Player.State|Player.State]]
* [[Scripting/Squirrel/Functions/Player.StreamedToPlayer|Player.StreamedToPlayer]]
* [[Scripting/Squirrel/Functions/Player.Typing|Player.Typing]]
* [[Scripting/Squirrel/Functions/Player.Team|Player.Team]]
* [[Scripting/Squirrel/Functions/Player.UniqueID|Player.UniqueID]]
* [[Scripting/Squirrel/Functions/Player.UniqueID2 |Player.UniqueID2]]
* [[Scripting/Squirrel/Functions/Player.UniqueWorld|Player.UniqueWorld]]
* [[Scripting/Squirrel/Functions/Player.Vehicle|Player.Vehicle]]
* [[Scripting/Squirrel/Functions/Player.VehicleSlot|Player.Vehicle]]
* [[Scripting/Squirrel/Functions/Player.VehicleStatus|Player.Vehicle]]
* [[Scripting/Squirrel/Functions/Player.WantedLevel|Player.WantedLevel]]
* [[Scripting/Squirrel/Functions/Player.Weapon|Player.Weapon]]
* [[Scripting/Squirrel/Functions/Player.WhiteScanlines|Player.WhiteScanlines]]
* [[Scripting/Squirrel/Functions/Player.Widescreen|Player.Widescreen]]
* [[Scripting/Squirrel/Functions/Player.World|Player.World]]
* [[Scripting/Squirrel/Functions/Player.PutInVehicleSlot|Player.PutInVehicleSlot]]

=== Player Game Functions ===
''These functions exist for compatibility with the R2 Squirrel server.''
* [[GetCinematicBorder]]
* [[GetGreenScanLines]]
* [[GetWhiteScanLines]]
* [[SetCinematicBorder]]
* [[SetGreenScanLines]]
* [[SetWhiteScanLines]]

Template:Main Page

2018-07-01T06:05:28Z

Sseebbyy:

{{Main Page giant banner}}
<br />
{{VCMPLangs
| title=Vice City Multiplayer
| hu=Main_Page/hu
| pt=Main_Page/pt
}}
<br />
{| 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" | Welcome!
|-
| style="padding:10px;" |
Welcome to the VC:MP 0.4 Wiki!<br/>
This wiki will cover everything about the online multiplayer mod for Grand Theft Auto: Vice City.<br/>
From installing the client, to setting up your own server and scripts. You will be able to find any information you might need here.<br/><br/>
If you see anything missing, wrong or otherwise not helpful, be free to create or edit pages. Make sure you use proper english, and keep the same layout throughout the pages.<br/>
For anyone just starting to edit the wiki extensively, please read these quick contribution guidelines: [[VCMP:Contributing|Contributing]].<br/>
For more help and the latest news, visit our [http://www.vc-mp.org website] or [http://forum.vc-mp.org forums].<br/><br/>
Thanks for reading,<br/>
The VC:MP Team.

</div>
|-
|}
|}

{| style="width:100%; background:none; border:none; margin:0.5em 0; padding:none;" cellspacing="0" cellpadding="0"
|-
| style="width:33%; background:#FEFBF6; border:1px solid #79542B;" valign="top" |
{| style="padding:0px; width:100%;" |
! class="mp-content-header mp-title-gradient" | Download
|-
| style="padding:4px; margin:0;" |
{| style="width:100%; background:none; border:none; padding:5px; margin:0.25em; text-align:center;" cellspacing="2px" class="plainlinks"
! align="center" |
! align="right" | Latest update:
| align="left" |  {{Updates|type=client}} <small>({{Updates|type=client-version}})</small>
|-
! align="center" colspan="3" | <small>[[Updates|Full list of updates and changelog]]</small>
|}
{| style="100% background:none; border:none: padding:2px; margin:2px; margin: 0 auto; text-align:center;" cellspacing="2px"
| align="center" colspan="2" | [[File:download-client.png|link=https://vc-mp.org]]
|-
| align="right" | [[File:download-windows-32.png|link={{Updates|type=server-link-win32}}]]
| align="left" | [[File:download-linux-32.png|link={{Updates|type=server-link-linux32}}]]
|-
| align="right" | [[File:download-windows-64.png|link={{Updates|type=server-link-win64}}]]
| align="left" | [[File:download-linux-64.png|link={{Updates|type=server-link-linux64}}]]
|-
|}
|-
|}
|  
| style="width:33%; background:#FEFBF6; border:1px solid #79542B;" valign="top" |
{| style="padding:0px; width:100%;" |
! class="mp-content-header mp-title-gradient" | Client Information
|-
| style="padding:4px; margin:0;" |
* How to start the browser<br/>
* How to use the browser<br/>
* How to join a server<br/>
* Favorites<br/>
* Troubleshooting<br/>
* [[:Category:Client Documentation|Client Documentation]]<br/>
* [[Client-side_Scripting_Resources|Client-side Scripting resources]]<br/>
|}
|  
| style="width:auto; background:#FEFBF6; border:1px solid #79542B;" valign="top" |
{| style="padding:0px; width:100%;" |
! class="mp-content-header mp-title-gradient" | Server Information
|-
| style="padding:4px; margin:0;" |
* [[Starting_your_first_server|Starting your first server]]<br/>
* [[:Category:Server Documentation|Server Documentation]]<br/>
* [[Server-side_Scripting_Resources|Server-side Scripting resources]]<br/>
* [[ID Reference|ID References]]<br/>
* Troubleshooting<br/>
|}

Template:Main Page

2018-07-01T06:01:20Z

Sseebbyy:

{{Main Page giant banner}}
<br />
{{VCMPLangs
| title=Vice City Multiplayer
| hu=Main_Page/hu
| pt=Main_Page/pt
}}
<br />
{| 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" | Welcome!
|-
| style="padding:10px;" |
Welcome to the VC:MP 0.4 Wiki!<br/>
This wiki will cover everything about the online multiplayer mod for Grand Theft Auto: Vice City.<br/>
From installing the client, to setting up your own server and scripts. You will be able to find any information you might need here.<br/><br/>
If you see anything missing, wrong or otherwise not helpful, be free to create or edit pages. Make sure you use proper english, and keep the same layout throughout the pages.<br/>
For anyone just starting to edit the wiki extensively, please read these quick contribution guidelines: [[VCMP:Contributing|Contributing]].<br/>
For more help and the latest news, visit our [http://www.vc-mp.org website] or [http://forum.vc-mp.org forums].<br/><br/>
Thanks for reading,<br/>
The VC:MP Team.

</div>
|-
|}
|}

{| style="width:100%; background:none; border:none; margin:0.5em 0; padding:none;" cellspacing="0" cellpadding="0"
|-
| style="width:33%; background:#FEFBF6; border:1px solid #79542B;" valign="top" |
{| style="padding:0px; width:100%;" |
! class="mp-content-header mp-title-gradient" | Download
|-
| style="padding:4px; margin:0;" |
{| style="width:100%; background:none; border:none; padding:5px; margin:0.25em; text-align:center;" cellspacing="2px" class="plainlinks"
! align="center" |
! align="right" | Latest update:
| align="left" |  {{Updates|type=client}} <small>({{Updates|type=client-version}})</small>
|-
! align="center" colspan="3" | <small>[[Updates|Full list of updates and changelog]]</small>
|}
{| style="100% background:none; border:none: padding:2px; margin:2px; margin: 0 auto; text-align:center;" cellspacing="2px"
| align="center" colspan="2" | [[File:download-client.png|link=https://vc-mp.org]] <small>[http://static.vc-mp.org/VCMP04_Installer.exe Old version]</small>
|-
| align="right" | [[File:download-windows-32.png|link={{Updates|type=server-link-win32}}]]
| align="left" | [[File:download-linux-32.png|link={{Updates|type=server-link-linux32}}]]
|-
| align="right" | [[File:download-windows-64.png|link={{Updates|type=server-link-win64}}]]
| align="left" | [[File:download-linux-64.png|link={{Updates|type=server-link-linux64}}]]
|-
|}
|-
|}
|  
| style="width:33%; background:#FEFBF6; border:1px solid #79542B;" valign="top" |
{| style="padding:0px; width:100%;" |
! class="mp-content-header mp-title-gradient" | Client Information
|-
| style="padding:4px; margin:0;" |
* How to start the browser<br/>
* How to use the browser<br/>
* How to join a server<br/>
* Favorites<br/>
* Troubleshooting<br/>
* [[:Category:Client Documentation|Client Documentation]]<br/>
* [[Client-side_Scripting_Resources|Client-side Scripting resources]]<br/>
|}
|  
| style="width:auto; background:#FEFBF6; border:1px solid #79542B;" valign="top" |
{| style="padding:0px; width:100%;" |
! class="mp-content-header mp-title-gradient" | Server Information
|-
| style="padding:4px; margin:0;" |
* [[Starting_your_first_server|Starting your first server]]<br/>
* [[:Category:Server Documentation|Server Documentation]]<br/>
* [[Server-side_Scripting_Resources|Server-side Scripting resources]]<br/>
* [[ID Reference|ID References]]<br/>
* Troubleshooting<br/>
|}

Template:Updates

2018-07-01T05:59:14Z

Sseebbyy:

<includeonly>{{#ifeq:{{{lang}}}|hu|{{Updates/core/hu | type = {{{type|client}}}
| client-month = 06
| client-day = 28
| client-year = 2018
| client-version = 04rel006
| server-month = 06
| server-day = 28
| server-year = 2018
| server-version = 04rel006
| server-link-win32 = http://v04.vc-mp.org/server/VCMP04_server_v30_win32.zip
| server-link-win64 = https://v04.vc-mp.org/server/VCMP04_server_v30_win64.zip
| server-link-linux32 = https://v04.vc-mp.org/server/VCMP04_server_v30_linux32.zip
| server-link-linux64 = https://v04.vc-mp.org/server/VCMP04_server_v30_linux64.zip
}}|{{Updates/core | type = {{{type|client}}}
| client-month = 06
| client-day = 28
| client-year = 2018
| client-version = 04rel006
| server-month = 06
| server-day = 28
| server-year = 2018
| server-version = 04rel006
| server-link-win32 = http://v04.vc-mp.org/server/VCMP04_server_v30_win32.zip
| server-link-win64 = https://v04.vc-mp.org/server/VCMP04_server_v30_win64.zip
| server-link-linux32 = https://v04.vc-mp.org/server/VCMP04_server_v30_linux32.zip
| server-link-linux64 = https://v04.vc-mp.org/server/VCMP04_server_v30_linux64.zip
}}}}</includeonly>

Scripting/Squirrel/Functions/SetBackfaceCullingDisabled

2017-08-26T09:50:58Z

Sseebbyy: Created page with "This function will enable/disable backface culling. Vice City enables it by default, that's why some objects around the map are not visible from all view angles. To better und..."

This function will enable/disable backface culling.
Vice City enables it by default, that's why some objects around the map are not visible from all view angles.
To better understand what it is supposed to do, try to disable it in your server.

== Syntax ==

<pre>SetBackfaceCullingDisabled( bool )</pre>

== Arguments ==

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

== Example ==

<source lang=squirrel>
function onScriptLoad()
{
SetBackfaceCullingDisabled( true );
}
</source>

=== Notes ===
Call [[onScriptLoad]] was used in this example.

== Related Functions ==

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

ID Reference

2015-09-07T21:11:54Z

Sseebbyy:

Server-side Scripting Resources

2015-05-19T22:24:01Z

Sseebbyy:

{{Main Page giant banner}}

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

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

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

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

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

== Scripts ==

The following is a list of example Squirrel scripts

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

== Reference ==

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

== Tutorials / Documentation ==

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

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

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

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

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

Scripting/Squirrel/Functions/Player.Health

2015-02-27T21:26:50Z

Sseebbyy:

This function will set or return a player's health value.

== Syntax ==

<pre>1. player.Health (returns the health value of player)
2. player.Health = newHealth (sets the health value of player)</pre>

== Arguments ==

* ''float'' '''newHealth''' - the new health value

== Example 1 ==
The following example will set player's health to 100, for some cash.
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
if ( cmd == "heal" )
{
local health = player.Health;
if ( health < 100 )
{
// calculate the cost depends on their health
local cost = ( ( 250 / 100 ) * ( 100 - health ) );
if ( player.Cash >= cost )
{
player.Cash -= cost;
stats[ player.ID ].Cash -= cost;
player.Health = 100;
Message( "[#DC26FF] Player [#ffffff][ " + player.Name + " ] [#DC26FF] has bought heal [#ffffff](Cost: $" + cost + ")" );
}
else MessagePlayer( "[#ffffff]You dont have enough money (Cost: $" + cost + ")", player );
}
else MessagePlayer( "[#ffffff]You Already Having 100hp :)", player );
}
</source>

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

== Example 2 ==
The following example will stop a player, with lower hp than 30, that wants to be driver.
<source lang=squirrel>
function onPlayerEnteringVehicle( player, vehicle, door )
{
Message( ">> " + player.Name + " is entering in slot " + door + " of vehicle ID + " + vehicle.ID);
if( player.Health < 30.0 )
{
if( door == 0 )
{
MessagePlayer( " Are you insane ?? You can't drive with your poor hp !", player );
return 0;
}
}
return 1;
}
</source>

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Player_Functions}}

WeaponDataValue

2015-02-21T10:48:55Z

Sseebbyy: Created page with "{{Main Page giant banner}} {| style="width:100%; background:none; border:none; margin:0.5em 0; padding:none;" cellspacing="0" cellpadding="0" |- | style="width:auto; backgrou..."

Scripting/Squirrel/Functions/ResetAllWeaponData

2015-02-20T12:31:47Z

Sseebbyy:

This function will reset a weapon's settings to the defaults. (damage, range, etc)

== Syntax ==

<pre>ResetAllWeaponData( )</pre>

== Arguments ==

* '''N/A'''

== Example ==
The following example will reset all weapons data to defaults.
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if( cmd == "resetweapons" )
{
ResetAllWeaponData( );
Message( "All weapons were reseted to default settings !!" );
}
}
</source>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/ResetAllWeaponData

2015-02-20T12:31:11Z

Sseebbyy: Created page with "This function will reset a weapon's settings to the defaults. (damage, range, etc) == Syntax == <pre>ResetAllWeaponData( )</pre> == Arguments == * '''N/A''' == Example ==..."

This function will reset a weapon's settings to the defaults. (damage, range, etc)

== Syntax ==

<pre>ResetAllWeaponData( )</pre>

== Arguments ==

* '''N/A'''

== Example ==
The following example will check if the data value of the weapon, from player's hand, was edited.
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if( cmd == "resetweapons" )
{
ResetAllWeaponData( );
Message( "All weapons were reseted to default settings !!" );
}
}
</source>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/ResetWeaponData

2015-02-20T12:24:09Z

Sseebbyy: Created page with "This function will reset a weapon's settings to the defaults. (damage, range, etc) == Syntax == <pre>ResetWeaponData( weaponID )</pre> == Arguments == * ''integer'' '''wea..."

This function will reset a weapon's settings to the defaults. (damage, range, etc)

== Syntax ==

<pre>ResetWeaponData( weaponID )</pre>

== Arguments ==

* ''integer'' '''weaponID''' - model ID of weapon

== Example ==
The following example will check if the data value of the weapon, from player's hand, was edited.
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if( cmd == "resetdatawep" )
{
if( !text || !IsNum(text) ) MessagePlayer( "Error - Correct syntax - '/" + cmd + " <weaponID>' !", player );
else if( text >= 1 || text <= 25 ) MessagePlayer( "Error - Weapon IDs are from 0 to 33 !", player );
else
{
ResetWeaponData( text.tointeger );
Message( "NEWS -> Weapon " + GetWeaponName( text ) + " received the default settings !" );
}
}
}
</source>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/IsWeaponDataModified

2015-02-20T12:12:50Z

Sseebbyy:

This function will check a weapon for changed data values. (damage, range, etc)

== Syntax ==

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

== Arguments ==

* ''integer'' '''weaponID''' - model ID of weapon
* ''integer'' '''fieldID''' - field ID of data you want to check for edits ( [[WeaponDataValue]] )

== Example ==
The following example will check if the data value of the weapon, from player's hand, was edited.
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if( cmd == "checkmywepdata" )
{
if( !text || !IsNum(text) ) MessagePlayer( "Error - Correct syntax - '/checkmywepdata <fieldID>' !", player );
else if( text >= 1 || text <= 25 ) MessagePlayer( "Error - Field IDs are from 1 to 25 !", player );
else
{
if( IsWeaponDataModified( player.Weapon.ID, text.tointeger() ) == true )
MessagePlayer( "Yes, data " + text + " of " + GetWeaponName( player.Weapon.ID ) + "is edited !!", player );
else
MessagePlayer( "Nope, data " + text + " of " + GetWeaponName( player.Weapon.ID ) + " is not edited.", player );

MessagePlayer( "Data" + text + " of " + GetWeaponName( player.Weapon.ID ) + " is " + GetWeaponDataValue( player.Weapon.ID, text.tointeger() ) );
}
}
}
</source>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/IsWeaponDataModified

2015-02-20T12:11:24Z

Sseebbyy: Created page with "This function will check a weapon for changed data values. (damage, range, etc) == Syntax == <pre>IsWeaponDataModified( weaponID , fieldID )</pre> == Arguments == * ''inte..."

This function will check a weapon for changed data values. (damage, range, etc)

== Syntax ==

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

== Arguments ==

* ''integer'' '''weaponID''' - model ID of weapon
* ''integer'' '''fieldID''' - field ID of data you want to check for edits ( [[WeaponDataValue]] )

== Example ==
The following example will check if the data value of the weapon, from player's hand, was edited.
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if( cmd == "checkmywepdata" )
{
if( !text || !IsNum(text) ) MessagePlayer( "Error - Correct syntax - '/checkmywepdata <fieldID>' !", player );
else if( text >= 1 || text <= 25 ) MessagePlayer( "Error - Field IDs are from 1 to 25 !", player );
else
{
if( IsWeaponDataModified( player.Weapon.ID, text.tointeger() ) == true )
MessagePlayer( "Yes, Data value of field " + text + " of " + GetWeaponName( player.Weapon.ID ) + "is edited !!", player );
else
MessagePlayer( "Nope, data value of field " + text + " of " + GetWeaponName( player.Weapon.ID ) + " is not edited.", player );

MessagePlayer( "Data value of field " + text + " of " + GetWeaponName( player.Weapon.ID ) + " is " + GetWeaponDataValue( player.Weapon.ID, text.tointeger() ) );
}
}
}
</source>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/ResetWeaponDataValue

2015-02-20T11:40:52Z

Sseebbyy: Created page with "This function will reset the data value of a weapon. (range, damage, etc) == Syntax == <pre>ResetWeaponDataValue( weaponID, fieldID )</pre> == Arguments == * ''integer'' '..."

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

== Syntax ==

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

== Arguments ==

* ''integer'' '''weaponID''' - model ID of weapon
* ''integer'' '''fieldID''' - field ID of data you want to reset ( [[WeaponDataValue]] )

== Example ==
The following example will return the original firing range of Stubby Shotgun.
<source lang=squirrel>
ResetWeaponDataValue( 21, 2 )
</source>

== Related Functions ==

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

Scripting/Squirrel/Functions/SetWeaponDataValue

2015-02-20T11:33:02Z

Sseebbyy:

This function will edit the settings of a weapon. (damage, range, etc)

== Syntax ==

<pre>SetWeaponDataValue( weaponID , fieldID, value )</pre>

== Arguments ==

* ''integer'' '''weaponID''' - model ID of weapon
* ''integer'' '''fieldID''' - field ID of data you want to edit ( [[WeaponDataValue]] )
* ''float'' '''value''' - value to be set

== Example ==
The following example edit the damage value of minigun to "0".
<source lang=squirrel>
function onScriptLoad()
{
SetWeaponDataValue( 33, 6, 0 );
}
</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/GetWeaponDataValue

2015-02-20T11:32:32Z

Sseebbyy:

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

== Syntax ==

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

== Arguments ==

* ''integer'' '''weaponID''' - model ID of weapon
* ''integer'' '''fieldID''' - field ID of data you want to get ( [[WeaponDataValue]] )

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

2015-02-20T11:31:33Z

Sseebbyy: Created page with "This function will return a data value of a weapon. (damage, range, etc) == Syntax == <pre>GetWeaponDataValue( weaponID , fieldID )</pre> == Arguments == * ''integer'' '''..."

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

== Syntax ==

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

== Arguments ==

* ''integer'' '''weaponID''' - model ID of weapon
* ''integer'' '''fieldID''' - field ID of data you want to get ( [[WeaponDataValue]] )

== Example ==
The following example will change stubby shotgun's range to minigun's one.
<source lang=squirrel>
function onScriptLoad()
{
SetWeaponDataValue( 21, 2, GetWeaponDataValue( 21, 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/SetWeaponDataValue

2015-02-20T11:18:19Z

Sseebbyy:

This function will edit the settings of a weapon. (damage, range, etc)

== Syntax ==

<pre>SetWeaponDataValue( weaponID , fieldID, value )</pre>

== Arguments ==

* ''integer'' '''weaponID''' - model ID of weapon
* ''integer'' '''fieldID''' - field ID of data you want to edit ( [[WeaponDataValue]] )
* ''float'' '''value''' - value to be set

== Example ==
The following example edit the damage value of minigun to "0".
<source lang=squirrel>
function onScriptLoad()
{
SetWeaponDataValue( 33, 6, 0 );
}
</source>

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

== Related Functions ==

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

Scripting/Squirrel/Functions/SetWeaponDataValue

2015-02-20T11:16:37Z

Sseebbyy: Created page with "This function will edit the settings of a weapon. (damage, range, etc) == Syntax == <pre>SetWeaponDataValue( weaponID , fieldID, value )</pre> == Arguments == * ''integer'..."

This function will edit the settings of a weapon. (damage, range, etc)

== Syntax ==

<pre>SetWeaponDataValue( weaponID , fieldID, value )</pre>

== Arguments ==

* ''integer'' '''weaponID''' - model ID of weapon
* ''integer'' '''fieldID''' - field ID of data you want to edit ( [[WeaponDataValue]] )
* ''float'' '''value''' - value to be set

== Example ==
The following example edit the damage value of minigun to "0".
<source lang=squirrel>
function onScriptLoad()
{
SetWeaponDataValue( 33, 6, 0 );
}
</source>

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

== Related Functions ==

{{Scripting/Squirrel/Functions/SetWeaponDataValue}}