Resource::IRecord class
#include <Spore ModAPI/Spore/Resource/IRecord.h>

Represents a file in a Database; records are identified by a ResourceKey (which specifies group, instance and type IDs), and have an underlying IO::IStream that is used to read/write data.

Base classes

class ThreadedObject

Derived classes

class FakeRecord
class PFRecordBase: Base implementation for records in a .package file (DatabasePackedFile).

Public functions

auto GetKey() -> const ResourceKey& pure virtual: Gets the ResourceKey name that identifies this record.
auto SetKey(const ResourceKey& key) -> void pure virtual: Sets the ResourceKey name that identifies this record.
auto GetStream() -> IO::IStream* pure virtual: Returns the IStream used to access this record data.
auto GetDatabase() -> Database* pure virtual: Returns the database that this record belongs to.
auto RecordOpen() -> bool pure virtual: Opens this record, allowing its data to be used.
auto RecordClose() -> bool pure virtual: Closes this record, forbidding any use of its data.

Function documentation

void Resource::IRecord::SetKey(const ResourceKey& key) pure virtual

Sets the ResourceKey name that identifies this record.

Parameters
key

IO::IStream* Resource::IRecord::GetStream() pure virtual

Returns the IStream used to access this record data.

Returns