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

[AI] Carries a notification to be sent to a target MxCore object. More...

#include <mxnotificationmanager.h>

Public Member Functions

 MxNotification (MxCore *p_target, const MxNotificationParam &p_param)
 [AI] Constructor for MxNotification. More...
 
 ~MxNotification ()
 [AI] Destructor for MxNotification. More...
 
MxCoreGetTarget ()
 [AI] Returns the target of this notification. More...
 
MxNotificationParamGetParam ()
 [AI] Returns the notification parameter (cloned by the notification). More...
 

Detailed Description

[AI] Carries a notification to be sent to a target MxCore object.

This encapsulates a notification target and a notification parameter instance.

[AI] Used internally by the notification manager to represent a single pending notification for asynchronous delivery to a game object.

Definition at line 15 of file mxnotificationmanager.h.

Constructor & Destructor Documentation

◆ MxNotification()

MxNotification::MxNotification ( MxCore p_target,
const MxNotificationParam p_param 
)

[AI] Constructor for MxNotification.

Parameters
p_targetThe MxCore object to which this notification is addressed. [AI]
p_paramReference to the notification parameter object (the manager will clone this parameter). [AI]

[AI] The notification takes ownership of a cloned copy of the parameter to ensure thread safety.

Definition at line 16 of file mxnotificationmanager.cpp.

◆ ~MxNotification()

MxNotification::~MxNotification ( )

[AI] Destructor for MxNotification.

Destroys the internally cloned parameter. [AI]

Definition at line 23 of file mxnotificationmanager.cpp.

Member Function Documentation

◆ GetParam()

MxNotificationParam * MxNotification::GetParam ( )
inline

[AI] Returns the notification parameter (cloned by the notification).

Returns
MxNotificationParam* [AI]

Definition at line 40 of file mxnotificationmanager.h.

◆ GetTarget()

MxCore * MxNotification::GetTarget ( )
inline

[AI] Returns the target of this notification.

Returns
MxCore* [AI]

Definition at line 34 of file mxnotificationmanager.h.


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