Writing Modules In C - Revision history

Cheese: link to advanced

2010-03-05T06:56:03Z

link to advanced

← Older revision		Revision as of 06:56, 5 March 2010
Line 651:		Line 651:
	</pre>		</pre>

			When you are ready for something more advanced, read [[Writing Advanced Modules In C]]
	[[Category:Module]]		[[Category:Module]]
	[[Category:Guides]]		[[Category:Guides]]

Initrd.gz: /* Listening For Callbacks */ Added Callbacks link to C tutorial

2008-11-13T23:36:56Z

Listening For Callbacks: Added Callbacks link to C tutorial

← Older revision		Revision as of 23:36, 13 November 2008
Line 155:		Line 155:

	If we compile our code now and run it on the server, we should be messaged whenever we change ships.		If we compile our code now and run it on the server, we should be messaged whenever we change ships.

			For a list of callbacks and arguments they take, check out the [[Callbacks]] page.

	== Declaring Arena / Player Data ==		== Declaring Arena / Player Data ==

Pourya: /* Template Module */

2007-11-10T10:15:09Z

Template Module

← Older revision		Revision as of 10:15, 10 November 2007
Line 31:		Line 31:
	</pre>		</pre>

	This modules loading function is called MM_template, and it is to be saved in the text file template.c. This will make our module name be template when we are interested in loading it into a server. This is a good place to make sure that your module compiles, and that it loads into a server. You will need to compile it as a shared library (.so or .dll). Windows users may find they have to include zlib.lib, pthread.lib and util.c into the compilation. Place the resulting file into the bin/ directory and from within the ~~server~~ type ?insmod template~~, the~~ server will reply with confirmation text ~~and you~~ can double check with the command ?lsmod.		This modules loading function is called MM_template, and it is to be saved in the text file template.c. This will make our module name be template when we are interested in loading it into a server. This is a good place to make sure that your module compiles, and that it loads into a server. You will need to compile it as a shared library (.so or .dll). Windows users may find they have to include zlib.lib, pthread.lib and util.c into the compilation. Place the resulting file into the bin/ directory and load the module.

			To load the module from from within the game, type the command in this format: ?insmod <so or dll name without the extension removed>:<modulename>

			Assuming your dll is called Template.dll, you would type:

			?insmod Template:template

			The server will reply with confirmation text: "Module Template:template loaded successfully". You can double check with the command ?lsmod. If you see "template" in the list of loaded modules, the module is loaded.

	== Using Interfaces ==		== Using Interfaces ==

BaK: /* Template Module */ removed attach

2007-04-13T23:46:36Z

Template Module: removed attach

← Older revision		Revision as of 23:46, 13 April 2007
Line 24:		Line 24:
	else if (action == MM_UNLOAD)		else if (action == MM_UNLOAD)
	{		{
	~~rv = MM_OK;~~
	}
	~~else if (action == MM_ATTACH)~~
	{
	~~rv = MM_OK;~~
	}
	~~else if (action == MM_DETACH)~~
	{
	rv = MM_OK;		rv = MM_OK;
	}		}

BaK: /* Adding Timers */ removed attach

2007-04-13T23:46:19Z

Adding Timers: removed attach

← Older revision		Revision as of 23:46, 13 April 2007
Line 431:		Line 431:
	mm->ReleaseInterface(aman);		mm->ReleaseInterface(aman);
	mm->ReleaseInterface(chat);		mm->ReleaseInterface(chat);
	~~rv = MM_OK;~~
	}
	~~else if (action == MM_ATTACH)~~
	{
	~~rv = MM_OK;~~
	}
	~~else if (action == MM_DETACH)~~
	{
	rv = MM_OK;		rv = MM_OK;
	}		}

BaK: /* Adding Commands */ fixed error checking / removed attach

2007-04-13T23:45:48Z

Adding Commands: fixed error checking / removed attach

@@ Line 538: / Line 538: @@
 		if (!chat || !aman || !pd || !ml || !cmd) // check interfaces
 			rv = MM_FAIL;
 		else
+		{
@@ Line 545: / Line 554: @@
 			playerKey = pd->AllocatePlayerData(sizeof(MyPlayerData));
-			if (!arenaKey || !playerKey) // check if we ran out of memory
+			if (arenaKey == -1 || playerKey == -1) // check if we ran out of memory
+			{
 				rv = MM_FAIL;
+			}
@@ Line 585: / Line 607: @@
 		mm->ReleaseInterface(aman);
 		mm->ReleaseInterface(chat);
 		rv = MM_OK;
+	}

BaK: /* Adding Timers */ error checking + fix per play/arena data error checking

2007-04-13T23:42:34Z

Adding Timers: error checking + fix per play/arena data error checking

@@ Line 369: / Line 369: @@
 		if (!chat || !aman || !pd || !ml) // check interfaces
 			rv = MM_FAIL;
 		else
+		{
@@ Line 376: / Line 384: @@
 			playerKey = pd->AllocatePlayerData(sizeof(MyPlayerData));
-			if (!arenaKey || !playerKey) // check if we ran out of memory
+			if (arenaKey == -1 || playerKey == -1) // check if we ran out of memory
+			{
 				rv = MM_FAIL;
+			}

BaK: /* Declaring Arena / Player Data */ removed attach / error checkin and fixed out of memory problem

2007-04-13T23:41:11Z

Declaring Arena / Player Data: removed attach / error checkin and fixed out of memory problem

@@ Line 227: / Line 227: @@
 		if (!chat || !aman || !pd) // check interfaces
 			rv = MM_FAIL;
 		else
+		{
@@ Line 234: / Line 240: @@
 			playerKey = pd->AllocatePlayerData(sizeof(MyPlayerData));
-			if (!arenaKey || !playerKey) // check if we ran out of memory
+			if (arenaKey == -1 || playerKey == -1) // check if we ran out of memory
+			{
 				rv = MM_FAIL;
+			}
@@ Line 258: / Line 275: @@
 		mm->ReleaseInterface(aman);
 		mm->ReleaseInterface(chat);
 		rv = MM_OK;
+	}

BaK: /* Listening For Callbacks */ removed attach

2007-04-13T23:36:57Z

Listening For Callbacks: removed attach

← Older revision		Revision as of 23:36, 13 April 2007
Line 132:		Line 132:
	mm->UnregCallback(CB_SHIPCHANGE, ShipChange, ALLARENAS);		mm->UnregCallback(CB_SHIPCHANGE, ShipChange, ALLARENAS);
	mm->ReleaseInterface(chat);		mm->ReleaseInterface(chat);
	~~rv = MM_OK;~~
	}
	~~else if (action == MM_ATTACH)~~
	{
	~~rv = MM_OK;~~
	}
	~~else if (action == MM_DETACH)~~
	{
	rv = MM_OK;		rv = MM_OK;
	}		}

BaK: /* Using Interfaces */ removed attach code

2007-04-13T23:36:23Z

Using Interfaces: removed attach code

← Older revision		Revision as of 23:36, 13 April 2007
Line 74:		Line 74:
	{		{
	mm->ReleaseInterface(chat);		mm->ReleaseInterface(chat);
	~~rv = MM_OK;~~
	}
	~~else if (action == MM_ATTACH)~~
	{
	~~rv = MM_OK;~~
	}
	~~else if (action == MM_DETACH)~~
	{
	rv = MM_OK;		rv = MM_OK;
	}		}