NameObj Class Reference

The most basic form of an object. More...

#include <NameObj.hpp>

Inheritance diagram for NameObj:

Public Member Functions
	NameObj (const char *pName)
	Constructs a new NameObj instance.
virtual void	init (const JMapInfoIter &rIter)
	Intializes the NameObj and can set various settings and construct necessary classes.
virtual void	initAfterPlacement ()
virtual void	movement ()
virtual void	draw () const
	Draws the object. Does nothing until overridden.
virtual void	calcAnim ()
virtual void	calcViewAndEntry ()
void	initWithoutIter ()
	Initializes a NameObj without a JMapInfoIter instance.
void	setName (const char *pName)
	Sets the NameObj's mName.
void	executeMovement ()
void	requestSuspend ()
void	requestResume ()
void	syncWithFlags ()

Public Attributes
const char *	mName
	A string to identify the NameObj.
volatile u16	mFlags
	Flags in relation to movement.
s16	mExecutorIdx
	The index into the NameObjExecuteInfo array.

Detailed Description

The most basic form of an object.

Definition at line 11 of file NameObj.hpp.

Constructor & Destructor Documentation

NameObj()

NameObj::NameObj

(

const char *

pName

)

Constructs a new NameObj instance.

Parameters

pName

The new name assigned to the NameObj.

Definition at line 6 of file NameObj.cpp.

~NameObj()

NameObj::~NameObj ( )

virtual

Definition at line 13 of file NameObj.cpp.

Member Function Documentation

init()

void NameObj::init ( const JMapInfoIter & rIter )

virtual

Intializes the NameObj and can set various settings and construct necessary classes.

Parameters

rIter

A reference to the JMapInfoIter that supplies BCSV information.

Reimplemented in AreaObj, AreaObjContainer, AstroChangeStageCube, AudioEffectArea, BgmProhibitArea, BigBubbleGoalArea, BloomArea, ChangeBgmCube, AreaPolygon, CollisionArea, CubeCameraArea, DeathArea, DepthOfFieldArea, GlaringLightArea, HazeCube, LightArea, MercatorTransformCube, MessageArea, PlayerSeArea, RestartCube, ScreenBlurArea, SimpleBloomArea, SoundEmitterCube, SoundEmitterSphere, SpinGuidanceArea, SwitchArea, WarpCube, WaterArea, SkeletalFishBabyRail, SkeletalFishBoss, SkeletalFishBossScarFlash, SkeletalFishBossInfo, SkeletalFishBossRail, SkeletalFishGuard, CameraDirector, CameraMan, CameraManEvent, CameraManGame, CameraManPause, CameraManSubjective, CameraTargetObj, DemoCastGroup, PackunPetit, ClippingJudge, MsgSharedGroup, LiveActorGroupArray, MessageSensorHolder, MirrorActor, MirrorCamera, MirrorReflectionModel, ModelObj, ModelObjNpc, PartsModel, SensorHitChecker, Air, CollisionDirector, FileSelectEffect, Halo, PowerStarHalo, LightDirector, OceanRing, OceanRingBloomDrawer, PlayerRacer, RaceRail, ScenarioSelectStar, SeaGull, SeaGullGroup, Sky, SpaceInner, SphereSelector, TimerSwitch, AirBubble, AirBubbleGenerator, AirBubbleHolder, AnmModelObj, ArrowSwitch, ArrowSwitchTarget, ArrowSwitchMulti, AssemblyBlock, BallRail, BeeFlowerHover, BenefitItemInvincible, BenefitItemLifeUp, BenefitItemObj, BigBubbleMoveLimitter, BigFan, BlackHole, BreakableCage, CapsuleCage, ChipBase, ChipCounter, ChooChooTrain, CocoNut, CoconutTree, Coin, CoinBox, CoinGroup, CoinHolder, CoinReplica, CoinSpot, CollapsePlane, CollectCounter, CollisionBlocker, CrystalCage, CrystalCageMoving, CrystalSwitch, CutBushModelObj, DashRing, DeadLeaves, DynamicCollisionObj, FireBarBall, FireBar, FirePressure, FirePressureBullet, FirePressureBulletHolder, FlipPanel, FlipPanelObserver, FloaterFloatingForce, FloaterFloatingForceTypeNormal, Fountain, FountainBig, GeneralMapParts, GreenCaterpillarBigBody, GreenCaterpillarBig, HatchWaterPlanet, HipDropMoveObj, IceStep, ItemAppearStone, ItemBlock, KeySwitch, KillerGunnerSingle, LargeChain, LavaBallRisingPlanetLava, MagicBell, ManholeCover, MapObjActor, MapParts, MapPartsAppearController, MapPartsFloatingForce, MapPartsFunction, MapPartsRailGuideDrawer, MapPartsRailGuideHolder, MapPartsRailGuidePoint, MapPartsRailMover, MapPartsRailPosture, MapPartsRailRotator, MapPartsRotator, MarblePlanet, MarblePlanetElectron, MarblePlanetElectronShadow, MechaKoopaPartsArm, MechaKoopaPartsHead, NoteGroup, Note, NoteFairy, PowerStar, PowerStarAppearPoint, PowerStarHolder, PressureMessenger, PressureBase, PunchingKinoko, PurpleCoinStarter, RailMoveObj, RailMoveObjPress, RailMoveObjSwitchShadow, RailDemoMoveObj, ReverseGravityRoomPlanet, RotateMoveObj, SandCapsuleInsidePlanet, ShootingStar, SimpleMapObj, SimpleEnvironmentObj, SimpleMapObjFarMax, SimpleSeesawObj, SimpleMirrorObj, SimpleMirrorReflectionObj, UFOKinokoUnderConstruction, SimpleTimerObj, SnowplowSwitch, SpaceMine, SphereRailDash, SpinDriver, SpinDriverOperateRing, SpinDriverPathDrawer, SubmarineVolcanoBigColumn, Sun, SuperSpinDriver, TimeAppearObj, TreasureBoxCracked, TreasureSpot, UFOKinoko, WatchTowerRotateStep, WaterPressureBullet, WaterPressureBulletHolder, WoodBox, NPCActor, TalkDirector, MarioActor, MultiSceneActor, StageDataHolder, BackButton, CoinCounter, GalaxyNamePlate, IconAButton, IconComet, PlayerActionGuidance, ScenarioSelectLayout, StarPieceCounter, SubMeterLayout, SurfingGuidance, Poihana, GlobalGravityObj, PlanetGravityManager, MarioLauncherAttractor, PTimerSwitch, SwitchBox, and LiveActor.

Definition at line 17 of file NameObj.cpp.

initAfterPlacement()

void NameObj::initAfterPlacement ( )

virtual

Definition at line 21 of file NameObj.cpp.

movement()

void NameObj::movement ( )

virtual

Definition at line 25 of file NameObj.cpp.

draw()

void NameObj::draw ( ) const

virtual

Draws the object. Does nothing until overridden.

Reimplemented in BigBubbleGoalArea, WarpCube, CameraCover, ShadowVolumeBox, ShadowVolumeDrawer, VolumeModelDrawer, OceanRing, OceanRingBloomDrawer, DashRing, NormalMapBase, SpinDriverPathDrawer, NameObjAdaptor, CaptureScreenActor, LayoutActor, ScenarioSelectLayout, and ScreenPreserver.

Definition at line 29 of file NameObj.cpp.

calcAnim()

void NameObj::calcAnim ( )

virtual

Definition at line 33 of file NameObj.cpp.

calcViewAndEntry()

void NameObj::calcViewAndEntry ( )

virtual

Definition at line 37 of file NameObj.cpp.

initWithoutIter()

void NameObj::initWithoutIter

(

)

Initializes a NameObj without a JMapInfoIter instance.

Definition at line 41 of file NameObj.cpp.

setName()

void NameObj::setName

(

const char *

pName

)

Sets the NameObj's mName.

Parameters

pName

The new name assigned to the NameObj.

Definition at line 48 of file NameObj.cpp.

executeMovement()

void NameObj::executeMovement

(

)

Definition at line 52 of file NameObj.cpp.

requestSuspend()

void NameObj::requestSuspend

(

)

Definition at line 58 of file NameObj.cpp.

requestResume()

void NameObj::requestResume

(

)

Definition at line 66 of file NameObj.cpp.

syncWithFlags()

void NameObj::syncWithFlags

(

)

Definition at line 74 of file NameObj.cpp.

Member Data Documentation

mName

const char* NameObj::mName

A string to identify the NameObj.

Definition at line 38 of file NameObj.hpp.

mFlags

volatile u16 NameObj::mFlags

Flags in relation to movement.

Definition at line 39 of file NameObj.hpp.

mExecutorIdx

s16 NameObj::mExecutorIdx

The index into the NameObjExecuteInfo array.

Definition at line 40 of file NameObj.hpp.