#include <game/bases/d_model_play_guide.hpp>

Inheritance diagram for dModelPlayGuide_c:

Description

The screen overlay for Hint Movies.

This is the border that appears around the screen during Hint Movies. It's spawned automatically by the stage scene (dScStage_c) when the game is in the Hint Movie mode.

Definition at line 12 of file d_model_play_guide.hpp.

Public Member Functions
	dModelPlayGuide_c ()
	Constructs a new base.
virtual	~dModelPlayGuide_c ()
	Destroys the base.
virtual int	create ()
	`do` method for the `create` operation.
virtual int	doDelete ()
	`do` method for the `delete` operation.
virtual int	preExecute ()
	`pre` method for the `execute` operation.
virtual int	execute ()
	`do` method for the `execute` operation.
virtual int	draw ()
	`do` method for the `draw` operation.
bool	createLayout ()
	Loads the resources and creates the layout for the base.
Public Member Functions inherited from dBase_c
	dBase_c ()
	Constructs a new base.
virtual int	preCreate ()
	`pre` method for the `create` operation.
virtual void	postCreate (fBase_c::MAIN_STATE_e status)
	`post` method for the `create` operation.
virtual int	preDelete ()
	`pre` method for the `delete` operation.
virtual void	postDelete (fBase_c::MAIN_STATE_e status)
	`post` method for the `delete` operation.
virtual void	postExecute (fBase_c::MAIN_STATE_e status)
	`post` method for the `execute` operation.
virtual int	preDraw ()
	`pre` method for the `draw` operation.
virtual void	postDraw (fBase_c::MAIN_STATE_e status)
	`post` method for the `draw` operation.
virtual	~dBase_c ()
	Destroys the base.
virtual const char *	getKindString () const
	Gets the base's kind string.
Public Member Functions inherited from fBase_c
	fBase_c ()
	Constructs a new base.
fBaseID_e	getID () const
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.

Public Attributes
LytBase_c	mLayout
	The layout of the overlay.
nw4r::lyt::Pane *	mpRootPane
	The root pane of the layout.
bool	mIsCreated
	If the layout has been successfully created.
Public Attributes inherited from fBase_c
fBaseID_e	mUniqueID
	The base's unique identifier.
u32	mParam
	A bitfield that configures the base's behaviour. Its usage varies from profile to profile.
ProfileName	mProfName
	The base's profile name.

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 , ENEMY }
	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 = BIT_FLAG(0) , DISABLE_EXECUTE = BIT_FLAG(1) , ROOT_DISABLE_DRAW = BIT_FLAG(2) , DISABLE_DRAW = BIT_FLAG(3) }
	Controls if the `execute` and `draw` operations should be skipped. More...
Static Public Member Functions inherited from dBase_c
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 ()
	Sets the callbacks for the scrapped relocatable profile system.
static dBase_c *	createBase (ProfileName profName, dBase_c *parent, unsigned long param, u8 groupType)
	Creates a child base under the given parent.
static dBase_c *	createRoot (ProfileName profName, unsigned long param, u8 groupType)
	Creates a root base.
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.
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 void	deleteReady ()
	Informs the base that it's about to be deleted.
virtual bool	entryFrmHeap (unsigned long size, EGG::Heap *parentHeap)
	Creates a heap of the given size for the base.
virtual bool	entryFrmHeapNonAdjust (unsigned long size, EGG::Heap *parentHeap)
	Creates a heap of the given size for the base.
virtual bool	createHeap ()
	[Does nothing].
virtual	~fBase_c ()
	Destroys the base.
Protected Attributes inherited from dBase_c
const char *	mpKindString
	The base's kind string.
const char *	mpNameString
	The base's profile name string.
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 `delete` 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.
fArcLoad_c *	mpArcList
	See Unused Content.
fLiMgBa_c	mBaseLinks
	See Unused Content.
EGG::FrmHeap *	mHeap
	The base's dedicated heap.
Static Protected Attributes inherited from fBase_c
static int(*	sLoadAsyncCallback )()
	See Unused Content.
static void(*	sUnloadCallback )()
	See Unused Content.

Constructor & Destructor Documentation

◆ dModelPlayGuide_c()

dModelPlayGuide_c::dModelPlayGuide_c ( )

Constructs a new base.

Definition at line 9 of file d_model_play_guide.cpp.

◆ ~dModelPlayGuide_c()

dModelPlayGuide_c::~dModelPlayGuide_c ( )

virtual

Destroys the base.

Definition at line 11 of file d_model_play_guide.cpp.

Member Function Documentation

◆ create()

int dModelPlayGuide_c::create ( )

virtual

do method for the create operation.

Returns: A PACK_RESULT_e value.

Reimplemented from fBase_c.

Definition at line 13 of file d_model_play_guide.cpp.

◆ doDelete()

int dModelPlayGuide_c::doDelete ( )

virtual

do method for the delete operation.

This method was renamed due to conflict with the delete C++ keyword.

Returns: A PACK_RESULT_e value.

Reimplemented from fBase_c.

Definition at line 69 of file d_model_play_guide.cpp.

◆ preExecute()

int dModelPlayGuide_c::preExecute ( )

virtual

pre method for the execute operation.

Returns: A PACK_RESULT_e value.

Reimplemented from dBase_c.

Definition at line 45 of file d_model_play_guide.cpp.

◆ execute()

int dModelPlayGuide_c::execute ( )

virtual

do method for the execute operation.

Returns: A PACK_RESULT_e value.

Reimplemented from fBase_c.

Definition at line 53 of file d_model_play_guide.cpp.

◆ draw()

int dModelPlayGuide_c::draw ( )

virtual

do method for the draw operation.

Returns: A PACK_RESULT_e value.

Reimplemented from fBase_c.

Definition at line 61 of file d_model_play_guide.cpp.

◆ createLayout()

bool dModelPlayGuide_c::createLayout ( )

Loads the resources and creates the layout for the base.

Returns: If the creation was successful.

Definition at line 29 of file d_model_play_guide.cpp.

Member Data Documentation

◆ mLayout

LytBase_c dModelPlayGuide_c::mLayout

The layout of the overlay.

Definition at line 26 of file d_model_play_guide.hpp.

◆ mpRootPane

nw4r::lyt::Pane* dModelPlayGuide_c::mpRootPane

The root pane of the layout.

Definition at line 27 of file d_model_play_guide.hpp.

◆ mIsCreated

bool dModelPlayGuide_c::mIsCreated

If the layout has been successfully created.

Definition at line 28 of file d_model_play_guide.hpp.

Description

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ dModelPlayGuide_c()

◆ ~dModelPlayGuide_c()

Member Function Documentation

◆ create()

◆ doDelete()

◆ preExecute()

◆ execute()

◆ draw()

◆ createLayout()

Member Data Documentation

◆ mLayout

◆ mpRootPane

◆ mIsCreated