ConnectNPC

From NPC for VCMP 0.4 Servers
Revision as of 17:17, 24 December 2022 by Habi (talk | contribs)
Jump to navigation Jump to search

Version 1.5 patch2 has added parameter enableconsoleinput. Version 1.1 do not have this parameter.


Description:
Connect an NPC to the server


Parameters:

(name, script="", enableconsoleinput=false, host="127.0.0.1")

name : The name for the NPC to use.
script : The script NPC must use. This script must reside in npcscripts folder.(with the ".nut" extension)
enableconsoleinput : true/false. If true, text typed in the console is passed to the npcscript by calling the function OnConsoleInput, if available. If true, the console will not be hidden. If false, text cannot be typed in the console and visibility of console depends on ShowNPCConsole called earlier.
host : This paramter is optional.


Return Values:
This function does not return any specific values.

Important Note:
Prior to version 1.5, script was mandatory.

Example

function onScriptLoad()
{
	ConnectNPC("[Bot]John", "test.nut");
}

Related Functions

The following functions may be helpful as they relate to this function in one way or another.