Vice City Multiplayer - User contributions [en]

Scripting/Squirrel/Functions/GetJoinMessages

2014-08-14T09:07:43Z

Rocky: /* Example */

This function will return the current status of the join messages.

== Syntax ==

<pre>GetJoinMessages()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''bool'' '''toggled''' - '''true''' or '''false'''

== Example ==
The following example messages if join message is enabled or not when player types the command.<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "messages" )
{
if( GetJoinMessages() ) MessagePlayer("Join messages are enabled.", player );
else MessagePlayer("Join messages are disabled.", player );
}
</source>

=== Notes ===
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/Server_Settings}}

Scripting/Squirrel/Functions/SetServerPassword

2014-08-14T08:59:00Z

Rocky: /* Example */

This function will set the server password.

== Syntax ==

<pre>SetServerPassword( password )</pre>

== Arguments ==

* ''string'' '''password''' - The password to set

This command will change the server password when a player types '/c setpass anystring'.

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

=== Notes ===

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/FindVehicle

2014-08-14T08:57:05Z

Rocky: /* Example */

__NOTOC__
This finds a vehicle from an id and returns the pointer

== Syntax ==

<code>vehicle FindVehicle( int id )</code>

== Arguments ==

* '''id''' - The ID of the vehicle to find

== Example ==

Now we will create a simple spawncar command. Type /c spawn VehicleID. The vehicle will be moved to the player, that uses this command. The FindVehicle function is here very important.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "spawn" )
{
local veh = FindVehicle( text.tointeger() );
if ( !veh ) PrivMessage( "Error: Wrong ID of the vehicle.", player );
else {
PrivMessage( "Spawning vehicle " + veh + ".", player );
veh.Pos = Vector( ( player.Pos.x + 2 ), ( player.Pos.y + 1 ),( player.Pos.z - 1.12 ) );
}
}

}
</source>

=== Notes ===
The functions [[Scripting/Squirrel/Functions/Misc/PrivMessage|PrivMessage]], [[Scripting/Squirrel/Functions/Vehicles/Pos|vehicle.Pos]] and call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in in this example. More info about them in the corresponding pages.

Scripting/Squirrel/Functions/FindVehicle

2014-08-14T08:55:49Z

Rocky: /* Related Functions */

__NOTOC__
This finds a vehicle from an id and returns the pointer

== Syntax ==

<code>vehicle FindVehicle( int id )</code>

== Arguments ==

* '''id''' - The ID of the vehicle to find

== Example ==

Now we will create a simple spawncar command. Type /c spawn VehicleID. The vehicle will be moved to the player, that uses this command. The FindVehicle function is here very important.

<code lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "spawn" )
{
local veh = FindVehicle( text.tointeger() );
if ( !veh ) PrivMessage( "Error: Wrong ID of the vehicle.", player );
else {
PrivMessage( "Spawning vehicle " + veh + ".", player );
veh.Pos = Vector( ( player.Pos.x + 2 ), ( player.Pos.y + 1 ),( player.Pos.z - 1.12 ) );
}
}

}
</code>

=== Notes ===
The functions [[Scripting/Squirrel/Functions/Misc/PrivMessage|PrivMessage]], [[Scripting/Squirrel/Functions/Vehicles/Pos|vehicle.Pos]] and call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in in this example. More info about them in the corresponding pages.

Scripting/Squirrel/Functions/FindVehicle

2014-08-14T08:44:50Z

Rocky: Created page with "__NOTOC__ This finds a vehicle from an id and returns the pointer == Syntax == <code>vehicle FindVehicle( int id )</code> == Arguments == * '''id''' - The ID of the vehicl..."

__NOTOC__
This finds a vehicle from an id and returns the pointer

== Syntax ==

<code>vehicle FindVehicle( int id )</code>

== Arguments ==

* '''id''' - The ID of the vehicle to find

== Example ==

Now we will create a simple spawncar command. Type /c spawn VehicleID. The vehicle will be moved to the player, that uses this command. The FindVehicle function is here very important.

<code lang="squirrel">
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "spawn" )
{
local veh = FindVehicle( text.tointeger() );
if ( !veh ) PrivMessage( "Error: Wrong ID of the vehicle.", player );
else {
PrivMessage( "Spawning vehicle " + veh + ".", player );
veh.Pos = Vector( ( player.Pos.x + 2 ), ( player.Pos.y + 1 ),( player.Pos.z - 1.12 ) );
}
}

}
</code>

=== Notes ===
The functions [[Scripting/Squirrel/Functions/Misc/PrivMessage|PrivMessage]], [[Scripting/Squirrel/Functions/Vehicles/Pos|vehicle.Pos]] and call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Vehicles}}

Scripting/Squirrel/Functions/GetWaterLevel

2014-07-25T16:42:53Z

Rocky: /* Example */

This function will get the water level of the game.

== Syntax ==

<pre>GetWaterLevel()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''int'' '''waterlevel''' - The water level of the game (default is 6)

== Example ==
The following example messages current water level to everyone when someone types the command.<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "waterlvl" ) Message( GetWaterLevel().tostring() );
}
</source>

=== Notes ===
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/Server_Settings}}