79 lines
2.8 KiB
Plaintext
79 lines
2.8 KiB
Plaintext
|
/// ----------------------------------------------------------------------------
|
||
|
|
/// @file util_i_library.nss
|
||
|
|
/// @author Michael A. Sinclair (Squatting Monk) <squattingmonk@gmail.com>
|
||
|
|
/// @brief Boilerplace code for creating a library dispatcher. Should only be
|
||
|
|
/// included in library scripts as it implements main().
|
||
|
|
/// ----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
#include "util_i_libraries"
|
||
|
|
|
||
|
|
// -----------------------------------------------------------------------------
|
||
|
|
// Function Protoypes
|
||
|
|
// -----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
// This is a user-defined function that registers function names to a unique (to
|
||
|
|
// this library) number. When the function name is run using RunLibraryScript(),
|
||
|
|
// this number will be passed to the user-defined function OnLibraryScript(),
|
||
|
|
// which resolves the call to the correct function.
|
||
|
|
//
|
||
|
|
// Example usage:
|
||
|
|
// void OnLibraryLoad()
|
||
|
|
// {
|
||
|
|
// RegisterLibraryScript("MyFunction");
|
||
|
|
// RegisterLibraryScript("MyOtherFunction");
|
||
|
|
// }
|
||
|
|
//
|
||
|
|
// or, if using nEntry...
|
||
|
|
// void OnLibraryLoad()
|
||
|
|
// {
|
||
|
|
// RegisterLibraryScript("MyFunction", 1);
|
||
|
|
// RegisterLibraryScript("MyOtherFunction", 2);
|
||
|
|
// }
|
||
|
|
void OnLibraryLoad();
|
||
|
|
|
||
|
|
// This is a user-defined function that routes a unique (to the module) script
|
||
|
|
// name (sScript) or a unique (to this library) number (nEntry) to a function.
|
||
|
|
//
|
||
|
|
// Example usage:
|
||
|
|
// void OnLibraryScript(string sScript, int nEntry)
|
||
|
|
// {
|
||
|
|
// if (sScript == "MyFunction") MyFunction();
|
||
|
|
// else if (sScript == "MyOtherFunction") MyOtherFunction();
|
||
|
|
// }
|
||
|
|
//
|
||
|
|
// or, using nEntry...
|
||
|
|
// void OnLibraryScript(string sScript, int nEntry)
|
||
|
|
// {
|
||
|
|
// switch (nEntry)
|
||
|
|
// {
|
||
|
|
// case 1: MyFunction(); break;
|
||
|
|
// case 2: MyOtherFunction(); break;
|
||
|
|
// }
|
||
|
|
// }
|
||
|
|
//
|
||
|
|
// For advanced usage, see the libraries included in the Core Framework.
|
||
|
|
void OnLibraryScript(string sScript, int nEntry);
|
||
|
|
|
||
|
|
// -----------------------------------------------------------------------------
|
||
|
|
// Function Implementations
|
||
|
|
// -----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
// These are dummy implementations to prevent nwnsc from complaining that they
|
||
|
|
// do not exist. If you want to compile in the toolset rather than using nwnsc,
|
||
|
|
// comment these lines out.
|
||
|
|
// #pragma default_function(OnLibraryLoad)
|
||
|
|
// #pragma default_function(OnLibraryScript)
|
||
|
|
|
||
|
|
// -----------------------------------------------------------------------------
|
||
|
|
// Main Routine
|
||
|
|
// -----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
void main()
|
||
|
|
{
|
||
|
|
if (GetScriptParam(LIB_ENTRY) == "")
|
||
|
|
OnLibraryLoad();
|
||
|
|
else
|
||
|
|
OnLibraryScript(GetScriptParam(LIB_SCRIPT),
|
||
|
|
StringToInt(GetScriptParam(LIB_ENTRY)));
|
||
|
|
}
|