Merge branch 'master' into 'plure'

Master

See merge request !16

MQ2Posse/ISXEQPosse.cpp

+//
+// ISXEQPosse
+//
+#pragma warning(disable:4996)
+#include "../ISXEQClient.h"
+#include "ISXEQPosse.h"
+
+// The mandatory pre-setup function.  Our name is "ISXEQPosse", and the class is ISXEQPosse.
+// This sets up a "ModulePath" variable which contains the path to this module in case we want it,
+// and a "PluginLog" variable, which contains the path and filename of what we should use for our
+// debug logging if we need it.  It also sets up a variable "pExtension" which is the pointer to
+// our instanced class.
+ISXPreSetup("ISXEQPosse",ISXEQPosse);
+
+// Basic LavishScript datatypes, these get retrieved on startup by our initialize function, so we can
+// use them in our Top-Level Objects or custom datatypes
+LSType *pStringType=0;
+LSType *pIntType=0;
+LSType *pBoolType=0;
+LSType *pFloatType=0;
+LSType *pTimeType=0;
+LSType *pByteType=0;
+
+ISInterface *pISInterface=0;
+HISXSERVICE hPulseService=0;
+HISXSERVICE hMemoryService=0;
+HISXSERVICE hServicesService=0;
+
+HISXSERVICE hEQChatService=0;
+HISXSERVICE hEQUIService=0;
+HISXSERVICE hEQGamestateService=0;
+HISXSERVICE hEQSpawnService=0;
+HISXSERVICE hEQZoneService=0;
+
+unsigned int ISXEQPosseXML=0;
+
+// Forward declarations of callbacks
+void __cdecl PulseService(bool Broadcast, unsigned int MSG, void *lpData);
+void __cdecl MemoryService(bool Broadcast, unsigned int MSG, void *lpData);
+void __cdecl ServicesService(bool Broadcast, unsigned int MSG, void *lpData);
+
+
+// Initialize is called by Inner Space when the extension should initialize.
+bool ISXEQPosse::Initialize(ISInterface *p_ISInterface)
+{    pISInterface=p_ISInterface;
+
+// retrieve basic ISData types
+pStringType=pISInterface->FindLSType("string");
+pIntType=pISInterface->FindLSType("int");
+pBoolType=pISInterface->FindLSType("bool");
+pFloatType=pISInterface->FindLSType("float");
+pTimeType=pISInterface->FindLSType("time");
+pByteType=pISInterface->FindLSType("byte");
+
+
+pISInterface->OpenSettings(XMLFileName);
+LoadSettings();
+
+ConnectServices();
+
+RegisterCommands();
+RegisterAliases();
+RegisterDataTypes();
+RegisterTopLevelObjects();
+RegisterServices();
+
+WriteChatf("ISXEQPosse Loaded");
+return true;
+}
+
+// shutdown sequence
+void ISXEQPosse::Shutdown()
+{
+    // save settings, if you changed them and want to save them now.  You should normally save
+    // changes immediately.
+    //pISInterface->ExportSet(ISXEQPosseXML,XMLFileName);
+
+    pISInterface->UnloadSet(ISXEQPosseXML);
+
+    DisconnectServices();
+
+    UnRegisterServices();
+    UnRegisterTopLevelObjects();
+    UnRegisterDataTypes();
+    UnRegisterAliases();
+    UnRegisterCommands();
+}
+
+
+void ISXEQPosse::ConnectServices()
+{
+    // connect to any services.  Here we connect to "Pulse" which receives a
+    // message every frame (after the frame is displayed) and "Memory" which
+    // wraps "detours" and memory modifications
+    hPulseService=pISInterface->ConnectService(this,"Pulse",PulseService);
+    hMemoryService=pISInterface->ConnectService(this,"Memory",MemoryService);
+    hServicesService=pISInterface->ConnectService(this,"Services",ServicesService);
+
+
+}
+
+void ISXEQPosse::RegisterCommands()
+{
+    // add any commands
+    //    pISInterface->AddCommand("MyCommand",MyCommand,true,false);
+
+}
+
+void ISXEQPosse::RegisterAliases()
+{
+    // add any aliases
+}
+
+void ISXEQPosse::RegisterDataTypes()
+{
+    // add any datatypes
+    // pMyType = new MyType;
+    // pISInterface->AddLSType(*pMyType);
+}
+
+void ISXEQPosse::RegisterTopLevelObjects()
+{
+    // add any Top-Level Objects
+    //    pISInterface->AddTopLevelObject("MapSpawn",tloMapSpawn);
+}
+
+void ISXEQPosse::RegisterServices()
+{
+    // register any services.  Here we demonstrate a service that does not use a
+    // callback
+    // set up a 1-way service (broadcast only)
+    //    hISXEQPosseService=pISInterface->RegisterService(this,"ISXEQPosse Service",0);
+    // broadcast a message, which is worthless at this point because nobody will receive it
+    // (nobody has had a chance to connect)
+    //    pISInterface->ServiceBroadcast(this,hISXEQPosseService,ISXSERVICE_MSG+1,0);
+
+}
+
+void ISXEQPosse::DisconnectServices()
+{
+    // gracefully disconnect from services
+    if (hPulseService)
+        pISInterface->DisconnectService(this,hPulseService);
+    if (hMemoryService)
+    {
+        pISInterface->DisconnectService(this,hMemoryService);
+        // memory modifications are automatically undone when disconnecting
+        // also, since this service accepts messages from clients we should reset our handle to
+        // 0 to make sure we dont try to continue using it
+        hMemoryService=0; 
+    }
+    if (hServicesService)
+        pISInterface->DisconnectService(this,hServicesService);
+}
+
+void ISXEQPosse::UnRegisterCommands()
+{
+    // remove commands
+    //    pISInterface->RemoveCommand("MyCommand");
+}
+void ISXEQPosse::UnRegisterAliases()
+{
+    // remove aliases
+}
+void ISXEQPosse::UnRegisterDataTypes()
+{
+    // remove data types
+    //if (pMyType)
+    //{
+    //    pISInterface->RemoveLSType(*pMyType);
+    //    delete pMyType;
+    //}
+}
+void ISXEQPosse::UnRegisterTopLevelObjects()
+{
+    // remove Top-Level Objects
+    //    pISInterface->RemoveTopLevelObject("MapSpawn");
+}
+void ISXEQPosse::UnRegisterServices()
+{
+    // shutdown our own services
+    //    if (hISXEQPosseService)
+    //        pISInterface->ShutdownService(this,hISXEQPosseService);
+}
+
+void ISXEQPosse::LoadSettings()
+{
+    bool bChanged=false;
+
+    // open the settings file, and store the ID number in ISXEQPosseXML
+    ISXEQPosseXML=pISInterface->OpenSettings(XMLFileName);
+    // This ID is used to refer to the base set of the loaded settings
+
+    /*
+    Here is an example settings hierarchy:
+    base set
+    ..settings
+    .."General" set
+    .."Characters" set
+    ...."Server A" set
+    ......"Character A" set
+    ........settings
+    ......"Character B" set
+    ........settings
+    ...."Server B" set
+    ......"Character A" set
+    ........settings
+    ...."Server C" set 
+    ......"Character A" set
+    ........settings
+    ......"Character B" set
+    ........settings
+    ......"Character C" set
+    ........settings
+
+    As you can see, there can be any number of nested sets, which can contain sets, settings, and comments.
+    Any set can be referred to by its ID.  The base set is stored in ISXEQPosseXML.  Note that the settings
+    are NOT "xml" after loading them, they are simply settings stored in memory!
+    */
+    // Get General set ID, which can be a child of the base set
+    if (unsigned int GeneralGUID=pISInterface->FindSet(ISXEQPosseXML,"General"))
+    {
+        // retrieve a text setting from the General set
+        char Text[512];
+        if (pISInterface->GetSetting(GeneralGUID,"Name of setting",Text,512))
+        {
+            // success
+        }
+        unsigned int IntSetting;
+        if (pISInterface->GetSetting(GeneralGUID,"Name of int setting",IntSetting))
+        {
+            // success
+        }
+    }
+    /*
+    Deeper sets and settings are accessed in exactly the same way.  If a sub-set of General was to be used,
+    accessing it would work like so:
+    if (unsigned int SubSetGUID=pISInterface->FindSet(GeneralGUID,"Sub-set name"))
+    {
+    // got the sub-set
+    }
+    */
+
+    // save settings if we changed them
+    if (bChanged)
+        pISInterface->ExportSet(ISXEQPosseXML,XMLFileName);
+    // Note: ExportSet can save ANY set and its settings, sets, and comments as ANY filename.  The "General" set
+    // could be stored as "General.XML" simply by doing pISInterface->ExportSet(GeneralGUID,"General.XML");
+}
+
+
+void __cdecl PulseService(bool Broadcast, unsigned int MSG, void *lpData)
+{
+    if (MSG==PULSE_PULSE)
+    {
+        // Same as OnPulse
+    }
+}
+
+void __cdecl MemoryService(bool Broadcast, unsigned int MSG, void *lpData)
+{
+    // no messages are currently associated with this service (other than
+    // system messages such as client disconnect), so do nothing.
+}
+
+void __cdecl EQUIService(bool Broadcast, unsigned int MSG, void *lpData)
+{
+    switch(MSG)
+    {
+    case UISERVICE_CLEANUP:
+        // same as OnCleanUI
+        break;
+    case UISERVICE_RELOAD:
+        // same as OnReloadUI
+        break;
+    }
+}
+void __cdecl EQGamestateService(bool Broadcast, unsigned int MSG, void *lpData)
+{
+#define GameState ((unsigned int)lpData)
+    if (MSG==GAMESTATESERVICE_CHANGED)
+    {
+        // same as SetGameState
+    }
+#undef GameState
+}
+void __cdecl EQSpawnService(bool Broadcast, unsigned int MSG, void *lpData)
+{
+    switch(MSG)
+    {
+#define pSpawn ((PSPAWNINFO)lpData)
+    case SPAWNSERVICE_ADDSPAWN:
+        // same as OnAddSpawn
+        break;
+    case SPAWNSERVICE_REMOVESPAWN:
+        // same as OnRemoveSpawn
+        break;
+#undef pSpawn
+#define pGroundItem ((PGROUNDITEM)lpData)
+    case SPAWNSERVICE_ADDITEM:
+        // same as OnAddGroundItem
+        break;
+    case SPAWNSERVICE_REMOVEITEM:
+        // same as OnRemoveGroundItem
+        break;
+#undef pGroundItem
+    }
+}
+
+void __cdecl EQZoneService(bool Broadcast, unsigned int MSG, void *lpData)
+{
+    switch(MSG)
+    {
+    case ZONESERVICE_BEGINZONE:
+        // same as OnBeginZone
+        break;
+    case ZONESERVICE_ENDZONE:
+        // same as OnEndZone
+        break;
+    case ZONESERVICE_ZONED:
+        // same as OnZoned
+        break;
+    }
+}
+
+void __cdecl EQChatService(bool Broadcast, unsigned int MSG, void *lpData)
+{
+#define pChat ((_EQChat*)lpData)
+    switch(MSG)
+    {
+    case CHATSERVICE_OUTGOING:
+        // same as OnWriteChatColor
+        break;
+    case CHATSERVICE_INCOMING:
+        // same as OnIncomingChat
+        break;
+    }
+#undef pChat
+}
+
+// This uses the Services service to connect to ISXEQ services
+void __cdecl ServicesService(bool Broadcast, unsigned int MSG, void *lpData)
+{
+#define Name ((char*)lpData)
+    switch(MSG)
+    {
+    case SERVICES_ADDED:
+        if (!stricmp(Name,"EQ UI Service"))
+        {
+            hEQUIService=pISInterface->ConnectService(pExtension,Name,EQUIService);
+        }
+        else if (!stricmp(Name,"EQ Gamestate Service"))
+        {
+            hEQGamestateService=pISInterface->ConnectService(pExtension,Name,EQGamestateService);
+        }
+        else if (!stricmp(Name,"EQ Spawn Service"))
+        {
+            hEQSpawnService=pISInterface->ConnectService(pExtension,Name,EQSpawnService);
+        }
+        else if (!stricmp(Name,"EQ Zone Service"))
+        {
+            hEQZoneService=pISInterface->ConnectService(pExtension,Name,EQZoneService);
+        }
+        else if (!stricmp(Name,"EQ Chat Service"))
+        {
+            hEQChatService=pISInterface->ConnectService(pExtension,Name,EQChatService);
+        }
+        break;
+    case SERVICES_REMOVED:
+        if (!stricmp(Name,"EQ UI Service"))
+        {
+            if (hEQUIService)
+            {
+                pISInterface->DisconnectService(pExtension,hEQUIService);
+                hEQUIService=0;
+            }
+        }
+        else if (!stricmp(Name,"EQ Gamestate Service"))
+        {
+            if (hEQGamestateService)
+            {
+                pISInterface->DisconnectService(pExtension,hEQGamestateService);
+                hEQGamestateService=0;
+            }
+        }
+        else if (!stricmp(Name,"EQ Spawn Service"))
+        {
+            if (hEQSpawnService)
+            {
+                pISInterface->DisconnectService(pExtension,hEQSpawnService);
+                hEQSpawnService=0;
+            }
+        }
+        else if (!stricmp(Name,"EQ Zone Service"))
+        {
+            if (hEQZoneService)
+            {
+                pISInterface->DisconnectService(pExtension,hEQZoneService);
+                hEQZoneService=0;
+            }
+        }
+        else if (!stricmp(Name,"EQ Chat Service"))
+        {
+            if (hEQChatService)
+            {
+                pISInterface->DisconnectService(pExtension,hEQChatService);
+                hEQChatService=0;
+            }
+        }
+        break;
+    }
+#undef Name
+}
+
+int MyCommand(int argc, char *argv[])
+{
+    // IS Commands work just like console programs. argc is the argument (aka parameter) count, 
+    // argv is an array containing them.  The name of the command is always the first argument.
+    if (argc<2)
+    {
+        // This command requires arguments
+        WriteChatf("Syntax: %s <text>",argv[0]);
+        return 0;
+    }
+
+    char FullText[8192]={0};
+    pISInterface->GetArgs(1,argc,argv,FullText); // this gets the rest of the arguments, from 1 to argc
+    WriteChatf("You passed the following text to the command:");
+    WriteChatf("%s",FullText);
+
+    // For most commands, you need to deal with only one argument at a time, instead of the entire line.
+    for (int i = 1 ; i < argc ; i++)
+    {
+        WriteChatf("argv[%d]=\"%s\"",i,argv[i]);
+    }
+
+    // return 0 or greater for normal conditions, or return -1 for an error that should stop
+    // a script. 
+    return 0;
+}

MQ2Posse/ISXEQPosse.h

+#pragma once
+#include <isxdk.h>
+
+
+class ISXEQPosse :
+    public ISXInterface
+{
+public:
+
+    virtual bool Initialize(ISInterface *p_ISInterface);
+    virtual void Shutdown();
+
+    void LoadSettings();
+    void ConnectServices();
+    void RegisterCommands();
+    void RegisterAliases();
+    void RegisterDataTypes();
+    void RegisterTopLevelObjects();
+    void RegisterServices();
+
+    void DisconnectServices();
+    void UnRegisterCommands();
+    void UnRegisterAliases();
+    void UnRegisterDataTypes();
+    void UnRegisterTopLevelObjects();
+    void UnRegisterServices();
+
+};
+
+extern ISInterface *pISInterface;
+extern HISXSERVICE hPulseService;
+extern HISXSERVICE hMemoryService;
+extern HISXSERVICE hServicesService;
+
+extern HISXSERVICE hEQChatService;
+extern HISXSERVICE hEQUIService;
+extern HISXSERVICE hEQGamestateService;
+extern HISXSERVICE hEQSpawnService;
+extern HISXSERVICE hEQZoneService;
+
+extern ISXEQPosse *pExtension;
+#define printf pISInterface->Printf
+
+#define EzDetour(Address, Detour, Trampoline) IS_Detour(pExtension,pISInterface,hMemoryService,(unsigned int)Address,Detour,Trampoline)
+#define EzUnDetour(Address) IS_UnDetour(pExtension,pISInterface,hMemoryService,(unsigned int)Address)
+
+#define EzModify(Address,NewData,Length,Reverse) Memory_Modify(pExtension,pISInterface,hMemoryService,(unsigned int)Address,NewData,Length,Reverse)
+#define EzUnModify(Address) Memory_UnModify(pExtension,pISInterface,hMemoryService,(unsigned int)Address)
+
+#define EzHttpRequest(_URL_,_pData_) IS_HttpRequest(pExtension,pISInterface,hHTTPService,_URL_,_pData_)
+
+extern LSType *pStringType;
+extern LSType *pIntType;
+extern LSType *pBoolType;
+extern LSType *pFloatType;
+extern LSType *pTimeType;
+extern LSType *pByteType;

MQ2Posse/ISXEQPosse.vcproj

+<?xml version="1.0" encoding = "Windows-1252"?>
+<VisualStudioProject
+	ProjectType="Visual C++"
+	Version="7.00"
+	Name="ISXEQPosse"
+	ProjectGUID="{A8B40FA9-7854-44E8-8440-46F3952DD86A}"
+	Keyword="Win32Proj">
+	<Platforms>
+		<Platform
+			Name="Win32"/>
+	</Platforms>
+	<Configurations>
+		<Configuration
+			Name="Release|Win32"
+			OutputDirectory="..\Release"
+			IntermediateDirectory=".\ISXEQPosseIntermediate"
+			ConfigurationType="2"
+			CharacterSet="2">
+			<Tool
+				Name="VCCLCompilerTool"
+				AdditionalOptions="/DCINTERFACE"
+				Optimization="2"
+				GlobalOptimizations="FALSE"
+				InlineFunctionExpansion="1"
+				FavorSizeOrSpeed="0"
+				OmitFramePointers="FALSE"
+				OptimizeForProcessor="0"
+				OptimizeForWindowsApplication="FALSE"
+				PreprocessorDefinitions="CINTERFACE;ISXEQ"
+				StringPooling="TRUE"
+				ExceptionHandling="TRUE"
+				BasicRuntimeChecks="0"
+				RuntimeLibrary="0"
+				StructMemberAlignment="1"
+				BufferSecurityCheck="FALSE"
+				EnableFunctionLevelLinking="FALSE"
+				DisableLanguageExtensions="FALSE"
+				DefaultCharIsUnsigned="FALSE"
+				UsePrecompiledHeader="0"
+				WarningLevel="3"
+				Detect64BitPortabilityProblems="FALSE"
+				DebugInformationFormat="3"
+				CallingConvention="0"
+				CompileAs="2"/>
+			<Tool
+				Name="VCCustomBuildTool"/>
+			<Tool
+				Name="VCLinkerTool"
+				AdditionalOptions="/OPT:NOICF"
+				AdditionalDependencies="wsock32.lib"
+				OutputFile="$(OutDir)/ISXEQPosse.dll"
+				LinkIncremental="1"
+				SuppressStartupBanner="FALSE"
+				AdditionalLibraryDirectories="..\Release"
+				GenerateDebugInformation="TRUE"
+				GenerateMapFile="TRUE"
+				MapExports="TRUE"
+				MapLines="TRUE"
+				SubSystem="2"
+				OptimizeReferences="1"
+				EnableCOMDATFolding="1"
+				BaseAddress="0x04000000"
+				ImportLibrary="$(OutDir)/ISXEQPosse.lib"
+				TargetMachine="1"/>
+			<Tool
+				Name="VCMIDLTool"/>
+			<Tool
+				Name="VCPostBuildEventTool"/>
+			<Tool
+				Name="VCPreBuildEventTool"/>
+			<Tool
+				Name="VCPreLinkEventTool"/>
+			<Tool
+				Name="VCResourceCompilerTool"/>
+			<Tool
+				Name="VCWebServiceProxyGeneratorTool"/>
+			<Tool
+				Name="VCWebDeploymentTool"/>
+		</Configuration>
+	</Configurations>
+	<Files>
+		<Filter
+			Name="Source Files"
+			Filter="cpp;c;cxx;def;odl;idl;hpj;bat;asm">
+			<File
+				RelativePath="ISXEQPosse.cpp">
+			</File>
+		</Filter>
+		<Filter
+			Name="Header Files"
+			Filter="h;hpp;hxx;hm;inl;inc">
+			<File
+				RelativePath="ISXEQPosse.h">
+			</File>
+		</Filter>
+		<Filter
+			Name="Resource Files"
+			Filter="rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe">
+		</Filter>
+	</Files>
+	<Globals>
+	</Globals>
+</VisualStudioProject>

MQ2Posse/MQ2Posse.dep

+# Microsoft Developer Studio Generated Dependency File, included by MQ2Posse.mak
+
+.\MQ2Posse.cpp : \
+	"..\detours\inc\detours.h"\
+	"..\MQ2Main\EQClasses.h"\
+	"..\MQ2Main\EQData.h"\
+	"..\MQ2Main\eqgame.h"\
+	"..\MQ2Main\EQUIStructs.h"\
+	"..\MQ2Main\MQ2Globals.h"\
+	"..\MQ2Main\MQ2Internal.h"\
+	"..\MQ2Main\MQ2Main.h"\
+	"..\MQ2Main\MQ2Prototypes.h"\
+	"..\mq2plugin.h"\
+