ConnectMultipleNpcs: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
(Created page with "{{v1_8_beta}} {{Welcome|desc=Opens a .hrec_file and starts connecting npcs using name present in the file.| params=<source>(filename,host="127.0.0.1",flags=7,execArg="")</source> <poem> :: filename : The name of the hrec file without the ".hrec" extension. The file must be present in the recordings/a_server/ folder. :: host : The IP address of the server to connect the npcs. :: flags : {| class="wikitable" |+ Flag Table ! Flag !! Description |- | AUTOMATIC_PLAY || St...")
 
No edit summary
Line 5: Line 5:
:: filename : The name of the hrec file without the ".hrec" extension. The file must be present in the recordings/a_server/ folder.
:: filename : The name of the hrec file without the ".hrec" extension. The file must be present in the recordings/a_server/ folder.
:: host : The IP address of the server to connect the npcs.
:: host : The IP address of the server to connect the npcs.
:: flags : {| class="wikitable"
:: flags : </poem>{| class="wikitable"
|+ Flag Table
|+ Flag Table
! Flag !! Description
! Flag !! Description
Line 14: Line 14:
|-
|-
| SHOW_CONSOLE || The console of NPCs will be visible.
| SHOW_CONSOLE || The console of NPCs will be visible.
|}
|}<poem>
:: execArg = The string to be executed when npc is connected. |
:: execArg = The string to be executed when npc is connected. </poem>|
retvals=true, on success. throws error on failure.|
retvals=true, on success. throws error on failure.|
relfuncs=*[[ConnectNPC]]
relfuncs=*[[ConnectNPC]]

Revision as of 15:24, 28 January 2024

This function was added in v1.8 beta and will not work on previous versions.


Description:
Opens a .hrec_file and starts connecting npcs using name present in the file.


Parameters:

(filename,host="127.0.0.1",flags=7,execArg="")

filename : The name of the hrec file without the ".hrec" extension. The file must be present in the recordings/a_server/ folder.
host : The IP address of the server to connect the npcs.
flags :

{


Return Values:
true, on success. throws error on failure.



Related Functions

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