[AI] A list (collection) of pointers to MxDSAction objects, supporting comparison, destruction, and list management. More...

#include <mxdsactionlist.h>

Inheritance diagram for MxDSActionList:

[legend]

Collaboration diagram for MxDSActionList:

[legend]

Public Member Functions
	MxDSActionList ()
	[AI] Constructs a new MxDSActionList with the unknown internal state initialized to zero. More...

MxS8	Compare (MxDSAction p_a, MxDSAction p_b) override
	[AI] Compares two MxDSAction pointers by address. More...

Public Member Functions inherited from MxList< MxDSAction * >
	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 (MxDSAction * p_obj)
	[AI] More...

void	Prepend (MxDSAction * p_obj)
	[AI] More...

void	DeleteAll ()
	[AI] More...

void	Empty ()
	[AI] More...

MxU32	GetNumElements ()
	[AI] More...

Static Public Member Functions
static void	Destroy (MxDSAction *p_action)
	[AI] Destroys/deletes a given MxDSAction pointer. More...

Additional Inherited Members
Protected Member Functions inherited from MxList< MxDSAction * >
void	DeleteEntry (MxListEntry< MxDSAction * > *)
	[AI] More...

MxListEntry< MxDSAction * > *	InsertEntry (MxDSAction , MxListEntry< MxDSAction > , MxListEntry< MxDSAction > *)
	[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< MxDSAction * >
MxListEntry< MxDSAction * > *	m_first
	[AI] Pointer to the first entry in the list. [AI] More...

MxListEntry< MxDSAction * > *	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

[AI] A list (collection) of pointers to MxDSAction objects, supporting comparison, destruction, and list management.

[AI] This class inherits from MxList<MxDSAction*> and represents an owning collection of all actions in a deserialized SI action group or composite. It uses pointer comparison as a sorting mechanism and provides static creation/deletion routines for memory management.

Definition at line 26 of file mxdsactionlist.h.

Constructor & Destructor Documentation

◆ MxDSActionList()

MxDSActionList::MxDSActionList ( )

inline

[AI] Constructs a new MxDSActionList with the unknown internal state initialized to zero.

[AI] The private member m_unk0x18 is set to 0 on instantiation. Purpose of this member is currently unknown.

Definition at line 32 of file mxdsactionlist.h.

Member Function Documentation

◆ Compare()

MxS8 MxDSActionList::Compare	(	MxDSAction *	p_a,
		MxDSAction *	p_b
	)

inlineoverride

[AI] Compares two MxDSAction pointers by address.

Parameters

p_a	First MxDSAction pointer [AI]
p_b	Second MxDSAction pointer [AI]

Returns: 0 if p_a == p_b, -1 if p_a < p_b, 1 if p_a > p_b [AI]

[AI] This is used for pointer-based ordering or searching within the list.

Definition at line 41 of file mxdsactionlist.h.

◆ Destroy()

static void MxDSActionList::Destroy ( MxDSAction * p_action )

inlinestatic

[AI] Destroys/deletes a given MxDSAction pointer.

Parameters

p_action MxDSAction pointer to delete [AI]

[AI] Used by list cleanup routines or when actions are being removed from the owning list.

Definition at line 51 of file mxdsactionlist.h.

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

mxdsactionlist.h

Public Member Functions