ConnectNPC: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
<poem style="border: 2px solid #d6d2c5; background-color: #ffff00; padding: 1em;"> | |||
Version 1.5 patch2 has added parameter enableconsoleinput. Version 1.1 do not have this parameter. | |||
</poem> | |||
{{Welcome| | {{Welcome| | ||
desc=Connect an NPC to the server| | desc=Connect an NPC to the server| | ||
params=<syntaxhighlight lang="lua">(name, script="", host="127.0.0.1")</syntaxhighlight> | params=<syntaxhighlight lang="lua">(name, script="", enableconsoleinput=false, host="127.0.0.1")</syntaxhighlight> | ||
<poem>::name : The name for the NPC to use. | <poem>::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) | ::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. </poem>| | ::host : This paramter is optional. </poem>| | ||
retval= This function always return 1.| | retval= This function always return 1.| | ||
Revision as of 17:17, 24 December 2022
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.