added some more doc
authorDavid Anderson <dvander@alliedmods.net>
Thu Jan 31 02:37:34 2008 +0000 (2008-01-31)
changeset 186949274af1f67c
parent 1868 33f4a6629b49
child 1870 d87b57801d4a
added some more doc
plugins/include/sourcemod.inc
     1.1 --- a/plugins/include/sourcemod.inc	Wed Jan 30 20:51:07 2008 +0000
     1.2 +++ b/plugins/include/sourcemod.inc	Thu Jan 31 02:37:34 2008 +0000
     1.3 @@ -85,9 +85,12 @@
     1.4  public Plugin:myinfo;
     1.5   
     1.6  /**
     1.7 - * Called when the plugin is fully initialized and all known external references are resolved.
     1.8 - * This is called even if the plugin type is "private."
     1.9 - * @note Errors in this function will cause the plugin to stop running.
    1.10 + * Called when the plugin is fully initialized and all known external references 
    1.11 + * are resolved. This is only called once in the lifetime of the plugin, and is 
    1.12 + * paired with OnPluginEnd().
    1.13 + *
    1.14 + * If any run-time error is thrown during this callback, the plugin will be marked 
    1.15 + * as failed.
    1.16   *
    1.17   * @noreturn
    1.18   */
    1.19 @@ -101,6 +104,9 @@
    1.20   * 
    1.21   * @note It is not safe to call externally resolved natives until OnPluginStart().
    1.22   * @note Any sort of RTE in this function will cause the plugin to fail loading.
    1.23 + * @note You MUST remember to return SOMETHING here.  The act of not returning is 
    1.24 + *       equivalent to returning 0 (false).  If you forgot to return, it will 
    1.25 + *       cause your plugin to not load with a very strange error message.
    1.26   *
    1.27   * @param myself	Handle to the plugin.
    1.28   * @param late		Whether or not the plugin was loaded "late" (after map load).