Main Page

Introduction

NPCs (Non Player Characters) or bots can be created in vcmp 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 intelligence can be scripted in separate squirrel scripts. These scripts with 'artificial intelligence' of NPC reside in npcscripts directory.

Each NPC run in its own process. The NPC scripts have functions as well as callbacks.

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.

NPC script callbacks	NPC script functions	ServerData (v1.6)
OnNPCScriptLoad OnNPCScriptUnload OnNPCConnect OnNPCDisconnect OnNPCSpawn OnNPCEnterVehicle OnNPCExitVehicle OnClientMessage OnPlayerDeath OnPlayerText OnPlayerStreamIn OnPlayerStreamOut OnVehicleStreamIn OnVehicleStreamOut OnRecordingPlaybackEnd OnPlayerUpdate OnSniperRifleFired OnConsoleInput OnServerData Constants BodyParts LocalValue fields Game Keys 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) Modules LibRPC LibAction npcmodule (to be renamed) z-finder	StartRecordingPlayback StopRecordingPlayback PauseRecordingPlayback ResumeRecordingPlayback SendChat SendCommand GetMyPos SetMyPos GetMyFacingAngle SetMyFacingAngle GetDistanceFromMeToPoint IsVehicleStreamedIn IsPlayerStreamedIn SelectWeapon (v1.6 b4p2) GetAvailableWeapons GetAmmoOfMyWeapon SetTimer SetTimerEx (v1.5) KillTimer GetMyName (v1.6 ) GetMyID (v1.6 ) QuitServer (v1.6) Advanced functions(v1.5+) SendOnFootSyncData SendOnFootSyncDataEx SendOnFootSyncDataLV SendInCarSyncData SendInCarSyncDataEx SendInCarSyncDataLV SendPassengerSyncData FireSniperRifle FireSniperRifleEx EnterVehicle SendShotInfo SendDeathInfo GetLocalValue SetLocalValue GetSlotFromWeaponId FaceNPCToPlayer GetTickCount GetClosestPlayer Functions used only in server scripts ConnectNPC ConnectNPCEx(v1.5) IsPlayerNPC ShowNPCConsole(v1.5) StartRecordingPlayerData StopRecordingPlayerData RFC(v1.6) F(v1.6) Examples (Remote calls)	SendServerData ReadInt ReadByte ReadFloat ReadString WriteInt WriteByte WriteFloat WriteString v1.6 beta 4 FireProjectile OnExplosion OnProjectileFired OnNPCClassSelect RequestClass RequestSpawn OnServerShareTick (beta 5) v1.7 ClaimPickup IsPickupStreamedIn GetPickupModel GetPickupAlpha GetPickupQuantity GetPickupPos GetPickupCount OnPickupStreamIn OnPickupDestroyed OnPickupUpdate OnCheckpointStreamIn OnCheckpointDestroyed OnCheckpointUpdate IsCheckpointStreamedIn GetCheckpointRadius GetCheckpointPos GetCheckpointColor IsCheckpointSphere ClaimEnterCheckpoint ClaimExitCheckpoint OnTimeWeatherSync GetVehicleDriver GetVehicleModel GetVehicleTurretRot GetVehicleRotation GetVehiclePos GetVehicleSpeed GetVehicleHealth GetVehicleDamage GetPlayerSpeed IsObjectStreamedIn GetObjectModel GetObjectPos GetObjectRotation GetObjectAlpha IsObjectTouchReportEnabled IsObjectShotReportEnabled ClaimObjectTouch ClaimObjectShot GetObjectCount GetCheckpointCount ExitVehicle (b2) ExitVehicleEx (b2) GetPlayerAction (b2) More NPC Installation Squirrel Standard Library Functions Forum NPCHide Command-line usage Attack Script (v1.5) Walking cop script

04 February 2023: Hiding/Changing name of NPC In-Game New Plugin. see

20 February 2023: New module Lib Action released. click here

27 June 2023: NPC v1.6 Beta5 is released. click here

24 August 2023: NPC v1.7 Beta is released See [forum.vc-mp.org]