Vice City Multiplayer - User contributions [en]

Server-side Scripting Resources

2016-12-11T11:56:28Z

Doom Killer:

{{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" | Server-side 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]

== Useful Resources ==

The following is a list of handy releases/resources to help you with big stuff

* [http://forum.vc-mp.org/?topic=1303.0 VC:MP Ingame Map Editor]

== Reference ==

* [[Scripting/Squirrel/Functions|Server Functions]]
* [[Scripting/Squirrel/Events|Server 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/squirrel3.html Squirrel Reference Manual]
* [http://squirrel-lang.org/doc/sqstdlib3.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>
|}

Player.Skin

2016-06-08T07:24:59Z

Doom Killer: Created page with "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>PlayerInstanc..."

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=squirrel>
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=squirrel>
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 );
player.Skin = text.tointeger();
MessagePlayer( "Your skin ID is: " + player.Skin, player );
}
}
</source>

== Related Functions ==

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

Scripting/Squirrel/Functions/SetShowOnlyTeamMarkers

2016-04-24T04:43:45Z

Doom Killer: /* Example */

This function will set the player's tag visible to only his/her team.

== Syntax ==

<pre>SetShowOnlyTeamMarkers ( bool );</pre>

== Arguments ==

'''bool''' True / false.

== Example ==

<source lang=squirrel>
function onScriptLoad ()
{
SetShowOnlyTeamMarkers( true );
print ( "Printing out the new state " + GetShowOnlyTeamMarkers() + "!");
}
</source>

- Xmair.
- Text misplacement fixed. [ Doom_Kill3R ]

=== Notes ===

Call [[onScriptLoad]] and [[GetShowOnlyTeamMarkers]] were used in this example.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/Player.PlaySound

2016-03-12T08:25:04Z

Doom Killer: Created page with "This function will play a sound for a specific player == Syntax == <pre>Player.PlaySound( sound )</pre> == Arguments == * ''instance'' '''Player''' - The player to play so..."

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>

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Game_Functions}}

OnCheckpointExited

2016-03-09T10:06:12Z

Doom Killer: Created page with "This is called when a player exits any checkpoint == Syntax == <pre>function onCheckpointExited( player, checkpoint )</pre> == Arguments == * '''player''' - The pointer of..."

This is called when a player exits any checkpoint

== Syntax ==

<pre>function onCheckpointExited( player, checkpoint )</pre>

== Arguments ==

* '''player''' - The pointer of the new player

* '''checkpoint''' - The pointer of the checkpoint

== Example ==

<source lang="squirrel">
function onCheckpointExited( player, checkpoint )
{
MessagePlayer( "You have exited a checkpoint! ID: " + checkpoint.ID, player );
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] and [[Scripting/Squirrel/Functions/Checkpoint.ID|Checkpoint.ID]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Checkpoint_Events}}

OnCheckpointEntered

2016-03-09T10:04:47Z

Doom Killer: Created page with "This is called when a player enters any checkpoint == Syntax == <pre>function onCheckpointEntered( player, checkpoint )</pre> == Arguments == * '''player''' - The pointer..."

This is called when a player enters any checkpoint

== Syntax ==

<pre>function onCheckpointEntered( player, checkpoint )</pre>

== Arguments ==

* '''player''' - The pointer of the new player

* '''checkpoint''' - The pointer of the checkpoint

== Example ==

<source lang="squirrel">
function onCheckpointEntered( player, checkpoint )
{
MessagePlayer( "You have entered a checkpoint! ID: " + checkpoint.ID, player );
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] and [[Scripting/Squirrel/Functions/Checkpoint.ID|Checkpoint.ID]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Checkpoint_Events}}

Scripting/Squirrel/Functions/Player.IsOnRadar

2016-03-09T09:52:42Z

Doom Killer: Created page with "This function will set a user visible or invisible on radar. == Syntax == <pre>player.IsOnRadar = toggle</pre> == Arguments == * ''bool'' '''toggle''' - A boolean value re..."

This function will set a user visible or invisible on radar.

== Syntax ==

<pre>player.IsOnRadar = toggle</pre>

== Arguments ==

* ''bool'' '''toggle''' - A boolean value representing either visible ( true ) or invisible on radar ( false )

== Example ==
<pre>function onPlayerCommand( player, cmd, text )
{
if( cmd == "hide" )
{
player.IsOnRadar = !player.IsOnRadar;
if( player.IsOnRadar ) return MessagePlayer( "* You are visible on radar!", player );
else if( !player.IsOnRadar ) return MessagePlayer( "* You are invisible on radar!", player );
}
}

Scripting/Squirrel/Functions/Pickup.Remove

2016-03-09T09:45:34Z

Doom Killer: Created page with "== Syntax == <pre>bool Pickup.Remove</pre> == Arguments == '''> Pickup''' - The pickup instance. == Example == This example will create a pickup when the script loads and..."

== Syntax ==

<pre>bool Pickup.Remove</pre>

== Arguments ==

'''> Pickup''' - The pickup instance.

== Example ==

This example will create a pickup when the script loads and deletes it when it unloads.

<pre>function onScriptLoad()
{
myPickup <- CreatePickup( 284, 1, Vector( -2261.12, 753.12, 211.123 ) );
}

function onScriptUnload()
{
myPickup.Remove();
}
</pre>

Scripting/Squirrel/Functions/Pickup.Pos

2016-03-09T09:43:10Z

Doom Killer: /* Arguments */

== Syntax ==

<pre>vector Pickup.Pos = Vector( X, Y, Z )</pre>

== Arguments ==

'''> Pickup''' - The pickup instance.

'''> X''' - The X-axis float point.

'''> Y''' - The Y-axis float point.

'''> Z''' - The Z-axis float point.

== Example ==

This example will create a pickup and set its position to the center of map.

<pre>function onScriptLoad()
{
myPickup <- CreatePickup( 284, 1, Vector( -2261.12, 753.12, 211.123 ) );
myPickup.Pos = Vector( 0, 0, 0 );
}
</pre>

Scripting/Squirrel/Functions/Pickup.Pos

2016-03-09T09:42:21Z

Doom Killer: Created page with "== Syntax == <pre>vector Pickup.Pos = Vector( X, Y, Z )</pre> == Arguments == '''> Pickup''' - The pickup instance. '''> X''' - The X-axis float point. '''> Y''' - The Y-ax..."

== Syntax ==

<pre>vector Pickup.Pos = Vector( X, Y, Z )</pre>

== Arguments ==

'''> Pickup''' - The pickup instance.
'''> X''' - The X-axis float point.
'''> Y''' - The Y-axis float point.
'''> Z''' - The Z-axis float point.

== Example ==

This example will create a pickup and set its position to the center of map.

<pre>function onScriptLoad()
{
myPickup <- CreatePickup( 284, 1, Vector( -2261.12, 753.12, 211.123 ) );
myPickup.Pos = Vector( 0, 0, 0 );
}
</pre>

Scripting/Squirrel/Functions/Player.CameraLocked

2016-03-09T09:36:35Z

Doom Killer: /* Syntax */

== Syntax ==

<pre>bool Player.CameraLocked</pre>

== Arguments ==

'''> Player''' - The player instance to lock camera for.

== Example ==

This example will set a player's camera locked.

<pre>function onPlayerSpawn( player )
{
player.CameraLocked = true;
}
</pre>

Scripting/Squirrel/Functions/Player.CameraLocked

2016-03-09T09:36:07Z

Doom Killer: /* Syntax */

== Syntax ==

''bool'' <pre>Player.CameraLocked</pre>

== Arguments ==

'''> Player''' - The player instance to lock camera for.

== Example ==

This example will set a player's camera locked.

<pre>function onPlayerSpawn( player )
{
player.CameraLocked = true;
}
</pre>

Scripting/Squirrel/Functions/Player.CameraLocked

2016-03-09T09:35:32Z

Doom Killer: Created page with "== Syntax == <pre>''bool'' Player.CameraLocked</pre> == Arguments == '''> Player''' - The player instance to lock camera for. == Example == This example will set a player..."

== Syntax ==

<pre>''bool'' Player.CameraLocked</pre>

== Arguments ==

'''> Player''' - The player instance to lock camera for.

== Example ==

This example will set a player's camera locked.

<pre>function onPlayerSpawn( player )
{
player.CameraLocked = true;
}
</pre>

Scripting/Squirrel/Functions/Player.Colour

2016-03-04T11:55:27Z

Doom Killer: /* Arguments */

== Syntax ==

<pre>Player.Colour = RGB( Red, Green, Blue )</pre>

== Arguments ==

'''> Player''' - The player instance to set colour of.

'''> RGB''' - A function used for defining colours in which Red, Green and Blue are the respective quantity of colours to add.

== Example ==

This example will set a player's colour on scoreboard and radar to a random colour.

<pre>function onPlayerSpawn( player )
{
player.Colour = RGB( rand() % 255, rand() % 255, rand() % 255 );
}
</pre>

Scripting/Squirrel/Functions/Player.Colour

2016-03-04T11:54:57Z

Doom Killer:

== Syntax ==

<pre>Player.Colour = RGB( Red, Green, Blue )</pre>

== Arguments ==

'''> Player''' - The player instance to set colour of.
'''> RGB''' - A function used for defining colours in which Red, Green and Blue are the respective quantity of colours to add.

== Example ==

This example will set a player's colour on scoreboard and radar to a random colour.

<pre>function onPlayerSpawn( player )
{
player.Colour = RGB( rand() % 255, rand() % 255, rand() % 255 );
}
</pre>

Scripting/Squirrel/Functions/Player.Colour

2016-03-04T11:51:41Z

Doom Killer: Created page with "== Syntax == <pre>Player.Colour = RGB( Red, Green, Blue )</pre> == Example == This example will set a player's colour on scoreboard and radar to a random colour. <pre>func..."

== Syntax ==

<pre>Player.Colour = RGB( Red, Green, Blue )</pre>

== Example ==

This example will set a player's colour on scoreboard and radar to a random colour.

<pre>function onPlayerSpawn( player )
{
player.Colour = RGB( rand() % 255, rand() % 255, rand() % 255 );
}
</pre>

Server-side Scripting Resources

2016-03-04T11:47:34Z

Doom Killer: /* 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

* [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]
* [http://forum.vc-mp.org/?topic=1303.0 VC:MP Ingame Map Editor]

== 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/squirrel3.html Squirrel Reference Manual]
* [http://squirrel-lang.org/doc/sqstdlib3.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.Alpha

2015-02-21T10:27:41Z

Doom Killer: /* Syntax */

Scripting/Squirrel/Functions/Player.Alpha

2015-02-21T10:27:27Z

Doom Killer: /* Example */

== Syntax ==

<pre>player.Alpha</pre>

Scripting/Squirrel/Functions/Player.Alpha

2015-02-21T10:25:39Z

Doom Killer: Created page with "== Syntax == <pre>player.Alpha</pre> == Example == The following example will set a player's alpha to 0, means hiding him: <source lang=squirrel> function onPlayerCommand(..."

== Syntax ==

<pre>player.Alpha</pre>

== Example ==
The following example will set a player's alpha to 0, means hiding him:

<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "hideme" )
{
player.Alpha = 0;
Message("You are now invisible!");
}
}
</source>

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

Scripting/Squirrel/Functions/BindKey

2015-02-21T10:21:55Z

Doom Killer: How to bind different keys for different actions in game, could be useful, created by Doom_Killer

'''Syntax'''

BindKey( bool:press, key, args..., args2...)

'''Arguments'''

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

'''key''' The key you bind at, you can get key codes from [http://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx Key Codes]

'''args...''' You can have this 0.

'''args2...''' You can have this 0.

'''Example'''

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

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

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

'''Notes'''

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