[AI] Notification parameter class that contains information about an MxDSAction, used for inter-object notifications related to dynamic script (SI) actions. More...

#include <mxactionnotificationparam.h>

Inheritance diagram for MxActionNotificationParam:

[legend]

Collaboration diagram for MxActionNotificationParam:

[legend]

Public Member Functions
	MxActionNotificationParam (NotificationId p_type, MxCore p_sender, MxDSAction p_action, MxBool p_reallocAction)
	[AI] Constructs the action notification parameter, optionally cloning the action if requested. More...

	~MxActionNotificationParam () override
	[AI] Destructor releases the action if this object owns it (realloc flag set). [AI] More...

MxNotificationParam *	Clone () const override
	[AI] Creates a clone of this notification parameter with the same state. More...

MxDSAction *	GetAction ()
	[AI] Direct access to the underlying action. More...

Public Member Functions inherited from MxNotificationParam
	MxNotificationParam ()
	[AI] Constructs a default notification parameter with type c_notificationType0 and no sender. More...

	MxNotificationParam (NotificationId p_type, MxCore *p_sender)
	[AI] Constructs a notification parameter with a specific type and sender. More...

virtual MxNotificationParam *	Clone () const
	[AI] Creates a copy of this notification parameter object on the heap. More...

NotificationId	GetNotification () const
	[AI] Retrieves the current notification type of this parameter. More...

MxCore *	GetSender () const
	[AI] Retrieves the sender pointer associated with this notification. More...

void	SetNotification (NotificationId p_type)
	[AI] Sets the notification type for this parameter object. More...

void	SetSender (MxCore *p_sender)
	[AI] Sets the sender pointer for this notification parameter. More...

Public Member Functions inherited from MxParam
virtual	~MxParam ()
	[AI] Virtual destructor for safe polymorphic deletion of derived parameter objects. More...

Protected Attributes
MxDSAction *	m_action
	[AI] Associated action (owned if m_realloc is true). [AI] More...

MxBool	m_realloc
	[AI] TRUE if this object owns and should free m_action. [AI] More...

Protected Attributes inherited from MxNotificationParam
NotificationId	m_type
	[AI] Type of notification/event carried by this object (see NotificationId). More...

MxCore *	m_sender
	[AI] Pointer to the MxCore instance that sent or originated this notification. More...

Detailed Description

[AI] Notification parameter class that contains information about an MxDSAction, used for inter-object notifications related to dynamic script (SI) actions.

It can optionally own/reallocate its action. [AI]

[AI] Derived from MxNotificationParam, this class extends notifications to carry an action and "realloc" flag, typically signaling start/end/progress of script actions. It supports cloning and optional deep copy creation of the action. [AI]

Definition at line 14 of file mxactionnotificationparam.h.

Constructor & Destructor Documentation

◆ MxActionNotificationParam()

MxActionNotificationParam::MxActionNotificationParam	(	NotificationId	p_type,
		MxCore *	p_sender,
		MxDSAction *	p_action,
		MxBool	p_reallocAction
	)

inline

[AI] Constructs the action notification parameter, optionally cloning the action if requested.

[AI]

Parameters

p_type	Notification type that identifies the notification event. [AI]
p_sender	The object sending the notification. [AI]
p_action	The MxDSAction associated with the notification. [AI]
p_reallocAction	If TRUE, clones the input action for ownership; if FALSE, just references it. [AI]

Definition at line 21 of file mxactionnotificationparam.h.