Skip to content

feat: Add option to bypass initial upgraded special power reload time #3054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Stubbjax wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: Add option to bypass initial upgraded special power reload time #3054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8b5a764
feat: Add option to bypass initial upgraded special power reload time
Stubbjax Aug 3, 2026
bb74c62
tweak: Move field to the SpecialAbility module to allow usage for non…
Stubbjax Aug 4, 2026
d88b24c
tweak: Prevent potential mismatches between different retail-compatib…
Stubbjax Aug 4, 2026
76b8775
tweak: Only ignore the first reload time
Stubbjax Aug 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Generals/Code/GameEngine/Include/GameLogic/Module/SpecialPowerModule.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ class SpecialPowerModuleInterface
virtual void markSpecialPowerTriggered( const Coord3D *location ) = 0;
virtual void startPowerRecharge() = 0;
virtual const AudioEventRTS& getInitiateSound() const = 0;
virtual Bool hasInitialReloadTime() const = 0;
virtual Bool isScriptOnly() const = 0;
};

Expand All @@ -83,6 +84,7 @@ class SpecialPowerModuleData : public BehaviorModuleData
AudioEventRTS m_initiateSound;
Bool m_updateModuleStartsAttack; ///< update module determines when the special power actually starts! If true, update module is required.
Bool m_startsPaused; ///< Paused on creation, someone else will have to unpause (like upgrade module, or script)
Bool m_hasInitialReloadTime; ///< If true, the special power will have a reload time on creation, otherwise it will be ready immediately.
Bool m_scriptedSpecialPowerOnly;
};

Expand Down Expand Up @@ -154,6 +156,7 @@ class SpecialPowerModule : public BehaviorModule,
virtual void startPowerRecharge() override;
virtual const AudioEventRTS& getInitiateSound() const override;

virtual Bool hasInitialReloadTime() const override;
virtual Bool isScriptOnly() const override;

protected:
Expand Down
16 changes: 16 additions & 0 deletions Generals/Code/GameEngine/Source/GameLogic/Object/SpecialPower/SpecialPowerModule.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ SpecialPowerModuleData::SpecialPowerModuleData()
m_specialPowerTemplate = nullptr;
m_updateModuleStartsAttack = false;
m_startsPaused = FALSE;
m_hasInitialReloadTime = TRUE;
m_scriptedSpecialPowerOnly = FALSE;

}
Expand All @@ -78,6 +79,7 @@ SpecialPowerModuleData::SpecialPowerModuleData()
{ "SpecialPowerTemplate", INI::parseSpecialPowerTemplate, nullptr, offsetof( SpecialPowerModuleData, m_specialPowerTemplate ) },
{ "UpdateModuleStartsAttack", INI::parseBool, nullptr, offsetof( SpecialPowerModuleData, m_updateModuleStartsAttack ) },
{ "StartsPaused", INI::parseBool, nullptr, offsetof( SpecialPowerModuleData, m_startsPaused ) },
{ "HasInitialReloadTime", INI::parseBool, nullptr, offsetof( SpecialPowerModuleData, m_hasInitialReloadTime ) },
{ "InitiateSound", INI::parseAudioEventRTS, nullptr, offsetof( SpecialPowerModuleData, m_initiateSound ) },
{ "ScriptedSpecialPowerOnly", INI::parseBool, nullptr, offsetof( SpecialPowerModuleData, m_scriptedSpecialPowerOnly ) },
{ nullptr, nullptr, nullptr, 0 }
Expand Down Expand Up @@ -113,7 +115,11 @@ SpecialPowerModule::SpecialPowerModule( Thing *thing, const ModuleData *moduleDa
//A sharedNSync special only startPowerRecharges when first scienced or when executed,
//Since a new module with same SPTemplates may construct at any time.
if ( getSpecialPowerTemplate()->isSharedNSync() == FALSE )
{
startPowerRecharge();
if (!hasInitialReloadTime())
m_availableOnFrame = TheGameLogic->getFrame();
}
}
// WE USED TO DO THE POLL-EVERYBODY-AND-VOTE-ON-WHO-TO-SYNC-TO THING HERE,
// BUT NO MORE, NOW IT IS HANDLED IN PLAYER
Expand Down Expand Up @@ -345,6 +351,16 @@ Real SpecialPowerModule::getPercentReady() const
return percent;
}

Bool SpecialPowerModule::hasInitialReloadTime() const
{
#if RETAIL_COMPATIBLE_CRC
return true;
#endif

const SpecialPowerModuleData* modData = getSpecialPowerModuleData();
return modData->m_hasInitialReloadTime;
}

//-------------------------------------------------------------------------------------------------
// A special power module that is only supposed to be fired via scripts. An example of this
// are the various cargo plane units we have. Scripters can launch specials from them after
Expand Down
9 changes: 9 additions & 0 deletions Generals/Code/GameEngine/Source/GameLogic/Object/Upgrade/UnpauseSpecialPowerUpgrade.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
#include "PreRTS.h"
#include "Common/SpecialPower.h"
#include "Common/Xfer.h"
#include "GameLogic/GameLogic.h"
#include "GameLogic/Object.h"
#include "GameLogic/Module/SpecialPowerModule.h"
#include "GameLogic/Module/UnpauseSpecialPowerUpgrade.h"
Expand Down Expand Up @@ -89,7 +90,15 @@ void UnpauseSpecialPowerUpgrade::upgradeImplementation()
continue;

if( sp->getSpecialPowerTemplate() == getUnpauseSpecialPowerUpgradeModuleData()->m_specialPower )
{
sp->pauseCountdown( FALSE );

if (!sp->hasInitialReloadTime())
{
UnsignedInt now = TheGameLogic->getFrame();
sp->setReadyFrame(now);
}
}
}
}

Expand Down
3 changes: 3 additions & 0 deletions GeneralsMD/Code/GameEngine/Include/GameLogic/Module/SpecialPowerModule.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ class SpecialPowerModuleInterface
virtual void markSpecialPowerTriggered( const Coord3D *location ) = 0;
virtual void startPowerRecharge() = 0;
virtual const AudioEventRTS& getInitiateSound() const = 0;
virtual Bool hasInitialReloadTime() const = 0;
virtual Bool isScriptOnly() const = 0;

//If the special power launches a construction site, we need to know the final product for placement purposes.
Expand All @@ -86,6 +87,7 @@ class SpecialPowerModuleData : public BehaviorModuleData
AudioEventRTS m_initiateSound;
Bool m_updateModuleStartsAttack; ///< update module determines when the special power actually starts! If true, update module is required.
Bool m_startsPaused; ///< Paused on creation, someone else will have to unpause (like upgrade module, or script)
Bool m_hasInitialReloadTime; ///< If true, the special power will have a reload time on creation, otherwise it will be ready immediately.
Bool m_scriptedSpecialPowerOnly;
};

Expand Down Expand Up @@ -157,6 +159,7 @@ class SpecialPowerModule : public BehaviorModule,
virtual void startPowerRecharge() override;
virtual const AudioEventRTS& getInitiateSound() const override;

virtual Bool hasInitialReloadTime() const override;
virtual Bool isScriptOnly() const override;

//If the special power launches a construction site, we need to know the final product for placement purposes.
Expand Down
16 changes: 16 additions & 0 deletions GeneralsMD/Code/GameEngine/Source/GameLogic/Object/SpecialPower/SpecialPowerModule.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ SpecialPowerModuleData::SpecialPowerModuleData()
m_specialPowerTemplate = nullptr;
m_updateModuleStartsAttack = false;
m_startsPaused = FALSE;
m_hasInitialReloadTime = TRUE;
m_scriptedSpecialPowerOnly = FALSE;

}
Expand All @@ -79,6 +80,7 @@ SpecialPowerModuleData::SpecialPowerModuleData()
{ "SpecialPowerTemplate", INI::parseSpecialPowerTemplate, nullptr, offsetof( SpecialPowerModuleData, m_specialPowerTemplate ) },
{ "UpdateModuleStartsAttack", INI::parseBool, nullptr, offsetof( SpecialPowerModuleData, m_updateModuleStartsAttack ) },
{ "StartsPaused", INI::parseBool, nullptr, offsetof( SpecialPowerModuleData, m_startsPaused ) },
{ "HasInitialReloadTime", INI::parseBool, nullptr, offsetof( SpecialPowerModuleData, m_hasInitialReloadTime ) },
{ "InitiateSound", INI::parseAudioEventRTS, nullptr, offsetof( SpecialPowerModuleData, m_initiateSound ) },
{ "ScriptedSpecialPowerOnly", INI::parseBool, nullptr, offsetof( SpecialPowerModuleData, m_scriptedSpecialPowerOnly ) },
{ nullptr, nullptr, nullptr, 0 }
Expand Down Expand Up @@ -114,7 +116,11 @@ SpecialPowerModule::SpecialPowerModule( Thing *thing, const ModuleData *moduleDa
//A sharedNSync special only startPowerRecharges when first scienced or when executed,
//Since a new module with same SPTemplates may construct at any time.
if ( getSpecialPowerTemplate()->isSharedNSync() == FALSE )
{
startPowerRecharge();
if (!hasInitialReloadTime())
m_availableOnFrame = TheGameLogic->getFrame();
}
}
// WE USED TO DO THE POLL-EVERYBODY-AND-VOTE-ON-WHO-TO-SYNC-TO THING HERE,
// BUT NO MORE, NOW IT IS HANDLED IN PLAYER
Expand Down Expand Up @@ -370,6 +376,16 @@ Real SpecialPowerModule::getPercentReady() const
return percent;
}

Bool SpecialPowerModule::hasInitialReloadTime() const
{
#if RETAIL_COMPATIBLE_CRC
return true;
#endif

const SpecialPowerModuleData* modData = getSpecialPowerModuleData();
return modData->m_hasInitialReloadTime;
}

//-------------------------------------------------------------------------------------------------
// A special power module that is only supposed to be fired via scripts. An example of this
// are the various cargo plane units we have. Scripters can launch specials from them after
Expand Down
9 changes: 9 additions & 0 deletions GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Upgrade/UnpauseSpecialPowerUpgrade.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
#include "PreRTS.h"
#include "Common/SpecialPower.h"
#include "Common/Xfer.h"
#include "GameLogic/GameLogic.h"
#include "GameLogic/Object.h"
#include "GameLogic/Module/SpecialPowerModule.h"
#include "GameLogic/Module/UnpauseSpecialPowerUpgrade.h"
Expand Down Expand Up @@ -89,7 +90,15 @@ void UnpauseSpecialPowerUpgrade::upgradeImplementation()
continue;

if( sp->getSpecialPowerTemplate() == getUnpauseSpecialPowerUpgradeModuleData()->m_specialPower )
{
sp->pauseCountdown( FALSE );

if (!sp->hasInitialReloadTime())
{
UnsignedInt now = TheGameLogic->getFrame();
sp->setReadyFrame(now);
}
}
}
}

Expand Down
Loading