ConnectMultipleNpcs: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:
{{{!}} class="wikitable"
{{{!}} class="wikitable"
{{!}}+ Flag Table
{{!}}+ Flag Table
! Flag !! Description
! Flag !! Description !!Value
{{!}}-
{{!}}-
{{!}} AUTOMATIC_PLAY {{!}}{{!}} Starts playing playback on class select.
{{!}} AUTOMATIC_PLAY {{!}}{{!}} Starts playing playback on class select.{{!}}{{!}}1
{{!}}-
{{!}}-
{{!}} DISCONNECT_AT_END {{!}}{{!}} Disconnects after playback is finished.
{{!}} DISCONNECT_AT_END {{!}}{{!}} Disconnects after playback is finished.{{!}}{{!}}2
{{!}}-
{{!}}-
{{!}} SHOW_CONSOLE {{!}}{{!}} The console of NPCs will be visible.
{{!}} SHOW_CONSOLE {{!}}{{!}} The console of NPCs will be visible.{{!}}{{!}}4
{{!}}}
{{!}}}
<poem>
<poem>

Revision as of 15:29, 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 :

Flag Table
Flag Description Value
AUTOMATIC_PLAY Starts playing playback on class select. 1
DISCONNECT_AT_END Disconnects after playback is finished. 2
SHOW_CONSOLE The console of NPCs will be visible. 4

execArg = The string to be executed when npc is connected.


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.