MxNextActionDataStart Class Reference

[AI] Contains data for scheduling the next action in a process, storing an object id, a parameter, and an associated data value. More...

#include <mxnextactiondatastart.h>

Inheritance diagram for MxNextActionDataStart:

Collaboration diagram for MxNextActionDataStart:

Public Member Functions
	MxNextActionDataStart (MxU32 p_objectId, MxS16 p_unk0x24, MxU32 p_data)
	[AI] Constructs an MxNextActionDataStart object and initializes its fields. More...
const char *	ClassName () const override
	[AI] Returns the class name as a constant string. More...
MxBool	IsA (const char *p_name) const override
	[AI] Performs runtime type check against class name and all ancestors. More...
MxU32	GetObjectId () const
	[AI] Gets the identifier for the object the action applies to. More...
MxS16	GetUnknown24 () const
	[AI] Gets the unknown parameter or code for the action (purpose unclear in decompilation output). More...
MxU32	GetData () const
	[AI] Retrieves the extra data associated with the action dispatch. More...
void	SetData (MxU32 p_data)
	[AI] Sets the data value for this action instance. More...
Public 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...

Detailed Description

[AI] Contains data for scheduling the next action in a process, storing an object id, a parameter, and an associated data value.

[AI] MxNextActionDataStart is a simple data-holder class derived from MxCore, used to store information about the start of a future action/command within the LEGO Island action sequence system. It maintains references for the object the action applies to, a secondary parameter (purpose not fully understood in decompiled code), and an additional data field. [AI]

Definition at line 14 of file mxnextactiondatastart.h.

Constructor & Destructor Documentation

MxNextActionDataStart()

MxNextActionDataStart::MxNextActionDataStart ( MxU32  p_objectId, MxS16  p_unk0x24, MxU32  p_data  )

inline

[AI] Constructs an MxNextActionDataStart object and initializes its fields.

Parameters

p_objectId	[AI] The primary ID for the action's target object (stored in m_objectId).
p_unk0x24	[AI] Secondary parameter, possibly an action subtype or control value (stored in m_unk0x24). [AI_SUGGESTED_NAME: actionParameter]
p_data	[AI] Value used as extra information for the action's execution (stored in m_data).

Definition at line 22 of file mxnextactiondatastart.h.

Member Function Documentation

ClassName()

const char * MxNextActionDataStart::ClassName ( ) const

inlineoverridevirtual

[AI] Returns the class name as a constant string.

Returns

[AI] "MxNextActionDataStart"

Reimplemented from MxCore.

Definition at line 33 of file mxnextactiondatastart.h.

GetData()

MxU32 MxNextActionDataStart::GetData ( ) const

inline

[AI] Retrieves the extra data associated with the action dispatch.

Definition at line 63 of file mxnextactiondatastart.h.

GetObjectId()

MxU32 MxNextActionDataStart::GetObjectId ( ) const

inline

[AI] Gets the identifier for the object the action applies to.

Definition at line 53 of file mxnextactiondatastart.h.

GetUnknown24()

MxS16 MxNextActionDataStart::GetUnknown24 ( ) const

inline

[AI] Gets the unknown parameter or code for the action (purpose unclear in decompilation output).

[AI_SUGGESTED_NAME: GetActionParameter]

Definition at line 58 of file mxnextactiondatastart.h.

IsA()

MxBool MxNextActionDataStart::IsA ( const char *  p_name ) const

inlineoverridevirtual

[AI] Performs runtime type check against class name and all ancestors.

Parameters

p_name

[AI] Name to check.

Return values

TRUE	[AI] If p_name matches this class or MxCore.
FALSE	[AI] Otherwise.

Reimplemented from MxCore.

Definition at line 45 of file mxnextactiondatastart.h.

SetData()

void MxNextActionDataStart::SetData ( MxU32  p_data )

inline

[AI] Sets the data value for this action instance.

Parameters

p_data

[AI] New value for the data field (m_data).

Definition at line 69 of file mxnextactiondatastart.h.

---

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

• mxnextactiondatastart.h