OnNPCScriptLoad: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<poem style="border: 2px solid #d6d2c5; background-color: #f9f4e6; padding: 1em;">
<poem style="border: 2px solid #d6d2c5; background-color: #f9f4e6; padding: 1em;">
 
Note: The argument params was added in v1.5 only
</poem>
<big><poem>'''Description''':  
<big><poem>'''Description''':  
::This function is called when a NPC script is loaded.
::This function is called when a NPC script is loaded.
Line 7: Line 8:


'''Parameters:'''
'''Parameters:'''
<syntaxhighlight lang="lua">This callback has no parameters.</syntaxhighlight>
<syntaxhighlight lang="lua">params</syntaxhighlight>
::params : An array containing string values which was passed to the npcscripts via [[ConnectNPCEx]] or npcclient.exe with the usage of -w parameter.


<poem>
<poem>
Line 17: Line 19:


<source lang="lua">
<source lang="lua">
function OnNPCScriptLoad()
function OnNPCScriptLoad(params)
{
{
print("NPC script loaded\n");
timer<- null;
print("params array length is "+params.len()+"\n");
print("arguments passed to script are:\n");
foreach( arg in params)
print(arg+"\n");
}
}
</source>
</source>
</big>
</big>

Revision as of 07:54, 30 November 2022

Note: The argument params was added in v1.5 only

Description:
This function is called when a NPC script is loaded.


Parameters:

params
params : An array containing string values which was passed to the npcscripts via ConnectNPCEx or npcclient.exe with the usage of -w parameter.


Return Values:
This callback does not handle returns


function OnNPCScriptLoad(params)
{
	timer<- null;
	print("params array length is "+params.len()+"\n");
	print("arguments passed to script are:\n");
	foreach( arg in params)
		print(arg+"\n");
	
}