View source for Main Page

__NOEDITSECTION__ __NOTOC__
<big>
== Introduction ==
NPCs also known as bots -feature introduced in April 2022 in [https://forum.vc-mp.org/?topic=8799.0 vc-mp forum]. 
This new feature allows you to create NPCs inside your server. They can be created at ammunition stores, toolshop or mall. They can chat with players, send command to server. They can be used to play a previous recording like driving a car around an area repeatedly. Like normal players, they use server slot.
Their actions are scripted by squirrel scripts. These scripts with 'artificial intelligence' of NPC reside in '''npcscripts''' directory. 

Each NPC run in its own process. This might make their usage and working economical. The NPC scripts have functions as well as callbacks. The Player functions, Advanced functions are all functions usable in npcscripts( and not server scripts).

Since v1.5, adding an npc is simple as a call to [[ConnectNPC]] and if you do not want to give npc AI, the script parameter can be omitted. 
{| style=height:1em
|scope="col" style="width: 300px; text-align:left; vertical-align: top;"| 
== NPC script callbacks ==
|scope="col" style="width: 700px;vertical-align: top;" |  
== NPC script functions == 
|-style="vertical-align: top;"
| 
* [[OnNPCScriptLoad]]
* [[OnNPCScriptUnload]]
* [[OnNPCConnect]]
* [[OnNPCDisconnect]]
* [[OnNPCSpawn]]
* [[OnNPCEnterVehicle]]
* [[OnNPCExitVehicle]]
* [[OnClientMessage]]
* [[OnPlayerDeath]]
* [[OnPlayerText]]
* [[OnPlayerStreamIn]]
* [[OnPlayerStreamOut]]
* [[OnVehicleStreamIn]]
* [[OnVehicleStreamOut]]
* [[OnRecordingPlaybackEnd]]        
* [[OnPlayerUpdate]]
* [[OnSniperRifleFired]]
* [[OnConsoleInput]]
==Constants==
* [[Bodypart| BodyParts]]
* [[field| LocalValue fields]]
* [[Keys|Game Keys]]
* [[Player_States|Player States]]
== Classes ==
*[[Vector]]
*[[Quaternion]]
== Player functions ==
*[[GetPlayerState]]
*[[GetPlayerPos]]
*[[GetPlayerVehicleID]]
*[[GetPlayerArmedWeapon]]
*[[GetPlayerHealth]]
*[[GetPlayerArmour]]
*[[GetPlayerKeys]]
*[[GetPlayerFacingAngle]]
*[[IsPlayerInRangeOfPoint]]
*[[GetPlayerName]]
*[[IsPlayerConnected]] 
* [[GetPlayerSkin]] (v1.5)
* [[GetPlayerTeam]] (v1.5)
* [[GetPlayerSlotWeapon]]  (v1.5)
* [[GetPlayerSlotAmmo]]   (v1.5)
* [[WhereIsPlayer]] (v1.5)
 || 
* [[StartRecordingPlayback]]
* [[StopRecordingPlayback]]
* [[PauseRecordingPlayback]]
* [[ResumeRecordingPlayback]]
* [[SendChat]]
* [[SendCommand]]
* [[GetMyPos]]
* [[SetMyPos]]
* [[GetMyFacingAngle]]
* [[SetMyFacingAngle]]
* [[GetDistanceFromMeToPoint]]
* [[IsVehicleStreamedIn]]
* [[IsPlayerStreamedIn]]
* [[SetTimer]]
* [[SetTimerEx]] (v1.5)
* [[KillTimer]]
==Advanced functions(v1.5+)==
* [[SendOnFootSyncData]]
* [[SendOnFootSyncDataEx]]
* [[SendOnFootSyncDataLV]]
* [[SendInCarSyncData]]
* [[SendInCarSyncDataEx]]
* [[SendInCarSyncDataLV]]
* [[SendPassengerSyncData]]
* [[FireSniperRifle]]
* [[FireSniperRifleEx]]
* [[SendShotInfo]]
* [[SendDeathInfo]]
* [[GetLocalValue]]
* [[SetLocalValue]]
* [[GetSlotFromWeaponId]] 
* [[FaceNPCToPlayer]]
* [[GetTickCount]]
* [[GetClosestPlayer]]
== Functions used only in server scripts==
* [[ConnectNPC]]
* [[ConnectNPCEx]]
* [[IsPlayerNPC]]
* [[ShowNPCConsole]]
* [[StartRecordingPlayerData]]
* [[StopRecordingPlayerData]]
== More ==
* [[SquirrelPlugin|Squirrel Add-On Plugin]]
*[[NPC Installation]]
* [[Squirrel Standard Library Functions]]
==v1.5 ==
* [[New Release]]
* [[Command-line usage]]
* [[Attack Script]]
|}
</big>
<poem style="border: 2px solid #d6d2c5; background-color: #00ff00; ">
'''08 January 2023: Happy New Year. NPC Version 1.6 alpha is out'''. [[V1_6_alpha_release_notes|'''here''']]
</poem>
<poem style="border: 2px solid #d6d2c5; background-color: #00ee00; ">
'''13 January 2023: Server Plugin to hide npcs from VCMP-Browser. [[NPC_Hide|see]]
</poem>