PutServerInRecordingMode

From NPC for VCMP 0.4 Servers
Revision as of 17:11, 17 February 2024 by 127.0.0.1 (talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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:
Returns true on success and false on failure (server already in recording mode)

Important Note:
Calling this function will stop any playback recordings started with StartRecordingPlayerData or StartRecordingAllPlayerData

Example

function onScriptLoad()
{
PutServerInRecordingMode("race", PLAYER_RECORDING_TYPE_ALL, REC_ALLNAME);
}
function onServerStop()
{
StopServerInRecordingMode();
}

Related Functions

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