You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en-us/reference/engine/classes/Stats.yaml
+14-14Lines changed: 14 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,7 @@ properties:
48
48
In a networked game, this describes roughly how many kilobytes of data are
49
49
being received by the current instance, per second.
50
50
description: |
51
-
In a networked game, DataReceiveKbps describes roughly how many kilobytes
51
+
In a networked game, this property describes roughly how many kilobytes
52
52
of data are being received by the current instance, per second. If from
53
53
the server's perspective, this represents the total amount of data being
54
54
received from the clients connected to the server. If from a client's
@@ -75,7 +75,7 @@ properties:
75
75
In a networked game, this describes roughly how many kilobytes of data are
76
76
being sent by the current instance, per second.
77
77
description: |
78
-
In a networked game, DataSendKbps describes roughly how many kilobytes of
78
+
In a networked game, this property describes roughly how many kilobytes of
79
79
data are being sent by the current instance, per second. If from the
80
80
server's perspective, this represents the total amount of data being sent
81
81
to the clients connected to the server. If from a client's perspective,
@@ -100,7 +100,7 @@ properties:
100
100
summary: |
101
101
A measurement of how long it takes for the engine to process all tasks required to render a frame.
102
102
description: |
103
-
FrameTime is a measurement of how long it takes for the engine to render a frame. This can be used to calculate frames per second (FPS) through dividing 1 by this value. A high frame time value indicates the engine and device struggling to render frames.
103
+
This property is a measurement of how long it takes for the engine to render a frame. It can be used to calculate frames per second (FPS) through dividing `1` by this value. A high frame time value indicates the engine and device are struggling to render frames.
104
104
code_samples: []
105
105
type: float
106
106
tags:
@@ -270,7 +270,7 @@ properties:
270
270
summary: |
271
271
A measurement of how long it takes for the physics engine to update its current state.
272
272
description: |
273
-
A measurement of how long it takes for the physics engine to update its current state. If this value is high, then it means the game instance is under stress from the physics simulations taking place.
273
+
This property is a measurement of how long it takes for the physics engine to update its current state. If this value is high, it means the game instance is under stress from the physics simulations taking place.
274
274
code_samples: []
275
275
type: float
276
276
tags:
@@ -340,7 +340,7 @@ properties:
340
340
summary: |
341
341
A measurement of how long it takes for the CPU to process all of its tasks required to render a frame.
342
342
description: |
343
-
The RenderCPUFrameTime property is a measurement of how long it takes for the CPU to process all of its tasks required to render a frame. A high value can indicate that the CPU is taking longer to render a frame, which can lead to performance issues.
343
+
This property is a measurement of how long it takes for the CPU to process all of its tasks required to render a frame. A high value can indicate that the CPU is taking longer to render a frame, which can lead to performance issues.
344
344
code_samples: []
345
345
type: float
346
346
tags:
@@ -361,7 +361,7 @@ properties:
361
361
summary: |
362
362
A measurement of how long it takes for the GPU to process all of its tasks required to render a frame.
363
363
description: |
364
-
The RenderGPUFrameTime property is a measurement of how long it takes for the GPU to process all of its tasks required to render a frame. A high value can indicate that the GPU is taking longer to render a frame, which can lead to performance issues.
364
+
This property is a measurement of how long it takes for the GPU to process all of its tasks required to render a frame. A high value can indicate that the GPU is taking longer to render a frame, which can lead to performance issues.
365
365
code_samples: []
366
366
type: float
367
367
tags:
@@ -382,7 +382,7 @@ properties:
382
382
summary: |
383
383
A measurement of the number of draw calls made by the game's current scene.
384
384
description: |
385
-
The SceneDrawcallCount property is a measurement of the number of draw calls made by the game's current scene. A draw call is a single rendering operation, such as drawing a mesh. A high draw call count could mean a scene is too complex or unoptimized, which can lead to performance issues.
385
+
This property is a measurement of the number of draw calls made by the game's current scene. A draw call is a single rendering operation, such as drawing a mesh. A high draw call count could mean a scene is too complex or unoptimized, which can lead to performance issues.
386
386
code_samples: []
387
387
type: int
388
388
tags:
@@ -403,7 +403,7 @@ properties:
403
403
summary: |
404
404
A measurement of the number of triangles rendered by the game's current scene.
405
405
description: |
406
-
The SceneTriangleCount property is a measurement of the number of triangles rendered ny the game's current scene. A count of triangles rendered is useful when trying to estimate the complexity and performance of a scene.
406
+
This property is a measurement of the number of triangles rendered by the game's current scene. A count of triangles rendered is useful when trying to estimate the complexity and performance of a scene.
407
407
code_samples: []
408
408
type: int
409
409
tags:
@@ -424,7 +424,7 @@ properties:
424
424
summary: |
425
425
A measurement of the number of draw calls being made for shadows by the game's current scene.
426
426
description: |
427
-
The ShadowsDrawcallCount property is a measurement of the number of draw calls being made for shadows by the game's current scene. A high count means more shadows are being created by the amount of rendered objects in a scene.
427
+
This property is a measurement of the number of draw calls being made for shadows by the game's current scene. A high count means more shadows are being created by the amount of rendered objects in a scene.
428
428
code_samples: []
429
429
type: int
430
430
tags:
@@ -445,7 +445,7 @@ properties:
445
445
summary: |
446
446
A measurement of the number of traingles rendered as shadows in the game's current scene.
447
447
description: |
448
-
The ShadowsTriangleCount property is a measurement of the number of triangles rendered as shdows in the game's current scene. A high count means there are a lot of triangles used to cast shadows, which can hinder performance.
448
+
This property is a measurement of the number of triangles rendered as shadows in the game's current scene. A high count means there are a lot of triangles used to cast shadows, which can hinder performance.
449
449
code_samples: []
450
450
type: int
451
451
tags:
@@ -466,7 +466,7 @@ properties:
466
466
summary: |
467
467
A measurement of the number of 2D draw calls made for UI elements in the game's current scene.
468
468
description: |
469
-
The UI2DDrawcallCount property is a measurement of the number of 2D draw calls made for UI elements in the game's current scene. A high count can mean there are a lot of 2D UI elements being used.
469
+
This property is a measurement of the number of 2D draw calls made for UI elements in the game's current scene. A high count can mean there are a lot of 2D UI elements being used.
470
470
code_samples: []
471
471
type: int
472
472
tags:
@@ -487,7 +487,7 @@ properties:
487
487
summary: |
488
488
A measurement of the number of triangles that are being rendered for 2D UI elements in the game's current scene.
489
489
description: |
490
-
The UI2DTriangleCount property is a measurement of the number of triangles that are being rendered for 2D UI elements in the game's current scene. A high count can mean there are many or complex 2D UI elements used, which can contribute to performance loss in regards to rendering.
490
+
This property is a measurement of the number of triangles that are being rendered for 2D UI elements in the game's current scene. A high count can mean there are many or complex 2D UI elements used, which can contribute to performance loss in regards to rendering.
491
491
code_samples: []
492
492
type: int
493
493
tags:
@@ -508,7 +508,7 @@ properties:
508
508
summary: |
509
509
A measurement of the number of 3D draw calls made for UI elements in the game's current scene.
510
510
description: |
511
-
The UI3DDrawcallCount property is a measurement of the number of 3D draw calls made for UI elements in the game's current scene. A high count could indicate a high amount of 3D objects being used within UI, potentially hurting performance; however, it is very unlikely you would see a significant count since UI elements are typically 2D.
511
+
This property is a measurement of the number of 3D draw calls made for UI elements in the game's current scene. A high count could indicate a high amount of 3D objects being used within UI, potentially hurting performance; however, it is very unlikely you would see a significant count since UI elements are typically 2D.
512
512
code_samples: []
513
513
type: int
514
514
tags:
@@ -529,7 +529,7 @@ properties:
529
529
summary: |
530
530
A measurement of the number of triangles being rendered for 3D UI elements in the game's current scene.
531
531
description: |
532
-
The UI3DTriangleCount property is a measurement of the number of triangles being rendered for 3D UI elements in the game's current scene; however, it is very unlikely you would see a significant count since UI elements are typically 2D.
532
+
This property is a measurement of the number of triangles being rendered for 3D UI elements in the game's current scene; however, it is very unlikely you would see a significant count since UI elements are typically 2D.
0 commit comments