SuperTuxKart
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
WorldWithRank Class Reference

A WorldWithRank is a world where the karts are ranked. More...

#include <world_with_rank.hpp>

Inheritance diagram for WorldWithRank:
Inheritance graph
[legend]

Public Member Functions

virtual void init () OVERRIDE
 call just after instanciating. More...
 
virtual void reset (bool restart=false) OVERRIDE
 This function is called before a race is started (i.e. More...
 
bool displayRank () const
 
void beginSetKartPositions ()
 This function must be called before starting to set all kart positions again. More...
 
bool setKartPosition (unsigned int kart_id, unsigned int position)
 Sets the position of a kart. More...
 
void endSetKartPositions ()
 Called once the last position was set. More...
 
AbstractKartgetKartAtPosition (unsigned int p) const
 Returns the kart with a given position. More...
 
virtual int getScoreForPosition (int p)
 Returns the number of points for a kart at a specified position. More...
 
virtual unsigned int getRescuePositionIndex (AbstractKart *kart) OVERRIDE
 Determines the rescue position for a kart. More...
 
TrackSectorgetTrackSector (unsigned int kart_index) const
 Returns the track_sector object for the specified kart. More...
 
bool isOnRoad (unsigned int kart_index) const
 Returns true if the kart is on a valid graph quad. More...
 
int getSectorForKart (const AbstractKart *kart) const
 Gets the sector a kart is on. More...
 
- Public Member Functions inherited from World
 World ()
 The main world class is used to handle the track and the karts. More...
 
virtual const std::string & getIdent () const =0
 Each game mode should have a unique identifier. More...
 
virtual unsigned int getNumberOfRescuePositions () const
 Returns the number of rescue positions on a given track and game mode. More...
 
virtual btTransform getRescueTransform (unsigned int index) const
 Returns the bullet transformation for the specified rescue index. More...
 
virtual void moveKartAfterRescue (AbstractKart *kart)
 Places a kart that is rescued. More...
 
virtual bool raceHasLaps ()=0
 Called when it is needed to know whether this kind of race involves counting laps. More...
 
virtual int getFinishedLapsOfKart (unsigned int kart_index) const
 Returns the number of laps for a given kart. More...
 
virtual void getKartsDisplayInfo (std::vector< RaceGUIBase::KartIconDisplayInfo > *info)=0
 Called by the code that draws the list of karts on the race GUI to know what needs to be drawn in the current mode. More...
 
virtual void updateGraphics (float dt)
 This updates all only graphical elements. More...
 
virtual void terminateRace () OVERRIDE
 Called at the end of a race. More...
 
virtual void pause (Phase phase) OVERRIDE
 Pauses the music (and then pauses WorldStatus).
 
virtual void unpause () OVERRIDE
 Switches back from a pause state to the previous state.
 
virtual void getDefaultCollectibles (int *collectible_type, int *amount)
 Called to determine the default collectibles to give each player at the start for this kind of race. More...
 
virtual void collectedItem (const AbstractKart *kart, const ItemState *item)
 Receives notification if an item is collected. More...
 
virtual void endRaceEarly ()
 
virtual bool hasRaceEndedEarly () const
 
virtual bool haveBonusBoxes ()
 Called to determine whether this race mode uses bonus boxes. More...
 
virtual bool useFastMusicNearEnd () const
 Returns if this mode should use fast music (if available). More...
 
virtual void kartAdded (AbstractKart *kart, scene::ISceneNode *node)
 If you want to do something to karts or their graphics at the start of the race, override this. More...
 
virtual void newLap (unsigned int kart_index)
 Called whenever a kart starts a new lap. More...
 
virtual bool kartHit (int kart_id, int hitter=-1)
 Called when a kart was hit by a projectile. More...
 
virtual void onMouseClick (int x, int y)
 
HighscoresgetHighscores () const
 
void schedulePause (Phase phase)
 
void scheduleUnpause ()
 
void scheduleExitRace ()
 
void scheduleTutorial ()
 
void updateWorld (int ticks)
 This is the main interface to update the world. More...
 
void handleExplosion (const Vec3 &xyz, AbstractKart *kart_hit, PhysicalObject *object)
 
AbstractKartgetPlayerKart (unsigned int player) const
 Returns the n-th player kart. More...
 
AbstractKartgetLocalPlayerKart (unsigned int n) const
 Returns the nth local player kart, i.e. More...
 
virtual const btTransform & getStartTransform (int index)
 Returns the start coordinates for a kart with a given index. More...
 
void moveKartTo (AbstractKart *kart, const btTransform &t)
 Places the kart at a given position and rotation. More...
 
RaceGUIBasegetRaceGUI () const
 Returns a pointer to the race gui. More...
 
unsigned int getNumKarts () const
 Returns the number of karts in the race. More...
 
AbstractKartgetKart (int kartId) const
 Returns the kart with a given world id. More...
 
const KartList & getKarts () const
 Returns all karts. More...
 
unsigned int getCurrentNumKarts () const
 Returns the number of currently active (i.e.non-elikminated) karts. More...
 
unsigned int getCurrentNumPlayers () const
 Returns the number of currently active (i.e. More...
 
void resetElimination ()
 
virtual void addReservedKart (int kart_id)
 
virtual void saveCompleteState (BareNetworkString *bns, STKPeer *peer)
 
virtual void restoreCompleteState (const BareNetworkString &buffer)
 
virtual bool shouldDrawTimer () const
 The code that draws the timer should call this first to know whether the game mode wants a timer drawn. More...
 
bool useHighScores () const
 
virtual void onFirePressed (Controller *who)
 Override if you want to know when a kart presses fire.
 
virtual bool useChecklineRequirements () const
 Whether to compute checkline requirements for each world on the quadgraph. More...
 
virtual void escapePressed ()
 
virtual void loadCustomModels ()
 
void eliminateKart (int kart_number, bool notify_of_elimination=true)
 Remove (eliminate) a kart from the race.
 
void setUnfairTeam (bool val)
 
virtual bool hasTeam () const
 
KartTeam getKartTeam (unsigned int kart_id) const
 Get the team of kart in world (including AIs)
 
int getTeamNum (KartTeam team) const
 
void setNetworkWorld (bool is_networked)
 Set the network mode (true if networked)
 
bool isNetworkWorld () const
 
void initTeamArrows (AbstractKart *k)
 Set the team arrow on karts if necessary.
 
virtual std::pair< uint32_t, uint32_t > getGameStartedProgress () const
 Used by server to get the current started game progress in either or both remaining time or progress in percent. More...
 
virtual bool isGoalPhase () const
 
- Public Member Functions inherited from WorldStatus
virtual ~WorldStatus ()
 Destructor of WorldStatus.
 
virtual void updateTime (int ticks)
 Updates the world time and clock (which might be running backwards), and all status information, called once per frame at the end of the main loop. More...
 
void startReadySetGo ()
 
virtual void pause (Phase phase)
 Pauses the game and switches to the specified phase. More...
 
virtual void enterRaceOverState ()
 Called when the race is finished, but it still leaves some time for an end of race animation, and potentially let some more AI karts finish the race.
 
void setTime (const float time)
 Sets the time for the clock. More...
 
void setTicks (int ticks)
 Sets a new time for the world time, measured in ticks. More...
 
void setTicksForRewind (int ticks)
 Sets a new time for the world time (used by rewind), measured in ticks. More...
 
bool isStartPhase () const
 
bool isRacePhase () const
 
bool isActiveRacePhase () const
 
bool isFinishPhase () const
 While the race menu is being displayed, m_phase is limbo, and m_previous_phase is finish. More...
 
const Phase getPhase () const
 Returns the current race phase. More...
 
void setPhase (Phase phase)
 Sets the current race phase. More...
 
void setClockMode (const ClockType mode, const float initial_time=0.0f)
 Call to specify what kind of clock you want. More...
 
int getClockMode () const
 Returns the current clock mode. More...
 
float getTime () const
 Returns the current race time. More...
 
int getTimeTicks () const
 Returns the current race time in time ticks (i.e. More...
 
virtual void countdownReachedZero ()
 Will be called to notify your derived class that the clock, which is in COUNTDOWN mode, has reached zero. More...
 
int getTicksSinceStart () const
 Get the ticks since start regardless of which way the clock counts.
 
int getAuxiliaryTicks () const
 
bool isLiveJoinWorld () const
 
void setLiveJoinWorld (bool val)
 
int getMusicDescriptionTicks () const
 
void endLiveJoinWorld (int ticks_now)
 Base on the network timer set current world count up ticks to tick_now.
 

Protected Member Functions

unsigned int getClosestStartPoint (AbstractKart *kart)
 
void updateSectorForKarts ()
 Localize each kart on the graph using its center xyz.
 
- Protected Member Functions inherited from World
void updateHighscores (int *best_highscore_rank)
 Called at the end of a race. More...
 
void resetAllKarts ()
 Waits till each kart is resting on the ground. More...
 
ControllerloadAIController (AbstractKart *kart)
 Creates an AI controller for the kart. More...
 
virtual std::shared_ptr< AbstractKartcreateKart (const std::string &kart_ident, int index, int local_player_id, int global_player_id, RaceManager::KartType type, HandicapLevel handicap)
 Creates a kart, having a certain position, starting location, and local and global player id (if applicable). More...
 
virtual void onGo () OVERRIDE
 Called when 'go' is being displayed for the first time. More...
 
virtual bool isRaceOver ()=0
 Returns true if the race is over. More...
 
virtual void update (int ticks) OVERRIDE
 Updates the physics, all karts, the track, and projectile manager. More...
 
virtual void createRaceGUI ()
 
void updateTrack (int ticks)
 Only updates the track. More...
 
virtual float estimateFinishTimeForKart (AbstractKart *kart)
 Used for AI karts that are still racing when all player kart finished. More...
 
void updateAchievementDataEndRace ()
 
void updateAchievementModeCounters (bool start)
 

Protected Attributes

std::vector< int > m_position_index
 This contains a mapping from race position to kart index. More...
 
bool m_display_rank
 Whether to display the rank in the race GUI.
 
std::vector< int > m_score_for_position
 The points given to a kart on a given position (index is 0 based, so using race-position - 1. More...
 
std::vector< TrackSector * > m_kart_track_sector
 Stores the current graph node and track coordinates for each kart. More...
 
- Protected Attributes inherited from World
int m_red_ai
 
int m_blue_ai
 
std::map< int, KartTeam > m_kart_team_map
 
std::map< int, unsigned int > m_kart_position_map
 
KartList m_karts
 The list of all karts. More...
 
RandomGenerator m_random
 
AbstractKartm_fastest_kart
 
int m_eliminated_karts
 Number of eliminated karts. More...
 
int m_eliminated_players
 Number of eliminated players. More...
 
int m_num_players
 OVerall number of players. More...
 
bool m_faster_music_active
 
bool m_stop_music_when_dialog_open
 
bool m_unfair_team
 
bool m_use_highscores
 Whether highscores should be used for this kind of race. More...
 
RaceGUIBasem_race_gui
 Pointer to the race GUI. More...
 
RaceGUIBasem_saved_race_gui
 The actual race gui needs to be saved when the race result gui is displayed since it is still needed in case of a restart, and it can't simply be created again (since it assumes that it can render to texture without having any scene nodes, but in case of a restart there are scene nodes). More...
 
bool m_schedule_pause
 Pausing/unpausing are not done immediately, but at next udpdate. More...
 
bool m_schedule_unpause
 Pausing/unpausing are not done immediately, but at next udpdate. More...
 
bool m_schedule_exit_race
 
bool m_schedule_tutorial
 
Phase m_scheduled_pause_phase
 
bool m_self_destruct
 Set when the world needs to be deleted but you can't do it immediately because you are e.g. More...
 
bool m_is_network_world
 Set when the world is online and counts network players. More...
 
bool m_ended_early
 
- Protected Attributes inherited from WorldStatus
double m_time
 Elasped/remaining time in seconds. More...
 
int m_time_ticks
 Time in number of ticks (in terms of physics time steps). More...
 
bool m_play_racestart_sounds
 If the start race should be played, disabled in cutscenes. More...
 
bool m_play_track_intro_sound
 
bool m_play_ready_set_go_sounds
 
std::atomic< Phase > m_phase
 

Additional Inherited Members

- Public Types inherited from World
typedef std::vector< std::shared_ptr< AbstractKart > > KartList
 
- Public Types inherited from WorldStatus
enum  ClockType { CLOCK_NONE, CLOCK_CHRONO, CLOCK_COUNTDOWN }
 Different clock types for a race. More...
 
enum  Phase {
  TRACK_INTRO_PHASE, SETUP_PHASE, WAIT_FOR_SERVER_PHASE, SERVER_READY_PHASE,
  READY_PHASE, SET_PHASE, GO_PHASE, MUSIC_PHASE,
  RACE_PHASE, DELAY_FINISH_PHASE, RESULT_DISPLAY_PHASE, FINISH_PHASE,
  IN_GAME_MENU_PHASE, UNDEFINED_PHASE
}
 
- Static Public Member Functions inherited from World
static WorldgetWorld ()
 Returns a pointer to the (singleton) world object. More...
 
static void deleteWorld ()
 Delete the )singleton) world object, if it exists, and sets the singleton pointer to NULL. More...
 
static void setWorld (World *world)
 Sets the pointer to the world object. More...
 

Detailed Description

A WorldWithRank is a world where the karts are ranked.

This is the base class for races and battle modes - all of which rank the kart. A class using this as a subclass must call setKartPosition(kart id, position) and this class is used to access the ranks from other objects. This class adds a convenient rescue implementation: a kart is rescued to the closest start point. This is useful for battle, soccer, ... modes. Linear world defines its own rescue functions and will overwrite this.

Member Function Documentation

◆ beginSetKartPositions()

void WorldWithRank::beginSetKartPositions ( )

This function must be called before starting to set all kart positions again.

It's mainly used to add some debug support, i.e. detect if the same position is set in different karts.

◆ endSetKartPositions()

void WorldWithRank::endSetKartPositions ( )

Called once the last position was set.

Note that we should not test if all positions were set, since e.g. for eliminated and finished karts the position won't be set anymore.

◆ getKartAtPosition()

AbstractKart * WorldWithRank::getKartAtPosition ( unsigned int  p) const

Returns the kart with a given position.

Parameters
pThe position of the kart, 1<=p<=num_karts).

◆ getRescuePositionIndex()

unsigned int WorldWithRank::getRescuePositionIndex ( AbstractKart kart)
virtual

Determines the rescue position for a kart.

The rescue position is the start position which is has the biggest accumulated distance to all other karts, and which has no other kart very close. The latter avoids dropping a kart on top of another kart. This is the method used

Parameters
kartThe kart that is going to be rescued.
Returns
The index of the start position to which the rescued kart should be moved to.

Implements World.

Reimplemented in SoccerWorld, LinearWorld, CaptureTheFlag, and TutorialWorld.

◆ getScoreForPosition()

int WorldWithRank::getScoreForPosition ( int  p)
virtual

Returns the number of points for a kart at a specified position.

Parameters
pPosition (starting with 1).

Reimplemented in FollowTheLeaderRace.

◆ getSectorForKart()

int WorldWithRank::getSectorForKart ( const AbstractKart kart) const

Gets the sector a kart is on.

This function returns UNKNOWN_SECTOR if the kart_id is larger than the current kart sector. This is necessary in the case that a collision with the track happens during resetAllKarts: at this time m_kart_track_sector is not initialised (and has size 0), so it would trigger this assert. While this normally does not happen, it is useful for track designers that STK does not crash.

Parameters
kartKart for which to return the sector.

◆ getTrackSector()

TrackSector* WorldWithRank::getTrackSector ( unsigned int  kart_index) const
inline

Returns the track_sector object for the specified kart.

Parameters
kart_indexWorld index of the kart.

◆ init()

void WorldWithRank::init ( )
virtual

call just after instanciating.

can't be moved to the contructor as child classes must be instanciated, otherwise polymorphism will fail and the results will be incorrect

Reimplemented from World.

Reimplemented in SoccerWorld, LinearWorld, ThreeStrikesBattle, CaptureTheFlag, EasterEggHunt, FollowTheLeaderRace, and FreeForAll.

◆ isOnRoad()

bool WorldWithRank::isOnRoad ( unsigned int  kart_index) const

Returns true if the kart is on a valid graph quad.

Parameters
kart_indexIndex of the kart.

◆ reset()

void WorldWithRank::reset ( bool  restart = false)
virtual

This function is called before a race is started (i.e.

either after calling init() when starting a race for the first time, or after restarting a race, in which case no init() is called.

Reimplemented from World.

Reimplemented in SoccerWorld, LinearWorld, ThreeStrikesBattle, CaptureTheFlag, EasterEggHunt, FreeForAll, and FollowTheLeaderRace.

◆ setKartPosition()

bool WorldWithRank::setKartPosition ( unsigned int  kart_id,
unsigned int  position 
)

Sets the position of a kart.

This will be saved in this object to allow quick lookup of which kart is on a given position, but also in the kart objects.

Parameters
kart_idThe index of the kart to set the position for.
positionThe position of the kart (1<=position<=num karts).
Returns
false if this position was already set, i.e. an inconsistency in kart positions has occurred. This is used in debug mode only to allow the calling function to print debug information.

Member Data Documentation

◆ m_kart_track_sector

std::vector<TrackSector*> WorldWithRank::m_kart_track_sector
protected

Stores the current graph node and track coordinates for each kart.

◆ m_position_index

std::vector<int> WorldWithRank::m_position_index
protected

This contains a mapping from race position to kart index.

◆ m_score_for_position

std::vector<int> WorldWithRank::m_score_for_position
protected

The points given to a kart on a given position (index is 0 based, so using race-position - 1.


The documentation for this class was generated from the following files: