Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Performance Metrics | |Name=Performance Metrics | ||
}} | }} | ||
The '''PerformanceMetrics''' component is used to show performance for a particular <code>User</code> at the present moment. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|User|{{RootFieldType|UserRef}}|TypeAdv0=true| | |User|{{RootFieldType|UserRef}}|TypeAdv0=true| The user we are measuring performance for. | ||
|FPS|Float| | |FPS|Float| <code>User</code>'s Frames Per second. | ||
|ImmediateFPS|Float| | |ImmediateFPS|Float| <code>User</code>'s immediate Frames Per Second. | ||
|RenderTime|Float| | |RenderTime|Float| <code>User</code>'s time it takes to render the scene in seconds. | ||
|TotalEngineUpdateTime|Float| | |TotalEngineUpdateTime|Float| <code>User</code>'s time it takes to update the engine in seconds. | ||
}} | }} | ||
== | == Usage == | ||
Attach to a slot and provide a user for <code>User</code> for it to start giving performance metrics. | |||
== Examples == | == Examples == | ||
{{stub}} | |||
== See Also == | == See Also == | ||
| Line 22: | Line 24: | ||
[[Category:Components:Utility{{#translation:}}|Performance Metrics]] | [[Category:Components:Utility{{#translation:}}|Performance Metrics]] | ||
[[Category:Components{{#translation:}}|Performance Metrics]] | [[Category:Components{{#translation:}}|Performance Metrics]] | ||
Latest revision as of 16:35, 30 January 2025
Component image 
Performance Metrics component as seen in the Scene Inspector
The PerformanceMetrics component is used to show performance for a particular User at the present moment.
Fields
| Name | Type | Description |
|---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't. |
User
|
direct UserRef | The user we are measuring performance for. |
FPS
|
Float | User's Frames Per second.
|
ImmediateFPS
|
Float | User's immediate Frames Per Second.
|
RenderTime
|
Float | User's time it takes to render the scene in seconds.
|
TotalEngineUpdateTime
|
Float | User's time it takes to update the engine in seconds.
|
Usage
Attach to a slot and provide a user for User for it to start giving performance metrics.
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.