dScStage_c Class Reference

Inheritance diagram for dScStage_c:

Description

Definition at line 7 of file d_s_stage.hpp.

Public Types
enum	LOOP_TYPE_e {   LOOP_NONE ,   LOOP_EDGES ,   LOOP_SECTION ,   LOOP_COUNT }
	The possible stage loop types. More...
typedef void(*	changePosFunc) (mVec3_c *)
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 = 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
static float	getLoopPosX (float x)
static void	setChangePosFunc (int)
static void	setTitleReplayRandomTable ()
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.

Public Attributes
char	pad [0x119a]
u8	mCurrFile
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.

Static Public Attributes
static int	m_loopType
static int	mCollectionCoin [STAR_COIN_COUNT]
static const char	mCdArcName []
static bool	m_isCourseOut
	Whether the game is transitioning from a stage scene to a non-stage scene.
static bool	m_KoopaJrEscape
static changePosFunc	changePos
static dScStage_c *	m_instance
Static Public Attributes inherited from dScene_c
static u32	mPara
	The parameters for the next scene.
static ProfileName	m_nextScene = fProfile::INVALID
	The profile name of the next scene.
static ProfileName	m_nowScene = fProfile::INVALID
	The profile name of the current scene.
static ProfileName	m_oldScene = fProfile::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 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 int	preExecute ()
	pre method for the execute 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.
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.
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	doDelete ()
	do method for the delete operation.
virtual int	execute ()
	do method for the execute operation.
virtual int	draw ()
	do 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)
	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.
fBaHelper_c *	mpUnusedHelper
	See Unused Content.
fLiMgBa_c	mUnusedList
	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.

Member Typedef Documentation

changePosFunc

typedef void(* dScStage_c::changePosFunc) (mVec3_c *)

Definition at line 30 of file d_s_stage.hpp.

Member Enumeration Documentation

LOOP_TYPE_e

enum dScStage_c::LOOP_TYPE_e

The possible stage loop types.

Enumerator
LOOP_NONE	No stage looping occurs.
LOOP_EDGES	The stage loops around on the zone edges. Only works for specific zone sizes.
LOOP_SECTION	The stage loops in specific sections.

Definition at line 11 of file d_s_stage.hpp.

Member Data Documentation

pad

char dScStage_c::pad[0x119a]

Definition at line 18 of file d_s_stage.hpp.

mCurrFile

u8 dScStage_c::mCurrFile

Definition at line 19 of file d_s_stage.hpp.

m_loopType

int dScStage_c::m_loopType

static

Definition at line 22 of file d_s_stage.hpp.

mCollectionCoin

int dScStage_c::mCollectionCoin[STAR_COIN_COUNT]

static

Definition at line 23 of file d_s_stage.hpp.

mCdArcName

const char dScStage_c::mCdArcName[]

static

Definition at line 25 of file d_s_stage.hpp.

m_isCourseOut

bool dScStage_c::m_isCourseOut

static

Whether the game is transitioning from a stage scene to a non-stage scene.

Definition at line 27 of file d_s_stage.hpp.

m_KoopaJrEscape

bool dScStage_c::m_KoopaJrEscape

static

Definition at line 28 of file d_s_stage.hpp.

changePos

changePosFunc dScStage_c::changePos

static

Definition at line 35 of file d_s_stage.hpp.

m_instance

dScStage_c* dScStage_c::m_instance

static

Definition at line 36 of file d_s_stage.hpp.