Act3List Class Reference

[AI] A custom intrusive list for handling state machine or scheduled actions/events during Act 3 sequences. More...

#include <act3.h>

Inheritance diagram for Act3List:

Collaboration diagram for Act3List:

Public Member Functions
	Act3List ()
	[AI] Constructor, initializes the guarded flag to zero. More...
void	Insert (MxS32 p_objectId, MxS32 p_option)
	[AI] Inserts a new element, and conditionally triggers associated script actions or events depending on the queueing logic. More...
void	FUN_10071fa0 ()
	[AI] Internal removal method for the first element, wraps a deletion and triggers any necessary cleanup. More...
void	Clear ()
	[AI] Removes all elements, triggers associated clean-up actions, and stops background audio. More...
void	FUN_100720d0 (MxU32 p_objectId)
	[AI] Removes an element either by objectId or from the front of the list, and updates queue state bookkeeping. More...

Detailed Description

[AI] A custom intrusive list for handling state machine or scheduled actions/events during Act 3 sequences.

Used to hold and sequence various events such as playing sound, animation, activating or removing in-game objects as determined by scripts. SIZE 0x10

Definition at line 81 of file act3.h.

Constructor & Destructor Documentation

Act3List()

Act3List::Act3List ( )

inline

[AI] Constructor, initializes the guarded flag to zero.

Definition at line 86 of file act3.h.

Member Function Documentation

Clear()

void Act3List::Clear

(

)

[AI] Removes all elements, triggers associated clean-up actions, and stops background audio.

[AI] Call this to reset/clear scheduled or active actions and to halt background processes in Act 3 cutscenes.

Definition at line 154 of file act3.cpp.

FUN_10071fa0()

void Act3List::FUN_10071fa0

(

)

[AI] Internal removal method for the first element, wraps a deletion and triggers any necessary cleanup.

[AI] This corresponds to cleaning up audio/actions that were previously started.

Definition at line 148 of file act3.cpp.

FUN_100720d0()

void Act3List::FUN_100720d0

(

MxU32

p_objectId

)

[AI] Removes an element either by objectId or from the front of the list, and updates queue state bookkeeping.

Parameters

p_objectId

Object ID to remove, or if zero, removes the head. [AI]

[AI] Also reactivates or begins queued actions if others remain after removal.

Definition at line 176 of file act3.cpp.

Insert()

void Act3List::Insert	(	MxS32	p_objectId,
		MxS32	p_option
	)

[AI] Inserts a new element, and conditionally triggers associated script actions or events depending on the queueing logic.

Parameters

p_objectId	ID of the object or script action. [AI]
p_option	Queue type/option, determines logic branch. [AI]

[AI] Triggers events or actions according to the branching order for options 1, 2, 3, see source for details.

Parameters

p_objectId	[AI]
p_option	[AI]

[AI]

Definition at line 112 of file act3.cpp.

---

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

• act3.h
• act3.cpp