CSMAPI_BaseModInterface.h

Go to the documentation of this file.

/*
  Cavestory Multiplayer API
  Copyright (C) 2021 Johnny Ledger
 
  This software is provided 'as-is', without any express or implied
  warranty.  In no event will the authors be held liable for any damages
  arising from the use of this software.
 
  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:
 
  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.
*/
 
#pragma once
 
#include <CSMAPI_begincode.h>
 
class CAVESTORY_MOD_API BaseModInterface
{
public: // Private stuff!
 
    static BaseModInterface* gsModInterface;
 
public: // C++ garbage
 
    BaseModInterface();
 
    ~BaseModInterface();
 
public: // Mod functions
 
    virtual int OnInit() { return 0; }
    
    virtual void OnShutdown() {}
 
    virtual int OnEnterTitleScreen(bool& bImmediateReturn, unsigned char& pAction) { return 0; }
 
    virtual bool IsMultiplayer() { return false; }
    
    virtual bool IsSingleplayer() { return true; }
    
    virtual bool HasIntroSequence() { return true; }
    
    virtual int GetIntroSequenceLength() { return 500; }
    
    virtual bool IsRevivingPlayersAllowed() { return true; }
    
    virtual bool DisableEveryoneDiedEvent() { return false; }
};
 
#include <CSMAPI_endcode.h>