Stats.h

/*
 * Copyright (c) 2016-2020 Marco Cawthorne <marco@icculus.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
 
var bool autocvar_logging_enabled = false;
 
/* ncStats Logging
 
A detailed record of a match or any game session.
 
*/
class
ncStats
{
public:
    nonvirtual void Init(void);
    nonvirtual void Shutdown(void);
    
    nonvirtual string OutputFilename(void);
    
    nonvirtual void Game(string keyName, string setValue);
    nonvirtual void Player(string keyName, string setValue);
    nonvirtual void Map(string keyName, string setValue);
    nonvirtual void JoinTeam(int teamID, ncPlayer leavingPlayer);
    nonvirtual void LeaveTeam(int teamID, ncPlayer leavingPlayer);
 
    /* player activities */
    nonvirtual void Connect(ncClient connectingClient);
    nonvirtual void Enter(ncPlayer enteringPlayer);
    nonvirtual void Leave(ncPlayer leavingPlayer);
    nonvirtual void Disconnect(ncPlayer disconnectinggPlayer);
    nonvirtual void Respawn(ncPlayer respawningPlayer);
    nonvirtual void NameChange(ncPlayer changedPlayer, string newName);
    nonvirtual void Kill(ncPlayer killedPlayer, ncEntity inflicingEntity, ncEntity attackingEntity, int attackerScoreChange, string attackerWeapon, int killedScoreChange, string deadWeapon);
 
    nonvirtual void PickupItem(ncItem takenItem, ncPlayer inflictingPlayer);
    nonvirtual void UseItem(ncItem useditem, ncPlayer inflictingPlayer);
    nonvirtual void DropItem(ncItem droppedItem, ncPlayer inflictingPlayer);
    nonvirtual void ExpireItem(ncItem expiredItem, ncPlayer inflictingPlayer);
 
    /* game state */
    nonvirtual void StartGame(void);
    nonvirtual void EndGame(string reasonString);
 
private:
    nonvirtual void Info(string, string);
    nonvirtual string LocalTime(void);
    nonvirtual string NetGamesTime(void);
};
 // end of logging