Vice City Multiplayer - User contributions [en]

Server-side Scripting Resources

2015-03-07T14:06:24Z

RObInX: /* Scripts */

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

* [http://forum.vc-mp.org/?topic=332.0 ADM Script]

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

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

</div>
|}

Server-side Scripting Resources

2015-03-07T14:05:22Z

RObInX: /* Scripts */

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

* [ http://forum.vc-mp.org/?topic=332.0 ADM Script]

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

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

</div>
|}

OnPlayerCrashDump

2015-03-05T09:39:54Z

RObInX: /* Arguments */

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''' - One who crashed
* '''CrashReport''' - Reason

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

Scripting/Squirrel/Functions/SetTime

2015-03-03T16:06:46Z

RObInX: /* Example */

This function will set the game minute.

== Syntax ==

<pre>SetTime( hour, minute )</pre>

== Arguments ==

* ''int'' '''hour''' - The hour of the game (from 00 to 23)
* ''int'' '''minute''' - The minute of the game (from 00 to 59)

== Example ==

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "settime" )
{
If ( !text ) MessagePlayer( "Format: /settime <hr> <min>"", player );
else
{
local a = split(text, " ")
if ( !IsNum( a[0] ) MessagePlayer( "Format: /settime <hr> <min>"", player );
else if ( !IsNum( a[1] ) MessagePlayer( "Format: /settime <hr> <min>"", player );
else SetTime( a[0], a[1] );
}
}
}
</source>

=== Notes ===

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

User:RObInX

2015-03-02T09:38:00Z

RObInX: Created page with "Welcome to rObInX's page. My works: [http://vcmp.liberty-unleashed.co.uk/forum/index.php?action=profile;area=showposts;sa=topics;u=595 Here]"

Welcome to rObInX's page.
My works: [http://vcmp.liberty-unleashed.co.uk/forum/index.php?action=profile;area=showposts;sa=topics;u=595 Here]

Scripting/Squirrel/Functions/GetServerName

2015-03-02T09:32:24Z

RObInX: /* Notes */

This function will get the server name.

== Syntax ==

<pre>GetServerName()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''string'' '''servername''' - The name of the server

== Example ==
The following example messages the server name ingame.
<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
If (cmd == "server")
{
Message("Server Name:" + GetServerName());
}
}
</source>
== Notes ==
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetServerName

2015-03-02T09:30:39Z

RObInX: /* Example */

This function will get the server name.

== Syntax ==

<pre>GetServerName()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''string'' '''servername''' - The name of the server

== Example ==
The following example messages the server name ingame.
<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
If (cmd == "server")
{
Message("Server Name:" + GetServerName());
}
}
</source>
== Notes ==

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetServerName

2015-03-02T09:29:43Z

RObInX: /* Example */

This function will get the server name.

== Syntax ==

<pre>GetServerName()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''string'' '''servername''' - The name of the server

== Example ==
The following example messages the server name ingame.
<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
If (cmd == "server")
{
Message("Server Name:" + GetServerName());
}
}

== Notes ==

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetServerName

2015-03-02T09:28:49Z

RObInX: /* Example */

This function will get the server name.

== Syntax ==

<pre>GetServerName()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''string'' '''servername''' - The name of the server

== Example ==
The following example messages the server name ingame.
<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
If (cmd == "server")
{
Message("Server Name:" + GetServerName());
}
}

===Notes===

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/CreateRadioStream

2015-03-02T09:17:18Z

RObInX: /* Example */

This function will add a online radio to vehicle's radio.

== Syntax ==

<pre>CreateRadioStream( radioName, radioURL, CanSelect )</pre>

== Arguments ==

* ''string'' '''radioName''' - The radio name
* ''string'' '''radioURL''' - The online radio URL
* ''bool'' '''CanSelect''' - Show the radio stream on vehicle's radio list.

== Example ==
The following is an example for radio stream. Link not provided.
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "radio" )
{
player.Vehicle.Radio = CreateRadioStream( "TestRadio", "YourURL", true );
}
}
</source>

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Game Functions}}