Skip to content

Commit

Permalink
Updated exampleplugin/doc/readme.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
danij committed Feb 28, 2009
1 parent f6c6970 commit 4118d65
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions doomsday/plugins/exampleplugin/doc/readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Doomsday Plugin Example
=======================
by Daniel Swanson <danij@dengine.net>
22/10/2007
28/02/2009


WHAT IS THIS?
Expand All @@ -17,7 +17,7 @@ the possibility of providing extended functionality not present in the
engine itself and/or access to the engine's public API for other means.

Various plugins are developed alongside the Doomsday Engine itself (such
as dpMapLoad and dpDehRead) and are distributed with it.
as dpWadMapConverter and dpDehRead) and are distributed with it.

The Doomsday API and it's plugin system are public interfaces, making it
possible to either completely replace existing plugins (for example, a
Expand All @@ -36,7 +36,7 @@ The Doomsday engine will automatically load all plugins from the plugin
directory, provided their names are prefixed 'dp' e.g:

Under WindowsXP:
c:\Program Files:\Doomsday\bin\dpExample.dll
c:\Program Files\Doomsday\bin\dpExample.dll

During the load process, a plugin must register into the engine the
hooks by which it should be called. This is done via the Doomsday public
Expand All @@ -45,12 +45,10 @@ API function:
Plug_AddHook(hookType, hookFunc)

@hookType (int)
The type of hook being attached to. The available hooks are as follows:

HOOK_STARTUP - Called ASAP after startup.
HOOK_INIT - Called after engine has been initialized.
HOOK_DEFS - Called after DEDs have been loaded.
HOOK_LOAD_MAP_LUMPS - Called when loading map data lumps.
The type of hook being attached to. Doomsday presents various hooks,
defined in

./engine/api/dd_plugin.h

@hookFunc - (int(function)(int type, int param, void *data))
A pointer to the function to be called when the hook is processed.

0 comments on commit 4118d65

Please sign in to comment.