Vice City Multiplayer - User contributions [en]

Introduction to the Plugin SDK

2017-10-05T18:13:35Z

Xmair:

One of the major new features available in the 0.4 server is the plugin SDK. Any user can now use an official SDK header to create plugins that can be used to interact with the server, clients, game world and other plugins.

The current plugin SDK can be found here:

https://gist.github.com/nsgomez/e0b525ed660db7f83b56

https://bitbucket.org/maxorator/vcmp-plugin-header/src/fb1d2cb0dcfb7b56f0dfd469babb00f9da759d33/plugin.h?at=default&fileviewer=file-view-default

Here is a list of plugin functions:[[Plugin_Functions|Plugin_Functions]]

----

'''Creating a Loadable Plugin'''

The VC:MP server expects the existence of a special exported function, VcmpPluginInit, to exist in a plugin in order to be able to load one. As part of this function, the server will pass a set of callable functions, a structure for the plugin to set the callbacks it accepts, and a structure for the plugin to set information about itself.

The structure of VcmpPluginInit is as follows:
<source lang=cpp>
#ifdef WIN32
#define EXPORT __declspec(dllexport)
#else
#define EXPORT
#endif

extern "C" EXPORT unsigned int VcmpPluginInit( PluginFuncs* pluginFuncs, PluginCallbacks* pluginCalls, PluginInfo* pluginInfo )
{
return 1;
}
</source>

* '''pluginFuncs''' is the PluginFuncs struct from the server header, which can be used to call any function available through the plugin SDK.

* '''pluginCalls''' is a struct of PluginCallbacks. pluginCalls essentially starts off empty; your plugin must provide its own callbacks and set them in the struct in order for them to be called, and you must use the same pointer to the struct provided.

* '''pluginInfo''' is a struct of PluginInfo (from the SDK) that, again, is empty at first. You can set your plugin's version and name (max 32 characters) through it, but you must use the same pointer to the struct.

----

'''Setting a Callback'''

To receive callbacks from the server, you need to create a function in the same format as the defined type of the callback:
<source lang=cpp>
typedef int (*SDK_OnInitServer) (void);
typedef void (*SDK_OnShutdownServer) (void);
typedef void (*SDK_OnFrame) (float fElapsedTime);
typedef void (*SDK_OnPlayerConnect) (int nPlayerId);
typedef void (*SDK_OnPlayerDisconnect) (int nPlayerId, int nReason);
typedef void (*SDK_OnPlayerBeginTyping) (int nPlayerId);
typedef void (*SDK_OnPlayerEndTyping) (int nPlayerId);
typedef int (*SDK_OnPlayerRequestClass) (int nPlayerId, int nOffset);
typedef int (*SDK_OnPlayerRequestSpawn) (int nPlayerId);
typedef void (*SDK_OnPlayerSpawn) (int nPlayerId);
typedef void (*SDK_OnPlayerDeath) (int nPlayerId, int nKillerId, int nReason, int nBodyPart);
typedef void (*SDK_OnPlayerUpdate) (int nPlayerId, int nUpdateType);
typedef int (*SDK_OnPlayerRequestEnter) (int nPlayerId, int nVehicleId, int nSlotId);
typedef void (*SDK_OnPlayerEnterVehicle) (int nPlayerId, int nVehicleId, int nSlotId);
typedef void (*SDK_OnPlayerExitVehicle) (int nPlayerId, int nVehicleId);
typedef int (*SDK_OnPickupClaimPicked) (int nPickupId, int nPlayerId);
typedef void (*SDK_OnPickupPickedUp) (int nPickupId, int nPlayerId);
typedef void (*SDK_OnPickupRespawn) (int nPickupId);
typedef void (*SDK_OnVehicleUpdate) (int nVehicleId, int nUpdateType);
typedef void (*SDK_OnVehicleExplode) (int nVehicleId);
typedef void (*SDK_OnVehicleRespawn) (int nVehicleId);
typedef void (*SDK_OnObjectShot) (int nObjectId, int nPlayerId, int nWeapon);
typedef void (*SDK_OnObjectBump) (int nObjectId, int nPlayerId);
typedef int (*SDK_OnPublicMessage) (int nPlayerId, const char* pszText);
typedef int (*SDK_OnCommandMessage) (int nPlayerId, const char* pszText);
typedef int (*SDK_OnPrivateMessage) (int nPlayerId, int nTargetId, const char* pszText);
typedef int (*SDK_OnInternalCommand) (unsigned int uCmdType, const char* pszText);
typedef int (*SDK_OnLoginAttempt) (char* pszPlayerName, const char* pszUserPassword, const char* pszIpAddress);
typedef void (*SDK_OnEntityPoolChange) (int nEntityType, int nEntityId, unsigned int bDeleted);
typedef void (*SDK_OnKeyBindDown) (int nPlayerId, int nBindId);
typedef void (*SDK_OnKeyBindUp) (int nPlayerId, int nBindId);
typedef void (*SDK_OnPlayerAwayChange) (int nPlayerId, unsigned int bNewStatus);
typedef void (*SDK_OnPlayerSpectate) (int nPlayerId, int nTargetId);
typedef void (*SDK_OnPlayerCrashReport) (int nPlayerId, const char* pszReport);
typedef void (*SDK_OnServerPerformanceReport) (int nNumStats, const char** ppszDescription, unsigned long long* pnMillisecsSpent);
typedef void (*SDK_OnPlayerNameChange) (int nPlayerId, const char* pszOldName, const char* pszNewName);
typedef void (*SDK_OnPlayerStateChange) (int nPlayerId, int nOldState, int nNewState);
typedef void (*SDK_OnPlayerActionChange) (int nPlayerId, int nOldAction, int nNewAction);
typedef void (*SDK_OnPlayerOnFireChange) (int nPlayerId, unsigned int bIsOnFireNow);
typedef void (*SDK_OnPlayerCrouchChange) (int nPlayerId, unsigned int bIsCrouchingNow);
typedef void (*SDK_OnPlayerGameKeysChange) (int nPlayerId, int nOldKeys, int nNewKeys);
</source>

For example, to create a callback for OnPublicMessage:

<source lang=cpp>
typedef int (*SDK_OnPublicMessage) (int nPlayerId, const char* pszText);
</source>

You would need to create a function like so:
<source lang=cpp>
int MyOnPublicMessage (int nPlayerId, const char* pszText)
{
return 1;
}
</source>
void functions need not return anything (and should not), whereas callbacks with a return type expect a value to be returned, and will react differently according to their return values. For example, returning 0 in OnPublicMessage will reject a given chat message and essentially mute it. Returning 1 will send it to other players if no other plugins suppress it.

To have the server recognize the callback and make use of it, set it in VcmpPluginInit:
<source lang=cpp>
extern "C" EXPORT unsigned int VcmpPluginInit( PluginFuncs* pluginFuncs, PluginCallbacks* pluginCalls, PluginInfo* pluginInfo )
{
pluginCalls->OnPublicMessage = MyOnPublicMessage;
return 1;
}
</source>

----

'''Using Plugin Functions'''

Using plugin functions is easier still than dealing with callbacks. To use a function, you can simply make a direct call to a function in the pluginFuncs struct:
<source lang=cpp>
extern "C" EXPORT unsigned int VcmpPluginInit( PluginFuncs* pluginFuncs, PluginCallbacks* pluginCalls, PluginInfo* pluginInfo )
{
pluginFuncs->SetServerName("My VC:MP Server");
return 1;
}
</source>
[[Category:Server_Documentation]]

Scripting/Squirrel/Functions/SetWeather

2017-03-09T08:26:09Z

Xmair: /* Example */

This function will set the weather of the game.

== Syntax ==

<pre>SetWeather( weatherid )</pre>

== Arguments ==

* ''int'' '''weatherid''' - The weather id to be set

== Example ==
<pre>
function onPlayerCommand( iPlayer, szCommand, szArguments ) {
switch( szCommand.tolower( ) ) {
case "setweather":
if( !szArguments ) ClientMessage( "Invalid syntax, correct usage: /" + szCommand + " [ID]", iPlayer, 255, 0, 0, 255 );
else if ( !IsNum( szArguments ) ) ClientMessage( "ID must be an integer.", iPlayer, 255, 0, 0, 255 );
else if ( GetWeather() == szArguments.tointeger( ) ) ClientMessage( "The weather ID specified is already being used.", iPlayer, 255, 0, 0, 255 );
else {
SetWeather( szArguments.tointeger( ) );
ClientMessageToAll( iPlayer.Name + " has set the weather to " + szArguments + "!", 255, 255, 255, 255 );
}
break;
}
}
</pre>
=== Notes ===
Call [[onPlayerCommand]] was used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetWeather

2017-03-09T08:26:00Z

Xmair: /* Notes */

This function will get the weather ID of the game.

== Syntax ==

<pre>GetWeather()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''int'' '''weatherid''' - The weather ID of the game

== Example ==
<pre>
function onPlayerCommand( iPlayer, szCommand, szArguments ) {
switch( szCommand.tolower( ) ) {
case "setweather":
if( !szArguments ) ClientMessage( "Invalid syntax, correct usage: /" + szCommand + " [ID]", iPlayer, 255, 0, 0, 255 );
else if ( !IsNum( szArguments ) ) ClientMessage( "ID must be an integer.", iPlayer, 255, 0, 0, 255 );
else if ( GetWeather() == szArguments.tointeger( ) ) ClientMessage( "The weather ID specified is already being used.", iPlayer, 255, 0, 0, 255 );
else {
SetWeather( szArguments.tointeger( ) );
ClientMessageToAll( iPlayer.Name + " has set the weather to " + szArguments + "!", 255, 255, 255, 255 );
}
break;
}
}
</pre>
=== Notes ===
Call [[onPlayerCommand]] was used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Scripting/Squirrel/Functions/GetWeather

2017-03-09T08:25:45Z

Xmair: /* Notes */

This function will get the weather ID of the game.

== Syntax ==

<pre>GetWeather()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''int'' '''weatherid''' - The weather ID of the game

== Example ==
<pre>
function onPlayerCommand( iPlayer, szCommand, szArguments ) {
switch( szCommand.tolower( ) ) {
case "setweather":
if( !szArguments ) ClientMessage( "Invalid syntax, correct usage: /" + szCommand + " [ID]", iPlayer, 255, 0, 0, 255 );
else if ( !IsNum( szArguments ) ) ClientMessage( "ID must be an integer.", iPlayer, 255, 0, 0, 255 );
else if ( GetWeather() == szArguments.tointeger( ) ) ClientMessage( "The weather ID specified is already being used.", iPlayer, 255, 0, 0, 255 );
else {
SetWeather( szArguments.tointeger( ) );
ClientMessageToAll( iPlayer.Name + " has set the weather to " + szArguments + "!", 255, 255, 255, 255 );
}
break;
}
}
</pre>
=== Notes ===
Call [[onPlayerCommand]] and function [[Functions/SetWeather]] was used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Scripting/Squirrel/Functions/GetWeather

2017-03-09T08:23:32Z

Xmair: /* Example */

This function will get the weather ID of the game.

== Syntax ==

<pre>GetWeather()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''int'' '''weatherid''' - The weather ID of the game

== Example ==
<pre>
function onPlayerCommand( iPlayer, szCommand, szArguments ) {
switch( szCommand.tolower( ) ) {
case "setweather":
if( !szArguments ) ClientMessage( "Invalid syntax, correct usage: /" + szCommand + " [ID]", iPlayer, 255, 0, 0, 255 );
else if ( !IsNum( szArguments ) ) ClientMessage( "ID must be an integer.", iPlayer, 255, 0, 0, 255 );
else if ( GetWeather() == szArguments.tointeger( ) ) ClientMessage( "The weather ID specified is already being used.", iPlayer, 255, 0, 0, 255 );
else {
SetWeather( szArguments.tointeger( ) );
ClientMessageToAll( iPlayer.Name + " has set the weather to " + szArguments + "!", 255, 255, 255, 255 );
}
break;
}
}
</pre>
=== Notes ===
Call [[onPlayerCommand]] and function [[Scripting/Squirrel/Functions/GetWeather]] was used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Scripting/Squirrel/Functions/SetWeather

2017-03-09T08:22:16Z

Xmair: /* Example */

This function will set the weather of the game.

== Syntax ==

<pre>SetWeather( weatherid )</pre>

== Arguments ==

* ''int'' '''weatherid''' - The weather id to be set

== Example ==
<pre>
function onPlayerCommand( iPlayer, szCommand, szArguments ) {
switch( szCommand.tolower( ) ) {
case "setweather":
if( !szArguments ) ClientMessage( "Invalid syntax, correct usage: /" + szCommand + " [ID]", iPlayer, 255, 0, 0, 255 );
else if ( !IsNum( szArguments ) ) ClientMessage( "ID must be an integer.", iPlayer, 255, 0, 0, 255 );
else if ( GetWeather() == szArguments.tointeger( ) ) ClientMessage( "The weather ID specified is already being used.", iPlayer, 255, 0, 0, 255 );
else {
SetWeather( szArguments.tointeger( ) );
ClientMessageToAll( iPlayer.Name + " has set the weather to " + szArguments + "!", 255, 255, 255, 255 );
}
break;
}
}
</pre>
=== Notes ===
Call [[onPlayerCommand]] and function [[GetWeather]] was used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetWeather

2017-03-09T08:21:52Z

Xmair: /* Example */

This function will get the weather ID of the game.

== Syntax ==

<pre>GetWeather()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''int'' '''weatherid''' - The weather ID of the game

== Example ==
<pre>
function onPlayerCommand( iPlayer, szCommand, szArguments ) {
switch( szCommand.tolower( ) ) {
case "setweather":
if( !szArguments ) ClientMessage( "Invalid syntax, correct usage: /" + szCommand + " [ID]", iPlayer, 255, 0, 0, 255 );
else if ( !IsNum( szArguments ) ) ClientMessage( "ID must be an integer.", iPlayer, 255, 0, 0, 255 );
else if ( GetWeather() == szArguments.tointeger( ) ) ClientMessage( "The weather ID specified is already being used.", iPlayer, 255, 0, 0, 255 );
else {
SetWeather( szArguments.tointeger( ) );
ClientMessageToAll( iPlayer.Name + " has set the weather to " + szArguments + "!", 255, 255, 255, 255 );
}
break;
}
}
</pre>
=== Notes ===
Call [[onPlayerCommand]] and function [[SetWeather]] was used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Scripting/Squirrel/Functions/GetWeather

2017-03-09T08:20:06Z

Xmair: /* Example */

This function will get the weather ID of the game.

== Syntax ==

<pre>GetWeather()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* ''int'' '''weatherid''' - The weather ID of the game

== Example ==
<pre>
function onPlayerCommand( iPlayer, szCommand, szArguments ) {
switch( szCommand.tolower( ) ) {
case "setweather":
if( !szArguments ) ClientMessage( "Invalid syntax, correct usage: /" + szCommand + " [ID]", iPlayer, 255, 0, 0, 255 );
else if ( !IsNum( szArguments ) ) ClientMessage( "ID must be an integer.", iPlayer, 255, 0, 0, 255 );
else if ( GetWeather() == szArguments ) ClientMessage( "The weather ID specified is already being used.", iPlayer, 255, 0, 0, 255 );
else {
SetWeather( szArguments );
ClientMessageToAll( iPlayer.Name + " has set the weather to " + szArguments + "!", 255, 255, 255, 255 );
}
break;
}
}
</pre>
=== Notes ===
Call [[onPlayerCommand]] and function [[SetWeather]] was used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Scripting/Squirrel/Functions/SetWeather

2017-03-09T08:19:59Z

Xmair: /* Example */

This function will set the weather of the game.

== Syntax ==

<pre>SetWeather( weatherid )</pre>

== Arguments ==

* ''int'' '''weatherid''' - The weather id to be set

== Example ==
<pre>
function onPlayerCommand( iPlayer, szCommand, szArguments ) {
switch( szCommand.tolower( ) ) {
case "setweather":
if( !szArguments ) ClientMessage( "Invalid syntax, correct usage: /" + szCommand + " [ID]", iPlayer, 255, 0, 0, 255 );
else if ( !IsNum( szArguments ) ) ClientMessage( "ID must be an integer.", iPlayer, 255, 0, 0, 255 );
else if ( GetWeather() == szArguments ) ClientMessage( "The weather ID specified is already being used.", iPlayer, 255, 0, 0, 255 );
else {
SetWeather( szArguments );
ClientMessageToAll( iPlayer.Name + " has set the weather to " + szArguments + "!", 255, 255, 255, 255 );
}
break;
}
}
</pre>
=== Notes ===
Call [[onPlayerCommand]] and function [[GetWeather]] was used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Client Functions

2017-03-09T08:05:34Z

Xmair:

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

=== 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/CreateExplosion

2016-08-13T12:14:28Z

Xmair: /* Example */

This function will create an explosion at the given location.

== Syntax ==

1
<pre>CreateExplosion( world, type, pos, playerCaused, onGround )</pre>
2
<pre>CreateExplosion( world, type, x, y, z, playerCaused, onGround )</pre>

== Arguments ==

1
* ''int'' '''world''' - The world ID
* ''int'' '''type''' - The [[Explosion_Types|Explosion Types]]
* ''[[Scripting/Squirrel/Functions/Vector|Vector]]'' '''pos''' - The position of the explosion to be created
* ''int'' '''playerCaused''' - the ID of the player to blame the explosion on, or -1 for no player
* ''bool'' '''onGround''' - To be added
2
* ''int'' '''world''' - The world ID
* ''int'' '''type''' - The [[Explosion_Types|Explosion Types]]
* ''float'' '''x''' - The x position of the explosion to be created
* ''float'' '''y''' - The y position of the explosion to be created
* ''float'' '''z''' - The z position of the explosion to be created
* ''int'' '''playerCaused''' - the ID of the player to blame the explosion on, or -1 for no player
* ''bool'' '''onGround''' - To be added

== Example ==
<pre>CreateExplosion( 1, 7, 154.55, 159, 11.4584, -1, true );</pre>

=== Notes ===
There are several types of Explosions you can find a list of them from [http://wiki.vc-mp.org/wiki/Explosion_Types here]

== Related Functions ==

{{Scripting/Squirrel/Functions/Game_Functions}}

Player.Skin

2016-07-14T05:59:51Z

Xmair: /* Example */

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

User talk:Xmair

2016-07-14T05:54:15Z

Xmair: Replaced content with "'-..-'"

'-..-'

Scripting/Squirrel/Client Functions/World::FindPlayer

2016-07-14T05:52:41Z

Xmair:

This function returns the player instance for the ID, or null if the player does not exist.
== Syntax ==

<pre>World.FindPlayer( int_ID )</pre>

== Arguments ==

* '''INTEGER''' '''int_ID''' The ID of the player to find.

== Return type ==

'''Instance'''.

== Example ==

This page needs an example.

Scripting/Squirrel/Client Functions/World::FindVehicle

2016-07-14T05:52:30Z

Xmair:

This function returns the vehicle instance for the ID, or null if the vehicle does not exist or is not streamed in.
== Syntax ==

<pre>World.FindVehicle( int_ID )</pre>

== Arguments ==

* '''INTEGER''' '''int_ID''' The ID of the vehicle to find.

== Return type ==

'''Instance'''

== Example ==
This page needs an example.

Scripting/Squirrel/Client Functions/World::FindVehicle

2016-07-14T05:52:12Z

Xmair:

This function returns the vehicle instance for the ID, or null if the vehicle does not exist or is not streamed in.
== Syntax ==

<pre>World.FindVehicle( int_ID )</pre>

== Arguments ==

'''INTEGER''' '''int_ID''' The ID of the vehicle to find.

== Return type ==

'''Instance'''

== Example ==
This page needs an example.

Scripting/Squirrel/Client Functions/World::FindVehicle

2016-07-14T05:51:18Z

Xmair: Created page with "This function returns the vehicle instance for the ID, or null if the vehicle does not exist or is not streamed in. == Syntax == <pre>World.FindVehicle</pre> == Arguments ==..."

This function returns the vehicle instance for the ID, or null if the vehicle does not exist or is not streamed in.
== Syntax ==

<pre>World.FindVehicle</pre>

== Arguments ==

None.

== Return type ==

'''Instance'''

== Example ==
This page needs an example.

Scripting/Squirrel/Client Functions/World::FindLocalPlayer

2016-07-14T05:50:26Z

Xmair:

This function returns the local player instance.
== Syntax ==

<pre>World.FindLocalPlayer</pre>

== Arguments ==

None.

== Return type ==

'''Instance'''

== Example ==
This page needs an example.

Scripting/Squirrel/Client Functions/World::FindLocalPlayer

2016-07-14T05:49:29Z

Xmair: Created page with "This function returns the local player instance. == Syntax == <pre>World.FindLocalPlayer</pre> == Arguments == * '''STRING''' '''szText''' The message to print. == Return..."

This function returns the local player instance.
== Syntax ==

<pre>World.FindLocalPlayer</pre>

== Arguments ==

* '''STRING''' '''szText''' The message to print.

== Return type ==

'''Instance'''

== Example ==
This page needs an example.

Scripting/Squirrel/Client Functions/World::FindPlayer

2016-07-14T05:21:54Z

Xmair: Created page with "This function returns the player instance for the ID, or null if the player does not exist. == Syntax == <pre>World.FindPlayer( int_ID )</pre> == Arguments == * '''INTEGER'..."

Scripting/Squirrel/Client Functions/Console::Print

2016-07-14T05:13:41Z

Xmair:

This function writes text to the game console.

== Syntax ==

<pre>Console.Print( szText )</pre>

== Arguments ==

* '''STRING''' '''szText''' The message to print.

== Example ==
This will message 'player has died.' whenever a player dies.

<code lang="squirrel">
function Player::PlayerDeath( player )
{

Console.Print( player.Name + " has died." );

}
</code>

=== Notes ===

The event [http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Client_Events/Player::PlayerDeath Player::PlayerDeath] was used in in this example. More info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/print

2016-07-14T05:07:06Z

Xmair: Created page with "This function prints stuff in the debug file present in %appdata%\VCMP\04Beta\debuglog.txt. == Syntax == <pre>print( szText )</pre> == Arguments == * '''STRING''' '''szTex..."

This function prints stuff in the debug file present in %appdata%\VCMP\04Beta\debuglog.txt.

== Syntax ==

<pre>print( szText )</pre>

== Arguments ==

* '''STRING''' '''szText''' The message to print.

== Example ==
This will print "Client side scripts loaded" to the debug log when the client side scripts are loaded.

<code lang="squirrel">
function Script::ScriptLoad( )
{

print( "Client side scripts loaded." );

}
</code>

=== Notes ===

The event [http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Client_Events/Script::ScriptLoad Script::ScriptLoad] was used in in this example. More info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/Script::GetTicks

2016-07-14T04:57:12Z

Xmair: Created page with "This function returns a number of milliseconds since the computer started. Can be used to measure time intervals. == Syntax == <pre>None.</pre> == Arguments == * None. ==..."

This function returns a number of milliseconds since the computer started. Can be used to measure time intervals.

== Syntax ==

<pre>None.</pre>

== Arguments ==

* None.

== Return type ==

'''Integer'''.

== Example ==
This will message the number of milliseconds since the computer has started.

<code lang="squirrel">
function Script::ScriptLoad( )
{

Console.Print( GetTicks( ).tostring( ) );

}
</code>

=== Notes ===

The event [http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Client_Events/Script::ScriptLoad Script::ScriptLoad] was used in in this example. More info about them in the corresponding pages.

Scripting/Squirrel/Client Events/Player::PlayerDeath

2016-07-12T05:33:22Z

Xmair: Created page with "This event is called when a player dies. == Syntax == <pre>player - The instance.</pre> == Arguments == None. == Example == This will message the player's name when the p..."

This event is called when a player dies.

== Syntax ==

<pre>player - The instance.</pre>

== Arguments ==

None.

== Example ==
This will message the player's name when the player dies.

<code lang="squirrel">
function Player::PlayerDeath( player )
{

Console.Print( player.Name + " has died." );

}
</code>

=== Notes ===

The event [http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Client_Events/Script::ScriptLoad Script::ScriptLoad] and function [http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Client_Functions/Console::Print Console::Print] were used in in this example. More info about them in the corresponding pages.

Scripting/Squirrel/Client Functions

2016-07-12T05:29:20Z

Xmair: /* Script Functions */

== Script Functions ==
* [[Scripting/Squirrel/Client_Functions/dofile|dofile]](string filename)
* [[Scripting/Squirrel/Client_Functions/Script::LoadScript|Script::LoadScript]](string filename)
* [[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)

== Server Functions ==
* [[Scripting/Squirrel/Client_Functions/Server::SendData|Server::SendData]](Stream stream)

== 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 ==
{{Scripting/Squirrel/Functions/DataTypes}}

Scripting/Squirrel/Client Functions/include

2016-07-12T05:27:57Z

Xmair: Created page with "This function loads a file. == Syntax == <pre>include( FileName ) </pre> == Arguments == * '''STRING''' '''FileName''' This is the name of the file, must be a string. ==..."

This function loads a file.

== Syntax ==

<pre>include( FileName ) </pre>

== Arguments ==

* '''STRING''' '''FileName''' This is the name of the file, must be a string.

== Example ==
This will load the file named 'test.nut'.

<code lang="squirrel">
function Script::ScriptLoad( )
{

include( "test.nut" );

}
</code>

=== Notes ===

The event [http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Client_Events/Script::ScriptLoad Script::ScriptLoad] was used in in this example. More info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/Script::LoadScript

2016-07-12T05:27:23Z

Xmair: Created page with "This function loads a file. == Syntax == <pre>Script::LoadScript( FileName ) </pre> == Arguments == * '''STRING''' '''FileName''' This is the name of the file, must be a s..."

This function loads a file.

== Syntax ==

<pre>Script::LoadScript( FileName ) </pre>

== Arguments ==

* '''STRING''' '''FileName''' This is the name of the file, must be a string.

== Example ==
This will load the file named 'test.nut'.

<code lang="squirrel">
function Script::ScriptLoad( )
{

LoadScript( "test.nut" );

}
</code>

=== Notes ===

The event [http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Client_Events/Script::ScriptLoad Script::ScriptLoad] was used in in this example. More info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/dofile

2016-07-12T05:26:26Z

Xmair:

This function loads a file.

== Syntax ==

<pre>dofile( FileName ) </pre>

== Arguments ==

* '''STRING''' '''FileName''' This is the name of the file, must be a string.

== Example ==
This will load the file named 'test.nut'.

<code lang="squirrel">
function Script::ScriptLoad( )
{

dofile( "test.nut" );

}
</code>

=== Notes ===

The event [http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Client_Events/Script::ScriptLoad Script::ScriptLoad] was used in in this example. More info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/dofile

2016-07-12T05:24:39Z

Xmair: Created page with "This function loads a file. == Syntax == <pre>dofile( FileName ) </pre> == Arguments == * '''STRING''' '''FileName''' This is the name of the file, must be a string. == E..."

This function loads a file.

== Syntax ==

<pre>dofile( FileName ) </pre>

== Arguments ==

* '''STRING''' '''FileName''' This is the name of the file, must be a string.

== Example ==
This will load the file named 'test.nut'.

<code lang="squirrel">
function Script::ScriptLoad( )
{

dofile( "test.nut" );

}
</code>

=== Notes ===

The event [[http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Client_Events/Script::ScriptLoad]] was used in in this example. More info about them in the corresponding pages.

Scripting/Squirrel/Functions/WriteIniInteger

2016-07-12T05:17:16Z

Xmair:

__NOTOC__
This function writes an integer value to an .ini file. If the file does not exist, the function will NOT create it because the ini plugin is messed up, you'll manually need to create the file.

== Syntax ==

<code>bool WriteIniInteger( string filename, string section, string var, int value )</code>

== Arguments ==

* '''filename''' This is the name of the file
* '''section''' The section that contains the value you want to create/edit
* '''var''' The name of the variable
* '''value''' The integer value for the variable

== Example ==
This example will save player's cash to a file 'PlayerCash.ini' when they leave the game.

<code lang="squirrel">
function onPlayerPart( player, reason )
{
WriteIniInteger( "PlayerCash.ini", "Cash", player.Name, player.Cash );
}
</code>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Player.Name|player.Name]], [[Scripting/Squirrel/Functions/Player.Cash|player.Cash]] and call [[OnPlayerPart]] were also used in in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/WriteIniInteger

2016-07-12T05:16:52Z

Xmair:

__NOTOC__
This function writes an integer value to an .ini file. If the file does not exist, the function will NOT create it because the ini plugin is messed up.

== Syntax ==

<code>bool WriteIniInteger( string filename, string section, string var, int value )</code>

== Arguments ==

* '''filename''' This is the name of the file
* '''section''' The section that contains the value you want to create/edit
* '''var''' The name of the variable
* '''value''' The integer value for the variable

== Example ==
This example will save player's cash to a file 'PlayerCash.ini' when they leave the game.

<code lang="squirrel">
function onPlayerPart( player, reason )
{
WriteIniInteger( "PlayerCash.ini", "Cash", player.Name, player.Cash );
}
</code>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Player.Name|player.Name]], [[Scripting/Squirrel/Functions/Player.Cash|player.Cash]] and call [[OnPlayerPart]] were also used in in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/Player.SetInterior

2016-07-12T05:16:04Z

Xmair:

Scripting/Squirrel/Functions/SetUseClasses

2016-07-12T05:12:28Z

Xmair: Undo revision 19143 by Kennedyarz (talk)

This function will enable/disable use of classes

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

== Arguments ==

* ''bool'' - true or false

== Example ==

<source lang=squirrel>
function onScriptLoad()
{
SetUseClasses( true );
}

</source>

<source lang=squirrel>
function onScriptLoad()
{
SetUseClasses( false );
}

</source>

Scripting/Squirrel/Functions/Object.ID

2016-03-09T10:44:40Z

Xmair: Created page with "This function returns an object's ID. == Syntax == Object.ID; == Arguments == '''N/A''' == Example == <source lang=squirrel> function onScriptLoad ( ) { local ids = "";..."

This function returns an object's ID.

== Syntax ==

Object.ID;

== Arguments ==

'''N/A'''

== Example ==

<source lang=squirrel>
function onScriptLoad ( )
{
local ids = "";
for ( local i=0; i< GetObjectCount(); i++)
{
if ( FindObject( i ) ) ids = ids + ", " + FindObject( i ).ID;
}
print( "Loaded objects with ids: " + ids );
}
</source>

Scripting/Squirrel/Functions/ShowAllMapObjects

2016-03-09T10:32:13Z

Xmair: Created page with "This function shows all the hidden map objects. == Syntax == <pre>ShowAllMapObjects()</pre> == Arguments == '''N/A''' Not available. == Example == <source lang=squirrel>..."

This function shows all the hidden map objects.

== Syntax ==
<pre>ShowAllMapObjects()</pre>

== Arguments ==

'''N/A''' Not available.

== Example ==
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "showallobjects" )
{
ShowAllMapObjects( );
MessagePlayer ( "No objects are hidden now!" , player );
}
}
</source>

- Xmair.

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Object_Functions}}

Scripting/Squirrel/Functions/GetWeaponSync

2016-03-09T10:28:29Z

Xmair: Created page with "SetWeaponSync does not exists in 0.4. Rely on anticheat."

SetWeaponSync does not exists in 0.4. Rely on anticheat.

Scripting/Squirrel/Functions/SetWeaponSync

2016-03-09T10:27:53Z

Xmair: Created page with "SetWeaponSync does not exists in 0.4. Rely on anticheat."

SetWeaponSync does not exists in 0.4. Rely on anticheat.

Scripting/Squirrel/Functions/GetFallEnabled

2016-03-09T10:24:40Z

Xmair:

SetFallEnabled does not have any effect so this function is also trash.

Scripting/Squirrel/Functions/SetFallEnabled

2016-03-09T10:23:37Z

Xmair: Created page with "This function has no effect."

This function has no effect.

Scripting/Squirrel/Functions/GetFallEnabled

2016-03-09T09:47:19Z

Xmair: Created page with "This function will return the current status of fall ( vehicle killing type ) being enabled or disabled. == Syntax == <pre>GetFallEnabled()</pre> == Arguments == '''N/A'''..."

This function will return the current status of fall ( vehicle killing type ) being enabled or disabled.

== Syntax ==

<pre>GetFallEnabled()</pre>

== Arguments ==

'''N/A'''

== Return value ==

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

== Example ==

<source lang=squirrel>
function onScriptLoad ()
{
print ( "Fall is set to " + GetFallEnabled() + "!");
}
</source>

- Xmair.

=== Notes ===

Call [[onScriptLoad]] was used in this example.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetShowOnlyTeamMarkers

2016-03-09T09:41:38Z

Xmair: /* Syntax */

This function will return the current status of showing markers to only team members.

== Syntax ==

<pre>GetShowOnlyTeamMarkers()</pre>

== Arguments ==

'''N/A'''

== Return value ==

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

== Example ==

<source lang=squirrel>
function onScriptLoad ()
{
print ( "Show name tags setting is set to " + GetShowOnlyTeamMarkers() + "!");
}
</source>

- Xmair.

=== Notes ===

Call [[onScriptLoad]] was used in this example.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetShowOnlyTeamMarkers

2016-03-09T09:40:44Z

Xmair:

This function will return the current status of showing markers to only team members.

== Syntax ==

<pre>GetShowNametags()</pre>

== Arguments ==

'''N/A'''

== Return value ==

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

== Example ==

<source lang=squirrel>
function onScriptLoad ()
{
print ( "Show name tags setting is set to " + GetShowOnlyTeamMarkers() + "!");
}
</source>

- Xmair.

=== Notes ===

Call [[onScriptLoad]] was used in this example.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetShowOnlyTeamMarkers

2016-03-09T09:37:31Z

Xmair: /* Example */

This function will return the current status of players' nametags.

== Syntax ==

<pre>GetShowNametags()</pre>

== Arguments ==

'''N/A'''

== Return value ==

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

== Example ==

<source lang=squirrel>
function onScriptLoad ()
{
print ( "Show name tags setting is set to " + GetShowOnlyTeamMarkers() + "!");
}
</source>

- Xmair.

=== Notes ===

Call [[onScriptLoad]] was used in this example.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/SetShowOnlyTeamMarkers

2016-03-09T09:20:25Z

Xmair: Created page with "This function will set the player's tag visible to only his/her team. == Syntax == <pre>SetShowOnlyTeamMarkers ( bool );</pre> == Arguments == '''bool''' True / false. ==..."

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 ( "Show name tags setting is set to " + GetShowOnlyTeamMarkers() + "!");
}
</source>

- Xmair.

=== Notes ===

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

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetShowOnlyTeamMarkers

2016-03-09T09:18:01Z

Xmair: Created page with "This function will return the current status of players' nametags. == Syntax == <pre>GetShowNametags()</pre> == Arguments == '''N/A''' == Return value == * ''bool'' '''t..."

This function will return the current status of players' nametags.

== Syntax ==

<pre>GetShowNametags()</pre>

== Arguments ==

'''N/A'''

== Return value ==

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

== Example ==

<source lang=squirrel>
function onScriptLoad ()
{
print ( "Show name tags setting is set to " + GetShowNametags() + "!");
}
</source>

- Xmair.

=== Notes ===

Call [[onScriptLoad]] was used in this example.
== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetObjectCount

2016-03-09T09:16:56Z

Xmair: Created page with "This function will return the current object count. == Syntax == <pre>GetObjectCount()</pre> == Arguments == '''N/A''' == Return value == * '''int.''' == Example == Thi..."

This function will return the current object count.

== Syntax ==

<pre>GetObjectCount()</pre>

== Arguments ==

'''N/A'''

== Return value ==

* '''int.'''

== Example ==
This command will return the object count.
<source lang=squirrel>
function onPlayerCommand ( player , cmd , text )
{
if( cmd == "objects")
{
MessagePlayer("There are " + GetObjectCount() + " objects in this server!" , player );
}
</source>

- Xmair.

=== Notes ===

Call [[onPlayerCommand]] was used in this example.
== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetShowNametags

2016-03-09T09:14:09Z

Xmair:

This function will return the current status of players' nametags.

== Syntax ==

<pre>GetShowNametags()</pre>

== Arguments ==

'''N/A'''

== Return value ==

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

== Example ==

<source lang=squirrel>
function onScriptLoad ()
{
print ( "Show name tags setting is set to " + GetShowNametags() + "!");
}
</source>

- Xmair.

=== Notes ===

Call [[onScriptLoad]] was used in this example.
== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/SetGameModeText

2016-03-09T09:11:12Z

Xmair:

This function will set the gamemode text to be shown in the client browser.

== Syntax ==

<pre>SetGameModeName( gamemodetext )</pre>

== Arguments ==

* ''string'' '''gamemodetext''' - The game mode name to be set

== Example ==

<source lang=squirrel>
function onPlayerCommand ( player , cmd , text )
{
if ( cmd == "gamemodename" )
{
if ( !text ) MessagePlayer("/gamemodename [ Gamemode name ]" , player)
else SetGameModeName( text.tostring( ) ), MessagePlayer( "You changed the gamemode's name to " +text + "!" , player);
}
</source>

- Xmair.

=== Notes ===
Call [[onPlayerCommand]] was used in this example.

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/ShowMapObject

2016-03-09T09:06:07Z

Xmair:

This function will show an object on the map if the map was hidden using [[HideMapObject]] or [[RawHideMapObject]]

== Syntax ==
<pre>ShowMapObject( ObjectID , VectorX, VectorY, VectorZ );</pre>

== Arguments ==

* ''int'' '''ObjectID''' - The ID of the object, must be an integer.
* ''float'' '''VectorX''' - The vector x of the hidden object. Should be float.
* ''float'' '''VectorY''' - The vector y of the hidden object. Should be float.
* ''float'' '''VectorZ''' - The vector z of the hidden object. Should be float.

== Example ==
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "hideobj" )
{
HideMapObject ( 379 , -1721.86 , -293.002 , 15.1086 );
MessagePlayer ( "You've successfully hidden the army gate!" , player );
}
else if ( cmd == "showobj" )
{
ShowMapObject ( 379 , -1721.86 , -293.002 , 15.1086 );
MessagePlayer ( "The army gate is no longer hidden!" , player );
}
}
</source>

- Xmair.

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Object_Functions}}

Scripting/Squirrel/Functions/ShowMapObject

2016-03-09T09:05:18Z

Xmair: Created page with "This function will show an object on the map if the map was hidden using HideMapObject or RawHideMapObject == Syntax == <pre>ShowMapObject( ObjectID , VectorX, Vecto..."

This function will show an object on the map if the map was hidden using [[HideMapObject]] or [[RawHideMapObject]]

== Syntax ==
<pre>ShowMapObject( ObjectID , VectorX, VectorY, VectorZ );</pre>

== Arguments ==

* ''int'' '''ObjectID''' - The ID of the object, must be an integer.
* ''float'' '''VectorX''' - The vector x of the hidden object. Should be float.
* ''float'' '''VectorY''' - The vector y of the hidden object. Should be float.
* ''float'' '''VectorZ''' - The vector z of the hidden object. Should be float.

== Example ==
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "hideobj" )
{
HideMapObject ( 379 , -1721.86 , -293.002 , 15.1086 );
MessagePlayer ( "You've successfully hidden the army gate!" , player );
}
else if ( cmd == "showobj" )
{
ShowMapObject ( 379 , -1721.86 , -293.002 , 15.1086 );
MessagePlayer ( "The army gate is no longer hidden!" , player );
}
}
</source>

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Object_Functions}}