Public API Reference

               

---

csCollectionList::CollectionList Class Reference

iCollectionList implementation. More...

#include <engine.h>

Inheritance diagram for csCollectionList::CollectionList:

List of all members.

Public Methods
virtual iCollection *	NewCollection (const char *name)
	Create a new collection. More...
virtual int	GetCount () const
	Return the number of collections in this list. More...
virtual iCollection *	Get (int n) const
	Return a collection by index. More...
virtual int	Add (iCollection *obj)
	Add a collection. More...
virtual bool	Remove (iCollection *obj)
	Remove a collection. More...
virtual bool	Remove (int n)
	Remove the nth collection. More...
virtual void	RemoveAll ()
	Remove all collections. More...
virtual int	Find (iCollection *obj) const
	Find a collection and return its index. More...
virtual iCollection *	FindByName (const char *Name) const
	Find a collection by name. More...

---

Detailed Description

iCollectionList implementation.

Definition at line 128 of file csengine/engine.h.

---

Member Function Documentation

virtual int csCollectionList::CollectionList::Add (  iCollection *    obj )  [virtual]

Add a collection. Implements iCollectionList.

virtual int csCollectionList::CollectionList::Find (  iCollection *    obj )  const [virtual]

Find a collection and return its index. Implements iCollectionList.

virtual iCollection* csCollectionList::CollectionList::FindByName (  const char *    Name )  const [virtual]

Find a collection by name. Implements iCollectionList.

virtual iCollection* csCollectionList::CollectionList::Get (  int    n )  const [virtual]

Return a collection by index. Implements iCollectionList.

virtual int csCollectionList::CollectionList::GetCount (    )  const [virtual]

Return the number of collections in this list. Implements iCollectionList.

virtual iCollection* csCollectionList::CollectionList::NewCollection (  const char *    name )  [virtual]

Create a new collection. Implements iCollectionList.

virtual bool csCollectionList::CollectionList::Remove (  int    n )  [virtual]

Remove the nth collection. Implements iCollectionList.

virtual bool csCollectionList::CollectionList::Remove (  iCollection *    obj )  [virtual]

Remove a collection. Implements iCollectionList.

virtual void csCollectionList::CollectionList::RemoveAll (    )  [virtual]

Remove all collections. Implements iCollectionList.

---

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

• csengine/engine.h

---