Stats

Show Deprecated
Not Creatable
Service

Stats is a service that provides real-time performance information about the current running game instance. Its primary purpose is to provide an end point to measure where resources are being consumed, as well as how much memory is being consumed overall.

The service also stores a tree of StatsItem objects which can have their values read by plugins.

Summary

Properties

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of how many parts are currently in contact with one another.

  • Read Only
    Not Replicated
    Read Parallel

    In a networked game, this describes roughly how many kilobytes of data are being received by the current instance, per second.

  • Read Only
    Not Replicated
    Read Parallel

    In a networked game, this describes roughly how many kilobytes of data are being sent by the current instance, per second.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of how long it takes for the engine to process all tasks required to render a frame.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of the total amount of time it takes for the server to update its Task Scheduler jobs in seconds.

  • Read Only
    Not Replicated
    Deprecated
    Read Parallel

    A measurement of how many Instance are currently in memory.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of how many physically simulated components are currently moving in the game world.

  • Read Only
    Not Replicated
    Read Parallel

    In a networked game, this describes roughly how many kilobytes of physics data are being received by the current instance, per second.

  • Read Only
    Not Replicated
    Read Parallel

    In a networked game, this describes roughly how many kilobytes of physics data are being sent by the current instance, per second.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of how long it takes for the physics engine to update its current state.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of how many physically simulated components currently exist in the game world.

  • Read Only
    Not Replicated
    Deprecated
    Read Parallel

    A measurement of how long it takes for the CPU to process all of its rendering tasks for a frame.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of how long it takes for the GPU to process all of its tasks required to render a frame.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of the number of draw calls made by the game's current scene.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of the number of triangles rendered by the game's current scene.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of the number of draw calls being made for shadows by the game's current scene.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of the number of triangles rendered as shadows in the game's current scene.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of the number of 2D draw calls made for UI elements in the game's current scene.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of the number of triangles that are being rendered for 2D UI elements in the game's current scene.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of the number of 3D draw calls made for UI elements in the game's current scene.

  • Read Only
    Not Replicated
    Read Parallel

    A measurement of the number of triangles being rendered for 3D UI elements in the game's current scene.

  • Read Only
    Not Replicated
    Read Parallel
  • Read Only
    Not Replicated
    Read Parallel

Methods

Properties

ContactsCount

Read Only
Not Replicated
Read Parallel

DataReceiveKbps

Read Only
Not Replicated
Read Parallel

DataSendKbps

Read Only
Not Replicated
Read Parallel

FrameTime

Read Only
Not Replicated
Read Parallel

HeartbeatTime

Read Only
Not Replicated
Read Parallel

HeartbeatTimeMs

Read Only
Not Replicated
Deprecated
Read Parallel

InstanceCount

Read Only
Not Replicated
Read Parallel

MovingPrimitivesCount

Read Only
Not Replicated
Read Parallel

PhysicsReceiveKbps

Read Only
Not Replicated
Read Parallel

PhysicsSendKbps

Read Only
Not Replicated
Read Parallel

PhysicsStepTime

Read Only
Not Replicated
Read Parallel

PhysicsStepTimeMs

Read Only
Not Replicated
Deprecated
Read Parallel

PrimitivesCount

Read Only
Not Replicated
Read Parallel

RenderCPUFrameTime

Read Only
Not Replicated
Read Parallel

RenderGPUFrameTime

Read Only
Not Replicated
Read Parallel

SceneDrawcallCount

Read Only
Not Replicated
Read Parallel

SceneTriangleCount

Read Only
Not Replicated
Read Parallel

ShadowsDrawcallCount

Read Only
Not Replicated
Read Parallel

ShadowsTriangleCount

Read Only
Not Replicated
Read Parallel

UI2DDrawcallCount

Read Only
Not Replicated
Read Parallel

UI2DTriangleCount

Read Only
Not Replicated
Read Parallel

UI3DDrawcallCount

Read Only
Not Replicated
Read Parallel

UI3DTriangleCount

Read Only
Not Replicated
Read Parallel

Methods

GetHarmonyQualityLevel


Returns

GetMemoryCategoryNames


Returns

GetMemoryUsageMbAllCategories


Returns

GetMemoryUsageMbForTag

Parameters


Returns

GetTotalMemoryUsageMb


Returns

ResetHarmonyMemoryTarget

()

Returns

()

SetHarmonyMemoryTarget

()

Parameters

targetMB: number

Returns

()

Events