Skip to content

Commit f6b309f

Browse files
committed
Added '@info' comments for functions.
1 parent ed4c7c5 commit f6b309f

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

Core/GameEngine/Source/Common/RandomValue.cpp

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,10 @@ DEBUG_LOG(( "%d: GetGameLogicRandomValue = %d (%d - %d), %s line %d",
229229
}
230230

231231
//
232-
// Integer random value; does not change the seed values
232+
// TheSuperHackers @info This function does not change the seed values with retail compability disabled.
233+
// Consecutive calls always return the same value for the same combination of min / max values, assuming the seed values haven't changed in between.
234+
// The intended use case for this function are randomized values that are desirable to be synchronized across clients,
235+
// but should not result in a mismatch if they aren't; e.g. for scripted audio events.
233236
//
234237
Int GetGameLogicCurrentRandomValue( int lo, int hi, const char *file, int line )
235238
{
@@ -327,7 +330,10 @@ DEBUG_LOG(( "%d: GetGameLogicRandomValueReal = %f, %s line %d",
327330
}
328331

329332
//
330-
// Real random value; does not change the seed values
333+
// TheSuperHackers @info This function does not change the seed values with retail compability disabled.
334+
// Consecutive calls always return the same value for the same combination of min / max values, assuming the seed values haven't changed in between.
335+
// The intended use case for this function are randomized values that are desirable to be synchronized across clients,
336+
// but should not result in a mismatch if they aren't; e.g. for scripted audio events.
331337
//
332338
Real GetGameLogicCurrentRandomValueReal( Real lo, Real hi, const char *file, int line )
333339
{

0 commit comments

Comments
 (0)