Main Page: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
(226 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<strong>MediaWiki has been installed.</strong>
__NOEDITSECTION__ __NOTOC__
<big>
== 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.  


Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.
Each NPC run in its own process. The NPC scripts have functions as well as callbacks.  


== Getting started ==
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.
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
{| style=height:1em
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
|scope="col" style="width: 300px; text-align:left; vertical-align: top;"|
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
== NPC script callbacks ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
|scope="col" style="width: 630px;vertical-align: top;" | 
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
== NPC script functions ==
|scope="col" style="width: 300px;vertical-align: top;" |
==ServerData ==
|-style="vertical-align: top;"
|
* [[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==
* [[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]]
* [[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|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_man|Walking cop script]]
|}
</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 #4682B4; background-color: #FFE4B5; ">
03 October 2024: NPC v1.8 Beta 3 is released. [[V1_8_beta3_release_notes|click here]]
</poem>
<Poem style="border: 2px solid #4682B4; background-color: #FFE4B5; ">
'''25 October 2024: NPC v1.8 Beta 4'''. ('''new''') [[V1_8_beta4_release_notes|'''click here''']]
</poem>

Latest revision as of 12:44, 4 November 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

0.4.7.1

Store

Pickup

Checkpoint

Vehicle

Objects

More

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