$psn_matches

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

read-only

$psn_matches.are_requests_pending() -> bool

Does the match instance still have pending requests?

Returns bool: True if match still has requests pending, false otherwise.

$psn_matches.create_match() -> bool

Make a request to create a match

Returns bool: True if match creation was started, false otherwise.

$psn_matches.destroy_match()

Destroy the match instance.

read-only

$psn_matches.get_match_status() -> int

Get the current status of the match

Returns int: The match status of type vpsn_match_status_t, or k_vpsn_match_status_unknown if match isn't valid.

read-only

$psn_matches.get_match_uuid() -> string

Get the PSN Match uuid

Returns string: Match uuid string if match is valiid, NULL otherwise

read-only

$psn_matches.has_access_token() -> bool

Do we have a valid access token to make calls to PSN?

Returns bool: True if we have received a valid access token from the backend, false otherwise.

read-only

$psn_matches.has_created_match() -> bool

Have we successfully created a PSN match?

Returns bool: True if match created successfully, false otherwise.

read-only

$psn_matches.is_creating_match() -> bool

Are we creating a PSN match?

Returns bool: True if match creation is underway, false otherwise.

$psn_matches.report_match_results(roster: list) -> bool

Reports the results for the PSN match. After this the match status will be marked as completed

Parameter	Type	Meaning
`roster`	`list`	The match team list provided as a list of lists.

Returns bool: True if request issued successfully, false otherwise.

$psn_matches.update_match_roster(roster: list) -> bool

Updates the team roster for the PSN match

Parameter	Type	Meaning
`roster`	`list`	The match team list provided as a list of lists.

Returns bool: True if request issued successfully, false otherwise.

$psn_matches.update_match_status(match_status: int) -> bool

Update the status of the PSN match

Parameter	Type	Meaning
`match_status`	`int`	The match status that we want to transition to.

Returns bool: True if request issued successfully, false otherwise.