Description

Definition at line 19 of file MapdataCheckPoint.hh.

Classes
struct	SData

Public Types
enum class	SectorOccupancy { InsideSector , OutsideSector , BetweenSides }
enum class	CheckArea { NormalCheckpoint = -1 , FinishLine = 0 }

Public Member Functions
	STATIC_ASSERT (sizeof(SData)==0x14)
	MapdataCheckPoint (const SData *data)
void	read (EGG::Stream &stream)
void	initCheckpointLinks (MapdataCheckPointAccessor &accessor, int id)
	Calculates m_nextPoints and m_prevPoints from m_nextPt and m_prevPt.
SectorOccupancy	checkSectorAndDistanceRatio (const EGG::Vector3f &pos, f32 &distanceRatio) const
u16	getEntryOffsetMs (const EGG::Vector2f &prevPos, const EGG::Vector2f &pos) const
	Finds the offset between the two positions that enter the checkpoint.
f32	getEntryOffsetExact (const EGG::Vector2f &prevPos, const EGG::Vector2f &pos) const
	Finds the offset between the two positions that enter the checkpoint.
bool	isNormalCheckpoint () const
bool	isFinishLine () const
Setters
void	setSearched (u32 epoch)
void	clearSearched ()
Getters
bool	searched (u32 epoch) const
s8	jugemIndex () const
s8	checkArea () const
u16	nextCount () const
u16	prevCount () const
const EGG::Vector2f &	dir () const
u16	id () const
MapdataCheckPoint *	prevPoint (size_t i) const
MapdataCheckPoint *	nextPoint (size_t i) const

Private Member Functions
SectorOccupancy	checkSectorAndDistanceRatio (const LinkedCheckpoint &next, const EGG::Vector2f &p0, const EGG::Vector2f &p1, f32 &distanceRatio) const
bool	checkSector (const LinkedCheckpoint &next, const EGG::Vector2f &p0, const EGG::Vector2f &p1) const
bool	checkDistanceRatio (const LinkedCheckpoint &next, const EGG::Vector2f &p0, const EGG::Vector2f &p1, f32 &distanceRatio) const
	Sets the distance ratio, which is the progress of traversal through the checkpoint quad.

Private Attributes
const SData *	m_rawData
EGG::Vector2f	m_left
EGG::Vector2f	m_right
s8	m_jugemIndex
s8	m_checkArea
u8	m_prevPt
u8	m_nextPt
u16	m_nextCount
u16	m_prevCount
EGG::Vector2f	m_midpoint
EGG::Vector2f	m_dir
u16	m_id
u32	m_lastSearchedId
	The CourseMap::m_sectorSearchId in which this checkpoint was last searched.
std::array< MapdataCheckPoint *, MAX_NEIGHBORS >	m_prevPoints
std::array< LinkedCheckpoint, MAX_NEIGHBORS >	m_nextPoints

Static Private Attributes
static constexpr size_t	MAX_NEIGHBORS = 6

Member Enumeration Documentation

◆ CheckArea

enum class Kinoko::System::MapdataCheckPoint::CheckArea

strong

Enumerator
NormalCheckpoint	Only used for picking respawn position.
FinishLine	Triggers a lap change.

Definition at line 107 of file MapdataCheckPoint.hh.

◆ SectorOccupancy

enum class Kinoko::System::MapdataCheckPoint::SectorOccupancy

strong

Enumerator
InsideSector	Player is inside the given checkpoint group.
OutsideSector	Player is outside the given checkpoint group.
BetweenSides	Player is between sides of the checkpoint group but not between this checkpoint and next

Definition at line 31 of file MapdataCheckPoint.hh.

Constructor & Destructor Documentation

◆ MapdataCheckPoint()

Kinoko::System::MapdataCheckPoint::MapdataCheckPoint ( const SData * data )

0x805154E4

Definition at line 11 of file MapdataCheckPoint.cc.

Member Function Documentation

◆ checkArea()

s8 Kinoko::System::MapdataCheckPoint::checkArea ( ) const

inlinenodiscard

Definition at line 76 of file MapdataCheckPoint.hh.

◆ checkDistanceRatio()

bool Kinoko::System::MapdataCheckPoint::checkDistanceRatio	(	const LinkedCheckpoint &	next,
		const EGG::Vector2f &	p0,
		const EGG::Vector2f &	p1,
		f32 &	distanceRatio ) const

nodiscardprivate0x80510BF0

Sets the distance ratio, which is the progress of traversal through the checkpoint quad.

Parameters

distanceRatio The distance ratio reference to set.

Returns: Whether the distance ratio is in its valid range, [0, 1].

Definition at line 205 of file MapdataCheckPoint.cc.

◆ checkSector()

bool Kinoko::System::MapdataCheckPoint::checkSector	(	const LinkedCheckpoint &	next,
		const EGG::Vector2f &	p0,
		const EGG::Vector2f &	p1 ) const

nodiscardprivate0x0x80510B84

Returns: Whether the player is between the two sides of the checkpoint quad.

Definition at line 188 of file MapdataCheckPoint.cc.

◆ checkSectorAndDistanceRatio() [1/2]

MapdataCheckPoint::SectorOccupancy Kinoko::System::MapdataCheckPoint::checkSectorAndDistanceRatio	(	const EGG::Vector3f &	pos,
		f32 &	distanceRatio ) const

nodiscard0x80510D7C

Definition at line 99 of file MapdataCheckPoint.cc.

◆ checkSectorAndDistanceRatio() [2/2]

MapdataCheckPoint::SectorOccupancy Kinoko::System::MapdataCheckPoint::checkSectorAndDistanceRatio	(	const LinkedCheckpoint &	next,
		const EGG::Vector2f &	p0,
		const EGG::Vector2f &	p1,
		f32 &	distanceRatio ) const

nodiscardprivate0x80510C74

Definition at line 175 of file MapdataCheckPoint.cc.

◆ clearSearched()

void Kinoko::System::MapdataCheckPoint::clearSearched ( )

inline

Definition at line 62 of file MapdataCheckPoint.hh.

◆ dir()

const EGG::Vector2f & Kinoko::System::MapdataCheckPoint::dir ( ) const

inlinenodiscard

Definition at line 88 of file MapdataCheckPoint.hh.

◆ getEntryOffsetExact()

f32 Kinoko::System::MapdataCheckPoint::getEntryOffsetExact	(	const EGG::Vector2f &	prevPos,
		const EGG::Vector2f &	pos ) const

nodiscard

Finds the offset between the two positions that enter the checkpoint.

This assumes the player is entering the checkpoint as intended, and not from the side. This function isn't in the base game, but it can be used to determine improvements to runs.

Parameters

prevPos	The previous position, likely not located in the checkpoint.
pos	The current position, likely located in the checkpoint.

Returns: The exact offset that crosses into the checkpoint, in the range [0, 1000 / 59.94].

Definition at line 156 of file MapdataCheckPoint.cc.

◆ getEntryOffsetMs()

u16 Kinoko::System::MapdataCheckPoint::getEntryOffsetMs	(	const EGG::Vector2f &	prevPos,
		const EGG::Vector2f &	pos ) const

nodiscard0x80511EC8

Finds the offset between the two positions that enter the checkpoint.

This assumes the player is entering the checkpoint as intended, and not from the side.

Parameters

prevPos	The previous position, likely not located in the checkpoint.
pos	The current position, likely located in the checkpoint.

Returns: The earliest subdivision that crosses into the checkpoint, in the range [1, 17].

Definition at line 130 of file MapdataCheckPoint.cc.

◆ id()

u16 Kinoko::System::MapdataCheckPoint::id ( ) const

inlinenodiscard

Definition at line 92 of file MapdataCheckPoint.hh.

◆ initCheckpointLinks()

void Kinoko::System::MapdataCheckPoint::initCheckpointLinks	(	MapdataCheckPointAccessor &	accessor,
		int	id )

0x80515624

Calculates m_nextPoints and m_prevPoints from m_nextPt and m_prevPt.

Also calculates the quadrilaterals for the next checkpoints, filling the fields of LinkedCheckpoint for each.

Definition at line 34 of file MapdataCheckPoint.cc.

◆ isFinishLine()

bool Kinoko::System::MapdataCheckPoint::isFinishLine ( ) const

inlinenodiscard

Definition at line 53 of file MapdataCheckPoint.hh.

◆ isNormalCheckpoint()

bool Kinoko::System::MapdataCheckPoint::isNormalCheckpoint ( ) const

inlinenodiscard

Definition at line 49 of file MapdataCheckPoint.hh.

◆ jugemIndex()

s8 Kinoko::System::MapdataCheckPoint::jugemIndex ( ) const

inlinenodiscard

Definition at line 72 of file MapdataCheckPoint.hh.

◆ nextCount()

u16 Kinoko::System::MapdataCheckPoint::nextCount ( ) const

inlinenodiscard

Definition at line 80 of file MapdataCheckPoint.hh.

◆ nextPoint()

MapdataCheckPoint * Kinoko::System::MapdataCheckPoint::nextPoint ( size_t i ) const

inlinenodiscard

Definition at line 101 of file MapdataCheckPoint.hh.

◆ prevCount()

u16 Kinoko::System::MapdataCheckPoint::prevCount ( ) const

inlinenodiscard

Definition at line 84 of file MapdataCheckPoint.hh.

◆ prevPoint()

MapdataCheckPoint * Kinoko::System::MapdataCheckPoint::prevPoint ( size_t i ) const

inlinenodiscard

Definition at line 96 of file MapdataCheckPoint.hh.

◆ read()

void Kinoko::System::MapdataCheckPoint::read ( EGG::Stream & stream )

Definition at line 21 of file MapdataCheckPoint.cc.

◆ searched()

bool Kinoko::System::MapdataCheckPoint::searched ( u32 epoch ) const

inlinenodiscard

Definition at line 68 of file MapdataCheckPoint.hh.

◆ setSearched()

void Kinoko::System::MapdataCheckPoint::setSearched ( u32 epoch )

inline

Definition at line 58 of file MapdataCheckPoint.hh.

Member Data Documentation

◆ m_checkArea

s8 Kinoko::System::MapdataCheckPoint::m_checkArea

private

Either:

a `NORMAL_CHECKPOINT` (-1) used to calculate respawns,
a `FINISH_LINE` (0) which updates the lap count when crossed, or
a "key checkpoint" (1-127) used to ensure racers travel around the entire course before proceeding to the next lap. the type value represents the index, i.e. racers must pass checkpoint with `m_type` 1, then 2, then 3 etc..

Definition at line 133 of file MapdataCheckPoint.hh.

◆ m_dir

EGG::Vector2f Kinoko::System::MapdataCheckPoint::m_dir

private

Definition at line 139 of file MapdataCheckPoint.hh.

◆ m_id

u16 Kinoko::System::MapdataCheckPoint::m_id

private

Definition at line 140 of file MapdataCheckPoint.hh.

◆ m_jugemIndex

s8 Kinoko::System::MapdataCheckPoint::m_jugemIndex

private

Index of respawn point associated with this checkpoint. Players who die here will be respawned at this point.

Definition at line 125 of file MapdataCheckPoint.hh.

◆ m_lastSearchedId

u32 Kinoko::System::MapdataCheckPoint::m_lastSearchedId

private

The CourseMap::m_sectorSearchId in which this checkpoint was last searched.

This is a performance improvement for Kinoko. The base game stores a boolean that is cleared on every checkpoint before each search in CourseMap::findSector(). By referencing m_lastSearchedId instead, we can determine if the checkpoint has been found in the current search without having to clear it explicitly.

Definition at line 147 of file MapdataCheckPoint.hh.

◆ m_left

EGG::Vector2f Kinoko::System::MapdataCheckPoint::m_left

private

Definition at line 123 of file MapdataCheckPoint.hh.

◆ m_midpoint

EGG::Vector2f Kinoko::System::MapdataCheckPoint::m_midpoint

private

Definition at line 138 of file MapdataCheckPoint.hh.

◆ m_nextCount

u16 Kinoko::System::MapdataCheckPoint::m_nextCount

private

Definition at line 136 of file MapdataCheckPoint.hh.

◆ m_nextPoints

std::array<LinkedCheckpoint, MAX_NEIGHBORS> Kinoko::System::MapdataCheckPoint::m_nextPoints

private

Definition at line 150 of file MapdataCheckPoint.hh.

◆ m_nextPt

u8 Kinoko::System::MapdataCheckPoint::m_nextPt

private

Definition at line 135 of file MapdataCheckPoint.hh.

◆ m_prevCount

u16 Kinoko::System::MapdataCheckPoint::m_prevCount

private

Definition at line 137 of file MapdataCheckPoint.hh.

◆ m_prevPoints

std::array<MapdataCheckPoint *, MAX_NEIGHBORS> Kinoko::System::MapdataCheckPoint::m_prevPoints

private

Definition at line 149 of file MapdataCheckPoint.hh.

◆ m_prevPt

u8 Kinoko::System::MapdataCheckPoint::m_prevPt

private

Definition at line 134 of file MapdataCheckPoint.hh.

◆ m_rawData

const SData* Kinoko::System::MapdataCheckPoint::m_rawData

private

Definition at line 122 of file MapdataCheckPoint.hh.

◆ m_right

EGG::Vector2f Kinoko::System::MapdataCheckPoint::m_right

private

Definition at line 124 of file MapdataCheckPoint.hh.

◆ MAX_NEIGHBORS

size_t Kinoko::System::MapdataCheckPoint::MAX_NEIGHBORS = 6

staticconstexprprivate

Definition at line 120 of file MapdataCheckPoint.hh.

Description

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Member Enumeration Documentation

◆ CheckArea

◆ SectorOccupancy

Constructor & Destructor Documentation

◆ MapdataCheckPoint()

Member Function Documentation

◆ checkArea()

◆ checkDistanceRatio()

◆ checkSector()

◆ checkSectorAndDistanceRatio() [1/2]

◆ checkSectorAndDistanceRatio() [2/2]

◆ clearSearched()

◆ dir()

◆ getEntryOffsetExact()

◆ getEntryOffsetMs()

◆ id()

◆ initCheckpointLinks()

◆ isFinishLine()

◆ isNormalCheckpoint()

◆ jugemIndex()

◆ nextCount()

◆ nextPoint()

◆ prevCount()

◆ prevPoint()

◆ read()

◆ searched()

◆ setSearched()

Member Data Documentation

◆ m_checkArea

◆ m_dir

◆ m_id

◆ m_jugemIndex

◆ m_lastSearchedId

◆ m_left

◆ m_midpoint

◆ m_nextCount

◆ m_nextPoints

◆ m_nextPt

◆ m_prevCount

◆ m_prevPoints

◆ m_prevPt

◆ m_rawData

◆ m_right

◆ MAX_NEIGHBORS