whiteshark's new plugin mode check-in

git-svn-id: svn://svn.code.sf.net/p/ultrastardx/svn/branches/experimental@1644 b956fd51-792f-4845-bead-9b4dfca2ff2c

3 files changed, 53 insertions, 0 deletions

diff --git a/ServiceBasedPlugins/plugins/SDK/Hooks.txt b/ServiceBasedPlugins/plugins/SDK/Hooks.txt
new file mode 100644
index 00000000..999f552f
--- /dev/null
+++ b/ServiceBasedPlugins/plugins/SDK/Hooks.txt
@@ -0,0 +1,20 @@
+Ultrastar Deluxe Hook List
+-----------------------------------
+Here you can find the Events the Core offers to you:
+
+--------------------
+Core:
+--------------------
+Core/LoadingFinished <- Hook is called after all Modules and Plugins are loaded completely, before MainLoop
+Core/MainLoop        <- Hook is called once in MainLoop before Drawing
+Core/Translate       <- Hook is called when Strings should be translated. If this is Retranslating lParam is Non Zero
+Core/LoadTextures    <- Hook is called when Textures should be Loaded. This will be called in Ogl Thread. If Textures are Reloaded (e.g. on Display ReInit) LParam is non Zero.
+Core/ExitQuery       <- Hook is called if someone querys an exit. (e.g. X is pressed). Not called on ForcedExit. If Chain is breaked the exit will be aborted.
+Core/Exit            <- Hook is called before Module a. Plugin unload.
+Core/NewDebugInfo    <- Hook is called everytime there is Debug Info to Output(only if Debug Mode is enabled). wParam: Pchar(Message), lParam: PChar(Reportername)
+Core/NewError        <- Hook is called everytime an error is reported. wParam: Pchar(Message), lParam: PChar(Reportername)
+
+--------------------
+Display
+--------------------
+Display/onScreenChange <-Hook is called when there is an attemp to change Screen. wParam is address to Screens Name(Null Terminated). If Chain is breaked Screenchange will be aborted.
\ No newline at end of file
diff --git a/ServiceBasedPlugins/plugins/SDK/Plugin DLL Exports.txt b/ServiceBasedPlugins/plugins/SDK/Plugin DLL Exports.txt
new file mode 100644
index 00000000..930e18ac
--- /dev/null
+++ b/ServiceBasedPlugins/plugins/SDK/Plugin DLL Exports.txt
@@ -0,0 +1,11 @@
+Ultrastar Plugin DLL(Libary) Exports
+-----------------------------------
+This are the Procedurs and Functions that a UsDx Plugin has to export to get Loaded.
+
+
+USPlugin_Info(PInfo: PUS_PluginInfo); stdcall;
+-----------------------------------
+Ultrastar uses this Procedure to identify the Plugins.
+At the given Address there is a PUS_PluginInfo Record. cbSize
+attribut is already set. Please asure not to overwrite this assigned
+memory amount.
diff --git a/ServiceBasedPlugins/plugins/SDK/Services.txt b/ServiceBasedPlugins/plugins/SDK/Services.txt
new file mode 100644
index 00000000..8db031d8
--- /dev/null
+++ b/ServiceBasedPlugins/plugins/SDK/Services.txt
@@ -0,0 +1,22 @@
+Ultrastar Deluxe Service List
+-----------------------------------
+Here you can find the Services the Core offers to you:
+
+--------------------
+Core:
+--------------------
+Core/ReportError    <- Calls the 'Core/NewError' Chain. wParam: Pchar(Message), lParam: PChar(Reportername)
+Core/ReportDebug    <- Calls the 'Core/NewDebugInfo' Chain. wParam: Pchar(Message), lParam: PChar(Reportername)
+Core/ShowMessage    <- Shows a Message Dialog. (lParam: PChar Text, wParam: Symbol)
+Core/Retranslate    <- Calls Translate Hook
+Core/ReloadTextures <- Calls LoadTextures Hook
+Core/GetModuleInfo  <- If lParam = nil then get length of Moduleinfo Array. If lparam <> nil then write array of TModuleInfo to address at lparam
+Core/GetApplicationHandle <- Returns Main-Applications Handle (Win32 Only)
+
+--------------------
+PluginLoader
+--------------------
+PluginLoader/GetPluginInfo  <- If wParam = -1 then (If lParam = nil then get length of Moduleinfo Array. If lparam <> nil then write array of TUS_PluginInfo to address at lparam) Else (Get PluginInfo of Plugin with Index(wParam) to Address at lParam)
+PluginLoader/GetPluginState <- If wParam = -1 then (If lParam = nil then get length of Moduleinfo Array. If lparam <> nil then write array of TUS_PluginInfo to address at lparam) Else (Return PluginInfo of Plugin with Index(wParam))
+PluginLoader/LoadPlugin     <- wParam PChar(PluginName/PluginPath) | lParam (if wParam = nil) ID of the Plugin
+PluginLoader/UnloadPlugin   <- wParam PChar(PluginName/PluginPath) | lParam (if wParam = nil) ID of the Plugin
\ No newline at end of file