Skip to main content

App - Utilities & Math

ThreadPool, Http client, G3D primitives, math functions, and URL parsers.

Subsystem Metrics​

  • Total Documented Functions: 1822
  • Functions Exercised in Tests: 291
  • Platform-Divergent Implementations: 200
  • Component Source Files: 195

Source Files​

View all 195 source files in this subsystem
Source FilePath
Analytics.hApp/include/util/Analytics.h
AnimationId.hApp/include/util/AnimationId.h
AsyncHttpCache.hApp/include/util/AsyncHttpCache.h
AsyncHttpQueue.hApp/include/util/AsyncHttpQueue.h
Average.hApp/include/util/Average.h
Axes.hApp/include/util/Axes.h
BiMultiMap.hApp/include/util/BiMultiMap.h
BinaryString.hApp/include/util/BinaryString.h
BrickColor.hApp/include/util/BrickColor.h
CameraSubject.hApp/include/util/CameraSubject.h
CellID.hApp/include/util/CellID.h
CheatEngine.hApp/include/util/CheatEngine.h
ClusterCellIterator.hApp/include/util/ClusterCellIterator.h
Color.hApp/include/util/Color.h
CompactEnum.hApp/include/util/CompactEnum.h
ComputeProp.hApp/include/util/ComputeProp.h
ConcurrencyValidator.hApp/include/util/ConcurrencyValidator.h
ContentId.hApp/include/util/ContentId.h
ControlledLRUCache.hApp/include/util/ControlledLRUCache.h
DoubleEndedVector.hApp/include/util/DoubleEndedVector.h
ExponentialRunningAverage.hApp/include/util/ExponentialRunningAverage.h
Extents.hApp/include/util/Extents.h
ExtentsInt32.hApp/include/util/ExtentsInt32.h
Face.hApp/include/util/Face.h
Faces.hApp/include/util/Faces.h
FixedArray.hApp/include/util/FixedArray.h
FixedSizeCircularBuffer.hApp/include/util/FixedSizeCircularBuffer.h
Guid.hApp/include/util/Guid.h
Handle.hApp/include/util/Handle.h
HeapValue.hApp/include/util/HeapValue.h
HeartbeatInstance.hApp/include/util/HeartbeatInstance.h
HitTestFilter.hApp/include/util/HitTestFilter.h
Http.hApp/include/util/Http.h
HttpPlatformImpl.hApp/include/util/HttpPlatformImpl.h
IHasLocation.hApp/include/util/IHasLocation.h
IMetric.hApp/include/util/IMetric.h
IndexArray.hApp/include/util/IndexArray.h
IndexBox.hApp/include/util/IndexBox.h
IndexedMesh.hApp/include/util/IndexedMesh.h
IndexedTree.hApp/include/util/IndexedTree.h
LRUCache.hApp/include/util/LRUCache.h
Lcmrand.hApp/include/util/Lcmrand.h
MD5Hasher.hApp/include/util/MD5Hasher.h
Math.hApp/include/util/Math.h
MovementHistory.hApp/include/util/MovementHistory.h
Name.hApp/include/util/Name.h
NavKeys.hApp/include/util/NavKeys.h
NormalId.hApp/include/util/NormalId.h
Object.hApp/include/util/Object.h
ObscureValue.hApp/include/util/ObscureValue.h
PV.hApp/include/util/PV.h
PathInterpolatedCFrame.hApp/include/util/PathInterpolatedCFrame.h
PhysicalProperties.hApp/include/util/PhysicalProperties.h
PhysicsCoord.hApp/include/util/PhysicsCoord.h
Profiling.hApp/include/util/Profiling.h
ProgramMemoryChecker.hApp/include/util/ProgramMemoryChecker.h
ProgressIndicator.hApp/include/util/ProgressIndicator.h
ProtectedGeneric.hApp/include/util/ProtectedGeneric.h
ProtectedString.hApp/include/util/ProtectedString.h
Quaternion.hApp/include/util/Quaternion.h
Rect.hApp/include/util/Rect.h
Region2.hApp/include/util/Region2.h
Region3.hApp/include/util/Region3.h
Region3Int16.hApp/include/util/Region3Int16.h
Rotation2d.hApp/include/util/Rotation2d.h
RunStateOwner.hApp/include/util/RunStateOwner.h
ScopedAssign.hApp/include/util/ScopedAssign.h
ScriptInformationProvider.hApp/include/util/ScriptInformationProvider.h
Selectable.hApp/include/util/Selectable.h
Sound.hApp/include/util/Sound.h
SoundChannel.hApp/include/util/SoundChannel.h
SoundEffect.hApp/include/util/SoundEffect.h
SoundService.hApp/include/util/SoundService.h
SoundWorld.hApp/include/util/SoundWorld.h
SpanningEdge.hApp/include/util/SpanningEdge.h
SpanningNode.hApp/include/util/SpanningNode.h
SpatialRegion.hApp/include/util/SpatialRegion.h
SteppedInstance.hApp/include/util/SteppedInstance.h
StlExtra.hApp/include/util/StlExtra.h
StreamRegion.hApp/include/util/StreamRegion.h
SurfaceType.hApp/include/util/SurfaceType.h
SystemAddress.hApp/include/util/SystemAddress.h
TextureId.hApp/include/util/TextureId.h
ThreadPool.hApp/include/util/ThreadPool.h
TouchType.hApp/include/util/TouchType.h
URL.hApp/include/util/URL.h
Units.hApp/include/util/Units.h
UserInputBase.hApp/include/util/UserInputBase.h
Utilities.hApp/include/util/Utilities.h
VarInt.hApp/include/util/VarInt.h
Vector3int32.hApp/include/util/Vector3int32.h
Vector6.hApp/include/util/Vector6.h
Velocity.hApp/include/util/Velocity.h
base64.hppApp/include/util/base64.hpp
quadedge.hApp/include/util/quadedge.h
Analytics.cppApp/util/Analytics.cpp
FileSystem.cppApp/util/Android/FileSystem.cpp
MachineIdUploader.cppApp/util/Android/MachineIdUploader.cpp
MemoryStats.cppApp/util/Android/MemoryStats.cpp
StringConv.cppApp/util/Android/StringConv.cpp
AsyncHttpQueue.cppApp/util/AsyncHttpQueue.cpp
Axes.cppApp/util/Axes.cpp
Base64BinaryInputStream.cppApp/util/Base64BinaryInputStream.cpp
Base64BinaryOutputStream.cppApp/util/Base64BinaryOutputStream.cpp
BrickColor.cppApp/util/BrickColor.cpp
CacheableContentProvider.cppApp/util/CacheableContentProvider.cpp
CameraSubject.cppApp/util/CameraSubject.cpp
Color.cppApp/util/Color.cpp
ContentFilter.cppApp/util/ContentFilter.cpp
ContentId.cppApp/util/ContentId.cpp
ContentProvider.cppApp/util/ContentProvider.cpp
ContentProviderJob.cppApp/util/ContentProviderJob.cpp
FileSystem.mmApp/util/Darwin/FileSystem.mm
HttpCocoa.mmApp/util/Darwin/HttpCocoa.mm
MachineIdUploader_OSX.cppApp/util/Darwin/MachineIdUploader_OSX.cpp
MemoryStats.cppApp/util/Darwin/MemoryStats.cpp
StringConv.cppApp/util/Darwin/StringConv.cpp
FileSystemDurango.cppApp/util/Durango/FileSystemDurango.cpp
ProgramMemoryChecker.cppApp/util/Durango/ProgramMemoryChecker.cpp
Extents.cppApp/util/Extents.cpp
Face.cppApp/util/Face.cpp
Faces.cppApp/util/Faces.cpp
FileSystemIndependent.cppApp/util/FileSystemIndependent.cpp
Guid.cppApp/util/Guid.cpp
Handle.cppApp/util/Handle.cpp
Hash.cppApp/util/Hash.cpp
HeartbeatInstance.cppApp/util/HeartbeatInstance.cpp
HitTest.cppApp/util/HitTest.cpp
HttpAsync.cppApp/util/HttpAsync.cpp
IndexBox.cppApp/util/IndexBox.cpp
IndexedMesh.cppApp/util/IndexedMesh.cpp
IndexedTree.cppApp/util/IndexedTree.cpp
LegacyContentTable.cppApp/util/LegacyContentTable.cpp
LuaWebService.cppApp/util/LuaWebService.cpp
MD5Hasher.cppApp/util/MD5Hasher.cpp
MachineIdUploader.cppApp/util/MachineIdUploader.cpp
MachineIdUploader_Windows.cppApp/util/MachineIdUploader_Windows.cpp
Math.cppApp/util/Math.cpp
MemoryStats.cppApp/util/MemoryStats.cpp
MemoryStatsCommon.cppApp/util/MemoryStatsCommon.cpp
MeshContentProvider.cppApp/util/MeshContentProvider.cpp
MovementHistory.cppApp/util/MovementHistory.cpp
Name.cppApp/util/Name.cpp
NormalId.cppApp/util/NormalId.cpp
PathInterpolatedCFrame.cppApp/util/PathInterpolatedCFrame.cpp
PhysicalProperties.cppApp/util/PhysicalProperties.cpp
Profiling.cppApp/util/Profiling.cpp
ProgramMemoryChecker.cppApp/util/ProgramMemoryChecker.cpp
ProtectedString.cppApp/util/ProtectedString.cpp
Quaternion.cppApp/util/Quaternion.cpp
RbxStringTable.cppApp/util/RbxStringTable.cpp
Rect.cppApp/util/Rect.cpp
Region2.cppApp/util/Region2.cpp
Region3.cppApp/util/Region3.cpp
Region3int32.cppApp/util/Region3int32.cpp
RobloxGoogleAnalytics.cppApp/util/RobloxGoogleAnalytics.cpp
RunStateOwner.cppApp/util/RunStateOwner.cpp
RunningAverage.cppApp/util/RunningAverage.cpp
Http.cppApp/util/Shared/Http.cpp
HttpCacheEntry.cppApp/util/Shared/HttpCacheEntry.cpp
HttpPlatformImpl.cppApp/util/Shared/HttpPlatformImpl.cpp
Sound.cppApp/util/Sound.cpp
SoundChannel.cppApp/util/SoundChannel.cpp
SoundEffect.cppApp/util/SoundEffect.cpp
SoundService.cppApp/util/SoundService.cpp
SpanningEdge.cppApp/util/SpanningEdge.cpp
SpanningNode.cppApp/util/SpanningNode.cpp
SpanningTree.cppApp/util/SpanningTree.cpp
SpatialRegion.cppApp/util/SpatialRegion.cpp
Statistics.cppApp/util/Statistics.cpp
SteppedInstance.cppApp/util/SteppedInstance.cpp
StreamRegion.cppApp/util/StreamRegion.cpp
TextureContentProvider.cppApp/util/TextureContentProvider.cpp
ThreadPool.cppApp/util/ThreadPool.cpp
UDim.cppApp/util/UDim.cpp
URL.cppApp/util/URL.cpp
UintSet.cppApp/util/UintSet.cpp
Units.cppApp/util/Units.cpp
MachOBaseAddr.mmApp/util/Unix/MachOBaseAddr.mm
ProgramMemoryChecker.cppApp/util/Unix/ProgramMemoryChecker.cpp
UserInputBase.cppApp/util/UserInputBase.cpp
Utilities.cppApp/util/Utilities.cpp
Vector3int32.cppApp/util/Vector3int32.cpp
CheatEngine.cppApp/util/Win/CheatEngine.cpp
FileSystem.cppApp/util/Win/FileSystem.cpp
WinHeap.cppApp/util/WinHeap.cpp
WinHttp.cppApp/util/WinHttp.cpp
WinInet.cppApp/util/WinInet.cpp
XboxHttp2.cppApp/util/XboxHttp2.cpp
gpc.cApp/util/gpc.c
md5.cApp/util/md5.c
quadedge.cppApp/util/quadedge.cpp
rbxrandom.cppApp/util/rbxrandom.cpp
standardout.cppApp/util/standardout.cpp
xxhash.cApp/util/xxhash.c

Function Reference​

1. Points​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

public: Points();
PropertyValue
Return Typepublic:
ModifiersNone
Source LocationApp/include/util/Analytics.h:160
SubsystemApp - Utilities & Math

How it Works Internally​

Declaration or inline method for Points.

  • Control Flow & Execution: Linear execution flow.
  • Memory Management: Standard stack allocation.
  • Concurrency & Thread Safety: Unsynchronized / single-threaded context.
  • Error Handling & Invariants: Standard return value verification.
  • State Mutation: Stateless or local modification.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on Points.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


2. setUserIdOverride​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void setUserIdOverride(const int id);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/Analytics.h:164
SubsystemApp - Utilities & Math

How it Works Internally​

Executes setUserIdOverride within App - Utilities & Math. Coordinates interactions with format.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: format.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on setUserIdOverride.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


3. addPoint​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void addPoint(const std::string& name, const rapidjson::Value& value, bool override = false);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/Analytics.h:169
SubsystemApp - Utilities & Math

How it Works Internally​

Executes addPoint within App - Utilities & Math. Coordinates interactions with Point, insert, erase.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: Point, insert, erase.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on addPoint.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


4. report​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void report(const std::string& resource, int throttleHundredthsPercentage, bool blocking = false);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/Analytics.h:181
SubsystemApp - Utilities & Math

How it Works Internally​

Executes report within App - Utilities & Math. Coordinates interactions with empty, reportPointsV2, reportPoints, clear.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: empty, reportPointsV2, reportPoints, clear.
  • External Library Dependencies: InfluxDB Metrics Ingestion Client.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on report.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


5. getPoints​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

boost::unordered_set<Point>& getPoints() const;
PropertyValue
Return Typeboost::unordered_set&lt;Point&gt;&
Modifiersconst
Source LocationApp/include/util/Analytics.h:193
SubsystemApp - Utilities & Math

How it Works Internally​

Executes getPoints within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getPoints.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


6. isActive​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

bool isActive() const;
PropertyValue
Return Typebool
Modifiersconst
Source LocationApp/include/util/AnimationId.h:13
SubsystemApp - Utilities & Math

How it Works Internally​

Executes isActive within App - Utilities & Math. Coordinates interactions with toString, substr.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: toString, substr.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on isActive.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


7. nullAnimation​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

AnimationId nullAnimation();
PropertyValue
Return TypeAnimationId
Modifiersstatic
Source LocationApp/include/util/AnimationId.h:15
SubsystemApp - Utilities & Math

How it Works Internally​

Executes nullAnimation within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on nullAnimation.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


8. getRequestedUrls​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

shared_ptr<const Reflection::ValueArray> getRequestedUrls();
PropertyValue
Return Typeshared_ptr&lt;const Reflection::ValueArray&gt;
ModifiersNone
Source LocationApp/include/util/AsyncHttpCache.h:16
SubsystemApp - Utilities & Math

How it Works Internally​

Executes getRequestedUrls within App - Utilities & Math. Coordinates interactions with result, lock, begin, end. Employs reference-counted heap object ownership (boost::shared_ptr).

  • Control Flow & Execution: Iterative loop processing, Conditional branching, Explicit result return.
  • Memory Management: Reference-counted heap object ownership (boost::shared_ptr).
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock); Thread mutual exclusion locking (boost::mutex).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: result, lock, begin, end, isHttp, push_back, toString.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getRequestedUrls.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


9. setCacheSize​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void setCacheSize(int count);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/AsyncHttpCache.h:41
SubsystemApp - Utilities & Math

How it Works Internally​

Executes setCacheSize within App - Utilities & Math. Coordinates interactions with lock, resize.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock); Thread mutual exclusion locking (boost::mutex).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, resize.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on setCacheSize.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


10. findCacheItem​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

bool findCacheItem(const std::string& id, CachedContent* result);
PropertyValue
Return Typebool
ModifiersNone
Source LocationApp/include/util/AsyncHttpCache.h:47
SubsystemApp - Utilities & Math

How it Works Internally​

Executes findCacheItem within App - Utilities & Math. Coordinates interactions with lock, fetch.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock); Thread mutual exclusion locking (boost::mutex).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, fetch.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on findCacheItem.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


11. removeCacheItem​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void removeCacheItem(const std::string& id);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/AsyncHttpCache.h:53
SubsystemApp - Utilities & Math

How it Works Internally​

Executes removeCacheItem within App - Utilities & Math. Coordinates interactions with lock, remove.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock); Thread mutual exclusion locking (boost::mutex).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, remove.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on removeCacheItem.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


12. invalidateCacheItemOrFailure​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void invalidateCacheItemOrFailure(const std::string& id);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/AsyncHttpCache.h:58
SubsystemApp - Utilities & Math

How it Works Internally​

Executes invalidateCacheItemOrFailure within App - Utilities & Math. Coordinates interactions with lock, remove, end, begin.

  • Control Flow & Execution: Iterative loop processing, Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock); Thread mutual exclusion locking (boost::mutex).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, remove, end, begin, erase.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on invalidateCacheItemOrFailure.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


13. insertCacheItem​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void insertCacheItem(const std::string& id, const CachedContent& result);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/AsyncHttpCache.h:79
SubsystemApp - Utilities & Math

How it Works Internally​

Executes insertCacheItem within App - Utilities & Math. Coordinates interactions with lock, insert.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock); Thread mutual exclusion locking (boost::mutex).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, insert.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on insertCacheItem.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


14. renameCacheItem​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void renameCacheItem(const std::string& id, const std::string& newId);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/AsyncHttpCache.h:84
SubsystemApp - Utilities & Math

How it Works Internally​

Executes renameCacheItem within App - Utilities & Math. Coordinates interactions with lock, fetch, remove, insert.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock); Thread mutual exclusion locking (boost::mutex).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, fetch, remove, insert.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on renameCacheItem.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


15. clearCache​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void clearCache();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/AsyncHttpCache.h:95
SubsystemApp - Utilities & Math

How it Works Internally​

Executes clearCache within App - Utilities & Math. Coordinates interactions with lock, clear.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock); Thread mutual exclusion locking (boost::mutex).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, clear.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on clearCache.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


16. printContentNames​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void printContentNames();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/AsyncHttpCache.h:107
SubsystemApp - Utilities & Math

How it Works Internally​

Executes printContentNames within App - Utilities & Math. Coordinates interactions with lock.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock); Thread mutual exclusion locking (boost::mutex).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on printContentNames.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


17. setCachePolicy​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void setCachePolicy(const HttpCache::Policy policy);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/AsyncHttpQueue.h:47
SubsystemApp - Utilities & Math

How it Works Internally​

Executes setCachePolicy within App - Utilities & Math.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on setCachePolicy.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


18. getAvgTimeInQueue​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

double getAvgTimeInQueue();
PropertyValue
Return Typedouble
ModifiersNone
Source LocationApp/include/util/AsyncHttpQueue.h:69
SubsystemApp - Utilities & Math

How it Works Internally​

Executes getAvgTimeInQueue within App - Utilities & Math. Coordinates interactions with value.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: value.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getAvgTimeInQueue.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


19. getAvgRequestCompleteTime​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

double getAvgRequestCompleteTime();
PropertyValue
Return Typedouble
ModifiersNone
Source LocationApp/include/util/AsyncHttpQueue.h:70
SubsystemApp - Utilities & Math

How it Works Internally​

Executes getAvgRequestCompleteTime within App - Utilities & Math. Coordinates interactions with value.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: value.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getAvgRequestCompleteTime.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


20. getNumSlowRequests​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

int getNumSlowRequests();
PropertyValue
Return Typeint
ModifiersNone
Source LocationApp/include/util/AsyncHttpQueue.h:71
SubsystemApp - Utilities & Math

How it Works Internally​

Executes getNumSlowRequests within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getNumSlowRequests.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


21. registerContent​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void registerContent(const std::string& url, shared_ptr<const std::string> response, shared_ptr<const std::string> filename);
PropertyValue
Return Typevoid
Modifiersvirtual
Source LocationApp/include/util/AsyncHttpQueue.h:74
SubsystemApp - Utilities & Math

How it Works Internally​

Declaration or inline method for registerContent.

  • Control Flow & Execution: Linear execution flow.
  • Memory Management: Standard stack allocation.
  • Concurrency & Thread Safety: Unsynchronized / single-threaded context.
  • Error Handling & Invariants: Standard return value verification.
  • State Mutation: Stateless or local modification.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on registerContent.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


22. sample​

Status: 🧪 Tested  |  🌐 Cross-Platform Uniform

void sample(T value, bool advanceBuffer = true);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/Average.h:20
SubsystemApp - Utilities & Math

How it Works Internally​

Executes sample within App - Utilities & Math.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

This function is exercised in 1 test case(s):

  • PathfindingTest::PathfindingStress (App.UnitTest/PathfindingTest.cpp:48)
    • Usage Pattern: Direct Call
    • Callsite Snippet: runAverage.sample(RakNet::GetTime() - start_test_time);

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


23. getAverage​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

T getAverage() const;
PropertyValue
Return TypeT
Modifiersconst
Source LocationApp/include/util/Average.h:28
SubsystemApp - Utilities & Math

How it Works Internally​

Executes getAverage within App - Utilities & Math.

  • Control Flow & Execution: Iterative loop processing, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getAverage.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


24. size​

Status: 🧪 Tested  |  ⚠️ Platform Divergent

size_t size() const;
PropertyValue
Return Typesize_t
Modifiersconst
Source LocationApp/include/util/Average.h:37
SubsystemApp - Utilities & Math

How it Works Internally​

Executes size within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

This function is exercised in 59 test case(s):

  • Instance::LockUnlockDeprecated (App.UnitTest/Instance.cpp:186)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_REQUIRE_EQUAL(result-&gt;values.size(), 1)
    • Callsite Snippet: BOOST_REQUIRE_EQUAL(result-&gt;values.size(), 1);
  • WebSerializer::TestWebSerializerList (App.UnitTest/WebSerializerTest.cpp:12)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(newValueCollection-&gt;size() == valueCollection-&gt;size())
    • Callsite Snippet: BOOST_CHECK(newValueCollection-&gt;size() == valueCollection-&gt;size());
  • WebSerializer::TestWebSerializerTable (App.UnitTest/WebSerializerTest.cpp:57)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(newValueMap-&gt;size() == valueMap-&gt;size())
    • Callsite Snippet: BOOST_CHECK(newValueMap-&gt;size() == valueMap-&gt;size());
  • WebSerializer::TestWebSerializerInstance (App.UnitTest/WebSerializerTest.cpp:115)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(newValue.get&lt;shared_ptr&lt;Instance&gt; &gt;()-&gt;getChildren()-&gt;size() == 3)
    • Callsite Snippet: BOOST_CHECK(newValue.get&lt;shared_ptr&lt;Instance&gt; &gt;()-&gt;getChildren()-&gt;size() == 3);

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/p2p.h.

  • Alternative Implementation Files: XboxClient/p2p.h

25. getValue​

Status: 🧪 Tested  |  🌐 Cross-Platform Uniform

T& getValue(size_t index) const;
PropertyValue
Return TypeT&
Modifiersconst const
Source LocationApp/include/util/Average.h:41
SubsystemApp - Utilities & Math

How it Works Internally​

Executes getValue within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

This function is exercised in 5 test case(s):

  • Xml::Parse (App.UnitTest/XmlElement.cpp:12)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_REQUIRE(node-&gt;getValue(value)), BOOST_REQUIRE(attribute-&gt;getValue(value))
    • Callsite Snippet: BOOST_REQUIRE(node-&gt;getValue(value));
  • Xml::StringToInt (App.UnitTest/XmlElement.cpp:42)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(element.getValue(i)), BOOST_CHECK(!element2.getValue(i)), BOOST_CHECK(!element3.getValue(i))
    • Callsite Snippet: BOOST_CHECK(element.getValue(i));
  • ModuleScriptTest::ReturnStatefulClosure (App.UnitTest/ModuleScriptTest.cpp:63)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK_EQUAL(16, Instance::fastDynamicCast&lt;IntValue&gt;(inst16)-&gt;getValue())
    • Callsite Snippet: BOOST_CHECK_EQUAL(16, Instance::fastDynamicCast&lt;IntValue&gt;(inst16)-&gt;getValue());
  • ModuleScriptTest::SharedLoadResult (App.UnitTest/ModuleScriptTest.cpp:108)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK_EQUAL(14, Instance::fastDynamicCast&lt;IntValue&gt;(inst14)-&gt;getValue())
    • Callsite Snippet: BOOST_CHECK_EQUAL(14, Instance::fastDynamicCast&lt;IntValue&gt;(inst14)-&gt;getValue());

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


26. resetValues​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void resetValues(const T& value);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/Average.h:45
SubsystemApp - Utilities & Math

How it Works Internally​

Executes resetValues within App - Utilities & Math.

  • Control Flow & Execution: Iterative loop processing.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on resetValues.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


27. resetValues​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void resetValues(size_t samplesNew, const T& value);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/Average.h:51
SubsystemApp - Utilities & Math

How it Works Internally​

Executes resetValues within App - Utilities & Math. Coordinates interactions with resize.

  • Control Flow & Execution: Iterative loop processing.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: resize.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on resetValues.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


28. clear​

Status: 🧪 Tested  |  🌐 Cross-Platform Uniform

void clear();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/Axes.h:18
SubsystemApp - Utilities & Math

How it Works Internally​

Executes clear within App - Utilities & Math.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

This function is exercised in 2 test case(s):

  • signals::AssignmentOperator (Base.UnitTest/signals.cpp:350)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_CHECK_EQUAL(result, "Hello"), BOOST_CHECK_EQUAL(result, "")
    • Callsite Snippet: result.clear();
  • signals::ReentrantResetScopedConnection (Base.UnitTest/signals.cpp:413)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_CHECK_EQUAL(result, "Reset"), BOOST_CHECK_EQUAL(result, "HelloReset#")
    • Callsite Snippet: result.clear();

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


29. pairInMap​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

bool pairInMap(const Left& left, const Right& right);
PropertyValue
Return Typebool
ModifiersNone
Source LocationApp/include/util/BiMultiMap.h:17
SubsystemApp - Utilities & Math

How it Works Internally​

Executes pairInMap within App - Utilities & Math. Coordinates interactions with lower_bound, upper_bound.

  • Control Flow & Execution: Iterative loop processing, Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lower_bound, upper_bound.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on pairInMap.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


30. insertPair​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void insertPair(const Left& left, const Right& right);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/BiMultiMap.h:27
SubsystemApp - Utilities & Math

How it Works Internally​

Executes insertPair within App - Utilities & Math. Coordinates interactions with RBXASSERT_SLOW, pairInMap, insert, make_pair.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: RBXASSERT_SLOW, pairInMap, insert, make_pair.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on insertPair.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


31. removePair​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void removePair(const Left& left, const Right& right);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/BiMultiMap.h:32
SubsystemApp - Utilities & Math

How it Works Internally​

Executes removePair within App - Utilities & Math. Coordinates interactions with RBXASSERT_SLOW, pairInMap, lower_bound, upper_bound.

  • Control Flow & Execution: Iterative loop processing, Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT).
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: RBXASSERT_SLOW, pairInMap, lower_bound, upper_bound, erase, RBXASSERT.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on removePair.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


32. empty​

Status: 🧪 Tested  |  🌐 Cross-Platform Uniform

bool empty() const;
PropertyValue
Return Typebool
Modifiersconst
Source LocationApp/include/util/BiMultiMap.h:45
SubsystemApp - Utilities & Math

How it Works Internally​

Executes empty within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

This function is exercised in 6 test case(s):

  • LuaDebugger::FlatDataSerialization (App.UnitTest/LuaDebugger.cpp:139)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(binaryDataStreamOriginal.str().empty() != true)
    • Callsite Snippet: BOOST_CHECK(binaryDataStreamOriginal.str().empty() != true);
  • LuaDebugger::NestedDataSerialization (App.UnitTest/LuaDebugger.cpp:211)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(binaryDataStreamOriginal.str().empty() != true)
    • Callsite Snippet: BOOST_CHECK(binaryDataStreamOriginal.str().empty() != true);
  • URLParser::Split (App.UnitTest/URLParserTest.cpp:7)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(url.query().empty())
    • Callsite Snippet: BOOST_CHECK(url.query().empty());
  • URLParser::Invalid (App.UnitTest/URLParserTest.cpp:128)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_CHECK(!url.isValid()), BOOST_CHECK_EQUAL(url.asString(), "")
    • Callsite Snippet: BOOST_CHECK(url.scheme().empty());

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


33. emptyLeft​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

bool emptyLeft(const Left& left) const;
PropertyValue
Return Typebool
Modifiersconst
Source LocationApp/include/util/BiMultiMap.h:49
SubsystemApp - Utilities & Math

How it Works Internally​

Executes emptyLeft within App - Utilities & Math. Coordinates interactions with return, lower_bound, upper_bound.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: return, lower_bound, upper_bound.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on emptyLeft.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


34. visitEachLeft​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void visitEachLeft(const Left& left, const Func& func) const;
PropertyValue
Return Typevoid
Modifiersinline const
Source LocationApp/include/util/BiMultiMap.h:53
SubsystemApp - Utilities & Math

How it Works Internally​

Executes visitEachLeft within App - Utilities & Math. Coordinates interactions with lower_bound, upper_bound, func.

  • Control Flow & Execution: Iterative loop processing.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: lower_bound, upper_bound, func.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on visitEachLeft.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


35. BinaryString​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

public: BinaryString();
PropertyValue
Return Typepublic:
ModifiersNone
Source LocationApp/include/util/BinaryString.h:9
SubsystemApp - Utilities & Math

How it Works Internally​

Declaration or inline method for BinaryString.

  • Control Flow & Execution: Linear execution flow.
  • Memory Management: Standard stack allocation.
  • Concurrency & Thread Safety: Unsynchronized / single-threaded context.
  • Error Handling & Invariants: Standard return value verification.
  • State Mutation: Stateless or local modification.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on BinaryString.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


36. internalValue​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

: internalValue(value);
PropertyValue
Return Type:
ModifiersNone
Source LocationApp/include/util/BinaryString.h:15
SubsystemApp - Utilities & Math

How it Works Internally​

Declaration or inline method for internalValue.

  • Control Flow & Execution: Linear execution flow.
  • Memory Management: Standard stack allocation.
  • Concurrency & Thread Safety: Unsynchronized / single-threaded context.
  • Error Handling & Invariants: Standard return value verification.
  • State Mutation: Stateless or local modification.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on internalValue.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


37. value​

Status: 🧪 Tested  |  🌐 Cross-Platform Uniform

std::string& value() const;
PropertyValue
Return Typestd::string&
Modifiersconst const
Source LocationApp/include/util/BinaryString.h:18
SubsystemApp - Utilities & Math

How it Works Internally​

Executes value within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

This function is exercised in 2 test case(s):

  • StreamRegionTest::RegionIdCreateTest (App.UnitTest/StreamRegionTest.cpp:80)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK_EQUAL(Vector3int32(-1, 0, 0), regionId.value())
    • Callsite Snippet: BOOST_CHECK_EQUAL(Vector3int32(-1, 0, 0), regionId.value());
  • SpatialRegionTest::RegionContainingVoxel (App.UnitTest/SpatialRegionTest.cpp:9)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK_EQUAL(Vector3int16::zero(), id.value()), BOOST_CHECK_EQUAL(Vector3int16::zero(), id.value()), BOOST_CHECK_EQUAL(Vector3int16(-1,-1,-1), id.value()), BOOST_CHECK_EQUAL(Vector3int16(-1,-1,-1), id.value())
    • Callsite Snippet: BOOST_CHECK_EQUAL(Vector3int16::zero(), id.value());

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


38. set​

Status: 🧪 Tested  |  🌐 Cross-Platform Uniform

void set(const char* buffer, unsigned int size);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/BinaryString.h:23
SubsystemApp - Utilities & Math

How it Works Internally​

Executes set within App - Utilities & Math. Coordinates interactions with assign.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: assign.

How it is Used in Tests​

This function is exercised in 19 test case(s):

  • ReplicatorGcJobTest::RegionRemovalIdsKeepFirstSeenOrder (App.UnitTest/ReplicatorGcJobTest.cpp:34)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_CHECK(ids.insert(first)), BOOST_CHECK(ids.insert(second))
    • Callsite Snippet: first.scope.set("stream-out-test-a");
  • ReplicatorGcJobTest::MovingPartOutsideOfStreamedAreaCausesItToBeGced (App.UnitTest/ReplicatorGcJobTest.cpp:98)
    • Usage Pattern: Performance Benchmark
    • Assertions Checked: BOOST_REQUIRE(clientDm-&gt;getWorkspace()-&gt;findFirstChildByName("BasePlate")), BOOST_REQUIRE(clientDm-&gt;getWorkspace()-&gt;findFirstChildByName("ToStreamOut"))
    • Callsite Snippet: Workspace::prop_StreamingEnabled.set(serverDm-&gt;getWorkspace(), true);
  • ReplicatorGcJobTest::MovingPartAndItsParentOutsideOfStreamedAreaShouldNotRemoveThePartTwice (App.UnitTest/ReplicatorGcJobTest.cpp:195)
    • Usage Pattern: Performance Benchmark
    • Assertions Checked: BOOST_REQUIRE(clientDm-&gt;getWorkspace()-&gt;findFirstChildByName("BasePlate")), BOOST_REQUIRE(parent)
    • Callsite Snippet: Workspace::prop_StreamingEnabled.set(serverDm-&gt;getWorkspace(), true);
  • ReplicatorGcJobTest::ReparentingToGcedPartCausesInstanceToLeave (App.UnitTest/ReplicatorGcJobTest.cpp:305)
    • Usage Pattern: Performance Benchmark
    • Assertions Checked: BOOST_REQUIRE(clientDm-&gt;getWorkspace()-&gt;findFirstChildByName("Inside")), BOOST_REQUIRE(clientDm-&gt;getWorkspace()-&gt;findFirstChildByName("Outside"))
    • Callsite Snippet: Workspace::prop_StreamingEnabled.set(serverDm-&gt;getWorkspace(), true);

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


39. brickWhite​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

BrickColor brickWhite();
PropertyValue
Return TypeBrickColor
Modifiersinline static
Source LocationApp/include/util/BrickColor.h:255
SubsystemApp - Utilities & Math

How it Works Internally​

Executes brickWhite within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on brickWhite.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


40. brickGray​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

BrickColor brickGray();
PropertyValue
Return TypeBrickColor
Modifiersinline static
Source LocationApp/include/util/BrickColor.h:259
SubsystemApp - Utilities & Math

How it Works Internally​

Executes brickGray within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on brickGray.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


41. brickDarkGray​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

BrickColor brickDarkGray();
PropertyValue
Return TypeBrickColor
Modifiersinline static
Source LocationApp/include/util/BrickColor.h:263
SubsystemApp - Utilities & Math

How it Works Internally​

Executes brickDarkGray within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on brickDarkGray.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


42. brickBlack​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

BrickColor brickBlack();
PropertyValue
Return TypeBrickColor
Modifiersinline static
Source LocationApp/include/util/BrickColor.h:267
SubsystemApp - Utilities & Math

How it Works Internally​

Executes brickBlack within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on brickBlack.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


43. brickRed​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

BrickColor brickRed();
PropertyValue
Return TypeBrickColor
Modifiersinline static
Source LocationApp/include/util/BrickColor.h:271
SubsystemApp - Utilities & Math

How it Works Internally​

Executes brickRed within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on brickRed.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


44. brickYellow​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

BrickColor brickYellow();
PropertyValue
Return TypeBrickColor
Modifiersinline static
Source LocationApp/include/util/BrickColor.h:275
SubsystemApp - Utilities & Math

How it Works Internally​

Executes brickYellow within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on brickYellow.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


45. brickGreen​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

BrickColor brickGreen();
PropertyValue
Return TypeBrickColor
Modifiersinline static
Source LocationApp/include/util/BrickColor.h:279
SubsystemApp - Utilities & Math

How it Works Internally​

Executes brickGreen within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on brickGreen.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


46. baseplateGreen​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

BrickColor baseplateGreen();
PropertyValue
Return TypeBrickColor
Modifiersinline static
Source LocationApp/include/util/BrickColor.h:283
SubsystemApp - Utilities & Math

How it Works Internally​

Executes baseplateGreen within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on baseplateGreen.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


47. brickBlue​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

BrickColor brickBlue();
PropertyValue
Return TypeBrickColor
Modifiersinline static
Source LocationApp/include/util/BrickColor.h:287
SubsystemApp - Utilities & Math

How it Works Internally​

Executes brickBlue within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on brickBlue.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


48. defaultColor​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

BrickColor defaultColor();
PropertyValue
Return TypeBrickColor
Modifiersinline static
Source LocationApp/include/util/BrickColor.h:291
SubsystemApp - Utilities & Math

How it Works Internally​

Executes defaultColor within App - Utilities & Math. Coordinates interactions with BrickColor.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: BrickColor.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on defaultColor.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


49. asInt​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

int asInt() const;
PropertyValue
Return Typeint
Modifiersconst
Source LocationApp/include/util/BrickColor.h:311
SubsystemApp - Utilities & Math

How it Works Internally​

returns the number as an int, not an ARGB

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on asInt.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


50. CameraSubject​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

public: CameraSubject();
PropertyValue
Return Typepublic:
ModifiersNone
Source LocationApp/include/util/CameraSubject.h:17
SubsystemApp - Utilities & Math

How it Works Internally​

Declaration or inline method for CameraSubject.

  • Control Flow & Execution: Linear execution flow.
  • Memory Management: Standard stack allocation.
  • Concurrency & Thread Safety: Unsynchronized / single-threaded context.
  • Error Handling & Invariants: Standard return value verification.
  • State Mutation: Stateless or local modification.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on CameraSubject.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


51. ~CameraSubject​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

virtual ~CameraSubject();
PropertyValue
Return Typevirtual
ModifiersNone
Source LocationApp/include/util/CameraSubject.h:19
SubsystemApp - Utilities & Math

How it Works Internally​

Declaration or inline method for ~CameraSubject.

  • Control Flow & Execution: Linear execution flow.
  • Memory Management: Standard stack allocation.
  • Concurrency & Thread Safety: Unsynchronized / single-threaded context.
  • Error Handling & Invariants: Standard return value verification.
  • State Mutation: Stateless or local modification.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on ~CameraSubject.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


52. getIsNil​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

bool getIsNil() const;
PropertyValue
Return Typebool
Modifiersconst
Source LocationApp/include/util/CellID.h:35
SubsystemApp - Utilities & Math

How it Works Internally​

Executes getIsNil within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getIsNil.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


53. setIsNil​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void setIsNil(bool newIsNil);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/CellID.h:37
SubsystemApp - Utilities & Math

How it Works Internally​

Executes setIsNil within App - Utilities & Math.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on setIsNil.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


54. getLocation​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

G3D::Vector3 getLocation() const;
PropertyValue
Return TypeG3D::Vector3
Modifiersconst
Source LocationApp/include/util/CellID.h:38
SubsystemApp - Utilities & Math

How it Works Internally​

Executes getLocation within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getLocation.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


55. setLocation​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void setLocation(RBX::Vector3 newLocation);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/CellID.h:40
SubsystemApp - Utilities & Math

How it Works Internally​

Executes setLocation within App - Utilities & Math.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on setLocation.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


56. getTerrainPart​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

shared_ptr<Instance> getTerrainPart() const;
PropertyValue
Return Typeshared_ptr&lt;Instance&gt;
Modifiersconst
Source LocationApp/include/util/CellID.h:41
SubsystemApp - Utilities & Math

How it Works Internally​

Executes getTerrainPart within App - Utilities & Math.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getTerrainPart.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


57. setTerrainPart​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void setTerrainPart(shared_ptr<Instance> newTerrainPart);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/util/CellID.h:43
SubsystemApp - Utilities & Math

How it Works Internally​

Executes setTerrainPart within App - Utilities & Math.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on setTerrainPart.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


58. fromParameters​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

CellID fromParameters(bool newIsNil, float newLocation[3], shared_ptr<Instance> newTerrainPart);
PropertyValue
Return TypeCellID
Modifiersstatic
Source LocationApp/include/util/CellID.h:44
SubsystemApp - Utilities & Math

How it Works Internally​

Executes fromParameters within App - Utilities & Math. Coordinates interactions with CellID.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: CellID.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on fromParameters.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


59. hashDbgRegs​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

size_t hashDbgRegs(CONTEXT& ctx);
PropertyValue
Return Typesize_t
Modifiersinline
Source LocationApp/include/util/CheatEngine.h:78
SubsystemApp - Utilities & Math

How it Works Internally​

Executes hashDbgRegs within App - Utilities & Math. Coordinates interactions with return.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: return.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on hashDbgRegs.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


60. nextCellInIterationOrder​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void nextCellInIterationOrder(const Vector3int16& cellpos, Vector3int16* out);
PropertyValue
Return Typevoid
Modifiersstatic inline
Source LocationApp/include/util/ClusterCellIterator.h:34
SubsystemApp - Utilities & Math

How it Works Internally​

Executes nextCellInIterationOrder within App - Utilities & Math. Coordinates interactions with Vector3int16, globalVoxelCoordinateFromRegionAndRelativeCoordinate, regionContainingVoxel.

  • Control Flow & Execution: Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: Vector3int16, globalVoxelCoordinateFromRegionAndRelativeCoordinate, regionContainingVoxel.
  • External Library Dependencies: OpenGL / GLES Graphics API.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on nextCellInIterationOrder.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


Additional Functions

There are 1762 additional internal and inline functions in this subsystem. All functions are indexed and cross-referenced in the Complete Function Catalog.