Preloaded Class Reference
[Engine Module]

#include <preloaded.h>

Inheritance diagram for Preloaded:

List of all members.

---

Detailed Description

Todo:

Maybe move this class to Framework.

Public Member Functions
	Preloaded (const char *id)
virtual	~Preloaded ()
bool	LoadHeader ()
virtual bool	Load ()
virtual bool	Unload ()
virtual void	SetActive (bool active)
bool	Save ()
void	SetFileName (const string &file_name)
const string &	GetFileName ()
bool	IsActive ()
bool	IsLoaded ()
Protected Member Functions
virtual void	ClearHeader ()
virtual void	ClearBody ()
virtual bool	LoadResources ()
virtual void	UnloadResources ()
virtual bool	Serialize (Serializer &serializer)
virtual bool	Deserialize (Serializer &serializer, bool first)
virtual bool	ReadHeader (Serializer &serializer)
virtual bool	ReadBody (Serializer &serializer)
virtual bool	WriteHeader (Serializer &serializer)
virtual bool	WriteBody (Serializer &serializer)
Protected Attributes
string	file_name
	Full file name of preloaded file.
bool	loaded
	Whether this object is loaded.
bool	load_header
	Whether only header will be loaded.
bool	active
	Whether this object is active.

---

Constructor & Destructor Documentation

Preloaded::Preloaded

(

const char *

id

)

Constructor.

Preloaded::~Preloaded

(

)

[virtual]

Destructor.

---

Member Function Documentation

bool Preloaded::LoadHeader

(

)

Load object header from file.

Returns:

True if successful.

bool Preloaded::Load

(

)

[virtual]

Load object from file.

Returns:

True if successful.

bool Preloaded::Unload

(

)

[virtual]

Unload scheme.

Returns:

True if successful.

void Preloaded::SetActive

(

bool

active

)

[virtual]

Sets active state.

Parameters:

active

Active state.

Reimplemented in Level, and Map.

bool Preloaded::Save

(

)

Saves preloaded to file.

Returns:

True if successful.

void Preloaded::SetFileName

(

const string &

file_name

)

[inline]

Sets path to the preloaded file.

Parameters:

file_name

Path to the resource file.

const string & Preloaded::GetFileName

(

)

[inline]

Gets path to the preloaded file.

Returns:

Path to the preloaded file.

bool Preloaded::IsActive

(

)

[inline]

Returns whether preloaded is active.

Returns:

Active state.

bool Preloaded::IsLoaded

(

)

[inline]

Returns whether preloaded is loaded.

Returns:

Load state.

void Preloaded::ClearHeader

(

)

[protected, virtual]

Reimplemented in Gui, Level, Map, Profile, Race, and Scheme.

void Preloaded::ClearBody

(

)

[protected, virtual]

Reimplemented in Gui, Level, Map, Profile, Race, and Scheme.

bool Preloaded::LoadResources

(

)

[protected, virtual]

Reimplemented in Gui, Level, Race, and Scheme.

void Preloaded::UnloadResources

(

)

[protected, virtual]

Reimplemented in Gui, Level, Race, and Scheme.

bool Preloaded::Serialize

(

Serializer &

serializer

)

[protected, virtual]

Recursively serialize all children.

Reimplemented from Root.

bool Preloaded::Deserialize	(	Serializer &	serializer,
		bool	first
	)			[protected, virtual]

Recursively deserialize all children.

Reimplemented from Root.

bool Preloaded::ReadHeader

(

Serializer &

serializer

)

[protected, virtual]

Reimplemented in Gui, Level, Map, Profile, Race, and Scheme.

bool Preloaded::ReadBody

(

Serializer &

serializer

)

[protected, virtual]

Reimplemented in Gui, Level, Map, Profile, Race, and Scheme.

bool Preloaded::WriteHeader

(

Serializer &

serializer

)

[protected, virtual]

Reimplemented in Gui, Level, Map, Profile, Race, and Scheme.

bool Preloaded::WriteBody

(

Serializer &

serializer

)

[protected, virtual]

Reimplemented in Gui, Level, Map, Profile, Race, and Scheme.

---

Member Data Documentation

string Preloaded::file_name [protected]

Full file name of preloaded file.

bool Preloaded::loaded [protected]

Whether this object is loaded.

bool Preloaded::load_header [protected]

Whether only header will be loaded.

bool Preloaded::active [protected]

Whether this object is active.

---

The documentation for this class was generated from the following files:

• D:/Projects/dark-oberon.svn/game/sources/engine/preloaded.h
• D:/Projects/dark-oberon.svn/game/sources/engine/preloaded.cpp

---