Main Page: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
No edit summary
No edit summary
(162 intermediate revisions by 2 users not shown)
Line 2: Line 2:
<big>
<big>
== Introduction ==
== Introduction ==
NPCs also known as bots -feature introduced in April 2022 in [https://forum.vc-mp.org/?topic=8799.0 vc-mp forum].
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.
This new feature allows you to create NPCs inside your server who will work like virtual players. 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.  
Their actions are scripted by squirrel scripts. These scripts with 'artificial intelligence' of NPC reside in '''npcscripts''' directory. If you want to have 10 different NPC doing 10 different things, you might want to script 10 different scripts.


Each NPC run in its own process. This might make their usage and working economical. The NPC scripts have functions as well as callbacks.
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.
{| style=height:1em
{| style=height:1em
|scope="col" style="width: 300px; text-align:left; vertical-align: top;"|  
|scope="col" style="width: 300px; text-align:left; vertical-align: top;"|  
== NPC script callbacks ==
== NPC script callbacks ==
|scope="col" style="width: 700px;vertical-align: top;" |   
|scope="col" style="width: 630px;vertical-align: top;" |   
== NPC script functions ==  
== NPC script functions ==  
|scope="col" style="width: 300px;vertical-align: top;" |
==ServerData ==
|-style="vertical-align: top;"
|-style="vertical-align: top;"
|  
|  
Line 30: Line 32:
* [[OnVehicleStreamOut]]
* [[OnVehicleStreamOut]]
* [[OnRecordingPlaybackEnd]]         
* [[OnRecordingPlaybackEnd]]         
* [[OnPlayerUpdate]]
* [[OnSniperRifleFired]]
* [[OnConsoleInput]]
* [[OnServerData]]
* [[OnExplosion]]
* [[OnProjectileFired]]
* [[OnNPCClassSelect]]
* [[OnServerShareTick]]
*[[OnTimeWeatherSync]]
==Constants==
* [[Bodypart| BodyParts]]
* [[field| LocalValue fields]]
* [[Keys|Game Keys]]
* [[Player_States|Player States]]
* [[Play_Flags|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]]
  ||  
  ||  
* [[StartRecordingPlayback]]
* [[StartRecordingPlayback]]
Line 44: Line 106:
* [[IsVehicleStreamedIn]]
* [[IsVehicleStreamedIn]]
* [[IsPlayerStreamedIn]]
* [[IsPlayerStreamedIn]]
== Functions used only within gamemode==
* [[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]]
* [[ConnectNPC]]
* [[ConnectNPCEx]]
* [[IsPlayerNPC]]
* [[IsPlayerNPC]]
* [[ShowNPCConsole]]
* [[StartRecordingPlayerData]]
* [[StopRecordingPlayerData]]
* [[RFC]]
* [[F]]
* [[Examples]] (Remote calls)
* [[StartRecordingAllPlayerData]] (v1.8)
* [[StopRecordingAllPlayerData]]
* [[PutServerInRecordingMode]]
* [[StopServerInRecordingMode]]
* [[IsPlayerRecording]]
* [[IsServerInRecordingMode]]
* [[ConnectMultipleNpcs]]
* [[StopConnectingMultipleNpcs]]
* [[Server.cfg|server.cfg values]]
==Tools==
* [[recupdate]]
* [[recEdit]]
||
* [[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 ==
== More ==
* [[AdditionalFunctions|Additional Functions]]
* [[SquirrelPlugin|Squirrel Add-On Plugin]]
*[[NPC Installation]]
*[[NPC Installation]]
== 0.1b Functions ==
* [[Squirrel Standard Library Functions]]
* [[SendNPCSyncData]]
* [[NPCHide]]
* [[Command-line usage]]
* [[Attack Script]] (v1.5)
* [[walking_man|Walking cop script]]
|}
|}
</big>
</big>
<poem style="border: 2px solid #d6d2c5; background-color: #19f4e6; ">
'''04 February 2023: Hiding/Changing name of NPC In-Game New Plugin. [[NPCHide|see]]
</poem>
<Poem style="border: 2px solid #d6d2c5; background-color: #FFC0CB; ">
'''29 February 2024: NPC v1.8 Beta P1 is released'''. (new) [[V1_8_beta_release_notes|'''click here''']]
</poem>

Revision as of 06:09, 6 May 2024

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

Constants

Classes

Player functions

Modules

v1.8

Advanced functions

Functions used only in server scripts

Tools

Pickup

Checkpoint

Vehicle

Objects

More

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

29 February 2024: NPC v1.8 Beta P1 is released. (new) click here