extensions/topmenus/extension.h
author Scott Ehlert <ds@alliedmods.net>
Thu Mar 27 04:54:56 2008 +0000 (2008-03-27)
changeset 1947 e73a1e51833b
parent 1491 fb537eedb76a
child 2289 44045ead61cd
permissions -rw-r--r--
Updated copyright year
dvander@1488
     1
/**
dvander@1488
     2
 * vim: set ts=4 :
dvander@1488
     3
 * =============================================================================
dvander@1488
     4
 * SourceMod Sample Extension
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
dvander@1488
     6
 * =============================================================================
dvander@1488
     7
 *
dvander@1488
     8
 * This program is free software; you can redistribute it and/or modify it under
dvander@1488
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
dvander@1488
    10
 * Free Software Foundation.
dvander@1488
    11
 * 
dvander@1488
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@1488
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@1488
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@1488
    15
 * details.
dvander@1488
    16
 *
dvander@1488
    17
 * You should have received a copy of the GNU General Public License along with
dvander@1488
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1488
    19
 *
dvander@1488
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
dvander@1488
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@1488
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@1488
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@1488
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@1488
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
dvander@1488
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@1488
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@1488
    28
 *
dvander@1491
    29
 * Version: $Id$
dvander@1488
    30
 */
dvander@1488
    31
dvander@1488
    32
#ifndef _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@1488
    33
#define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@1488
    34
dvander@1488
    35
/**
dvander@1488
    36
 * @file extension.h
dvander@1488
    37
 * @brief Sample extension code header.
dvander@1488
    38
 */
dvander@1488
    39
dvander@1488
    40
#include "smsdk_ext.h"
dvander@1488
    41
dvander@1488
    42
dvander@1488
    43
/**
dvander@1488
    44
 * @brief Sample implementation of the SDK Extension.
dvander@1488
    45
 * Note: Uncomment one of the pre-defined virtual functions in order to use it.
dvander@1488
    46
 */
dvander@1488
    47
class TopMenuExtension : public SDKExtension
dvander@1488
    48
{
dvander@1488
    49
public:
dvander@1488
    50
	/**
dvander@1488
    51
	 * @brief This is called after the initial loading sequence has been processed.
dvander@1488
    52
	 *
dvander@1488
    53
	 * @param error		Error message buffer.
dvander@1488
    54
	 * @param maxlength	Size of error message buffer.
dvander@1488
    55
	 * @param late		Whether or not the module was loaded after map load.
dvander@1488
    56
	 * @return			True to succeed loading, false to fail.
dvander@1488
    57
	 */
dvander@1488
    58
	virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
dvander@1488
    59
	
dvander@1488
    60
	/**
dvander@1488
    61
	 * @brief This is called right before the extension is unloaded.
dvander@1488
    62
	 */
dvander@1488
    63
	virtual void SDK_OnUnload();
dvander@1488
    64
};
dvander@1488
    65
dvander@1488
    66
#endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_