$telemetry

19 natives. Read-only natives only look things up; the rest change something. Parameter types use the language's names (Types).

add_bool

$telemetry.add_bool(event_ref: Reference, key: string, value: bool)

Add a boolean value on the given telemetry event.

Parameter	Type	Meaning
event_ref	Reference	The telemetry event reference
key	string	The event value key
value	bool	The event value

add_component

$telemetry.add_component(event_ref: Reference, component: Component, skip: string)

Add all the fields on a component as key-value pairs on the given telemetry event.

Parameter	Type	Meaning
event_ref	Reference	The telemetry event reference
component	Component	The component
skip	string	If provided, the name of a field skip when writing telemetry

add_float

$telemetry.add_float(event_ref: Reference, key: string, value: float)

Add a float value on the given telemetry event.

Parameter	Type	Meaning
event_ref	Reference	The telemetry event reference
key	string	The event value key
value	float	The float value

add_int

$telemetry.add_int(event_ref: Reference, key: string, value: int)

Add an int value on the given telemetry event.

Parameter	Type	Meaning
event_ref	Reference	The telemetry event reference
key	string	The event value key
value	int	The int value

add_networknext_session_id

$telemetry.add_networknext_session_id(user: User, event_ref: Reference)

Add the NetworkNext session id to a server telemetry event.

Parameter	Type	Meaning
user	User	The user for whom the event is being captured
event_ref	Reference	The telemetry event reference

add_text

$telemetry.add_text(event_ref: Reference, key: string, value: string)

Add a string value on the given telemetry event.

Parameter	Type	Meaning
event_ref	Reference	The telemetry event reference
key	string	The event value key
value	string	The text value

add_user_id

$telemetry.add_user_id(event_ref: Reference, key: string, user: User)

Add a user id value to a telemetry event. The id is written as a string.

Parameter	Type	Meaning
event_ref	Reference	The telemetry event reference
key	string	The event value key
user	User	The user whose id will be added.

build_gpu_time_percentiles

$telemetry.build_gpu_time_percentiles(user: User) -> list

Sorts historical gpu time data for specified user and returns values at the 5th, 15th, 50th, 85th, and 95th percentile. Historical data is cleared as a result of this operation. Server only.

Parameter	Type	Meaning
user	User	The user to query.

Returns list: Millisecond values at the 5th, 15th, 50th, 85th, 95th percentiles.

build_input_delay_percentiles

$telemetry.build_input_delay_percentiles(user: User) -> list

Sorts historical input delay data for specified user and returns values at the 5th, 15th, 50th, 85th, and 95th percentile. Historical data is cleared as a result of this operation. Server only.

Parameter	Type	Meaning
user	User	The user to query.

Returns list: Values at the 5th, 15th, 50th, 85th, 95th percentiles.

build_out_time_percentiles

$telemetry.build_out_time_percentiles(user: User) -> list

Sorts historical out time data for specified user and returns values at the 5th, 15th, 50th, 85th, and 95th percentile. Historical data is cleared as a result of this operation. Server only.

Parameter	Type	Meaning
user	User	The user to query.

Returns list: Millisecond values at the 5th, 15th, 50th, 85th, 95th percentiles.

build_ping_time_percentiles

$telemetry.build_ping_time_percentiles(user: User) -> list

Sorts historical ping time data for specified user and returns values at the 5th, 15th, 50th, 85th, and 95th percentile. Historical data is cleared as a result of this operation. Server only.

Parameter	Type	Meaning
user	User	The user to query.

Returns list: Millisecond values at the 5th, 15th, 50th, 85th, 95th percentiles.

build_sim_time_percentiles

$telemetry.build_sim_time_percentiles(user: User) -> list

Sorts historical sim time data for specified user and returns values at the 5th, 15th, 50th, 85th, and 95th percentile. Historical data is cleared as a result of this operation. Server only.

Parameter	Type	Meaning
user	User	The user to query.

Returns list: Millisecond values at the 5th, 15th, 50th, 85th, 95th percentiles.

clear_time_percentiles

$telemetry.clear_time_percentiles(user: User)

Reset historical sim, out, gpu, and ping percentile data for a specified user. Server only.

Parameter	Type	Meaning
user	User	The user.

commit

$telemetry.commit(event_ref: Reference)

Finish modifying and begin sending a telemetry event.

Parameter	Type	Meaning
event_ref	Reference	The telemetry event reference

get_input_starved_count

$telemetry.get_input_starved_count(user: User) -> int

Get the number of frames the server lacked input for the specified user. Server only.

Parameter	Type	Meaning
user	User	The user to query.

Returns int: Input starved count.

local_user_create_event

$telemetry.local_user_create_event(type: string, user: User, is_critical: bool) -> Reference

Create a telemetry event for the provided local user. If the provided user is not local to the machine, returns NULL.

Parameter	Type	Meaning
type	string	The type of telemetry event
user	User	The user for whom the event is being captured
is_critical	bool	True if the telemetry event is critical and should override the user's telemetry settings.

Returns Reference: The telemetry event reference

print_event_to_log

$telemetry.print_event_to_log(event_ref: Reference)

Prints the content of the given telemerty event to the log.

Parameter	Type	Meaning
event_ref	Reference	The telemetry event reference

server_create_event

$telemetry.server_create_event(type: string, user: User) -> Reference

Create a telemetry event on the server. On the client returns NULL.

Parameter	Type	Meaning
type	string	The type of telemetry event
user	User	The user for whom the event is being captured

Returns Reference: The telemetry event reference

set_or_create_unique_key

$telemetry.set_or_create_unique_key(unique_key: list) -> list

Set the unique telemetry key, or create one if unique_key parameter is empty.

Parameter	Type	Meaning
unique_key	list	The saved unique key, or empty list to create.

Returns list: Telemetry key as a list of ints.