DarkflameServer/dGame/dComponents/RacingControlComponent.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

249 lines
4.6 KiB
C
Raw Normal View History

/**
* Thanks to Simon for his early research on the racing system.
*/
#pragma once
#include "BitStream.h"
#include "Entity.h"
#include "Component.h"
/**
* Information for each player in the race
*/
struct RacingPlayerInfo {
/**
* The ID of the player
*/
LWOOBJID playerID;
2022-07-28 13:39:57 +00:00
/**
* The ID of the car the player is driving
*/
LWOOBJID vehicleID;
2022-07-28 13:39:57 +00:00
/**
* The index of this player in the list of players
*/
uint32_t playerIndex;
2022-07-28 13:39:57 +00:00
/**
* Whether the player has finished loading or not
*/
bool playerLoaded;
2022-07-28 13:39:57 +00:00
/**
* Scripted activity component score
*/
float data[10]{};
2022-07-28 13:39:57 +00:00
/**
* Point that the player will respawn at if they smash their car
*/
NiPoint3 respawnPosition;
2022-07-28 13:39:57 +00:00
/**
* Rotation that the player will respawn at if they smash their car
*/
NiQuaternion respawnRotation;
2022-07-28 13:39:57 +00:00
/**
* The index in the respawn point the player is now at
*/
uint32_t respawnIndex;
2022-07-28 13:39:57 +00:00
/**
* The number of laps the player has completed
*/
uint32_t lap;
2022-07-28 13:39:57 +00:00
/**
* Whether or not the player has finished the race
*/
uint32_t finished;
2022-07-28 13:39:57 +00:00
/**
* Unused
*/
uint16_t reachedPoints;
2022-07-28 13:39:57 +00:00
/**
* The fastest lap time of the player
*/
time_t bestLapTime = 0;
2022-07-28 13:39:57 +00:00
/**
* The current lap time of the player
*/
time_t lapTime = 0;
2022-07-28 13:39:57 +00:00
/**
* The number of times this player smashed their car
*/
uint32_t smashedTimes = 0;
2022-07-28 13:39:57 +00:00
/**
* Whether or not the player should be smashed if the game is reloaded
*/
bool noSmashOnReload = false;
2022-07-28 13:39:57 +00:00
/**
* Whether or not this player has collected their rewards from completing the race
*/
bool collectedRewards = false;
2022-07-28 13:39:57 +00:00
/**
* Unused
*/
time_t raceTime = 0;
};
/**
* Component that's attached to a manager entity in each race zone that loads player vehicles, keep scores, etc.
*/
class RacingControlComponent : public Component {
public:
static const uint32_t ComponentType = COMPONENT_TYPE_RACING_CONTROL;
2022-07-28 13:39:57 +00:00
RacingControlComponent(Entity* parentEntity);
~RacingControlComponent();
void Serialize(RakNet::BitStream* outBitStream, bool bIsInitialUpdate, unsigned int& flags);
void Update(float deltaTime);
2022-07-28 13:39:57 +00:00
/**
* Invoked when a player loads into the zone.
*/
void OnPlayerLoaded(Entity* player);
2022-07-28 13:39:57 +00:00
/**
* Initalize the player's vehicle.
*
* @param player The player who's vehicle to initialize.
* @param initialLoad Is this the first time the player is loading in this race?
*/
2022-12-22 13:16:18 +00:00
void LoadPlayerVehicle(Entity* player, uint32_t positionNumber, bool initialLoad = false);
2022-07-28 13:39:57 +00:00
/**
* Invoked when the client says it has loaded in.
*/
void OnRacingClientReady(Entity* player);
2022-07-28 13:39:57 +00:00
/**
* Invoked when the client says it should be smashed.
*/
void OnRequestDie(Entity* player);
2022-07-28 13:39:57 +00:00
/**
* Invoked when the player has finished respawning.
*/
void OnRacingPlayerInfoResetFinished(Entity* player);
2022-07-28 13:39:57 +00:00
/**
* Invoked when the player responds to the GUI.
*/
void HandleMessageBoxResponse(Entity* player, const std::string& id);
2022-07-28 13:39:57 +00:00
/**
Implementing and Fixing All Racing Achievements (#366) * Grammatical changes in comments * Grammatical fixes in comments Small grammatical fixes found in comments throughout the code. * Added descriptions to functions Added descriptions to functions that didn't have them to keep the code well documented * Created RacingTaskParam.h Created RacingTaskParam so eliminate magic numbers in the original implementation of completing racing missions. * Updated magic numbers in Mission.cpp Updated magic numbers in Mission.cpp to a meaningful name. * Implemented racing smashable task progression Previously, races did not progress tasks for smashing Entities. Now all achievements tracking smashables track them correctly. This has been implemented in the three Entities that can be smashed in a race (imagination boxes, track specific smashables, Forbidden Valley dragon eggs). * Updated race imagination task progression Race imagination now no longer uses a magic number when passed to missionComponent. Instead we use a number defined in an enum located in RacingTaskParam.h * Updated Race task checks Racing tasks for completing races without smashing now no longer auto complete the whole chain of missions. Tasks that track placing on tracks and races overall now properly complete. Tasks that count how many missions in a zone are completed now function. Tasks that track race completions in multiple areas now function. * Updated RacingControlComponent.cpp Fixed any tasks that required 3 players to now require 3 or more players in a race to progress. This restriction is ignored if the world config opted in for solo racing to allow progression in solo worlds. Updated magic numbers sent into missionComponent->Progress to an enum created in this PR. Fixed some indentation. * Fixed a grammatical error in variable name Fixed a grammatical error in the enum for task params
2022-02-05 11:28:17 +00:00
* Get the racing data from a player's LWOOBJID.
*/
RacingPlayerInfo* GetPlayerData(LWOOBJID playerID);
2022-07-28 13:39:57 +00:00
/**
* Formats a time to a string, currently unused
* @param time the time to format
* @return the time formatted as string
*/
static std::string FormatTimeString(time_t time);
private:
/**
* The players that are currently racing
*/
std::vector<RacingPlayerInfo> m_RacingPlayers;
2022-07-28 13:39:57 +00:00
/**
* The paths that are followed for the camera scenes
*/
std::u16string m_PathName;
2022-07-28 13:39:57 +00:00
/**
* The ID of the activity for participating in this race
*/
uint32_t m_ActivityID;
2022-07-28 13:39:57 +00:00
/**
* The world the players return to when they finish the race
*/
uint32_t m_MainWorld;
2022-07-28 13:39:57 +00:00
/**
* The number of laps that are remaining for the winning player
*/
uint16_t m_RemainingLaps;
2022-07-28 13:39:57 +00:00
/**
* The ID of the player that's currently winning the race
*/
LWOOBJID m_LeadingPlayer;
2022-07-28 13:39:57 +00:00
/**
* The overall best lap from all the players
*/
float m_RaceBestLap;
2022-07-28 13:39:57 +00:00
/**
* The overall best time from all the players
*/
float m_RaceBestTime;
2022-07-28 13:39:57 +00:00
/**
* Whether or not the race has started
*/
bool m_Started;
2022-07-28 13:39:57 +00:00
/**
* The time left until the race will start
*/
float m_StartTimer;
2022-07-28 13:39:57 +00:00
/**
* The time left for loading the players
*/
float m_LoadTimer;
2022-07-28 13:39:57 +00:00
/**
* Whether or not all players have loaded
*/
bool m_Loaded;
2022-07-28 13:39:57 +00:00
/**
* The number of loaded players
*/
uint32_t m_LoadedPlayers;
2022-07-28 13:39:57 +00:00
/**
* All the players that are in the lobby, loaded or not
*/
std::vector<LWOOBJID> m_LobbyPlayers;
2022-07-28 13:39:57 +00:00
/**
Implementing and Fixing All Racing Achievements (#366) * Grammatical changes in comments * Grammatical fixes in comments Small grammatical fixes found in comments throughout the code. * Added descriptions to functions Added descriptions to functions that didn't have them to keep the code well documented * Created RacingTaskParam.h Created RacingTaskParam so eliminate magic numbers in the original implementation of completing racing missions. * Updated magic numbers in Mission.cpp Updated magic numbers in Mission.cpp to a meaningful name. * Implemented racing smashable task progression Previously, races did not progress tasks for smashing Entities. Now all achievements tracking smashables track them correctly. This has been implemented in the three Entities that can be smashed in a race (imagination boxes, track specific smashables, Forbidden Valley dragon eggs). * Updated race imagination task progression Race imagination now no longer uses a magic number when passed to missionComponent. Instead we use a number defined in an enum located in RacingTaskParam.h * Updated Race task checks Racing tasks for completing races without smashing now no longer auto complete the whole chain of missions. Tasks that track placing on tracks and races overall now properly complete. Tasks that count how many missions in a zone are completed now function. Tasks that track race completions in multiple areas now function. * Updated RacingControlComponent.cpp Fixed any tasks that required 3 players to now require 3 or more players in a race to progress. This restriction is ignored if the world config opted in for solo racing to allow progression in solo worlds. Updated magic numbers sent into missionComponent->Progress to an enum created in this PR. Fixed some indentation. * Fixed a grammatical error in variable name Fixed a grammatical error in the enum for task params
2022-02-05 11:28:17 +00:00
* The number of players that have finished the race
*/
uint32_t m_Finished;
2022-07-28 13:39:57 +00:00
/**
* The time the race was started
*/
time_t m_StartTime;
2022-07-28 13:39:57 +00:00
/**
* Timer for tracking how long a player was alone in this race
*/
float m_EmptyTimer;
2022-07-28 13:39:57 +00:00
bool m_SoloRacing;
};