LegoPathStructNotificationParam Class Reference

[AI] Specialized notification parameter used for path structure related events in LEGO Island. More...

#include <legopathstruct.h>

Inheritance diagram for LegoPathStructNotificationParam:

Collaboration diagram for LegoPathStructNotificationParam:

Public Member Functions
	LegoPathStructNotificationParam (NotificationId p_type, MxCore *p_sender, MxU8 p_trigger, MxS16 p_data)
	[AI] Constructor for LegoPathStructNotificationParam. More...
MxNotificationParam *	Clone () const override
	[AI] Creates a deep copy of this notification parameter. More...
MxU8	GetTrigger ()
	[AI] Returns the trigger type associated with this notification. More...
MxS16	GetData ()
	[AI] Retrieves the supplemental data associated with the notification. 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
MxS16	m_data
	[AI] Context-dependent data relevant to the trigger event (e.g. object id, animation id). More...
MxU8	m_trigger
	[AI] Trigger type character - specifies which trigger caused the event (e.g. 'D' for door/passage, 'S' for state). 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] Specialized notification parameter used for path structure related events in LEGO Island.

[AI] Encapsulates an additional data field (m_data) and a trigger indicator (m_trigger), defining the context of the notification within path struct-triggered events. Used to notify actors and worlds of crossing or entering path triggers.

Remarks

[AI] Used in path transition logic (see LegoPathStruct).

Definition at line 18 of file legopathstruct.h.

Constructor & Destructor Documentation

LegoPathStructNotificationParam()

LegoPathStructNotificationParam::LegoPathStructNotificationParam ( NotificationId  p_type, MxCore *  p_sender, MxU8  p_trigger, MxS16  p_data  )

inline

[AI] Constructor for LegoPathStructNotificationParam.

Parameters

p_type	[AI] The notification type identifier.
p_sender	[AI] The object (typically a path actor) that sends the notification.
p_trigger	[AI] A trigger value identifying the kind of trigger (e.g. 'D', 'S', etc.) the notification relates to.
p_data	[AI] Supplemental data relevant to the trigger (typically a numeric value such as an object or animation ID).

Definition at line 25 of file legopathstruct.h.

Member Function Documentation

Clone()

MxNotificationParam * LegoPathStructNotificationParam::Clone ( ) const

inlineoverridevirtual

[AI] Creates a deep copy of this notification parameter.

[AI] Used by the notification system to safely propagate notification parameters.

Returns

[AI] New instance, cloned from current contents.

Reimplemented from MxNotificationParam.

Definition at line 38 of file legopathstruct.h.

GetData()

MxS16 LegoPathStructNotificationParam::GetData ( )

inline

[AI] Retrieves the supplemental data associated with the notification.

Returns

[AI] Notification context data (meaning depends on trigger type).

Definition at line 51 of file legopathstruct.h.

GetTrigger()

MxU8 LegoPathStructNotificationParam::GetTrigger ( )

inline

[AI] Returns the trigger type associated with this notification.

Returns

[AI] The trigger byte (e.g. 'D', 'S').

Definition at line 46 of file legopathstruct.h.

Member Data Documentation

m_data

MxS16 LegoPathStructNotificationParam::m_data

protected

[AI] Context-dependent data relevant to the trigger event (e.g. object id, animation id).

Definition at line 54 of file legopathstruct.h.

m_trigger

MxU8 LegoPathStructNotificationParam::m_trigger

protected

[AI] Trigger type character - specifies which trigger caused the event (e.g. 'D' for door/passage, 'S' for state).

Definition at line 55 of file legopathstruct.h.

---

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

• legopathstruct.h