MxDSSerialAction Class Reference

[AI] Represents a serial (sequential) action group for data-driven sequence execution in LEGO Island. More...

#include <mxdsserialaction.h>

Inheritance diagram for MxDSSerialAction:

Collaboration diagram for MxDSSerialAction:

Public Member Functions
	MxDSSerialAction ()
	[AI] Constructs an empty serial action, setting up the cursor and type. More...
	MxDSSerialAction (MxDSSerialAction &p_dsSerialAction)
	[AI] Copy constructor. More...
	~MxDSSerialAction () override
	[AI] Destructor. More...
void	CopyFrom (MxDSSerialAction &p_dsSerialAction)
	[AI] Copies the state of another MxDSSerialAction into this one, including duplication warnings if the source cursor is active. More...
MxDSSerialAction &	operator= (MxDSSerialAction &p_dsSerialAction)
	[AI] Assignment operator. More...
const char *	ClassName () const override
	[AI] Gets the class name of this object. More...
MxBool	IsA (const char *p_name) const override
	[AI] Checks if this class is of a given type or its parent types. More...
MxLong	GetDuration () override
	[AI] Calculates and retrieves the total duration of this serial action. More...
void	SetDuration (MxLong p_duration) override
	[AI] Sets an explicit duration value for the entire serial action sequence. More...
MxDSAction *	Clone () override
	[AI] Clones (deep copies) this serial action, including its list of contained actions and configuration. More...
Public Member Functions inherited from MxDSMultiAction
	MxDSMultiAction ()
	[AI] Constructs an MxDSMultiAction, initializing its type and instantiating an empty action list. More...
	MxDSMultiAction (MxDSMultiAction &p_dsMultiAction)
	[AI] Copy constructor for MxDSMultiAction, performing a deep copy of all actions in the source list. More...
	~MxDSMultiAction () override
	[AI] Destructor. More...
void	CopyFrom (MxDSMultiAction &p_dsMultiAction)
	[AI] Deeply copies all actions from another MxDSMultiAction. More...
MxDSMultiAction &	operator= (MxDSMultiAction &p_dsMultiAction)
	[AI] Assignment operator, deeply copies all state and actions from another MxDSMultiAction. More...
const char *	ClassName () const override
	[AI] Returns the class name for this object ("MxDSMultiAction"). More...
MxBool	IsA (const char *p_name) const override
	[AI] Checks whether a given class name matches this or any parent class. More...
undefined4	VTable0x14 () override
	[AI] Hook for vtable entry 0x14. More...
MxU32	GetSizeOnDisk () override
	[AI] Calculates the total disk size occupied by this multi-action and all its subactions. More...
void	Deserialize (MxU8 *&p_source, MxS16 p_unk0x24) override
	[AI] Reads the object's data from a raw byte buffer. More...
void	SetAtomId (MxAtomId p_atomId) override
	[AI] Propagates the given AtomId to this and all subactions. More...
MxDSAction *	Clone () override
	[AI] Constructs a deep clone of this multi-action, including all subactions. More...
void	MergeFrom (MxDSAction &p_dsAction) override
	[AI] Propagates a merge operation from the provided MxDSAction to all subactions, as well as self. More...
MxBool	HasId (MxU32 p_objectId) override
	[AI] Returns whether this action or any contained subaction matches the provided object id. More...
void	SetUnknown90 (MxLong p_unk0x90) override
	[AI] Propagates an unknown value to this and all subactions. More...
MxDSActionList *	GetActionList () const
	[AI] Returns the internal action list holding all subactions of this multi-action. More...
Public Member Functions inherited from MxDSAction
	MxDSAction ()
	[AI] Default constructor. More...
	~MxDSAction () override
	[AI] Destructor. More...
	MxDSAction (MxDSAction &p_dsAction)
	[AI] Copy constructor from another MxDSAction More...
void	CopyFrom (MxDSAction &p_dsAction)
	[AI] Copies all properties from another MxDSAction (deep copy, including extra data string) More...
MxDSAction &	operator= (MxDSAction &p_dsAction)
	[AI] Assignment operator: deep-copy from a different MxDSAction, including base class data and extra fields. More...
const char *	ClassName () const override
	[AI] Returns the class name for RTTI or reflection purposes. More...
MxBool	IsA (const char *p_name) const override
	[AI] Run-time type check, compares provided name with this or any ancestor type. More...
undefined4	VTable0x14 () override
	[AI] Unknown virtual placeholder, possibly for additional interfaces. More...
MxU32	GetSizeOnDisk () override
	[AI] Serializes the size on disk of this action (all fields + extra data length) More...
void	Deserialize (MxU8 *&p_source, MxS16 p_unk0x24) override
	[AI] Deserializes this action's data from a binary buffer. More...
virtual MxLong	GetDuration ()
	[AI] Gets the duration for which this action is intended to run. More...
virtual void	SetDuration (MxLong p_duration)
	[AI] Sets the duration of this action in ticks or time units. More...
virtual MxDSAction *	Clone ()
	[AI] Clones (deep-copies) this action and returns a new pointer. More...
virtual void	MergeFrom (MxDSAction &p_dsAction)
	[AI] Copies/merges properties from another action. More...
virtual MxBool	HasId (MxU32 p_objectId)
	[AI] Checks if this action contains/was created for a specific SI object id. More...
virtual void	SetUnknown90 (MxLong p_unk0x90)
	[AI] Set unknown value at offset 0x90, used as baseline in GetElapsedTime. More...
virtual MxLong	GetUnknown90 ()
	[AI] Gets the unknown value at offset 0x90, likely a start timestamp. More...
virtual MxLong	GetElapsedTime ()
	[AI] Gets elapsed time for this action since the last time field 0x90 was set. More...
void	AppendExtra (MxU16 p_extraLength, const char *p_extraData)
	[AI] Concatenates or stores extra data associated with this action, robust for multi-part actions. More...
void	GetExtra (MxU16 &p_extraLength, char *&p_extraData)
	[AI] Retrieves the extra data and its length for this action. More...
MxU32	GetFlags ()
	[AI] Returns the flag field for this action (bitmask). More...
void	SetFlags (MxU32 p_flags)
	[AI] Sets the flag bitmask controlling action logic (enabled, looping, etc). More...
char *	GetExtraData ()
	[AI] Accessor for extra data (not null-terminated). More...
MxU16	GetExtraLength () const
	[AI] Returns the length (in bytes) of extra data. More...
MxLong	GetStartTime () const
	[AI] Gets the nominal start time for the action, as loaded or scheduled. More...
MxS32	GetLoopCount ()
	[AI] Returns the loop count for this action. More...
void	SetLoopCount (MxS32 p_loopCount)
	[AI] Sets the loop count for this action. More...
const Vector3 &	GetLocation ()
	[AI] Gets the location vector for this action (world or local space). More...
const Vector3 &	GetDirection ()
	[AI] Gets the direction vector (typically forward vector) for this action. More...
const Vector3 &	GetUp ()
	[AI] Gets the up vector for this action (global or local). More...
void	SetLocation (const Vector3 &p_location)
	[AI] Sets the location vector for this action. More...
void	SetDirection (const Vector3 &p_direction)
	[AI] Sets the direction vector for this action. More...
void	SetUp (const Vector3 &p_up)
	[AI] Sets the up vector for this action. More...
MxCore *	GetUnknown84 ()
	[AI] Returns a pointer to an associated or auxiliary core object. More...
void	SetUnknown84 (MxCore *p_unk0x84)
	[AI] Sets the auxiliary core pointer for this action. More...
MxCore *	GetOrigin ()
	[AI] Returns a pointer to the "origin" core object, which may be used to localize the action. More...
void	SetOrigin (MxCore *p_origin)
	[AI] Sets the origin core pointer for this action, if spatially transforming/localizing this action. More...
MxBool	IsLooping () const
	[AI] Whether this action is set to loop based on current flags. More...
MxBool	IsBit3 () const
	[AI] Tests for the state of the (unknown purpose) bit 3 flag in m_flags. More...
Public Member Functions inherited from MxDSObject
	MxDSObject ()
	[AI] Default constructor. Initializes to e_object and clears names and pointers. More...
	~MxDSObject () override
	[AI] Destructor. Frees allocated objectName/sourceName memory. More...
void	CopyFrom (MxDSObject &p_dsObject)
	[AI] Copy data from another MxDSObject, performing deep string copy for names. More...
	MxDSObject (MxDSObject &p_dsObject)
	[AI] Copy constructor. More...
MxDSObject &	operator= (MxDSObject &p_dsObject)
	[AI] Assignment operator. More...
void	SetObjectName (const char *p_objectName)
	[AI] Sets object (internal) unique name; deep copies the string. More...
void	SetSourceName (const char *p_sourceName)
	[AI] Sets the source name (usually source SI file); deep copies the string. More...
const char *	ClassName () const override
	[AI] Returns the class identifier string for run-time type ID. More...
MxBool	IsA (const char *p_name) const override
	[AI] Runtime type check; supports derived/parent class lookup by name. More...
virtual undefined4	VTable0x14 ()
	[AI] Placeholder for early vtable slot (purpose unknown, may be used for RTTI). More...
virtual MxU32	GetSizeOnDisk ()
	[AI] Calculates serialized size of this object on disk (for buffer allocation). More...
virtual void	Deserialize (MxU8 *&p_source, MxS16 p_unk0x24)
	[AI] Initializes this object from serialized (memory buffer) data. More...
virtual void	SetAtomId (MxAtomId p_atomId)
	[AI] Sets the atom id for this object instance, used for indexing or lookup. More...
Type	GetType () const
	[AI] Returns the object's type enum as stored in m_type. More...
const char *	GetSourceName () const
	[AI] Returns the source name string (typically the originating SI file). More...
const char *	GetObjectName () const
	[AI] Returns the object name string. More...
MxU32	GetObjectId ()
	[AI] Returns the object id numeric value. More...
const MxAtomId &	GetAtomId ()
	[AI] Returns a const-reference to the object's atom identifier. More...
MxS16	GetUnknown24 ()
	[AI] Returns the unknown 0x24 value (may be data version or usage state). [AI] More...
MxPresenter *	GetUnknown28 ()
	[AI] Returns the pointer stored at 0x28, likely a presenter or handler for this DS object. More...
void	SetType (Type p_type)
	[AI] Sets the DS object type. More...
void	SetObjectId (MxU32 p_objectId)
	[AI] Sets the object id (for serialization or lookup). More...
void	SetUnknown24 (MxS16 p_unk0x24)
	[AI] Sets the unknown field at 0x24 (possibly version/state). More...
void	SetUnknown28 (MxPresenter *p_unk0x28)
	[AI] Sets the pointer at 0x28 (presenter or handler). More...
void	ClearAtom ()
	[AI] Clears the atom id, releasing its association. 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...

Additional Inherited Members
Public Types inherited from MxDSAction
enum	{   c_looping = 0x01 , c_bit3 = 0x04 , c_bit4 = 0x08 , c_bit5 = 0x10 ,   c_enabled = 0x20 , c_bit7 = 0x40 , c_world = 0x80 , c_bit9 = 0x100 ,   c_bit10 = 0x200 , c_bit11 = 0x400 }
	[AI] Action bitmask flag options controlling flow (loop, enable, world-space, etc) More...
Public Types inherited from MxDSObject
enum	Type {   e_object = 0 , e_action , e_mediaAction , e_anim ,   e_sound , e_multiAction , e_serialAction , e_parallelAction ,   e_event , e_selectAction , e_still , e_objectAction }
	[AI] Enumerated type value for each kind of DS object. More...
Protected Attributes inherited from MxDSMultiAction
MxU32	m_sizeOnDisk
	[AI] Stores the last-computed disk storage size for m_actionList and metadata. More...
MxDSActionList *	m_actionList
	[AI] List of contained actions (ownership: this owns and deletes subactions). More...
Protected Attributes inherited from MxDSAction
MxU32	m_sizeOnDisk
	[AI] The size of this action's fields on disk, not counting ancestor size. More...
MxU32	m_flags
	[AI] Bitfield for flags (enabled, looping, etc). More...
MxLong	m_startTime
	[AI] Time at which the action is meant to start, or INT_MIN for unset. More...
MxLong	m_duration
	[AI] The duration to run the action, or INT_MIN for undefined. More...
MxS32	m_loopCount
	[AI] Number of times to repeat the action, or -1 for infinite/not-set. More...
Mx3DPointFloat	m_location
	[AI] Location in 3D world or local space (x, y, z). More...
Mx3DPointFloat	m_direction
	[AI] "Forward" direction vector for this action. More...
Mx3DPointFloat	m_up
	[AI] "Up" vector for this action. More...
char *	m_extraData
	[AI] Opaque extra data for custom or extended behavior. More...
MxU16	m_extraLength
	[AI] Length of extra data in bytes. More...
MxCore *	m_unk0x84
	[AI] Pointer to an auxiliary MxCore object, purpose unknown. More...
undefined4	m_unk0x88
	[AI] 4 bytes at 0x88; usage not known. More...
MxCore *	m_origin
	[AI] Pointer to an "origin" MxCore object, for spatial/ownership reference. More...
MxLong	m_unk0x90
	[AI] Unknown field, appears to store a timestamp for GetElapsedTime logics. More...
Protected Attributes inherited from MxDSObject
MxU32	m_sizeOnDisk
	[AI] Cached/calculated disk size of object data for serialization. [AI] More...
MxU16	m_type
	[AI] Object type enum (see Type) as read from data or set in code. [AI] More...
char *	m_sourceName
	[AI] Heap copy: SI file or source identifier string. [AI] More...
undefined4	m_unk0x14
	[AI] Unknown usage, possibly flags or reserved SI-format field. [AI] More...
char *	m_objectName
	[AI] Heap copy: Logical object name as referenced in script/data. [AI] More...
MxU32	m_objectId
	[AI] Numeric id (unique per file or context, often -1). [AI] More...
MxAtomId	m_atomId
	[AI] String/value pair for engine lookup/reference. [AI] More...
MxS16	m_unk0x24
	[AI] Unknown usage, possibly used for context or flags during loading. [AI] More...
MxPresenter *	m_unk0x28
	[AI] Presenter or handler associated to this object (may be null). [AI] More...

Detailed Description

[AI] Represents a serial (sequential) action group for data-driven sequence execution in LEGO Island.

Actions within this group are processed one at a time, in the order they appear.

[AI] This class inherits from MxDSMultiAction and extends its functionality to enforce serial execution of contained actions. It utilizes an internal cursor to keep track of traversal state. Care should be taken when copying serial actions, as concurrent traversal of the action list can result in conflicts (as signaled by debug warnings in CopyFrom).

Definition at line 15 of file mxdsserialaction.h.

Constructor & Destructor Documentation

MxDSSerialAction() [1/2]

MxDSSerialAction::MxDSSerialAction

(

)

[AI] Constructs an empty serial action, setting up the cursor and type.

Definition at line 10 of file mxdsserialaction.cpp.

MxDSSerialAction() [2/2]

MxDSSerialAction::MxDSSerialAction

(

MxDSSerialAction &

p_dsSerialAction

)

[AI] Copy constructor.

Creates a deep copy from another MxDSSerialAction, including action list and cursor state.

Parameters

p_dsSerialAction

[AI] Source serial action to copy from.

Definition at line 42 of file mxdsserialaction.cpp.

~MxDSSerialAction()

MxDSSerialAction::~MxDSSerialAction ( )

override

[AI] Destructor.

Cleans up internal cursor.

Definition at line 26 of file mxdsserialaction.cpp.

Member Function Documentation

ClassName()

const char * MxDSSerialAction::ClassName ( ) const

inlineoverridevirtual

[AI] Gets the class name of this object.

[AI] Used for run-time type identification and class hierarchies. Returns "MxDSSerialAction".

Returns

Pointer to static string literal representing the class name. [AI]

Reimplemented from MxDSMultiAction.

Definition at line 52 of file mxdsserialaction.h.

Clone()

MxDSAction * MxDSSerialAction::Clone ( )

overridevirtual

[AI] Clones (deep copies) this serial action, including its list of contained actions and configuration.

Returns

A pointer to the duplicated serial action object. [AI]

Reimplemented from MxDSMultiAction.

Definition at line 62 of file mxdsserialaction.cpp.

CopyFrom()

void MxDSSerialAction::CopyFrom

(

MxDSSerialAction &

p_dsSerialAction

)

[AI] Copies the state of another MxDSSerialAction into this one, including duplication warnings if the source cursor is active.

[AI] Will log a warning if the source is currently being traversed or in use.

Parameters

p_dsSerialAction

[AI] Source serial action to copy from.

Definition at line 34 of file mxdsserialaction.cpp.

GetDuration()

MxLong MxDSSerialAction::GetDuration ( )

overridevirtual

[AI] Calculates and retrieves the total duration of this serial action.

[AI] If an explicit duration is set, returns that. Otherwise, computes the total by summing up each contained action's duration, their start times, and any media action sustain times.

Reimplemented from MxDSAction.

Definition at line 75 of file mxdsserialaction.cpp.

IsA()

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

inlineoverridevirtual

[AI] Checks if this class is of a given type or its parent types.

Parameters

p_name

[AI] Class name string to check against.

Return values

TRUE	if match for "MxDSSerialAction" or parent classes; FALSE otherwise. [AI]

Reimplemented from MxDSMultiAction.

Definition at line 63 of file mxdsserialaction.h.

operator=()

MxDSSerialAction & MxDSSerialAction::operator=

(

MxDSSerialAction &

p_dsSerialAction

)

[AI] Assignment operator.

Overwrites this serial action's state with another's.

Parameters

p_dsSerialAction

[AI] Source serial action to assign from.

Returns

Reference to this, now updated, object. [AI]

Definition at line 49 of file mxdsserialaction.cpp.

SetDuration()

void MxDSSerialAction::SetDuration ( MxLong  p_duration )

overridevirtual

[AI] Sets an explicit duration value for the entire serial action sequence.

If set, GetDuration() will return this value without computation.

Parameters

p_duration

[AI] New total duration (in gameplay ticks or ms, units engine-specific).

Reimplemented from MxDSAction.

Definition at line 19 of file mxdsserialaction.cpp.

---

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

• mxdsserialaction.h
• mxdsserialaction.cpp