#include <dol/bases/d_base.hpp>

Inheritance diagram for dBase_c:

Description

An extension of fBase_c with base kind and name strings.

All bases should inherit from this class, not from fBase_c.

Definition at line 9 of file d_base.hpp.

Public Member Functions
virtual int	preCreate ()
	See fBase_c::preCreate.

virtual void	postCreate (fBase_c::MAIN_STATE_e status)
	See fBase_c::postCreate.

virtual int	preDelete ()
	See fBase_c::preDelete.

virtual void	postDelete (fBase_c::MAIN_STATE_e status)
	See fBase_c::postDelete.

virtual int	preExecute ()
	Code to be executed before execute.

virtual void	postExecute (fBase_c::MAIN_STATE_e status)
	See fBase_c::postExecute.

virtual int	preDraw ()
	Code to be executed before draw.

virtual void	postDraw (fBase_c::MAIN_STATE_e status)
	See fBase_c::postDraw.

virtual const char *	getKindString () const
	Gets a string describing the kind of this base.

Public Member Functions inherited from fBase_c
	fBase_c ()
	Constructs a new base.

void	deleteRequest ()
	Requests deletion of the base.

fBase_c *	getConnectParent () const
	Gets the base's parent.

fBase_c *	getConnectChild () const
	Gets the base's first child.

fBase_c *	getConnectBrNext () const
	Gets the base's next sibling.

bool	checkChildProcessCreateState () const
	Checks if the base has at least one child in the CREATING state.

Public Member Functions inherited from cOwnerSetMg_c
	cOwnerSetMg_c ()
	Constructs a new set container.

	~cOwnerSetMg_c ()
	Destroys the set.

void	add (cOwnerSetNd_c nd, void owner)
	Adds a node to the set.

void	remove (cOwnerSetNd_c nd, void owner)
	Removes a node from the set.

Static Public Member Functions
static dBase_c *	searchBaseByProfName (ProfileName profile, const dBase_c *parent)
	Searches for a base with a given profile name, optionally under a given parent.

static void	initLoader ()
	[Unknown purpose. Callbacks do nothing and don't seem to ever be called].

static dBase_c *	createBase (ProfileName profName, dBase_c *parent, unsigned long param, u8 groupType)
	See fBase_c::createChild.

static dBase_c *	createRoot (ProfileName profName, unsigned long param, u8 groupType)
	See fBase_c::createRoot.

Static Public Member Functions inherited from fBase_c
static void *	operator new (size_t)
	`new` operator override for all bases.

static void	operator delete (void *)
	`delete` operator override for all bases.

static fBase_c *	createChild (ProfileName profName, fBase_c *parent, unsigned long param, u8 groupType)
	Creates a child base under the given parent.

static fBase_c *	createRoot (ProfileName profName, unsigned long param, u8 groupType)
	Creates a root base.

Static Private Member Functions
static int	loadAsyncCallback ()
	[Unused]. [Does nothing].

static void	unloadCallback ()
	[Unused]. [Does nothing].

Private Attributes
const char *	mpKindString
	[Unused]. A string describing the kind of this base.

const char *	mpNameString
	[Unused]. A string representing the name of the profile this base belongs to.

Additional Inherited Members
Public Types inherited from fBase_c
enum	LIFECYCLE_e { CREATING , ACTIVE , DELETING }
	The possible lifecycle states. More...

enum	GROUP_TYPE_e { OTHER , SCENE , ACTOR }
	The possible group types. More...

enum	MAIN_STATE_e { CANCELED , ERROR , SUCCESS , WAITING }
	The possible operation results. More...

enum	PACK_RESULT_e { NOT_READY , SUCCEEDED , FAILED }
	The possible operation step results. More...

enum	PROC_DISABLE_e { ROOT_DISABLE_EXECUTE = 1 , DISABLE_EXECUTE = 2 , ROOT_DISABLE_DRAW = 4 , DISABLE_DRAW = 8 }
	Controls if the `execute` and `draw` operations should be skipped. More...

Public Attributes inherited from fBase_c
fBaseID_e	mUniqueID
	The base's unique identifier.

u32	mParam
	A bitfield that configures the base's behaviour. [Represents nybbles 5 to 12 of Reggie's spritedata].

ProfileName	mProfName
	The base's profile name.

Protected Member Functions inherited from fBase_c
bool	isProcControlFlag (u8 flag) const
	Checks if a flag is set in mProcControl.

void	setProcControlFlag (u8 flag)
	Sets a flag in mProcControl.

void	clearProcControlFlag (u8 flag)
	Clears a flag in mProcControl.

virtual int	create ()
	`do` method for the `create` operation.

virtual int	preCreate ()
	`pre` method for the `create` operation.

virtual void	postCreate (MAIN_STATE_e state)
	`post` method for the `create` operation.

virtual int	doDelete ()
	`do` method for the `delete` operation.

virtual int	preDelete ()
	`pre` method for the `delete` operation.

virtual void	postDelete (MAIN_STATE_e state)
	`post` method for the `delete` operation.

virtual int	execute ()
	`do` method for the `execute` operation.

virtual int	preExecute ()
	`pre` method for the `execute` operation.

virtual void	postExecute (MAIN_STATE_e state)
	`post` method for the `execute` operation.

virtual int	draw ()
	`do` method for the `draw` operation.

virtual int	preDraw ()
	`pre` method for the `draw` operation.

virtual void	postDraw (MAIN_STATE_e state)
	`post` method for the `draw` operation.

virtual void	deleteReady ()
	Informs the base that it's about to be deleted.

virtual bool	entryFrmHeap (unsigned long size, EGG::Heap *parentHeap)
	[Unused]. Creates a heap of the given size for the base.

virtual bool	entryFrmHeapNonAdjust (unsigned long size, EGG::Heap *parentHeap)
	[Unused]. Creates a heap of the given size for the base.

virtual bool	createHeap ()
	[Unused]. [Does nothing].

virtual	~fBase_c ()
	Destroys the base.

Protected Attributes inherited from fBase_c
u8	mLifecycleState
	The base's lifecycle state. Value is a LIFECYCLE_e.

bool	mDeleteRequested
	If deletion of the base was requested, but the corresponding operation has not been scheduled yet.

bool	mDeferExecute
	If the `create` operation was completed, but scheduling the `execute` and `draw` operations isn't possible at this time.

bool	mDeferRetryCreate
	If the `create` operation has not been completed, and rescheduling it isn't possible at this time.

u8	mGroupType
	The base's group type. Value is a GROUP_TYPE_e.

u8	mProcControl
	The operations to be skipped. Value is a PROC_DISABLE_e.

fManager_c	mMng
	The base's process manager.

fBaHelper_c *	mpUnusedHelper
	[Unused]. See Unused Content.

fLiMgBa_c	mUnusedList
	[Unused]. See Unused Content.

EGG::FrmHeap *	mpHeap
	[Unused]. The base's dedicated heap.

Static Protected Attributes inherited from fBase_c
static int(*	sLoadAsyncCallback )()
	[Unused]. See Unused Content.

static void(*	sUnloadCallback )()
	[Unused]. See Unused Content.

Constructor & Destructor Documentation

◆ dBase_c()

dBase_c::dBase_c ( )

Definition at line 12 of file d_base.cpp.

◆ ~dBase_c()

dBase_c::~dBase_c ( )

virtual

Definition at line 16 of file d_base.cpp.

Member Function Documentation

◆ preCreate()

int dBase_c::preCreate ( )

virtual

See fBase_c::preCreate.

Reimplemented from fBase_c.

Reimplemented in dBaseActor_c, and dScene_c.

Definition at line 37 of file d_base.cpp.

◆ postCreate()

void dBase_c::postCreate ( fBase_c::MAIN_STATE_e status )

virtual

See fBase_c::postCreate.

Reimplemented from fBase_c.

Reimplemented in dBaseActor_c, and dScene_c.

Definition at line 41 of file d_base.cpp.

◆ preDelete()

int dBase_c::preDelete ( )

virtual

See fBase_c::preDelete.

Reimplemented from fBase_c.

Reimplemented in dBaseActor_c, and dScene_c.

Definition at line 45 of file d_base.cpp.

◆ postDelete()

void dBase_c::postDelete ( fBase_c::MAIN_STATE_e status )

virtual

See fBase_c::postDelete.

Reimplemented from fBase_c.

Reimplemented in dBaseActor_c, and dScene_c.

Definition at line 49 of file d_base.cpp.

◆ preExecute()

int dBase_c::preExecute ( )

virtual

Code to be executed before execute.

[The function obtains the kind string for no reason, before passing execution to the base class].

Reimplemented from fBase_c.

Reimplemented in dBaseActor_c, and dScene_c.

Definition at line 53 of file d_base.cpp.

◆ postExecute()

void dBase_c::postExecute ( fBase_c::MAIN_STATE_e status )

virtual

See fBase_c::postExecute.

Reimplemented from fBase_c.

Reimplemented in dBaseActor_c, and dScene_c.

Definition at line 58 of file d_base.cpp.

◆ preDraw()

int dBase_c::preDraw ( )

virtual

Code to be executed before draw.

[The function calculates g_basesRandomSeed for no reason before passing execution to the base class].

Reimplemented from fBase_c.

Reimplemented in dBaseActor_c, and dScene_c.

Definition at line 62 of file d_base.cpp.

◆ postDraw()

void dBase_c::postDraw ( fBase_c::MAIN_STATE_e status )

virtual

See fBase_c::postDraw.

Reimplemented from fBase_c.

Reimplemented in dBaseActor_c, and dScene_c.

Definition at line 67 of file d_base.cpp.

◆ getKindString()

const char * dBase_c::getKindString ( ) const

virtual

Gets a string describing the kind of this base.

Definition at line 71 of file d_base.cpp.

◆ searchBaseByProfName()

dBase_c * dBase_c::searchBaseByProfName	(	ProfileName	profile,
		const dBase_c *	parent
	)

static

Searches for a base with a given profile name, optionally under a given parent.

[This calls fTrMgBa_c::searchNodeByProfName internally].

Definition at line 18 of file d_base.cpp.

◆ initLoader()

void dBase_c::initLoader ( )

static

[Unknown purpose. Callbacks do nothing and don't seem to ever be called].

Definition at line 82 of file d_base.cpp.

◆ createBase()

dBase_c * dBase_c::createBase	(	ProfileName	profName,
		dBase_c *	parent,
		unsigned long	param,
		u8	groupType
	)

static

See fBase_c::createChild.

Definition at line 87 of file d_base.cpp.

◆ createRoot()

dBase_c * dBase_c::createRoot	(	ProfileName	profName,
		unsigned long	param,
		u8	groupType
	)

static

See fBase_c::createRoot.

Definition at line 91 of file d_base.cpp.

◆ loadAsyncCallback()

int dBase_c::loadAsyncCallback ( )

staticprivate

[Unused]. [Does nothing].

Note: Unofficial name.

Definition at line 75 of file d_base.cpp.

◆ unloadCallback()

void dBase_c::unloadCallback ( )

staticprivate

[Unused]. [Does nothing].

Note: Unofficial name.

Definition at line 79 of file d_base.cpp.

Member Data Documentation

◆ mpKindString

const char* dBase_c::mpKindString

private

[Unused]. A string describing the kind of this base.

Definition at line 48 of file d_base.hpp.

◆ mpNameString

const char* dBase_c::mpNameString

private

[Unused]. A string representing the name of the profile this base belongs to.

Definition at line 49 of file d_base.hpp.

Description

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ dBase_c()

◆ ~dBase_c()

Member Function Documentation

◆ preCreate()

◆ postCreate()

◆ preDelete()

◆ postDelete()

◆ preExecute()

◆ postExecute()

◆ preDraw()

◆ postDraw()

◆ getKindString()

◆ searchBaseByProfName()

◆ initLoader()

◆ createBase()

◆ createRoot()

◆ loadAsyncCallback()

◆ unloadCallback()

Member Data Documentation

◆ mpKindString

◆ mpNameString