Merge branch 'TheSuperHackers:main' into feature/sdl3-input-backport

Author: githubawn

CONTRIBUTING.md

@@ -2,6 +2,21 @@
 
 To contribute, fork this repository to create your own copy that you can clone locally and push back to. You can use your fork to create pull requests for your code to be merged into this repository.
 
+
+## Contribution guidelines
+
+Prefer opening fewer high quality Pull Requests over many low quality ones. Prioritize polishing existing Pull Requests instead of creating new ones. Do not open Pull Requests as draft unless there are specific requirements that justify it, because draft Pull Requests are generally not looked at and pollute the Pull Request section.
+
+
+## AI code generation guidelines
+
+Creating changes with LLM generated code is generally allowed. The author is responsible for verifying that all generated code is human readable, maintainable and logically correct. Furthermore, all generated code needs to be tested and verified. The author is not allowed to outsource the polishing of the generated code to the human code reviewers. In a Pull Request, generated code needs to be announced as such and to what extent it was polished by human intervention.
+
+### New code contributors and AI generated code
+
+New contributors are discouraged from submitting Pull Requests with thousands of lines changed or added with the help of LLMs, because human code reviewers cannot attend such volumes at the risk of wasting precious time with potentially poorly generated code.
+
+
 ## Code guidelines
 
 ### Scope of code changes

Core/GameEngine/Include/Common/INI.h

@@ -160,13 +160,11 @@ typedef void (*BuildMultiIniFieldProc)(MultiIniFieldParse& p);
 //-------------------------------------------------------------------------------------------------
 class INI
 {
-  INI(const INI&);
-  INI& operator=(const INI&);
+	INI(const INI&) CPP_11(= delete);
+	INI& operator=(const INI&) CPP_11(= delete);
 
 public:
-
 	INI();
-	~INI();
 
 	// TheSuperHackers @feature xezon 19/08/2025
 	// Load a specific INI file by name and/or INI files from a directory (and its subdirectories).
@@ -251,11 +249,12 @@ class INI
 	AsciiString getFilename() const { return m_filename; }
 	INILoadType getLoadType() const { return m_loadType; }
 	UnsignedInt getLineNum() const { return m_lineNum; }
-	const char *getSeps() const { return m_seps; }
-	const char *getSepsPercent() const { return m_sepsPercent; }
-	const char *getSepsColon() const { return m_sepsColon; }
-	const char *getSepsQuote() { return m_sepsQuote; }
 	Bool isEOF() const { return m_endOfFile; }
+	static const char *getSeps()        { return " \n\r\t="; }   ///< default delimiters for strtok parsing
+	static const char *getSepsPercent() { return " \n\r\t=%%"; } ///< default delimiters & percent delimiter
+	static const char *getSepsColon()   { return " \n\r\t=:"; }  ///< default delimiters & colon delimiter
+	static const char *getSepsQuote()   { return "\"\n="; }      ///< delimiters to represent a quoted ascii string
+	static const char *getEndToken()    { return "End"; }        ///< token to represent an end of data block
 
 	void initFromINI( void *what, const FieldParse* parseTable );
 	void initFromINIMulti( void *what, const MultiIniFieldParse& parseTableList );
@@ -321,20 +320,19 @@ class INI
 	static void parseVeterancyLevelFlags(INI* ini, void* instance, void* store, const void* userData);
 	static void parseSoundsList( INI* ini, void *instance, void *store, const void* /*userData*/ );
 
-
 	/**
-		return the next token. if seps is null (or omitted), the standard seps are used.
+		return the next token. if seps is not specified, the standard seps are used.
 
 		this will *never* return null; if there are no more tokens, an exception will be thrown.
 	*/
-	const char* getNextToken(const char* seps = nullptr);
+	static const char* getNextToken(const char* seps = getSeps());
 
 	/**
 		just like getNextToken(), except that null is returned if no more tokens are present
 		(rather than throwing an exception). usually you should call getNextToken(),
 		but for some cases this is handier (ie, parsing a variable-length number of tokens).
 	*/
-	const char* getNextTokenOrNull(const char* seps = nullptr);
+	static const char* getNextTokenOrNull(const char* seps = getSeps());
 
 	/**
 		This is called when the next thing you expect is something like:
@@ -346,7 +344,7 @@ class INI
 
 		If "Tag" is not the next token, an error is thrown.
 	*/
-	const char* getNextSubToken(const char* expected);
+	static const char* getNextSubToken(const char* expected);
 
 	/**
 		return the next ascii string. this is usually the same the result of getNextToken(),
@@ -400,14 +398,9 @@ class INI
 	unsigned m_readBufferUsed;                ///< number of bytes in read buffer
 
 	AsciiString m_filename;										///< filename of file currently loading
-	INILoadType m_loadType;										///< load time for current file
+	INILoadType m_loadType;										///< load type for current file
 	UnsignedInt m_lineNum;										///< current line number that's been read
 	char m_buffer[ INI_MAX_CHARS_PER_LINE+1 ];///< buffer to read file contents into
-	const char *m_seps;												///< for strtok parsing
-	const char *m_sepsPercent;								///< m_seps with percent delimiter as well
-	const char *m_sepsColon;									///< m_seps with colon delimiter as well
-	const char *m_sepsQuote;									///< token to represent a quoted ascii string
-	const char *m_blockEndToken;							///< token to represent end of data block
 	Bool m_endOfFile;													///< TRUE when we've hit EOF
 #ifdef DEBUG_CRASHING
 	char m_curBlockStart[ INI_MAX_CHARS_PER_LINE+1 ];	///< first line of cur block

Core/GameEngine/Include/GameClient/View.h

@@ -187,8 +187,10 @@ class View : public Snapshot
 	virtual Real getDefaultPitch() { return m_defaultPitch; }						///< Return current default camera pitch
 	virtual void setAngleToDefault();															///< Set the view angle back to default
 	virtual void setPitchToDefault();															///< Set the view pitch back to default
-	void setPosition( const Coord3D *pos ) { m_pos = *pos; }
-	void getPosition(Coord3D *pos) { *pos = m_pos;}							///< Returns position camera is looking at (z will be zero)
+	void setPosition( const Coord3D &pos ) { m_pos = pos; }
+	void setPosition2D( const Coord2D &pos ) { m_pos.x = pos.x; m_pos.y = pos.y; }
+	const Coord3D &getPosition() const { return m_pos; } ///< Returns position camera is looking at
+	Coord2D getPosition2D() const { Coord2D c = { m_pos.x, m_pos.y }; return c; } ///< Returns position camera is looking at
 
 	virtual const Coord3D& get3DCameraPosition() const = 0;							///< Returns the actual camera position
 
@@ -201,7 +203,7 @@ class View : public Snapshot
 	virtual void setOkToAdjustHeight( Bool val ) { m_okToAdjustHeight = val; }	///< Set this to adjust camera height
 
 	// TheSuperHackers @info Functions to call for user camera controls, not by the scripted camera.
-	Bool userSetPosition(const Coord3D *pos)             { return doUserAction(&View::setPosition, pos); }
+	Bool userSetPosition(const Coord3D &pos)             { return doUserAction(&View::setPosition, pos); }
 	Bool userSetAngle(Real radians)                      { return doUserAction(&View::setAngle, radians); }
 	Bool userSetAngleToDefault()                         { return doUserAction(&View::setAngleToDefault); }
 	Bool userSetPitch(Real radians)                      { return doUserAction(&View::setPitch, radians); }
@@ -219,6 +221,8 @@ class View : public Snapshot
 	Bool userSetCameraLockDrawable(Drawable *drawable)   { return doUserAction(&View::setCameraLockDrawable, drawable); }
 
 	void lockUserControlUntilFrame(UnsignedInt frame) { m_userControlLockedUntilFrame = frame; } ///< Locks the user control over camera until the given frame is reached.
+
+	virtual void setUserControlled(Bool value) { m_isUserControlled = value; }
 	Bool isUserControlLocked() const;
 
 	// for debugging
@@ -268,13 +272,9 @@ class View : public Snapshot
 	virtual void xfer( Xfer *xfer ) override;
 	virtual void loadPostProcess() override { }
 
-	const Coord3D *getPosition() const { return &m_pos; }
-
 	virtual View *prependViewToList( View *list );							///< Prepend this view to the given list, return the new list
 	virtual View *getNextView() { return m_next; }				///< Return next view in the set
 
-	virtual void setUserControlled(Bool value) { m_isUserControlled = value; }
-
 private:
 
 	template<typename Function>
@@ -309,7 +309,7 @@ class View : public Snapshot
 	UnsignedInt m_userControlLockedUntilFrame;									///< Locks the user control over camera until the given frame is reached
 	Bool m_isUserControlled;																		///< True if the user moved the camera last, false if the scripted camera moved the camera last
 
-	Coord3D m_pos;																							///< Pivot of the camera, in world coordinates // TheSuperHackers @todo Make this Coord2D or use the Z component
+	Coord3D m_pos;																							///< Pivot of the camera, in world coordinates
 	Int m_width, m_height;																			///< Dimensions of the view
 	Int m_originX, m_originY;																		///< Location of top/left view corner
 
@@ -363,12 +363,10 @@ class ViewLocation
 	Real getPitch() const { return m_pitch; }
 	Real getZoom() const { return m_zoom; }
 
-	void init(Real x, Real y, Real z, Real angle, Real pitch, Real zoom)
+	void init(Coord3D pos, Real angle, Real pitch, Real zoom)
 	{
 		m_valid = true;
-		m_pos.x = x;
-		m_pos.y = y;
-		m_pos.z = z;
+		m_pos = pos;
 		m_angle = angle;
 		m_pitch = pitch;
 		m_zoom = zoom;
@@ -408,8 +406,8 @@ class ViewDummy : public View
 	}
 	virtual void screenToTerrain( const ICoord2D *screen, Coord3D *world ) override {}
 	virtual void screenToWorldAtZ( const ICoord2D *s, Coord3D *w, Real z ) override {}
-	virtual void drawView( void ) override {}
-	virtual void updateView(void) override {}
+	virtual void drawView() override {}
+	virtual void updateView() override {}
 	virtual void stepView() override {}
 	virtual void setGuardBandBias( const Coord2D *gb ) override {}
 	virtual Bool isDoingScriptedCamera() override { return false; }

Core/GameEngine/Source/Common/Audio/GameAudio.cpp

@@ -282,16 +282,16 @@ void AudioManager::reset()
 //-------------------------------------------------------------------------------------------------
 void AudioManager::update()
 {
-	Coord3D groundPos, microphonePos;
-	TheTacticalView->getPosition( &groundPos );
+	Coord3D cameraPivot = TheTacticalView->getPosition();
 	Real angle = TheTacticalView->getAngle();
 	Matrix3D rot = Matrix3D::Identity;
 	rot.Rotate_Z( angle );
 	Vector3 forward( 0, 1, 0 );
 	rot.mulVector3( forward );
 
-	Real desiredHeight = m_audioSettings->m_microphoneDesiredHeightAboveTerrain;
-	Real maxPercentage = m_audioSettings->m_microphoneMaxPercentageBetweenGroundAndCamera;
+	const Real desiredHeightRel = m_audioSettings->m_microphoneDesiredHeightAboveTerrain;
+	const Real desiredHeightAbs = desiredHeightRel + cameraPivot.z;
+	const Real maxPercentage = m_audioSettings->m_microphoneMaxPercentageBetweenGroundAndCamera;
 
 	Coord3D lookTo;
 	lookTo.set(forward.X, forward.Y, forward.Z);
@@ -303,18 +303,18 @@ void AudioManager::update()
 	Coord3D cameraPos = TheTacticalView->get3DCameraPosition();
 	Coord3D groundToCameraVector;
 	groundToCameraVector.set( &cameraPos );
-	groundToCameraVector.sub( &groundPos );
+	groundToCameraVector.sub( &cameraPivot );
 	Real bestScaleFactor;
 
-	if( cameraPos.z <= desiredHeight || groundToCameraVector.z <= 0.0f )
+	if( cameraPos.z <= desiredHeightAbs || groundToCameraVector.z <= 0.0f )
 	{
 		//Use the percentage calculation!
 		bestScaleFactor = maxPercentage;
 	}
 	else
 	{
 		//Calculate the stopping position of the groundToCameraVector when we force z to be m_microphoneDesiredHeightAboveTerrain
-		Real zScale = desiredHeight / groundToCameraVector.z;
+		Real zScale = desiredHeightRel / groundToCameraVector.z;
 
 		//Use the smallest of the two scale calculations
 		bestScaleFactor = MIN( maxPercentage, zScale );
@@ -324,8 +324,8 @@ void AudioManager::update()
 	groundToCameraVector.scale( bestScaleFactor );
 
 	//Set the microphone to be the ground position adjusted for terrain plus the vector we just calculated.
-	groundPos.z = TheTerrainLogic->getGroundHeight( groundPos.x, groundPos.y );
-	microphonePos.set( &groundPos );
+	Coord3D microphonePos;
+	microphonePos.set( &cameraPivot );
 	microphonePos.add( &groundToCameraVector );
 
 	//Viola! A properly placed microphone.

Core/GameEngine/Source/Common/INI/INI.cpp

@@ -180,26 +180,14 @@ INI::INI()
 	m_filename					= "None";
 	m_loadType					= INI_LOAD_INVALID;
 	m_lineNum						= 0;
-	m_seps							= " \n\r\t=";			///< make sure you update m_sepsPercent/m_sepsColon as well
-	m_sepsPercent				= " \n\r\t=%%";
-	m_sepsColon					= " \n\r\t=:";
-	m_sepsQuote					= "\"\n=";				///< stop at " = EOL
-	m_blockEndToken			= "END";
-	m_endOfFile					= FALSE;
 	m_buffer[0]					= 0;
+	m_endOfFile					= FALSE;
 #ifdef DEBUG_CRASHING
 	m_curBlockStart[0]	= 0;
 #endif
 
 }
 
-//-------------------------------------------------------------------------------------------------
-//-------------------------------------------------------------------------------------------------
-INI::~INI()
-{
-
-}
-
 //-------------------------------------------------------------------------------------------------
 UnsignedInt INI::loadFileDirectory( AsciiString fileDirName, INILoadType loadType, Xfer *pXfer, Bool subdirs )
 {
@@ -397,7 +385,7 @@ UnsignedInt INI::load( AsciiString filename, INILoadType loadType, Xfer *pXfer )
 			AsciiString currentLine = m_buffer;
 
 			// the first word is the type of data we're processing
-			const char *token = strtok( m_buffer, m_seps );
+			const char *token = strtok( m_buffer, getSeps() );
 			if( token )
 			{
 				INIBlockParse parse = findBlockParse(token);
@@ -710,7 +698,7 @@ void INI::parseAsciiStringVector( INI* ini, void * /*instance*/, void *store, co
 {
 	std::vector<AsciiString>* asv = (std::vector<AsciiString>*)store;
 	asv->clear();
-	for (const char *token = ini->getNextTokenOrNull(); token != nullptr; token = ini->getNextTokenOrNull())
+	for (const char *token = ini->getNextTokenOrNull(); token; token = ini->getNextTokenOrNull())
 	{
 		asv->push_back(token);
 	}
@@ -723,7 +711,7 @@ void INI::parseAsciiStringVectorAppend( INI* ini, void * /*instance*/, void *sto
 	std::vector<AsciiString>* asv = (std::vector<AsciiString>*)store;
 	// nope, don't clear. duh.
 	// asv->clear();
-	for (const char *token = ini->getNextTokenOrNull(); token != nullptr; token = ini->getNextTokenOrNull())
+	for (const char *token = ini->getNextTokenOrNull(); token; token = ini->getNextTokenOrNull())
 	{
 		asv->push_back(token);
 	}
@@ -735,7 +723,7 @@ void INI::parseAsciiStringVectorAppend( INI* ini, void * /*instance*/, void *sto
 {
 	ScienceVec* asv = (ScienceVec*)store;
 	asv->clear();
-	for (const char *token = ini->getNextTokenOrNull(); token != nullptr; token = ini->getNextTokenOrNull())
+	for (const char *token = ini->getNextTokenOrNull(); token; token = ini->getNextTokenOrNull())
 	{
 		if (stricmp(token, "None") == 0)
 		{
@@ -952,7 +940,7 @@ void INI::parseBitString32( INI* ini, void * /*instance*/, void *store, const vo
 	Bool foundAddOrSub = false;
 
 	// loop through all tokens
-	for (const char *token = ini->getNextTokenOrNull(); token != nullptr; token = ini->getNextTokenOrNull())
+	for (const char *token = ini->getNextTokenOrNull(); token; token = ini->getNextTokenOrNull())
 	{
 		if (stricmp(token, "NONE") == 0)
 		{
@@ -1528,7 +1516,7 @@ void INI::initFromINIMulti( void *what, const MultiIniFieldParse& parseTableList
 		if( field )
 		{
 
-			if( stricmp( field, m_blockEndToken ) == 0 )
+			if( stricmp( field, getEndToken() ) == 0 )
 			{
 				done = TRUE;
 			}
@@ -1580,7 +1568,7 @@ void INI::initFromINIMulti( void *what, const MultiIniFieldParse& parseTableList
 
 			done = TRUE;
 			DEBUG_CRASH( ("Error parsing block '%s', in INI file '%s'.  Missing '%s' token",
-												 m_curBlockStart, getFilename().str(), m_blockEndToken) );
+												 m_curBlockStart, getFilename().str(), getEndToken()) );
 			throw INI_MISSING_END_TOKEN;
 
 		}
@@ -1592,7 +1580,6 @@ void INI::initFromINIMulti( void *what, const MultiIniFieldParse& parseTableList
 //-------------------------------------------------------------------------------------------------
 /*static*/ const char* INI::getNextToken(const char* seps)
 {
-	if (!seps) seps = getSeps();
 	const char *token = ::strtok(nullptr, seps);
 	if (!token)
 		throw INI_INVALID_DATA;
@@ -1602,7 +1589,6 @@ void INI::initFromINIMulti( void *what, const MultiIniFieldParse& parseTableList
 //-------------------------------------------------------------------------------------------------
 /*static*/ const char* INI::getNextTokenOrNull(const char* seps)
 {
-	if (!seps) seps = getSeps();
 	const char *token = ::strtok(nullptr, seps);
 	return token;
 }
@@ -1876,12 +1862,10 @@ void INI::parseSoundsList( INI* ini, void *instance, void *store, const void* /*
 	std::vector<AsciiString> *vec = (std::vector<AsciiString>*) store;
 	vec->clear();
 
-	const char* SEPS = " \t,=";
-	const char *c = ini->getNextTokenOrNull(SEPS);
-	while ( c )
+	constexpr const char* Seps = " \t,=";
+	for (const char* token = ini->getNextTokenOrNull(Seps); token; token = ini->getNextTokenOrNull(Seps))
 	{
-		vec->push_back( c );
-		c = ini->getNextTokenOrNull(SEPS);
+		vec->push_back(token);
 	}
 }
 

Core/GameEngine/Source/GameClient/GUI/GameWindow.cpp

@@ -1579,7 +1579,6 @@ void GameWinDefaultTooltip( GameWindow *window,
 														WinInstanceData *instData,
 														UnsignedInt mouse )
 {
-	return;
 
 }
 
@@ -1589,8 +1588,6 @@ void GameWinDefaultTooltip( GameWindow *window,
 void GameWinDefaultDraw( GameWindow *window, WinInstanceData *instData )
 {
 
-	return;
-
 }
 
 // GameWindow::winSetEnabledImage =============================================

Core/GameEngine/Source/GameClient/Input/Mouse.cpp

@@ -824,7 +824,8 @@ void Mouse::createStreamMessages()
 		{
 			msg = TheMessageStream->appendMessage( GameMessage::MSG_RAW_MOUSE_WHEEL );
 			msg->appendPixelArgument( m_currMouse.pos );
-			msg->appendIntegerArgument( m_currMouse.wheelPos / 120 );  // wheel delta
+			// TheSuperHackers @bugfix Use float wheel delta to preserve fractional values from touchpad input
+			msg->appendRealArgument( m_currMouse.wheelPos / (Real)MOUSE_WHEEL_DELTA );
 			msg->appendIntegerArgument( TheKeyboard->getModifierFlags() );
 		}
 

Core/GameEngine/Source/GameClient/System/ParticleSys.cpp

@@ -3384,6 +3384,8 @@ void ParticleSystemManager::xfer( Xfer *xfer )
 	}
 	else
 	{
+		DEBUG_ASSERTCRASH(m_allParticleSystemList.empty(), ("ParticleSystemManager: particle systems list is expected empty at start of xfer-load."));
+
 		const ParticleSystemTemplate *systemTemplate;
 
 		// read each particle system