public/sample_ext/extension.h
author David Anderson <dvander@alliedmods.net>
Fri Feb 16 03:47:10 2007 +0000 (2007-02-16)
changeset 501 e209a7296936
parent 375 a31ff1b6ae46
child 676 1ed65fdc194a
permissions -rw-r--r--
removed this potential feature, not useful enough
dvander@375
     1
// vim: set ts=4 :
dvander@324
     2
#ifndef _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@324
     3
#define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@324
     4
dvander@372
     5
/**
dvander@372
     6
 * @file extension.h
dvander@372
     7
 * @brief Sample extension code header.
dvander@372
     8
 */
dvander@372
     9
dvander@372
    10
dvander@324
    11
#include "smsdk_ext.h"
dvander@324
    12
dvander@372
    13
dvander@324
    14
/**
dvander@324
    15
 * @brief Sample implementation of the SDK Extension.
dvander@324
    16
 * Note: Uncomment one of the pre-defined virtual functions in order to use it.
dvander@324
    17
 */
dvander@324
    18
class Sample : public SDKExtension
dvander@324
    19
{
dvander@324
    20
public:
dvander@324
    21
	/**
dvander@324
    22
	 * @brief This is called after the initial loading sequence has been processed.
dvander@324
    23
	 *
dvander@324
    24
	 * @param error		Error message buffer.
dvander@324
    25
	 * @param err_max	Size of error message buffer.
dvander@324
    26
	 * @param late		Whether or not the module was loaded after map load.
dvander@324
    27
	 * @return			True to succeed loading, false to fail.
dvander@324
    28
	 */
dvander@324
    29
	//virtual bool SDK_OnLoad(char *error, size_t err_max, bool late);
dvander@324
    30
	
dvander@324
    31
	/**
dvander@324
    32
	 * @brief This is called right before the extension is unloaded.
dvander@324
    33
	 */
dvander@324
    34
	//virtual void SDK_OnUnload();
dvander@324
    35
dvander@324
    36
	/**
dvander@324
    37
	 * @brief This is called once all known extensions have been loaded.
dvander@324
    38
	 * Note: It is is a good idea to add natives here, if any are provided.
dvander@324
    39
	 */
dvander@324
    40
	//virtual void SDK_OnAllLoaded();
dvander@324
    41
dvander@324
    42
	/**
dvander@324
    43
	 * @brief Called when the pause state is changed.
dvander@324
    44
	 */
dvander@324
    45
	//virtual void SDK_OnPauseChange(bool paused);
dvander@324
    46
dvander@324
    47
	/**
dvander@324
    48
	 * @brief this is called when Core wants to know if your extension is working.
dvander@324
    49
	 *
dvander@324
    50
	 * @param error		Error message buffer.
dvander@324
    51
	 * @param err_max	Size of error message buffer.
dvander@324
    52
	 * @return			True if working, false otherwise.
dvander@324
    53
	 */
dvander@324
    54
	//virtual void QueryRunning(char *error, size_t maxlength);
dvander@324
    55
public:
dvander@324
    56
#if defined SMEXT_CONF_METAMOD
dvander@324
    57
	/**
dvander@324
    58
	 * Read smext_base.h for documentation on these.
dvander@324
    59
	 */
dvander@324
    60
dvander@324
    61
	//virtual bool SDK_OnMetamodLoad(char *error, size_t err_max, bool late);
dvander@324
    62
	//virtual bool SDK_OnMetamodUnload(char *error, size_t err_max);
dvander@324
    63
	//virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t err_max);
dvander@324
    64
#endif
dvander@324
    65
};
dvander@324
    66
dvander@324
    67
#endif //_INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_