Isle
Loading...
Searching...
No Matches
MxType4NotificationParam Class Reference

[AI] Specialized notification parameter, used for notification type 4, extending MxActionNotificationParam with a presenter pointer. More...

#include <mxactionnotificationparam.h>

Inheritance diagram for MxType4NotificationParam:
Collaboration diagram for MxType4NotificationParam:

Public Member Functions

 MxType4NotificationParam (MxCore *p_sender, MxDSAction *p_action, MxPresenter *p_unk0x14)
 [AI] Constructs a type 4 notification parameter carrying an action and a presenter pointer. More...
 
MxNotificationParamClone () const override
 [AI] Returns a clone of this notification parameter. [AI] More...
 
- Public Member Functions inherited from MxActionNotificationParam
 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...
 
MxNotificationParamClone () const override
 [AI] Creates a clone of this notification parameter with the same state. More...
 
MxDSActionGetAction ()
 [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 MxNotificationParamClone () 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...
 
MxCoreGetSender () 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...
 

Additional Inherited Members

- Protected Attributes inherited from MxActionNotificationParam
MxDSActionm_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...
 
MxCorem_sender
 [AI] Pointer to the MxCore instance that sent or originated this notification. More...
 

Detailed Description

[AI] Specialized notification parameter, used for notification type 4, extending MxActionNotificationParam with a presenter pointer.

[AI]

[AI] This is used for advanced/engine-internal actions that may require an associated MxPresenter. [AI]

Definition at line 121 of file mxactionnotificationparam.h.

Constructor & Destructor Documentation

◆ MxType4NotificationParam()

MxType4NotificationParam::MxType4NotificationParam ( MxCore p_sender,
MxDSAction p_action,
MxPresenter p_unk0x14 
)
inline

[AI] Constructs a type 4 notification parameter carrying an action and a presenter pointer.

[AI]

Parameters
p_senderNotification sender object. [AI]
p_actionAssociated action. [AI]
p_unk0x14Additional pointer, likely to an associated presenter. [AI_SUGGESTED_NAME: p_presenter] [AI]

Definition at line 127 of file mxactionnotificationparam.h.

Member Function Documentation

◆ Clone()

MxNotificationParam * MxType4NotificationParam::Clone ( ) const
overridevirtual

[AI] Returns a clone of this notification parameter. [AI]

Reimplemented from MxActionNotificationParam.

Definition at line 18 of file mxactionnotificationparam.cpp.


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