UNLOZE/sourcemod
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

added some more doc

Browse Source 
--HG--
extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%401875
This commit is contained in:
David Anderson 2008-01-31 02:37:34 +00:00
parent 512ec74819
commit 9e9f74aab0
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
plugins/include/sourcemod.inc
View File

@ -85,9 +85,12 @@ struct Plugin
public Plugin:myinfo;
/**
* Called when the plugin is fully initialized and all known external references are resolved.
* This is called even if the plugin type is "private."
* @note Errors in this function will cause the plugin to stop running.
* Called when the plugin is fully initialized and all known external references
* are resolved. This is only called once in the lifetime of the plugin, and is
* paired with OnPluginEnd().
*
* If any run-time error is thrown during this callback, the plugin will be marked
* as failed.
*
* @noreturn
*/
@ -101,6 +104,9 @@ forward OnPluginStart();
*
* @note It is not safe to call externally resolved natives until OnPluginStart().
* @note Any sort of RTE in this function will cause the plugin to fail loading.
* @note You MUST remember to return SOMETHING here. The act of not returning is
* equivalent to returning 0 (false). If you forgot to return, it will
* cause your plugin to not load with a very strange error message.
*
* @param myself Handle to the plugin.
* @param late Whether or not the plugin was loaded "late" (after map load).