This is the documentation for Enlighten.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

class Enlighten::IPrecompInputItemDependencies

    └>Geo::IGeoSerialisable
        └>Geo::IGeoReleasable

A collection of item dependencies.

Functions

Name Description
AddItem(const Geo::GeoGuid &)

Adds an item to the collection.

Create()

Create a new IPrecompInputItemDependencies.

GetId()

Get the guid of this item.

GetItem(const Geo::s32 &)

Get the guid of the item at position idx.

GetNumItems()

Return the number of items in the collection.

IsDependentOn(const Geo::GeoGuid &)

Adds an item to the collection.

Load(IGeoInputStream &, Geo::u32)

Load an instance of this class from an IGeoInputStream.

Release()

Free this object that was created within the Enlighten libraries.

Save(IGeoStream &, Geo::u32)

Save an instance of this class to an IGeoStream.

SetId(Geo::GeoGuid)

Set the guid of this item.


virtual bool Enlighten::IPrecompInputItemDependencies::AddItem


public: bool AddItem
(
    const Geo::GeoGuid & item
)


Adds an item to the collection.

Returns

True if the item could be added


static IPrecompInputItemDependencies* Enlighten::IPrecompInputItemDependencies::Create


public: IPrecompInputItemDependencies * Create()


Create a new IPrecompInputItemDependencies.


virtual Geo::GeoGuid Enlighten::IPrecompInputItemDependencies::GetId


public: Geo::GeoGuid GetId() const


Get the guid of this item.


virtual Geo::GeoGuid Enlighten::IPrecompInputItemDependencies::GetItem


public: Geo::GeoGuid GetItem
(
    const Geo::s32 & idx
) const


Get the guid of the item at position idx.


virtual Geo::s32 Enlighten::IPrecompInputItemDependencies::GetNumItems


public: Geo::s32 GetNumItems() const


Return the number of items in the collection.


virtual bool Enlighten::IPrecompInputItemDependencies::IsDependentOn


public: bool IsDependentOn
(
    const Geo::GeoGuid & item
) const


Adds an item to the collection.

Returns

True if there is a dependency between the guid this class represents and 'item'


virtual bool Geo::IGeoSerialisable::Load


public: bool Load
(
    IGeoInputStream & stream,
    Geo::u32 section
)


Load an instance of this class from an IGeoInputStream.

The stream must be ready to read from. You can load sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will load all sections. It is also safe to call this method on an object multiple times with different section arguments to load multiple parts.


virtual void Geo::IGeoReleasable::Release


public: void Release()


Free this object that was created within the Enlighten libraries.

Expect this to behave in a similar way to calling 'delete(this)'


virtual bool Geo::IGeoSerialisable::Save


public: bool Save
(
    IGeoStream & stream,
    Geo::u32 section
) const


Save an instance of this class to an IGeoStream.

The stream must be ready to write to. You can save sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will save all sections that are available.


virtual void Enlighten::IPrecompInputItemDependencies::SetId


public: void SetId
(
    Geo::GeoGuid id
)


Set the guid of this item.

  • No labels