GameRules.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.
 */
 
class ncRuleDelegate:ncIO
{
public:
    void ncRuleDelegate(void);
 
    /* overrides */
    virtual void Save(float);
    virtual void Restore(string,string);
    virtual void RestoreComplete(void);
    virtual void Input(entity, string, string);
 
    virtual void InitPostEnts(void);
    
    /* logic */
    virtual void Precache(void);
 
    virtual void Shutdown(void);
 
    virtual void FrameStart(void);
    virtual bool ConsoleCommand(ncPlayer,string);
    virtual bool ClientCommand(ncClient,string);
    virtual bool ImpulseCommand(ncClient, float);
    
    /* client */
    virtual void PlayerConnect(ncPlayer);
    virtual void PlayerDisconnect(ncPlayer);
    virtual void PlayerKill(ncPlayer);
    virtual void PlayerSpawn(ncPlayer);
    virtual void PlayerPreFrame(ncPlayer);
    virtual void PlayerPostFrame(ncPlayer);
    virtual void PlayerDeath(ncPlayer, ncEntity, ncEntity, string);
    virtual void PlayerPain(ncPlayer, ncActor, ncDict);
    virtual bool PlayerCanAttack(ncPlayer);
    virtual void PlayerInventoryChanged(ncPlayer);
    virtual void NPCDeath(ncActor, ncEntity, ncEntity);
 
    virtual bool PlayerRequestRespawn(ncPlayer);
 
    virtual bool PlayerRequestTeam(ncPlayer, int team);
    
    /* level transitions */
    virtual void LevelNewParms(void);
    virtual void LevelChangeParms(ncPlayer);
    virtual void LevelDecodeParms(ncPlayer);
    
    /* Entities/Item manipulation */
    virtual int MaxItemPerSlot(int);
    virtual bool MonstersSpawn(void);
    
    /* end of a game */
    virtual void IntermissionStart(void);
    virtual void IntermissionCycle(void);
    virtual void IntermissionEnd(void);
    virtual void IntermissionToPlayer(ncPlayer);
    virtual bool InIntermission(void);
    virtual void OnIntermissionCycle(void);
 
    virtual bool IsTeamplay(void);
    virtual bool IsMultiplayer(void);
 
 
    /* chat related methods */
    virtual void ChatMessageAll(ncClient, string);
 
    virtual void ChatMessageTeam(ncClient, string);
 
    virtual string Title(void);
 
    nonvirtual void LinkProgs(void);
    nonvirtual ncRuleDelegate ActiveInstance(void);
    
    /* spectator */
    /*
    virtual void SpectatorConnect(ncPlayer);
    virtual void SpectatorDisconnect(ncPlayer);
    virtual void SpectatorThink(ncPlayer);
    */
private:
    int m_iIntermission;
    float m_flIntermissionTime;
    float m_flIntermissionCycle;
    entity m_eIntermissionPoint;
};
 
/* our currently running mode */
ncRuleDelegate g_grMode;
var float g_ruleCProgs;
var string g_ruleCName;
 
#define CGameRules ncRuleDelegate
#define RULEMAP(x, y, z) x.y = externvalue(g_ruleCProgs, z); if (!x.y) { x.y = ncRuleDelegate::y; }
 
void RuleC_Init(void);