Clarify boolean result of ReorderLevelList()

softins · softins · commit 4b56a8cf705c · 2024-11-21T18:37:45.000Z
diff --git a/src/client.cpp b/src/client.cpp
@@ -1574,6 +1574,9 @@ int CClient::FindClientChannel ( const int iServerChannelID, const bool bCreateI
 //
 // The list size is checked against the current number of active channels to guard against
 // any unexpected temporary mismatch in size due to potential out-of-order message delivery.
+//
+// This function returns true if the list has been processed and should be passed on,
+// or false if it was the wrong size and should be discarded.
 
 bool CClient::ReorderLevelList ( CVector<uint16_t>& vecLevelList )
 {

Original file line number	Diff line number	Diff line change
`@@ -1574,6 +1574,9 @@ int CClient::FindClientChannel ( const int iServerChannelID, const bool bCreateI`
`1574`	`1574`	`//`
`1575`	`1575`	`// The list size is checked against the current number of active channels to guard against`
`1576`	`1576`	`// any unexpected temporary mismatch in size due to potential out-of-order message delivery.`
	`1577`	`+//`
	`1578`	`+// This function returns true if the list has been processed and should be passed on,`
	`1579`	`+// or false if it was the wrong size and should be discarded.`
`1577`	`1580`
`1578`	`1581`	`bool CClient::ReorderLevelList ( CVector<uint16_t>& vecLevelList )`
`1579`	`1582`	`{`