NSGameRules.h

Go to the documentation of this file.

/*
 * 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.
 */
 
class NSGameRules:NSIO
{
public:
        void NSGameRules(void);
 
        /* overrides */
        virtual void Save(float);
        virtual void Restore(string,string);
        virtual void RestoreComplete(void);
 
        virtual void InitPostEnts(void);
        
        /* logic */
        virtual void FrameStart(void);
        virtual bool ConsoleCommand(NSClientPlayer,string);
        virtual bool ClientCommand(NSClient,string);
        virtual bool ImpulseCommand(NSClient, float);
        
        /* client */
        virtual void PlayerConnect(NSClientPlayer);
        virtual void PlayerDisconnect(NSClientPlayer);
        virtual void PlayerKill(NSClientPlayer);
        virtual void PlayerSpawn(NSClientPlayer);
        virtual void PlayerPreFrame(NSClientPlayer);
        virtual void PlayerPostFrame(NSClientPlayer);
        virtual void PlayerDeath(NSClientPlayer);
        virtual void PlayerPain(NSClientPlayer);
        virtual bool PlayerCanAttack(NSClientPlayer);
 
        virtual bool PlayerRequestRespawn(NSClientPlayer);
        
        /* level transitions */
        virtual void LevelNewParms(void);
        virtual void LevelChangeParms(NSClientPlayer);
        
        /* Entities/Item manipulation */
        virtual int MaxItemPerSlot(int);
        virtual bool MonstersSpawn(void);
        nonvirtual void DamageApply(entity,entity,float,int,damageType_t);
        nonvirtual bool DamageCheckTrace(entity,vector);
        nonvirtual void DamageRadius(vector,entity,float,float,bool,int);
        
        /* end of a game */
        virtual void IntermissionStart(void);
        virtual void IntermissionCycle(void);
        virtual void IntermissionEnd(void);
        virtual void IntermissionToPlayer(NSClientPlayer);
        virtual bool InIntermission(void);
 
        virtual bool IsTeamplay(void);
        virtual bool IsMultiplayer(void);
 
        /* chat related methods */
        virtual void ChatMessageAll(NSClient, string);
 
        virtual void ChatMessageTeam(NSClient, string);
 
        virtual string Title(void);
        
        /* spectator */
        /*
        virtual void SpectatorConnect(NSClientPlayer);
        virtual void SpectatorDisconnect(NSClientPlayer);
        virtual void SpectatorThink(NSClientPlayer);
        */
private:
        int m_iIntermission;
        float m_flIntermissionTime;
        float m_flIntermissionCycle;
        entity m_eIntermissionPoint;
};
 
/* our currently running mode */
NSGameRules g_grMode;
 
#define CGameRules NSGameRules