ModTextScriptCommand.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.
*/
 
#include <CavestoryModAPI.h>
 
#pragma once
 
 
#define TSC_NAME_TO_HEX(A,B,C) (int(A) | (int(B) << 8) | (int(C) << 16))
 
class ModTextScriptCommand
{
public: // Typedefs
 
    typedef void(*TSCRunFunc)(int& x, int& y, int& z, int& w, bool& bExit, int& iError);
 
public: // Linking
 
    static ModTextScriptCommand* first;
 
    ModTextScriptCommand* next;
 
protected: // Variables
 
    TSCRunFunc mExecute;
 
public: // Human information
 
    char mCommand[4];
 
    char* mShortDesc;
 
    char* mDesc;
 
    char* mArguments;
 
public: // Constructors
 
    ModTextScriptCommand() {}
 
    ModTextScriptCommand(TSCRunFunc pCommand, char pFirst, char pSecond, char pThird, const char* pShortDesc, const char* pDesc, const char* pArgs);
 
    ~ModTextScriptCommand();
 
public: // Public, static methods
 
    static void Init();
};
 
//---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
inline ModTextScriptCommand::ModTextScriptCommand(TSCRunFunc pCommand, char pFirst, char pSecond, char pThird, const char* pShortDesc, const char* pDesc, const char* pArgs)
{
    mCommand[0] = pFirst;
    mCommand[1] = pSecond;
    mCommand[2] = pThird;
    mCommand[3] = 0;
    mShortDesc  = strdup(pShortDesc);
    mDesc       = strdup(pDesc);
    mArguments  = strdup(pArgs);
    mExecute    = pCommand;
 
    // Link us up
    next  = first;
    first = this;
}
 
inline ModTextScriptCommand::~ModTextScriptCommand()
{
    if (mShortDesc)
        free(mShortDesc);
    
    if (mDesc)
        free(mDesc);
    
    if (mArguments)
        free(mArguments);
}
 
//----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
inline void ModTextScriptCommand::Init()
{
    // Populate the lists
    for (ModTextScriptCommand* walk = ModTextScriptCommand::first; walk; walk = walk->next)
    {
        if (CSM_RegisterTextScriptCommand(walk->mCommand, walk->mShortDesc, walk->mDesc, walk->mArguments, walk->mExecute) == FALSE)
        {
            CSM_LogError("Mod/TextScript", "Failed to register TextScript command <%.3s!", walk->mCommand);
            // Used to do it like this so the error message would still be printed to console in the event that trying to fetch the command's name crashed the game
            //CSM_Log("Mod/TextScript", "Failed to register TextScript command <");
            //CSM_Log("%.3s!\r\n", walk->mCommand);
        }
    }
}
 
//---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
#ifdef _TEXT_SCRIPT_FILE_
#define DEFINE_TEXTSCRIPT_COMMAND(NAMEA, NAMEB, NAMEC, SHORTHAND_DESC, DESC, ARGS) \
    extern void __declspec(dllexport) __##NAMEA##NAMEB##NAMEC##__RUNFUNC__(int& x, int& y, int& z, int& w, bool& bExit, int& iError);\
    static ModTextScriptCommand __CMD_##NAMEA##NAMEB##NAMEC##(&__##NAMEA##NAMEB##NAMEC##__RUNFUNC__, #@NAMEA, #@NAMEB, #@NAMEC, SHORTHAND_DESC, DESC, ARGS);\
    void __##NAMEA##NAMEB##NAMEC##__RUNFUNC__(int& x, int& y, int& z, int& w, bool& bExit, int& iError)
 
#define TGetMyChar              (*gCurrentPtrData.Char)
#define TGetGameFlags           (*gCurrentPtrData.GameFlags)
#define TGetPlayer              gCurrentPtrData.Player
#define TGetClient              gCurrentPtrData.Client
#define TGetKey                 (*gCurrentPtrData.Key)
#define TGetKeyTrg              (*gCurrentPtrData.KeyTrg)
#endif
 
///