Introduce API events & functions to work w/replays

[allejo]

New Functions

bool bz_isReplayServer(void)

Returns true if the current BZFS process runs with the -replay flag.

bool bz_loadReplay(const char* _filename, int playerIndex = BZ_SERVERPLAYER)

The BZFS API equivalent of a player running /replay load.

bool bz_replayExists(const char* _filename)

Check to see if a given replay filename exists on the server.

bool bz_unloadReplay(int playerIndex = BZ_SERVERPLAYER)

Reset the replay server's status and unload the current replay. This is no slash-command equivalent of this (as far as I know).

New Server Events

bz_eReplayRequestedEvent

• Dispatched from Replay::loadFile -> called from /replay load
• This event is triggered before bz_eReplayLoadedEvent; any errors that happen in loading replays will be reported here

Property	Data Type	Description
playerID	int	The player ID that is requesting the replay to be loaded
success	bool	Whether the replay was able to load successfully
errorMsg	const char*	If there's an error in loading the replay, the details will be here
filename	const char*	The filename of the replay requested

bz_eReplayLoadedEvent

• Dispatched from Replay::loadFile -> called from /replay load
• This event is only triggered when a file is successfully loaded. If the replay fails to load, this event is never called

Property	Data Type	Description
filename	const char*	The filename of the replay that's being loaded
authorCallsign	const char*	The callsign of the player (or "SERVER") if who started the replay
authorMotto	const char*	The motto of the author who triggered the recording
protocol	const char*	The BZFS protocol version the replay was recorded with
serverVersion	const char*	The BZFS version used for the replay
seconds	float	The duration of this recording in seconds
start	bz_Time*	Timestamp of when the replay started
end	bz_Time*	...and when it ended

bz_eRecordingStartedEvent

• Dispatched when a recording starts, i.e. Record::start
  • Called during /record start
  • Called during bz_startRecBuf()

Property	Data Type	Description
playerID	int	The player ID that started the recording or 253 if the server starts it

bz_eRecordingEndedEvent

• Dispatched when a recording ends, i.e. Record:stop
  • Called during /record stop
  • Called during bz_stopRecBuf()

Data fields are the same as bz_eRecordingStartedEvent