$catch

Knockout City's own gameplay: players, balls, throws, catches, knockouts.

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

accessories_are_matched_logo_set

read-only

$catch.accessories_are_matched_logo_set(accessory_a: Reference, accessory_b: Reference) -> bool

Given two accessories, check if they belong to the same crew logo set.

Parameter	Type	Meaning
`accessory_a`	`Reference`	The first accessory (vcatch_accessory_t ref) to check.
`accessory_b`	`Reference`	The second accessory (vcatch_accessory_t ref) to check.

Returns bool: True if the accessories belong to the same crew logo set.

append_crew_contract_def_list_to_list

read-only

$catch.append_crew_contract_def_list_to_list(list: list, contract_def_list: Reference) -> list

Append a list of vcatch_crew_contract_def_t* to a list, returning the result.

Parameter	Type	Meaning
`list`	`list`	A list of .crew_contract_def
`contract_def_list`	`Reference`	A vector of vcatch_reward_def_t*.

Returns list: A list of .crew_contract_def.

bot_get_matchmaking_playlist

read-only

$catch.bot_get_matchmaking_playlist(match_defs: list) -> Reference

Get the matchmaking playlist specified for the bot.

Parameter	Type	Meaning
`match_defs`	`list`	All available match defs.

Returns Reference: A matchmaking playlist or NULL on error.

bot_get_username_to_join

read-only

$catch.bot_get_username_to_join() -> string

Specify a username for the bot to join.

Returns string: The specified username that the bot should join.

brawl_pass_get_last_purchase

$catch.brawl_pass_get_last_purchase() -> list

Get the local clients last brawl pass purchase.

Returns list: A list containing the purchase price of premium and the number of levels skipped.

brawl_pass_get_level

$catch.brawl_pass_get_level(user: User, season: int) -> int

Get a user's brawl pass level. Clients can check their own level, servers can check the status of anyone on the server.

Parameter	Type	Meaning
`user`	`User`	The user.
`season`	`int`	The season to lookup.

Returns int: The user's brawl pass level if it matches the current season.

brawl_pass_increase_level

$catch.brawl_pass_increase_level(user: User, season: int, levels_unlocked: int)

Increase a users brawl pass level. Server only.

Parameter	Type	Meaning
`user`	`User`	The user.
`season`	`int`	The season to lookup.
`levels_unlocked`	`int`	The number of levels to increase.

brawl_pass_is_premium

read-only

$catch.brawl_pass_is_premium(user: User, season: int) -> bool

Get whether a user has purchased a premium brawl for the given season. Clients can check their own status, servers can check the status of anyone on the server.

Parameter	Type	Meaning
`user`	`User`	The user.
`season`	`int`	The season to lookup.

Returns bool: True if the user has purchased premium this season

brawl_pass_purchase

$catch.brawl_pass_purchase(user: User, season: int, levels_unlocked: int, price: int, platform_balance: int, purchase_premium: bool)

Increase a users brawl pass level. Server only.

Parameter	Type	Meaning
`user`	`User`	The user.
`season`	`int`	The season to lookup.
`levels_unlocked`	`int`	The number of levels to increase.
`price`	`int`	The price of the offer.
`platform_balance`	`int`	The client's platform currency balance.
`purchase_premium`	`bool`	True if premium should be purchased - if false only level skips are purchased.

brawl_pass_retry_pending_rewards

$catch.brawl_pass_retry_pending_rewards(user: User, season: int)

Retry granting any pending rewards. Server only.

Parameter	Type	Meaning
`user`	`User`	The user.
`season`	`int`	The season to lookup.

calc_take_hit_row_index

read-only

$catch.calc_take_hit_row_index(direction: int, height: int, inclination: int) -> int

Returns a 'row index' for our take-hit system based on a hit's direction, height, and inclination.

Parameter	Type	Meaning
`direction`	`int`	The direction of the hit. [0, 7].
`height`	`int`	The height of the hit. [0..2].
`inclination`	`int`	The inclination of the hit. [0..2].

Returns int: The calculated row index.

catalog_debug_menu

$catch.catalog_debug_menu() -> bool

Create the catalog debug menu.

Returns bool: Whether the window was opened.

charge_level_to_stage

read-only

$catch.charge_level_to_stage(charge: float, overcharge: float) -> int

Gets an enum value that represents which stage the given charge level falls within.

Parameter	Type	Meaning
`charge`	`float`	The amount of normal charge.
`overcharge`	`float`	The amount of over charge.

Returns int: An enum value that represents which stage the given charge level falls within.

clear_contract_numerator

read-only

$catch.clear_contract_numerator(contract_def: Reference, user: User, debug: bool)

Clear the numerator to zero for a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The user who has this contract.
`debug`	`bool`	Whether this is for debug purpose.

customization_debug_menu_begin

$catch.customization_debug_menu_begin() -> bool

Begin the customization debug menu.

Returns bool: Whether the window was opened.

customization_debug_menu_get_inventory_override

read-only

$catch.customization_debug_menu_get_inventory_override() -> bool

Returns the value of the debug setting for Customization to show all catalog items instead of just the inventory.

Returns bool: The value of the override_inventory debug setting.

customization_debug_menu_preset

$catch.customization_debug_menu_preset(preset_names: list, equipped_preset_index: int) -> int

Create a section of the customization debug menu for accessory presets.

Parameter	Type	Meaning
`preset_names`	`list`	The names of the presets.
`equipped_preset_index`	`int`	The index of the equipped preset (or -1 if no preset is equipped).

Returns int: The index of the equipped preset (or -1 if no preset is equipped).

customization_debug_menu_section

$catch.customization_debug_menu_section(accessory_type: int, accessories: list, equipped_accessory: Reference) -> Reference

Create a section of the customization debug menu for a single type of accessory.

Parameter	Type	Meaning
`accessory_type`	`int`	The accessory type.
`accessories`	`list`	The accessories.
`equipped_accessory`	`Reference`	The currently equipped accessory.

Returns Reference: The equipped accessory.

customization_debug_menu_test_accessories

$catch.customization_debug_menu_test_accessories()

Create the UI for selecting customization test accessories.

customization_debug_menu_test_animations

$catch.customization_debug_menu_test_animations(animations: var)

Create the UI for selecting customization test animations.

Parameter	Type	Meaning
`animations`	`var`	The set of available test animations.

customization_debug_menu_test_playlist

$catch.customization_debug_menu_test_playlist(auto_playing: bool, playing_index: int) -> list

Create the UI for selecting and auto playing customization tests.

Parameter	Type	Meaning
`auto_playing`	`bool`	Whether currently auto-playing.
`playing_index`	`int`	The current playlist index.

Returns list: List of results according to vcatch_customization_debug_menu_test_playlist_result_t.

customization_debug_menu_test_push_accessory_list

$catch.customization_debug_menu_test_push_accessory_list(accessory_type: int, accessories: list, catalogs: list, catalog_start_indices: list)

Provide accessory data for the customization test menu.

Parameter	Type	Meaning
`accessory_type`	`int`	The accessory type.
`accessories`	`list`	The accessories.
`catalogs`	`list`	The catalogs associated to this accessory type. Optional for showing source catalog of accessories.
`catalog_start_indices`	`list`	The start indices for each catalog in the list. Optional for showing source catalog of accessories.

debug_set_opponent_is_higher_tier

$catch.debug_set_opponent_is_higher_tier(user: User, is_higher_tier: bool)

Call this function to set if this users has a higher tier opponent

Parameter	Type	Meaning
`user`	`User`	The user who called this debug feature. This users group will not be modified.
`is_higher_tier`	`bool`	If true then this users should qualify for loss forgiveness.

debug_set_quit_penalty_persistence_values

$catch.debug_set_quit_penalty_persistence_values(user: User, quitters_marks: int, last_quit_timestamp: int, match_completion_streak: int)

Debug function to set the persistence values related to quit penalties. Also has the backend update the quit penalty end times and send them back to the clients.

Parameter	Type	Meaning
`user`	`User`	The user to set the quit penalty values for.
`quitters_marks`	`int`	The new quitters_marks persistence value.
`last_quit_timestamp`	`int`	The new last_quit_timestamp persistence value.
`match_completion_streak`	`int`	The new match_completion_streak value.

debug_set_tier

$catch.debug_set_tier(user: User, new_tier: int)

Set the tier of the provided user.

Parameter	Type	Meaning
`user`	`User`	The user who will have their tier modifed.
`new_tier`	`int`	What tier should the user be simulated as being at.

debug_simulate_join_in_progress

$catch.debug_simulate_join_in_progress(user: User)

Simulate that the provided user joined this match while it is was in progress.

Parameter	Type	Meaning
`user`	`User`	The user who will be marked as join in progress.

debug_simulate_teammate_drop

$catch.debug_simulate_teammate_drop(team_id: int, leave_time_ms: int)

Force loss forgiveness when the match end

Parameter	Type	Meaning
`team_id`	`int`	The team ID of the user who left.
`leave_time_ms`	`int`	The debug time the user left in ms.

debug_simulate_teammate_join

$catch.debug_simulate_teammate_join(user: User, join_time_ms: int)

Simulate a teammate joining a match. This will be used to cap off the time in which a user was missing a teammate

Parameter	Type	Meaning
`user`	`User`	The user who called this debug feature. They will have values marked based off how long a teammate was missing
`join_time_ms`	`int`	The debug time use to calculate how long a user did not have a teammate.

drawcall3d_material_eye_colors

$catch.drawcall3d_material_eye_colors(drawcall: Reference, eye_color_set: Reference)

Set eye colors based on a handle to vcatch_eye_color_set_t

Parameter	Type	Meaning
`drawcall`	`Reference`	Reference to the draw call. @see drawcall3d_begin
`eye_color_set`	`Reference`	Handle to a vcatch_eye_color_set_t

drawcall3d_material_hair_colors

$catch.drawcall3d_material_hair_colors(drawcall: Reference, hair_color_set: Reference)

Set hair colors based on a handle to vcatch_hair_color_set_t

Parameter	Type	Meaning
`drawcall`	`Reference`	Reference to the draw call. @see drawcall3d_begin
`hair_color_set`	`Reference`	Handle to a vcatch_hair_color_set_t

drawcall3d_material_makeup_colors

$catch.drawcall3d_material_makeup_colors(drawcall: Reference, makeup_color_set: Reference)

Set eye colors based on a handle to vcatch_makeup_color_set_t

Parameter	Type	Meaning
`drawcall`	`Reference`	Reference to the draw call. @see drawcall3d_begin
`makeup_color_set`	`Reference`	Handle to a vcatch_makeup_color_set_t. If null, will revert to original colors.

drawcall3d_material_skin_colors

$catch.drawcall3d_material_skin_colors(drawcall: Reference, skin_color_set: Reference)

Set skin colors based on a handle to vcatch_skin_color_set_t

Parameter	Type	Meaning
`drawcall`	`Reference`	Reference to the draw call. @see drawcall3d_begin
`skin_color_set`	`Reference`	Handle to a vcatch_skin_color_set_t

expand_take_hit_row_index

$catch.expand_take_hit_row_index(row_index: int) -> list

Given a 'row index', return list of the parts of the take hit.

Parameter	Type	Meaning
`row_index`	`int`	The row index to expand.

Returns list: The components of the take-hit. [direction, height, inclination].

filter_accessories_by_body_type

read-only

$catch.filter_accessories_by_body_type(accessories: list, body_type_accessory: Reference, body_type_substring: string) -> list

Given a list of accessories, return a list containing only accessories associated with a given body type.

Parameter	Type	Meaning
`accessories`	`list`	The list of accessories (vcatch_accessory_t refs).
`body_type_accessory`	`Reference`	The accessory (vcatch_accessory_t ref) of the body type to filter by; alternative to body_type_substring.
`body_type_substring`	`string`	Body type substring to filter by; alternative to body_type_accessory.

Returns list: The filtered list of accessories (vcatch_accessory_t refs).

filter_accessories_for_base_version

read-only

$catch.filter_accessories_for_base_version(accessories: list) -> list

Given a list of accessories, return a list containing only accessories that are base variants.

Parameter	Type	Meaning
`accessories`	`list`	The list of accessories (vcatch_accessory_t refs) to search.

Returns list: A new list of the filtered results.

filter_accessories_for_platform

read-only

$catch.filter_accessories_for_platform(accessories: list) -> list

Given a list of accessories, return a list containing only accessories are allowed on the current platform.

Parameter	Type	Meaning
`accessories`	`list`	The list of accessories (vcatch_accessory_t refs) to search.

Returns list: A new list of the filtered results.

filter_accessories_for_unowned

read-only

$catch.filter_accessories_for_unowned(accessories: list) -> list

Given a list of accessories, return a list containing only accessories that are not owned.

Parameter	Type	Meaning
`accessories`	`list`	The list of accessories (vcatch_accessory_t refs) to search.

Returns list: A new list of the filtered results.

flush_favorites

read-only

$catch.flush_favorites()

Send all the updated durable favorites to the backend

force_ftue_breadcrumb_flow

read-only

$catch.force_ftue_breadcrumb_flow() -> bool

Returns true if we should force the user into the breadcrumb game flow.

Returns bool: If -ftue_breadcrumb_flow enabled

force_ftue_flow

read-only

$catch.force_ftue_flow() -> bool

Returns true if we should force the user into the FTUE game flow.

Returns bool: If -ftue_flow enabled

generate_character_memory_report

$catch.generate_character_memory_report(accessories: list, catalogs: list, all_sizes: list, character_sizes: list, effects_sizes: list, gameplay_sizes: list, csv: string, budget: string)

Generates a character memory usage report and updates the memory budget.

Parameter	Type	Meaning
`accessories`	`list`	List of references to accessories.
`catalogs`	`list`	List of catalog components, one for each accessory.
`all_sizes`	`list`	Total memory used by each accessory in kilobytes.
`character_sizes`	`list`	Character memory used by each accessory in kilobytes.
`effects_sizes`	`list`	Effects memory used by each accessory in kilobytes.
`gameplay_sizes`	`list`	Gameplay memory used by each accessory in kilobytes.
`csv`	`string`	Path of the CSV to write.
`budget`	`string`	Path of the memory budget to update.

get_accessory_brag_type

read-only

$catch.get_accessory_brag_type(accessory: Reference) -> int

Gets the brag type of the form k_player_brag_* of an accessory.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory asset.

Returns int: The accessory type in the form k_accessory_type_*.

get_accessory_content_attached_levels

$catch.get_accessory_content_attached_levels(accessory_content: Reference) -> list

Get the attached levels to spawn for the given accessory content_file

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns list: A list that contains all levels that should be spawned with a given accessory_content

get_accessory_content_cinematic_animation

read-only

$catch.get_accessory_content_cinematic_animation(accessory_content: Reference) -> Reference

Gets cinematic_animation from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The animation.

get_accessory_content_cinematic_extra_levels

read-only

$catch.get_accessory_content_cinematic_extra_levels(accessory_content: Reference) -> list

Gets cinematic_extra_levels from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns list: The list of levels.

get_accessory_content_cinematic_head_anims

read-only

$catch.get_accessory_content_cinematic_head_anims(accessory_content: Reference) -> Reference

Gets cinematic_head_anim_spreadsheet from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The head .anim_spreadsheet..

get_accessory_content_cinematic_preview_start_time

read-only

$catch.get_accessory_content_cinematic_preview_start_time(accessory_content: Reference) -> float

Gets cinematic_preview_start_time from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns float: The cinematic_preview_start_time value.

get_accessory_content_cinematic_socket_level

read-only

$catch.get_accessory_content_cinematic_socket_level(accessory_content: Reference) -> Reference

Gets cinematic_ball_socket_level from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The level.

get_accessory_content_crew_logo_spin_rate

$catch.get_accessory_content_crew_logo_spin_rate(accessory_content: Reference) -> float

Gets crew logo texture spin rate from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns float: The spin rate in from accessory file. In degrees per second.

get_accessory_content_crew_logo_texture

$catch.get_accessory_content_crew_logo_texture(accessory_content: Reference) -> Reference

Gets crew logo texture from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns Reference: A reference that contains crew logo texture

get_accessory_content_crew_nameplate_data

$catch.get_accessory_content_crew_nameplate_data(accessory_content: Reference) -> list

Gets crew nameplate data from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns list: A list that contains texture_a, color_a, texture_b, color_b, texture_c, color_c, and animation sprite level

get_accessory_content_crew_vehicle_type

read-only

$catch.get_accessory_content_crew_vehicle_type(accessory_content: Reference) -> int

Gets crew_vehicle_type from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns int: The crew vehicle type.

get_accessory_content_description

$catch.get_accessory_content_description(accessory_content: Reference) -> string

Get the description for the given accessory content_file

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns string: The description for the given accessory_content

get_accessory_content_disable_gloves

read-only

$catch.get_accessory_content_disable_gloves(accessory_content: Reference) -> bool

Get whether to hide gloves if any among outfit, head, hair, and gloves have this on.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns bool: Whether the gloves should be disabled.

get_accessory_content_disable_hair

read-only

$catch.get_accessory_content_disable_hair(accessory_content: Reference) -> bool

Get whether to hide hair if any among outfit, head, hair, and gloves have this on.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns bool: Whether the hair should be disabled.

get_accessory_content_disable_head

read-only

$catch.get_accessory_content_disable_head(accessory_content: Reference) -> bool

Get whether to hide head if any among outfit, head, hair, and gloves have this on.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns bool: Whether the head should be disabled.

get_accessory_content_eye_color_set

read-only

$catch.get_accessory_content_eye_color_set(accessory_content: Reference) -> Reference

Gets the eye_color_set from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The eye_color_set

get_accessory_content_force_enable_eye_color

read-only

$catch.get_accessory_content_force_enable_eye_color(accessory_content: Reference) -> bool

Get whether the eye color will be used even if the customization piece is not a head piece.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns bool: If true, eye color will be used even if the customization piece is not a head piece.

get_accessory_content_force_enable_hair_color

read-only

$catch.get_accessory_content_force_enable_hair_color(accessory_content: Reference) -> bool

Get whether the hair color will be used even if the customization piece is not a hair or head piece.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns bool: If true, hair color will be used even if the customization piece is not a hair or head piece.

get_accessory_content_force_enable_makeup_color

read-only

$catch.get_accessory_content_force_enable_makeup_color(accessory_content: Reference) -> bool

Get whether the makeup color will be used even if the customization piece is not a hair or head piece.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns bool: If true, makeup color will be used even if the customization piece is not a hair or head piece.

get_accessory_content_hair_color_set

read-only

$catch.get_accessory_content_hair_color_set(accessory_content: Reference) -> Reference

Gets the hair_color_set from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The hair_color_set

get_accessory_content_head_class

read-only

$catch.get_accessory_content_head_class(accessory_content: Reference) -> int

Gets the head class integer from the given accessory content file.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns int: Head Class

get_accessory_content_makeup_color_set

read-only

$catch.get_accessory_content_makeup_color_set(accessory_content: Reference) -> Reference

Gets the makeup_color_set from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The makeup_color_set

get_accessory_content_model_no_makeup

read-only

$catch.get_accessory_content_model_no_makeup(accessory_content: Reference) -> Reference

Gets the no-makeup version of model from an accessory_content. This is used when using 'nomakeup' makeup color for head model

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The model

get_accessory_content_physics_bones

$catch.get_accessory_content_physics_bones(accessory_content: Reference, movement_mode: int, velocity: vec3, cinematic_accessory: Reference) -> Reference

Gets the physics bones from the given accessory content file.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.
`movement_mode`	`int`	The movement mode override physics bones to return (Will return default is override doesn't exist).
`velocity`	`vec3`	Velocity of the player.
`cinematic_accessory`	`Reference`	The accessory file for the cinematic currently playing (Will be null if no cinematic is playing).

Returns Reference: Physics Bones set

get_accessory_content_player_brag_default_frame

read-only

$catch.get_accessory_content_player_brag_default_frame(accessory_content: Reference) -> Reference

Gets player default frame file from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The player brag default frame.

get_accessory_content_player_brag_defs

read-only

$catch.get_accessory_content_player_brag_defs(accessory_content: Reference) -> list

Gets the list of player brag def files from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns list: The list of player brag defs.

get_accessory_content_player_brag_display_text

read-only

$catch.get_accessory_content_player_brag_display_text(accessory_content: Reference) -> string

Gets display text from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns string: The in-cinematic text.

get_accessory_content_player_brag_mvp_frame

read-only

$catch.get_accessory_content_player_brag_mvp_frame(accessory_content: Reference) -> Reference

Gets player mvp frame file from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The player brag mvp frame.

get_accessory_content_sfx_switch

$catch.get_accessory_content_sfx_switch(accessory_content: Reference) -> Reference

Gets the sfx switch from the given accessory content file.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns Reference: SFX switch

get_accessory_content_skin_color_set

read-only

$catch.get_accessory_content_skin_color_set(accessory_content: Reference) -> Reference

Gets the skin_color_set from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The skin_color_set

get_accessory_content_taunt_emote

read-only

$catch.get_accessory_content_taunt_emote(accessory_content: Reference) -> Reference

Gets taunt_animation from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The vcatch_emote_def ref.

get_accessory_content_text_to_speech_voice_index

$catch.get_accessory_content_text_to_speech_voice_index(accessory_content: Reference) -> int

Gets the text to speech voice index associated with a voice accessory.

Parameter	Type	Meaning
`accessory_content`	`Reference`	An accessory content file.

Returns int: The voice index.

get_accessory_content_ui_rotation_offset

read-only

$catch.get_accessory_content_ui_rotation_offset(accessory_content: Reference) -> vec3

Gets the ui rotation offset for the given accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns vec3: The rotation

get_accessory_content_ult_throw_hologram_fx_level

read-only

$catch.get_accessory_content_ult_throw_hologram_fx_level(accessory_content: Reference) -> Reference

Gets ult_throw_hologram_fx_level from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The level.

get_accessory_content_ult_throw_hologram_special_explosion_fx_level

read-only

$catch.get_accessory_content_ult_throw_hologram_special_explosion_fx_level(accessory_content: Reference) -> Reference

Gets ult_throw_hologram_explosion_fx_level from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The level.

get_accessory_content_ult_thrown_hologram_orientation_type

read-only

$catch.get_accessory_content_ult_thrown_hologram_orientation_type(accessory_content: Reference) -> int

Gets ult_thrown_orientation_type from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns int: The orientation behavior type.

get_accessory_content_vehicle_override_anim_spreadsheet

read-only

$catch.get_accessory_content_vehicle_override_anim_spreadsheet(accessory_content: Reference) -> Reference

Gets vehicle override anim spreadsheet from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The anim spreadsheet.

get_accessory_content_wwise_sound_event

read-only

$catch.get_accessory_content_wwise_sound_event(accessory_content: Reference) -> Reference

Gets wwise sound event from an accessory_content.

Parameter	Type	Meaning
`accessory_content`	`Reference`	The accessory_content asset.

Returns Reference: The wwise sound event.

get_accessory_disallow_variations

read-only

$catch.get_accessory_disallow_variations(accessory: Reference) -> bool

Gets the value of disallow_variations from an accessory, which indicates that this accessory doesn't support things like colors, makeup or styles.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory asset.

Returns bool: If this accessory disallows variations. Returns false on error.

get_accessory_extra_text

read-only

$catch.get_accessory_extra_text(accessory: Reference) -> string

Gets the extra_text of the specified accessory.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory asset.

Returns string: The localized extra_text for the accessory; otherwise NULL in the event of an error.

get_accessory_for_body_type

read-only

$catch.get_accessory_for_body_type(accessory: Reference, body_type_accessory: Reference, body_type_substring: string, accessories: list, look_up_from_inventory: bool) -> Reference

Given an accessory, find another version of that accessory associated with a given body type.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory (vcatch_accessory_t ref) a version of which to find.
`body_type_accessory`	`Reference`	The accessory (vcatch_accessory_t ref) of the desired body type; alternative to body_type_substring.
`body_type_substring`	`string`	Body type substring of desired body type; alternative to body_type_accessory.
`accessories`	`list`	The list of accessories (vcatch_accessory_t refs) in which to search.
`look_up_from_inventory`	`bool`	If the given accessories list is empty, try to look it up from inventory.

Returns Reference: The accessory (vcatch_accessory_t ref) associated with the given body type.

get_accessory_for_platform

read-only

$catch.get_accessory_for_platform(accessory: Reference) -> Reference

Return an equivalent accessory for the current platform or the same accessory if it is platform agnostic (platform_restriction is k_platform_family_invalid).

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory (vcatch_accessory_t refs).

Returns Reference: The version of accessory (vcatch_accessory_t ref) for the current platform.

get_accessory_in_catalog_manager

read-only

$catch.get_accessory_in_catalog_manager(index: int, accessory_type: int, runtime_list: list) -> Reference

Gets an accessory in the catalog manager's runtime data list.

Parameter	Type	Meaning
`index`	`int`	The index inside the runtime data's accessory list
`accessory_type`	`int`	the accessory type
`runtime_list`	`list`	Reference to the catalog manager's runtime data list

Returns Reference: The matched accessory in the catalog manager's runtime data list

get_accessory_in_initial_inventory

read-only

$catch.get_accessory_in_initial_inventory(accessory: Reference) -> bool

Gets in_initial_inventory from an accessory.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory asset.

Returns bool: The value of in_initial_inventory.

get_accessory_index_base_version

read-only

$catch.get_accessory_index_base_version(accessory: Reference, list: list) -> int

Given a list of accessories, return the index of an accessory in that list ignoring variants.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory (vcatch_accessory_t ref) to check. Should not be a variant.
`list`	`list`	The list of accessories (vcatch_accessory_t refs) to search.

Returns int: Index of the accessory or -1 if not found.

get_accessory_index_in_catalog_manager

read-only

$catch.get_accessory_index_in_catalog_manager(accessory: Reference, runtime_list: list) -> int

Gets the accessory's index in the catalog manager's runtime data list.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory asset.
`runtime_list`	`list`	Reference to the catalog manager's runtime data list

Returns int: The index of the accessory in the catalog manager's runtime data list

get_accessory_is_variant

read-only

$catch.get_accessory_is_variant(accessory: Reference) -> bool

Given an accessory, returns true if it's a variant.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory (vcatch_accessory_t ref) to check.

Returns bool: True if the accessory passed in is a variant.

get_accessory_name

read-only

$catch.get_accessory_name(accessory: Reference) -> string

Gets the name of the specified accessory.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory asset.

Returns string: The localized display name for the accessory; otherwise NULL in the event of an error.

get_accessory_rarity

read-only

$catch.get_accessory_rarity(accessory: Reference) -> int

Gets the rarity of an accessory.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory asset.

Returns int: The rarity (vcatch_rarity_t enum). Returns k_rarity_none on error.

get_accessory_small_extra_icon_package

read-only

$catch.get_accessory_small_extra_icon_package(accessory: Reference) -> Reference

Gets the small extra icon package from an accessory.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory asset.

Returns Reference: The package

get_accessory_small_icon_package

read-only

$catch.get_accessory_small_icon_package(accessory: Reference) -> Reference

Gets the small icon package from an accessory.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory asset.

Returns Reference: The package

get_accessory_type

read-only

$catch.get_accessory_type(accessory: Reference) -> int

Gets the accessory type of the form k_accessory_type_* of an accessory.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory asset.

Returns int: The accessory type in the form k_accessory_type_*.

get_accessory_type_str

read-only

$catch.get_accessory_type_str(accessory: Reference) -> string

Gets the accessory type as a string with the prefix 'k_accessory_type_' omitted.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory asset.

Returns string: The accessory type with the prefix 'k_accessory_type_' omitted.

get_achievement_in_custom_match

read-only

$catch.get_achievement_in_custom_match(contract_def: Reference) -> bool

Get whether to update this achievement in a custom match.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns bool: Whether to update this achievement in the hideout.

get_achievement_in_hideout

read-only

$catch.get_achievement_in_hideout(contract_def: Reference) -> bool

Get whether to update this achievement in the hideout.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns bool: Whether to update this achievement in the hideout.

get_achievement_in_quickplay_match

read-only

$catch.get_achievement_in_quickplay_match(contract_def: Reference) -> bool

Get whether to update this achievement in a quickplay match.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns bool: Whether to update this achievement in the hideout.

get_achievement_in_ranked_match

read-only

$catch.get_achievement_in_ranked_match(contract_def: Reference) -> bool

Get whether to update this achievement in a ranked match.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns bool: Whether to update this achievement in the hideout.

get_achievement_in_tutorial

read-only

$catch.get_achievement_in_tutorial(contract_def: Reference) -> bool

Get whether to update this achievement in a tutorial.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns bool: Whether to update this achievement in the hideout.

get_achievement_list_achievement_id

read-only

$catch.get_achievement_list_achievement_id(achievement_list: Reference, index: int) -> int

Get the id passed to net.grant_achievement for the achievment to grant for a specific .contract_def from an .achievement_list.

Parameter	Type	Meaning
`achievement_list`	`Reference`	A reference to the .achievement_list file.
`index`	`int`	The index of the .contract_def for which to get the id.

Returns int: The achievment id.

get_achievement_list_achievement_token

read-only

$catch.get_achievement_list_achievement_token(achievement_list: Reference) -> string

Get the token passed to net.grant_achievement.

Parameter	Type	Meaning
`achievement_list`	`Reference`	A reference to the .achievement_list file.

Returns string: The achievement token.

get_achievement_list_contract_def

read-only

$catch.get_achievement_list_contract_def(achievement_list: Reference, index: int) -> Reference

Get a specific .contract_def from an .achievement_list.

Parameter	Type	Meaning
`achievement_list`	`Reference`	A reference to the .achievement_list file.
`index`	`int`	The index of the .contract_def to return.

Returns Reference: The .contract_def.

get_achievement_list_count

read-only

$catch.get_achievement_list_count(achievement_list: Reference) -> int

Get the number of contracts in an .achievement_list.

Parameter	Type	Meaning
`achievement_list`	`Reference`	A reference to the .achievement_list file.

Returns int: The number of contracts.

get_block_party_owned

read-only

$catch.get_block_party_owned() -> bool

Get the ownership status of block party content.

Returns bool: True if the block party content is owned.

get_breadcrumb_step_description

$catch.get_breadcrumb_step_description(breadcrumb_step: int) -> string

Gets the description associated with a given breadcrumb step.

Parameter	Type	Meaning
`breadcrumb_step`	`int`	The given breadcrumb Step

Returns string: The description associated with a breadcrumb step

get_client_authoritative_camera_yaw_pitch

read-only

$catch.get_client_authoritative_camera_yaw_pitch(user: User) -> vec2

Get the camera yaw/pitch values of a remote user on the server.

Parameter	Type	Meaning
`user`	`User`	The user.

Returns vec2: <yaw, pitch>

get_client_authoritative_player_yaw

read-only

$catch.get_client_authoritative_player_yaw(user: User) -> float

Get the player yaw value of a remote user on the server.

Parameter	Type	Meaning
`user`	`User`	The user.

Returns float: The yaw value.

get_client_token_expiration_ms

read-only

$catch.get_client_token_expiration_ms() -> int

Get the client_token_expiration_ms backend tunable value.

Returns int: The client_token_expiration_ms value (how long the client has to connect to a server).

get_contract_all_initial_numerators_in_between

read-only

$catch.get_contract_all_initial_numerators_in_between(contract_def: Reference, starting_numerator: int, ending_numerator: int) -> list

Get all initial numerators from a .contract_def reference in between starting numerator and ending numerator. Always include starting numerator if succeeded. Non-multi-denominator contracts will only have one element at most. E.g. For contract with [10, 100, 1000] multi-denominator, input (5, 500) will return [5, 10, 100].

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`starting_numerator`	`int`	The starting numerator.
`ending_numerator`	`int`	The ending numerator.

Returns list: Initial numerators list.

get_contract_category_viewed_key_string

read-only

$catch.get_contract_category_viewed_key_string(main_category: int, sub_category: int) -> string

Get a string for contract main category and subcategory.

Parameter	Type	Meaning
`main_category`	`int`	The main category.
`sub_category`	`int`	The sub category.

Returns string: A string for the contract category.

get_contract_completion_criteria

read-only

$catch.get_contract_completion_criteria(crew_guid: string, crew_contract: Reference) -> int

Get a crew contract's registered completion criteria.

Parameter	Type	Meaning
`crew_guid`	`string`	The crew to lookup progress for.
`crew_contract`	`Reference`	The crew contract to lookup progress for.

Returns int: The completion criteria for when the backend registers a contract is completed.

get_contract_denominator

read-only

$catch.get_contract_denominator(contract_def: Reference, user: User, use_staged_numerator: bool, staged_numerator: int, get_max: bool) -> int

Get the denominator from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The owner of the contract.
`use_staged_numerator`	`bool`	Do we use the segment before what we'd normally use based on the current numerator?
`staged_numerator`	`int`	Will be ignored if use_staged_numerator is false. The staged delta numerator for calculating previous segment.
`get_max`	`bool`	Do we want the maximum denominator for clamping purposes? Has no effect except on multi-denominator contracts.

Returns int: The denominator.

get_contract_description

read-only

$catch.get_contract_description(contract_def: Reference) -> string

Get the name from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns string: The description.

get_contract_description_keymap_aliases_string

read-only

$catch.get_contract_description_keymap_aliases_string(contract_def: Reference) -> list

Get the list of keymap aliases to show glyph as string args for description. The first empty element will be filled by contract denominator.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns list: A list of keymap aliases to get glyphs for in the order they appear in contract description. The first empty element will be filled by contract denominator.

get_contract_icon

read-only

$catch.get_contract_icon(contract_def: Reference, user: User, use_staged_numerator: bool, staged_numerator: int) -> Reference

Get the name from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The owner of the contract.
`use_staged_numerator`	`bool`	Do we use the segment before what we'd normally use based on the current numerator?
`staged_numerator`	`int`	Will be ignored if use_staged_numerator is false. The staged delta numerator for calculating previous segment.

Returns Reference: The icon.

get_contract_implementation_level

read-only

$catch.get_contract_implementation_level(contract_def: Reference) -> Reference

Get the implementation level from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns Reference: The implementation level.

get_contract_in_last_denominator_segment

read-only

$catch.get_contract_in_last_denominator_segment(contract_def: Reference, user: User) -> bool

Is this contract's numerator in the last denominator segment? Used for multi denominator contracts. If this return true, the contract can be officially fulfilled.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The owner of the contract.

Returns bool: Whether this contract is in its last denominator segment.

get_contract_is_premium

read-only

$catch.get_contract_is_premium(contract_def: Reference) -> bool

Get whether the contract is only available to premium brawl pass users.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns bool: Whether this contract is for premium users only.

get_contract_lifetime

read-only

$catch.get_contract_lifetime(crew_guid: string, crew_contract: Reference) -> int

Get a crew contract's registered lifetime.

Parameter	Type	Meaning
`crew_guid`	`string`	The crew to lookup progress for.
`crew_contract`	`Reference`	The crew contract to lookup progress for.

Returns int: The lifetime registered with the backend for a crew contract in seconds.

get_contract_list_contract_def

read-only

$catch.get_contract_list_contract_def(contract_list: Reference, index: int) -> Reference

Get a specific .contract_def from a .contract_list.

Parameter	Type	Meaning
`contract_list`	`Reference`	A reference to the .contract_list file.
`index`	`int`	The index of the .contract_def to return.

Returns Reference: The .contract_def.

get_contract_list_count

read-only

$catch.get_contract_list_count(contract_list: Reference) -> int

Get the number of contracts in a .contract_list.

Parameter	Type	Meaning
`contract_list`	`Reference`	A reference to the .contract_list file.

Returns int: The number of contracts.

get_contract_main_category

read-only

$catch.get_contract_main_category(contract_def: Reference) -> int

Get the main category from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns int: The main category.

get_contract_name

read-only

$catch.get_contract_name(contract_def: Reference) -> string

Get the name from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns string: The name.

get_contract_numerator

read-only

$catch.get_contract_numerator(contract_def: Reference, user: User) -> int

Get the numerator from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The user who has this contract.

Returns int: The numerator.

get_contract_previous_denominator

read-only

$catch.get_contract_previous_denominator(contract_def: Reference, user: User, use_staged_numerator: bool, staged_numerator: int, get_max: bool) -> int

Get the previous denominator from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The owner of the contract.
`use_staged_numerator`	`bool`	Do we use the segment before what we'd normally use based on the current numerator?
`staged_numerator`	`int`	Will be ignored if use_staged_numerator is false. The staged delta numerator for calculating previous segment.
`get_max`	`bool`	Do we want the maximum denominator for clamping purposes? Has no effect except on multi-denominator contracts.

Returns int: The previous denominator.

get_contract_progress

read-only

$catch.get_contract_progress(crew_guid: string, crew_contract: Reference, ignore_staged: bool) -> int

Get a crew's collective progress towards a given contract. This will include any progress queued for update by this game server as well.

Parameter	Type	Meaning
`crew_guid`	`string`	The crew to lookup progress for.
`crew_contract`	`Reference`	The crew contract to lookup progress for.
`ignore_staged`	`bool`	If true, this function ignores any progress updates staged but not yet submitted to the backend.

Returns int: The progress completed by the crew (including queued progress).

get_contract_rewards

read-only

$catch.get_contract_rewards(contract_def: Reference, user: User, use_staged_numerator: bool, staged_numerator: int, out_segment_reward_count_list: list, begin_segment_only: bool) -> list

Get the list of rewards from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The user who has this contract.
`use_staged_numerator`	`bool`	Do we use the segment before what we'd normally use based on the current numerator?
`staged_numerator`	`int`	Will be ignored if use_staged_numerator is false. The staged delta numerator for calculating previous segment.
`out_segment_reward_count_list`	`list`	A list of rewards count at each rewarded segment. The length of the list is the number of rewarded segments, and the value is the number of rewards at each segment.
`begin_segment_only`	`bool`	Whether we only want to get rewards for the begin segment.

Returns list: A list of rewards.

get_contract_spawn_always

read-only

$catch.get_contract_spawn_always(contract_def: Reference) -> bool

Get whether to update this contract in all match flows.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns bool: Whether to update this contract in all match_flows.

get_contract_start_time

read-only

$catch.get_contract_start_time(crew_guid: string, crew_contract: Reference) -> int

Get a crew contract's registered start time.

Parameter	Type	Meaning
`crew_guid`	`string`	The crew to lookup progress for.
`crew_contract`	`Reference`	The crew contract to lookup progress for.

Returns int: The start time registered with the backend for a crew contract in seconds.

get_contract_state

read-only

$catch.get_contract_state(contract_def: Reference, user: User) -> int

Get the state from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The user who has this contract.

Returns int: The state.

get_contract_sub_category

read-only

$catch.get_contract_sub_category(contract_def: Reference) -> int

Get the sub category from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.

Returns int: The sub category.

get_contract_token

read-only

$catch.get_contract_token(contract_def: Reference, user: User) -> string

Get the token from a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The owner of the contract. Optional unless you want to have a platform appropriate token for achievements/trophies.

Returns string: The token.

get_crew_contract_crew_guid_temp

$catch.get_crew_contract_crew_guid_temp(contract_def: Reference) -> string

Get the GUID of the crew associated with the given contract guid.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .crew_contract_def reference.

Returns string: A temporary string with the GUID.

get_crew_contract_group_condition

read-only

$catch.get_crew_contract_group_condition(crew_contract_def: Reference) -> int

Get the group condition from a .crew_contract_def reference.

Parameter	Type	Meaning
`crew_contract_def`	`Reference`	A .crew_contract_def reference.

Returns int: The group condition.

get_crew_contract_guid_temp

$catch.get_crew_contract_guid_temp(contract_def: Reference) -> string

Get the GUID of a .crew_contract_def reference as a string using temporary string storage.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .crew_contract_def reference.

Returns string: A temporary string with the GUID.

get_crew_contract_is_season_long

read-only

$catch.get_crew_contract_is_season_long(crew_contract_def: Reference) -> bool

If the contract should last the whole season.

Parameter	Type	Meaning
`crew_contract_def`	`Reference`	A .crew_contract_def reference.

Returns bool: If crew contract is season long.

get_crew_contract_list_contract_def

read-only

$catch.get_crew_contract_list_contract_def(contract_list: Reference, index: int) -> Reference

Get a specific .crew_contract_def from a .crew_contract_list.

Parameter	Type	Meaning
`contract_list`	`Reference`	A reference to the .crew_contract_list file.
`index`	`int`	The index of the .crew_contract_def to return.

Returns Reference: The .crew_contract_def.

get_crew_contract_list_count

read-only

$catch.get_crew_contract_list_count(contract_list: Reference) -> int

Get the number of crew contracts in a .crew_contract_list.

Parameter	Type	Meaning
`contract_list`	`Reference`	A reference to the .crew_contract_list file.

Returns int: The number of crew contracts.

get_crew_contract_option_contract_list

read-only

$catch.get_crew_contract_option_contract_list(crew_contract_def: Reference) -> Reference

Get the list of crew contracts in a .crew_contract_def.

Parameter	Type	Meaning
`crew_contract_def`	`Reference`	A .crew_contract_def reference.

Returns Reference: The list of contracts crew contract def.

get_crew_contract_reward_state

read-only

$catch.get_crew_contract_reward_state(crew_contract_def: Reference, user: User) -> int

Get the crew contract state for the given user. Game server can see state of everyone on their server, users can only see their own state.

Parameter	Type	Meaning
`crew_contract_def`	`Reference`	A .crew_contract_def reference.
`user`	`User`	The user to check the contract state for.

Returns int: The crew contract state.

get_crew_contract_rewards

read-only

$catch.get_crew_contract_rewards(crew_contract_def: Reference) -> list

Get the list of rewards from a .crew_contract_def reference.

Parameter	Type	Meaning
`crew_contract_def`	`Reference`	A .crew_contract_def reference.

Returns list: A list of rewards.

get_crew_contract_rfc_guid_temp

$catch.get_crew_contract_rfc_guid_temp(contract_def: Reference) -> string

Get the RFC formatted GUID of a .crew_contract_def reference as a string using temporary string storage.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .crew_contract_def reference.

Returns string: A temporary string with the GUID.

get_crew_contract_show_completed_progress_from_0

read-only

$catch.get_crew_contract_show_completed_progress_from_0(crew_contract_def: Reference) -> bool

If the contract should show its progress starting from 0 in the reward UI.

Parameter	Type	Meaning
`crew_contract_def`	`Reference`	A .crew_contract_def reference.

Returns bool: Show completed progress from 0.

get_crew_contract_spawn_always

read-only

$catch.get_crew_contract_spawn_always(crew_contract_def: Reference) -> bool

If the implementation level should always be spawned for a .crew_contract_def reference.

Parameter	Type	Meaning
`crew_contract_def`	`Reference`	A .crew_contract_def reference.

Returns bool: Spawn always.

get_crew_contracts

read-only

$catch.get_crew_contracts(crew_guid: string) -> list

Get a list of crew contracts the game server is aware of, given the specific crew. If an active contract is not in this list, that suggests the crew has not yet made progress towards it.

Parameter	Type	Meaning
`crew_guid`	`string`	The crew to update the contract for.

Returns list: A list of crew_contract definitions

get_crew_contracts_by_time

read-only

$catch.get_crew_contracts_by_time(crew_guid: string, time: int) -> list

Get a list of crew contracts the game server is aware of, that were/are active for the given time. If an active contract is not in this list, that suggests the crew has not yet made progress towards it.

Parameter	Type	Meaning
`crew_guid`	`string`	The crew to update the contract for.
`time`	`int`	The utc time (in seconds) to find contracts for.

Returns list: A list of crew_contract definitions

get_deluxe_edition_owned

read-only

$catch.get_deluxe_edition_owned() -> bool

Get the ownership status of the deluxe edition content.

Returns bool: True if the deluxe edition content is owned.

get_emote_alive_duration

read-only

$catch.get_emote_alive_duration(emote_def: Reference) -> float

Gets the amount of time the emote UI will be visible when the emote is triggered.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns float: The amount of time the emote UI will be visible when the emote is triggered.

get_emote_all_trigger_cooldown

read-only

$catch.get_emote_all_trigger_cooldown(emote_def: Reference) -> float

Gets the amount of time where any emote cannot be triggered after an emote is triggered.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns float: The amount of time where any emote cannot be triggered after an emote is triggered.

get_emote_animation

read-only

$catch.get_emote_animation(emote_def: Reference) -> Reference

Gets the emote animation or null if the emote does not have an animation.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns Reference: The animation.

get_emote_animation_ball

read-only

$catch.get_emote_animation_ball(emote_def: Reference) -> Reference

Gets the emote animation to use when a ball is held. This is emote_def.animation_ball or, if null, emote_def.animation.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns Reference: The animation.

get_emote_balloon_sprite_use_team_color

read-only

$catch.get_emote_balloon_sprite_use_team_color(emote_def: Reference) -> bool

Gets whether or not the emote balloon sprite should be team colored

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns bool: Whether or not the emote balloon sprite should use the team color.

get_emote_category

read-only

$catch.get_emote_category(emote_def: Reference) -> int

Gets the category of an emote.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns int: The category of the emote.

get_emote_companion_cooldown

read-only

$catch.get_emote_companion_cooldown(emote_def: Reference) -> float

Gets the amount of time where a companion emote, as defined by script, cannot be re-triggered after this triggered.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns float: The amount of time where a companion emote, as defined by script, cannot be re-triggered after this triggered.

get_emote_head_animation_spreadsheet

read-only

$catch.get_emote_head_animation_spreadsheet(spreadsheet: Reference) -> Reference

Gets the facial animation spreadsheet for emote

Parameter	Type	Meaning
`spreadsheet`	`Reference`	The emote .anim_spreadsheet..

Returns Reference: The head .anim_spreadsheet..

get_emote_input_use_intensity

read-only

$catch.get_emote_input_use_intensity(emote_def: Reference) -> int

Gets whether or not the emote input handling allows different intensity levels.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns int: Whether or not the emote input handling allows different intensity levels.

get_emote_input_use_sustain

read-only

$catch.get_emote_input_use_sustain(emote_def: Reference) -> int

Gets whether or not the emote input handling allows the emote to be sustained.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns int: Whether or not the emote input handling allows the emote to be sustained.

get_emote_intensity_max_level

read-only

$catch.get_emote_intensity_max_level(emote_def: Reference) -> int

Gets the maximum intensity level for this emote.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns int: The maximum intensity level for this emote.

get_emote_level

read-only

$catch.get_emote_level(emote_def: Reference) -> Reference

Gets the level to spawn with the emote, or null if there is no such level.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns Reference: The level.

get_emote_message_sprite_use_team_color

read-only

$catch.get_emote_message_sprite_use_team_color(emote_def: Reference) -> bool

Gets whether or not the emote message sprite should be team colored

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns bool: Whether or not the emote message sprite should use the team color.

get_emote_retrigger_cooldown

read-only

$catch.get_emote_retrigger_cooldown(emote_def: Reference) -> float

Gets the amount of time where an emote cannot be re-triggered after being triggered.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns float: The amount of time where an emote cannot be re-triggered after being triggered.

get_emote_sfx_intensity_name

read-only

$catch.get_emote_sfx_intensity_name(emote_def: Reference) -> string

Gets the name of the component that contains the intensity sound_event reference.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns string: The name of the component that contains a reference to the intensity sound event.

get_emote_sfx_oneshot_name

read-only

$catch.get_emote_sfx_oneshot_name(emote_def: Reference) -> string

Gets the name of the component that contains the one shot sound_event reference.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns string: The name of the component that contains a reference to the one shot sound event.

get_emote_sfx_sustain_intensity_press_name

read-only

$catch.get_emote_sfx_sustain_intensity_press_name(emote_def: Reference) -> string

Gets the name of the component that contains the sustain+intensity press sound_event reference.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns string: The name of the component that contains a reference to the sustain+intensity press sound event.

get_emote_sfx_sustain_intensity_release_name

read-only

$catch.get_emote_sfx_sustain_intensity_release_name(emote_def: Reference) -> string

Gets the name of the component that contains the sustain+intensity release sound_event reference.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns string: The name of the component that contains a reference to the sustain+intensity release sound event.

get_emote_sfx_sustain_press_name

read-only

$catch.get_emote_sfx_sustain_press_name(emote_def: Reference) -> string

Gets the name of the component that contains the sustain press sound_event reference.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns string: The name of the component that contains a reference to the sustain press sound event.

get_emote_sfx_sustain_release_name

read-only

$catch.get_emote_sfx_sustain_release_name(emote_def: Reference) -> string

Gets the name of the component that contains the sustain release sound_event reference.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns string: The name of the component that contains a reference to the sustain_release sound event.

get_emote_sfx_taunt_switch

read-only

$catch.get_emote_sfx_taunt_switch(emote_def: Reference) -> Reference

Gets the sound switch reference of the sfx_taunt_vo switch group associated with this emote.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns Reference: The sound switch ref.

get_emote_sound_retrigger_cooldown

read-only

$catch.get_emote_sound_retrigger_cooldown(emote_def: Reference) -> float

Gets the amount of time where a sound will not be triggered when the same emote is re-triggered.

Parameter	Type	Meaning
`emote_def`	`Reference`	An emote definition file.

Returns float: The amount of time where a sound will not be triggered when an emote is re-triggered.

get_energy_drink_def_base_xp_source_type

read-only

$catch.get_energy_drink_def_base_xp_source_type(energy_drink_def: Reference) -> int

Get base_xp_source_type from an energy_drink_def.

Parameter	Type	Meaning
`energy_drink_def`	`Reference`	A .energy_drink_def reference.

Returns int: The base_xp_source_type value.

get_energy_drink_def_default_base_xp

read-only

$catch.get_energy_drink_def_default_base_xp(energy_drink_def: Reference) -> int

Get default_base_xp from an energy_drink_def.

Parameter	Type	Meaning
`energy_drink_def`	`Reference`	A .energy_drink_def reference.

Returns int: The default_base_xp value.

get_energy_drink_def_description

read-only

$catch.get_energy_drink_def_description(energy_drink_def: Reference) -> string

Get descriptionfrom an energy_drink_def.

Parameter	Type	Meaning
`energy_drink_def`	`Reference`	A .energy_drink_def reference.

Returns string: The localized description string.

get_energy_drink_def_duration_hours

read-only

$catch.get_energy_drink_def_duration_hours(energy_drink_def: Reference) -> float

Get duration_hours from an energy_drink_def.

Parameter	Type	Meaning
`energy_drink_def`	`Reference`	A .energy_drink_def reference.

Returns float: The duration_hours value.

get_energy_drink_def_implementation_level

read-only

$catch.get_energy_drink_def_implementation_level(energy_drink_def: Reference) -> Reference

Get implementation_level from an energy_drink_def.

Parameter	Type	Meaning
`energy_drink_def`	`Reference`	A .energy_drink_def reference.

Returns Reference: The implementation_level value.

get_energy_drink_def_multiplier_value

read-only

$catch.get_energy_drink_def_multiplier_value(energy_drink_def: Reference) -> float

Get multiplier_value from an energy_drink_def.

Parameter	Type	Meaning
`energy_drink_def`	`Reference`	A .energy_drink_def reference.

Returns float: The multiplier_value value.

get_energy_drink_def_pack_icon

read-only

$catch.get_energy_drink_def_pack_icon(energy_drink_def: Reference, item_quantity: int, is_small_icon: bool) -> Reference

Get the corresponding pack icon from an energy_drink_def.

Parameter	Type	Meaning
`energy_drink_def`	`Reference`	A .energy_drink_def reference.
`item_quantity`	`int`	Item quantity in the pack.
`is_small_icon`	`bool`	Whether returning the small icon

Returns Reference: The pack icon.

get_favorited_durables_by_type

read-only

$catch.get_favorited_durables_by_type(accessory_type: int, user: User) -> list

Get all the favorited durable accessories.

Parameter	Type	Meaning
`accessory_type`	`int`	The accessory type
`user`	`User`	The user.

Returns list: A list of favorited accessories of a given type

get_favorited_durables_by_type_for_user

read-only

$catch.get_favorited_durables_by_type_for_user(accessory_type: int, user: User) -> list

Get all the favorited durable accessories for a user.

Parameter	Type	Meaning
`accessory_type`	`int`	The accessory type
`user`	`User`	The user.

Returns list: A list of favorited accessories of a given type

get_ftue_step_description

$catch.get_ftue_step_description(ftue_step: int) -> string

Gets the description associated with a given FTUE step.

Parameter	Type	Meaning
`ftue_step`	`int`	The given FTUE Step

Returns string: The description associated with a FTUE step

get_fun_survey_appearance_rate

read-only

$catch.get_fun_survey_appearance_rate() -> int

Get the appearance rate of the fun survey.

Returns int: The appearance rate of the fun survey.

get_group_quit_penalty_end_timestamp_seconds

read-only

$catch.get_group_quit_penalty_end_timestamp_seconds() -> int

Get the timestamp for the worst quit penalty in your group.

Returns int: The penalty end-timestamp in seconds.

get_group_quit_penalty_user

read-only

$catch.get_group_quit_penalty_user() -> User

Get the user with the worst quit penalty in your group.

Returns User: The user with the worst quit penalty in your group.

get_highest_tier

read-only

$catch.get_highest_tier(user: User, season: int) -> int

Get the highest tier of the given player for the given season.

Parameter	Type	Meaning
`user`	`User`	The user to lookup.
`season`	`int`	The season to check the tier for.

Returns int: The highest rank tier a user has earned for a given season, k_matchmaking_tier_invalid if the entry was not found.

get_inhibiting_quit_penalty_end_timestamp_seconds

read-only

$catch.get_inhibiting_quit_penalty_end_timestamp_seconds() -> int

Get the timestamp for the end of the quit penalty preventing your group from matchmaking in seconds.

Returns int: The penalty end-timestamp in seconds.

get_inhibiting_quit_penalty_user

read-only

$catch.get_inhibiting_quit_penalty_user() -> User

Get the user with the quit penalty preventing your group from matchmaking.

Returns User: The user whose penalty is preventing matchmaking.

get_is_durable_favorited

read-only

$catch.get_is_durable_favorited(accessory: Reference) -> bool

check to see if a given durable inventory accessory is favorited or not.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory whose is_favorited value we want to find

Returns bool: The favorited status of the given inventory durable.

get_leaderboard_entries_count

read-only

$catch.get_leaderboard_entries_count(match_def: Reference, season: int, pivot: int) -> int

Get the total number of cached leaderboard entries.

Parameter	Type	Meaning
`match_def`	`Reference`	The corresponding ranked playlist for the leaderboard.
`season`	`int`	The season to lookup.
`pivot`	`int`	The leaderboard's pivot style.

Returns int: The number of entries in the leaderboard that we have cached.

get_leaderboard_entry

read-only

$catch.get_leaderboard_entry(index: int, match_def: Reference, season: int, pivot: int) -> list

Get a leaderboard entry by index.

Parameter	Type	Meaning
`index`	`int`	The index in the list to lookup.
`match_def`	`Reference`	The corresponding ranked playlist for the leaderboard.
`season`	`int`	The season to lookup.
`pivot`	`int`	The leaderboard's pivot style.

Returns list: The entry in the cached leaderboard.

get_leaderboard_reward_highest_rank_to_grant

read-only

$catch.get_leaderboard_reward_highest_rank_to_grant(leaderboard_reward: Reference) -> int

Get the highest rank to grant of the given leaderboard reward. Returns -1 if null ref is given.

Parameter	Type	Meaning
`leaderboard_reward`	`Reference`	A .leaderboard reference.

Returns int: The highest rank to grant of the given leaderboard reward. If null ref is given, -1 will be returned.

get_leaderboard_reward_lowest_rank_to_grant

read-only

$catch.get_leaderboard_reward_lowest_rank_to_grant(leaderboard_reward: Reference) -> int

Get the lowest rank to grant of the given leaderboard reward. Returns -1 if null ref is given.

Parameter	Type	Meaning
`leaderboard_reward`	`Reference`	A .leaderboard reference.

Returns int: The lowest rank to grant of the given leaderboard reward. If null ref is given, -1 will be returned.

get_leaderboard_reward_rewards

read-only

$catch.get_leaderboard_reward_rewards(leaderboard_reward: Reference) -> list

Get the rewards of the given leaderboard reward. Returns empty list if null ref is given.

Parameter	Type	Meaning
`leaderboard_reward`	`Reference`	A .leaderboard reference.

Returns list: The rewards of the given leaderboard reward. If null ref is given, empty list will be returned.

get_leaderboard_reward_season

read-only

$catch.get_leaderboard_reward_season(leaderboard_reward: Reference) -> int

Get the season of the given leaderboard reward. Returns -1 if null ref is given.

Parameter	Type	Meaning
`leaderboard_reward`	`Reference`	A .leaderboard reference.

Returns int: The season of the given leaderboard reward. If null ref is given, -1 will be returned.

get_leaderboard_rewards_granted_this_time

read-only

$catch.get_leaderboard_rewards_granted_this_time(user: User, season: int) -> bool

Get whether a user has been granted their leaderboard rewards in this repsonse. Only valid after a net_season_ranks_received event has been received.

Parameter	Type	Meaning
`user`	`User`	The user to lookup.
`season`	`int`	The season to check the rewards status for.

Returns bool: True if the user has been granted their leaderboard rewards in this response, otherwise false.

get_leaderboard_unfiltered_entries_count

read-only

$catch.get_leaderboard_unfiltered_entries_count(match_def: Reference, season: int, pivot: int) -> int

Get the number leaderboard entries before crossplay filtering.

Parameter	Type	Meaning
`match_def`	`Reference`	The corresponding ranked playlist for the leaderboard.
`season`	`int`	The season to lookup.
`pivot`	`int`	The leaderboard's pivot style.

Returns int: The number of entries in the leaderboard that we would get without crossplay filtering.

get_leaderboard_user_index

read-only

$catch.get_leaderboard_user_index(match_def: Reference, season: int) -> int

Get the index of the focal point user for a given leaderboard.

Parameter	Type	Meaning
`match_def`	`Reference`	The corresponding ranked playlist for the leaderboard.
`season`	`int`	The season to lookup.

Returns int: The index of the focal user.

get_league_tier_def_description

read-only

$catch.get_league_tier_def_description(league_tier_def: Reference) -> string

Get the description from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.

Returns string: The description.

get_league_tier_def_division_count

read-only

$catch.get_league_tier_def_division_count(league_tier_def: Reference) -> int

Get the division_count from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.

Returns int: The division count.

get_league_tier_def_division_icon_package

read-only

$catch.get_league_tier_def_division_icon_package(league_tier_def: Reference, index: int) -> Reference

Get a specific division icon from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.
`index`	`int`	The index of the division icon to return.

Returns Reference: The division icon.

get_league_tier_def_icon_package

read-only

$catch.get_league_tier_def_icon_package(league_tier_def: Reference) -> Reference

Get the icon from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.

Returns Reference: The icon.

get_league_tier_def_name

read-only

$catch.get_league_tier_def_name(league_tier_def: Reference) -> string

Get the name from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.

Returns string: The name.

get_league_tier_def_points_per_division

read-only

$catch.get_league_tier_def_points_per_division(league_tier_def: Reference) -> int

Get the points_per_division from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.

Returns int: The points per division.

get_league_tier_def_points_per_loss

read-only

$catch.get_league_tier_def_points_per_loss(league_tier_def: Reference) -> int

Get the points_per_loss from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.

Returns int: The points per loss.

get_league_tier_def_points_per_win

read-only

$catch.get_league_tier_def_points_per_win(league_tier_def: Reference) -> int

Get the points_per_win from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.

Returns int: The points per win.

get_league_tier_def_reward

read-only

$catch.get_league_tier_def_reward(league_tier_def: Reference, index: int) -> Reference

Get a specific reward from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.
`index`	`int`	The index of the reward to return.

Returns Reference: The .reward_def.

get_league_tier_def_rewards

read-only

$catch.get_league_tier_def_rewards(league_tier_def: Reference) -> list

Get the list of rewards from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.

Returns list: The list of .reward_defs.

get_league_tier_def_tier_id

read-only

$catch.get_league_tier_def_tier_id(league_tier_def: Reference) -> int

Get the tier_id from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.

Returns int: The tier ID.

get_league_tier_def_win_streak_bonus_points

read-only

$catch.get_league_tier_def_win_streak_bonus_points(league_tier_def: Reference) -> int

Get the win_streak_bonus_points from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.

Returns int: The additional points rewarded while on a win streak.

get_league_tier_def_win_streak_count

read-only

$catch.get_league_tier_def_win_streak_count(league_tier_def: Reference) -> int

Get the win_streak_count from a .league_tier_def reference.

Parameter	Type	Meaning
`league_tier_def`	`Reference`	A .league_tier_def reference.

Returns int: The number of wins required for a win streak.

get_load_hideout_cosmetics_timeout

read-only

$catch.get_load_hideout_cosmetics_timeout() -> int

Get the load_hideout_cosmetics_timeout backend tunable value.

Returns int: The timeout in seconds.

get_load_hideout_timeout

read-only

$catch.get_load_hideout_timeout() -> int

Get the load_hideout_timeout backend tunable value.

Returns int: The timeout in seconds.

get_load_match_cosmetics_timeout

read-only

$catch.get_load_match_cosmetics_timeout() -> int

Get the load_match_cosmetics_timeout backend tunable value.

Returns int: The timeout in seconds.

get_load_match_jip_cosmetics_timeout

read-only

$catch.get_load_match_jip_cosmetics_timeout() -> int

Get the load_match_jip_cos4metics_timeout backend tunable value.

Returns int: The timeout in seconds.

get_load_match_jip_timeout

read-only

$catch.get_load_match_jip_timeout() -> int

Get the load_match_jip_timeout backend tunable value.

Returns int: The timeout in seconds.

get_load_match_timeout

read-only

$catch.get_load_match_timeout() -> int

Get the load_match_timeout backend tunable value.

Returns int: The timeout in seconds.

get_match_result_xp_award_method

read-only

$catch.get_match_result_xp_award_method(match_xp_model: Reference) -> int

Get the xp_award_method, which dictates how to determine match result xp. Currently, win_lose_tie or placement.

Parameter	Type	Meaning
`match_xp_model`	`Reference`	The .match_xp_model reference.

Returns int: The xp_model_type.

get_match_xp_model_type

read-only

$catch.get_match_xp_model_type(match_xp_model: Reference) -> int

Get the xp_model_type this .match_xp_model should apply to.

Parameter	Type	Meaning
`match_xp_model`	`Reference`	The .match_xp_model reference.

Returns int: The xp_model_type.

get_match_xp_rate

read-only

$catch.get_match_xp_rate(match_xp_model: Reference, xp_source_type: int) -> int

Get the amount that XP should increase for a given reason (xp_source_type).

Parameter	Type	Meaning
`match_xp_model`	`Reference`	The .match_xp_model reference.
`xp_source_type`	`int`	The vcatch_xp_source_type_t.

Returns int: The XP rate or 0 on failure.

get_platform_suffix_for_user

read-only

$catch.get_platform_suffix_for_user(user: User) -> string

Returns a suffix string for the user's platform. This works on both client and server.

Parameter	Type	Meaning
`user`	`User`	The user who's platform you want.

Returns string: One of: '_or', '_xb', '_ps', '_ni', or ''.

get_player_brag_a_list

read-only

$catch.get_player_brag_a_list(player_brag_def: Reference) -> list

Get the a_key_list from a .player_brag_def reference.

Parameter	Type	Meaning
`player_brag_def`	`Reference`	A .player_brag_def reference.

Returns list: The list of a keys.

get_player_brag_a_match_stat_type_list

read-only

$catch.get_player_brag_a_match_stat_type_list(player_brag_def: Reference) -> list

Get the a_in_match_stat_type_list from a .player_brag_def reference.

Parameter	Type	Meaning
`player_brag_def`	`Reference`	A .player_brag_def reference.

Returns list: The list of a types.

get_player_brag_b_list

read-only

$catch.get_player_brag_b_list(player_brag_def: Reference) -> list

Get the b_key_list from a .player_brag_def reference.

Parameter	Type	Meaning
`player_brag_def`	`Reference`	A .player_brag_def reference.

Returns list: The list of b keys.

get_player_brag_b_match_stat_type_list

read-only

$catch.get_player_brag_b_match_stat_type_list(player_brag_def: Reference) -> list

Get the b_in_match_stat_type_list from a .player_brag_def reference.

Parameter	Type	Meaning
`player_brag_def`	`Reference`	A .player_brag_def reference.

Returns list: The list of a types.

get_player_brag_brag_math

read-only

$catch.get_player_brag_brag_math(player_brag_def: Reference) -> int

Get the brag math from a .player_brag_def reference.

Parameter	Type	Meaning
`player_brag_def`	`Reference`	A .player_brag_def reference.

Returns int: The math type.

get_player_brag_is_match_stat

read-only

$catch.get_player_brag_is_match_stat(player_brag_def: Reference) -> bool

Get the is match stat from a .player_brag_def reference.

Parameter	Type	Meaning
`player_brag_def`	`Reference`	A .player_brag_def reference.

Returns bool: Is this stat a match.

get_player_entity

read-only

$catch.get_player_entity(user: User) -> Entity

Get the player entity for the given user.

Parameter	Type	Meaning
`user`	`User`	A user handle.

Returns Entity: The player_prefab.level entity for the given user.

get_playlist_calendar_match_defs

read-only

$catch.get_playlist_calendar_match_defs(playlist_calendar: Reference) -> list

Get all the match defs contained in relative_playlist_schedules from a .playlist_calendar reference (no duplicate entries).

Parameter	Type	Meaning
`playlist_calendar`	`Reference`	A .playlist_calendar reference.

Returns list: The list of all match_defs in relative_playlist_schedules. No duplicates.

get_playlist_calendar_playlist_schedule_at_index

read-only

$catch.get_playlist_calendar_playlist_schedule_at_index(playlist_calendar: Reference, index: int) -> Reference

Get a specific playlist_schedule from a .playlist_calendar reference's relative_playlist_schedule list, at the given index.

Parameter	Type	Meaning
`playlist_calendar`	`Reference`	A .playlist_calendar reference.
`index`	`int`	The index into the relative_playlist_schedules list.

Returns Reference: The playlist_schedule at the index.

get_playlist_calendar_playlist_schedule_count

read-only

$catch.get_playlist_calendar_playlist_schedule_count(playlist_calendar: Reference) -> int

Get the length of relative_playlist_schedules from a .playlist_calendar reference.

Parameter	Type	Meaning
`playlist_calendar`	`Reference`	A .playlist_calendar reference.

Returns int: The relative_playlist_schedules list length.

get_playlist_calendar_playlist_schedules

read-only

$catch.get_playlist_calendar_playlist_schedules(playlist_calendar: Reference) -> list

Get the playlist_schedules list from a .playlist_calendar reference.

Parameter	Type	Meaning
`playlist_calendar`	`Reference`	A .playlist_calendar reference.

Returns list: The playlist_schedules list.

get_playlist_calendars_enabled

read-only

$catch.get_playlist_calendars_enabled() -> bool

Get the state of the playlist_calendars_enabled flag.

Returns bool: The playlist_calendars_enabled flag.

get_quit_penalty_def_min_marks

read-only

$catch.get_quit_penalty_def_min_marks(quit_penalty_def: Reference) -> int

Get the min_marks from a .quit_penalty_def reference.

Parameter	Type	Meaning
`quit_penalty_def`	`Reference`	A .quit_penalty_def reference.

Returns int: The minimum quitter's marks to qualify for this quit penalty.

get_quit_penalty_duration_if_quit

read-only

$catch.get_quit_penalty_duration_if_quit() -> int

Get what the primary users quit penalty duration would be if they were to leave their current match.

Returns int: The quit penalty duration in seconds.

get_quit_penalty_duration_seconds

read-only

$catch.get_quit_penalty_duration_seconds(quit_penalty_def: Reference) -> int

Get the duration of the given .quit_penalty_def reference in seconds.

Parameter	Type	Meaning
`quit_penalty_def`	`Reference`	A .quit_penalty_def reference.

Returns int: The duration of this quit penalty in seconds.

get_quit_penalty_marks_per_quickplay

read-only

$catch.get_quit_penalty_marks_per_quickplay() -> int

Get how many marks you recieve for quitting a quickplay match.

Returns int: The number of marks.

get_quit_penalty_marks_per_ranked

read-only

$catch.get_quit_penalty_marks_per_ranked() -> int

Get how many marks you recieve for quitting a ranked match.

Returns int: The number of marks.

get_quit_penalty_marks_removed_per_day

read-only

$catch.get_quit_penalty_marks_removed_per_day() -> int

Get how many marks expire after each day.

Returns int: The number of marks.

get_quit_penalty_marks_removed_per_match

read-only

$catch.get_quit_penalty_marks_removed_per_match() -> int

Get how many marks expire after each match.

Returns int: The number of marks.

get_quit_penalty_max_marks

read-only

$catch.get_quit_penalty_max_marks() -> int

Get the max number of marks a user can have.

Returns int: The number of marks.

get_quit_penalty_rules_marks_per_quickplay

read-only

$catch.get_quit_penalty_rules_marks_per_quickplay(quit_penalty_rules_def: Reference) -> int

Get the marks_per_quickplay from a .quit_penalty_rules_def reference.

Parameter	Type	Meaning
`quit_penalty_rules_def`	`Reference`	A .quit_penalty_rules_def reference.

Returns int: The number of marks a user receives for quitting quickplay.

get_quit_penalty_rules_marks_per_ranked

read-only

$catch.get_quit_penalty_rules_marks_per_ranked(quit_penalty_rules_def: Reference) -> int

Get the marks_per_ranked from a .quit_penalty_rules_def reference.

Parameter	Type	Meaning
`quit_penalty_rules_def`	`Reference`	A .quit_penalty_rules_def reference.

Returns int: The number of marks a user receives for quitting ranked.

get_quit_penalty_rules_marks_removed_per_day

read-only

$catch.get_quit_penalty_rules_marks_removed_per_day(quit_penalty_rules_def: Reference) -> int

Get the marks_removed_per_day from a .quit_penalty_rules_def reference.

Parameter	Type	Meaning
`quit_penalty_rules_def`	`Reference`	A .quit_penalty_rules_def reference.

Returns int: The number of marks removed from a user for each 24h period after their last penalty completes.

get_quit_penalty_rules_marks_removed_per_match

read-only

$catch.get_quit_penalty_rules_marks_removed_per_match(quit_penalty_rules_def: Reference) -> int

Get the marks_removed_per_match from a .quit_penalty_rules_def reference.

Parameter	Type	Meaning
`quit_penalty_rules_def`	`Reference`	A .quit_penalty_rules_def reference.

Returns int: The number of marks removed from a user for completing a full match.

get_quit_penalty_rules_max_mark_count

read-only

$catch.get_quit_penalty_rules_max_mark_count(quit_penalty_rules_def: Reference) -> int

Get the max_mark_count from a .quit_penalty_rules_def reference.

Parameter	Type	Meaning
`quit_penalty_rules_def`	`Reference`	A .quit_penalty_rules_def reference.

Returns int: The max number of marks a user can have.

get_random_reward_def_accessory_type

read-only

$catch.get_random_reward_def_accessory_type(random_reward_def: Reference) -> int

Get the shared accessory type of the rewards of a given random_reward. Returns k_accessory_type_none if not all rewards are of the same accessory type.

Parameter	Type	Meaning
`random_reward_def`	`Reference`	A .random_reward_def reference.

Returns int: The accessory type. A value from the vcatch_accessory_type_t enum.

get_random_reward_def_first_accessory

read-only

$catch.get_random_reward_def_first_accessory(random_reward_def: Reference) -> Reference

Get the first found accessory reward of a given random_reward. Returns k_accessory_type_none if no rewards are found.

Parameter	Type	Meaning
`random_reward_def`	`Reference`	A .random_reward_def reference.

Returns Reference: The accessory.

get_raw_level_from_xp

read-only

$catch.get_raw_level_from_xp(reputation: Reference, xp: int) -> int

Get the raw reputation level given the experience number.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`xp`	`int`	The raw experience number.

Returns int: The delta xp.

get_relative_playlist_schedule_end_day

read-only

$catch.get_relative_playlist_schedule_end_day(relative_playlist_schedule: Reference) -> int

Get the end_day int for a vcatch_relative_playlist_schedule_t

Parameter	Type	Meaning
`relative_playlist_schedule`	`Reference`	A vcatch_relative_playlist_schedule_t reference.

Returns int: The end_day int of the vcatch_relative_playlist_schedule_t.

get_relative_playlist_schedule_label

read-only

$catch.get_relative_playlist_schedule_label(relative_playlist_schedule: Reference) -> string

Get the label string for a vcatch_relative_playlist_schedule_t

Parameter	Type	Meaning
`relative_playlist_schedule`	`Reference`	A vcatch_relative_playlist_schedule_t reference.

Returns string: The label string of the vcatch_relative_playlist_schedule_t.

get_relative_playlist_schedule_match_defs

read-only

$catch.get_relative_playlist_schedule_match_defs(relative_playlist_schedule: Reference) -> list

Get the match_defs list for a vcatch_relative_playlist_schedule_t

Parameter	Type	Meaning
`relative_playlist_schedule`	`Reference`	A vcatch_relative_playlist_schedule_t reference.

Returns list: The match_defs list of the vcatch_relative_playlist_schedule_t.

get_relative_playlist_schedule_start_day

read-only

$catch.get_relative_playlist_schedule_start_day(relative_playlist_schedule: Reference) -> int

Get the start_day int for a vcatch_relative_playlist_schedule_t

Parameter	Type	Meaning
`relative_playlist_schedule`	`Reference`	A vcatch_relative_playlist_schedule_t reference.

Returns int: The start_day int of the vcatch_relative_playlist_schedule_t.

get_replay_animation_start_time

$catch.get_replay_animation_start_time(user: User) -> int

Returns the start time of the animation.

Parameter	Type	Meaning
`user`	`User`	The user playing the animation.

Returns int: The playing animations start time.

get_replay_loop_animation

$catch.get_replay_loop_animation(user: User) -> bool

Returns if the playing animation should loop.

Parameter	Type	Meaning
`user`	`User`	The user playing the animation.

Returns bool: If the playing animation should loop.

get_replay_paused_animation_time

$catch.get_replay_paused_animation_time(user: User) -> float

Returns the paused time for the playing animation.

Parameter	Type	Meaning
`user`	`User`	The user playing the animation.

Returns float: The paused time for the playing animation.

get_replay_team_id

read-only

$catch.get_replay_team_id() -> int

Returns the desired team id for the local player.

Returns int: The desired team id for the local player.

get_reward_def_accessory_type

read-only

$catch.get_reward_def_accessory_type(reward_def: Reference) -> int

If the type of reward is k_reward_type_accessory_type, gets the type of accessory.

Parameter	Type	Meaning
`reward_def`	`Reference`	A .reward_def reference.

Returns int: The type of accessory. A value from the vcatch_accessory_type_t enum.

get_reward_def_contract_def

read-only

$catch.get_reward_def_contract_def(reward_def: Reference) -> Reference

If the type of reward is k_reward_type_contract, gets the .contract_def file reference.

Parameter	Type	Meaning
`reward_def`	`Reference`	A .reward_def reference.

Returns Reference: A reference to the contract_def file.

get_reward_def_data_index

read-only

$catch.get_reward_def_data_index(reward_def: Reference) -> int

Get the data index of reward for the given reward_def.

Parameter	Type	Meaning
`reward_def`	`Reference`	A .reward_def reference.

Returns int: The data_index of reward to give.

get_reward_def_quantity

read-only

$catch.get_reward_def_quantity(reward_def: Reference) -> int

Get the quantity of reward for the given reward_def.

Parameter	Type	Meaning
`reward_def`	`Reference`	A .reward_def reference.

Returns int: The quantity of reward to give.

get_reward_def_random_reward

read-only

$catch.get_reward_def_random_reward(reward_def: Reference) -> Reference

If the type of reward is k_reward_type_random_reward, gets the .random_reward file reference.

Parameter	Type	Meaning
`reward_def`	`Reference`	A .reward_def reference.

Returns Reference: A reference to the random_reward file.

get_reward_def_rarity

read-only

$catch.get_reward_def_rarity(reward_def: Reference) -> int

Get the rarity of the given reward_def.

Parameter	Type	Meaning
`reward_def`	`Reference`	A .reward_def reference.

Returns int: The rarity of the reward. A value from the vcatch_rarity_t enum.

get_reward_def_specific_accessory

read-only

$catch.get_reward_def_specific_accessory(reward_def: Reference) -> Reference

If the type of reward is k_reward_type_specific_accessory, gets the .accessory file reference.

Parameter	Type	Meaning
`reward_def`	`Reference`	A .reward_def reference.

Returns Reference: A reference to the accessory file.

get_reward_def_type

read-only

$catch.get_reward_def_type(reward_def: Reference) -> int

Get the type of the given reward_def.

Parameter	Type	Meaning
`reward_def`	`Reference`	A .reward_def reference.

Returns int: The type of reward. A value from the vcatch_reward_type_t enum.

get_season_leaderboard_rank

read-only

$catch.get_season_leaderboard_rank(user: User, season: int) -> int

Get the final rank of the given player for the given season. Only available once request_season_leaderboard_rank has return a response. Server only.

Parameter	Type	Meaning
`user`	`User`	The user to lookup.
`season`	`int`	The season to check the rank for.

Returns int: The rank of the user. INT_MAX if the user wasn't ranked, -1 if the entry was not found.

get_season_rewards_granted

read-only

$catch.get_season_rewards_granted(user: User, season: int) -> int

Get whether a user has been granted their seasonal rewards. Only valid after a net_season_ranks_received event has been received.

Parameter	Type	Meaning
`user`	`User`	The user to lookup.
`season`	`int`	The season to check the rewards status for.

Returns int: True if the user has been granted their ranked rewards, otherwise false.

get_season_xp_level_is_free

read-only

$catch.get_season_xp_level_is_free(season_reputation: Reference, raw_level: int) -> bool

True if the xp level of the season reputation is a free level.

Parameter	Type	Meaning
`season_reputation`	`Reference`	The .season_reputation.xml asset.
`raw_level`	`int`	The raw level number.

Returns bool: If the level is free.

get_season_xp_level_level_count

read-only

$catch.get_season_xp_level_level_count(season_reputation: Reference) -> int

Get the number of levels for the season reputation.

Parameter	Type	Meaning
`season_reputation`	`Reference`	The .season_reputation.xml asset.

Returns int: The number of levels.

get_season_xp_level_reward_accessory_type

read-only

$catch.get_season_xp_level_reward_accessory_type(season_reputation: Reference, raw_level: int, reward_index: int) -> int

If the type of reward is k_reward_type_accessory_type, gets the type of accessory.

Parameter	Type	Meaning
`season_reputation`	`Reference`	The .season_reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns int: The type of accessory. A value from the vcatch_accessory_type_t enum.

get_season_xp_level_reward_count

read-only

$catch.get_season_xp_level_reward_count(season_reputation: Reference, raw_level: int) -> int

Get the number of rewards granted for attaining the given raw season level.

Parameter	Type	Meaning
`season_reputation`	`Reference`	The .season_reputation.xml asset.
`raw_level`	`int`	The raw level number.

Returns int: The number of rewards.

get_season_xp_level_reward_data_index

read-only

$catch.get_season_xp_level_reward_data_index(season_reputation: Reference, raw_level: int, reward_index: int) -> int

Get the static data index value of reward for the given reward_def.

Parameter	Type	Meaning
`season_reputation`	`Reference`	The .season_reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns int: The static data index value of the reward.

get_season_xp_level_reward_def

read-only

$catch.get_season_xp_level_reward_def(season_reputation: Reference, raw_level: int, reward_index: int) -> Reference

Gets the .reward_def file reference.

Parameter	Type	Meaning
`season_reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns Reference: A reference to the reward.

get_season_xp_level_reward_quantity

read-only

$catch.get_season_xp_level_reward_quantity(season_reputation: Reference, raw_level: int, reward_index: int) -> int

Get the quantity of reward for the given reward_def.

Parameter	Type	Meaning
`season_reputation`	`Reference`	The .season_reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns int: The quantity of reward to give.

get_season_xp_level_reward_specific_accessory

read-only

$catch.get_season_xp_level_reward_specific_accessory(season_reputation: Reference, raw_level: int, reward_index: int) -> Reference

If the type of reward is k_reward_type_specific_accessory, gets the .accessory file reference.

Parameter	Type	Meaning
`season_reputation`	`Reference`	The .season_reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns Reference: A reference to the accessory file.

get_season_xp_level_reward_type

read-only

$catch.get_season_xp_level_reward_type(season_reputation: Reference, raw_level: int, reward_index: int) -> int

For a reward granted for attaining the supplied raw season level, get the type.

Parameter	Type	Meaning
`season_reputation`	`Reference`	The .season_reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns int: The type of reward. A value from the vcatch_reward_type_t enum.

get_sfx_desc_force_loop

read-only

$catch.get_sfx_desc_force_loop(sfx_desc: Reference) -> bool

Get if we should loop from a SFX desc.

Parameter	Type	Meaning
`sfx_desc`	`Reference`	A reference to a vcatch_sfx_desc_t.

Returns bool: Do we loop this sound?

get_sfx_desc_list_count

read-only

$catch.get_sfx_desc_list_count(sfx_desc_list: Reference) -> int

...

Parameter	Type	Meaning
`sfx_desc_list`	`Reference`	A reference to a vcatch_sfx_desc_list_t.

Returns int: ...

get_sfx_desc_list_entries_by_token

read-only

$catch.get_sfx_desc_list_entries_by_token(sfx_desc_list: Reference, token: string, iolist: list)

Get all the SFX desc entries from the list by looking up the unique token. The found entries are appended to the given iolist.

Parameter	Type	Meaning
`sfx_desc_list`	`Reference`	A reference to a vcatch_sfx_desc_list_t.
`token`	`string`	The token of the entries to return.
`iolist`	`list`	A list to append the refs to.

get_sfx_desc_list_entry_by_index

read-only

$catch.get_sfx_desc_list_entry_by_index(sfx_desc_list: Reference, index: int) -> Reference

...

Parameter	Type	Meaning
`sfx_desc_list`	`Reference`	A reference to a vcatch_sfx_desc_list_t.
`index`	`int`	The index.

Returns Reference: ...

get_sfx_desc_max_instance_count

read-only

$catch.get_sfx_desc_max_instance_count(sfx_desc: Reference) -> int

Get the maximum instances from a SFX desc reference.

Parameter	Type	Meaning
`sfx_desc`	`Reference`	A reference to a vcatch_sfx_desc_t.

Returns int: The maximum number of concurrent instances of this sound.

get_sfx_desc_rumble_reciever_type

read-only

$catch.get_sfx_desc_rumble_reciever_type(sfx_desc: Reference) -> int

Get the rumble receiver type from a SFX desc.

Parameter	Type	Meaning
`sfx_desc`	`Reference`	A reference to a vcatch_sfx_desc_t.

Returns int: A vcatch_rumble_receiver_t enum for this sound.

get_sfx_desc_token

read-only

$catch.get_sfx_desc_token(sfx_desc: Reference) -> string

Get the token from a SFX desc reference.

Parameter	Type	Meaning
`sfx_desc`	`Reference`	A reference to a vcatch_sfx_desc_t.

Returns string: The token string.

get_sfx_desc_wwise_event

read-only

$catch.get_sfx_desc_wwise_event(sfx_desc: Reference) -> Reference

Get the wwise event from a SFX desc reference.

Parameter	Type	Meaning
`sfx_desc`	`Reference`	A reference to a vcatch_sfx_desc_t.

Returns Reference: The wwise event of this sound.

get_sorted_combined_friends_with_headers

read-only

$catch.get_sorted_combined_friends_with_headers(in_game_platform_count: int, in_game_velan_count: int, online_count: int, offline_count: int, start_index: int, count: int) -> list

Gets a list of sorted combined friends with header markers for the friends list.

Parameter	Type	Meaning
`in_game_platform_count`	`int`	The number of known in-game Platform friends.
`in_game_velan_count`	`int`	The number of known in-game KO City friends.
`online_count`	`int`	The number of known online friends.
`offline_count`	`int`	The number of known offline friends.
`start_index`	`int`	The offset in the friends list to start at.
`count`	`int`	The number of friends to retrieve.

Returns list: The list of sorted combined friends. nulluser will be used to denote a header.

get_sorted_crew_members_with_headers

read-only

$catch.get_sorted_crew_members_with_headers(in_game_count: int, online_count: int, offline_count: int, start_index: int, count: int, guid: string) -> list

Gets a list of sorted crew members with header markers for the friends list.

Parameter	Type	Meaning
`in_game_count`	`int`	The number of known in-game crew members.
`online_count`	`int`	The number of known online crew members.
`offline_count`	`int`	The number of known offline crew members.
`start_index`	`int`	The offset in the crew member list to start at.
`count`	`int`	The number of crew members to retrieve.
`guid`	`string`	(optional) The crew guid to search by - will use the local user if unspecified.

Returns list: The list of sorted crew members. nulluser will be used to denote a header.

get_subtitle_text

read-only

$catch.get_subtitle_text(subtitle_def: Reference, wwise_event: Reference, wwise_marker_id: int) -> string

Get the subtitle text associated with the given wwise sound event.

Parameter	Type	Meaning
`subtitle_def`	`Reference`	A reference to a vcatch_subtitle_def_t.
`wwise_event`	`Reference`	A reference to a vaudio_wwise_sound_event_t.
`wwise_marker_id`	`int`	Optionally a wwise marker id, which is passed to the sound_marker_callback event.

Returns string: The text.

get_text_format_level

read-only

$catch.get_text_format_level(text_format: Reference) -> Reference

Get the implementation level of a text_format.

Parameter	Type	Meaning
`text_format`	`Reference`	The text_format to get the level from.

Returns Reference: The implementation level of text_format.

get_text_list_image_format_level

read-only

$catch.get_text_list_image_format_level(text_list: Reference) -> Reference

Get the image format level of a text_list.

Parameter	Type	Meaning
`text_list`	`Reference`	The text_list to get the format level from.

Returns Reference: The image format level of text_list.

get_text_list_length

read-only

$catch.get_text_list_length(text_list: Reference) -> int

Get the count of text_sections in a text_list.

Parameter	Type	Meaning
`text_list`	`Reference`	The text_list to get the length of.

Returns int: The count of text_sections.

get_text_list_section_format

read-only

$catch.get_text_list_section_format(text_list: Reference, index: int) -> Reference

Get a text_format from a text_list's text_section defined at index.

Parameter	Type	Meaning
`text_list`	`Reference`	The text_list to get the section from.
`index`	`int`	The index of the text_section to get the text_format from.

Returns Reference: The text_format at index.

get_text_list_text_section

read-only

$catch.get_text_list_text_section(text_list: Reference, index: int) -> Reference

Get a text_section from a text_list at index.

Parameter	Type	Meaning
`text_list`	`Reference`	The text_list to get the section from.
`index`	`int`	The index of the text_section.

Returns Reference: The text_section at index.

get_text_section_image_insert_index

read-only

$catch.get_text_section_image_insert_index(text_section: Reference) -> int

Get the index to insert the image at from a text_section.

Parameter	Type	Meaning
`text_section`	`Reference`	The text_section to get the image texture from.

Returns int: The insertion index.

get_text_section_image_texture

read-only

$catch.get_text_section_image_texture(text_section: Reference) -> Reference

Get the image texture of a text_section.

Parameter	Type	Meaning
`text_section`	`Reference`	The text_section to get the image texture from.

Returns Reference: The image texture.

get_text_section_text

read-only

$catch.get_text_section_text(text_section: Reference, index: int) -> Reference

Get the text from a text_section at index.

Parameter	Type	Meaning
`text_section`	`Reference`	The text_section to get the text from.
`index`	`int`	The index of the text.

Returns Reference: The text loc_string at index.

get_text_section_text_count

read-only

$catch.get_text_section_text_count(text_section: Reference) -> int

Get the count of text loc_strings in a text_section.

Parameter	Type	Meaning
`text_section`	`Reference`	The text_section to get the count of text loc_strings from.

Returns int: The count of text loc_strings.

get_thank_you_bonus_reward_def_list

read-only

$catch.get_thank_you_bonus_reward_def_list(thank_you_bonus_rewards: Reference) -> list

Gets the .reward_def reference list.

Parameter	Type	Meaning
`thank_you_bonus_rewards`	`Reference`	The .thank_you_bonus_rewards asset.

Returns list: A reference to the reward.

get_thank_you_bonus_season_number

read-only

$catch.get_thank_you_bonus_season_number(thank_you_bonus_rewards: Reference) -> int

Gets the season number of the thank you bonus rewards.

Parameter	Type	Meaning
`thank_you_bonus_rewards`	`Reference`	The .thank_you_bonus_rewards asset.

Returns int: A reference to the reward.

get_time_period_schedule_begin_time_utc_s

read-only

$catch.get_time_period_schedule_begin_time_utc_s(time_period_schedule: Reference, time_period_name: string) -> int

Gets the begin time of a time period in seconds UTC.

Parameter	Type	Meaning
`time_period_schedule`	`Reference`	The .time_period_schedule asset.
`time_period_name`	`string`	The name of the time period.

Returns int: The begin time.

get_time_period_schedule_day_begin_offset_hours

read-only

$catch.get_time_period_schedule_day_begin_offset_hours(time_period_schedule: Reference) -> int

Gets day_begin_offset_hours. An 'in-game day' begins at 00:00 UTC + this offset.

Parameter	Type	Meaning
`time_period_schedule`	`Reference`	The .time_period_schedule asset.

Returns int: The offset in hours.

get_time_period_schedule_end_time_utc_s

read-only

$catch.get_time_period_schedule_end_time_utc_s(time_period_schedule: Reference, time_period_name: string) -> int

Gets the end time of a time period in seconds UTC.

Parameter	Type	Meaning
`time_period_schedule`	`Reference`	The .time_period_schedule asset.
`time_period_name`	`string`	The name of the time period.

Returns int: The end time.

get_tmnt_baddies_bundle_owned

read-only

$catch.get_tmnt_baddies_bundle_owned() -> bool

Get the ownership status of the TMNT Baddies bundle.

Returns bool: True if the TMNT baddies bundle is owned.

get_tmnt_bundle_owned

read-only

$catch.get_tmnt_bundle_owned() -> bool

Get the ownership status of the TMNT bundle.

Returns bool: True if the TMNT bundle is owned.

get_user_quit_penalty_end_timestamp_seconds

read-only

$catch.get_user_quit_penalty_end_timestamp_seconds() -> int

Get the timestamp for the primary users quit penalty.

Returns int: The penalty end-timestamp in seconds.

get_variant_count_for_accessory

read-only

$catch.get_variant_count_for_accessory(accessory: Reference, accessories: list, body_type_accessory: Reference) -> int

Given a list of accessories, return the number of accessories associated with the variant set of the specified accessory.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory (vcatch_accessory_t ref) to search by.
`accessories`	`list`	The list of accessories (vcatch_accessory_t refs) to search.
`body_type_accessory`	`Reference`	The body type accessory (vcatch_accessory_t ref) to filter if it's provided.

Returns int: Count of filtered results.

get_variant_for_accessory_by_index

read-only

$catch.get_variant_for_accessory_by_index(accessory: Reference, accessories: list, body_type_accessory: Reference, variant_index: int) -> Reference

Return the i'th variant for an accessory in a given list.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory (vcatch_accessory_t ref) to search by.
`accessories`	`list`	The list of accessories (vcatch_accessory_t refs) to search.
`body_type_accessory`	`Reference`	The body type accessory (vcatch_accessory_t ref) to filter if it's provided.
`variant_index`	`int`	The index of the variant.

Returns Reference: The variant.

get_variants_for_accessory

read-only

$catch.get_variants_for_accessory(accessory: Reference, accessories: list, body_type_accessory: Reference) -> list

Given a list of accessories, return a new list containing only accessories associated with the variant set of the specified accessory.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory (vcatch_accessory_t ref) to search by.
`accessories`	`list`	The list of accessories (vcatch_accessory_t refs) to search.
`body_type_accessory`	`Reference`	The body type accessory (vcatch_accessory_t ref) to filter if it's provided.

Returns list: A new list with the filtered results.

get_vfx_desc_level

read-only

$catch.get_vfx_desc_level(vfx_desc: Reference) -> Reference

Get the level from a VFX desc reference.

Parameter	Type	Meaning
`vfx_desc`	`Reference`	A reference to a vcatch_vfx_desc_t.

Returns Reference: The level ref.

get_vfx_desc_list_count

read-only

$catch.get_vfx_desc_list_count(vfx_desc_list: Reference) -> int

Get the number of VFX descs within the list.

Parameter	Type	Meaning
`vfx_desc_list`	`Reference`	A reference to a vcatch_vfx_desc_list_t.

Returns int: The number of VFX descs.

get_vfx_desc_list_entry

read-only

$catch.get_vfx_desc_list_entry(vfx_desc_list: Reference, index: int) -> Reference

Get a VFX desc entry from the list.

Parameter	Type	Meaning
`vfx_desc_list`	`Reference`	A reference to a vcatch_vfx_desc_list_t.
`index`	`int`	The index of the entry to return. Use catch.get_vfx_desc_list_count(..) to find the count.

Returns Reference: A ref to a vcatch_vfx_desc_t.

get_vfx_desc_list_entry_by_token

read-only

$catch.get_vfx_desc_list_entry_by_token(vfx_desc_list: Reference, token: string) -> Reference

Get a VFX desc entry from the list by looking up its unique token.

Parameter	Type	Meaning
`vfx_desc_list`	`Reference`	A reference to a vcatch_vfx_desc_list_t.
`token`	`string`	The token of the entry to return.

Returns Reference: A ref to a vcatch_vfx_desc_t or nullref if not found.

get_vfx_desc_parent_component_name

read-only

$catch.get_vfx_desc_parent_component_name(vfx_desc: Reference) -> string

Get the name of the parent component to use from a VFX desc reference.

Parameter	Type	Meaning
`vfx_desc`	`Reference`	A reference to a vcatch_vfx_desc_t.

Returns string: The string name of the parent component to use.

get_vfx_desc_token

read-only

$catch.get_vfx_desc_token(vfx_desc: Reference) -> string

Get the token from a VFX desc reference.

Parameter	Type	Meaning
`vfx_desc`	`Reference`	A reference to a vcatch_vfx_desc_t.

Returns string: The token string.

get_xp_boost_def_description

read-only

$catch.get_xp_boost_def_description(xp_boost_def: Reference) -> string

Get descriptionfrom an xp_boost_def.

Parameter	Type	Meaning
`xp_boost_def`	`Reference`	A .xp_boost_def reference.

Returns string: The localized description string.

get_xp_boost_def_max_stackable_count

read-only

$catch.get_xp_boost_def_max_stackable_count(xp_boost_def: Reference) -> int

Get max_stackable_count from an xp_boost_def.

Parameter	Type	Meaning
`xp_boost_def`	`Reference`	A .xp_boost_def reference.

Returns int: The max_stackable_count value.

get_xp_boost_def_multiplier_value

read-only

$catch.get_xp_boost_def_multiplier_value(xp_boost_def: Reference) -> float

Get multiplier_value from an xp_boost_def.

Parameter	Type	Meaning
`xp_boost_def`	`Reference`	A .xp_boost_def reference.

Returns float: The multiplier_value value.

get_xp_boost_def_season

read-only

$catch.get_xp_boost_def_season(xp_boost_def: Reference) -> int

Get season from an xp_boost_def.

Parameter	Type	Meaning
`xp_boost_def`	`Reference`	A .xp_boost_def reference.

Returns int: The season value.

get_xp_boost_def_type

read-only

$catch.get_xp_boost_def_type(xp_boost_def: Reference) -> int

Get type from an xp_boost_def.

Parameter	Type	Meaning
`xp_boost_def`	`Reference`	A .xp_boost_def reference.

Returns int: The boost_type value.

get_xp_level_delta_xp

read-only

$catch.get_xp_level_delta_xp(reputation: Reference, raw_level: int) -> int

Get the delta XP of a reputation level given the raw level number.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.

Returns int: The delta xp.

get_xp_level_number

read-only

$catch.get_xp_level_number(reputation: Reference, raw_level: int) -> int

Get the level number of a reputation level given the raw level number.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.

Returns int: The level number.

get_xp_level_reward_accessory_type

read-only

$catch.get_xp_level_reward_accessory_type(reputation: Reference, raw_level: int, reward_index: int) -> int

If the type of reward is k_reward_type_accessory_type, gets the type of accessory.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns int: The type of accessory. A value from the vcatch_accessory_type_t enum.

get_xp_level_reward_contract

read-only

$catch.get_xp_level_reward_contract(reputation: Reference, raw_level: int, reward_index: int) -> Reference

If the type of reward is k_reward_type_contract, gets the .contract_def file reference.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns Reference: A reference to the contract definition.

get_xp_level_reward_count

read-only

$catch.get_xp_level_reward_count(reputation: Reference, raw_level: int) -> int

Get the number of rewards granted for attaining the given raw level.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.

Returns int: The tier.

get_xp_level_reward_quantity

read-only

$catch.get_xp_level_reward_quantity(reputation: Reference, raw_level: int, reward_index: int) -> int

Get the quantity of reward for the given reward_def.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns int: The quantity of reward to give.

get_xp_level_reward_random_reward

read-only

$catch.get_xp_level_reward_random_reward(reputation: Reference, raw_level: int, reward_index: int) -> Reference

If the type of reward is k_reward_type_random_reward, gets the .random_reward file reference.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns Reference: A reference to the random reward.

get_xp_level_reward_specific_accessory

read-only

$catch.get_xp_level_reward_specific_accessory(reputation: Reference, raw_level: int, reward_index: int) -> Reference

If the type of reward is k_reward_type_specific_accessory, gets the .accessory file reference.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns Reference: A reference to the accessory file.

get_xp_level_reward_type

read-only

$catch.get_xp_level_reward_type(reputation: Reference, raw_level: int, reward_index: int) -> int

For a reward granted for attaining the supplied raw level, get the type.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.
`reward_index`	`int`	The index of the reward.

Returns int: The type of reward. A value from the vcatch_reward_type_t enum.

get_xp_level_tier

read-only

$catch.get_xp_level_tier(reputation: Reference, raw_level: int) -> int

Get the tier of a reputation level given the raw level number.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.

Returns int: The tier.

get_xp_level_total_xp

read-only

$catch.get_xp_level_total_xp(reputation: Reference, raw_level: int) -> int

Get the total XP of a reputation level given the raw level number.

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`raw_level`	`int`	The raw level number.

Returns int: The total xp.

get_xp_max_level

read-only

$catch.get_xp_max_level(reputation: Reference) -> int

Get the max raw level

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.

Returns int: The maximum raw level

get_xp_rate

read-only

$catch.get_xp_rate(reputation: Reference, xp_model_type: int, xp_source_type: int) -> int

Get the amount that XP should increase for a given reason (xp_source_type).

Parameter	Type	Meaning
`reputation`	`Reference`	The .reputation.xml asset.
`xp_model_type`	`int`	The vcatch_xp_model_type_t.
`xp_source_type`	`int`	The vcatch_xp_source_type_t.

Returns int: The XP rate or 0 on failure.

get_xp_tier_border

read-only

$catch.get_xp_tier_border(xp_tier_list: Reference, tier: int) -> Reference

Get the border texture of an XP tier.

Parameter	Type	Meaning
`xp_tier_list`	`Reference`	The .xp_tier_list asset.
`tier`	`int`	The tier.

Returns Reference: The texture.

get_xp_tier_border_large

read-only

$catch.get_xp_tier_border_large(xp_tier_list: Reference, tier: int) -> Reference

Get the border_large texture of an XP tier.

Parameter	Type	Meaning
`xp_tier_list`	`Reference`	The .xp_tier_list asset.
`tier`	`int`	The tier.

Returns Reference: The texture.

get_xp_tier_border_num_backer

read-only

$catch.get_xp_tier_border_num_backer(xp_tier_list: Reference, tier: int) -> Reference

Get the border_num_backer texture of an XP tier.

Parameter	Type	Meaning
`xp_tier_list`	`Reference`	The .xp_tier_list asset.
`tier`	`int`	The tier.

Returns Reference: The texture.

get_xp_tier_border_strip

read-only

$catch.get_xp_tier_border_strip(xp_tier_list: Reference, tier: int) -> Reference

Get the border_strip texture of an XP tier.

Parameter	Type	Meaning
`xp_tier_list`	`Reference`	The .xp_tier_list asset.
`tier`	`int`	The tier.

Returns Reference: The texture.

get_xp_tier_name

read-only

$catch.get_xp_tier_name(xp_tier_list: Reference, tier: int) -> string

Get the name of an XP tier.

Parameter	Type	Meaning
`xp_tier_list`	`Reference`	The .xp_tier_list asset.
`tier`	`int`	The tier.

Returns string: The texture.

get_xp_tier_trophy

read-only

$catch.get_xp_tier_trophy(xp_tier_list: Reference, tier: int) -> Reference

Get the trophy texture of an XP tier.

Parameter	Type	Meaning
`xp_tier_list`	`Reference`	The .xp_tier_list asset.
`tier`	`int`	The tier.

Returns Reference: The texture.

get_xp_tier_trophy_half_size

read-only

$catch.get_xp_tier_trophy_half_size(xp_tier_list: Reference, tier: int) -> Reference

Get the trophy_half_size texture of an XP tier.

Parameter	Type	Meaning
`xp_tier_list`	`Reference`	The .xp_tier_list asset.
`tier`	`int`	The tier.

Returns Reference: The texture.

give_user_quitters_marks

$catch.give_user_quitters_marks(user: User, match_flow_type: int)

Gives a user quitters marks for leaving a certain match flow type.

Parameter	Type	Meaning
`user`	`User`	The user to give the marks to.
`match_flow_type`	`int`	The match flow type the user is quitting.

grant_seasonal_rewards

$catch.grant_seasonal_rewards(user: User, season: int, playlists: list)

Grant seasonal rewards to a given user, if earned - Server only.

Parameter	Type	Meaning
`user`	`User`	The user.
`season`	`int`	The current season.
`playlists`	`list`	The playlists to get leaderboard data for.

has_contract_progress

read-only

$catch.has_contract_progress(crew_guid: string, crew_contract: Reference) -> bool

Checks for entries in the crew progress list

Parameter	Type	Meaning
`crew_guid`	`string`	The crew to lookup progress for.
`crew_contract`	`Reference`	The crew contract to lookup progress for.

Returns bool: True if an entry exists in the crew contract cache.

increment_contract_numerator

read-only

$catch.increment_contract_numerator(contract_def: Reference, user: User, increment: int, debug: bool) -> int

Increment the numerator for a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The user who has this contract.
`increment`	`int`	The amount to increase the numerator.
`debug`	`bool`	Whether this is for debug purpose.

Returns int: The new incremented value.

insert_replay_prefab_entry

$catch.insert_replay_prefab_entry(name: string, category: string)

Add a prefab by name and category that can be spawned from the replay tool.

Parameter	Type	Meaning
`name`	`string`	Display name of the prefab that can be spawned
`category`	`string`	Display category of the prefab that can be spawned

is_accessory_type_consumable

read-only

$catch.is_accessory_type_consumable(accessory_type: int) -> bool

Returns whether accessories of a given accessory type are consumables.

Parameter	Type	Meaning
`accessory_type`	`int`	The accessory type.

Returns bool: Whether accessories of the given accessory type are consumables.

is_accessory_type_crew_equipable

read-only

$catch.is_accessory_type_crew_equipable(accessory_type: int) -> bool

Returns whether accessories of a given accessory type are durables that can be equipped to a crew.

Parameter	Type	Meaning
`accessory_type`	`int`	The accessory type.

Returns bool: Whether accessories of the given accessory type can be equipped to a crew.

is_accessory_type_equipable

read-only

$catch.is_accessory_type_equipable(accessory_type: int) -> bool

Returns whether accessories of a given accessory type are durables that can be equipped to character or to a crew.

Parameter	Type	Meaning
`accessory_type`	`int`	The accessory type.

Returns bool: Whether accessories of the given accessory type can be equipped.

is_crew_contract_avaliable_for_purchase

$catch.is_crew_contract_avaliable_for_purchase(user: User, crew_contract: Reference)

Send queued contracts for the specifed users.

Parameter	Type	Meaning
`user`	`User`	The user would be buying a contract.
`crew_contract`	`Reference`	The crew contract to lookup progress for.

is_private_server_build

read-only

$catch.is_private_server_build() -> bool

Check if this is the Catch private server build.

Returns bool: True if this is the private server build.

is_replay_camera_override_enabled

read-only

$catch.is_replay_camera_override_enabled() -> bool

Returns true if replay tool is overriding camera.

Returns bool: If replay tool is overriding camera.

is_replay_enabled

read-only

$catch.is_replay_enabled() -> bool

Returns true if replay tool functionality is enabled.

Returns bool: If replay tools are enabled.

is_replay_scrubbing

read-only

$catch.is_replay_scrubbing() -> bool

Returns true if replay tool scrubber is active.

Returns bool: If replay tool scrubber is active.

is_replay_trailer_mode_enabled

read-only

$catch.is_replay_trailer_mode_enabled() -> bool

Returns true if replay tool functionality is enabled.

Returns bool: If trailer mode in the replay tools is enabled.

leaderboard_request_by_position

$catch.leaderboard_request_by_position(match_def: Reference, season: int, start_index: int, page_size: int, pivot_from_start: bool)

Get a page of leaderboard entries by position in the leaderboard.

Parameter	Type	Meaning
`match_def`	`Reference`	The corresponding ranked playlist for the leaderboard.
`season`	`int`	The season to lookup.
`start_index`	`int`	The initial index to lookup.
`page_size`	`int`	The number of entries to lookup.
`pivot_from_start`	`bool`	True if we should pivot from the start of the leaderbaord.

leaderboard_request_by_user

$catch.leaderboard_request_by_user(match_def: Reference, season: int, start_index: int, page_size: int)

Get a page of leaderboard entries by a specific user in the leaderboard.

Parameter	Type	Meaning
`match_def`	`Reference`	The corresponding ranked playlist for the leaderboard.
`season`	`int`	The season to lookup.
`start_index`	`int`	The initial index to lookup.
`page_size`	`int`	The number of entries to lookup.

mark_crew_contract_displayed_for_user

$catch.mark_crew_contract_displayed_for_user(crew_contract: Reference, user: User)

Mark a crew contract state to displayed for a user - will be sent when catch.send_queued_crew_contracts() is called

Parameter	Type	Meaning
`crew_contract`	`Reference`	A reference to the crew contract being updated.
`user`	`User`	The user to update for.

playlist_calendar_find_match_def

read-only

$catch.playlist_calendar_find_match_def(playlist_calendar: Reference, match_def: Reference) -> int

In the given .playlist_calendar reference, find the first index of a playlist_schedule that contains the given match_def.

Parameter	Type	Meaning
`playlist_calendar`	`Reference`	A .playlist_calendar reference.
`match_def`	`Reference`	The match_def to find.

Returns int: The index of the first schedule with the given match_def. Returns -1 if not found

purchase_contract_skip

$catch.purchase_contract_skip(user: User, season: int, price: int, platform_balance: int, contract: Reference, crew_contract: bool)

Purchase a contract, completing it automatically and getting the reward

Parameter	Type	Meaning
`user`	`User`	The user.
`season`	`int`	The season to lookup.
`price`	`int`	The price of the offer.
`platform_balance`	`int`	The client's platform currency balance.
`contract`	`Reference`	The contract guid
`crew_contract`	`bool`	is this contract a crew contract

queue_crew_contract_progress

$catch.queue_crew_contract_progress(crew_guid: string, crew_contract: Reference, progress: int, completion_criteria: int, activation_timestamp: int, lifetime: int)

Queue up a crew contract for update - will be sent when catch.send_queued_crew_contracts() is called

Parameter	Type	Meaning
`crew_guid`	`string`	The crew to update the contract for.
`crew_contract`	`Reference`	A reference to the crew contract being updated.
`progress`	`int`	The amount of new progress to be registered towards the contracts completion.
`completion_criteria`	`int`	The total amount of progress needed to complete the contract.
`activation_timestamp`	`int`	The timestamp of when the contract was opened to accept progress in seconds.
`lifetime`	`int`	The lifetime of the contract, in seconds.

queue_debug_criteria_update_for_crew_contract

$catch.queue_debug_criteria_update_for_crew_contract(crew_guid: string, crew_contract: Reference, completion_criteria: int)

Queue up debug criteria update for a crew contract - will be sent when catch.send_queued_crew_contracts() is called

Parameter	Type	Meaning
`crew_guid`	`string`	The crew to update the contract for.
`crew_contract`	`Reference`	A reference to the crew contract being updated.
`completion_criteria`	`int`	The total amount of progress needed to complete the contract.

register_tier_defs

$catch.register_tier_defs(tier_defs: list)

Server only. Register a list of tier definition data.

Parameter	Type	Meaning
`tier_defs`	`list`	List of tier definition data.

relative_playlist_schedule_find_match_def

read-only

$catch.relative_playlist_schedule_find_match_def(relative_playlist_schedule: Reference, match_def: Reference) -> int

In the given vcatch_relative_playlist_schedule_t reference, find the first index of the given match_def.

Parameter	Type	Meaning
`relative_playlist_schedule`	`Reference`	A vcatch_relative_playlist_schedule_t reference.
`match_def`	`Reference`	The match_def to find.

Returns int: The index of the given match_def at its first occurrence. Returns -1 if not found

replay_invulnerable

read-only

$catch.replay_invulnerable() -> bool

Returns whether the replay tool has the local player toggled to invulnerable.

Returns bool: If local player should be invulnerable.

request_crew_contracts_update

$catch.request_crew_contracts_update()

Request the backend send a fresh list of crew contracts for everyone on the server.

reset_queued_crew_contracts

$catch.reset_queued_crew_contracts()

Resets the progress state of the crew contract queued updates

send_queued_contracts

$catch.send_queued_contracts(debug: bool)

Sends the contract updates that were queued by catch.increment_contract_numerator()

Parameter	Type	Meaning
`debug`	`bool`	Whether this is for debug purpose.

send_queued_crew_contracts

$catch.send_queued_crew_contracts(debug_override_write_limit: bool, crew_contract_skipped_purchase: bool, user: User)

Sends the crew contract updates that were queued by catch.queue_crew_contract_progress()

Parameter	Type	Meaning
`debug_override_write_limit`	`bool`	Crew contracts should only be written once per game server. If using a debug feature to write contracts additional times, mark this flag.
`crew_contract_skipped_purchase`	`bool`	Crew contract skipped purchase.
`user`	`User`	The user who bought the contract skip.

set_bot_gamepad_axis_value

$catch.set_bot_gamepad_axis_value(user: User, keymap: Reference, alias: string, value: float) -> bool

Set a bot user gamepad axis to the speficied value

Parameter	Type	Meaning
`user`	`User`	The user handle.
`keymap`	`Reference`	The keymap used to determine aliased keys.
`alias`	`string`	The name of the aliased input in the given keymap.
`value`	`float`	The value to set for the axis.

Returns bool: True if the value was set successfully

set_bot_gamepad_key_down

$catch.set_bot_gamepad_key_down(user: User, keymap: Reference, alias: string) -> bool

Set the bot user gamepad key as down

Parameter	Type	Meaning
`user`	`User`	The user handle.
`keymap`	`Reference`	The keymap used to determine aliased keys.
`alias`	`string`	The name of the aliased input in the given keymap.

Returns bool: True if the headless gamepad button was set

set_client_authoritative_camera_yaw_pitch

$catch.set_client_authoritative_camera_yaw_pitch(user: User, yaw: float, pitch: float)

Set the camera yaw/pitch values of a local user on the client, so that it can be sent to the server in the input packet.

Parameter	Type	Meaning
`user`	`User`	The user.
`yaw`	`float`	The yaw value.
`pitch`	`float`	The pitch value.

set_client_authoritative_player_yaw

$catch.set_client_authoritative_player_yaw(user: User, value: float)

Set the player yaw value of a local user on the client, so that it can be sent to the server in the input packet.

Parameter	Type	Meaning
`user`	`User`	The user.
`value`	`float`	The yaw value.

set_contract_done

read-only

$catch.set_contract_done(contract_def: Reference, user: User)

Set the numerator of a contract to its denominator, and set the state to 'closed' the contract.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The user who has this contract.

set_contract_nearly_done

read-only

$catch.set_contract_nearly_done(contract_def: Reference, user: User)

Set the numerator of a contract to its denominator less one, and set the state to 'closed' the contract.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The user who has this contract.

set_contract_state

read-only

$catch.set_contract_state(contract_def: Reference, user: User, state: int, debug: bool)

Set the state for a .contract_def reference.

Parameter	Type	Meaning
`contract_def`	`Reference`	A .contract_def reference.
`user`	`User`	The user who has this contract.
`state`	`int`	The state to set.
`debug`	`bool`	Whether this is for debug purpose.

set_favorite

read-only

$catch.set_favorite(accessory: Reference, is_favorited: bool)

Change the is_favorited values of a specific accessory type's inventory durables.

Parameter	Type	Meaning
`accessory`	`Reference`	The accessory whose is_favorited value we want to change.
`is_favorited`	`bool`	The value we want is_favorited to change to

set_replay_accessory

$catch.set_replay_accessory(type: int, index: int, body_type: int)

Sets the count of each accessory type on the replay tool.

Parameter	Type	Meaning
`type`	`int`	The vcatch_accessory_type_t of the accessory to set.
`index`	`int`	The index of the accessory to set.
`body_type`	`int`	The body type of the accessory if applicable.

set_replay_accessory_count

$catch.set_replay_accessory_count(type: int, count: int)

Sets the count of each accessory type on the replay tool.

Parameter	Type	Meaning
`type`	`int`	The vcatch_accessory_type_t of the accessory to set the count for.
`count`	`int`	The count of the type of accessory.

set_replay_accessory_names

$catch.set_replay_accessory_names(accessory_type: int, body_type: int, names: list)

Sets the names of the accessories on the replay tool. Should be called once per allowed accessory category.

Parameter	Type	Meaning
`accessory_type`	`int`	The accessory type of the names.
`body_type`	`int`	The body type of the accessory if applicable.
`names`	`list`	The names of the accessories of the specified accessory type (and body type if applicable).

set_replay_animation_duration

$catch.set_replay_animation_duration(user: User, duration: float)

Sets the animation duration on the replay tool.

Parameter	Type	Meaning
`user`	`User`	The owner of the contract.
`duration`	`float`	The animation duration.

set_replay_animation_override_names

$catch.set_replay_animation_override_names(names: list)

Sets the names of the animation_override components on the replay tool. Should only be called once.

Parameter	Type	Meaning
`names`	`list`	The names of the animation_override components on the animation_list entity.

set_replay_animation_time

$catch.set_replay_animation_time(user: User, time: float)

Sets animation time on the replay tool.

Parameter	Type	Meaning
`user`	`User`	The owner of the contract.
`time`	`float`	The animation time.

set_replay_lighting_prefab_names

$catch.set_replay_lighting_prefab_names(names: list)

Sets the names of the lighting prefabs available to spawn in the replay tool. Should only be called once.

Parameter	Type	Meaning
`names`	`list`	The names of the lighting prefabs available to spawn.

set_replay_team_id

$catch.set_replay_team_id(team_id: int)

Sets the team id for the local player. Meant to be used on team.vscript creation for the local user.

Parameter	Type	Meaning
`team_id`	`int`	The team id to set for the local player.

skip_hideout_intro

$catch.skip_hideout_intro() -> bool

Returns true if we should skip the intro.

Returns bool: If -nointro enabled

sort_accessories_by_sort_type

read-only

$catch.sort_accessories_by_sort_type(sort_mode: int, accessories: list) -> list

Given a list of accessories, return a new list containing the accessories sorted by the given sort type (a-z, z-a, rarity).

Parameter	Type	Meaning
`sort_mode`	`int`	The sort type to be used.
`accessories`	`list`	The list of accessories (vcatch_accessory_t refs) to sort.

Returns list: A new list with the sorted results.

update_durable_favorites

read-only

$catch.update_durable_favorites(accessories: list, accessory_type: int, user: User)

Change the is_favorited values of a specific accessory type's inventory durables.

Parameter	Type	Meaning
`accessories`	`list`	The update list of accessories that should be favorited.
`accessory_type`	`int`	The accessory type whose inventory durables we're updating.
`user`	`User`	The user.

update_replay_accessories

$catch.update_replay_accessories(user: User, accessories: list)

Updates the replay tool with the specified accessories.

Parameter	Type	Meaning
`user`	`User`	The user of the accessories.
`accessories`	`list`	The user's accessories.

use_legacy_player_connection_logic

read-only

$catch.use_legacy_player_connection_logic() -> bool

Get the use_legacy_player_connection_logic backend tunable value.

Returns bool: The use_legacy_player_connection_logic value.