_NetworkPerformance
Inherits: Node
Methods
| Return Type | Name |
|---|---|
| bool | is_enabled() |
| float | get_network_loop_duration_ms() |
| int | get_network_ticks() |
| float | get_rollback_loop_duration_ms() |
| int | get_rollback_ticks() |
| float | get_rollback_tick_duration_ms() |
| int | get_rollback_nodes_simulated() |
| float | get_rollback_nodes_simulated_per_tick() |
| void | push_rollback_nodes_simulated(int count) |
| int | get_full_state_props_count() |
| int | get_sent_state_props_count() |
| float | get_sent_state_props_ratio() |
| void | push_full_state(Dictionary state) |
| void | push_full_state_props(int count) |
| void | push_full_state_broadcast(Dictionary state) |
| void | push_sent_state(Dictionary state) |
| void | push_sent_state_props(int count) |
| void | push_sent_state_broadcast(Dictionary state) |
Constants
NETWORK_LOOP_DURATION_MONITOR = &"netfox/Network loop duration (ms)"
ROLLBACK_LOOP_DURATION_MONITOR = &"netfox/Rollback loop duration (ms)"
NETWORK_TICKS_MONITOR = &"netfox/Network ticks simulated"
ROLLBACK_TICKS_MONITOR = &"netfox/Rollback ticks simulated"
ROLLBACK_TICK_DURATION_MONITOR = &"netfox/Rollback tick duration (ms)"
ROLLBACK_NODES_SIMULATED_MONITOR = &"netfox/Rollback nodes simulated"
ROLLBACK_NODES_SIMULATED_PER_TICK_MONITOR = &"netfox/Rollback nodes simulated per tick (avg)"
FULL_STATE_PROPERTIES_COUNT = &"netfox/Full state properties count"
SENT_STATE_PROPERTIES_COUNT = &"netfox/Sent state properties count"
SENT_STATE_PROPERTIES_RATIO = &"netfox/Sent state properties ratio"
Method Descriptions
bool is_enabled ( )
Check if performance monitoring is enabled.
By default, monitoring is only enabled in debug builds ( see OS.is_debug_build() ).
Can be forced on with the netfox_perf feature tag.
Can be forced off with the netfox_noperf feature tag.
float get_network_loop_duration_ms ( )
Get time spent in the last network tick loop, in millisec.
Note that this also includes time spent in the rollback tick loop.
int get_network_ticks ( )
Get the number of ticks simulated in the last network tick loop.
float get_rollback_loop_duration_ms ( )
Get time spent in the last rollback tick loop, in millisec.
int get_rollback_ticks ( )
Get the number of ticks resimulated in the last rollback tick loop.
float get_rollback_tick_duration_ms ( )
Get the average amount of time spent in a rollback tick during the last rollback loop, in millisec.
int get_rollback_nodes_simulated ( )
Get the number of nodes simulated during the last rollback loop.
float get_rollback_nodes_simulated_per_tick ( )
Get the number of nodes simulated per tick on average during the last rollback loop.
void push_rollback_nodes_simulated ( int count )
No description provided.
int get_full_state_props_count ( )
Get the number of properties in the full state recorded during the last tick loop.
int get_sent_state_props_count ( )
Get the number of properties actually sent during the last tick loop.
float get_sent_state_props_ratio ( )
Get the ratio of sent properties count to full state properties count. See get_full_state_props_count
See get_sent_state_props_count
void push_full_state ( Dictionary state )
No description provided.
void push_full_state_props ( int count )
No description provided.
void push_full_state_broadcast ( Dictionary state )
No description provided.
void push_sent_state ( Dictionary state )
No description provided.
void push_sent_state_props ( int count )
No description provided.
void push_sent_state_broadcast ( Dictionary state )
No description provided.