BaseGameFeature::LoaderServer Class Reference
#include <loaderserver.h>
Inheritance diagram for BaseGameFeature::LoaderServer:
Detailed Description
The BaseGameFeature::LoaderServer is the central object of the loader subsystem Usually you don't work directly with the Loader subsystem, but instead use higher level classes like the Game::SetupManager and Game::SaveGameManager.(C) 2003 RadonLabs GmbH
Public Member Functions | |
| LoaderServer () | |
| constructor | |
| virtual | ~LoaderServer () |
| destructor | |
| void | SetDebugTextEnabled (bool b) |
| enable/disable debug text messages during load | |
| bool | GetDebugTextEnabled () const |
| get debug text enabled flag | |
| virtual bool | Open () |
| open the loader subsystem | |
| virtual void | Close () |
| close the loader subsystem | |
| bool | IsOpen () const |
| return true if open | |
| virtual Ptr< UserProfile > | CreateUserProfile () const |
| create a new user profile object | |
| void | SetUserProfile (const Ptr< UserProfile > &p) |
| set the current user profile | |
| const Ptr< UserProfile > & | GetUserProfile () const |
| get the current user profile | |
| virtual bool | LoadLevel (const Util::String &levelName) |
| load a new level, this method is usually called by Game::SetupManager | |
| void | AttachEntityLoader (const Ptr< EntityLoaderBase > &loader) |
| attach loader | |
| void | RemoveEntityLoader (const Ptr< EntityLoaderBase > &loader) |
| remove loader | |
| void | RemoveAllLoaders () |
| remove all loaders | |
| void | LoadEntities (const Util::Array< Util::String > &activeLayers) |
| load entities from db with entityloader | |
| void | SetProgressResource (const Util::String &r) |
| set progress indicator gui resource | |
| const Util::String & | GetProgressResource () const |
| get progress indicator gui resource | |
| void | SetMaxProgressValue (int v) |
| set the max progress value | |
| int | GetMaxProgressValue () const |
| get the max progress value | |
| void | AdvanceProgress (int amount) |
| advance the progress indicator | |
| void | SetProgressText (const Util::String &s) |
| set optional progress text | |
| const Util::String & | GetProgressText () const |
| get optional progress text | |
| virtual void | UpdateProgressDisplay () |
| update the progress indicator display | |
| void | OpenProgressIndicator () |
| open the progress indicator | |
| void | CloseProgressIndicator () |
| close the progress indicator | |
| IO::URI | GetScreenshotFilepath (const Util::String &extension) |
| get filename for next screenshot | |
| int | GetRefCount () const |
| get the current refcount | |
| void | AddRef () |
| increment refcount by one | |
| void | Release () |
| decrement refcount and destroy object if refcount is zero | |
| bool | IsInstanceOf (const Rtti &rtti) const |
| return true if this object is instance of given class | |
| bool | IsInstanceOf (const Util::String &className) const |
| return true if this object is instance of given class by string | |
| bool | IsInstanceOf (const Util::FourCC &classFourCC) const |
| return true if this object is instance of given class by fourcc | |
| bool | IsA (const Rtti &rtti) const |
| return true if this object is instance of given class, or a derived class | |
| bool | IsA (const Util::String &rttiName) const |
| return true if this object is instance of given class, or a derived class, by string | |
| bool | IsA (const Util::FourCC &rttiFourCC) const |
| return true if this object is instance of given class, or a derived class, by fourcc | |
| const Util::String & | GetClassName () const |
| get the class name | |
| Util::FourCC | GetClassFourCC () const |
| get the class FourCC code | |
Static Public Member Functions | |
| static void | DumpRefCountingLeaks () |
| dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!) | |
Member Function Documentation
| bool BaseGameFeature::LoaderServer::Open | ( | ) | [virtual] |
open the loader subsystem
Open the loader subsystem.
- Parameters:
-
applicationName the app name fileFormatVersion string in the form "x.y" describing the file format version
- Returns:
- true if loader subsystem successfully opened
| void BaseGameFeature::LoaderServer::Close | ( | ) | [virtual] |
close the loader subsystem
Close the loader subsystem.
| Ptr< UserProfile > BaseGameFeature::LoaderServer::CreateUserProfile | ( | ) | const [virtual] |
create a new user profile object
Creates a new user profile object. Override in subclass to create your own user profile subclass instances.
| void BaseGameFeature::LoaderServer::SetUserProfile | ( | const Ptr< UserProfile > & | p | ) | [inline] |
set the current user profile
This sets the current user profile.
| const Ptr< UserProfile > & BaseGameFeature::LoaderServer::GetUserProfile | ( | ) | const [inline] |
get the current user profile
Returns the current user profile
| bool BaseGameFeature::LoaderServer::LoadLevel | ( | const Util::String & | levelName | ) | [virtual] |
load a new level, this method is usually called by Game::SetupManager
Load a new game level from the world database.
- Parameters:
-
filename a level name (this is not a filename!)
- Returns:
- success
| void BaseGameFeature::LoaderServer::AttachEntityLoader | ( | const Ptr< EntityLoaderBase > & | loader | ) |
| void BaseGameFeature::LoaderServer::RemoveEntityLoader | ( | const Ptr< EntityLoaderBase > & | loader | ) |
| void BaseGameFeature::LoaderServer::RemoveAllLoaders | ( | ) |
remove all loaders
Remove all loaders.
| void BaseGameFeature::LoaderServer::LoadEntities | ( | const Util::Array< Util::String > & | activeLayers | ) |
load entities from db with entityloader
Go thru all entity loader and call its Load function.
| int Core::RefCounted::GetRefCount | ( | ) | const [inline, inherited] |
get the current refcount
Return the current refcount of the object.
| void Core::RefCounted::AddRef | ( | ) | [inline, inherited] |
increment refcount by one
Increment the refcount of the object.
| void Core::RefCounted::Release | ( | ) | [inline, inherited] |
decrement refcount and destroy object if refcount is zero
Decrement the refcount and destroy object if refcount is zero.
| const Util::String & Core::RefCounted::GetClassName | ( | ) | const [inline, inherited] |
get the class name
Get the class name of the object.
| Util::FourCC Core::RefCounted::GetClassFourCC | ( | ) | const [inline, inherited] |
get the class FourCC code
Get the class FourCC of the object.
| void Core::RefCounted::DumpRefCountingLeaks | ( | ) | [static, inherited] |
dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)
This method should be called as the very last before an application exits.