Vice City Multiplayer - User contributions [en]

Scripting/Squirrel/Functions/CreateSphere

2015-06-19T16:02:16Z

NE.CrystalBlue:

This function will create a sphere.

== Syntax ==

'''1'''
<pre>CreateSphere( player, world, pos, rgb, radius )</pre>

== Arguments ==

'''1'''
* ''int'' '''player''' - The player to stream this sphere to. If player is null it will be shown to everyone
* ''int'' '''world''' - The world id
* ''Vector'' '''pos''' - The sphere pos
* ''int'' '''rgb''' - The sphere color
* ''int'' '''radius''' - The diameter of the sphere

== Example ==
The following example will create a sphere
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "sph" )
{
CreateSphere( player, player.World, player.Pos, RGB(255, 0, 255), 2);
}
}
</source>

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Sphere_Functions}}

Scripting/Squirrel/Functions/CreateSphere

2015-06-19T16:01:34Z

NE.CrystalBlue: Created page with "This function will create a sphere. == Syntax == '''1''' <pre>CreateSphere( player, world, pos, rgb, radius )</pre> == Arguments == '''1''' * ''int'' '''player''' - The pl..."

This function will create a sphere.

== Syntax ==

'''1'''
<pre>CreateSphere( player, world, pos, rgb, radius )</pre>

== Arguments ==

'''1'''
* ''int'' '''player''' - The player to stream this sphere to. If player is null it will be shown to everyone
* ''int'' '''world''' - The world id
* ''Vector'' '''pos''' - The sphere pos
* ''int'' '''rg''' - The sphere color
* ''int'' '''radius''' - The diameter of the sphere

== Example ==
The following example create a sphere
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "sph" )
{
CreateSphere( player, player.World, player.Pos, RGB(255, 0, 255), 2);
}
}
</source>

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Sphere_Functions}}

Server-side Scripting Resources

2015-05-19T12:13:33Z

NE.CrystalBlue: /* 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]

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

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

Game Text Codes and Styles

2015-03-28T05:19:31Z

NE.CrystalBlue:

{| 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" | Game Text Codes and Styles
|-
| style="padding:10px;" |
Here is a full list of all available game text codes and styles that are usable.
*'''Note:''' You can use them via [[Announce]] / [[AnnounceAll]].

{| class="wikitable"
|-
!Symbol
!Description
|-
!~b~
!style="color:rgb(27,89,130)" | blue text
|-
!~g~
!style="color:rgb(255,150,225)" | hot pink text (default)
|-
!~h~
!white text
|-
!~l~
!forces text to default color and ignores set colors
|-
!~o~
!style="color:rgb(229,125,126)" | pink text
|-
!~p~
!style="color:rgb(168,110,252)" | purple text
|-
!~q~
!style="color:rgb(199,144,203)" | plum pink text
|-
!~r~
!style="color:rgb(255,150,225)" | hot pink text
|-
!~t~
!style="color:rgb(86,212,146)" | green text
|-
!~w~
!gray text
|-
!~x~
!style="color:rgb(175,175,175)" | light blue text
|-
!~y~
!style="color:rgb(132,146,197)" | yellow text
|-
!------------------------------
!-----------------------------------------------------------------
|-
!<
!armor icon
|-
!>
!wanted level (star) icon
|-
!{
!heart icon
|-
!}
!dollar sign icon (not "$")
|-
!_
!degree symbol (°)
|-
!@
!trademark symbol (™)
|-
!^
!inverted exclamation mark (¡)
|-
!------------------------------
!-----------------------------------------------------------------
|-
!\x10 or \n or \f
!next stage
|-
!\x87
!smaller exclamation mark
|-
!\x99 or ™
!R from Recording in Single Player (when you press F1)
|-
!\x94
!shoes ?
|-
!\x103
!weird u
|-
!\x183
!weird n
|}
</div>
|-
|}

*Some text styles can be combined, but not all ! Give it a try. ;)
*Here is an example:
[[File:TextStyleCombined.jpg|500px|thumb|left|alt text]]

{| 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:10px;" |

{| class="wikitable"
!Style ID
!Screenshot
|-
!0
|[[File:TextStyle0.jpg]]
|-
!1
|[[File:TextStyle1.jpg]]
|-
!2
|[[File:TextStyle2.jpg‎]]
|-
!3
|[[File:TextStyle3.jpg‎]]
|-
!4
|[[File:TextStyle4.jpg‎]]
|-
!5
|[[File:TextStyle5.jpg‎|1020px|thumb|left|alt text]]
|-
!6
|[[File:TextStyle6.jpg]]
|-
!7
|[[File:TextStyle7.jpg‎]]
|-
!8
|[[File:TextStyle8.jpg‎]]
|}

</div>
|}

Scripting/Squirrel/Functions/ClientMessage

2015-02-22T05:53:18Z

NE.CrystalBlue:

This function will send a coloured message to a player.

== Syntax ==

<pre>ClientMessage( message, player, R, G, B )</pre>

== Arguments ==

* ''string'' '''message''' - The message to send
* ''[[Scripting/Squirrel/Functions#Player Functions|Player]]'' '''playerTo''' - The player to send the message to
* ''int'' '''R''' - The amount of red
* ''int'' '''G''' - The amount of green
* ''int'' '''B''' - The amount of blue

== Example ==

<source lang=squirrel>function onPlayerJoin(player)
{
ClientMessage("Welcome to our server, [#B200FF]and have fun!");
}</source>

=== Notes ===

Hexadecimal color codes surrounded by square brackets ([#RRGGBB]) will change the color of the text preceding it.

== Related Functions ==

{{Scripting/Squirrel/Functions/Messages}}

OnScriptUnload

2015-02-22T05:48:49Z

NE.CrystalBlue:

== Description ==

Executed when the script is removed from memory

== Example ==

<source lang="squirrel">
function onScriptUnload()
{
print( "== Unloaded Squirrel VC:MP Script ==" );
}
</source>

OnScriptLoad

2015-02-22T05:32:30Z

NE.CrystalBlue:

== Description ==

Executed whenever the script is loaded (including reload)

== Example ==

<source lang="squirrel">
function onScriptLoad()
{
print( "== Loaded Squirrel VC:MP Script ==" );
}
</source>

Scripting/Squirrel/Functions/Quaternion

2015-02-22T05:28:27Z

NE.CrystalBlue:

== Syntax ==

<pre>Quaternion( X, Y, Z, W )</pre>

== Arguments ==

* ''float'' '''X''' - X coordinate
* ''float'' '''Y''' - Y coordinate
* ''float'' '''Z''' - Z coordinate
* ''float'' '''W''' - Rotation

== Example ==

<source lang="squirrel">function onPlayerCommand( player, cmd, passed )
{
if ( cmd == "resetangles" )
{
player.Angle = Quaternion(0, 0, 0, 0);
}
}</source>

== Description ==

Quaternion is used to locate fourth dimensional points

=== Notes ===

Prefer to use Vector as it is easier

== Related Functions ==

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

Scripting/Squirrel/Functions/Quaternion

2015-02-22T05:25:21Z

NE.CrystalBlue:

{{Scripting/Needs_Text}}

== Syntax ==

<pre>Quaternion( X, Y, Z, W )</pre>

== Arguments ==

* ''float'' '''X''' - X coordinate
* ''float'' '''Y''' - Y coordinate
* ''float'' '''Z''' - Z coordinate
* ''float'' '''W''' - Rotation

== Example ==

<source lang="squirrel">function onPlayerCommand( player, cmd, passed )
{
if ( cmd == "resetangles" )
{
player.Angle = Quaternion(0, 0, 0, 0);
}
}</source>

=== Notes ===

Quaternion is used for locating fourth dimensional points

== Related Functions ==

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