Files
itgmania212121/src/CharacterManager.h
T
Jason Felds ef31eca4c1 doxygen and better fail message.
Hmm..why does GetCharacters not return
the DefaultCharacter? Is this function perhaps misnamed?
2011-07-05 22:57:01 -04:00

65 lines
2.2 KiB
C++

#ifndef CHARACTER_MANAGER_H
#define CHARACTER_MANAGER_H
class Character;
struct lua_State;
/** @brief Manage all of the Characters. */
class CharacterManager
{
public:
/** @brief Set up the character manager. */
CharacterManager();
/** @brief Destroy the character manager. */
~CharacterManager();
void GetCharacters( vector<Character*> &vpCharactersOut );
/** @brief Get one installed character at random.
* @return The random character. */
Character* GetRandomCharacter();
/** @brief Get the character assigned as the default.
* @return The default character. */
Character* GetDefaultCharacter();
Character* GetCharacterFromID( RString sCharacterID );
void DemandGraphics();
void UndemandGraphics();
// Lua
void PushSelf( lua_State *L );
private:
vector<Character*> m_pCharacters;
};
extern CharacterManager* CHARMAN; // global and accessable from anywhere in our program
#endif
/*
* (c) 2001-2004 Chris Danford
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, and/or sell copies of the Software, and to permit persons to
* whom the Software is furnished to do so, provided that the above
* copyright notice(s) and this permission notice appear in all copies of
* the Software and that both the above copyright notice(s) and this
* permission notice appear in supporting documentation.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/