New Include/Base Structure

Instead of including <modules.h>, you should now include <amxxmodule.h> and add the M/SDK to your project (get the MDK from CVS or the packaged source code).

Then you should make the necessary moduleconfig.h configuration changes listed in the module writing guide to enable Metamod hooks, Native hooks, and your module’s “personal” information struct.

You should remove any .def files, and also remove any Metamod or AMX Mod hooks, such as Meta_Attach() or Amx_Attach(). Instead, uncomment the appropriate hooks in moduleconfig.h - such as OnAmxxAttach for natives and OnPluginsLoaded for forwards. For Metamod, remove all of the engine hook sets and uncomment the appropriate hooks in moduleconfig.h. For example, if your old AMX Mod module had this:

1
2
3
4
5
6
7
8
9
10
C_DLLEXPORT int AMX_Attach(pfnamx_engine_g* amxeng,pfnmodule_engine_g* meng) {
   g_engAmxFunc = amxeng;
   g_engModuleFunc = meng;
	
   if(!gpMetaGlobals) REPORT_ERROR(1, "[AMX] fun is not attached to metamod (module \"%s\")\n", LOGTAG);
	
   ADD_AMXNATIVES(&module_info, fun_Exports);
	
   return(1);
}

This would simply become:

1
2
3
4
void OnAmxxAttach()
{
    MF_AddNatives(fun_Exports);
}

Likewise:

1
2
3
4
5
6
enginefuncs_t meta_engfuncs;
C_DLLEXPORT int GetEngineFunctions(enginefuncs_t *pengfuncsFromEngine, int interfaceVersion ) {
   meta_engfuncs.pfnTraceLine = TraceLine;
   memcpy(pengfuncsFromEngine, &meta_engfuncs, sizeof(enginefuncs_t));
   return(TRUE);
}

Is simply deleted, and #define FM_TraceLine is uncommented from moduleconfig.h.

Easy, huh? Other things, like global/external pointers used for MM/AMX should be removed. These are handled by the M/SDK.

New API

You should familiarize yourself with the new module functions available.

Here are some quick changes. The parameter count is listed as well. A * indicates the parameters changed.

  • ADD_AMXNATIVES(2) -> MF_AddNatives(1*)
  • AMX_RAISEERROR(2) -> MF_RaiseAmxError(2) or MF_LogError(…*)
  • GET_AMXADDR(2) -> MF_GetAmxAddr(2)
  • SET_AMXSTRING(4) -> MF_SetAmxString(4)
  • GET_AMXSTRING(4) -> MF_GetAmxString(4*)

New Forward/Callback System

AMX Mod modules are responsible for handling forwards their own way - in AMX Mod X the core does it for you.

Take this example from VexD, the way to manage a forward was:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
struct AmxCall {
   plugin_t *pPlugin;
   int iFunctionIdx;
};

std::vector<AmxCall> vTouchCallList;

//Registering the forward:
   if (AMX_FINDPUBLIC(&pCurrent->amx, "vexd_pfntouch", &iFunctionIndex) == AMX_ERR_NONE) {
      AmxCall sNewCall;
      sNewCall.pPlugin = pCurrent;
      sNewCall.iFunctionIdx = iFunctionIndex;
      vTouchCallList.push_back(sNewCall);
   //...		}

//Calling the forward:
   for(std::vector<AmxCall>::iterator i = vTouchCallList.begin(); i != vTouchCallList.end(); i++) {
      cell iRetVal = 0;
      AMX_EXEC(&i->pPlugin->amx, &iRetVal, i->iFunctionIdx, 2, ENTINDEX(pToucher), ENTINDEX(pTouched));
   }

Rather than using the new API functions (MF_AmxFindPublic, MF_AmxExec), let’s try using the new Forward system.

1
2
3
4
5
6
7
int TouchForward = -1;

//Registering the forward:
   TouchForward = MF_RegisterForward("vexd_pfntouch", ET_IGNORE, FP_CELL, FP_CELL, FP_DONE);

//Calling the forward:
   MF_ExecuteForward(TouchForward, ENTINDEX(pToucher), ENTINDEX(pTouched));

Simple, clean, efficient. Have fun!

总结

简单的说，这篇文章就是介绍了老版本的amx和新版本的amxx在编写module时，代码风格和编写方式的不同，新版本的amxx可以说是更加简洁、更加方便了。

参考文献

AMX Mod X Documentation