Vice City Multiplayer - User contributions [en]

Scripting/Squirrel/Functions/SetWeatherLock

2015-03-05T22:08:56Z

Rww: Created page with "Sets the the weather to be locked or not == Syntax == <pre>bool SetWeatherLock( bool )</pre> == Arguments == * '''bool''' - Whether or not to lock the weather == Example..."

Sets the the weather to be locked or not

== Syntax ==

<pre>bool SetWeatherLock( bool )</pre>

== Arguments ==

* '''bool''' - Whether or not to lock the weather

== Example ==

After typing '/c weatherlock', the weather rate will be locked. And '/c weatherunlock', the weather rate will be unlocked.

<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "weatherlock" )
{
SetWeatherLock( true );
}
}
</source>

or

<source lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "weatherunlock" )
{
SetWeatherLock( false );
}
}
</source>

== Notes ==

The call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] was used in in this example. More info about this in the corresponding page.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/Player.UniqueID

2015-03-05T22:01:10Z

Rww:

This will return player Unique ID.

== Syntax ==

<pre>string player.UniqueID</pre>

== Example ==
<source lang=squirrel>
function onPlayerJoin( player )
{
ClientMessage( "pm >> Your Unique ID: " + player.UniqueID, player, 0, 255, 0 );
}
</source>
== Notes ==

Function [[Scripting/Squirrel/Functions/ClientMessage|ClientMessage]] and call [[onPlayerJoin]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.Score

2015-03-05T21:59:58Z

Rww:

This instance variable returns or sets player's score.

== Syntax ==

<pre>int player.Score

player.Score = int score</pre>

== Example ==

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "myscore" )
{
MessagePlayer( "Your score is " + player.Score , player );
}
}
</source>

== Notes ==

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.IP

2015-03-05T21:54:34Z

Rww:

This instance variable returns player's IP address.

== Syntax ==

<pre>string player.IP</pre>

== Example ==
<source lang=squirrel>
function OnPlayerCommand( player , cmd , text )
{
if ( cmd == "myip" ) MessagePlayer( " Your IP is " + player.IP , player );
}

</source>

=== Notes ===

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

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.UniqueID

2015-03-05T21:54:04Z

Rww:

This will return player Unique ID.

== Syntax ==

<pre>string player.UniqueID</pre>

== Example ==
<source lang=squirrel>
function onPlayerJoin( player )
{
ClientMessage( "pm >> Your Unique ID: " + player.UniqueID, player, 0, 255, 0 );
}
</source>
=== Notes ===

Function [[ClientMessage]] and call [[onPlayerJoin]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.IP

2015-03-05T21:53:54Z

Rww:

This instance variable returns player's IP address.

== Syntax ==

<pre>string player.IP</pre>

== Example ==
<source lang=squirrel>
function OnPlayerCommand( player , cmd , text )
{
if ( cmd == "myip" ) MessagePlayer( " Your IP is " + player.IP , player );
}

</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]], [[Scripting/Squirrel/Functions/Player.Name|Player.Name]] and call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in in this example. More info about them in corresponding pages.

== Related Functions ==

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

OnPlayerKill

2015-03-05T21:50:45Z

Rww:

This event is called every time a player kills another (and they're not in the same team).

== Syntax ==

<pre>function onPlayerKill( killer, player, reason, bodypart )</pre>

== Arguments ==

* '''player''' - He is who is attacking
* '''killer''' - He is who is being killed
* '''reason''' - [[Weapons|Weapon ID]]
* '''bodypart''' - [[Scripting/Squirrel/Constants#Body_Part|Bodypart ID]]

== Example ==

<source lang="squirrel">
function onPlayerKill( killer, player, reason, bodypart )
{
Message( "** " + killer.Name + " killed " + player.Name + " (" + GetWeaponName( reason ) + ") (" + bodypart + ")" );
}
</source>

=== Notes ===

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

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}

Scripting/Squirrel/Functions/Player.IP

2015-03-04T10:30:42Z

Rww:

OnPlayerCrashDump

2015-03-04T10:22:30Z

Rww: Created page with "This event is called every time a player kills another (and they're not in the same team). == Syntax == <pre>function onPlayerCrashDump( player, CrashReport )</pre> == Arg..."

This event is called every time a player kills another (and they're not in the same team).

== Syntax ==

<pre>function onPlayerCrashDump( player, CrashReport )</pre>

== Arguments ==

* '''player''' - He is who is crash
* '''CrashReport''' - ...

== Example ==

<source lang="squirrel">
function onPlayerCrashDump( player, CrashReport ) Message( "** " + player.Name + " left server. [Crash]!" );
</source>

=== Notes ===

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

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}