Vice City Multiplayer - User contributions [en]

Scripting/Squirrel/Client Functions/System::GetTimestamp

2018-10-02T14:34:06Z

Human.:

This function returns the number of seconds since the UNIX epoch; equivalent to Squirrel's time function: [http://squirrel-lang.org/squirreldoc/stdlib/stdsystemlib.html#time]

== Syntax ==
<pre>System.GetTimestamp()</pre>

== Return type ==

'''integer'''

== Example ==
<source lang=squirrel>
/* Player::PlayerDeath is triggered whenever someone die, we are going to use this for the sake of example */
function Player::PlayerDeath( player )
{
/* Check whether the player that just died is local player/self by comparing ID */
if ( player.ID == World.FindLocalPlayer( ).ID )
{
/* Get epoch time */
local time = System.GetTimestamp( );

/* Show the epoch time of death to local player/self */
Console.Print( player.Name +" died at "+ time );
}
}
</source>

=== Notes ===
[[Scripting/Squirrel/Client_Events/Player::PlayerDeath|Player::PlayerDeath]], [[Scripting/Squirrel/Client_Functions/World::FindLocalPlayer|World::FindLocalPlayer]] and [[Scripting/Squirrel/Client_Functions/Console::Print|Console::Print]]
were used in this example, more info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/GUI::GetMousePos

2018-10-02T14:27:53Z

Human.: /* Example */

This function returns mouse position of the player.

== Syntax ==
<pre>GUI.GetMousePos()</pre>

== Return type ==

'''VectorScreen'''

== Example ==
<source lang=squirrel>
/* Player::PlayerDeath is triggered whenever someone die, we are going to use this for the sake of example */
function Player::PlayerDeath( player )
{
/* Check whether the player that just died is local player/self by comparing ID */
if ( player.ID == World.FindLocalPlayer( ).ID )
{
/* Get player's mouse position */
local mousePos = GUI.GetMousePos( );

if ( mousePos ) {
/* Send message about mouse position to local player/self */
Console.Print( "Mouse position - X: "+ mousePos.X +", Y: "+ mousePos.Y );
}
}
}
</source>

=== Notes ===
[[Scripting/Squirrel/Client_Events/Player::PlayerDeath|Player::PlayerDeath]], [[Scripting/Squirrel/Client_Functions/World::FindLocalPlayer|World::FindLocalPlayer]] and [[Scripting/Squirrel/Client_Functions/Console::Print|Console::Print]]
were used in this example, more info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/System::GetDate

2018-10-02T14:27:13Z

Human.: /* Example */

This function returns a table containing a date/time splitted as in the table under '''Return type'''. It follows same syntax as the Squirrel standard library's date function: [http://squirrel-lang.org/squirreldoc/stdlib/stdsystemlib.html#date]

== Syntax ==
<pre>System.GetDate([time], [format]])</pre>
'''time''' and '''format''' are optional.

== Return type ==

'''table'''
<div>
{| class="wikitable"
!Name
!Description
|-
|sec
|Seconds after minute (0 - 59)
|-
|min
|Minutes after hour (0 - 59)
|-
|hour
|Hours since midnight (0 - 23)
|-
|day
|Day of month (1 - 31)
|-
|month
|Month (0 - 11; January = 0)
|-
|year
|Year (current year)
|-
|wday
|Day of week (0 - 6; Sunday = 0)
|-
|yday
|Day of year (0 - 365; January 1 = 0)
|}
</div>

== Example ==
<source lang=squirrel>
/* Player::PlayerDeath is triggered whenever someone die, we are going to use this for the sake of example */
function Player::PlayerDeath( player )
{
/* Check whether the player that just died is local player/self by comparing ID */
if ( player.ID == World.FindLocalPlayer().ID )
{
local now = System.GetDate();

// hour:minute:sec
local ftTime = format( "%i:%i:%i", now.hour, now.min, now.sec );

/* Send message about the time of death to local player/self */
Console.Print( player.Name +" died at "+ ftTime );
}
}
</source>

=== Notes ===
[[Scripting/Squirrel/Client_Events/Player::PlayerDeath|Player::PlayerDeath]], [[Scripting/Squirrel/Client_Functions/World::FindLocalPlayer|World::FindLocalPlayer]] and [[Scripting/Squirrel/Client_Functions/Console::Print|Console::Print]]
were used in this example, more info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/GUI::GetMousePos

2018-10-02T14:26:27Z

Human.: Created page with "This function returns mouse position of the player. == Syntax == <pre>GUI.GetMousePos()</pre> == Return type == '''VectorScreen''' == Example == <source lang=squirrel> /*..."

This function returns mouse position of the player.

== Syntax ==
<pre>GUI.GetMousePos()</pre>

== Return type ==

'''VectorScreen'''

== Example ==
<source lang=squirrel>
/* Player::PlayerDeath is triggered whenever someone die, we are going to use this for the sake of example */
function Player::PlayerDeath( player )
{
/* Check whether the player that just died is local player/self by comparing ID */
if ( player.ID == World.FindLocalPlayer( ).ID )
{
/* Get player's mouse position */
local mousePos = GUI.GetMousePos( );

if ( mousePos ) {
/* Send message to player about his mouse position */
Console.Print( "Mouse position - X: "+ mousePos.X +", Y: "+ mousePos.Y );
}
}
}
</source>

=== Notes ===
[[Scripting/Squirrel/Client_Events/Player::PlayerDeath|Player::PlayerDeath]], [[Scripting/Squirrel/Client_Functions/World::FindLocalPlayer|World::FindLocalPlayer]] and [[Scripting/Squirrel/Client_Functions/Console::Print|Console::Print]]
were used in this example, more info about them in the corresponding pages.

Scripting/Squirrel/Functions/Player.GetAmmoAtSlot

2018-10-02T14:09:57Z

Human.: Created page with "This function is used to get the ammo of the weapon that player is carrying at the entered slot ID. == Syntax == <pre>Player.GetAmmoAtSlot( slot );</pre> == Arguments == *..."

This function is used to get the ammo of the weapon that player is carrying at the entered slot ID.

== Syntax ==

<pre>Player.GetAmmoAtSlot( slot );</pre>

== Arguments ==

* ''int'' '''slot''' - The weapon slot ID.

== Example ==
<source lang=squirrel>
/* Comments about what each slot stores.
Slot 0: Hats, unarmed, Brass, etc...
Slot 1: Katana, chainsaw, hammer, etc...
Slot 2: Grenades, molotov, tear gas, etc...
Slot 3: Colt45, Python, etc...
Slot 4: Stubby, Spaz, Shotgun, etc...
Slot 5: Uzi, MP5, Ingram, etc...
Slot 6: M4, Ruger, etc...
Slot 7: M60, RPG, Minigun, etc...
Slot 8: Laser sniper, sniper, etc...
*/

function onPlayerCommand( player, cmd, text )
{
if ( cmd == "myweps" || cmd == "mywep" )
{
local wepID, wepAmmo;

for (local i = 0; i <= 8; i++)// Loops from slot 0 to 8.
{
wepID = player.GetWeaponAtSlot(i); // Will return the weapon's ID
wepAmmo = player.GetAmmoAtSlot(i); // Will return the weapon's ammo

// Displays the weapon's name and ammo of each slot( 0 - 8 )
MessagePlayer( "Weapon at slot " + i + ": "+ GetWeaponName(wepID) +" (ammo: "+ wepAmmo +")", player );
}
}
}

</source>
=== Notes ===
[[onPlayerCommand]], [[Scripting/Squirrel/Functions/GetWeaponName|GetWeaponName]], [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] and [[Scripting/Squirrel/Functions/Player.GetWeaponAtSlot|Player.GetWeaponAtSlot]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Player_Functions}}

== Related Functions ==

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

Scripting/Squirrel/Client Functions/System::GetDate

2018-09-28T16:58:44Z

Human.:

This function returns a table containing a date/time splitted as in the table under '''Return type'''. It follows same syntax as the Squirrel standard library's date function: [http://squirrel-lang.org/squirreldoc/stdlib/stdsystemlib.html#date]

== Syntax ==
<pre>System.GetDate([time], [format]])</pre>
'''time''' and '''format''' are optional.

== Return type ==

'''table'''
<div>
{| class="wikitable"
!Name
!Description
|-
|sec
|Seconds after minute (0 - 59)
|-
|min
|Minutes after hour (0 - 59)
|-
|hour
|Hours since midnight (0 - 23)
|-
|day
|Day of month (1 - 31)
|-
|month
|Month (0 - 11; January = 0)
|-
|year
|Year (current year)
|-
|wday
|Day of week (0 - 6; Sunday = 0)
|-
|yday
|Day of year (0 - 365; January 1 = 0)
|}
</div>

== Example ==
<source lang=squirrel>
/* Player::PlayerDeath is triggered whenever someone die */
function Player::PlayerDeath( player )
{
/* Check whether the player that just died is local player/self */
if ( player.ID == World.FindLocalPlayer().ID )
{
local now = System.GetDate();

// hour:minute:sec
local ftTime = format( "%i:%i:%i", now.hour, now.min, now.sec );

/* Show the time of player's death to local player/self. This is just for example */
Console.Print( player.Name +" died at "+ ftTime );
}
}
</source>

=== Notes ===
[[Scripting/Squirrel/Client_Events/Player::PlayerDeath|Player::PlayerDeath]], [[Scripting/Squirrel/Client_Functions/World::FindLocalPlayer|World::FindLocalPlayer]] and [[Scripting/Squirrel/Client_Functions/Console::Print|Console::Print]]
were used in this example, more info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/System::GetDate

2018-09-28T16:54:43Z

Human.:

This function returns a table containing a date/time splitted as in table below '''Return type'''. It follows same syntax as the Squirrel standard library's date function: [http://squirrel-lang.org/squirreldoc/stdlib/stdsystemlib.html#date]

== Syntax ==
<pre>System.GetDate([time], [format]])</pre>
'''time''' and '''format''' are optional.

== Return type ==

'''table'''
<div>
{| class="wikitable"
!Name
!Description
|-
|sec
|Seconds after minute (0 - 59)
|-
|min
|Minutes after hour (0 - 59)
|-
|hour
|Hours since midnight (0 - 23)
|-
|day
|Day of month (1 - 31)
|-
|month
|Month (0 - 11; January = 0)
|-
|year
|Year (current year)
|-
|wday
|Day of week (0 - 6; Sunday = 0)
|-
|yday
|Day of year (0 - 365; January 1 = 0)
|}
</div>

== Example ==
<source lang=squirrel>
/* Player::PlayerDeath is triggered whenever someone die */
function Player::PlayerDeath( player )
{
/* Check whether the player that just died is local player/self */
if ( player.ID == World.FindLocalPlayer().ID )
{
local now = System.GetDate();

// hour:minute:sec
local ftTime = format( "%i:%i:%i", now.hour, now.min, now.sec );

/* Show the time of player's death to local player/self. This is just for example */
Console.Print( player.Name +" died at "+ ftTime );
}
}
</source>

=== Notes ===
[[Scripting/Squirrel/Client_Events/Player::PlayerDeath|Player::PlayerDeath]], [[Scripting/Squirrel/Client_Functions/World::FindLocalPlayer|World::FindLocalPlayer]] and [[Scripting/Squirrel/Client_Functions/Console::Print|Console::Print]]
were used in this example, more info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/System::GetDate

2018-09-28T16:52:47Z

Human.: Created page with "This function returns a table containing a date/time splitted in the slots. It follows same syntax as the Squirrel standard library's date function: [http://squirrel-lang.org/..."

This function returns a table containing a date/time splitted in the slots. It follows same syntax as the Squirrel standard library's date function: [http://squirrel-lang.org/squirreldoc/stdlib/stdsystemlib.html#date]

== Syntax ==
<pre>System.GetDate([time], [format]])</pre>
'''time''' and '''format''' are optional.

== Return type ==

'''table'''
<div>
{| class="wikitable"
!Name
!Description
|-
|sec
|Seconds after minute (0 - 59)
|-
|min
|Minutes after hour (0 - 59)
|-
|hour
|Hours since midnight (0 - 23)
|-
|day
|Day of month (1 - 31)
|-
|month
|Month (0 - 11; January = 0)
|-
|year
|Year (current year)
|-
|wday
|Day of week (0 - 6; Sunday = 0)
|-
|yday
|Day of year (0 - 365; January 1 = 0)
|}
</div>

== Example ==
<source lang=squirrel>
/* Player::PlayerDeath is triggered whenever someone die */
function Player::PlayerDeath( player )
{
/* Check whether the player that just died is local player/self */
if ( player.ID == World.FindLocalPlayer().ID )
{
local now = System.GetDate();

// hour:minute:sec
local ftTime = format( "%i:%i:%i", now.hour, now.min, now.sec );

/* Show the time of player's death to local player/self. This is just for example */
Console.Print( player.Name +" died at "+ ftTime );
}
}
</source>

=== Notes ===
[[Scripting/Squirrel/Client_Events/Player::PlayerDeath|Player::PlayerDeath]], [[Scripting/Squirrel/Client_Functions/World::FindLocalPlayer|World::FindLocalPlayer]] and [[Scripting/Squirrel/Client_Functions/Console::Print|Console::Print]]
were used in this example, more info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/System::GetTimestamp

2018-09-28T16:33:42Z

Human.: /* Example */

This function returns the number of seconds since the UNIX epoch; equivalent to Squirrel's time function: [http://squirrel-lang.org/squirreldoc/stdlib/stdsystemlib.html#time]

== Syntax ==
<pre>System.GetTimestamp()</pre>

== Return type ==

'''integer'''

== Example ==
<source lang=squirrel>
/* Player::PlayerDeath is triggered whenever someone die */
function Player::PlayerDeath( player )
{
/* Check whether the player that just died is local player/self */
if ( player.ID == World.FindLocalPlayer( ).ID )
{
/* Get epoch time */
local time = System.GetTimestamp( );

/* Show the epoch time of player's death to local player/self. This is just for example */
Console.Print( player.Name +" died at "+ time );
}
}
</source>

=== Notes ===
[[Scripting/Squirrel/Client_Events/Player::PlayerDeath|Player::PlayerDeath]], [[Scripting/Squirrel/Client_Functions/World::FindLocalPlayer|World::FindLocalPlayer]] and [[Scripting/Squirrel/Client_Functions/Console::Print|Console::Print]]
were used in this example, more info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/System::GetTimestamp

2018-09-28T16:31:54Z

Human.: Created page with "This function returns the number of seconds since the UNIX epoch; equivalent to Squirrel's time function: [http://squirrel-lang.org/squirreldoc/stdlib/stdsystemlib.html#time]..."

This function returns the number of seconds since the UNIX epoch; equivalent to Squirrel's time function: [http://squirrel-lang.org/squirreldoc/stdlib/stdsystemlib.html#time]

== Syntax ==
<pre>System.GetTimestamp()</pre>

== Return type ==

'''integer'''

== Example ==
<source lang=squirrel>
/* Player::PlayerDeath is triggered whenever someone die */
function Player::PlayerDeath( player )
{
/* Check whether the player that just died is local player/self */
if ( player.ID == World.FindLocalPlayer( ).ID )
{
/* Get epoch time */
local time = System.GetTimestamp( );

/* Show the epoch time of player's death. This is just for example */
Console.Print( player.Name +" died at "+ time );
}
}
</source>

=== Notes ===
[[Scripting/Squirrel/Client_Events/Player::PlayerDeath|Player::PlayerDeath]], [[Scripting/Squirrel/Client_Functions/World::FindLocalPlayer|World::FindLocalPlayer]] and [[Scripting/Squirrel/Client_Functions/Console::Print|Console::Print]]
were used in this example, more info about them in the corresponding pages.

Scripting/Squirrel/Client Functions

2018-05-10T08:18:51Z

Human.: /* Global Functions */

== Global Functions ==
=== Script Functions ===
* [[Scripting/Squirrel/Client_Functions/dofile|dofile]](string filename)
* [[Scripting/Squirrel/Client_Functions/Script::LoadScript|Script::LoadScript]](string filename) <font color=green>// Same as dofile.</font>
* [[Scripting/Squirrel/Client_Functions/include|include]](string filename)
* [[Scripting/Squirrel/Client_Functions/print|print]](string text)
* [[Scripting/Squirrel/Client_Functions/Script::GetTicks|Script::GetTicks]]()

=== World Functions ===
* [[Scripting/Squirrel/Client_Functions/World::FindPlayer|World::FindPlayer]](int id)
* [[Scripting/Squirrel/Client_Functions/World::FindLocalPlayer|World::FindLocalPlayer]]()
* [[Scripting/Squirrel/Client_Functions/World::FindVehicle|World::FindVehicle]](int id)

=== System Functions ===
* [[Scripting/Squirrel/Client_Functions/System::GetDate|System::GetDate]]([timestamp, [format]])
* [[Scripting/Squirrel/Client_Functions/System::GetTimestamp|System::GetTimestamp]]()

=== Console Functions ===
* [[Scripting/Squirrel/Client_Functions/Console::Print|Console::Print]](string text)

=== GUI Functions ===
* [[Scripting/Squirrel/Client_Functions/GUI::GetMouseEnabled|GUI::GetMouseEnabled]]()
* [[Scripting/Squirrel/Client_Functions/GUI::SetMouseEnabled|GUI::SetMouseEnabled]](bool enabled)
* [[Scripting/Squirrel/Client_Functions/GUI::GetMousePos|GUI::GetMousePos]]()
* [[Scripting/Squirrel/Client_Functions/GUI::GetScreenSize|GUI::GetScreenSize]]()
* [[Scripting/Squirrel/Client_Functions/GUI::ScreenPosToWorld|GUI::ScreenPosToWorld]](Vector screenPosition)
* [[Scripting/Squirrel/Client_Functions/GUI::WorldPosToScreen|GUI::WorldPosToScreen]](Vector position)
* [[Scripting/Squirrel/Client_Functions/GUI::GetFocusedElement|GUI::GetFocusedElement]]()
* [[Scripting/Squirrel/Client_Functions/GUI::SetFocusedElement|GUI::SetFocusedElement]](GUIElement element)

== Data Types ==
Types int, float, bool and string are built-in types. entity is not an actual type, but can be any of either Player, Vehicle or Building. The actual type can be detected from the return value of entity.Type which is respectively OBJ_PLAYER, OBJ_VEHICLE or OBJ_BUILDING for them.

The values of properties marked as read-only cannot be changed. If a property is marked as bound, then it means the instance of for example a Vector that you get from it is bound to the object. Therefore if you do var = player.Position;, var.X will always contain the player's X position, not the X position when var was assigned. To get an unbound vector, use var = Vector(player.Position);.
{{Scripting/Squirrel/Functions/Client_DataTypes}}

== GUI Types ==
{{Scripting/Squirrel/Functions/Client_GUITypes}}

Scripting/Squirrel/Functions/Player.Immunity

2018-01-30T13:59:41Z

Human.:

This function is used to get or set a player's immunity.

== Syntax ==

<pre>player.Immunity = flags;</pre>

== Flags ==

1 = bulletproof | 2 = fireproof | 4 = explosion-proof | 8 = collision-proof | 16 = melee-proof | 32 = immune to falling down | 64 = immune to critical shot/headshot

0 means no immunity, 127 means full immunity. You can add all the numbers together or use bitwise OR/AND to toggle flags.

== Example ==

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "showimmunity" )
{
/* Show your immunity */
MessagePlayer( "Your immunity: "+ player.Immunity, player );
}
else if ( cmd == "setimmunity" )
{
/* You can also add up the numbers such as ( 1 + 2 + 4 + 6 + 8 + 16 ) is equal to 31 */
player.Immunity = ( 1 | 2 | 4 | 8 | 16 );
MessagePlayer( "You are now immune to bullet, fire, explosion, collision and melee", player );
}
}
</source>

== Related Functions ==

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

Scripting/Squirrel/Functions/Player.Immunity

2018-01-30T13:55:35Z

Human.:

This function is used to get or set a player's immunity.

== Syntax ==

<pre>player.Immunity = flags;</pre>

== Flags ==

1 = bulletproof | 2 = fireproof | 4 = explosion-proof | 8 = collision-proof | 16 = melee-proof | 32 = immune to falling down | 64 = immune to critical shot/headshot

0 means no immunity, 127 means full immunity. You can add all the numbers together or use bitwise OR/AND to toggle flags.

== Example ==

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "showimmunity" )
{
/* Show your immunity */
MessagePlayer( "Your immunity: "+ player.Immunity, player );
}
else if ( cmd == "setimmunity" )
{
/* You can also add up the numbers such as ( 1 + 2 + 4 + 6 + 8 + 16 ) is equal to 31 */
player.Immunity = ( 1 | 2 | 4 | 8 | 16 );
MessagePlayer( "You are now immune to bullet, fire, explosion, collision and melee", player );
}
}

</source>

== Related Functions ==

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