$catch_match

The match: teams, rounds, scores and match flow.

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

debug_clear_recent_loadout_history

$catch_match.debug_clear_recent_loadout_history(user: User)

(DEBUG ONLY) Clears the recent loadout history for a user.

Parameter	Type	Meaning
user	User	The user to clear the history for.

debug_get_override_ball_loadout_label

read-only

$catch_match.debug_get_override_ball_loadout_label(user: User) -> int

(DEBUG ONLY) Gets the override ball loadout label for a user.

Parameter	Type	Meaning
user	User	The user to get the override ball loadout label for.

Returns int: The override ball loadout label for the given user. k_ball_loadout_label_none if not found or invalid.

debug_get_override_enabled

read-only

$catch_match.debug_get_override_enabled(user: User) -> bool

(DEBUG ONLY) Gets the override map type for a user.

Parameter	Type	Meaning
user	User	The user to get the override enabled status for.

Returns bool: Whether or not match loadout is enabled for the given user. false if not found or invalid.

debug_get_override_map_type

read-only

$catch_match.debug_get_override_map_type(user: User) -> int

(DEBUG ONLY) Gets the override map type for a user.

Parameter	Type	Meaning
user	User	The user to get the override map type for.

Returns int: The override map type for the given user. k_map_type_undefined if not found or invalid.

debug_get_override_match_rules_index

read-only

$catch_match.debug_get_override_match_rules_index(user: User) -> int

(DEBUG ONLY) Gets the override match rules index for a user.

Parameter	Type	Meaning
user	User	The user to get the override match rules index for.

Returns int: The override match rules index for the given user. -1 is default.

debug_get_override_match_rules_type

read-only

$catch_match.debug_get_override_match_rules_type(user: User) -> int

(DEBUG ONLY) Gets the override match rules type for a user.

Parameter	Type	Meaning
user	User	The user to get the override match rules type for.

Returns int: The override match rules type for the given user. k_match_rules_type_none if not found or invalid.

debug_get_recent_ball_loadout_label_list

read-only

$catch_match.debug_get_recent_ball_loadout_label_list(user: User) -> list

(DEBUG ONLY) Retuns a list of recent ball loadout labels.

Parameter	Type	Meaning
user	User	The user to get the history for.

Returns list: A list of the recent ball loadouts encountered.

debug_get_recent_ball_loadout_label_scores

read-only

$catch_match.debug_get_recent_ball_loadout_label_scores(recent_list: list) -> list

(DEBUG ONLY) Retuns a list of scores for the list of recent ball loadout labels.

Parameter	Type	Meaning
recent_list	list	A list of ball loadout labels.

Returns list: A list of the scores for the list provided.

debug_get_recent_map_list

read-only

$catch_match.debug_get_recent_map_list(user: User) -> list

(DEBUG ONLY) Retuns a list of recent maps.

Parameter	Type	Meaning
user	User	The user to get the history for.

Returns list: A list of the recent maps played.

debug_get_recent_map_type_scores

read-only

$catch_match.debug_get_recent_map_type_scores(recent_list: list) -> list

(DEBUG ONLY) Retuns a list of scores for the list of recent maps.

Parameter	Type	Meaning
recent_list	list	A list of map types.

Returns list: A list of the scores for the list provided.

debug_get_recent_match_rules_type_list

read-only

$catch_match.debug_get_recent_match_rules_type_list(user: User) -> list

(DEBUG ONLY) Returns a list of recent match rules types.

Parameter	Type	Meaning
user	User	The user to get the history for.

Returns list: A list of the recent match rule types played.

debug_get_recent_match_rules_type_scores

read-only

$catch_match.debug_get_recent_match_rules_type_scores(recent_list: list) -> list

(DEBUG ONLY) Returns a list of scores for the list of recent match rule types.

Parameter	Type	Meaning
recent_list	list	A list of match rule types.

Returns list: A list of the scores for the list provided.

debug_get_recent_music_list

read-only

$catch_match.debug_get_recent_music_list(user: User, music_count: int) -> list

(DEBUG ONLY) Retuns a list of recent music.

Parameter	Type	Meaning
user	User	The user to get the history for.
music_count	int	The number of music tracks.

Returns list: A list of the recent music encountered.

debug_get_recent_music_scores

read-only

$catch_match.debug_get_recent_music_scores(recent_list: list, music_count: int) -> list

(DEBUG ONLY) Retuns a list of scores for the list of recent music.

Parameter	Type	Meaning
recent_list	list	A list of music indices.
music_count	int	The number of music tracks.

Returns list: A list of the scores for the list provided.

debug_record_random_loadout

$catch_match.debug_record_random_loadout(user: User, music_count: int)

(DEBUG ONLY) Records a random loadout selection for a user.

Parameter	Type	Meaning
user	User	The user to record the match loadout for.
music_count	int	The number of music tracks.

debug_record_recent_loadout

$catch_match.debug_record_recent_loadout(user: User, map_type: int, ball_loadout_label: int, match_rules_type: int, music_index: int)

(DEBUG ONLY) Records the loadout selection for a user.

Parameter	Type	Meaning
user	User	The user to record the match loadout for.
map_type	int	The map type to record.
ball_loadout_label	int	The ball loadout label to record.
match_rules_type	int	The match rules type to record.
music_index	int	The music index to record.

debug_select_override_match_loadout

$catch_match.debug_select_override_match_loadout(match_def: Reference, user_list: list, music_name_list: list, custom_match_map: int, custom_match_ball: int) -> list

Determines loadout selection based on overrides set by all users given. This function is non-deterministic.

Parameter	Type	Meaning
match_def	Reference	A match definition file.
user_list	list	A list of user refs that will participate in the match.
music_name_list	list	A list of the names of the music to select from.
custom_match_map	int	Optional override for map selection in custom matches. Set to -1 if not desired.
custom_match_ball	int	Optional override for ball type in custom matches. Set to -1 if not desired.

Returns list: The chosen loadout's data. The loadout index, the index of the map package, the index of the match rules, the index of the ball loadout, the index of the music to use, randomly chosen from the supplied music name list, and whether or not a valid loadout was selected.

debug_set_override_loadout

$catch_match.debug_set_override_loadout(user: User, is_enabled: bool, map_type: int, ball_loadout_label: int, match_rules_type: int, match_rules_index: int)

(DEBUG ONLY) Records the loadout selection for a user.

Parameter	Type	Meaning
user	User	The user to record the match loadout for.
is_enabled	bool	Whether or not to enable the match loadout override.
map_type	int	The map type to record.
ball_loadout_label	int	The ball loadout label to record.
match_rules_type	int	The match rules type to record
match_rules_index	int	The match rules index to record

ftue_training_playlist

read-only

$catch_match.ftue_training_playlist(match_def: Reference) -> bool

Gets if this is a FTUE training playlist.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns bool: If the match def is a FTUE training playlist

get_active_powerup_group

read-only

$catch_match.get_active_powerup_group(match_rules: Reference) -> int

Gets the powerup group that will be active.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The powerup group that will be active.

get_allow_collectible_hold_and_drop

read-only

$catch_match.get_allow_collectible_hold_and_drop(match_rules: Reference) -> bool

Whether the player is allowed to hold (and drop) collectibles

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether the player is allowed to hold (and drop) collectibles

get_allow_collectible_initial_spawn

read-only

$catch_match.get_allow_collectible_initial_spawn(match_rules: Reference) -> bool

Gets whether to spawn collectibles at each team's initial spawn location.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether to spawn collectibles at eacg team's initial spawn location.

get_allow_collectible_spawn

read-only

$catch_match.get_allow_collectible_spawn(match_rules: Reference) -> bool

Gets whether or not to allow the spawning of collectibles.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to allow players to spawn collectibles when hit.

get_allow_custom_match_ball_select

read-only

$catch_match.get_allow_custom_match_ball_select(match_def: Reference) -> bool

Gets whether non-default ball loadouts can be selected in custom private matches.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns bool: Whether to allow picking a custom ball loadout in private matches.

get_allow_custom_match_bot_select

read-only

$catch_match.get_allow_custom_match_bot_select(match_def: Reference) -> bool

Gets whether bots can be enabled for a given playlist in a custom private match.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns bool: Whether to allow enabling bots in private matches.

get_allow_loadout_selection

read-only

$catch_match.get_allow_loadout_selection(match_rules: Reference) -> bool

Gets whether or not to allow players to pick a mode-relative loadout.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to allow players to pick their mode-relative loadout.

get_allow_new_player_matchmaking

read-only

$catch_match.get_allow_new_player_matchmaking(match_def: Reference) -> bool

Gets if a match definition should use the new player matchmaking rules.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns bool: If the match definition allows new player mathcmaking

get_allow_point_display_fx

read-only

$catch_match.get_allow_point_display_fx(match_rules: Reference) -> bool

Gets whether or not to allow point display hud fx on hit or ko.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to allow point display hud fx on hit or ko.

get_allow_points_by_collectible

read-only

$catch_match.get_allow_points_by_collectible(match_rules: Reference) -> bool

Gets whether or not to allow points to be scored by collecting collectibles.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to allow points to be scored by collecting collectibles.

get_allow_points_for_last_team_standing

read-only

$catch_match.get_allow_points_for_last_team_standing(match_rules: Reference) -> bool

Gets whether or not to allow points to be scored when a team becomes the last team standing.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to allow points to be scored when a team becomes the last team standing.

get_allow_replacement_droids

read-only

$catch_match.get_allow_replacement_droids(match_def: Reference) -> bool

Gets whether to spawn droids when player disconnects in street play.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns bool: Whether to spawn droids when player disconnects in street play.

get_allow_spectating_of_opponent_teams

read-only

$catch_match.get_allow_spectating_of_opponent_teams(match_rules: Reference) -> bool

Gets whether or not to allow a downed player to spectate opponent teams.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to allow a downed player to spectate opponent teams.

get_announcer_session_repeat_match_rules_vo

read-only

$catch_match.get_announcer_session_repeat_match_rules_vo(match_def: Reference) -> bool

Gets whether to announce the match rules regardless of whether the vo has played this session.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns bool: Whether to announce the match rules regardless of whether the vo has played this session.

get_award_cached_points_immediately

read-only

$catch_match.get_award_cached_points_immediately(match_rules: Reference) -> bool

Gets whether or not to award points immediately for surviving in elimination but cache those points to be awarded when the ring expands. Only applicable during matches where allow_points_for_last_team_standing and award_points_based_on_ko_order are enabled.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to award points immediately for surviving in elimination but cache those points to be awarded when the ring expands. Only applicable during matches where allow_points_for_last_team_standing and award_points_based_on_ko_order are enabled.

get_award_points_based_on_ko_order

read-only

$catch_match.get_award_points_based_on_ko_order(match_rules: Reference) -> bool

Gets whether or not to award points based on ko order. Only applicable during matches where allow_points_for_last_team_standing is enabled.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to award points based on ko order. Only applicable during matches where allow_points_for_last_team_standing is enabled.

get_ball_charge_rate_multiplier

read-only

$catch_match.get_ball_charge_rate_multiplier(match_rules: Reference) -> float

Gets the charge rate multiplier to use for balls.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: The charge rate mutliplier to use, or -1 if there is no multiplier.

get_ball_loadout

read-only

$catch_match.get_ball_loadout(match_loadout: Reference, index: int) -> Reference

Gets a ref to the ball_loadout from a loadout.

Parameter	Type	Meaning
match_loadout	Reference	A match loadout reference.
index	int	The ball loadout index.

Returns Reference: The ball loadout.

get_ball_loadout_allow_droids

read-only

$catch_match.get_ball_loadout_allow_droids(loadout: Reference) -> bool

Gets whether to allow replacement droids for this ball loadout.

Parameter	Type	Meaning
loadout	Reference	A ball_loadout reference.

Returns bool: Whether to allow droids for this ball loadout

get_ball_loadout_description

read-only

$catch_match.get_ball_loadout_description(loadout: Reference) -> string

Returns a localized string describing the given ball loadout.

Parameter	Type	Meaning
loadout	Reference	A ball_loadout reference.

Returns string: The description.

get_ball_loadout_group

read-only

$catch_match.get_ball_loadout_group(loadout: Reference, index: int) -> Reference

Get the group (an opaque ref) specified in the ball loadout at the given index.

Parameter	Type	Meaning
loadout	Reference	A ball loadout reference.
index	int	The index of the desired group.

Returns Reference: the ball loadout group specified in the ball loadout at the given index.

get_ball_loadout_group_ball_count

read-only

$catch_match.get_ball_loadout_group_ball_count(group: Reference) -> int

Gets the number of balls desired in the given group.

Parameter	Type	Meaning
group	Reference	A group definition as returned by catch_match.get_ball_loadout_group().

Returns int: The number of balls in the given group.

get_ball_loadout_group_entry

read-only

$catch_match.get_ball_loadout_group_entry(group: Reference, index: int) -> Reference

Get the entry (an opaque ref) specified in the ball loadout group at the given index.

Parameter	Type	Meaning
group	Reference	A ball loadout group reference.
index	int	The index of the desired group entry.

Returns Reference: the ball loadout group entry specified at the given index.

get_ball_loadout_group_entry_ball_type

read-only

$catch_match.get_ball_loadout_group_entry_ball_type(entry: Reference) -> int

Gets the vcatch_ball_type_t of the given ball loadout group entry.

Parameter	Type	Meaning
entry	Reference	A group entry definition as returned by catch_match.get_ball_loadout_group_entry().

Returns int: The type enum from the entry.

get_ball_loadout_group_entry_length

read-only

$catch_match.get_ball_loadout_group_entry_length(group: Reference) -> int

Gets the number of entries in the given group.

Parameter	Type	Meaning
group	Reference	A group definition as returned by catch_match.get_ball_loadout_group().

Returns int: The number of entries in the given group.

get_ball_loadout_group_entry_weight

read-only

$catch_match.get_ball_loadout_group_entry_weight(entry: Reference) -> int

Gets the weight of the given ball loadout group entry.

Parameter	Type	Meaning
entry	Reference	A group entry definition as returned by catch_match.get_ball_loadout_group_entry().

Returns int: The weight.

get_ball_loadout_group_length

read-only

$catch_match.get_ball_loadout_group_length(loadout: Reference) -> int

Gets the number of groups specified in the given ball loadout.

Parameter	Type	Meaning
loadout	Reference	A ball loadout reference.

Returns int: The number of groups specified in the ball loadout.

get_ball_loadout_label

read-only

$catch_match.get_ball_loadout_label(loadout: Reference) -> int

Returns the ball_loadout_label of a ball loadout.

Parameter	Type	Meaning
loadout	Reference	A ball_loadout reference.

Returns int: The loadout label.

get_ball_loadout_path

read-only

$catch_match.get_ball_loadout_path(loadout: Reference) -> string

Returns the path of a ball loadout.

Parameter	Type	Meaning
loadout	Reference	A ball_loadout reference.

Returns string: The path.

get_ball_loadout_preview_texture_package

read-only

$catch_match.get_ball_loadout_preview_texture_package(loadout: Reference) -> Reference

Returns a localized string ref for the given ball loadout.

Parameter	Type	Meaning
loadout	Reference	A ball_loadout reference.

Returns Reference: The preview image texture package

get_ball_loadout_slot_machine_desc_type

read-only

$catch_match.get_ball_loadout_slot_machine_desc_type(loadout: Reference) -> int

Returns the slot machine desc type of a ball loadout.

Parameter	Type	Meaning
loadout	Reference	A ball_loadout reference.

Returns int: The slot machine desc type.

get_basketbrawl_allow_unique_slam_dunk_score

read-only

$catch_match.get_basketbrawl_allow_unique_slam_dunk_score(match_rules: Reference) -> bool

Get whether to award a different amount of points for a slam dunk.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether to award a different amount of points for a slam dunk.

get_city_rep_level_requirement

read-only

$catch_match.get_city_rep_level_requirement(match_def: Reference) -> int

Gets the minimum city rep level (ie Street Rank) required to matchmake in this playlist.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns int: The minimum city rep level (ie Street Rank) required to matchmake in this playlist.

get_closing_ring_type

read-only

$catch_match.get_closing_ring_type(match_rules: Reference) -> int

Gets the type of closing ring to spawn for the match.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The type of closing ring to spawn for the match from vcatch_closing_ring_type_t.

get_collectible_per_team_initial_spawn_count

read-only

$catch_match.get_collectible_per_team_initial_spawn_count(match_rules: Reference) -> int

Gets the number of collectibles to spawn at each team's initial spawn location at the beginning of a match.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of collectibles to spawn at each team's initial spawn location at the beginning of a match.

get_collectible_to_drop_on_hit_count

read-only

$catch_match.get_collectible_to_drop_on_hit_count(match_rules: Reference) -> int

Gets the number of collectibles to drop when a player is hit.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of collectibles to drop when a player is hit.

get_collectible_to_drop_on_ko_count

read-only

$catch_match.get_collectible_to_drop_on_ko_count(match_rules: Reference) -> int

Gets the number of collectibles to drop when a player is K.O.'d. by something other than an ultimate throw.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of collectibles to drop when a player is K.O.'d by something other than an ultimate throw.

get_collectible_to_drop_on_player_ball_ko_count

read-only

$catch_match.get_collectible_to_drop_on_player_ball_ko_count(match_rules: Reference) -> int

Gets the number of collectibles to drop when a player is K.O.'d by an (non-ultimate) player_ball.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of collectibles to drop when a player is K.O.'d by an (non-ultimate) player ball.

get_collectible_to_drop_on_ultimate_ko_count

read-only

$catch_match.get_collectible_to_drop_on_ultimate_ko_count(match_rules: Reference) -> int

Gets the number of collectibles to drop when a player is K.O.'d by an ultimate throw.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of collectibles to drop when a player is K.O.'d by an ultimate throw.

get_collectible_to_spawn_on_hit_count

read-only

$catch_match.get_collectible_to_spawn_on_hit_count(match_rules: Reference) -> int

Gets the number of collectibles to spawn when a player is hit.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of collectibles to spawn when a player is hit.

get_collectible_to_spawn_on_ko_count

read-only

$catch_match.get_collectible_to_spawn_on_ko_count(match_rules: Reference) -> int

Gets the number of collectibles to spawn when a player is K.O.'d. by something other than an ultimate throw.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of collectibles to spawn when a player is K.O.'d by something other than an ultimate throw.

get_collectible_to_spawn_on_player_ball_ko_count

read-only

$catch_match.get_collectible_to_spawn_on_player_ball_ko_count(match_rules: Reference) -> int

Gets the number of collectibles to spawn when a player is K.O.'d by an (non-ultimate) player_ball.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of collectibles to spawn when a player is K.O.'d by an (non-ultimate) player ball.

get_collectible_to_spawn_on_ultimate_ko_count

read-only

$catch_match.get_collectible_to_spawn_on_ultimate_ko_count(match_rules: Reference) -> int

Gets the number of collectibles to spawn when a player is K.O.'d by an ultimate throw.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of collectibles to spawn when a player is K.O.'d by an ultimate throw.

get_collectible_type

read-only

$catch_match.get_collectible_type(match_rules: Reference) -> int

Gets the type of collectible used in this match.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The collectible type to use in this match.

get_disable_border_warning

read-only

$catch_match.get_disable_border_warning(match_rules: Reference) -> bool

Gets whether or not to disable the border warning for the match.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to disable the border warning for the match.

get_disable_initial_spawn_randomization

read-only

$catch_match.get_disable_initial_spawn_randomization(match_rules: Reference) -> bool

Gets whether or not to disable randomization of initial spawn locations.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to disable randomization of initial spawn locations.

get_disallow_basketbrawl_hoops

read-only

$catch_match.get_disallow_basketbrawl_hoops(match_rules: Reference) -> bool

Gets if we disallow basketbrawl hoops.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Do we disallow basketbrawl hoop.

get_drop_all_collectibles_on_ko

read-only

$catch_match.get_drop_all_collectibles_on_ko(match_rules: Reference) -> bool

Whether to drop all collectibles on KO.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether to drop all collectibles on KO.

get_enable_fulltime_powerups

read-only

$catch_match.get_enable_fulltime_powerups(match_rules: Reference) -> bool

Gets whether fulltime powerups listed are enabled.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether fulltime powerups listed are enabled.

get_enable_revenge_ultimate

read-only

$catch_match.get_enable_revenge_ultimate(match_rules: Reference) -> bool

Gets whether or not to enable revenge ultimates on player KO.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to enable revenge ultimate on player KO.

get_enemies_revealed_upon_respawn_duration

read-only

$catch_match.get_enemies_revealed_upon_respawn_duration(match_rules: Reference) -> float

Gets the length of time enemies are revealed to a player upon respawn.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: The length of time enemies are revealed to a player upon respawn.

get_hide_first_to_text

read-only

$catch_match.get_hide_first_to_text(match_rules: Reference) -> bool

Get whether to hide the first to # text.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether to hide the first to # text.

get_hide_round_num_text

read-only

$catch_match.get_hide_round_num_text(match_rules: Reference) -> bool

Get whether to hide the round number text.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether to hide the round number text.

get_hurry_up_time

read-only

$catch_match.get_hurry_up_time(match_rules: Reference) -> float

Gets the time at which the game is in a 'hurry up' state.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: The time at which the game is in a 'hurry up' state.

get_is_active

read-only

$catch_match.get_is_active(match_def: Reference, match_flow: int) -> bool

Gets the is_active state from the match definition.

Parameter	Type	Meaning
match_def	Reference	A match definition file.
match_flow	int	The match flow to get the active status of.

Returns bool: Whether the playlist is active.

get_is_enabled_fulltime_powerup_id

read-only

$catch_match.get_is_enabled_fulltime_powerup_id(match_rules: Reference, powerup_id: int) -> bool

Gets whether the specific powerup type is enabled fulltime.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.
powerup_id	int	The powerup type for which to check for fulltime use.

Returns bool: Whether the specific powerup type is enabled fulltime.

get_is_freeze_tag

read-only

$catch_match.get_is_freeze_tag(match_rules: Reference) -> bool

Gets if this is a freeze tag rules.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Are we in a freeze tag.

get_juggernaut_start_time

read-only

$catch_match.get_juggernaut_start_time(match_rules: Reference) -> float

Gets the number of seconds before which the first player becomes juggernaut, if juggernaut rules are active.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: The number of seconds before which the first player becomes juggernaut.

get_ko_order_points_for_placement

read-only

$catch_match.get_ko_order_points_for_placement(match_rules: Reference, placement_index: int) -> int

Gets the number of points to award for the given placement. Only applicable during matches where allow_points_for_last_team_standing is enabled and award_points_based_on_ko_order is enabled.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.
placement_index	int	The placement index for which to retrieve the amount of awarded points.

Returns int: The number of points to award for the given placement. Only applicable during matches where allow_points_for_last_team_standing is enabled and award_points_based_on_ko_order is enabled.

get_level_checkmark_contract

read-only

$catch_match.get_level_checkmark_contract(match_def: Reference) -> Reference

Gets the contract, which if finished, will add a checkmark to the playlist button.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns Reference: The contract

get_level_checkmark_persistence_key

read-only

$catch_match.get_level_checkmark_persistence_key(match_def: Reference) -> string

Gets the complete persistence key, which if set, will add a checkmark to the playlist button.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns string: The contract

get_level_description

read-only

$catch_match.get_level_description(match_def: Reference) -> string

Gets a description of the match as defined in the playlist.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns string: A string that describes the match.

get_level_flavor_background_texture_package

read-only

$catch_match.get_level_flavor_background_texture_package(match_def: Reference) -> Reference

Gets the level flavor background texture package.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns Reference: The level flavor background texture package.

get_level_flavor_foreground_texture_package

read-only

$catch_match.get_level_flavor_foreground_texture_package(match_def: Reference) -> Reference

Gets the level flavor foreground texture package.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns Reference: The level flavor foreground texture package.

get_level_net_name

read-only

$catch_match.get_level_net_name(match_def: Reference) -> string

Gets the net name of the level to spawn.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns string: A string that is used as the net name when spawning the package.

get_level_playlist_name

read-only

$catch_match.get_level_playlist_name(match_def: Reference) -> string

Gets the playlist name of the match as defined in the playlist.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns string: A string of match's playlist name.

get_level_vs_info

read-only

$catch_match.get_level_vs_info(match_def: Reference) -> string

Gets the vs information of the match as defined in the playlist.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns string: A string of match's vs information.

get_loadout_ball_count

read-only

$catch_match.get_loadout_ball_count(match_def: Reference, loadout_index: int) -> int

Get the number of ball loadouts contained in a match loadout.

Parameter	Type	Meaning
match_def	Reference	A match definition file.
loadout_index	int	The loadout index.

Returns int: The length of the ball_loadouts array.

get_loadout_by_index

read-only

$catch_match.get_loadout_by_index(match_def: Reference, index: int) -> Reference

Gets the loadout at a given index.

Parameter	Type	Meaning
match_def	Reference	A match definition file.
index	int	The index of the loadout to read.

Returns Reference: The given loadout.

get_loadout_map_count

read-only

$catch_match.get_loadout_map_count(match_def: Reference, loadout_index: int) -> int

Get the number of map_defs contained in a match loadout.

Parameter	Type	Meaning
match_def	Reference	A match definition file.
loadout_index	int	The loadout index.

Returns int: The length of the map_def array.

get_loadout_selection_time

read-only

$catch_match.get_loadout_selection_time(match_rules: Reference) -> float

Gets the time for loadout selection for when loadout selection is allowed.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: Time for loadout selection for when loadout selection is allowed.

get_map_def

read-only

$catch_match.get_map_def(match_def: Reference, loadout_index: int, map_index: int) -> Reference

Gets the map def that contains the package to spawn for this match.

Parameter	Type	Meaning
match_def	Reference	A match def.
loadout_index	int	The loadout index.
map_index	int	The map index.

Returns Reference: The map_def that contains the package to spawn for this match.

get_map_def_allow_droids

read-only

$catch_match.get_map_def_allow_droids(map_def: Reference) -> bool

Gets whether to allow replacement droids for this map.

Parameter	Type	Meaning
map_def	Reference	A map def.

Returns bool: Whether to allow replacement droids for this map.

get_map_def_preview_texture_package

read-only

$catch_match.get_map_def_preview_texture_package(map_def: Reference) -> Reference

Gets the preview image texture package.

Parameter	Type	Meaning
map_def	Reference	A map def.

Returns Reference: The preview image texture package

get_map_def_standard_package

read-only

$catch_match.get_map_def_standard_package(map_def: Reference) -> Reference

Gets the package ref to the standard variant of this map.

Parameter	Type	Meaning
map_def	Reference	A map def.

Returns Reference: The standard variant of this map.

get_map_type

read-only

$catch_match.get_map_type(map_def: Reference) -> int

Gets the map type as an integer.

Parameter	Type	Meaning
map_def	Reference	A map def.

Returns int: The map_def to retrieve the type from.

get_match_loadout_count

read-only

$catch_match.get_match_loadout_count(match_def: Reference) -> int

Get the number of loadouts contained in a match_def.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns int: The length of the loadout array.

get_match_metadata_season

read-only

$catch_match.get_match_metadata_season(match_def: Reference) -> int

Gets the metadata season this match is tagged with.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns int: The metadata season

get_match_result_stats_list

read-only

$catch_match.get_match_result_stats_list(match_rules: Reference) -> list

Gets the list of desired match stats for the given match rules reference.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns list: The list of desired match stats for the given match rules reference. Values from the vcatch_match_result_stat_type_t enum.

get_match_result_stats_override_names

read-only

$catch_match.get_match_result_stats_override_names(match_rules: Reference) -> list

Gets the override list of desired names for the match stats for the given match rules reference.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns list: The list of desired match stats for the given match rules reference. Values from the vcatch_match_result_stat_type_t enum.

get_match_rules

read-only

$catch_match.get_match_rules(match_def: Reference, loadout_index: int, match_rules_index: int) -> Reference

Gets a ref to the match_rules from a match loadout.

Parameter	Type	Meaning
match_def	Reference	A match def reference.
loadout_index	int	The match loadout index.
match_rules_index	int	The match loadout index.

Returns Reference: The match rules.

get_match_rules_type

read-only

$catch_match.get_match_rules_type(match_rules: Reference) -> int

Gets the match rules type for the given match rules reference.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The match rules type for the given match rules reference. A value from the vcatch_match_rules_type_t enum.

get_match_win_cond_first_to_goal

read-only

$catch_match.get_match_win_cond_first_to_goal(match_rules: Reference) -> int

Gets the number of rounds a team win in order to win the match.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of rounds a team must lead by in order to win the match.

get_match_win_cond_win_by_margin

read-only

$catch_match.get_match_win_cond_win_by_margin(match_rules: Reference) -> int

Gets the number of rounds a team must lead by in order to win the match.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of rounds a team must lead by in order to win the match.

get_oddball_count

read-only

$catch_match.get_oddball_count(match_rules: Reference) -> int

Gets the number of desired oddballs in the match - only valid if the match rules are set to Oddball.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of desired oddballs in the match - only valid if the match rules are set to Oddball.

get_oddball_holding_points_per_period

read-only

$catch_match.get_oddball_holding_points_per_period(match_rules: Reference) -> int

Gets the number of points awarded every oddball_holding_score_duration seconds when holding an Odd Ball.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: Points awarded every oddball_holding_score_duration seconds when holding an Odd Ball

get_oddball_holding_score_initial_period

read-only

$catch_match.get_oddball_holding_score_initial_period(match_rules: Reference) -> float

Specifies the number of seconds before initially awarding points_for_holding_oddball when holding an Odd Ball.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: The number of seconds before initially awarding points_for_holding_oddball when holding an Odd Ball.

get_oddball_holding_score_period

read-only

$catch_match.get_oddball_holding_score_period(match_rules: Reference) -> float

Specifies the number of seconds between awarding points_for_holding_oddball when holding an Odd Ball.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: The number of seconds between awarding points_for_holding_oddball when holding an Odd Ball.

get_oddball_initial_spawn_delay

read-only

$catch_match.get_oddball_initial_spawn_delay(match_rules: Reference) -> float

Gets the delay after the beginning of the match for the first oddball spawn - only valid if the match rules are set to Oddball.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: The delay after an oddball despawns before it respawns - only valid if the match rules are set to Oddball.

get_oddball_oob_point_deduction

read-only

$catch_match.get_oddball_oob_point_deduction(match_rules: Reference) -> int

Gets points to be deducted if a team is the last to hold the oddball and it falls off the map.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: Points to be deducted if a team is the last to hold the oddball and it falls off the map.

get_oddball_point_limit

read-only

$catch_match.get_oddball_point_limit(match_rules: Reference) -> int

Gets the limit of points an oddball has before it requires respawn.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The limit of points an oddball has before it requires respawn

get_oddball_spawn_delay

read-only

$catch_match.get_oddball_spawn_delay(match_rules: Reference) -> float

Gets the delay after an oddball despawns before it respawns - only valid if the match rules are set to Oddball.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: The delay after an oddball despawns before it respawns - only valid if the match rules are set to Oddball.

get_override_announcer_level

read-only

$catch_match.get_override_announcer_level(match_def: Reference) -> Reference

Gets the override announcer observer level for this match_def.

Parameter	Type	Meaning
match_def	Reference	A match def file.

Returns Reference: The announcer observer level for this match def.

get_overtime_time_limit

read-only

$catch_match.get_overtime_time_limit(match_rules: Reference) -> float

Gets the time limit for round overtime in the match.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: The time limit for round overtime in the match.

get_player_collectible_hold_limit

read-only

$catch_match.get_player_collectible_hold_limit(match_rules: Reference) -> int

Gets the number of collectibles a player can hold.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of collectibles a player can hold.

get_player_respawn_count

read-only

$catch_match.get_player_respawn_count(match_rules: Reference) -> int

Gets the number of times a player is allowed to respawn. Valid only when get_match_should_limit_respawn_count returns true.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of times a player is allowed to respawn. Valid only when get_match_should_limit_respawn_count returns true.

get_player_respawns_with_ball

read-only

$catch_match.get_player_respawns_with_ball(match_rules: Reference) -> bool

Gets whether or not players get a ball when they respawn.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not players get a ball when they respawn.

get_player_vs_bots

read-only

$catch_match.get_player_vs_bots(match_def: Reference) -> bool

Gets whether bots should make up one team

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns bool: Whether to allow a team to consist of bots

get_points_awarded_for_opponent_falls

read-only

$catch_match.get_points_awarded_for_opponent_falls(match_rules: Reference) -> int

Gets the number of points to award for opponent falls that do not result in a team elimination. Only applicable during matches where allow_points_for_last_team_standing and award_points_based_on_ko_order are enabled.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of points to award for opponent falls that do not result in a team elimination.

get_points_on_juggernaut_hit_player

read-only

$catch_match.get_points_on_juggernaut_hit_player(match_rules: Reference) -> int

Gets points when the juggernaut hits a player.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: Points to be scored by the juggernaut hitting opponent players.

get_points_on_juggernaut_ko_player

read-only

$catch_match.get_points_on_juggernaut_ko_player(match_rules: Reference) -> int

Gets points when the juggernaut K.O.-s a player.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: Points to be scored by the juggernaut K.O.-ing opponent players.

get_points_on_player_hit

read-only

$catch_match.get_points_on_player_hit(match_rules: Reference) -> int

Gets points to be scored on hitting opponents.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: Points to be scored on hitting opponent players.

get_points_on_player_hit_juggernaut

read-only

$catch_match.get_points_on_player_hit_juggernaut(match_rules: Reference) -> int

Gets points when a player hits a juggernaut.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: Points to be scored by a player hitting an opponent juggernaut.

get_points_on_player_ko

read-only

$catch_match.get_points_on_player_ko(match_rules: Reference) -> int

Gets points to be scored on K.O.-ing opponents.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: Points to be scored on K.O.-ing opponent players.

get_points_on_player_ko_juggernaut

read-only

$catch_match.get_points_on_player_ko_juggernaut(match_rules: Reference) -> int

Gets points when a player K.O.-s a juggernaut.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: Points to be scored by a player K.O.-ing an opponent juggernaut.

get_points_on_player_oddball_hit

read-only

$catch_match.get_points_on_player_oddball_hit(match_rules: Reference) -> int

Gets points to be scored on hitting opponents with an Odd Ball.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: Points to be scored on hitting opponent players with an Odd Ball.

get_points_on_player_oddball_ko

read-only

$catch_match.get_points_on_player_oddball_ko(match_rules: Reference) -> int

Gets points to be scored on K.O.-ing opponents with an Odd Ball.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: Points to be scored on K.O.-ing opponent players with an Odd Ball.

get_respawn_neutral_balls_upon_ring_expand

read-only

$catch_match.get_respawn_neutral_balls_upon_ring_expand(match_rules: Reference) -> bool

Gets whether or not to respawn all neutral balls when the ring expands. Only applicable during matches where allow_points_for_last_team_standing is enabled.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to respawn all neutral balls when the ring expands. Only applicable during matches where allow_points_for_last_team_standing is enabled.

get_revenge_ultimate_prevents_match_end

read-only

$catch_match.get_revenge_ultimate_prevents_match_end(match_rules: Reference) -> bool

Gets whether or not revenge ultimates prevent the end of the match while active.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not revenge ultimates prevent the end of the match while active.

get_round_time_limit

read-only

$catch_match.get_round_time_limit(match_rules: Reference) -> float

Gets the time limit for a round in the match.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: the time limit for a round in the match.

get_round_win_cond_first_to_goal

read-only

$catch_match.get_round_win_cond_first_to_goal(match_rules: Reference) -> int

Gets the number of rounds a team win in order to win the round.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of rounds a team must lead by in order to win the match.

get_round_win_cond_win_by_margin

read-only

$catch_match.get_round_win_cond_win_by_margin(match_rules: Reference) -> int

Gets the number of rounds a team must lead by in order to win the round.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The number of rounds a team must lead by in order to win the match.

get_rules_announcer_level

read-only

$catch_match.get_rules_announcer_level(match_rules: Reference) -> Reference

Gets the announcer observer level for this match_rules.

Parameter	Type	Meaning
match_rules	Reference	A match rules file.

Returns Reference: The announcer observer level for this match rules.

get_rules_collectible_spawner_level_override

read-only

$catch_match.get_rules_collectible_spawner_level_override(match_rules: Reference) -> Reference

Gets the override collectible spawner level for this match_rules.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns Reference: The collectible spawner level for this match_rules.

get_should_limit_respawn_count

read-only

$catch_match.get_should_limit_respawn_count(match_rules: Reference) -> bool

Gets whether or not to limit the number of times a player can respawn.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to limit the number of times a player can respawn.

get_show_basic_ball_intro

read-only

$catch_match.get_show_basic_ball_intro(match_def: Reference) -> bool

Gets whether show intro cutscene if selected loadout doesnt contain any special balls.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns bool: Whether to show ball slot machine shot when there is no special ball.

get_show_collectible_held_count_in_hud

read-only

$catch_match.get_show_collectible_held_count_in_hud(match_rules: Reference) -> bool

Gets whether or not to show the collectibles held by all players in the hud.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to show the collectibles held by all players in the hud.

get_show_custom_game_menu_countdown

read-only

$catch_match.get_show_custom_game_menu_countdown(match_def: Reference) -> bool

Gets whether the time remaining should be shown in custom games

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns bool: Should it display time remaining

get_show_remote_player_score_info_hud

read-only

$catch_match.get_show_remote_player_score_info_hud(match_rules: Reference) -> bool

Gets whether or not to show the score info hud below remote players.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to show the score info hud below remote players.

get_spawn_closing_ring

read-only

$catch_match.get_spawn_closing_ring(match_rules: Reference) -> bool

Gets whether or not to spawn a closing ring.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to spawn a closing ring for the match.

get_team_count

read-only

$catch_match.get_team_count(match_def: Reference) -> int

Gets the number of expected teams from the match definition.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns int: The number of teams expected to be participating in the match.

get_team_size

read-only

$catch_match.get_team_size(match_def: Reference) -> int

Gets the expected team size from the match definition.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns int: The number of players expected to be on each team.

get_treasure_hunt_collectible_spawn_period

read-only

$catch_match.get_treasure_hunt_collectible_spawn_period(match_rules: Reference) -> float

Gets how often collectibles will spawn in Treasure Hunt. This applies only to the stationary collectibles that spawn in the map.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns float: how often Treasure Hunt collectibles will spawn in the Treasure Hunt game mode.

get_use_alternate_bomb_ball_level

read-only

$catch_match.get_use_alternate_bomb_ball_level(match_rules: Reference) -> bool

Gets whether or not to use the alternate bomb ball level.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to use the alternate bomb ball level.

get_use_average_score_for_same_ko_order

read-only

$catch_match.get_use_average_score_for_same_ko_order(match_rules: Reference) -> bool

Gets whether or not to average points for all teams tied with a ko order placement. Only applicable during matches where allow_points_for_last_team_standing and award_points_based_on_ko_order are enabled.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to average points for all teams tied with a ko order placement. Only applicable during matches where allow_points_for_last_team_standing and award_points_based_on_ko_order are enabled.

get_use_match_win_cond_first_to

read-only

$catch_match.get_use_match_win_cond_first_to(match_rules: Reference) -> bool

Gets whether or not to use the 'first_to' win condition for determining the match winner.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not the use the match 'first_to' win condition.

get_use_match_win_cond_win_by

read-only

$catch_match.get_use_match_win_cond_win_by(match_rules: Reference) -> bool

Gets whether or not to use the 'win_by' win condition for determining the match winner.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not the use the match 'win_by' win condition.

get_use_player_collectible_hold_limit

read-only

$catch_match.get_use_player_collectible_hold_limit(match_rules: Reference) -> bool

Whether to use the player collectible hold limit.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to use the player collectible hold limit.

get_use_round_win_cond_first_to

read-only

$catch_match.get_use_round_win_cond_first_to(match_rules: Reference) -> bool

Gets whether or not to use the 'first_to' win condition for determining the round winner.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not the use the match 'first_to' win condition.

get_use_round_win_cond_timer_expired

read-only

$catch_match.get_use_round_win_cond_timer_expired(match_rules: Reference) -> bool

Gets whether or not to use timer expiration as condition for determining the end of a round.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not to use timer expiration as condition for determining the end of a round.

get_use_round_win_cond_win_by

read-only

$catch_match.get_use_round_win_cond_win_by(match_rules: Reference) -> bool

Gets whether or not to use the 'win_by' win condition for determining the round winner.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns bool: Whether or not the use the match 'win_by' win condition.

get_wave_respawn_delay

read-only

$catch_match.get_wave_respawn_delay(match_rules: Reference) -> int

Gets the delay between droids respawning in player vs droid

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: Delay between Droids spawning

get_xp_model_type

read-only

$catch_match.get_xp_model_type(match_rules: Reference) -> int

Gets the xp model type for the given match rules reference.

Parameter	Type	Meaning
match_rules	Reference	A match rules reference.

Returns int: The xp model type for the given match rules reference. A value from the vcatch_xp_model_type_t enum.

is_special_practice_training_playlist

read-only

$catch_match.is_special_practice_training_playlist(match_def: Reference) -> bool

Gets if this is a special practice training playlist.

Parameter	Type	Meaning
match_def	Reference	A match definition file.

Returns bool: If the match def is a special practice training playlist

record_recent_loadout

$catch_match.record_recent_loadout(match_def: Reference, user_list: list, loadout_index: int, map_def_index: int, match_rules_index: int, ball_loadout_index: int, music_index: int)

Records the loadout selection for all users.

Parameter	Type	Meaning
match_def	Reference	A match definition file.
user_list	list	A list of user refs that participated in the match.
loadout_index	int	The index of the loadout played in the match.
map_def_index	int	The index of the map_def played in the match.
match_rules_index	int	The index of the match rules used in the match.
ball_loadout_index	int	The index of the ball loadout used in the match.
music_index	int	The index of the music used in the match.

select_match_loadout

$catch_match.select_match_loadout(match_def: Reference, user_list: list, music_name_list: list, force_all_random: bool, is_droids_match: bool, custom_match_map: int, custom_match_ball: int) -> list

Determines loadout selection based on loadouts recently played by all users given. This function is non-deterministic.

Parameter	Type	Meaning
match_def	Reference	A match definition file.
user_list	list	A list of user refs that will participate in the match.
music_name_list	list	A list of the names of the music to select from.
force_all_random	bool	Whether or not to force selection to be completely random.
is_droids_match	bool	Whether the match flow type is droids.
custom_match_map	int	Optional override for map selection in custom matches. Set to -1 if not desired.
custom_match_ball	int	Optional override for ball type in custom matches. Set to -1 if not desired.

Returns list: The chosen loadout's data. The loadout index, the index of the map package, the index of the match rules, the index of the ball loadout, and the index of the music to use, chosen from the supplied music name list.

send_loadout_to_backend

$catch_match.send_loadout_to_backend(match_def: Reference, loadout_index: int, map_index: int, rules_index: int, ball_loadout_index: int)

Forward the loadout to the backend to track game history. Should only be called by game servers.

Parameter	Type	Meaning
match_def	Reference	A match definition file.
loadout_index	int	The match loadout index.
map_index	int	The index of the map.
rules_index	int	The index of the game mode.
ball_loadout_index	int	The index of the ball_loadout.

sort_mvp_values

read-only

$catch_match.sort_mvp_values(mvp_values: list)

Sort a list of MVP values in descending order. Afterwards, the list will have the MVP sorted first. This sorts the list using each element in the sub-lists in decreasing priority order. E.g., the first element decides MVP, but ties there are broken with the second element, and ties there with the third, etc. Not numeric entries are ignored and so can be used as data.

Parameter	Type	Meaning
mvp_values	list	A list-of-lists of the MVP values. This will be sorted in-place.