#include <game/bases/d_s_restart_crsin.hpp>

Inheritance diagram for dScRestartCrsin_c:

Description

This scene is used to "restart" levels.

It is used for the following purposes:

Returning to Peach's Castle after a Hint Movie ends.
Starting the title screen stage.

Definition at line 12 of file d_s_restart_crsin.hpp.

Public Member Functions
	dScRestartCrsin_c ()
	Creates a new scene.
virtual	~dScRestartCrsin_c ()
	Destroys the scene.
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.
Public Member Functions inherited from dScene_c
	dScene_c ()
	Creates a new scene.
	~dScene_c ()
	Destroys the scene.
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.
Public Member Functions inherited from dBase_c
	dBase_c ()
	Constructs a new base.
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.

Static Public Member Functions
static void	startTitle (u8 isReplay, bool forceChange)
	Starts the title screen stage or a title replay.
static void	reStartPeachCastle ()
	Starts the Peach's Castle stage.
Static Public Member Functions inherited from dScene_c
static void	setStartScene ()
	Sets up the scene to be shown when the game boots up.
static void	setResetScene ()
	Sets up the scene to be shown after a game reset.
static dScene_c *	createNextScene ()
	Creates and returns a root base for the next scene.
static void	setNextScene (ProfileName nextScene, unsigned long param, bool forceChange)
	Attempts to prepare the transition to a new scene.
static void	setFadeInFrame (unsigned short length)
	Sets the duration of the next fade-in transition to `length`.
static void	setFadeOutFrame (unsigned short length)
	Sets the duration of the next fade-out transition to `length`.
static void	setFadeInOutFrame (unsigned short length)
	Sets the duration of the next fade-in and fade-out transitions to `length`.
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.

Static Public Attributes
static dInfo_c::StartGameInfo_s	m_startGameInfo
	Info used to start a level.
Static Public Attributes inherited from dScene_c
static u32	mPara
	The parameters for the next scene.
static ProfileName	m_nextScene = fProf::INVALID
	The profile name of the next scene.
static ProfileName	m_nowScene = fProf::INVALID
	The profile name of the current scene.
static ProfileName	m_oldScene = fProf::INVALID
	The profile name of the previous scene.
static bool	m_otherSceneFlg = true
	Whether the next scene has already been created.
static u16	m_fadeInFrame = 30
	The duration of the next fade-in.
static u16	m_fadeOutFrame = 30
	The duration of the next fade-out.
static bool	m_isAutoFadeIn = true
	If a fade-in should automatically be performed on scene load.

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...
Public Attributes inherited from dScene_c
sPhase_c *	mpPhase
	The phase used for scene initialization.
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.
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

◆ dScRestartCrsin_c()

dScRestartCrsin_c::dScRestartCrsin_c ( )

Creates a new scene.

Definition at line 9 of file d_s_restart_crsin.cpp.

◆ ~dScRestartCrsin_c()

dScRestartCrsin_c::~dScRestartCrsin_c ( )

virtual

Destroys the scene.

Definition at line 11 of file d_s_restart_crsin.cpp.

Member Function Documentation

◆ create()

int dScRestartCrsin_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_s_restart_crsin.cpp.

◆ doDelete()

int dScRestartCrsin_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 38 of file d_s_restart_crsin.cpp.

◆ preExecute()

int dScRestartCrsin_c::preExecute ( )

virtual

pre method for the execute operation.

If m_nextScene is set, prepares to transition to the next scene. Once all initial child bases have been added, the execute and draw operations are enabled on this base and its children.

Reimplemented from dScene_c.

Definition at line 29 of file d_s_restart_crsin.cpp.

◆ execute()

int dScRestartCrsin_c::execute ( )

virtual

do method for the execute operation.

Returns: A PACK_RESULT_e value.

Reimplemented from fBase_c.

Definition at line 33 of file d_s_restart_crsin.cpp.

◆ draw()

int dScRestartCrsin_c::draw ( )

virtual

do method for the draw operation.

Returns: A PACK_RESULT_e value.

Reimplemented from fBase_c.

Definition at line 45 of file d_s_restart_crsin.cpp.

◆ startTitle()

void dScRestartCrsin_c::startTitle	(	u8	isReplay,
		bool	forceChange )

static

Starts the title screen stage or a title replay.

Parameters

isReplay	Whether it will start a random replay or the title screen.
forceChange	If the scene transition should always be performed.

Definition at line 7 of file d_s_restart_crsin_static.cpp.

◆ reStartPeachCastle()

void dScRestartCrsin_c::reStartPeachCastle ( )

static

Starts the Peach's Castle stage.

Definition at line 48 of file d_s_restart_crsin_static.cpp.

Member Data Documentation

◆ m_startGameInfo

dInfo_c::StartGameInfo_s dScRestartCrsin_c::m_startGameInfo

static

Info used to start a level.

Definition at line 31 of file d_s_restart_crsin.hpp.

Description

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ dScRestartCrsin_c()

◆ ~dScRestartCrsin_c()

Member Function Documentation

◆ create()

◆ doDelete()

◆ preExecute()

◆ execute()

◆ draw()

◆ startTitle()

◆ reStartPeachCastle()

Member Data Documentation

◆ m_startGameInfo