LegoWorldList Class Reference

A specialized list for managing pointers to LegoWorld instances. More...

#include <legoworldlist.h>

Inheritance diagram for LegoWorldList:

Collaboration diagram for LegoWorldList:

Public Member Functions
	LegoWorldList (MxBool p_ownership=FALSE)
	Constructor which may optionally enable ownership of the LegoWorld pointers. More...
MxS8	Compare (LegoWorld *p_a, LegoWorld *p_b) override
	Compares two LegoWorld pointers for ordering. More...
Public Member Functions inherited from MxPtrList< LegoWorld >
	MxPtrList (MxBool p_ownership)
	[AI] More...
void	SetOwnership (MxBool p_ownership)
	[AI] More...
Public Member Functions inherited from MxList< T >
	MxList ()
	[AI] Constructor. Initializes the list pointers to null (empty list). [AI] More...
	~MxList () override
	[AI] Destructor. Deletes all entries in the list and manages resource ownership. [AI] More...
void	Append (T p_obj)
	[AI] More...
void	Prepend (T p_obj)
	[AI] More...
void	DeleteAll ()
	[AI] More...
void	Empty ()
	[AI] More...
MxU32	GetNumElements ()
	[AI] More...

Additional Inherited Members
Static Public Member Functions inherited from MxPtrList< LegoWorld >
static void	Destroy (LegoWorld *p_obj)
	[AI] More...
Protected Member Functions inherited from MxList< T >
void	DeleteEntry (MxListEntry< T > *)
	[AI] More...
MxListEntry< T > *	InsertEntry (T, MxListEntry< T > *, MxListEntry< T > *)
	[AI] More...
Protected Member Functions inherited from MxCollection< T >
	MxCollection ()
	[AI] Constructs an empty collection, initializing count and default element destructor. More...
virtual MxS8	Compare (T a, T b)
	[AI] Compares two elements of the collection (default implementation returns zero; override in subclasses for meaningful comparison). More...
	~MxCollection () override
	[AI] Virtual destructor for proper polymorphic destruction. More...
void	SetDestroy (void(*p_customDestructor)(T))
	[AI] Assigns a custom destructor function to be used for elements of this collection. More...
Protected Member Functions inherited from MxCore
	MxCore ()
	[AI] Constructs a new MxCore object and assigns it a unique id. More...
virtual	~MxCore ()
	[AI] Virtual destructor. Required for correct polymorphic cleanup in derived classes. More...
virtual MxLong	Notify (MxParam &p_param)
	[AI] Virtual callback notification mechanism. More...
virtual MxResult	Tickle ()
	[AI] Called by tickle managers to allow the object to update itself. More...
virtual const char *	ClassName () const
	[AI] Returns the runtime class name of this object. More...
virtual MxBool	IsA (const char *p_name) const
	[AI] Checks whether this object's class type or parents match the given name. More...
MxU32	GetId ()
	[AI] Gets the unique (per-process) id assigned to this object instance. More...
Static Protected Member Functions inherited from MxCollection< T >
static void	Destroy (T obj)
	[AI] Static no-op destroy function; suitable for types that do not need destruction. More...
Protected Attributes inherited from MxList< T >
MxListEntry< T > *	m_first
	[AI] Pointer to the first entry in the list. [AI] More...
MxListEntry< T > *	m_last
	[AI] Pointer to the last entry in the list. [AI] More...
Protected Attributes inherited from MxCollection< T >
MxU32	m_count
	[AI] Number of elements currently stored in the collection. More...
void(*	m_customDestructor )(T)
	[AI] Function pointer to the custom element destructor used for cleanup of elements. More...

Detailed Description

A specialized list for managing pointers to LegoWorld instances.

[AI]

[AI] Inherits from MxPtrList<LegoWorld>, providing ordering, iteration, ownership control, and pointer management for LegoWorld objects in the engine. [AI]

Note

[AI] Implements custom comparison logic for LegoWorld pointers. [AI]

Definition at line 13 of file legoworldlist.h.

Constructor & Destructor Documentation

LegoWorldList()

LegoWorldList::LegoWorldList ( MxBool  p_ownership = FALSE )

inline

Constructor which may optionally enable ownership of the LegoWorld pointers.

[AI]

Parameters

p_ownership

If TRUE, the list will own (and delete) the objects it contains. [AI]

Definition at line 17 of file legoworldlist.h.

Member Function Documentation

Compare()

MxS8 LegoWorldList::Compare ( LegoWorld *  p_a, LegoWorld *  p_b  )

inlineoverride

Compares two LegoWorld pointers for ordering.

[AI]

[AI] Returns 0 if the pointers are equal, -1 if p_a < p_b, and 1 if p_a > p_b. Used for ordered list operations. [AI]

Parameters

p_a	First LegoWorld pointer to compare. [AI]
p_b	Second LegoWorld pointer to compare. [AI]

Returns

0 if equal, -1 if p_a < p_b, 1 otherwise. [AI]

Definition at line 24 of file legoworldlist.h.

---

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

• legoworldlist.h