Torque Game Engine Documentation
TGE Version 1.5.2

ResourceObject Class Reference

#include <resManager.h>

Detailed Description

This contains all the book-keeping data used by ResDictionary and ResManager.

Public Types

enum Flags {
  VolumeBlock = BIT(0),
  File = BIT(1),
  Added = BIT(2)
}

Public Member Functions

ResourceObject ()

~ResourceObject ()

void destruct ()

void getFileTimes (FileTime *createTime, FileTime *modifyTime)

Get some information about file times.

List Management

ResourceObject * getNext () const

void unlink ()

void linkAfter (ResourceObject *res)

Data Fields

S32 flags

Set from Flags.

StringTableEntry path

Resource path.

StringTableEntry name

Resource name.

ResourceInstance * mInstance

Pointer to actual object instance.

S32 lockCount

Lock count; used to control load/unload of resource from memory.

U32 crc

CRC of resource.

ZIP Archive

If the resource is stored in a zip file, these members are populated.

StringTableEntry zipPath

Path of zip file.

StringTableEntry zipName

Name of zip file.

S32 fileOffset

Offset of data in zip file.

S32 fileSize

Size on disk of resource block.

S32 compressedFileSize

Actual size of resource data.

Private Attributes

List Book-keeping

ResourceObject * prev

ResourceObject * next

ResourceObject * nextEntry

This is used by ResDictionary for its hash table.

ResourceObject * nextResource

ResourceObject * prevResource

Friends

class ResDictionary

class ResManager

Enumerator:

ResourceObject::ResourceObject ( )

ResourceObject::~ResourceObject ( ) [inline]

void ResourceObject::destruct ( )

ResourceObject* ResourceObject::getNext ( ) const [inline]

void ResourceObject::unlink ( ) [inline]

void ResourceObject::linkAfter ( ResourceObject * res ) [inline]

void ResourceObject::getFileTimes	(	FileTime *	createTime,
		FileTime *	modifyTime
	)

Get some information about file times.

Parameters:

	createTime	Pointer to a FileTime structure to fill with information about when this object was created.
	modifyTime	Pointer to a FileTime structure to fill with information about when this object was modified.