moduleCallbacks.h

Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2013 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _MODULE_CALLBACKS_H_
25#define _MODULE_CALLBACKS_H_
26
27#ifndef _MODULE_DEFINITION_H
28#include "moduleDefinition.h"
29#endif
30
31//-----------------------------------------------------------------------------
32
33/// @ingroup moduleGroup
34/// @see moduleGroup
35class ModuleCallbacks
36{
37    friend class ModuleManager;
38
39private:
40    // Called when a module is about to be loaded.
41    virtual void onModulePreLoad( ModuleDefinition* pModuleDefinition ) {}
42
43    // Called when a module has been loaded.
44    virtual void onModulePostLoad( ModuleDefinition* pModuleDefinition ) {}
45
46    // Called when a module is about to be unloaded.
47    virtual void onModulePreUnload( ModuleDefinition* pModuleDefinition ) {}
48
49    // Called when a module has been unloaded.
50    virtual void onModulePostUnload( ModuleDefinition* pModuleDefinition ) {}
51};
52
53#endif // _MODULE_CALLBACKS_H_
54