Burger::Flash::BaseExecute Class Reference

Execution base class. More...

Inheritance diagram for Burger::Flash::BaseExecute:

Collaboration diagram for Burger::Flash::BaseExecute:

Public Member Functions
const Burger::StaticRTTI *	get_StaticRTTI (void) const noexcept override
	Get the description to the class.
	BaseExecute ()
	Default constructor.
virtual	~BaseExecute ()
	Default destructor.
virtual void	Execute (CharacterObject *pObject)
	Execute action.
virtual void	ExecuteState (CharacterObject *pObject)
	Execute state change.
virtual void	ExecuteStateReverse (CharacterObject *pObject, uint_t uFrame)
	Execute state change based in frame number.
virtual uint32_t	GetDepthIDOfReplaceOrAddTag (void) const
	Get the depth value and ID.
Public Member Functions inherited from Burger::Base
const char *	get_class_name (void) const noexcept
	Get the name of the class.
virtual	~Base () noexcept=default
	Destructor.

Static Public Attributes
static const Burger::StaticRTTI	g_StaticRTTI
	The global description of the class.
Static Public Attributes inherited from Burger::Base
static const Burger::StaticRTTI	g_StaticRTTI
	The global description of the class.

Detailed Description

Execution base class.

---

Execute tags include things that control the operation of the Flash movie. Essentially, these are the events associated with a frame.

Constructor & Destructor Documentation

BaseExecute()

Burger::Flash::BaseExecute::BaseExecute ( )

inline

Default constructor.

---

Assigns default functions for everything that wasn't taken control of in a derived class.

~BaseExecute()

Burger::Flash::BaseExecute::~BaseExecute ( )

virtual

Default destructor.

---

Doesn't do anything. Look at the derived classes for any actions

Member Function Documentation

Execute()

void Burger::Flash::BaseExecute::Execute ( CharacterObject * pObject )

virtual

Execute action.

---

Perform the action

Parameters

pObject

Pointer to an object to perform the action on

ExecuteState()

void Burger::Flash::BaseExecute::ExecuteState ( CharacterObject * pObject )

virtual

Execute state change.

---

Perform a state change

Parameters

pObject

Pointer to an object to perform the state change on

ExecuteStateReverse()

void Burger::Flash::BaseExecute::ExecuteStateReverse ( CharacterObject * pObject, uint_t uFrame )

virtual

Execute state change based in frame number.

---

Revert a state change that was a specific frame in the movie

Parameters

pObject	Pointer to an object to perform the state change on
uFrame	Frame number to base the state change on

get_StaticRTTI()

const Burger::StaticRTTI * Burger::Flash::BaseExecute::get_StaticRTTI ( void ) const

overridevirtualnoexcept

Get the description to the class.

---

This virtual function will pull the pointer to the StaticRTTI instance that has the name of the class. Due to it being virtual, it will be the name of the most derived class.

Returns

Pointer to a global, read only instance of StaticRTTI for the true class

Reimplemented from Burger::Base.

GetDepthIDOfReplaceOrAddTag()

uint32_t Burger::Flash::BaseExecute::GetDepthIDOfReplaceOrAddTag ( void ) const

virtual

Get the depth value and ID.

---

If there is an ID, return the depth of recursion in the upper 16 bit and the ID in the lower 16 bits.

Return BURGER_MAXUINT this value is not applicable.

Returns

Depth in the upper 16 bits, ID in the lower 16 bits or BURGER_MAXUINT

Member Data Documentation

g_StaticRTTI

const Burger::StaticRTTI Burger::Flash::BaseExecute::g_StaticRTTI

static

The global description of the class.

---

This record contains the name of this class and a reference to the parent