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 any artificial intelligence, the script parameter can be omitted.

NPC script callbacks	NPC script functions	ServerData
OnNPCScriptLoad OnNPCScriptUnload OnNPCConnect OnNPCDisconnect OnNPCSpawn OnNPCEnterVehicle OnNPCExitVehicle OnClientMessage OnPlayerDeath OnPlayerText OnPlayerStreamIn OnPlayerStreamOut OnVehicleStreamIn OnVehicleStreamOut OnRecordingPlaybackEnd OnPlayerUpdate OnSniperRifleFired OnConsoleInput OnServerData OnExplosion OnProjectileFired OnNPCClassSelect OnServerShareTick OnTimeWeatherSync Constants BodyParts LocalValue fields Game Keys Player States Play Flags Classes Vector Quaternion Player functions GetPlayerState GetPlayerPos GetPlayerVehicleID GetPlayerArmedWeapon GetPlayerHealth GetPlayerArmour GetPlayerKeys GetPlayerFacingAngle IsPlayerInRangeOfPoint GetPlayerName IsPlayerConnected GetPlayerSkin GetPlayerTeam GetPlayerSlotWeapon GetPlayerSlotAmmo GetPlayerSpeed GetPlayerAction WhereIsPlayer Modules LibRPC LibAction npcmodule (to be renamed) z-finder v1.8 Suicide SetMyHealth GetMyHealth LookAtPos LookAtPlayer GetMyClass RequestClassAbs AmISpawned GetMySkin GetMyTeam GetMyArmour SendPrivMsg SetConfig GetPlayerColor GetMyColor IsPlaybackRunning IsPlaybackPaused InPoly	StartRecordingPlayback StopRecordingPlayback PauseRecordingPlayback ResumeRecordingPlayback SendChat SendCommand GetMyPos SetMyPos GetMyFacingAngle SetMyFacingAngle GetDistanceFromMeToPoint IsVehicleStreamedIn IsPlayerStreamedIn SelectWeapon (v1.6 b4p2) GetAvailableWeapons GetAmmoOfMyWeapon SetTimer SetTimerEx KillTimer GetMyName GetMyID QuitServer RequestClass ReqeustClassAbs RequestSpawn GetTickCount GetClosestPlayer GetSlotFromWeaponId FaceNPCToPlayer Advanced functions SendOnFootSyncData SendOnFootSyncDataEx SendOnFootSyncDataLV SendInCarSyncData SendInCarSyncDataEx SendInCarSyncDataLV SendPassengerSyncData FireSniperRifle FireSniperRifleEx FireProjectile SendShotInfo SendDeathInfo GetLocalValue SetLocalValue Functions used only in server scripts ConnectNPC ConnectNPCEx IsPlayerNPC ShowNPCConsole StartRecordingPlayerData StopRecordingPlayerData RFC F Examples (Remote calls) StartRecordingAllPlayerData (v1.8) StopRecordingAllPlayerData PutServerInRecordingMode StopServerInRecordingMode IsPlayerRecording IsServerInRecordingMode ConnectMultipleNpcs StopConnectingMultipleNpcs server.cfg values Tools recupdate recEdit 0.4.7.1 FireBullet OnBulletFired Store GetStoreLocation IsStoreDownloading OnStoreDownloadComplete GetStoreURL	SendServerData ReadInt ReadByte ReadFloat ReadString WriteInt WriteByte WriteFloat WriteString Pickup ClaimPickup IsPickupStreamedIn GetPickupModel GetPickupAlpha GetPickupQuantity GetPickupPos GetPickupCount OnPickupStreamIn OnPickupDestroyed OnPickupUpdate Checkpoint OnCheckpointStreamIn OnCheckpointDestroyed OnCheckpointUpdate IsCheckpointStreamedIn GetCheckpointRadius GetCheckpointPos GetCheckpointColor IsCheckpointSphere ClaimEnterCheckpoint ClaimExitCheckpoint GetCheckpointCount Vehicle EnterVehicle GetVehicleDriver GetVehicleModel GetVehicleTurretRot GetVehicleRotation GetVehiclePos GetVehicleSpeed GetVehicleHealth GetVehicleDamage ExitVehicle ExitVehicleEx Objects OnObjectStreamIn OnObjectDestroyed OnObjectUpdate IsObjectStreamedIn GetObjectModel GetObjectPos GetObjectRotation GetObjectAlpha IsObjectTouchReportEnabled IsObjectShotReportEnabled ClaimObjectTouch ClaimObjectShot GetObjectCount More NPC Installation Squirrel Standard Library Functions NPCHide Command-line usage Attack Script (v1.5) Walking cop script

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

03 October 2024: NPC v1.8 Beta 3 is released. click here

25 October 2024: NPC v1.8 Beta 4. (new) click here