PutServerInRecordingMode: 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:
{{v1_8_beta}}
{{v1_8_beta}}
{{Welcome|
{{Welcome|
desc=Starts playback recording on all players and an hrec file is produced in <source inline>recordings/a_server</source>|
desc=Starts playback recording on all players and an hrec file is produced in <source inline>recordings/a_server/</source>|
params=<source>( hrecfilename, rectype=3, flags=REC_ALLNAME)</source>
params=<source>( hrecfilename, rectype=3, flags=REC_ALLNAME)</source>
<poem>
<poem>
::hrecfilename : The name of the hrec file without ".hrec" extension. This file will be created in recordings/a_server folder
::hrecfilename : The name of the hrec file without ".hrec" extension. This file will be created in recordings/a_server folder
::rectype : The [[RecordingTypes|type]] for playback recording which will be started on individual players, which in this case is 3 (PLAYER_RECORDING_TYPE_ALL)
::rectype : The [[RecordingTypes|type]] for playback recording which will be started on individual players, which in this case is 3 (PLAYER_RECORDING_TYPE_ALL)
::flags : The [[Recording_Flags|flags]] for the playback recording on individual players. Note that it is suitable to have REC_SPAWN so that npc will automatically choose classes. The default value if not provided is REC_ALLNAME (which contains REC_SPAWN, REC_DEATH, etc )</poem>
::flags : The [[Recording_Flags|flags]] for the playback recording on individual players. Note that it is suitable to have REC_SPAWN so that npc will automatically choose classes. The default value if not provided is REC_ALLNAME (which contains REC_SPAWN, REC_DEATH, etc )</poem>|
retval=Returns true on success and false on failure (server already in recording mode)|
relfuncs=*[[StopServerInRecordingMode]]
*[[IsServerInRecordingMode]]
*[[StartRecordingAllPlayerData]]
*[[IsPlayerRecording]]
}}
}}

Revision as of 15:30, 25 January 2024

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


Description:
Starts playback recording on all players and an hrec file is produced in recordings/a_server/


Parameters:

( hrecfilename, rectype=3, flags=REC_ALLNAME)

hrecfilename : The name of the hrec file without ".hrec" extension. This file will be created in recordings/a_server folder
rectype : The type for playback recording which will be started on individual players, which in this case is 3 (PLAYER_RECORDING_TYPE_ALL)
flags : The flags for the playback recording on individual players. Note that it is suitable to have REC_SPAWN so that npc will automatically choose classes. The default value if not provided is REC_ALLNAME (which contains REC_SPAWN, REC_DEATH, etc )


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



Related Functions

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