Skip to content

Commit

Permalink
Tuning: added "kill switch" cvar sim_tuning_enabled (bool)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ohlidalp
ohlidalp committed Dec 3, 2023
1 parent c221bf8 commit 7104026
Show file tree
Hide file tree
Showing 8 changed files with 76 additions and 34 deletions.
1 change: 1 addition & 0 deletions source/main/Application.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ CVar* sim_gearbox_mode;
CVar* sim_soft_reset_mode;
CVar* sim_quickload_dialog;
CVar* sim_live_repair_interval;
CVar* sim_tuning_enabled;

// Multiplayer
CVar* mp_state;
Expand Down
1 change: 1 addition & 0 deletions source/main/Application.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,7 @@ extern CVar* sim_gearbox_mode;
extern CVar* sim_soft_reset_mode;
extern CVar* sim_quickload_dialog;
extern CVar* sim_live_repair_interval; //!< Hold EV_COMMON_REPAIR_TRUCK to enter LiveRepair mode. 0 or negative interval disables.
extern CVar* sim_tuning_enabled;

// Multiplayer
extern CVar* mp_state;
Expand Down
45 changes: 24 additions & 21 deletions source/main/GameContext.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,30 +192,33 @@ ActorPtr GameContext::SpawnActor(ActorSpawnRequest& rq)
m_last_section_config = rq.asr_config;

// Make sure the actor has a default .tuneup project assigned. If not, create it.
CacheQuery query;
query.cqy_filter_type = LT_Tuneup;
query.cqy_filter_category_id = CID_TuneupsAuto;
query.cqy_filter_guid = rq.asr_cache_entry->guid;
if (App::GetCacheSystem()->Query(query) > 0)
if (App::sim_tuning_enabled->getBool())
{
rq.asr_tuneup_entry = query.cqy_results[0].cqr_entry;
}
else
{
CreateProjectRequest req;
req.cpr_type = CreateProjectRequestType::CREATE_TUNEUP;
req.cpr_source_entry = rq.asr_cache_entry;
req.cpr_name = fmt::format("tuned_{}", rq.asr_cache_entry->fname);
req.cpr_description = fmt::format("Customized {}", rq.asr_cache_entry->dname);
CacheQuery query;
query.cqy_filter_type = LT_Tuneup;
query.cqy_filter_category_id = CID_TuneupsAuto;
query.cqy_filter_guid = rq.asr_cache_entry->guid;
if (App::GetCacheSystem()->Query(query) > 0)
{
rq.asr_tuneup_entry = query.cqy_results[0].cqr_entry;
}
else
{
CreateProjectRequest req;
req.cpr_type = CreateProjectRequestType::CREATE_TUNEUP;
req.cpr_source_entry = rq.asr_cache_entry;
req.cpr_name = fmt::format("tuned_{}", rq.asr_cache_entry->fname);
req.cpr_description = fmt::format("Customized {}", rq.asr_cache_entry->dname);

rq.asr_tuneup_entry = App::GetCacheSystem()->CreateProject(&req); // Do it synchronously
rq.asr_tuneup_entry = App::GetCacheSystem()->CreateProject(&req); // Do it synchronously

if (!rq.asr_tuneup_entry)
{
Str<500> msg; msg <<"Cannot spawn actor; .tuneup project could not be created.";
App::GetConsole()->putMessage(Console::CONSOLE_MSGTYPE_ACTOR, Console::CONSOLE_SYSTEM_ERROR, msg.ToCStr());
return nullptr;
}
if (!rq.asr_tuneup_entry)
{
Str<500> msg; msg <<"Cannot spawn actor; .tuneup project could not be created.";
App::GetConsole()->putMessage(Console::CONSOLE_MSGTYPE_ACTOR, Console::CONSOLE_SYSTEM_ERROR, msg.ToCStr());
return nullptr;
}
}
}

if (rq.asr_spawnbox == nullptr)
Expand Down
4 changes: 3 additions & 1 deletion source/main/gui/GUIUtils.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,13 +257,15 @@ void RoR::ImTextWrappedColorMarked(std::string const& text)
ImGui::ItemAdd(bb, 0);
}

void RoR::DrawGCheckbox(CVar* cvar, const char* label)
bool RoR::DrawGCheckbox(CVar* cvar, const char* label)
{
bool val = cvar->getBool();
if (ImGui::Checkbox(label, &val))
{
cvar->setVal(val);
return true;
}
return false;
}

void RoR::DrawGIntCheck(CVar* cvar, const char* label)
Expand Down
2 changes: 1 addition & 1 deletion source/main/gui/GUIUtils.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ std::string StripColorMarksFromText(std::string const& text);
/// Prints multiline text with '#rrggbb' color markers. Behaves like `ImGui::Text*` functions.
void ImTextWrappedColorMarked(std::string const& text);

void DrawGCheckbox(CVar* cvar, const char* label);
bool DrawGCheckbox(CVar* cvar, const char* label);

void DrawGIntCheck(CVar* cvar, const char* label);

Expand Down
47 changes: 37 additions & 10 deletions source/main/gui/panels/GUI_TopMenubar.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1450,12 +1450,34 @@ void TopMenubar::Draw(float dt)
{
ROR_ASSERT(tuning_actor->getUsedActorEntry());
CacheEntryPtr& tuneup_entry = tuning_actor->getUsedTuneupEntry();
ROR_ASSERT(tuneup_entry); // Created by `GameContext::SpawnActor()`
ROR_ASSERT(tuneup_entry->resource_group != "");
ROR_ASSERT(tuneup_entry->tuneup_def != nullptr);
if (tuneup_entry)
{
ROR_ASSERT(tuneup_entry->resource_group != "");
ROR_ASSERT(tuneup_entry->tuneup_def != nullptr);
}

// SAVED TUNEUPS
// KILL SWITCH

if (DrawGCheckbox(App::sim_tuning_enabled, _LC("Tuning", "Enable tuning")))
{
// Create spawn request while actor still exists
// Note we don't use `ActorModifyRequest::Type::RELOAD` because we don't need the bundle reloaded.
ActorSpawnRequest* srq = new ActorSpawnRequest;
srq->asr_position = Ogre::Vector3(tuning_actor->getPosition().x, tuning_actor->getMinHeight(), tuning_actor->getPosition().z);
srq->asr_rotation = Ogre::Quaternion(Ogre::Degree(270) - Ogre::Radian(tuning_actor->getRotation()), Ogre::Vector3::UNIT_Y);
srq->asr_config = tuning_actor->getSectionConfig();
srq->asr_skin_entry = tuning_actor->getUsedSkinEntry();
srq->asr_cache_entry = tuning_actor->getUsedActorEntry();
srq->asr_debugview = (int)tuning_actor->GetGfxActor()->GetDebugView();
srq->asr_origin = ActorSpawnRequest::Origin::USER;

// Request actor delete and chain the actor spawn message to it.
App::GetGameContext()->ChainMessage(Message(MSG_SIM_DELETE_ACTOR_REQUESTED, new ActorPtr(tuning_actor)));
App::GetGameContext()->ChainMessage(Message(MSG_SIM_SPAWN_ACTOR_REQUESTED, srq));
}

// SAVED TUNEUPS
ImGui::Separator();
ImGui::TextDisabled(fmt::format(_LC("Tuning", "Saved tuneups ({})"), tuning_saves.cqy_results.size()).c_str());
for (CacheQueryResult& tuneup_result: tuning_saves.cqy_results)
{
Expand Down Expand Up @@ -1627,7 +1649,7 @@ void TopMenubar::Draw(float dt)
// Draw props
size_t total_props = tuning_actor->GetGfxActor()->getProps().size();
std::string props_title = fmt::format(_LC("TopMenubar", "Props ({})"), total_props);
if (ImGui::CollapsingHeader(props_title.c_str()))
if (ImGui::CollapsingHeader(props_title.c_str()) && tuneup_entry)
{
// Draw all props (those removed by addonparts are also present as placeholders)
for (Prop const& p: tuning_actor->GetGfxActor()->getProps())
Expand Down Expand Up @@ -1688,7 +1710,7 @@ void TopMenubar::Draw(float dt)
// Ditto for flexbodies
size_t total_flexbodies = tuning_actor->GetGfxActor()->GetFlexbodies().size();
std::string flexbodies_title = fmt::format(_LC("TopMenubar", "Flexbodies ({})"), total_flexbodies);
if (ImGui::CollapsingHeader(flexbodies_title.c_str()))
if (ImGui::CollapsingHeader(flexbodies_title.c_str()) && tuneup_entry)
{
// Draw all flexbodies (those removed by addonparts are also present as placeholders)
for (FlexBody* flexbody: tuning_actor->GetGfxActor()->GetFlexbodies())
Expand Down Expand Up @@ -1725,7 +1747,7 @@ void TopMenubar::Draw(float dt)
// Draw wheels
const int total_wheels = tuning_actor->ar_num_wheels;
std::string wheels_title = fmt::format(_LC("TopMenubar", "Wheels ({})"), total_wheels);
if (ImGui::CollapsingHeader(wheels_title.c_str()))
if (ImGui::CollapsingHeader(wheels_title.c_str()) && tuneup_entry)
{
for (WheelID_t i = 0; i < total_wheels; i++)
{
Expand Down Expand Up @@ -2229,23 +2251,28 @@ void TopMenubar::GetPresets()
void TopMenubar::RefreshTuningMenu()
{
const ActorPtr& current_actor = App::GetGameContext()->GetPlayerActor();
if (current_actor && (tuning_actor != current_actor || tuning_force_refresh))
if (App::sim_tuning_enabled->getBool() && current_actor && (tuning_actor != current_actor || tuning_force_refresh))
{
ROR_ASSERT(current_actor->getUsedActorEntry());

tuning_addonparts.cqy_filter_type = LT_AddonPart;
tuning_addonparts.cqy_filter_guid = current_actor->getUsedActorEntry()->guid;
tuning_addonparts.cqy_results.clear();
tuning_addonparts.resetResults();
App::GetCacheSystem()->Query(tuning_addonparts);

tuning_saves.cqy_filter_type = LT_Tuneup;
tuning_saves.cqy_filter_guid = current_actor->getUsedActorEntry()->guid;
tuning_saves.cqy_filter_category_id = CID_TuneupsUser; // Exclude auto-generated entries
tuning_saves.cqy_results.clear();
tuning_saves.resetResults();
App::GetCacheSystem()->Query(tuning_saves);

tuning_rwidget_cursorx_min = 0.f;
}
else if (!App::sim_tuning_enabled->getBool())
{
tuning_addonparts.resetResults();
tuning_saves.resetResults();
}
tuning_actor = current_actor;
}

Expand Down
7 changes: 7 additions & 0 deletions source/main/resources/CacheSystem.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,13 @@ struct CacheQuery
std::vector<CacheQueryResult> cqy_results;
std::map<int, size_t> cqy_res_category_usage; //!< Total usage (ignores search params + category filter)
std::time_t cqy_res_last_update = std::time_t();

void resetResults()
{
cqy_results.clear();
cqy_res_category_usage.clear();
cqy_res_last_update = std::time_t();
}
};

enum class CacheValidity
Expand Down
3 changes: 2 additions & 1 deletion source/main/system/CVar.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ void Console::cVarSetupBuiltins()
App::sim_gearbox_mode = this->cVarCreate("sim_gearbox_mode", "GearboxMode", CVAR_ARCHIVE | CVAR_TYPE_INT);
App::sim_soft_reset_mode = this->cVarCreate("sim_soft_reset_mode", "", CVAR_TYPE_BOOL, "false");
App::sim_quickload_dialog = this->cVarCreate("sim_quickload_dialog", "", CVAR_ARCHIVE | CVAR_TYPE_BOOL, "true");
App::sim_live_repair_interval = this->cVarCreate("sim_live_repair_interval", "", CVAR_ARCHIVE | CVAR_TYPE_FLOAT, "2.f");
App::sim_live_repair_interval = this->cVarCreate("sim_live_repair_interval", "", CVAR_ARCHIVE | CVAR_TYPE_FLOAT, "2.f");
App::sim_tuning_enabled = this->cVarCreate("sim_tuning_enabled", "", CVAR_ARCHIVE | CVAR_TYPE_BOOL, "false");

App::mp_state = this->cVarCreate("mp_state", "", CVAR_TYPE_INT, "0"/*(int)MpState::DISABLED*/);
App::mp_join_on_startup = this->cVarCreate("mp_join_on_startup", "Auto connect", CVAR_ARCHIVE | CVAR_TYPE_BOOL, "false");
Expand Down

0 comments on commit 7104026

Please sign in to comment.