PutServerInRecordingMode: Difference between revisions
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
::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>| | ||
note=Calling this function will stop any playback recordings started with [[StartRecordingPlayerData]] or [[StartRecordingAllPlayerData]]| | |||
retvals=Returns true on success and false on failure (server already in recording mode)| | retvals=Returns true on success and false on failure (server already in recording mode)| | ||
relfuncs=*[[StopServerInRecordingMode]] | relfuncs=*[[StopServerInRecordingMode]] | ||
Revision as of 15:32, 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:
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
Related Functions
The following functions may be helpful as they relate to this function in one way or another.