$user

Users: the people playing, their names, their players.

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

accept_crew_invite

$user.accept_crew_invite(user: User)

Accept the given user's crew invite.

Parameter	Type	Meaning
user	User	The user id to accept the invite from.

accept_crew_join_request

$user.accept_crew_join_request(user: User)

Accept the given user's join request.

Parameter	Type	Meaning
user	User	The user id to accept the request of.

accept_first_party_friend_request

$user.accept_first_party_friend_request(user: User)

Accept the first party friend request from the given user.

Parameter	Type	Meaning
user	User	The user id who sent the request.

accept_first_party_group_invite

$user.accept_first_party_group_invite(user: User)

Join the group and remove the invite from the given first party user.

Parameter	Type	Meaning
user	User	The user id who sent the invite.

accept_friend_request

$user.accept_friend_request(user: User)

Accept the friend request from the given user.

Parameter	Type	Meaning
user	User	The user id who sent the request.

accept_group_invite

$user.accept_group_invite(user: User, merge: bool)

Join the group and remove the invite from the given user. Optionally, bring the existing group along with you (only a group leader joining an open group can do this)

Parameter	Type	Meaning
user	User	The user id who sent the invite.
merge	bool	True if we should try to merge the groups.

activity_availability_changed

$user.activity_availability_changed(mode: string, available: list, unavailable: list)

Notifies the platform that the availability of the activities has changed.

Parameter	Type	Meaning
mode	string	The update mode: if 'full' then all availability values in the state are updated, if 'delta' then the system calculates the difference and add/removes from the state.
available	list	List of available activites.
unavailable	list	List of unavailable activities.

activity_terminate

$user.activity_terminate()

Notify the platform to terminate all activities and reset their state to default.

add_default

$user.add_default(gamepad: int)

Enqueues the addition of the default user on the local system.

Parameter	Type	Meaning
gamepad	int	The gamepad index.

add_droid

$user.add_droid(name: string)

Enqueues the addition of a droid user on the local system.

Parameter	Type	Meaning
name	string	The name to use for the droid.

add_dummy

$user.add_dummy(client_index: int, gamepad: int)

Enqueues the addition of a dummy remote user on the local system.

Parameter	Type	Meaning
client_index	int	The remote client index.
gamepad	int	The gamepad index.

add_guest

$user.add_guest(gamepad: int)

Enqueues the addition of a guest user on the local system.

Parameter	Type	Meaning
gamepad	int	The gamepad index.

add_recent_players

$user.add_recent_players()

Add all users on the server as recent players for the local user.

add_recent_players_first_party

$user.add_recent_players_first_party()

Add all users on the server on the same platform as first party recent players for the local user.

add_user_reputation_xp

$user.add_user_reputation_xp(user: User, xp: int)

Add reputation XP for a given user.

Parameter	Type	Meaning
user	User	The user.
xp	int	The xp value to add.

add_with_selector

$user.add_with_selector(gamepad: int)

Enqueues the selection of a user on the local platform. Note on some platforms this starts an async process that will eventually result in a user being added (assuming the process isn't canceled by the user input)

Parameter	Type	Meaning
gamepad	int	The gamepad index.

block_player

$user.block_player(user: User)

Block the given user.

Parameter	Type	Meaning
user	User	The user id to block.

cache_bootable_invite

read-only

$user.cache_bootable_invite()

Cache a bootable invite from the first party.

compare_users

read-only

$user.compare_users(user1: User, user2: User) -> int

Get the name (gamertag) for a user.

Parameter	Type	Meaning
user1	User	The first user handle.
user2	User	The second user handle.

Returns int: 0 if the user values are equal.

consume_accepted_invite

$user.consume_accepted_invite()

Consume an invite we've accepted at a first-party level and try to join the user's group.

consume_pending_game_intent

$user.consume_pending_game_intent()

Consumes the pending game intent thereby removing it from the system. The game code needs to act upon the intent.

create_crew

$user.create_crew(name: string)

Create a new crew. Must currently not be in a crew.

Parameter	Type	Meaning
name	string	The crew name.

display_igo_profile

$user.display_igo_profile(user: User, name: string)

Display the given user in the first party overlay.

Parameter	Type	Meaning
user	User	The user id to display.
name	string	The name of the user.

end_activity

$user.end_activity(activity: string, outcome: string)

Notifies the platform that the user has ended the specified activity.

Parameter	Type	Meaning
activity	string	The name of the activity
outcome	string	The outcome of the activity: 'completed', 'failed', or 'abandoned'

get_all_friends_on_server

read-only

$user.get_all_friends_on_server() -> list

Get a list of all friends on server.

Returns list: List of friends.

get_all_users

read-only

$user.get_all_users() -> list

Get a list of all users.

Returns list: List of users.

get_blocked_player_count

read-only

$user.get_blocked_player_count() -> int

Gets the number of players blocked by the local user.

Returns int: The number of blocked players.

get_blocked_players

read-only

$user.get_blocked_players(sort_by_name: bool) -> list

Get the local user's blocked players list.

Parameter	Type	Meaning
sort_by_name	bool	Whether or not to sort the results by name.

Returns list: The blocked list.

get_blocked_players_first_party

read-only

$user.get_blocked_players_first_party(sort_by_name: bool) -> list

Get the local user's blocked players list from the first party.

Parameter	Type	Meaning
sort_by_name	bool	Whether or not to sort the results by name.

Returns list: The first party blocked list.

get_cohort_for_experiment

read-only

$user.get_cohort_for_experiment(user: User, experiment: string) -> string

Get the cohort for a user for a given experiment based on their user id.

Parameter	Type	Meaning
user	User	The user handle.
experiment	string	The vuser_ab_experiment.

Returns string: The user cohort. Do not cache this string.

get_combined_friend_presence_counts

read-only

$user.get_combined_friend_presence_counts() -> list

Gets a list of counts for all combined friend presences.

Returns list: Index 0 = in game friend count, 1 = online friend count, 2 = offline friend count.

get_connection

$user.get_connection(user: User) -> int

Get the network connection associated with a user.

Parameter	Type	Meaning
user	User	The user handle.

Returns int: The network connection.

get_crew_captain

read-only

$user.get_crew_captain(user: User, guid: string) -> User

Get the crew's captain by a user or by a crew id.

Parameter	Type	Meaning
user	User	The user id.
guid	string	The crew guid to search by.

Returns User: The crew captain

get_crew_code

$user.get_crew_code(user: User, guid: string) -> int

Get the crew's name code by a user or by crew id.

Parameter	Type	Meaning
user	User	The user id.
guid	string	The crew guid to search by.

Returns int: The crew's name code.

get_crew_guid

read-only

$user.get_crew_guid(user: User) -> string

Get the crew's unique identifier.

Parameter	Type	Meaning
user	User	The user id.

Returns string: The crew's unique identifier.

get_crew_invites

read-only

$user.get_crew_invites() -> list

Get a list of users who have sent crew invites.

Returns list: List of online ids for users who sent crew invites.

get_crew_join_requests

read-only

$user.get_crew_join_requests() -> list

Get a list of users who have sent crew join requests.

Returns list: List of online ids for users who sent crew join requests.

get_crew_member_count

read-only

$user.get_crew_member_count() -> int

Gets the total number of users in the crew.

Returns int: The total number of crew members.

get_crew_members

read-only

$user.get_crew_members(guid: string, start_index: int, count: int, sort_members: bool) -> list

Get a list of users in the crew by user or by crew id. Includes the crew captain.

Parameter	Type	Meaning
guid	string	(optional) The crew guid to search by. If null, will return the local users crew members.
start_index	int	The offset in the crew member list to start retrieving members at.
count	int	The total number of crew members to retrieve. Will cap at the max list length.
sort_members	bool	If true the members will be sorted with the crew captain first, then alphabetically.

Returns list: List of online ids for users in the crew.

get_crew_name

$user.get_crew_name(user: User, guid: string) -> string

Get the crew's name by a user or by crew id.

Parameter	Type	Meaning
user	User	The user id.
guid	string	The crew guid to search by.

Returns string: The crew's name.

get_crew_name_platform_valid

$user.get_crew_name_platform_valid(name: string) -> bool

Check if the given crew name is valid on the current platform.

Parameter	Type	Meaning
name	string	The crew_name.

Returns bool: True if the name is valid.

get_crew_name_profanity_checked

$user.get_crew_name_profanity_checked(user: User, guid: string) -> bool

Get the status of the crew name profanity filtering.

Parameter	Type	Meaning
user	User	The user id.
guid	string	The crew guid to search by.

Returns bool: The state of the profanity filtering.

get_crew_name_unfiltered

$user.get_crew_name_unfiltered(user: User, guid: string) -> string

Get the crew's unfiltered name by a user or by crew id.

Parameter	Type	Meaning
user	User	The user id.
guid	string	The crew guid to search by.

Returns string: The crew's name.

get_crew_namer

read-only

$user.get_crew_namer(user: User, guid: string) -> User

Get the user id of the player that named the crew.

Parameter	Type	Meaning
user	User	The user id.
guid	string	The crew guid to search by.

Returns User: The namer of the crew.

get_crew_presence_counts

read-only

$user.get_crew_presence_counts() -> list

Gets a list of counts for crew member presences. This will exclude the crew leader.

Returns list: Index 0 = in game crew member count, 1 = online crew member count, 2 = offline crew member count.

get_crew_search_results

read-only

$user.get_crew_search_results(users: list) -> list

Get a list of crews returned by the search function.

Parameter	Type	Meaning
users	list	The users to request the crews for

Returns list: List of crew guids.

get_first_party_friend_count

read-only

$user.get_first_party_friend_count() -> int

Gets the total number of first-party friends for the local user.

Returns int: The total number of first-party friends.

get_first_party_friend_requests

$user.get_first_party_friend_requests() -> list

Get a list of users who have sent first party friend requests.

Returns list: List of ids.

get_first_party_friends

read-only

$user.get_first_party_friends(sort_by_name: bool, start_index: int, count: int) -> list

Get a list of all first party friends for the local user.

Parameter	Type	Meaning
sort_by_name	bool	Whether or not to sort the results by name.
start_index	int	The offset in the friends list to start retrieving friends at.
count	int	The total number of friends to retrieve. Will cap at the max list length.

Returns list: List of first party friend user ids.

get_first_party_group_invites

$user.get_first_party_group_invites() -> list

Get a list of users who have sent first party group invites.

Returns list: List of ids.

get_first_party_rich_presence_string

$user.get_first_party_rich_presence_string(user: User) -> string

Get the user's rich presence string from the first party.

Parameter	Type	Meaning
user	User	The user id.

Returns string: The user's rich presence string.

get_first_party_user

read-only

$user.get_first_party_user(user: User) -> User

Given a velan user, return their first party user.

Parameter	Type	Meaning
user	User	The user.

Returns User: The first party user.

get_friend_count

read-only

$user.get_friend_count() -> int

Gets the total number of Velan friends for the local user.

Returns int: The total number of Velan friends.

get_friend_requests

$user.get_friend_requests() -> list

Get a list of users who have sent friend requests.

Returns list: List of ids.

get_friends

read-only

$user.get_friends(sort_by_name: bool, start_index: int, count: int) -> list

Get a list of all friends for the local user.

Parameter	Type	Meaning
sort_by_name	bool	Whether or not to sort the results by name.
start_index	int	The offset in the friends list to start retrieving friends at.
count	int	The total number of friends to retrieve. Will cap at the max list length.

Returns list: List of friend user ids.

get_friends_crew_captains

read-only

$user.get_friends_crew_captains(include_first_party: bool) -> list

Get a list of crew captains for the crews your friends are in.

Parameter	Type	Meaning
include_first_party	bool	If true, first party friend's crew captains are returned as well.

Returns list: List of crew captains of your friend's crews.

get_gamepad

read-only

$user.get_gamepad(user: User) -> int

Get the gamepad associated with a user.

Parameter	Type	Meaning
user	User	The user handle.

Returns int: The gamepad index.

get_group

read-only

$user.get_group() -> list

Get a list of users in the group. Includes the group leader.

Returns list: List of online ids for users in group.

get_group_invites

$user.get_group_invites() -> list

Get a list of users who have sent group invites.

Returns list: List of ids.

get_group_invites_combined

$user.get_group_invites_combined() -> list

Get a combined list of users who have sent group invites via velan or first party platforms.

Returns list: List of ids.

get_group_leader

read-only

$user.get_group_leader() -> User

Get the group leader for the current user, including remote index and gamepad index

Returns User: The group leader.

get_group_leader_by_user

read-only

$user.get_group_leader_by_user(user: User) -> User

Get the group leader for the given user on server. Always return null user on client.

Parameter	Type	Meaning
user	User	The user.

Returns User: The group leader.

get_group_leader_user_id

read-only

$user.get_group_leader_user_id() -> User

Get the user id of the group leader for the current user.

Returns User: The group leader user id.

get_local_index

read-only

$user.get_local_index(user: User) -> int

Returns the index of a user on its client. If not found, returns -1.

Parameter	Type	Meaning
user	User	The user handle.

Returns int: User index on its client, or -1 if not found

get_local_users

read-only

$user.get_local_users() -> list

Get a list of all local users.

Returns list: List of users.

get_lowest_id_user

read-only

$user.get_lowest_id_user(users: list) -> User

Returns the user with the lowest internal ID from a list.

Parameter	Type	Meaning
users	list	A list of users.

Returns User: The user with the lowest ID.

get_name

read-only

$user.get_name(user: User, publisher: bool) -> string

Get the name (gamertag) for a user.

Parameter	Type	Meaning
user	User	The user handle.
publisher	bool	True if requesting the publisher username.

Returns string: The user name.

get_name_profanity_checked

read-only

$user.get_name_profanity_checked(user: User) -> bool

Get the status of the user name profanity filter.

Parameter	Type	Meaning
user	User	The user handle.

Returns bool: The status of the profanity filter.

get_pending_game_intent_activity_id

read-only

$user.get_pending_game_intent_activity_id() -> string

Returns the activity id of any pending game intent.

Returns string: The activity ID of the pending game intent

get_pending_game_intent_type

read-only

$user.get_pending_game_intent_type() -> int

Returns the type of any pending game intent.

Returns int: The vonline_game_intent_type_t of the pending game intent

get_platform_family

read-only

$user.get_platform_family(user: User) -> int

Get the platform family for the given user

Parameter	Type	Meaning
user	User	The user.

Returns int: The vplatform_family_t value for the user if it is possible to determine, k_platform_family_invalid if not.

get_platform_string

read-only

$user.get_platform_string(user: User) -> string

Get the platform string for the given user from their persona id.

Parameter	Type	Meaning
user	User	The user.

Returns string: The user's platform string.

get_platform_user_kind

read-only

$user.get_platform_user_kind(user: User) -> int

Get the first party platform user kind for the given user.

Parameter	Type	Meaning
user	User	The user.

Returns int: The user's platform.

get_presence_state

read-only

$user.get_presence_state(user: User) -> int

Determine the user's current online state.

Parameter	Type	Meaning
user	User	The user id.

Returns int: The user's online state.

get_primary

read-only

$user.get_primary() -> User

Determine the primary user on the calling system.

Returns User: Primary user.

get_publisher_username_code

read-only

$user.get_publisher_username_code(user: User) -> int

Get the #1234 suffix for a user's publisher username.

Parameter	Type	Meaning
user	User	The user handle.

Returns int: The code.

get_ranked_skill_by_playlist

read-only

$user.get_ranked_skill_by_playlist(match_def: Reference) -> list

Get the ranked skill data for the user from the specified playlist

Parameter	Type	Meaning
match_def	Reference	The playlist definition to lookup skill for

Returns list: The user's skill data, null if not found. List ordered as tier, division, division_progress, mmr, volatility, win_streak, skill_rating, skill_rating_decayed. See vonline_matchmaking_skill_t.

get_recent_players

$user.get_recent_players() -> list

Get the recent players to the local first party user.

Returns list: The recent players for the user.

get_rich_presence_state

read-only

$user.get_rich_presence_state(user: User) -> int

Determine the user's current rich presence state.

Parameter	Type	Meaning
user	User	The user id.

Returns int: The user's online state.

get_sim_frame_time_scale_for_user

read-only

$user.get_sim_frame_time_scale_for_user(user: User) -> float

Returns the time scale used by the given user's client. For instance, a Switch client will return 2.0..

Parameter	Type	Meaning
user	User	The user to check.

Returns float: The time scale of the given user.

get_thank_you_bonus_display_season_number

read-only

$user.get_thank_you_bonus_display_season_number() -> int

Server Only - Get the season number when the thank you bonus rewards were granted.

Returns int: The season number for the thank you bonus.

get_unranked_skill

read-only

$user.get_unranked_skill() -> list

Get the quickplay skill data for the user

Returns list: The user's quickplay skill data, null if not found. List ordered as tier, division, division_progress, mmr, volatility, win_streak. See vonline_matchmaking_skill_t.

get_user_by_client_index

$user.get_user_by_client_index(index: int, gamepad: int) -> User

Return the user at the given netrep client index.

Parameter	Type	Meaning
index	int	The client index.
gamepad	int	The gamepad index.

Returns User: The user at the client connection index.

get_user_by_index

$user.get_user_by_index(index: int) -> User

Return the user at the given index.

Parameter	Type	Meaning
index	int	The user index.

Returns User: The user indexed in the 'get_all_users' array

get_user_games_played

read-only

$user.get_user_games_played(user: User) -> int

Get the total number of games played from skill data for the given user. Server Only.

Parameter	Type	Meaning
user	User	The user.

Returns int: The user's total number of games played from skill data, -1 if not found. It will return quickplay games in hideout.

get_user_group_size

read-only

$user.get_user_group_size(user: User) -> int

Get the group size for a given user. This is tied to presence and are not guaranteed to update for local group members. user.get_group().length is preferred for getting local group size.

Parameter	Type	Meaning
user	User	The user.

Returns int: The user's group size.

get_user_index

read-only

$user.get_user_index(user: User) -> int

Returns the index into the array returned by 'get_all_users' for the given user. If not found, returns -1. Don't store this across frames, as the array can change!

Parameter	Type	Meaning
user	User	The user handle.

Returns int: User index into 'get_all_users' array, or -1 if not found

get_user_kind

read-only

$user.get_user_kind(user: User) -> int

Get the user kind of the provided user.

Parameter	Type	Meaning
user	User	The user.

Returns int: The user's kind.

get_user_reputation_xp

read-only

$user.get_user_reputation_xp(user: User) -> int

Get the reputation XP for a given user.

Parameter	Type	Meaning
user	User	The user.

Returns int: The user's xp.

get_user_skill

read-only

$user.get_user_skill(user: User) -> list

Get the skill data for the given user for the current match. Server Only.

Parameter	Type	Meaning
user	User	The user.

Returns list: The user's skill data, null if not found. List ordered as tier, division, division_progress, mmr, volatility, win_streak. See vonline_matchmaking_skill_t.

get_user_wins

read-only

$user.get_user_wins(user: User) -> int

Get the wins from skill data for the given user for the current match. It will return quickplay wins in hideout. Server Only.

Parameter	Type	Meaning
user	User	The user.

Returns int: The user's wins from skill data, -1 if not found. It will return quickplay wins in hideout.

get_velan_id_from_first_party_id

read-only

$user.get_velan_id_from_first_party_id(first_party_id: User) -> User

Given a first party id, attempt to retrieve the user's velan id.

Parameter	Type	Meaning
first_party_id	User	The first party user.

Returns User: The velan user.

get_velan_user_hash

read-only

$user.get_velan_user_hash(user: User, salt: int) -> int

Get a 32-bit hash for a Velan user. The user kind must be k_vuser_kind_velan. This does NOT take gamepad or user-type into consideration.

Parameter	Type	Meaning
user	User	The Velan user.
salt	int	A number to hash in with the player.

Returns int: A hash of the user and the salt value.

get_visibility

$user.get_visibility(user: User) -> int

Get the given user's group visibility. Only relevant when they're the group leader.

Parameter	Type	Meaning
user	User	The user id to get the visibility state for.

Returns int: The user's visibility state

get_xbox_default_user_name

read-only

$user.get_xbox_default_user_name() -> string

Get the name (gamertag) for the default Xbox user.

Returns string: The name of the default Xbox user.

invite_to_group

$user.invite_to_group(user: User, message: string)

Invite the given user to the group.

Parameter	Type	Meaning
user	User	The user id to invite.
message	string	A message to attach to the invite.

invite_to_group_first_party

$user.invite_to_group_first_party(user: User, message: string)

Send a first party game into to the given user.

Parameter	Type	Meaning
user	User	The user id to invite.
message	string	A message to attach to the invite.

is_blocked

read-only

$user.is_blocked(user: User) -> bool

Checks to see if the given user is blocked.

Parameter	Type	Meaning
user	User	The user to check.

Returns bool: Whether or not the given user is blocked.

is_blocked_velan

read-only

$user.is_blocked_velan(user: User) -> bool

Checks to see if the given user is blocked_velan.

Parameter	Type	Meaning
user	User	The user to check. Requires a velan user kind.

Returns bool: Whether or not the given velan user is KO City ID blocked.

is_child

$user.is_child(user: User) -> bool

Determine if a user is underage.

Parameter	Type	Meaning
user	User	The user handle.

Returns bool: True if child.

is_commerce_allowed

read-only

$user.is_commerce_allowed() -> bool

Get whether a user is allowed to access commerce.

Returns bool: True if the local user is allowed to access commerce.

is_crossplay_allowed

read-only

$user.is_crossplay_allowed(refresh_if_disabled: bool) -> bool

Get whether crossplay is currently allowed.

Parameter	Type	Meaning
refresh_if_disabled	bool	True to force a refresh of the privilege if currently disallowed. May trigger a system dialog.

Returns bool: True if crossplay is allowed.

is_crossplay_visible

read-only

$user.is_crossplay_visible(user: User) -> bool

Given a velan user and the current crossplay settings, is that user visible.

Parameter	Type	Meaning
user	User	The user.

Returns bool: True if the user is crossplay visible.

is_dummy

read-only

$user.is_dummy() -> bool

Determine if the owning user is a dummy.

Returns bool: True if the owning user is a dummy.

is_first_party_friend

read-only

$user.is_first_party_friend(user: User) -> bool

Checks to see if the given user is a first-party friend.

Parameter	Type	Meaning
user	User	The user to check.

Returns bool: Whether or not the given user is a first-party friend.

is_first_party_invite

$user.is_first_party_invite(invite: User) -> bool

Check if a given invite is from the platform.

Parameter	Type	Meaning
invite	User	The invite.

Returns bool: True if the invite is a platform invite.

is_first_party_network_up

$user.is_first_party_network_up() -> bool

Determine if the first party network is accessible.

Returns bool: True if the first party network is accessible.

is_friend

read-only

$user.is_friend(user: User) -> bool

Checks to see if the given user is a Velan / KO ID friend.

Parameter	Type	Meaning
user	User	The user to check.

Returns bool: Whether or not the given user is a Velan / KO ID friend.

is_group_leader

read-only

$user.is_group_leader() -> bool

Determine if this user is the group leader.

Returns bool: True if the group leader.

is_guest

$user.is_guest(user: User) -> bool

Determine if a user is a guest on its system.

Parameter	Type	Meaning
user	User	The user handle.

Returns bool: True if guest.

is_igo_visible

read-only

$user.is_igo_visible() -> bool

Get whether the platform IGO is visible or not.

Returns bool: True if the platform IGO is visible.

is_in_crew

read-only

$user.is_in_crew(user: User) -> bool

Get whether the user is in a crew.

Parameter	Type	Meaning
user	User	The user id.

Returns bool: True if the user is in a crew.

is_input_extrapolated

read-only

$user.is_input_extrapolated() -> bool

Determine if the input for the owning user of the current component is being extrapolated.

Returns bool: True if the owning user's input is extrapolated.

is_local

read-only

$user.is_local(user: User) -> bool

Determine if a user is local to the current machine.

Parameter	Type	Meaning
user	User	The user handle.

Returns bool: True if specified user is local.

is_predicted

$user.is_predicted() -> bool

Determine if the owning user of the current component is predicted by default. That is, the owning user is local or being simulated on the server. Always returns true on the server.

Returns bool: True if the owning user is local or being simulated on the server.

is_primary

read-only

$user.is_primary(user: User) -> bool

Determine if a user is the primary user on its system.

Parameter	Type	Meaning
user	User	The user handle.

Returns bool: True if primary.

is_social_allowed

read-only

$user.is_social_allowed() -> bool

Get whether a user is allowed to access social features.

Returns bool: True if the local user is allowed to access social features.

is_telemetry_allowed

read-only

$user.is_telemetry_allowed() -> bool

Get whether the local user allows telemetry.

Returns bool: True if the local user allows telemetry.

is_ugc_allowed

read-only

$user.is_ugc_allowed(refresh_if_disabled: bool) -> bool

Get whether a user is allowed to access user-generated content.

Parameter	Type	Meaning
refresh_if_disabled	bool	True to force a refresh of the privilege if currently disallowed. May trigger a system dialog.

Returns bool: True if the local user is allowed to access UGC.

is_underage

read-only

$user.is_underage() -> bool

Get whether the local user is underage.

Returns bool: True if the local user is underage.

is_user_droid

read-only

$user.is_user_droid(user: User) -> bool

Determine if the given user is a droid.

Parameter	Type	Meaning
user	User	The user handle.

Returns bool: True if the given user is a droid.

is_user_dummy

read-only

$user.is_user_dummy(user: User) -> bool

Determine if the given user is a dummy.

Parameter	Type	Meaning
user	User	The user handle.

Returns bool: True if the given user is a dummy.

is_user_input_extrapolated

read-only

$user.is_user_input_extrapolated(user: User) -> bool

Determine if the input for the given user is being extrapolated.

Parameter	Type	Meaning
user	User	The user handle.

Returns bool: True if the given user's input is extrapolated.

is_user_predicted

read-only

$user.is_user_predicted(user: User) -> bool

Determine if the given user is predicted by default. That is, the owning user is local or being simulated on the server.

Parameter	Type	Meaning
user	User	The user handle.

Returns bool: True if the given user is local or being simulated on the server.

is_velan_user_test_group_odd

read-only

$user.is_velan_user_test_group_odd(user: User) -> bool

Returns true if a velan user id is odd. Intended for A/B testing

Parameter	Type	Meaning
user	User	The Velan user.

Returns bool: True if userid value is odd.

join_group

$user.join_group(user: User, from_invite: bool)

Try to join the given user's group.

Parameter	Type	Meaning
user	User	The user id to join.
from_invite	bool	If true, the join originates from an invite.

kick_from_crew

$user.kick_from_crew(user: User)

Kick the given user from the crew. Only succeeds for the crew captain.

Parameter	Type	Meaning
user	User	The user id to kick.

kick_from_group

$user.kick_from_group(user: User)

Kick the given user from the group. Only succeeds for the group leader.

Parameter	Type	Meaning
user	User	The user id to kick.

leave_crew

$user.leave_crew()

Leave the crew.

leave_group

$user.leave_group()

Leave the current group we're in.

merge_group

$user.merge_group(user: User)

Try to join the given user's group, and bring your current group with you.

Parameter	Type	Meaning
user	User	The user id to join.

presence_request

$user.presence_request(username: string)

Partial name presence request for velan presence. When users have been found, they can be queried with user.presence_search. Note: This is a one-time request, and won't subscribe the client to presence updates about the user.

Parameter	Type	Meaning
username	string	The (partial) username to request presence for.

presence_search

$user.presence_search(username: string, sort_by_name: bool) -> list

Partial name presence lookup for velan presence.

Parameter	Type	Meaning
username	string	The (partial) username to get presence for.
sort_by_name	bool	Will sort list alphabetically if set to true.

Returns list: A list of user id's whose username (partially) match the given string.

promote_group_leader

$user.promote_group_leader(user: User)

Promote a user to the group leader.

Parameter	Type	Meaning
user	User	The user id to promote.

promote_to_captain

$user.promote_to_captain(user: User)

Promote the given user to crew captain. Only succeeds for the crew captain.

Parameter	Type	Meaning
user	User	The user id to promote.

reject_crew_invite

$user.reject_crew_invite(user: User)

Reject the given user's crew invite.

Parameter	Type	Meaning
user	User	The user id to reject the invite from.

reject_crew_join_request

$user.reject_crew_join_request(user: User)

Reject the given user's join request.

Parameter	Type	Meaning
user	User	The user id to reject the request of.

reject_first_party_friend_request

$user.reject_first_party_friend_request(user: User)

Reject the friend request from the given first party user.

Parameter	Type	Meaning
user	User	The user id who sent the request.

reject_first_party_group_invite

$user.reject_first_party_group_invite(user: User)

Remove the group invite from the given first party user.

Parameter	Type	Meaning
user	User	The user id who sent the invite.

reject_friend_request

$user.reject_friend_request(user: User)

Reject the friend request from the given user.

Parameter	Type	Meaning
user	User	The user id who sent the request.

reject_group_invite

$user.reject_group_invite(user: User)

Remove the group invite from the given user.

Parameter	Type	Meaning
user	User	The user id who sent the invite.

remove

$user.remove(user: User)

Enqueues the logout and removal of a user on the local system.

Parameter	Type	Meaning
user	User	The user handle.

remove_all_droids

$user.remove_all_droids()

Enqueues the removal of all droid users. Should only be called on the server.

remove_friend

$user.remove_friend(user: User)

Remove the user as a friend.

Parameter	Type	Meaning
user	User	The user id to remove.

rename_crew

$user.rename_crew(name: string)

Rename the crew. Only succeeds for the crew captain.

Parameter	Type	Meaning
name	string	The new crew name.

request_add_friend

$user.request_add_friend(user: User)

Send the user a friend request.

Parameter	Type	Meaning
user	User	The user id to add.

request_crews

read-only

$user.request_crews(users: list)

Request the crews for a set of arbitrary users.

Parameter	Type	Meaning
users	list	The users to request the crews for

request_presence_for_friends

$user.request_presence_for_friends()

Request presence for velan friends - this should be when the friends list is open. vonline will handle rate-limiting the message.

resume_activity

$user.resume_activity(activity: string)

Notifies the platform that the user has resumed the specified activity.

Parameter	Type	Meaning
activity	string	The name of the activity

send_crew_invite

$user.send_crew_invite(user: User)

Send the given user a crew invite.

Parameter	Type	Meaning
user	User	The user id to invite.

send_crew_join_request

$user.send_crew_join_request(user: User)

Request to join a given user's crew.

Parameter	Type	Meaning
user	User	The user id to send the request to.

set_crew_invite_permissions

$user.set_crew_invite_permissions(allowed: bool)

Set whether a user can receive crew_invites.

Parameter	Type	Meaning
allowed	bool	The value to set.

set_crew_invite_request_permissions

$user.set_crew_invite_request_permissions(allowed: bool)

Set whether a user can receive crew_invite_requests.

Parameter	Type	Meaning
allowed	bool	The value to set.

set_crossplay_permissions

$user.set_crossplay_permissions(enabled: bool)

Set whether a user has enabled crossplay.

Parameter	Type	Meaning
enabled	bool	True if the user is allowed to play crossplay

set_friend_request_permissions

$user.set_friend_request_permissions(allowed: bool)

Set whether a user can receive friend_requests.

Parameter	Type	Meaning
allowed	bool	The value to set.

set_group_invite_permissions

$user.set_group_invite_permissions(allowed: bool)

Set whether a user can receive group invites and join requests.

Parameter	Type	Meaning
allowed	bool	The value to set.

set_presence

$user.set_presence(state: int, rich_presence: int, rich_presence_string: string, args: list)

Set the rich presence of the local user.

Parameter	Type	Meaning
state	int	The new presence state.
rich_presence	int	The new rich presence state.
rich_presence_string	string	The new rich presence string, needed for first party presence.
args	list	Arguments for the rich presence string.

set_replicate_input

$user.set_replicate_input(user: User, replicate: bool)

Set if replication should forward input for this user.

Parameter	Type	Meaning
user	User	The user.
replicate	bool	Whether or not to replicate input for the user.

set_telemetry_allowed

$user.set_telemetry_allowed(opt_in: bool)

Set if the given user is allowing data sharing.

Parameter	Type	Meaning
opt_in	bool	Are we allowed to share this user's data?

set_thank_you_bonus_displayed

read-only

$user.set_thank_you_bonus_displayed(user: User)

Server Only - Send a request to backend to set thank you bonus displayed for a given user.

Parameter	Type	Meaning
user	User	The user to mark.

set_visibility

$user.set_visibility(visibility_state: int)

Set the local user's group visibility. Only relevant when they're the group leader (but it will still be saved if they are not.)

Parameter	Type	Meaning
visibility_state	int	The state to set the group's visibility to. See vonline_group_visibility_t.

should_consume_accepted_invite

read-only

$user.should_consume_accepted_invite() -> bool

Get whether the user has accepted an invite at the first party level.

Returns bool: True if the user has accepted a first party invite from the platform level.

should_display_crossplay_popup

read-only

$user.should_display_crossplay_popup(elapsed_time: float, manual_regional_override: bool) -> bool

Get whether crossplay enable popup should be shown.

Parameter	Type	Meaning
elapsed_time	float	How long has this use been matchmaking
manual_regional_override	bool	Is the region override enabled for this user

Returns bool: True if popup should be shown.

should_display_thank_you_bonus

read-only

$user.should_display_thank_you_bonus(user: User) -> bool

Server Only - Get whether we should display thank you bonus notification for a given user.

Parameter	Type	Meaning
user	User	The user to check.

Returns bool: True if we should display it.

start_activity

$user.start_activity(activity: string)

Notifies the platform that the user has started the specified activity.

Parameter	Type	Meaning
activity	string	The name of the activity

unblock_player

$user.unblock_player(user: User)

Unblock the given user.

Parameter	Type	Meaning
user	User	The user id to unblock.

will_all_users_run_this_frame

read-only

$user.will_all_users_run_this_frame() -> bool

Checks to see if all users will simulate the current frame.

Returns bool: Whether or not all users will run on this frame.

will_run_this_frame

read-only

$user.will_run_this_frame(user: User) -> bool

Checks to see if the given user will simulate the current frame. Intended be called on remote users.

Parameter	Type	Meaning
user	User	The user to check.

Returns bool: Whether or not the given user's client will run on this frame.