2022-01-30 06:47:22 +00:00
## [:rewind: Lua Reference](lua.md)
# Supported Functions
2022-03-05 07:05:23 +00:00
- manually written functions
- [define_custom_obj_fields ](#define_custom_obj_fields )
- [network_init_object ](#network_init_object )
- [network_send_object ](#network_send_object )
< br / >
2022-04-07 01:36:15 +00:00
- behavior_actions.h
- [arc_to_goal_pos ](#arc_to_goal_pos )
- [bhv_1up_common_init ](#bhv_1up_common_init )
- [bhv_1up_hidden_in_pole_loop ](#bhv_1up_hidden_in_pole_loop )
- [bhv_1up_hidden_in_pole_spawner_loop ](#bhv_1up_hidden_in_pole_spawner_loop )
- [bhv_1up_hidden_in_pole_trigger_loop ](#bhv_1up_hidden_in_pole_trigger_loop )
- [bhv_1up_hidden_loop ](#bhv_1up_hidden_loop )
- [bhv_1up_hidden_trigger_loop ](#bhv_1up_hidden_trigger_loop )
- [bhv_1up_init ](#bhv_1up_init )
- [bhv_1up_jump_on_approach_loop ](#bhv_1up_jump_on_approach_loop )
- [bhv_1up_loop ](#bhv_1up_loop )
- [bhv_1up_running_away_loop ](#bhv_1up_running_away_loop )
- [bhv_1up_sliding_loop ](#bhv_1up_sliding_loop )
- [bhv_1up_walking_loop ](#bhv_1up_walking_loop )
- [bhv_act_selector_init ](#bhv_act_selector_init )
- [bhv_act_selector_loop ](#bhv_act_selector_loop )
- [bhv_act_selector_star_type_loop ](#bhv_act_selector_star_type_loop )
- [bhv_activated_back_and_forth_platform_init ](#bhv_activated_back_and_forth_platform_init )
- [bhv_activated_back_and_forth_platform_update ](#bhv_activated_back_and_forth_platform_update )
- [bhv_alpha_boo_key_loop ](#bhv_alpha_boo_key_loop )
- [bhv_ambient_sounds_init ](#bhv_ambient_sounds_init )
- [bhv_animated_texture_loop ](#bhv_animated_texture_loop )
- [bhv_animates_on_floor_switch_press_init ](#bhv_animates_on_floor_switch_press_init )
- [bhv_animates_on_floor_switch_press_loop ](#bhv_animates_on_floor_switch_press_loop )
- [bhv_arrow_lift_loop ](#bhv_arrow_lift_loop )
- [bhv_bbh_tilting_trap_platform_loop ](#bhv_bbh_tilting_trap_platform_loop )
- [bhv_beta_boo_key_loop ](#bhv_beta_boo_key_loop )
- [bhv_beta_bowser_anchor_loop ](#bhv_beta_bowser_anchor_loop )
- [bhv_beta_chest_bottom_init ](#bhv_beta_chest_bottom_init )
- [bhv_beta_chest_bottom_loop ](#bhv_beta_chest_bottom_loop )
- [bhv_beta_chest_lid_loop ](#bhv_beta_chest_lid_loop )
- [bhv_beta_fish_splash_spawner_loop ](#bhv_beta_fish_splash_spawner_loop )
- [bhv_beta_holdable_object_init ](#bhv_beta_holdable_object_init )
- [bhv_beta_holdable_object_loop ](#bhv_beta_holdable_object_loop )
- [bhv_beta_moving_flames_loop ](#bhv_beta_moving_flames_loop )
- [bhv_beta_moving_flames_spawn_loop ](#bhv_beta_moving_flames_spawn_loop )
- [bhv_beta_trampoline_spring_loop ](#bhv_beta_trampoline_spring_loop )
- [bhv_beta_trampoline_top_loop ](#bhv_beta_trampoline_top_loop )
- [bhv_big_boo_loop ](#bhv_big_boo_loop )
- [bhv_big_boulder_generator_loop ](#bhv_big_boulder_generator_loop )
- [bhv_big_boulder_init ](#bhv_big_boulder_init )
- [bhv_big_boulder_loop ](#bhv_big_boulder_loop )
- [bhv_big_bully_init ](#bhv_big_bully_init )
- [bhv_big_bully_with_minions_init ](#bhv_big_bully_with_minions_init )
- [bhv_big_bully_with_minions_loop ](#bhv_big_bully_with_minions_loop )
- [bhv_bird_update ](#bhv_bird_update )
- [bhv_birds_sound_loop ](#bhv_birds_sound_loop )
- [bhv_bitfs_sinking_cage_platform_loop ](#bhv_bitfs_sinking_cage_platform_loop )
- [bhv_bitfs_sinking_platform_loop ](#bhv_bitfs_sinking_platform_loop )
- [bhv_black_smoke_bowser_loop ](#bhv_black_smoke_bowser_loop )
- [bhv_black_smoke_mario_loop ](#bhv_black_smoke_mario_loop )
- [bhv_black_smoke_upward_loop ](#bhv_black_smoke_upward_loop )
- [bhv_blue_bowser_flame_init ](#bhv_blue_bowser_flame_init )
- [bhv_blue_bowser_flame_loop ](#bhv_blue_bowser_flame_loop )
- [bhv_blue_coin_jumping_loop ](#bhv_blue_coin_jumping_loop )
- [bhv_blue_coin_sliding_jumping_init ](#bhv_blue_coin_sliding_jumping_init )
- [bhv_blue_coin_sliding_loop ](#bhv_blue_coin_sliding_loop )
- [bhv_blue_coin_switch_loop ](#bhv_blue_coin_switch_loop )
- [bhv_blue_fish_movement_loop ](#bhv_blue_fish_movement_loop )
- [bhv_blue_flames_group_loop ](#bhv_blue_flames_group_loop )
- [bhv_bob_pit_bowling_ball_init ](#bhv_bob_pit_bowling_ball_init )
- [bhv_bob_pit_bowling_ball_loop ](#bhv_bob_pit_bowling_ball_loop )
- [bhv_bobomb_anchor_mario_loop ](#bhv_bobomb_anchor_mario_loop )
- [bhv_bobomb_buddy_init ](#bhv_bobomb_buddy_init )
- [bhv_bobomb_buddy_loop ](#bhv_bobomb_buddy_loop )
- [bhv_bobomb_bully_death_smoke_init ](#bhv_bobomb_bully_death_smoke_init )
- [bhv_bobomb_explosion_bubble_init ](#bhv_bobomb_explosion_bubble_init )
- [bhv_bobomb_explosion_bubble_loop ](#bhv_bobomb_explosion_bubble_loop )
- [bhv_bobomb_fuse_smoke_init ](#bhv_bobomb_fuse_smoke_init )
- [bhv_bobomb_init ](#bhv_bobomb_init )
- [bhv_bobomb_loop ](#bhv_bobomb_loop )
- [bhv_boo_boss_spawned_bridge_loop ](#bhv_boo_boss_spawned_bridge_loop )
- [bhv_boo_cage_init ](#bhv_boo_cage_init )
- [bhv_boo_cage_loop ](#bhv_boo_cage_loop )
- [bhv_boo_in_castle_loop ](#bhv_boo_in_castle_loop )
- [bhv_boo_init ](#bhv_boo_init )
- [bhv_boo_loop ](#bhv_boo_loop )
- [bhv_boo_with_cage_init ](#bhv_boo_with_cage_init )
- [bhv_boo_with_cage_loop ](#bhv_boo_with_cage_loop )
- [bhv_book_switch_loop ](#bhv_book_switch_loop )
- [bhv_bookend_spawn_loop ](#bhv_bookend_spawn_loop )
- [bhv_bouncing_fireball_flame_loop ](#bhv_bouncing_fireball_flame_loop )
- [bhv_bouncing_fireball_loop ](#bhv_bouncing_fireball_loop )
- [bhv_bowling_ball_init ](#bhv_bowling_ball_init )
- [bhv_bowling_ball_loop ](#bhv_bowling_ball_loop )
- [bhv_bowser_body_anchor_init ](#bhv_bowser_body_anchor_init )
- [bhv_bowser_body_anchor_loop ](#bhv_bowser_body_anchor_loop )
- [bhv_bowser_bomb_explosion_loop ](#bhv_bowser_bomb_explosion_loop )
- [bhv_bowser_bomb_loop ](#bhv_bowser_bomb_loop )
- [bhv_bowser_bomb_smoke_loop ](#bhv_bowser_bomb_smoke_loop )
- [bhv_bowser_course_red_coin_star_loop ](#bhv_bowser_course_red_coin_star_loop )
- [bhv_bowser_flame_spawn_loop ](#bhv_bowser_flame_spawn_loop )
- [bhv_bowser_init ](#bhv_bowser_init )
- [bhv_bowser_key_course_exit_loop ](#bhv_bowser_key_course_exit_loop )
- [bhv_bowser_key_init ](#bhv_bowser_key_init )
- [bhv_bowser_key_loop ](#bhv_bowser_key_loop )
- [bhv_bowser_key_unlock_door_loop ](#bhv_bowser_key_unlock_door_loop )
- [bhv_bowser_loop ](#bhv_bowser_loop )
- [bhv_bowser_shock_wave_loop ](#bhv_bowser_shock_wave_loop )
- [bhv_bowser_tail_anchor_init ](#bhv_bowser_tail_anchor_init )
- [bhv_bowser_tail_anchor_loop ](#bhv_bowser_tail_anchor_loop )
- [bhv_bowsers_sub_loop ](#bhv_bowsers_sub_loop )
- [bhv_breakable_box_loop ](#bhv_breakable_box_loop )
- [bhv_breakable_box_small_init ](#bhv_breakable_box_small_init )
- [bhv_breakable_box_small_loop ](#bhv_breakable_box_small_loop )
- [bhv_bub_loop ](#bhv_bub_loop )
- [bhv_bub_spawner_loop ](#bhv_bub_spawner_loop )
- [bhv_bubba_loop ](#bhv_bubba_loop )
- [bhv_bubble_cannon_barrel_loop ](#bhv_bubble_cannon_barrel_loop )
- [bhv_bubble_maybe_loop ](#bhv_bubble_maybe_loop )
- [bhv_bubble_player_loop ](#bhv_bubble_player_loop )
- [bhv_bubble_splash_init ](#bhv_bubble_splash_init )
- [bhv_bubble_wave_init ](#bhv_bubble_wave_init )
- [bhv_bullet_bill_init ](#bhv_bullet_bill_init )
- [bhv_bullet_bill_loop ](#bhv_bullet_bill_loop )
- [bhv_bully_loop ](#bhv_bully_loop )
- [bhv_butterfly_init ](#bhv_butterfly_init )
- [bhv_butterfly_loop ](#bhv_butterfly_loop )
- [bhv_camera_lakitu_init ](#bhv_camera_lakitu_init )
- [bhv_camera_lakitu_update ](#bhv_camera_lakitu_update )
- [bhv_cannon_barrel_loop ](#bhv_cannon_barrel_loop )
- [bhv_cannon_base_loop ](#bhv_cannon_base_loop )
- [bhv_cannon_base_unused_loop ](#bhv_cannon_base_unused_loop )
- [bhv_cannon_closed_init ](#bhv_cannon_closed_init )
- [bhv_cannon_closed_loop ](#bhv_cannon_closed_loop )
- [bhv_cap_switch_loop ](#bhv_cap_switch_loop )
- [bhv_castle_cannon_grate_init ](#bhv_castle_cannon_grate_init )
- [bhv_castle_flag_init ](#bhv_castle_flag_init )
- [bhv_castle_floor_trap_init ](#bhv_castle_floor_trap_init )
- [bhv_castle_floor_trap_loop ](#bhv_castle_floor_trap_loop )
- [bhv_ccm_touched_star_spawn_loop ](#bhv_ccm_touched_star_spawn_loop )
- [bhv_celebration_star_init ](#bhv_celebration_star_init )
- [bhv_celebration_star_loop ](#bhv_celebration_star_loop )
- [bhv_celebration_star_sparkle_loop ](#bhv_celebration_star_sparkle_loop )
- [bhv_chain_chomp_chain_part_update ](#bhv_chain_chomp_chain_part_update )
- [bhv_chain_chomp_gate_init ](#bhv_chain_chomp_gate_init )
- [bhv_chain_chomp_gate_update ](#bhv_chain_chomp_gate_update )
- [bhv_chain_chomp_update ](#bhv_chain_chomp_update )
- [bhv_checkerboard_elevator_group_init ](#bhv_checkerboard_elevator_group_init )
- [bhv_checkerboard_elevator_group_loop ](#bhv_checkerboard_elevator_group_loop )
- [bhv_checkerboard_platform_init ](#bhv_checkerboard_platform_init )
- [bhv_checkerboard_platform_loop ](#bhv_checkerboard_platform_loop )
- [bhv_chuckya_anchor_mario_loop ](#bhv_chuckya_anchor_mario_loop )
- [bhv_chuckya_loop ](#bhv_chuckya_loop )
- [bhv_circling_amp_init ](#bhv_circling_amp_init )
- [bhv_circling_amp_loop ](#bhv_circling_amp_loop )
- [bhv_clam_loop ](#bhv_clam_loop )
- [bhv_cloud_part_update ](#bhv_cloud_part_update )
- [bhv_cloud_update ](#bhv_cloud_update )
- [bhv_coffin_loop ](#bhv_coffin_loop )
- [bhv_coffin_spawner_loop ](#bhv_coffin_spawner_loop )
- [bhv_coin_formation_init ](#bhv_coin_formation_init )
- [bhv_coin_formation_loop ](#bhv_coin_formation_loop )
- [bhv_coin_formation_spawn_loop ](#bhv_coin_formation_spawn_loop )
- [bhv_coin_init ](#bhv_coin_init )
- [bhv_coin_inside_boo_loop ](#bhv_coin_inside_boo_loop )
- [bhv_coin_loop ](#bhv_coin_loop )
- [bhv_coin_sparkles_loop ](#bhv_coin_sparkles_loop )
- [bhv_collect_star_init ](#bhv_collect_star_init )
- [bhv_collect_star_loop ](#bhv_collect_star_loop )
- [bhv_controllable_platform_init ](#bhv_controllable_platform_init )
- [bhv_controllable_platform_loop ](#bhv_controllable_platform_loop )
- [bhv_controllable_platform_sub_loop ](#bhv_controllable_platform_sub_loop )
- [bhv_courtyard_boo_triplet_init ](#bhv_courtyard_boo_triplet_init )
- [bhv_ddd_moving_pole_loop ](#bhv_ddd_moving_pole_loop )
- [bhv_ddd_pole_init ](#bhv_ddd_pole_init )
- [bhv_ddd_pole_update ](#bhv_ddd_pole_update )
- [bhv_ddd_warp_loop ](#bhv_ddd_warp_loop )
- [bhv_decorative_pendulum_init ](#bhv_decorative_pendulum_init )
- [bhv_decorative_pendulum_loop ](#bhv_decorative_pendulum_loop )
- [bhv_donut_platform_spawner_update ](#bhv_donut_platform_spawner_update )
- [bhv_donut_platform_update ](#bhv_donut_platform_update )
- [bhv_door_init ](#bhv_door_init )
- [bhv_door_loop ](#bhv_door_loop )
- [bhv_dorrie_update ](#bhv_dorrie_update )
- [bhv_elevator_init ](#bhv_elevator_init )
- [bhv_elevator_loop ](#bhv_elevator_loop )
- [bhv_end_birds_1_loop ](#bhv_end_birds_1_loop )
- [bhv_end_birds_2_loop ](#bhv_end_birds_2_loop )
- [bhv_enemy_lakitu_update ](#bhv_enemy_lakitu_update )
- [bhv_exclamation_box_init ](#bhv_exclamation_box_init )
- [bhv_exclamation_box_loop ](#bhv_exclamation_box_loop )
- [bhv_explosion_init ](#bhv_explosion_init )
- [bhv_explosion_loop ](#bhv_explosion_loop )
- [bhv_eyerok_boss_init ](#bhv_eyerok_boss_init )
- [bhv_eyerok_boss_loop ](#bhv_eyerok_boss_loop )
- [bhv_eyerok_hand_loop ](#bhv_eyerok_hand_loop )
- [bhv_fading_warp_loop ](#bhv_fading_warp_loop )
- [bhv_falling_bowser_platform_loop ](#bhv_falling_bowser_platform_loop )
- [bhv_falling_pillar_hitbox_loop ](#bhv_falling_pillar_hitbox_loop )
- [bhv_falling_pillar_init ](#bhv_falling_pillar_init )
- [bhv_falling_pillar_loop ](#bhv_falling_pillar_loop )
- [bhv_ferris_wheel_axle_init ](#bhv_ferris_wheel_axle_init )
- [bhv_ferris_wheel_platform_update ](#bhv_ferris_wheel_platform_update )
- [bhv_fire_piranha_plant_init ](#bhv_fire_piranha_plant_init )
- [bhv_fire_piranha_plant_update ](#bhv_fire_piranha_plant_update )
- [bhv_fire_spitter_update ](#bhv_fire_spitter_update )
- [bhv_fish_group_loop ](#bhv_fish_group_loop )
- [bhv_fish_loop ](#bhv_fish_loop )
- [bhv_fish_spawner_loop ](#bhv_fish_spawner_loop )
- [bhv_flame_bouncing_init ](#bhv_flame_bouncing_init )
- [bhv_flame_bouncing_loop ](#bhv_flame_bouncing_loop )
- [bhv_flame_bowser_init ](#bhv_flame_bowser_init )
- [bhv_flame_bowser_loop ](#bhv_flame_bowser_loop )
- [bhv_flame_floating_landing_init ](#bhv_flame_floating_landing_init )
- [bhv_flame_floating_landing_loop ](#bhv_flame_floating_landing_loop )
- [bhv_flame_large_burning_out_init ](#bhv_flame_large_burning_out_init )
- [bhv_flame_mario_loop ](#bhv_flame_mario_loop )
- [bhv_flame_moving_forward_growing_init ](#bhv_flame_moving_forward_growing_init )
- [bhv_flame_moving_forward_growing_loop ](#bhv_flame_moving_forward_growing_loop )
- [bhv_flamethrower_flame_loop ](#bhv_flamethrower_flame_loop )
- [bhv_flamethrower_loop ](#bhv_flamethrower_loop )
- [bhv_floating_platform_loop ](#bhv_floating_platform_loop )
- [bhv_floor_trap_in_castle_loop ](#bhv_floor_trap_in_castle_loop )
- [bhv_fly_guy_flame_loop ](#bhv_fly_guy_flame_loop )
- [bhv_fly_guy_update ](#bhv_fly_guy_update )
- [bhv_flying_bookend_loop ](#bhv_flying_bookend_loop )
- [bhv_free_bowling_ball_init ](#bhv_free_bowling_ball_init )
- [bhv_free_bowling_ball_loop ](#bhv_free_bowling_ball_loop )
- [bhv_generic_bowling_ball_spawner_init ](#bhv_generic_bowling_ball_spawner_init )
- [bhv_generic_bowling_ball_spawner_loop ](#bhv_generic_bowling_ball_spawner_loop )
- [bhv_giant_pole_loop ](#bhv_giant_pole_loop )
- [bhv_golden_coin_sparkles_loop ](#bhv_golden_coin_sparkles_loop )
- [bhv_goomba_init ](#bhv_goomba_init )
- [bhv_goomba_triplet_spawner_update ](#bhv_goomba_triplet_spawner_update )
- [bhv_goomba_update ](#bhv_goomba_update )
- [bhv_grand_star_init ](#bhv_grand_star_init )
- [bhv_grand_star_loop ](#bhv_grand_star_loop )
- [bhv_grindel_thwomp_loop ](#bhv_grindel_thwomp_loop )
- [bhv_ground_sand_init ](#bhv_ground_sand_init )
- [bhv_ground_snow_init ](#bhv_ground_snow_init )
- [bhv_haunted_bookshelf_loop ](#bhv_haunted_bookshelf_loop )
- [bhv_haunted_bookshelf_manager_loop ](#bhv_haunted_bookshelf_manager_loop )
- [bhv_haunted_chair_init ](#bhv_haunted_chair_init )
- [bhv_haunted_chair_loop ](#bhv_haunted_chair_loop )
- [bhv_heave_ho_loop ](#bhv_heave_ho_loop )
- [bhv_heave_ho_throw_mario_loop ](#bhv_heave_ho_throw_mario_loop )
- [bhv_hidden_blue_coin_loop ](#bhv_hidden_blue_coin_loop )
- [bhv_hidden_object_loop ](#bhv_hidden_object_loop )
- [bhv_hidden_red_coin_star_init ](#bhv_hidden_red_coin_star_init )
- [bhv_hidden_red_coin_star_loop ](#bhv_hidden_red_coin_star_loop )
- [bhv_hidden_star_init ](#bhv_hidden_star_init )
- [bhv_hidden_star_loop ](#bhv_hidden_star_loop )
- [bhv_hidden_star_trigger_loop ](#bhv_hidden_star_trigger_loop )
- [bhv_homing_amp_init ](#bhv_homing_amp_init )
- [bhv_homing_amp_loop ](#bhv_homing_amp_loop )
- [bhv_hoot_init ](#bhv_hoot_init )
- [bhv_hoot_loop ](#bhv_hoot_loop )
- [bhv_horizontal_grindel_init ](#bhv_horizontal_grindel_init )
- [bhv_horizontal_grindel_update ](#bhv_horizontal_grindel_update )
- [bhv_idle_water_wave_loop ](#bhv_idle_water_wave_loop )
- [bhv_init_changing_water_level_loop ](#bhv_init_changing_water_level_loop )
- [bhv_intro_lakitu_loop ](#bhv_intro_lakitu_loop )
- [bhv_intro_peach_loop ](#bhv_intro_peach_loop )
- [bhv_intro_scene_loop ](#bhv_intro_scene_loop )
- [bhv_invisible_objects_under_bridge_init ](#bhv_invisible_objects_under_bridge_init )
- [bhv_invisible_objects_under_bridge_loop ](#bhv_invisible_objects_under_bridge_loop )
- [bhv_jet_stream_loop ](#bhv_jet_stream_loop )
- [bhv_jet_stream_ring_spawner_loop ](#bhv_jet_stream_ring_spawner_loop )
- [bhv_jet_stream_water_ring_init ](#bhv_jet_stream_water_ring_init )
- [bhv_jet_stream_water_ring_loop ](#bhv_jet_stream_water_ring_loop )
- [bhv_jrb_floating_box_loop ](#bhv_jrb_floating_box_loop )
- [bhv_jrb_sliding_box_loop ](#bhv_jrb_sliding_box_loop )
- [bhv_jumping_box_loop ](#bhv_jumping_box_loop )
- [bhv_kickable_board_loop ](#bhv_kickable_board_loop )
- [bhv_king_bobomb_loop ](#bhv_king_bobomb_loop )
- [bhv_klepto_init ](#bhv_klepto_init )
- [bhv_klepto_update ](#bhv_klepto_update )
- [bhv_koopa_init ](#bhv_koopa_init )
- [bhv_koopa_race_endpoint_update ](#bhv_koopa_race_endpoint_update )
- [bhv_koopa_shell_flame_loop ](#bhv_koopa_shell_flame_loop )
- [bhv_koopa_shell_loop ](#bhv_koopa_shell_loop )
- [bhv_koopa_shell_underwater_loop ](#bhv_koopa_shell_underwater_loop )
- [bhv_koopa_update ](#bhv_koopa_update )
- [bhv_large_bomp_init ](#bhv_large_bomp_init )
- [bhv_large_bomp_loop ](#bhv_large_bomp_loop )
- [bhv_lll_bowser_puzzle_loop ](#bhv_lll_bowser_puzzle_loop )
- [bhv_lll_bowser_puzzle_piece_loop ](#bhv_lll_bowser_puzzle_piece_loop )
- [bhv_lll_drawbridge_loop ](#bhv_lll_drawbridge_loop )
- [bhv_lll_drawbridge_spawner_init ](#bhv_lll_drawbridge_spawner_init )
- [bhv_lll_drawbridge_spawner_loop ](#bhv_lll_drawbridge_spawner_loop )
- [bhv_lll_floating_wood_bridge_loop ](#bhv_lll_floating_wood_bridge_loop )
- [bhv_lll_moving_octagonal_mesh_platform_loop ](#bhv_lll_moving_octagonal_mesh_platform_loop )
- [bhv_lll_rolling_log_init ](#bhv_lll_rolling_log_init )
- [bhv_lll_rotating_block_fire_bars_loop ](#bhv_lll_rotating_block_fire_bars_loop )
- [bhv_lll_rotating_hex_flame_loop ](#bhv_lll_rotating_hex_flame_loop )
- [bhv_lll_rotating_hexagonal_ring_loop ](#bhv_lll_rotating_hexagonal_ring_loop )
- [bhv_lll_sinking_rectangular_platform_loop ](#bhv_lll_sinking_rectangular_platform_loop )
- [bhv_lll_sinking_rock_block_loop ](#bhv_lll_sinking_rock_block_loop )
- [bhv_lll_sinking_square_platforms_loop ](#bhv_lll_sinking_square_platforms_loop )
- [bhv_lll_wood_piece_loop ](#bhv_lll_wood_piece_loop )
- [bhv_mad_piano_update ](#bhv_mad_piano_update )
- [bhv_manta_ray_init ](#bhv_manta_ray_init )
- [bhv_manta_ray_loop ](#bhv_manta_ray_loop )
- [bhv_manta_ray_water_ring_init ](#bhv_manta_ray_water_ring_init )
- [bhv_manta_ray_water_ring_loop ](#bhv_manta_ray_water_ring_loop )
- [bhv_menu_button_init ](#bhv_menu_button_init )
- [bhv_menu_button_loop ](#bhv_menu_button_loop )
- [bhv_menu_button_manager_init ](#bhv_menu_button_manager_init )
- [bhv_menu_button_manager_loop ](#bhv_menu_button_manager_loop )
- [bhv_merry_go_round_boo_manager_loop ](#bhv_merry_go_round_boo_manager_loop )
- [bhv_merry_go_round_loop ](#bhv_merry_go_round_loop )
- [bhv_metal_cap_init ](#bhv_metal_cap_init )
- [bhv_metal_cap_loop ](#bhv_metal_cap_loop )
- [bhv_mips_init ](#bhv_mips_init )
- [bhv_mips_loop ](#bhv_mips_loop )
- [bhv_moat_grills_loop ](#bhv_moat_grills_loop )
- [bhv_moneybag_hidden_loop ](#bhv_moneybag_hidden_loop )
- [bhv_moneybag_init ](#bhv_moneybag_init )
- [bhv_moneybag_loop ](#bhv_moneybag_loop )
- [bhv_monty_mole_hole_update ](#bhv_monty_mole_hole_update )
- [bhv_monty_mole_init ](#bhv_monty_mole_init )
- [bhv_monty_mole_rock_update ](#bhv_monty_mole_rock_update )
- [bhv_monty_mole_update ](#bhv_monty_mole_update )
- [bhv_moving_blue_coin_init ](#bhv_moving_blue_coin_init )
- [bhv_moving_blue_coin_loop ](#bhv_moving_blue_coin_loop )
- [bhv_moving_yellow_coin_init ](#bhv_moving_yellow_coin_init )
- [bhv_moving_yellow_coin_loop ](#bhv_moving_yellow_coin_loop )
- [bhv_mr_blizzard_init ](#bhv_mr_blizzard_init )
- [bhv_mr_blizzard_snowball ](#bhv_mr_blizzard_snowball )
- [bhv_mr_blizzard_update ](#bhv_mr_blizzard_update )
- [bhv_mr_i_body_loop ](#bhv_mr_i_body_loop )
- [bhv_mr_i_loop ](#bhv_mr_i_loop )
- [bhv_mr_i_particle_loop ](#bhv_mr_i_particle_loop )
- [bhv_normal_cap_init ](#bhv_normal_cap_init )
- [bhv_normal_cap_loop ](#bhv_normal_cap_loop )
- [bhv_object_bubble_init ](#bhv_object_bubble_init )
- [bhv_object_bubble_loop ](#bhv_object_bubble_loop )
- [bhv_object_water_wave_init ](#bhv_object_water_wave_init )
- [bhv_object_water_wave_loop ](#bhv_object_water_wave_loop )
- [bhv_openable_cage_door_loop ](#bhv_openable_cage_door_loop )
- [bhv_openable_grill_loop ](#bhv_openable_grill_loop )
- [bhv_orange_number_init ](#bhv_orange_number_init )
- [bhv_orange_number_loop ](#bhv_orange_number_loop )
- [bhv_particle_init ](#bhv_particle_init )
- [bhv_particle_loop ](#bhv_particle_loop )
- [bhv_penguin_race_finish_line_update ](#bhv_penguin_race_finish_line_update )
- [bhv_penguin_race_shortcut_check_update ](#bhv_penguin_race_shortcut_check_update )
- [bhv_piranha_particle_loop ](#bhv_piranha_particle_loop )
- [bhv_piranha_plant_bubble_loop ](#bhv_piranha_plant_bubble_loop )
- [bhv_piranha_plant_loop ](#bhv_piranha_plant_loop )
- [bhv_piranha_plant_waking_bubbles_loop ](#bhv_piranha_plant_waking_bubbles_loop )
- [bhv_platform_normals_init ](#bhv_platform_normals_init )
- [bhv_platform_on_track_init ](#bhv_platform_on_track_init )
- [bhv_platform_on_track_update ](#bhv_platform_on_track_update )
- [bhv_play_music_track_when_touched_loop ](#bhv_play_music_track_when_touched_loop )
- [bhv_pokey_body_part_update ](#bhv_pokey_body_part_update )
- [bhv_pokey_update ](#bhv_pokey_update )
- [bhv_pole_base_loop ](#bhv_pole_base_loop )
- [bhv_pole_init ](#bhv_pole_init )
- [bhv_pound_tiny_star_particle_init ](#bhv_pound_tiny_star_particle_init )
- [bhv_pound_tiny_star_particle_loop ](#bhv_pound_tiny_star_particle_loop )
- [bhv_pound_white_puffs_init ](#bhv_pound_white_puffs_init )
- [bhv_punch_tiny_triangle_init ](#bhv_punch_tiny_triangle_init )
- [bhv_punch_tiny_triangle_loop ](#bhv_punch_tiny_triangle_loop )
- [bhv_purple_switch_loop ](#bhv_purple_switch_loop )
- [bhv_pushable_loop ](#bhv_pushable_loop )
- [bhv_pyramid_elevator_init ](#bhv_pyramid_elevator_init )
- [bhv_pyramid_elevator_loop ](#bhv_pyramid_elevator_loop )
- [bhv_pyramid_elevator_trajectory_marker_ball_loop ](#bhv_pyramid_elevator_trajectory_marker_ball_loop )
- [bhv_pyramid_pillar_touch_detector_loop ](#bhv_pyramid_pillar_touch_detector_loop )
- [bhv_pyramid_top_fragment_init ](#bhv_pyramid_top_fragment_init )
- [bhv_pyramid_top_fragment_loop ](#bhv_pyramid_top_fragment_loop )
- [bhv_pyramid_top_init ](#bhv_pyramid_top_init )
- [bhv_pyramid_top_loop ](#bhv_pyramid_top_loop )
- [bhv_racing_penguin_init ](#bhv_racing_penguin_init )
- [bhv_racing_penguin_update ](#bhv_racing_penguin_update )
- [bhv_recovery_heart_loop ](#bhv_recovery_heart_loop )
- [bhv_red_coin_init ](#bhv_red_coin_init )
- [bhv_red_coin_loop ](#bhv_red_coin_loop )
- [bhv_red_coin_star_marker_init ](#bhv_red_coin_star_marker_init )
- [bhv_respawner_loop ](#bhv_respawner_loop )
- [bhv_rolling_log_loop ](#bhv_rolling_log_loop )
- [bhv_rotating_clock_arm_loop ](#bhv_rotating_clock_arm_loop )
- [bhv_rotating_exclamation_box_loop ](#bhv_rotating_exclamation_box_loop )
- [bhv_rotating_octagonal_plat_init ](#bhv_rotating_octagonal_plat_init )
- [bhv_rotating_octagonal_plat_loop ](#bhv_rotating_octagonal_plat_loop )
- [bhv_rotating_platform_loop ](#bhv_rotating_platform_loop )
- [bhv_rr_cruiser_wing_init ](#bhv_rr_cruiser_wing_init )
- [bhv_rr_cruiser_wing_loop ](#bhv_rr_cruiser_wing_loop )
- [bhv_rr_rotating_bridge_platform_loop ](#bhv_rr_rotating_bridge_platform_loop )
- [bhv_sand_sound_loop ](#bhv_sand_sound_loop )
- [bhv_scuttlebug_loop ](#bhv_scuttlebug_loop )
- [bhv_scuttlebug_spawn_loop ](#bhv_scuttlebug_spawn_loop )
- [bhv_seaweed_bundle_init ](#bhv_seaweed_bundle_init )
- [bhv_seaweed_init ](#bhv_seaweed_init )
- [bhv_seesaw_platform_init ](#bhv_seesaw_platform_init )
- [bhv_seesaw_platform_update ](#bhv_seesaw_platform_update )
- [bhv_shallow_water_splash_init ](#bhv_shallow_water_splash_init )
- [bhv_ship_part_3_loop ](#bhv_ship_part_3_loop )
- [bhv_skeeter_update ](#bhv_skeeter_update )
- [bhv_skeeter_wave_update ](#bhv_skeeter_wave_update )
- [bhv_sl_snowman_wind_loop ](#bhv_sl_snowman_wind_loop )
- [bhv_sl_walking_penguin_loop ](#bhv_sl_walking_penguin_loop )
- [bhv_sliding_plat_2_init ](#bhv_sliding_plat_2_init )
- [bhv_sliding_plat_2_loop ](#bhv_sliding_plat_2_loop )
- [bhv_sliding_snow_mound_loop ](#bhv_sliding_snow_mound_loop )
- [bhv_small_bomp_init ](#bhv_small_bomp_init )
- [bhv_small_bomp_loop ](#bhv_small_bomp_loop )
- [bhv_small_bubbles_loop ](#bhv_small_bubbles_loop )
- [bhv_small_bully_init ](#bhv_small_bully_init )
- [bhv_small_penguin_loop ](#bhv_small_penguin_loop )
- [bhv_small_piranha_flame_loop ](#bhv_small_piranha_flame_loop )
- [bhv_small_water_wave_loop ](#bhv_small_water_wave_loop )
- [bhv_snow_leaf_particle_spawn_init ](#bhv_snow_leaf_particle_spawn_init )
- [bhv_snow_mound_spawn_loop ](#bhv_snow_mound_spawn_loop )
- [bhv_snowmans_body_checkpoint_loop ](#bhv_snowmans_body_checkpoint_loop )
- [bhv_snowmans_bottom_init ](#bhv_snowmans_bottom_init )
- [bhv_snowmans_bottom_loop ](#bhv_snowmans_bottom_loop )
- [bhv_snowmans_head_init ](#bhv_snowmans_head_init )
- [bhv_snowmans_head_loop ](#bhv_snowmans_head_loop )
- [bhv_snufit_balls_loop ](#bhv_snufit_balls_loop )
- [bhv_snufit_loop ](#bhv_snufit_loop )
- [bhv_sound_spawner_init ](#bhv_sound_spawner_init )
- [bhv_sparkle_spawn_loop ](#bhv_sparkle_spawn_loop )
- [bhv_spawn_star_no_level_exit ](#bhv_spawn_star_no_level_exit )
- [bhv_spawned_star_init ](#bhv_spawned_star_init )
- [bhv_spawned_star_loop ](#bhv_spawned_star_loop )
- [bhv_spindel_init ](#bhv_spindel_init )
- [bhv_spindel_loop ](#bhv_spindel_loop )
- [bhv_spindrift_loop ](#bhv_spindrift_loop )
- [bhv_spiny_update ](#bhv_spiny_update )
- [bhv_squarish_path_moving_loop ](#bhv_squarish_path_moving_loop )
- [bhv_squarish_path_parent_init ](#bhv_squarish_path_parent_init )
- [bhv_squarish_path_parent_loop ](#bhv_squarish_path_parent_loop )
- [bhv_squishable_platform_loop ](#bhv_squishable_platform_loop )
- [bhv_ssl_moving_pyramid_wall_init ](#bhv_ssl_moving_pyramid_wall_init )
- [bhv_ssl_moving_pyramid_wall_loop ](#bhv_ssl_moving_pyramid_wall_loop )
- [bhv_star_door_loop ](#bhv_star_door_loop )
- [bhv_star_door_loop_2 ](#bhv_star_door_loop_2 )
- [bhv_star_key_collection_puff_spawner_loop ](#bhv_star_key_collection_puff_spawner_loop )
- [bhv_star_spawn_init ](#bhv_star_spawn_init )
- [bhv_star_spawn_loop ](#bhv_star_spawn_loop )
- [bhv_static_checkered_platform_loop ](#bhv_static_checkered_platform_loop )
- [bhv_strong_wind_particle_loop ](#bhv_strong_wind_particle_loop )
- [bhv_sunken_ship_part_loop ](#bhv_sunken_ship_part_loop )
- [bhv_sushi_shark_collision_loop ](#bhv_sushi_shark_collision_loop )
- [bhv_sushi_shark_loop ](#bhv_sushi_shark_loop )
- [bhv_swing_platform_init ](#bhv_swing_platform_init )
- [bhv_swing_platform_update ](#bhv_swing_platform_update )
- [bhv_swoop_update ](#bhv_swoop_update )
- [bhv_tank_fish_group_loop ](#bhv_tank_fish_group_loop )
- [bhv_temp_coin_loop ](#bhv_temp_coin_loop )
- [bhv_thi_bowling_ball_spawner_loop ](#bhv_thi_bowling_ball_spawner_loop )
- [bhv_thi_huge_island_top_loop ](#bhv_thi_huge_island_top_loop )
- [bhv_thi_tiny_island_top_loop ](#bhv_thi_tiny_island_top_loop )
- [bhv_tilting_bowser_lava_platform_init ](#bhv_tilting_bowser_lava_platform_init )
- [bhv_tilting_inverted_pyramid_loop ](#bhv_tilting_inverted_pyramid_loop )
- [bhv_tiny_star_particles_init ](#bhv_tiny_star_particles_init )
- [bhv_tower_door_loop ](#bhv_tower_door_loop )
- [bhv_tower_platform_group_init ](#bhv_tower_platform_group_init )
- [bhv_tower_platform_group_loop ](#bhv_tower_platform_group_loop )
- [bhv_tox_box_loop ](#bhv_tox_box_loop )
- [bhv_track_ball_update ](#bhv_track_ball_update )
- [bhv_treasure_chest_bottom_init ](#bhv_treasure_chest_bottom_init )
- [bhv_treasure_chest_bottom_loop ](#bhv_treasure_chest_bottom_loop )
- [bhv_treasure_chest_init ](#bhv_treasure_chest_init )
- [bhv_treasure_chest_jrb_init ](#bhv_treasure_chest_jrb_init )
- [bhv_treasure_chest_jrb_loop ](#bhv_treasure_chest_jrb_loop )
- [bhv_treasure_chest_loop ](#bhv_treasure_chest_loop )
- [bhv_treasure_chest_ship_init ](#bhv_treasure_chest_ship_init )
- [bhv_treasure_chest_ship_loop ](#bhv_treasure_chest_ship_loop )
- [bhv_treasure_chest_top_loop ](#bhv_treasure_chest_top_loop )
- [bhv_tree_snow_or_leaf_loop ](#bhv_tree_snow_or_leaf_loop )
- [bhv_triplet_butterfly_update ](#bhv_triplet_butterfly_update )
- [bhv_ttc_2d_rotator_init ](#bhv_ttc_2d_rotator_init )
- [bhv_ttc_2d_rotator_update ](#bhv_ttc_2d_rotator_update )
- [bhv_ttc_cog_init ](#bhv_ttc_cog_init )
- [bhv_ttc_cog_update ](#bhv_ttc_cog_update )
- [bhv_ttc_elevator_init ](#bhv_ttc_elevator_init )
- [bhv_ttc_elevator_update ](#bhv_ttc_elevator_update )
- [bhv_ttc_moving_bar_init ](#bhv_ttc_moving_bar_init )
- [bhv_ttc_moving_bar_update ](#bhv_ttc_moving_bar_update )
- [bhv_ttc_pendulum_init ](#bhv_ttc_pendulum_init )
- [bhv_ttc_pendulum_update ](#bhv_ttc_pendulum_update )
- [bhv_ttc_pit_block_init ](#bhv_ttc_pit_block_init )
- [bhv_ttc_pit_block_update ](#bhv_ttc_pit_block_update )
- [bhv_ttc_rotating_solid_init ](#bhv_ttc_rotating_solid_init )
- [bhv_ttc_rotating_solid_update ](#bhv_ttc_rotating_solid_update )
- [bhv_ttc_spinner_update ](#bhv_ttc_spinner_update )
- [bhv_ttc_treadmill_init ](#bhv_ttc_treadmill_init )
- [bhv_ttc_treadmill_update ](#bhv_ttc_treadmill_update )
- [bhv_ttm_rolling_log_init ](#bhv_ttm_rolling_log_init )
- [bhv_tumbling_bridge_loop ](#bhv_tumbling_bridge_loop )
- [bhv_tumbling_bridge_platform_loop ](#bhv_tumbling_bridge_platform_loop )
- [bhv_tuxies_mother_loop ](#bhv_tuxies_mother_loop )
- [bhv_tweester_loop ](#bhv_tweester_loop )
- [bhv_tweester_sand_particle_loop ](#bhv_tweester_sand_particle_loop )
- [bhv_ukiki_cage_loop ](#bhv_ukiki_cage_loop )
- [bhv_ukiki_cage_star_loop ](#bhv_ukiki_cage_star_loop )
- [bhv_ukiki_init ](#bhv_ukiki_init )
- [bhv_ukiki_loop ](#bhv_ukiki_loop )
- [bhv_unagi_init ](#bhv_unagi_init )
- [bhv_unagi_loop ](#bhv_unagi_loop )
- [bhv_unagi_subobject_loop ](#bhv_unagi_subobject_loop )
- [bhv_unused_particle_spawn_loop ](#bhv_unused_particle_spawn_loop )
- [bhv_unused_poundable_platform ](#bhv_unused_poundable_platform )
- [bhv_vanish_cap_init ](#bhv_vanish_cap_init )
- [bhv_volcano_flames_loop ](#bhv_volcano_flames_loop )
- [bhv_volcano_sound_loop ](#bhv_volcano_sound_loop )
- [bhv_volcano_trap_loop ](#bhv_volcano_trap_loop )
- [bhv_wall_tiny_star_particle_loop ](#bhv_wall_tiny_star_particle_loop )
- [bhv_warp_loop ](#bhv_warp_loop )
- [bhv_water_air_bubble_init ](#bhv_water_air_bubble_init )
- [bhv_water_air_bubble_loop ](#bhv_water_air_bubble_loop )
- [bhv_water_bomb_cannon_loop ](#bhv_water_bomb_cannon_loop )
- [bhv_water_bomb_shadow_update ](#bhv_water_bomb_shadow_update )
- [bhv_water_bomb_spawner_update ](#bhv_water_bomb_spawner_update )
- [bhv_water_bomb_update ](#bhv_water_bomb_update )
- [bhv_water_droplet_loop ](#bhv_water_droplet_loop )
- [bhv_water_droplet_splash_init ](#bhv_water_droplet_splash_init )
- [bhv_water_level_diamond_loop ](#bhv_water_level_diamond_loop )
- [bhv_water_level_pillar_init ](#bhv_water_level_pillar_init )
- [bhv_water_level_pillar_loop ](#bhv_water_level_pillar_loop )
- [bhv_water_mist_2_loop ](#bhv_water_mist_2_loop )
- [bhv_water_mist_loop ](#bhv_water_mist_loop )
- [bhv_water_mist_spawn_loop ](#bhv_water_mist_spawn_loop )
- [bhv_water_splash_spawn_droplets ](#bhv_water_splash_spawn_droplets )
- [bhv_water_waves_init ](#bhv_water_waves_init )
- [bhv_waterfall_sound_loop ](#bhv_waterfall_sound_loop )
- [bhv_wave_trail_shrink ](#bhv_wave_trail_shrink )
- [bhv_wdw_express_elevator_loop ](#bhv_wdw_express_elevator_loop )
- [bhv_wf_breakable_wall_loop ](#bhv_wf_breakable_wall_loop )
- [bhv_wf_elevator_tower_platform_loop ](#bhv_wf_elevator_tower_platform_loop )
- [bhv_wf_rotating_wooden_platform_init ](#bhv_wf_rotating_wooden_platform_init )
- [bhv_wf_rotating_wooden_platform_loop ](#bhv_wf_rotating_wooden_platform_loop )
- [bhv_wf_sliding_platform_init ](#bhv_wf_sliding_platform_init )
- [bhv_wf_sliding_platform_loop ](#bhv_wf_sliding_platform_loop )
- [bhv_wf_sliding_tower_platform_loop ](#bhv_wf_sliding_tower_platform_loop )
- [bhv_wf_solid_tower_platform_loop ](#bhv_wf_solid_tower_platform_loop )
- [bhv_whirlpool_init ](#bhv_whirlpool_init )
- [bhv_whirlpool_loop ](#bhv_whirlpool_loop )
- [bhv_white_puff_1_loop ](#bhv_white_puff_1_loop )
- [bhv_white_puff_2_loop ](#bhv_white_puff_2_loop )
- [bhv_white_puff_exploding_loop ](#bhv_white_puff_exploding_loop )
- [bhv_white_puff_smoke_init ](#bhv_white_puff_smoke_init )
- [bhv_whomp_loop ](#bhv_whomp_loop )
- [bhv_wiggler_body_part_update ](#bhv_wiggler_body_part_update )
- [bhv_wiggler_update ](#bhv_wiggler_update )
- [bhv_wind_loop ](#bhv_wind_loop )
- [bhv_wing_cap_init ](#bhv_wing_cap_init )
- [bhv_wing_vanish_cap_loop ](#bhv_wing_vanish_cap_loop )
- [bhv_wooden_post_update ](#bhv_wooden_post_update )
- [bhv_yellow_coin_init ](#bhv_yellow_coin_init )
- [bhv_yellow_coin_loop ](#bhv_yellow_coin_loop )
- [bhv_yoshi_init ](#bhv_yoshi_init )
- [bhv_yoshi_loop ](#bhv_yoshi_loop )
- [check_if_moving_over_floor ](#check_if_moving_over_floor )
- [clear_particle_flags ](#clear_particle_flags )
- [common_anchor_mario_behavior ](#common_anchor_mario_behavior )
- [cur_obj_spawn_strong_wind_particles ](#cur_obj_spawn_strong_wind_particles )
- [mario_moving_fast_enough_to_make_piranha_plant_bite ](#mario_moving_fast_enough_to_make_piranha_plant_bite )
- [obj_set_secondary_camera_focus ](#obj_set_secondary_camera_focus )
- [play_penguin_walking_sound ](#play_penguin_walking_sound )
- [spawn_default_star ](#spawn_default_star )
- [spawn_mist_from_global ](#spawn_mist_from_global )
- [spawn_mist_particles_variable ](#spawn_mist_particles_variable )
- [spawn_no_exit_star ](#spawn_no_exit_star )
- [spawn_red_coin_cutscene_star ](#spawn_red_coin_cutscene_star )
- [spawn_triangle_break_particles ](#spawn_triangle_break_particles )
- [spawn_wind_particles ](#spawn_wind_particles )
- [tox_box_move ](#tox_box_move )
- [update_angle_from_move_flags ](#update_angle_from_move_flags )
- [vec3f_copy_2 ](#vec3f_copy_2 )
< br / >
2022-02-22 06:46:39 +00:00
- behavior_table.h
2022-02-23 02:29:30 +00:00
- [get_behavior_from_id ](#get_behavior_from_id )
2022-04-06 08:36:33 +00:00
- [get_behavior_name_from_id ](#get_behavior_name_from_id )
2022-02-23 02:29:30 +00:00
- [get_id_from_behavior ](#get_id_from_behavior )
2022-04-06 08:36:33 +00:00
- [get_id_from_behavior_name ](#get_id_from_behavior_name )
- [get_id_from_vanilla_behavior ](#get_id_from_vanilla_behavior )
2022-02-22 06:46:39 +00:00
< br / >
2022-01-30 06:47:22 +00:00
- camera.h
2022-03-26 06:46:37 +00:00
- [approach_camera_height ](#approach_camera_height )
- [approach_f32_asymptotic ](#approach_f32_asymptotic )
- [approach_f32_asymptotic_bool ](#approach_f32_asymptotic_bool )
- [approach_s16_asymptotic ](#approach_s16_asymptotic )
- [approach_s16_asymptotic_bool ](#approach_s16_asymptotic_bool )
- [approach_vec3f_asymptotic ](#approach_vec3f_asymptotic )
- [calc_abs_dist ](#calc_abs_dist )
- [calc_hor_dist ](#calc_hor_dist )
- [calculate_angles ](#calculate_angles )
- [calculate_pitch ](#calculate_pitch )
- [calculate_yaw ](#calculate_yaw )
- [cam_select_alt_mode ](#cam_select_alt_mode )
- [camera_approach_f32_symmetric ](#camera_approach_f32_symmetric )
- [camera_approach_f32_symmetric_bool ](#camera_approach_f32_symmetric_bool )
- [camera_approach_s16_symmetric_bool ](#camera_approach_s16_symmetric_bool )
- [camera_course_processing ](#camera_course_processing )
2022-04-10 08:55:11 +00:00
- [camera_set_use_course_specific_settings ](#camera_set_use_course_specific_settings )
2022-03-26 06:46:37 +00:00
- [clamp_pitch ](#clamp_pitch )
- [clamp_positions_and_find_yaw ](#clamp_positions_and_find_yaw )
- [collide_with_walls ](#collide_with_walls )
- [cutscene_object ](#cutscene_object )
- [cutscene_object_with_dialog ](#cutscene_object_with_dialog )
- [cutscene_object_without_dialog ](#cutscene_object_without_dialog )
- [cutscene_set_fov_shake_preset ](#cutscene_set_fov_shake_preset )
- [cutscene_spawn_obj ](#cutscene_spawn_obj )
- [find_c_buttons_pressed ](#find_c_buttons_pressed )
- [find_mario_floor_and_ceil ](#find_mario_floor_and_ceil )
- [get_cutscene_from_mario_status ](#get_cutscene_from_mario_status )
- [handle_c_button_movement ](#handle_c_button_movement )
- [is_range_behind_surface ](#is_range_behind_surface )
- [is_within_100_units_of_mario ](#is_within_100_units_of_mario )
- [move_mario_head_c_up ](#move_mario_head_c_up )
- [next_lakitu_state ](#next_lakitu_state )
- [obj_rotate_towards_point ](#obj_rotate_towards_point )
- [object_pos_to_vec3f ](#object_pos_to_vec3f )
- [offset_rotated ](#offset_rotated )
- [offset_yaw_outward_radial ](#offset_yaw_outward_radial )
- [play_camera_buzz_if_c_sideways ](#play_camera_buzz_if_c_sideways )
- [play_camera_buzz_if_cbutton ](#play_camera_buzz_if_cbutton )
- [play_camera_buzz_if_cdown ](#play_camera_buzz_if_cdown )
- [play_cutscene ](#play_cutscene )
- [play_sound_button_change_blocked ](#play_sound_button_change_blocked )
- [play_sound_cbutton_down ](#play_sound_cbutton_down )
- [play_sound_cbutton_side ](#play_sound_cbutton_side )
- [play_sound_cbutton_up ](#play_sound_cbutton_up )
- [play_sound_if_cam_switched_to_lakitu_or_mario ](#play_sound_if_cam_switched_to_lakitu_or_mario )
- [play_sound_rbutton_changed ](#play_sound_rbutton_changed )
- [radial_camera_input ](#radial_camera_input )
- [random_vec3s ](#random_vec3s )
- [reset_camera ](#reset_camera )
- [resolve_geometry_collisions ](#resolve_geometry_collisions )
- [rotate_camera_around_walls ](#rotate_camera_around_walls )
- [rotate_in_xz ](#rotate_in_xz )
- [rotate_in_yz ](#rotate_in_yz )
- [scale_along_line ](#scale_along_line )
- [select_mario_cam_mode ](#select_mario_cam_mode )
- [set_cam_angle ](#set_cam_angle )
2022-03-01 20:06:06 +00:00
- [set_camera_mode ](#set_camera_mode )
- [set_camera_mode_fixed ](#set_camera_mode_fixed )
2022-02-03 08:41:07 +00:00
- [set_camera_pitch_shake ](#set_camera_pitch_shake )
- [set_camera_roll_shake ](#set_camera_roll_shake )
2022-01-30 06:47:22 +00:00
- [set_camera_shake_from_hit ](#set_camera_shake_from_hit )
- [set_camera_shake_from_point ](#set_camera_shake_from_point )
2022-02-03 08:41:07 +00:00
- [set_camera_yaw_shake ](#set_camera_yaw_shake )
2022-01-30 06:47:22 +00:00
- [set_environmental_camera_shake ](#set_environmental_camera_shake )
2022-03-26 06:46:37 +00:00
- [set_fixed_cam_axis_sa_lobby ](#set_fixed_cam_axis_sa_lobby )
- [set_fov_function ](#set_fov_function )
- [set_fov_shake ](#set_fov_shake )
- [set_fov_shake_from_point_preset ](#set_fov_shake_from_point_preset )
- [set_handheld_shake ](#set_handheld_shake )
- [set_or_approach_f32_asymptotic ](#set_or_approach_f32_asymptotic )
- [set_or_approach_s16_symmetric ](#set_or_approach_s16_symmetric )
- [set_or_approach_vec3f_asymptotic ](#set_or_approach_vec3f_asymptotic )
- [set_pitch_shake_from_point ](#set_pitch_shake_from_point )
- [shake_camera_handheld ](#shake_camera_handheld )
- [shake_camera_pitch ](#shake_camera_pitch )
- [shake_camera_roll ](#shake_camera_roll )
- [shake_camera_yaw ](#shake_camera_yaw )
- [soft_reset_camera ](#soft_reset_camera )
- [start_cutscene ](#start_cutscene )
- [start_object_cutscene_without_focus ](#start_object_cutscene_without_focus )
- [transition_next_state ](#transition_next_state )
- [trigger_cutscene_dialog ](#trigger_cutscene_dialog )
- [vec3f_sub ](#vec3f_sub )
- [vec3f_to_object_pos ](#vec3f_to_object_pos )
- [warp_camera ](#warp_camera )
2022-01-30 06:47:22 +00:00
< br / >
- characters.h
2022-02-03 08:43:08 +00:00
- [get_character ](#get_character )
2022-01-30 06:47:22 +00:00
- [get_character_anim_offset ](#get_character_anim_offset )
- [play_character_sound ](#play_character_sound )
- [play_character_sound_if_no_flag ](#play_character_sound_if_no_flag )
- [play_character_sound_offset ](#play_character_sound_offset )
- [update_character_anim_offset ](#update_character_anim_offset )
< br / >
2022-02-03 08:42:48 +00:00
- djui_chat_message.h
- [djui_chat_message_create ](#djui_chat_message_create )
< br / >
2022-02-16 06:12:20 +00:00
- djui_hud_utils.h
- [djui_hud_get_screen_height ](#djui_hud_get_screen_height )
- [djui_hud_get_screen_width ](#djui_hud_get_screen_width )
- [djui_hud_measure_text ](#djui_hud_measure_text )
- [djui_hud_print_text ](#djui_hud_print_text )
2022-02-16 06:15:49 +00:00
- [djui_hud_render_rect ](#djui_hud_render_rect )
2022-02-16 06:12:20 +00:00
- [djui_hud_render_texture ](#djui_hud_render_texture )
- [djui_hud_set_color ](#djui_hud_set_color )
- [djui_hud_set_font ](#djui_hud_set_font )
- [djui_hud_set_resolution ](#djui_hud_set_resolution )
2022-02-16 06:08:01 +00:00
< br / >
2022-02-03 08:41:07 +00:00
- djui_popup.h
2022-02-03 08:42:31 +00:00
- [djui_popup_create ](#djui_popup_create )
2022-02-03 08:41:07 +00:00
< br / >
2022-01-30 06:47:22 +00:00
- external.h
2022-02-03 08:41:07 +00:00
- [fade_volume_scale ](#fade_volume_scale )
- [fadeout_background_music ](#fadeout_background_music )
- [play_course_clear ](#play_course_clear )
- [play_dialog_sound ](#play_dialog_sound )
- [play_music ](#play_music )
- [play_peachs_jingle ](#play_peachs_jingle )
- [play_power_star_jingle ](#play_power_star_jingle )
- [play_puzzle_jingle ](#play_puzzle_jingle )
- [play_race_fanfare ](#play_race_fanfare )
- [play_secondary_music ](#play_secondary_music )
2022-01-30 06:47:22 +00:00
- [play_sound ](#play_sound )
2022-02-03 08:41:07 +00:00
- [play_sound_with_freq_scale ](#play_sound_with_freq_scale )
- [play_star_fanfare ](#play_star_fanfare )
- [play_toads_jingle ](#play_toads_jingle )
2022-03-13 08:17:10 +00:00
- [seq_player_fade_out ](#seq_player_fade_out )
- [seq_player_lower_volume ](#seq_player_lower_volume )
- [seq_player_unlower_volume ](#seq_player_unlower_volume )
2022-01-30 06:47:22 +00:00
< br / >
2022-02-05 03:13:15 +00:00
- interaction.h
2022-02-19 06:43:38 +00:00
- [does_mario_have_normal_cap_on_head ](#does_mario_have_normal_cap_on_head )
2022-02-05 03:13:15 +00:00
- [get_door_save_file_flag ](#get_door_save_file_flag )
- [mario_blow_off_cap ](#mario_blow_off_cap )
- [mario_check_object_grab ](#mario_check_object_grab )
- [mario_drop_held_object ](#mario_drop_held_object )
- [mario_get_collided_object ](#mario_get_collided_object )
- [mario_grab_used_object ](#mario_grab_used_object )
- [mario_lose_cap_to_enemy ](#mario_lose_cap_to_enemy )
- [mario_obj_angle_to_object ](#mario_obj_angle_to_object )
- [mario_retrieve_cap ](#mario_retrieve_cap )
- [mario_stop_riding_and_holding ](#mario_stop_riding_and_holding )
- [mario_stop_riding_object ](#mario_stop_riding_object )
- [mario_throw_held_object ](#mario_throw_held_object )
< br / >
- level_info.h
- [get_level_name ](#get_level_name )
< br / >
2022-01-30 06:47:22 +00:00
- mario.h
- [adjust_sound_for_speed ](#adjust_sound_for_speed )
- [check_common_action_exits ](#check_common_action_exits )
- [check_common_hold_action_exits ](#check_common_hold_action_exits )
- [drop_and_set_mario_action ](#drop_and_set_mario_action )
- [execute_mario_action ](#execute_mario_action )
- [find_floor_height_relative_polar ](#find_floor_height_relative_polar )
- [find_floor_slope ](#find_floor_slope )
- [find_mario_anim_flags_and_translation ](#find_mario_anim_flags_and_translation )
- [force_idle_state ](#force_idle_state )
- [hurt_and_set_mario_action ](#hurt_and_set_mario_action )
- [is_anim_at_end ](#is_anim_at_end )
- [is_anim_past_end ](#is_anim_past_end )
- [is_anim_past_frame ](#is_anim_past_frame )
2022-03-13 01:00:06 +00:00
- [mario_can_bubble ](#mario_can_bubble )
2022-01-30 06:47:22 +00:00
- [mario_facing_downhill ](#mario_facing_downhill )
- [mario_floor_is_slippery ](#mario_floor_is_slippery )
- [mario_floor_is_slope ](#mario_floor_is_slope )
- [mario_floor_is_steep ](#mario_floor_is_steep )
- [mario_get_floor_class ](#mario_get_floor_class )
- [mario_get_terrain_sound_addend ](#mario_get_terrain_sound_addend )
- [mario_set_bubbled ](#mario_set_bubbled )
- [mario_set_forward_vel ](#mario_set_forward_vel )
- [play_mario_action_sound ](#play_mario_action_sound )
- [play_mario_heavy_landing_sound ](#play_mario_heavy_landing_sound )
- [play_mario_heavy_landing_sound_once ](#play_mario_heavy_landing_sound_once )
- [play_mario_jump_sound ](#play_mario_jump_sound )
- [play_mario_landing_sound ](#play_mario_landing_sound )
- [play_mario_landing_sound_once ](#play_mario_landing_sound_once )
- [play_mario_sound ](#play_mario_sound )
- [play_sound_and_spawn_particles ](#play_sound_and_spawn_particles )
- [play_sound_if_no_flag ](#play_sound_if_no_flag )
2022-02-03 08:43:08 +00:00
- [resolve_and_return_wall_collisions ](#resolve_and_return_wall_collisions )
2022-01-30 06:47:22 +00:00
- [return_mario_anim_y_translation ](#return_mario_anim_y_translation )
- [set_anim_to_frame ](#set_anim_to_frame )
- [set_jump_from_landing ](#set_jump_from_landing )
- [set_jumping_action ](#set_jumping_action )
- [set_mario_action ](#set_mario_action )
- [set_mario_anim_with_accel ](#set_mario_anim_with_accel )
- [set_mario_animation ](#set_mario_animation )
2022-03-26 07:01:13 +00:00
- [set_mario_y_vel_based_on_fspeed ](#set_mario_y_vel_based_on_fspeed )
2022-01-30 06:47:22 +00:00
- [set_steep_jump_action ](#set_steep_jump_action )
- [set_water_plunge_action ](#set_water_plunge_action )
- [transition_submerged_to_walking ](#transition_submerged_to_walking )
- [update_mario_pos_for_anim ](#update_mario_pos_for_anim )
- [update_mario_sound_and_camera ](#update_mario_sound_and_camera )
< br / >
- mario_actions_airborne.c
- [check_common_airborne_cancels ](#check_common_airborne_cancels )
- [check_fall_damage ](#check_fall_damage )
- [check_fall_damage_or_get_stuck ](#check_fall_damage_or_get_stuck )
- [check_horizontal_wind ](#check_horizontal_wind )
- [check_kick_or_dive_in_air ](#check_kick_or_dive_in_air )
- [check_wall_kick ](#check_wall_kick )
- [common_air_action_step ](#common_air_action_step )
- [common_air_knockback_step ](#common_air_knockback_step )
- [lava_boost_on_wall ](#lava_boost_on_wall )
- [mario_execute_airborne_action ](#mario_execute_airborne_action )
- [play_far_fall_sound ](#play_far_fall_sound )
- [play_flip_sounds ](#play_flip_sounds )
- [play_knockback_sound ](#play_knockback_sound )
- [should_get_stuck_in_ground ](#should_get_stuck_in_ground )
- [update_air_with_turn ](#update_air_with_turn )
- [update_air_without_turn ](#update_air_without_turn )
- [update_flying ](#update_flying )
- [update_flying_pitch ](#update_flying_pitch )
- [update_flying_yaw ](#update_flying_yaw )
- [update_lava_boost_or_twirling ](#update_lava_boost_or_twirling )
< br / >
- mario_actions_automatic.c
- [add_tree_leaf_particles ](#add_tree_leaf_particles )
- [check_common_automatic_cancels ](#check_common_automatic_cancels )
- [climb_up_ledge ](#climb_up_ledge )
- [let_go_of_ledge ](#let_go_of_ledge )
- [mario_execute_automatic_action ](#mario_execute_automatic_action )
- [perform_hanging_step ](#perform_hanging_step )
- [play_climbing_sounds ](#play_climbing_sounds )
- [set_pole_position ](#set_pole_position )
- [update_hang_moving ](#update_hang_moving )
- [update_hang_stationary ](#update_hang_stationary )
- [update_ledge_climb ](#update_ledge_climb )
- [update_ledge_climb_camera ](#update_ledge_climb_camera )
< br / >
- mario_actions_cutscene.c
- [bhv_end_peach_loop ](#bhv_end_peach_loop )
- [bhv_end_toad_loop ](#bhv_end_toad_loop )
2022-02-03 08:41:07 +00:00
- [common_death_handler ](#common_death_handler )
2022-01-30 06:47:22 +00:00
- [cutscene_put_cap_on ](#cutscene_put_cap_on )
- [cutscene_take_cap_off ](#cutscene_take_cap_off )
- [general_star_dance_handler ](#general_star_dance_handler )
- [generate_yellow_sparkles ](#generate_yellow_sparkles )
2022-02-03 08:41:07 +00:00
- [get_star_collection_dialog ](#get_star_collection_dialog )
2022-01-30 06:47:22 +00:00
- [handle_save_menu ](#handle_save_menu )
2022-02-03 08:41:07 +00:00
- [launch_mario_until_land ](#launch_mario_until_land )
- [mario_execute_cutscene_action ](#mario_execute_cutscene_action )
- [mario_ready_to_speak ](#mario_ready_to_speak )
2022-01-30 06:47:22 +00:00
- [print_displaying_credits_entry ](#print_displaying_credits_entry )
- [should_start_or_continue_dialog ](#should_start_or_continue_dialog )
- [stuck_in_ground_handler ](#stuck_in_ground_handler )
< br / >
- mario_actions_moving.c
- [align_with_floor ](#align_with_floor )
- [analog_stick_held_back ](#analog_stick_held_back )
- [anim_and_audio_for_heavy_walk ](#anim_and_audio_for_heavy_walk )
- [anim_and_audio_for_hold_walk ](#anim_and_audio_for_hold_walk )
- [anim_and_audio_for_walk ](#anim_and_audio_for_walk )
- [apply_landing_accel ](#apply_landing_accel )
- [apply_slope_accel ](#apply_slope_accel )
- [apply_slope_decel ](#apply_slope_decel )
- [begin_braking_action ](#begin_braking_action )
- [begin_walking_action ](#begin_walking_action )
- [check_common_moving_cancels ](#check_common_moving_cancels )
- [check_ground_dive_or_punch ](#check_ground_dive_or_punch )
- [check_ledge_climb_down ](#check_ledge_climb_down )
- [common_ground_knockback_action ](#common_ground_knockback_action )
- [common_landing_action ](#common_landing_action )
- [common_slide_action ](#common_slide_action )
- [common_slide_action_with_jump ](#common_slide_action_with_jump )
- [mario_execute_moving_action ](#mario_execute_moving_action )
- [play_step_sound ](#play_step_sound )
- [push_or_sidle_wall ](#push_or_sidle_wall )
- [quicksand_jump_land_action ](#quicksand_jump_land_action )
- [set_triple_jump_action ](#set_triple_jump_action )
- [should_begin_sliding ](#should_begin_sliding )
- [slide_bonk ](#slide_bonk )
- [stomach_slide_action ](#stomach_slide_action )
- [tilt_body_butt_slide ](#tilt_body_butt_slide )
- [tilt_body_ground_shell ](#tilt_body_ground_shell )
- [tilt_body_running ](#tilt_body_running )
- [tilt_body_walking ](#tilt_body_walking )
- [update_decelerating_speed ](#update_decelerating_speed )
- [update_shell_speed ](#update_shell_speed )
- [update_sliding ](#update_sliding )
- [update_sliding_angle ](#update_sliding_angle )
- [update_walking_speed ](#update_walking_speed )
< br / >
- mario_actions_object.c
- [animated_stationary_ground_step ](#animated_stationary_ground_step )
- [check_common_object_cancels ](#check_common_object_cancels )
- [mario_execute_object_action ](#mario_execute_object_action )
- [mario_update_punch_sequence ](#mario_update_punch_sequence )
< br / >
- mario_actions_stationary.c
- [check_common_hold_idle_cancels ](#check_common_hold_idle_cancels )
- [check_common_idle_cancels ](#check_common_idle_cancels )
- [check_common_landing_cancels ](#check_common_landing_cancels )
- [check_common_stationary_cancels ](#check_common_stationary_cancels )
- [landing_step ](#landing_step )
- [mario_execute_stationary_action ](#mario_execute_stationary_action )
- [play_anim_sound ](#play_anim_sound )
- [stopping_step ](#stopping_step )
< br / >
- mario_actions_submerged.c
- [apply_water_current ](#apply_water_current )
- [float_surface_gfx ](#float_surface_gfx )
- [mario_execute_submerged_action ](#mario_execute_submerged_action )
- [perform_water_full_step ](#perform_water_full_step )
- [perform_water_step ](#perform_water_step )
- [set_swimming_at_surface_particles ](#set_swimming_at_surface_particles )
< br / >
2022-04-07 08:17:48 +00:00
- mario_misc.h
- [bhv_toad_message_init ](#bhv_toad_message_init )
- [bhv_toad_message_loop ](#bhv_toad_message_loop )
- [bhv_unlock_door_star_init ](#bhv_unlock_door_star_init )
- [bhv_unlock_door_star_loop ](#bhv_unlock_door_star_loop )
< br / >
2022-01-30 06:47:22 +00:00
- mario_step.h
- [get_additive_y_vel_for_jumps ](#get_additive_y_vel_for_jumps )
2022-03-03 09:04:15 +00:00
- [init_bully_collision_data ](#init_bully_collision_data )
2022-01-30 06:47:22 +00:00
- [mario_bonk_reflection ](#mario_bonk_reflection )
- [mario_push_off_steep_floor ](#mario_push_off_steep_floor )
- [mario_update_moving_sand ](#mario_update_moving_sand )
- [mario_update_quicksand ](#mario_update_quicksand )
- [mario_update_windy_ground ](#mario_update_windy_ground )
- [perform_air_step ](#perform_air_step )
- [perform_ground_step ](#perform_ground_step )
- [set_vel_from_pitch_and_yaw ](#set_vel_from_pitch_and_yaw )
- [stationary_ground_step ](#stationary_ground_step )
- [stop_and_set_height_to_floor ](#stop_and_set_height_to_floor )
< br / >
2022-02-17 02:10:06 +00:00
- network_player.h
- [get_network_player_from_area ](#get_network_player_from_area )
- [get_network_player_from_level ](#get_network_player_from_level )
- [get_network_player_smallest_global ](#get_network_player_smallest_global )
- [network_player_connected_count ](#network_player_connected_count )
- [network_player_from_global_index ](#network_player_from_global_index )
2022-02-17 06:30:17 +00:00
- [network_player_set_description ](#network_player_set_description )
2022-02-17 02:10:06 +00:00
< br / >
2022-02-03 04:24:35 +00:00
- network_utils.h
2022-02-04 03:05:59 +00:00
- [network_get_player_text_color_string ](#network_get_player_text_color_string )
2022-02-03 04:24:35 +00:00
- [network_global_index_from_local ](#network_global_index_from_local )
- [network_is_server ](#network_is_server )
- [network_local_index_from_global ](#network_local_index_from_global )
< br / >
2022-02-23 06:39:45 +00:00
- obj_behaviors.c
- [absf_2 ](#absf_2 )
- [calc_new_obj_vel_and_pos_y ](#calc_new_obj_vel_and_pos_y )
- [calc_new_obj_vel_and_pos_y_underwater ](#calc_new_obj_vel_and_pos_y_underwater )
- [calc_obj_friction ](#calc_obj_friction )
- [current_mario_room_check ](#current_mario_room_check )
2022-03-13 08:22:48 +00:00
- [is_nearest_mario_state_to_object ](#is_nearest_mario_state_to_object )
- [is_nearest_player_to_object ](#is_nearest_player_to_object )
2022-03-31 03:03:59 +00:00
- [is_other_player_active ](#is_other_player_active )
2022-02-23 06:39:45 +00:00
- [is_player_active ](#is_player_active )
2022-03-30 04:12:42 +00:00
- [is_player_in_local_area ](#is_player_in_local_area )
2022-02-23 06:39:45 +00:00
- [is_point_close_to_object ](#is_point_close_to_object )
- [is_point_within_radius_of_mario ](#is_point_within_radius_of_mario )
2022-03-31 03:03:59 +00:00
- [nearest_interacting_mario_state_to_object ](#nearest_interacting_mario_state_to_object )
- [nearest_interacting_player_to_object ](#nearest_interacting_player_to_object )
2022-02-23 06:39:45 +00:00
- [nearest_mario_state_to_object ](#nearest_mario_state_to_object )
- [nearest_player_to_object ](#nearest_player_to_object )
- [obj_check_floor_death ](#obj_check_floor_death )
- [obj_check_if_facing_toward_angle ](#obj_check_if_facing_toward_angle )
- [obj_find_wall ](#obj_find_wall )
- [obj_find_wall_displacement ](#obj_find_wall_displacement )
- [obj_flicker_and_disappear ](#obj_flicker_and_disappear )
- [obj_lava_death ](#obj_lava_death )
- [obj_move_xyz_using_fvel_and_yaw ](#obj_move_xyz_using_fvel_and_yaw )
- [obj_orient_graph ](#obj_orient_graph )
- [obj_return_and_displace_home ](#obj_return_and_displace_home )
- [obj_return_home_if_safe ](#obj_return_home_if_safe )
- [obj_spawn_yellow_coins ](#obj_spawn_yellow_coins )
- [obj_splash ](#obj_splash )
- [obj_update_pos_vel_xz ](#obj_update_pos_vel_xz )
- [object_step ](#object_step )
- [object_step_without_floor_orient ](#object_step_without_floor_orient )
- [set_object_visibility ](#set_object_visibility )
- [set_yoshi_as_not_dead ](#set_yoshi_as_not_dead )
- [spawn_orange_number ](#spawn_orange_number )
- [turn_obj_away_from_steep_floor ](#turn_obj_away_from_steep_floor )
- [turn_obj_away_from_surface ](#turn_obj_away_from_surface )
< br / >
- obj_behaviors_2.c
- [approach_f32_ptr ](#approach_f32_ptr )
- [cur_obj_init_anim_and_check_if_end ](#cur_obj_init_anim_and_check_if_end )
- [cur_obj_init_anim_check_frame ](#cur_obj_init_anim_check_frame )
- [cur_obj_init_anim_extend ](#cur_obj_init_anim_extend )
- [cur_obj_play_sound_at_anim_range ](#cur_obj_play_sound_at_anim_range )
- [cur_obj_set_anim_if_at_end ](#cur_obj_set_anim_if_at_end )
- [cur_obj_spin_all_dimensions ](#cur_obj_spin_all_dimensions )
- [obj_act_knockback ](#obj_act_knockback )
- [obj_act_squished ](#obj_act_squished )
- [obj_bounce_off_walls_edges_objects ](#obj_bounce_off_walls_edges_objects )
- [obj_check_attacks ](#obj_check_attacks )
- [obj_compute_vel_from_move_pitch ](#obj_compute_vel_from_move_pitch )
- [obj_die_if_above_lava_and_health_non_positive ](#obj_die_if_above_lava_and_health_non_positive )
- [obj_die_if_health_non_positive ](#obj_die_if_health_non_positive )
- [obj_face_pitch_approach ](#obj_face_pitch_approach )
- [obj_face_roll_approach ](#obj_face_roll_approach )
- [obj_face_yaw_approach ](#obj_face_yaw_approach )
- [obj_forward_vel_approach ](#obj_forward_vel_approach )
- [obj_get_pitch_from_vel ](#obj_get_pitch_from_vel )
- [obj_get_pitch_to_home ](#obj_get_pitch_to_home )
- [obj_grow_then_shrink ](#obj_grow_then_shrink )
- [obj_handle_attacks ](#obj_handle_attacks )
- [obj_is_near_to_and_facing_mario ](#obj_is_near_to_and_facing_mario )
- [obj_is_rendering_enabled ](#obj_is_rendering_enabled )
- [obj_move_for_one_second ](#obj_move_for_one_second )
- [obj_move_pitch_approach ](#obj_move_pitch_approach )
- [obj_random_fixed_turn ](#obj_random_fixed_turn )
- [obj_resolve_collisions_and_turn ](#obj_resolve_collisions_and_turn )
- [obj_resolve_object_collisions ](#obj_resolve_object_collisions )
- [obj_roll_to_match_yaw_turn ](#obj_roll_to_match_yaw_turn )
- [obj_rotate_yaw_and_bounce_off_walls ](#obj_rotate_yaw_and_bounce_off_walls )
- [obj_set_dist_from_home ](#obj_set_dist_from_home )
- [obj_set_knockback_action ](#obj_set_knockback_action )
- [obj_set_squished_action ](#obj_set_squished_action )
- [obj_smooth_turn ](#obj_smooth_turn )
- [obj_spit_fire ](#obj_spit_fire )
- [obj_turn_pitch_toward_mario ](#obj_turn_pitch_toward_mario )
- [obj_unused_die ](#obj_unused_die )
- [obj_update_blinking ](#obj_update_blinking )
- [obj_update_standard_actions ](#obj_update_standard_actions )
- [obj_y_vel_approach ](#obj_y_vel_approach )
- [oscillate_toward ](#oscillate_toward )
- [platform_on_track_update_pos_or_spawn_ball ](#platform_on_track_update_pos_or_spawn_ball )
- [random_linear_offset ](#random_linear_offset )
- [random_mod_offset ](#random_mod_offset )
2022-03-30 04:12:42 +00:00
- [treat_far_home_as_mario ](#treat_far_home_as_mario )
2022-02-23 06:39:45 +00:00
< br / >
2022-02-23 02:34:51 +00:00
- object_helpers.c
2022-03-03 09:04:15 +00:00
- [abs_angle_diff ](#abs_angle_diff )
- [apply_drag_to_value ](#apply_drag_to_value )
2022-02-23 02:34:51 +00:00
- [approach_f32_signed ](#approach_f32_signed )
- [approach_f32_symmetric ](#approach_f32_symmetric )
- [approach_s16_symmetric ](#approach_s16_symmetric )
2022-03-03 09:04:15 +00:00
- [bhv_dust_smoke_loop ](#bhv_dust_smoke_loop )
- [bhv_init_room ](#bhv_init_room )
- [bit_shift_left ](#bit_shift_left )
- [chain_segment_init ](#chain_segment_init )
- [clear_move_flag ](#clear_move_flag )
- [clear_time_stop_flags ](#clear_time_stop_flags )
2022-02-23 02:34:51 +00:00
- [count_objects_with_behavior ](#count_objects_with_behavior )
- [count_unimportant_objects ](#count_unimportant_objects )
2022-03-03 09:04:15 +00:00
- [cur_obj_abs_y_dist_to_home ](#cur_obj_abs_y_dist_to_home )
- [cur_obj_advance_looping_anim ](#cur_obj_advance_looping_anim )
- [cur_obj_align_gfx_with_floor ](#cur_obj_align_gfx_with_floor )
- [cur_obj_angle_to_home ](#cur_obj_angle_to_home )
- [cur_obj_apply_drag_xz ](#cur_obj_apply_drag_xz )
- [cur_obj_become_intangible ](#cur_obj_become_intangible )
- [cur_obj_become_tangible ](#cur_obj_become_tangible )
- [cur_obj_can_mario_activate_textbox ](#cur_obj_can_mario_activate_textbox )
- [cur_obj_can_mario_activate_textbox_2 ](#cur_obj_can_mario_activate_textbox_2 )
2022-02-23 02:34:51 +00:00
- [cur_obj_change_action ](#cur_obj_change_action )
2022-03-03 09:04:15 +00:00
- [cur_obj_check_anim_frame ](#cur_obj_check_anim_frame )
- [cur_obj_check_anim_frame_in_range ](#cur_obj_check_anim_frame_in_range )
- [cur_obj_check_frame_prior_current_frame ](#cur_obj_check_frame_prior_current_frame )
- [cur_obj_check_grabbed_mario ](#cur_obj_check_grabbed_mario )
- [cur_obj_check_if_at_animation_end ](#cur_obj_check_if_at_animation_end )
- [cur_obj_check_if_near_animation_end ](#cur_obj_check_if_near_animation_end )
- [cur_obj_check_interacted ](#cur_obj_check_interacted )
- [cur_obj_clear_interact_status_flag ](#cur_obj_clear_interact_status_flag )
- [cur_obj_compute_vel_xz ](#cur_obj_compute_vel_xz )
2022-02-23 02:34:51 +00:00
- [cur_obj_count_objects_with_behavior ](#cur_obj_count_objects_with_behavior )
2022-03-03 09:04:15 +00:00
- [cur_obj_detect_steep_floor ](#cur_obj_detect_steep_floor )
- [cur_obj_disable ](#cur_obj_disable )
2022-02-23 02:34:51 +00:00
- [cur_obj_disable_rendering ](#cur_obj_disable_rendering )
- [cur_obj_disable_rendering_and_become_intangible ](#cur_obj_disable_rendering_and_become_intangible )
- [cur_obj_dist_to_nearest_object_with_behavior ](#cur_obj_dist_to_nearest_object_with_behavior )
- [cur_obj_enable_rendering ](#cur_obj_enable_rendering )
- [cur_obj_enable_rendering_2 ](#cur_obj_enable_rendering_2 )
- [cur_obj_enable_rendering_and_become_tangible ](#cur_obj_enable_rendering_and_become_tangible )
2022-03-03 09:04:15 +00:00
- [cur_obj_enable_rendering_if_mario_in_room ](#cur_obj_enable_rendering_if_mario_in_room )
- [cur_obj_end_dialog ](#cur_obj_end_dialog )
- [cur_obj_extend_animation_if_at_end ](#cur_obj_extend_animation_if_at_end )
2022-02-23 02:34:51 +00:00
- [cur_obj_find_nearby_held_actor ](#cur_obj_find_nearby_held_actor )
- [cur_obj_find_nearest_object_with_behavior ](#cur_obj_find_nearest_object_with_behavior )
- [cur_obj_find_nearest_pole ](#cur_obj_find_nearest_pole )
2022-03-03 09:04:15 +00:00
- [cur_obj_follow_path ](#cur_obj_follow_path )
2022-02-23 02:34:51 +00:00
- [cur_obj_forward_vel_approach_upward ](#cur_obj_forward_vel_approach_upward )
2022-03-03 09:04:15 +00:00
- [cur_obj_get_dropped ](#cur_obj_get_dropped )
- [cur_obj_get_thrown_or_placed ](#cur_obj_get_thrown_or_placed )
- [cur_obj_has_behavior ](#cur_obj_has_behavior )
- [cur_obj_has_model ](#cur_obj_has_model )
2022-02-23 02:34:51 +00:00
- [cur_obj_hide ](#cur_obj_hide )
2022-03-03 09:04:15 +00:00
- [cur_obj_hide_if_mario_far_away_y ](#cur_obj_hide_if_mario_far_away_y )
- [cur_obj_if_hit_wall_bounce_away ](#cur_obj_if_hit_wall_bounce_away )
2022-02-23 02:34:51 +00:00
- [cur_obj_init_animation ](#cur_obj_init_animation )
2022-03-03 09:04:15 +00:00
- [cur_obj_init_animation_and_anim_frame ](#cur_obj_init_animation_and_anim_frame )
- [cur_obj_init_animation_and_check_if_near_end ](#cur_obj_init_animation_and_check_if_near_end )
- [cur_obj_init_animation_and_extend_if_at_end ](#cur_obj_init_animation_and_extend_if_at_end )
2022-02-23 02:34:51 +00:00
- [cur_obj_init_animation_with_accel_and_sound ](#cur_obj_init_animation_with_accel_and_sound )
- [cur_obj_init_animation_with_sound ](#cur_obj_init_animation_with_sound )
2022-03-03 09:04:15 +00:00
- [cur_obj_is_any_player_on_platform ](#cur_obj_is_any_player_on_platform )
- [cur_obj_is_mario_ground_pounding_platform ](#cur_obj_is_mario_ground_pounding_platform )
- [cur_obj_is_mario_on_platform ](#cur_obj_is_mario_on_platform )
- [cur_obj_lateral_dist_from_mario_to_home ](#cur_obj_lateral_dist_from_mario_to_home )
- [cur_obj_lateral_dist_from_obj_to_home ](#cur_obj_lateral_dist_from_obj_to_home )
- [cur_obj_lateral_dist_to_home ](#cur_obj_lateral_dist_to_home )
- [cur_obj_mario_far_away ](#cur_obj_mario_far_away )
- [cur_obj_move_after_thrown_or_dropped ](#cur_obj_move_after_thrown_or_dropped )
- [cur_obj_move_standard ](#cur_obj_move_standard )
- [cur_obj_move_up_and_down ](#cur_obj_move_up_and_down )
- [cur_obj_move_update_ground_air_flags ](#cur_obj_move_update_ground_air_flags )
- [cur_obj_move_update_underwater_flags ](#cur_obj_move_update_underwater_flags )
- [cur_obj_move_using_fvel_and_gravity ](#cur_obj_move_using_fvel_and_gravity )
2022-02-23 02:34:51 +00:00
- [cur_obj_move_using_vel ](#cur_obj_move_using_vel )
2022-03-03 09:04:15 +00:00
- [cur_obj_move_using_vel_and_gravity ](#cur_obj_move_using_vel_and_gravity )
- [cur_obj_move_xz ](#cur_obj_move_xz )
- [cur_obj_move_xz_using_fvel_and_yaw ](#cur_obj_move_xz_using_fvel_and_yaw )
- [cur_obj_move_y ](#cur_obj_move_y )
- [cur_obj_move_y_and_get_water_level ](#cur_obj_move_y_and_get_water_level )
- [cur_obj_move_y_with_terminal_vel ](#cur_obj_move_y_with_terminal_vel )
2022-02-23 02:34:51 +00:00
- [cur_obj_nearest_object_with_behavior ](#cur_obj_nearest_object_with_behavior )
2022-03-03 09:04:15 +00:00
- [cur_obj_outside_home_rectangle ](#cur_obj_outside_home_rectangle )
- [cur_obj_outside_home_square ](#cur_obj_outside_home_square )
- [cur_obj_progress_direction_table ](#cur_obj_progress_direction_table )
- [cur_obj_push_mario_away ](#cur_obj_push_mario_away )
- [cur_obj_push_mario_away_from_cylinder ](#cur_obj_push_mario_away_from_cylinder )
- [cur_obj_reflect_move_angle_off_wall ](#cur_obj_reflect_move_angle_off_wall )
- [cur_obj_reset_timer_and_subaction ](#cur_obj_reset_timer_and_subaction )
- [cur_obj_resolve_wall_collisions ](#cur_obj_resolve_wall_collisions )
- [cur_obj_reverse_animation ](#cur_obj_reverse_animation )
- [cur_obj_rotate_face_angle_using_vel ](#cur_obj_rotate_face_angle_using_vel )
- [cur_obj_rotate_move_angle_using_vel ](#cur_obj_rotate_move_angle_using_vel )
2022-02-23 02:34:51 +00:00
- [cur_obj_rotate_yaw_toward ](#cur_obj_rotate_yaw_toward )
- [cur_obj_scale ](#cur_obj_scale )
2022-03-03 09:04:15 +00:00
- [cur_obj_scale_over_time ](#cur_obj_scale_over_time )
- [cur_obj_set_behavior ](#cur_obj_set_behavior )
- [cur_obj_set_direction_table ](#cur_obj_set_direction_table )
- [cur_obj_set_face_angle_to_move_angle ](#cur_obj_set_face_angle_to_move_angle )
- [cur_obj_set_hitbox_and_die_if_attacked ](#cur_obj_set_hitbox_and_die_if_attacked )
- [cur_obj_set_hitbox_radius_and_height ](#cur_obj_set_hitbox_radius_and_height )
- [cur_obj_set_hurtbox_radius_and_height ](#cur_obj_set_hurtbox_radius_and_height )
- [cur_obj_set_model ](#cur_obj_set_model )
2022-02-23 02:34:51 +00:00
- [cur_obj_set_pos_relative ](#cur_obj_set_pos_relative )
- [cur_obj_set_pos_relative_to_parent ](#cur_obj_set_pos_relative_to_parent )
2022-03-03 09:04:15 +00:00
- [cur_obj_set_pos_to_home ](#cur_obj_set_pos_to_home )
- [cur_obj_set_pos_to_home_and_stop ](#cur_obj_set_pos_to_home_and_stop )
- [cur_obj_set_pos_to_home_with_debug ](#cur_obj_set_pos_to_home_with_debug )
- [cur_obj_set_pos_via_transform ](#cur_obj_set_pos_via_transform )
2022-02-23 02:34:51 +00:00
- [cur_obj_set_vel_from_mario_vel ](#cur_obj_set_vel_from_mario_vel )
2022-03-03 09:04:15 +00:00
- [cur_obj_set_y_vel_and_animation ](#cur_obj_set_y_vel_and_animation )
- [cur_obj_shake_screen ](#cur_obj_shake_screen )
- [cur_obj_shake_y ](#cur_obj_shake_y )
- [cur_obj_shake_y_until ](#cur_obj_shake_y_until )
- [cur_obj_spawn_loot_blue_coin ](#cur_obj_spawn_loot_blue_coin )
- [cur_obj_spawn_loot_coin_at_mario_pos ](#cur_obj_spawn_loot_coin_at_mario_pos )
- [cur_obj_spawn_particles ](#cur_obj_spawn_particles )
- [cur_obj_spawn_star_at_y_offset ](#cur_obj_spawn_star_at_y_offset )
- [cur_obj_start_cam_event ](#cur_obj_start_cam_event )
2022-02-23 02:34:51 +00:00
- [cur_obj_unhide ](#cur_obj_unhide )
2022-03-03 09:04:15 +00:00
- [cur_obj_unrender_and_reset_state ](#cur_obj_unrender_and_reset_state )
2022-02-23 02:34:51 +00:00
- [cur_obj_unused_init_on_floor ](#cur_obj_unused_init_on_floor )
2022-03-03 09:04:15 +00:00
- [cur_obj_unused_play_footstep_sound ](#cur_obj_unused_play_footstep_sound )
- [cur_obj_unused_resolve_wall_collisions ](#cur_obj_unused_resolve_wall_collisions )
- [cur_obj_update_floor ](#cur_obj_update_floor )
- [cur_obj_update_floor_and_resolve_wall_collisions ](#cur_obj_update_floor_and_resolve_wall_collisions )
- [cur_obj_update_floor_and_walls ](#cur_obj_update_floor_and_walls )
- [cur_obj_update_floor_height ](#cur_obj_update_floor_height )
- [cur_obj_update_floor_height_and_get_floor ](#cur_obj_update_floor_height_and_get_floor )
- [cur_obj_wait_then_blink ](#cur_obj_wait_then_blink )
- [cur_obj_was_attacked_or_ground_pounded ](#cur_obj_was_attacked_or_ground_pounded )
- [cur_obj_within_12k_bounds ](#cur_obj_within_12k_bounds )
- [disable_time_stop ](#disable_time_stop )
- [disable_time_stop_including_mario ](#disable_time_stop_including_mario )
2022-02-23 02:34:51 +00:00
- [dist_between_object_and_point ](#dist_between_object_and_point )
- [dist_between_objects ](#dist_between_objects )
2022-03-03 09:04:15 +00:00
- [enable_time_stop ](#enable_time_stop )
2022-03-30 04:12:42 +00:00
- [enable_time_stop_if_alone ](#enable_time_stop_if_alone )
2022-03-03 09:04:15 +00:00
- [enable_time_stop_including_mario ](#enable_time_stop_including_mario )
2022-03-31 03:03:59 +00:00
- [find_object_with_behavior ](#find_object_with_behavior )
2022-02-23 02:34:51 +00:00
- [find_unimportant_object ](#find_unimportant_object )
2022-03-03 09:04:15 +00:00
- [geo_offset_klepto_debug ](#geo_offset_klepto_debug )
2022-02-23 02:34:51 +00:00
- [get_object_list_from_behavior ](#get_object_list_from_behavior )
2022-03-03 09:04:15 +00:00
- [increment_velocity_toward_range ](#increment_velocity_toward_range )
- [is_item_in_array ](#is_item_in_array )
- [is_mario_moving_fast_or_in_air ](#is_mario_moving_fast_or_in_air )
2022-02-23 02:34:51 +00:00
- [lateral_dist_between_objects ](#lateral_dist_between_objects )
2022-03-03 09:04:15 +00:00
- [mario_is_dive_sliding ](#mario_is_dive_sliding )
- [mario_is_in_air_action ](#mario_is_in_air_action )
- [mario_is_within_rectangle ](#mario_is_within_rectangle )
- [mario_set_flag ](#mario_set_flag )
2022-02-23 02:34:51 +00:00
- [obj_angle_to_object ](#obj_angle_to_object )
- [obj_angle_to_point ](#obj_angle_to_point )
- [obj_apply_scale_to_transform ](#obj_apply_scale_to_transform )
2022-03-03 09:04:15 +00:00
- [obj_attack_collided_from_other_object ](#obj_attack_collided_from_other_object )
- [obj_become_tangible ](#obj_become_tangible )
- [obj_build_relative_transform ](#obj_build_relative_transform )
- [obj_build_transform_from_pos_and_angle ](#obj_build_transform_from_pos_and_angle )
- [obj_build_transform_relative_to_parent ](#obj_build_transform_relative_to_parent )
- [obj_build_vel_from_transform ](#obj_build_vel_from_transform )
- [obj_check_if_collided_with_object ](#obj_check_if_collided_with_object )
2022-02-23 02:34:51 +00:00
- [obj_copy_angle ](#obj_copy_angle )
2022-03-03 09:04:15 +00:00
- [obj_copy_behavior_params ](#obj_copy_behavior_params )
2022-02-23 02:34:51 +00:00
- [obj_copy_graph_y_offset ](#obj_copy_graph_y_offset )
- [obj_copy_pos ](#obj_copy_pos )
- [obj_copy_pos_and_angle ](#obj_copy_pos_and_angle )
- [obj_copy_scale ](#obj_copy_scale )
2022-03-03 09:04:15 +00:00
- [obj_create_transform_from_self ](#obj_create_transform_from_self )
- [obj_explode_and_spawn_coins ](#obj_explode_and_spawn_coins )
- [obj_has_behavior ](#obj_has_behavior )
2022-02-23 02:34:51 +00:00
- [obj_init_animation ](#obj_init_animation )
2022-03-03 09:04:15 +00:00
- [obj_is_hidden ](#obj_is_hidden )
- [obj_mark_for_deletion ](#obj_mark_for_deletion )
2022-02-23 02:34:51 +00:00
- [obj_pitch_to_object ](#obj_pitch_to_object )
- [obj_scale ](#obj_scale )
2022-03-03 09:04:15 +00:00
- [obj_scale_random ](#obj_scale_random )
2022-02-23 02:34:51 +00:00
- [obj_scale_xyz ](#obj_scale_xyz )
- [obj_set_angle ](#obj_set_angle )
2022-03-03 09:04:15 +00:00
- [obj_set_behavior ](#obj_set_behavior )
- [obj_set_billboard ](#obj_set_billboard )
- [obj_set_cylboard ](#obj_set_cylboard )
2022-02-23 02:34:51 +00:00
- [obj_set_face_angle_to_move_angle ](#obj_set_face_angle_to_move_angle )
2022-03-03 09:04:15 +00:00
- [obj_set_gfx_pos_at_obj_pos ](#obj_set_gfx_pos_at_obj_pos )
2022-02-23 02:34:51 +00:00
- [obj_set_gfx_pos_from_pos ](#obj_set_gfx_pos_from_pos )
- [obj_set_held_state ](#obj_set_held_state )
2022-03-03 09:04:15 +00:00
- [obj_set_hitbox ](#obj_set_hitbox )
2022-02-23 02:34:51 +00:00
- [obj_set_parent_relative_pos ](#obj_set_parent_relative_pos )
- [obj_set_pos ](#obj_set_pos )
2022-03-03 09:04:15 +00:00
- [obj_set_pos_relative ](#obj_set_pos_relative )
- [obj_set_throw_matrix_from_transform ](#obj_set_throw_matrix_from_transform )
- [obj_spawn_loot_blue_coins ](#obj_spawn_loot_blue_coins )
- [obj_spawn_loot_coins ](#obj_spawn_loot_coins )
- [obj_spawn_loot_yellow_coins ](#obj_spawn_loot_yellow_coins )
- [obj_translate_local ](#obj_translate_local )
- [obj_translate_xyz_random ](#obj_translate_xyz_random )
- [obj_translate_xz_random ](#obj_translate_xz_random )
2022-02-23 02:34:51 +00:00
- [obj_turn_toward_object ](#obj_turn_toward_object )
2022-03-03 09:04:15 +00:00
- [player_performed_grab_escape_action ](#player_performed_grab_escape_action )
- [random_f32_around_zero ](#random_f32_around_zero )
- [set_mario_interact_hoot_if_in_range ](#set_mario_interact_hoot_if_in_range )
- [set_time_stop_flags ](#set_time_stop_flags )
2022-03-30 04:12:42 +00:00
- [set_time_stop_flags_if_alone ](#set_time_stop_flags_if_alone )
2022-03-03 09:04:15 +00:00
- [signum_positive ](#signum_positive )
- [spawn_base_star_with_no_lvl_exit ](#spawn_base_star_with_no_lvl_exit )
- [spawn_mist_particles ](#spawn_mist_particles )
- [spawn_mist_particles_with_sound ](#spawn_mist_particles_with_sound )
- [spawn_star_with_no_lvl_exit ](#spawn_star_with_no_lvl_exit )
2022-02-23 02:34:51 +00:00
- [spawn_water_droplet ](#spawn_water_droplet )
2022-03-03 09:04:15 +00:00
- [stub_obj_helpers_3 ](#stub_obj_helpers_3 )
- [stub_obj_helpers_4 ](#stub_obj_helpers_4 )
2022-02-23 02:34:51 +00:00
< br / >
2022-04-07 01:24:50 +00:00
- object_list_processor.h
- [set_object_respawn_info_bits ](#set_object_respawn_info_bits )
< br / >
2022-03-13 08:17:10 +00:00
- rumble_init.c
- [queue_rumble_data ](#queue_rumble_data )
- [queue_rumble_data_mario ](#queue_rumble_data_mario )
- [queue_rumble_data_object ](#queue_rumble_data_object )
2022-03-19 07:56:59 +00:00
- [reset_rumble_timers ](#reset_rumble_timers )
- [reset_rumble_timers_2 ](#reset_rumble_timers_2 )
2022-03-13 08:17:10 +00:00
< br / >
2022-02-05 03:13:15 +00:00
- save_file.h
2022-03-25 02:30:15 +00:00
- [save_file_clear_flags ](#save_file_clear_flags )
2022-02-05 03:13:15 +00:00
- [save_file_get_cap_pos ](#save_file_get_cap_pos )
- [save_file_get_course_coin_score ](#save_file_get_course_coin_score )
- [save_file_get_course_star_count ](#save_file_get_course_star_count )
- [save_file_get_flags ](#save_file_get_flags )
- [save_file_get_max_coin_score ](#save_file_get_max_coin_score )
- [save_file_get_sound_mode ](#save_file_get_sound_mode )
- [save_file_get_star_flags ](#save_file_get_star_flags )
- [save_file_get_total_star_count ](#save_file_get_total_star_count )
2022-03-25 02:30:15 +00:00
- [save_file_set_flags ](#save_file_set_flags )
2022-02-05 03:13:15 +00:00
< br / >
2022-04-10 16:11:45 +00:00
- smlua_audio_utils.h
- [smlua_audio_utils_replace_sequence ](#smlua_audio_utils_replace_sequence )
2022-04-10 17:11:13 +00:00
- [smlua_audio_utils_reset_all ](#smlua_audio_utils_reset_all )
2022-04-10 16:11:45 +00:00
< br / >
2022-03-10 06:58:45 +00:00
- smlua_collision_utils.h
2022-03-05 22:24:58 +00:00
- [collision_find_surface_on_ray ](#collision_find_surface_on_ray )
2022-03-19 07:56:59 +00:00
- [get_water_surface_pseudo_floor ](#get_water_surface_pseudo_floor )
2022-03-28 08:02:33 +00:00
- [smlua_collision_util_get ](#smlua_collision_util_get )
2022-03-10 06:58:45 +00:00
< br / >
- smlua_misc_utils.h
2022-03-17 08:17:34 +00:00
- [allocate_mario_action ](#allocate_mario_action )
2022-04-07 01:24:50 +00:00
- [deref_s32_pointer ](#deref_s32_pointer )
2022-04-07 08:17:48 +00:00
- [get_current_save_file_num ](#get_current_save_file_num )
2022-04-05 22:53:16 +00:00
- [get_environment_region ](#get_environment_region )
2022-03-19 07:56:59 +00:00
- [get_hand_foot_pos_x ](#get_hand_foot_pos_x )
- [get_hand_foot_pos_y ](#get_hand_foot_pos_y )
- [get_hand_foot_pos_z ](#get_hand_foot_pos_z )
2022-03-10 03:08:41 +00:00
- [get_network_area_timer ](#get_network_area_timer )
2022-04-07 01:24:50 +00:00
- [get_temp_s32_pointer ](#get_temp_s32_pointer )
2022-03-11 02:33:52 +00:00
- [hud_hide ](#hud_hide )
- [hud_show ](#hud_show )
2022-04-09 08:47:20 +00:00
- [movtexqc_register ](#movtexqc_register )
2022-04-10 07:30:47 +00:00
- [save_file_set_using_backup_slot ](#save_file_set_using_backup_slot )
2022-04-05 22:53:16 +00:00
- [set_environment_region ](#set_environment_region )
2022-03-12 02:11:32 +00:00
- [warp_exit_level ](#warp_exit_level )
- [warp_restart_level ](#warp_restart_level )
- [warp_to_castle ](#warp_to_castle )
- [warp_to_level ](#warp_to_level )
2022-03-05 22:24:58 +00:00
< br / >
2022-03-14 07:11:36 +00:00
- smlua_model_utils.h
- [smlua_model_util_get_id ](#smlua_model_util_get_id )
< br / >
2022-02-22 06:46:39 +00:00
- smlua_obj_utils.h
2022-03-12 02:18:41 +00:00
- [get_temp_object_hitbox ](#get_temp_object_hitbox )
2022-04-09 06:01:41 +00:00
- [get_trajectory ](#get_trajectory )
2022-02-28 21:15:37 +00:00
- [obj_get_first ](#obj_get_first )
- [obj_get_first_with_behavior_id ](#obj_get_first_with_behavior_id )
- [obj_get_first_with_behavior_id_and_field_f32 ](#obj_get_first_with_behavior_id_and_field_f32 )
2022-03-01 20:06:06 +00:00
- [obj_get_first_with_behavior_id_and_field_s32 ](#obj_get_first_with_behavior_id_and_field_s32 )
2022-02-28 21:15:37 +00:00
- [obj_get_next ](#obj_get_next )
- [obj_get_next_with_same_behavior_id ](#obj_get_next_with_same_behavior_id )
- [obj_get_next_with_same_behavior_id_and_field_f32 ](#obj_get_next_with_same_behavior_id_and_field_f32 )
2022-03-01 20:06:06 +00:00
- [obj_get_next_with_same_behavior_id_and_field_s32 ](#obj_get_next_with_same_behavior_id_and_field_s32 )
2022-03-10 02:59:55 +00:00
- [obj_get_temp_spawn_particles_info ](#obj_get_temp_spawn_particles_info )
2022-03-05 22:39:55 +00:00
- [obj_has_behavior_id ](#obj_has_behavior_id )
- [obj_has_model_extended ](#obj_has_model_extended )
2022-03-04 00:46:01 +00:00
- [obj_set_model_extended ](#obj_set_model_extended )
2022-03-10 04:11:45 +00:00
- [spawn_non_sync_object ](#spawn_non_sync_object )
2022-03-01 20:06:06 +00:00
- [spawn_sync_object ](#spawn_sync_object )
2022-02-22 06:46:39 +00:00
< br / >
2022-04-10 06:28:36 +00:00
- smlua_text_utils.h
- [smlua_text_utils_castle_secret_stars_replace ](#smlua_text_utils_castle_secret_stars_replace )
- [smlua_text_utils_course_acts_replace ](#smlua_text_utils_course_acts_replace )
- [smlua_text_utils_dialog_replace ](#smlua_text_utils_dialog_replace )
- [smlua_text_utils_extra_text_replace ](#smlua_text_utils_extra_text_replace )
- [smlua_text_utils_reset_all ](#smlua_text_utils_reset_all )
- [smlua_text_utils_secret_star_replace ](#smlua_text_utils_secret_star_replace )
< br / >
2022-02-05 03:13:15 +00:00
- sound_init.h
- [disable_background_sound ](#disable_background_sound )
- [enable_background_sound ](#enable_background_sound )
- [fadeout_cap_music ](#fadeout_cap_music )
- [fadeout_level_music ](#fadeout_level_music )
- [fadeout_music ](#fadeout_music )
- [lower_background_noise ](#lower_background_noise )
- [play_cap_music ](#play_cap_music )
- [play_cutscene_music ](#play_cutscene_music )
- [play_infinite_stairs_music ](#play_infinite_stairs_music )
- [play_menu_sounds ](#play_menu_sounds )
- [play_painting_eject_sound ](#play_painting_eject_sound )
- [play_shell_music ](#play_shell_music )
- [raise_background_noise ](#raise_background_noise )
- [reset_volume ](#reset_volume )
- [set_background_music ](#set_background_music )
- [stop_cap_music ](#stop_cap_music )
- [stop_shell_music ](#stop_shell_music )
< br / >
2022-03-05 04:03:00 +00:00
- spawn_sound.c
- [calc_dist_to_volume_range_1 ](#calc_dist_to_volume_range_1 )
- [calc_dist_to_volume_range_2 ](#calc_dist_to_volume_range_2 )
- [cur_obj_play_sound_1 ](#cur_obj_play_sound_1 )
- [cur_obj_play_sound_2 ](#cur_obj_play_sound_2 )
- [exec_anim_sound_state ](#exec_anim_sound_state )
< br / >
2022-01-30 06:47:22 +00:00
- surface_collision.h
2022-03-04 00:46:01 +00:00
- [find_ceil_height ](#find_ceil_height )
2022-01-30 06:47:22 +00:00
- [find_floor_height ](#find_floor_height )
- [find_poison_gas_level ](#find_poison_gas_level )
- [find_wall_collisions ](#find_wall_collisions )
- [find_water_level ](#find_water_level )
< br / >
2022-03-10 06:58:45 +00:00
- surface_load.h
- [alloc_surface_pools ](#alloc_surface_pools )
- [clear_dynamic_surfaces ](#clear_dynamic_surfaces )
- [get_area_terrain_size ](#get_area_terrain_size )
- [load_area_terrain ](#load_area_terrain )
- [load_object_collision_model ](#load_object_collision_model )
< br / >
2022-01-30 06:47:22 +00:00
2022-03-05 07:05:23 +00:00
---
# manually written functions
< br / >
## [define_custom_obj_fields](#define_custom_obj_fields)
2022-03-05 09:29:24 +00:00
Defines a custom set of overlapping object fields.
The `fieldTable` table's keys must start with the letter `o` and the values must be either `u32` , `s32` , or `f32` .
2022-03-05 07:05:23 +00:00
### Lua Example
`define_custom_obj_fields({ oCustomField1 = 'u32', oCustomField2 = 's32', oCustomField3 = 'f32' })`
### Parameters
| Field | Type |
| ----- | ---- |
| fieldTable | `Lua Table` |
### C Prototype
`N/A`
[:arrow_up_small: ](# )
## [network_init_object](#network_init_object)
Enables synchronization on an object.
- Setting `standardSync` to `true` will automatically synchronize the object at a rate that is determined based on player distance. The commonly used object fields will be automatically synchronized.
- Setting `standardSync` to `false` will not automatically synchronize the object, or add commonly used object fields. The mod must manually call `network_send_object()` when fields have changed.
The `fieldTable` parameter can be `nil` , or a list of object fields.
### Lua Example
`network_init_object(obj, true, { 'oCustomField1', 'oCustomField2', 'oCustomField3' })`
### Parameters
| Field | Type |
| ----- | ---- |
| object | [Object ](structs.md#Object ) |
| standardSync | `bool` |
| fieldTable | `Lua Table` |
### C Prototype
`N/A`
[:arrow_up_small: ](# )
< br / >
## [network_send_object](#network_send_object)
Sends a packet that synchronizes an object. This does not need to be called when `standardSync` is enabled.
The `reliable` field will ensure that the packet arrives, but should be used sparingly and only when missing a packet would cause a desync.
### Lua Example
`network_send_object(obj, false)`
### Parameters
| Field | Type |
| ----- | ---- |
| object | [Object ](structs.md#Object ) |
| reliable | `bool` |
### C Prototype
`N/A`
[:arrow_up_small: ](# )
< br / >
2022-04-07 01:36:15 +00:00
---
# functions from behavior_actions.h
< br / >
## [arc_to_goal_pos](#arc_to_goal_pos)
### Lua Example
`local integerValue = arc_to_goal_pos(a0, a1, yVel, gravity)`
### Parameters
| Field | Type |
| ----- | ---- |
| a0 | [Vec3f ](structs.md#Vec3f ) |
| a1 | [Vec3f ](structs.md#Vec3f ) |
| yVel | `number` |
| gravity | `number` |
### Returns
- `integer`
### C Prototype
`s32 arc_to_goal_pos(Vec3f a0, Vec3f a1, f32 yVel, f32 gravity);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_common_init](#bhv_1up_common_init)
### Lua Example
`bhv_1up_common_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_common_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_hidden_in_pole_loop](#bhv_1up_hidden_in_pole_loop)
### Lua Example
`bhv_1up_hidden_in_pole_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_hidden_in_pole_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_hidden_in_pole_spawner_loop](#bhv_1up_hidden_in_pole_spawner_loop)
### Lua Example
`bhv_1up_hidden_in_pole_spawner_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_hidden_in_pole_spawner_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_hidden_in_pole_trigger_loop](#bhv_1up_hidden_in_pole_trigger_loop)
### Lua Example
`bhv_1up_hidden_in_pole_trigger_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_hidden_in_pole_trigger_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_hidden_loop](#bhv_1up_hidden_loop)
### Lua Example
`bhv_1up_hidden_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_hidden_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_hidden_trigger_loop](#bhv_1up_hidden_trigger_loop)
### Lua Example
`bhv_1up_hidden_trigger_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_hidden_trigger_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_init](#bhv_1up_init)
### Lua Example
`bhv_1up_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_jump_on_approach_loop](#bhv_1up_jump_on_approach_loop)
### Lua Example
`bhv_1up_jump_on_approach_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_jump_on_approach_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_loop](#bhv_1up_loop)
### Lua Example
`bhv_1up_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_running_away_loop](#bhv_1up_running_away_loop)
### Lua Example
`bhv_1up_running_away_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_running_away_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_sliding_loop](#bhv_1up_sliding_loop)
### Lua Example
`bhv_1up_sliding_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_sliding_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_1up_walking_loop](#bhv_1up_walking_loop)
### Lua Example
`bhv_1up_walking_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_1up_walking_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_act_selector_init](#bhv_act_selector_init)
### Lua Example
`bhv_act_selector_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_act_selector_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_act_selector_loop](#bhv_act_selector_loop)
### Lua Example
`bhv_act_selector_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_act_selector_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_act_selector_star_type_loop](#bhv_act_selector_star_type_loop)
### Lua Example
`bhv_act_selector_star_type_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_act_selector_star_type_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_activated_back_and_forth_platform_init](#bhv_activated_back_and_forth_platform_init)
### Lua Example
`bhv_activated_back_and_forth_platform_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_activated_back_and_forth_platform_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_activated_back_and_forth_platform_update](#bhv_activated_back_and_forth_platform_update)
### Lua Example
`bhv_activated_back_and_forth_platform_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_activated_back_and_forth_platform_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_alpha_boo_key_loop](#bhv_alpha_boo_key_loop)
### Lua Example
`bhv_alpha_boo_key_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_alpha_boo_key_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ambient_sounds_init](#bhv_ambient_sounds_init)
### Lua Example
`bhv_ambient_sounds_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ambient_sounds_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_animated_texture_loop](#bhv_animated_texture_loop)
### Lua Example
`bhv_animated_texture_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_animated_texture_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_animates_on_floor_switch_press_init](#bhv_animates_on_floor_switch_press_init)
### Lua Example
`bhv_animates_on_floor_switch_press_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_animates_on_floor_switch_press_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_animates_on_floor_switch_press_loop](#bhv_animates_on_floor_switch_press_loop)
### Lua Example
`bhv_animates_on_floor_switch_press_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_animates_on_floor_switch_press_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_arrow_lift_loop](#bhv_arrow_lift_loop)
### Lua Example
`bhv_arrow_lift_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_arrow_lift_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bbh_tilting_trap_platform_loop](#bhv_bbh_tilting_trap_platform_loop)
### Lua Example
`bhv_bbh_tilting_trap_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bbh_tilting_trap_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_boo_key_loop](#bhv_beta_boo_key_loop)
### Lua Example
`bhv_beta_boo_key_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_boo_key_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_bowser_anchor_loop](#bhv_beta_bowser_anchor_loop)
### Lua Example
`bhv_beta_bowser_anchor_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_bowser_anchor_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_chest_bottom_init](#bhv_beta_chest_bottom_init)
### Lua Example
`bhv_beta_chest_bottom_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_chest_bottom_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_chest_bottom_loop](#bhv_beta_chest_bottom_loop)
### Lua Example
`bhv_beta_chest_bottom_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_chest_bottom_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_chest_lid_loop](#bhv_beta_chest_lid_loop)
### Lua Example
`bhv_beta_chest_lid_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_chest_lid_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_fish_splash_spawner_loop](#bhv_beta_fish_splash_spawner_loop)
### Lua Example
`bhv_beta_fish_splash_spawner_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_fish_splash_spawner_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_holdable_object_init](#bhv_beta_holdable_object_init)
### Lua Example
`bhv_beta_holdable_object_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_holdable_object_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_holdable_object_loop](#bhv_beta_holdable_object_loop)
### Lua Example
`bhv_beta_holdable_object_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_holdable_object_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_moving_flames_loop](#bhv_beta_moving_flames_loop)
### Lua Example
`bhv_beta_moving_flames_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_moving_flames_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_moving_flames_spawn_loop](#bhv_beta_moving_flames_spawn_loop)
### Lua Example
`bhv_beta_moving_flames_spawn_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_moving_flames_spawn_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_trampoline_spring_loop](#bhv_beta_trampoline_spring_loop)
### Lua Example
`bhv_beta_trampoline_spring_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_trampoline_spring_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_beta_trampoline_top_loop](#bhv_beta_trampoline_top_loop)
### Lua Example
`bhv_beta_trampoline_top_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_beta_trampoline_top_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_big_boo_loop](#bhv_big_boo_loop)
### Lua Example
`bhv_big_boo_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_big_boo_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_big_boulder_generator_loop](#bhv_big_boulder_generator_loop)
### Lua Example
`bhv_big_boulder_generator_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_big_boulder_generator_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_big_boulder_init](#bhv_big_boulder_init)
### Lua Example
`bhv_big_boulder_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_big_boulder_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_big_boulder_loop](#bhv_big_boulder_loop)
### Lua Example
`bhv_big_boulder_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_big_boulder_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_big_bully_init](#bhv_big_bully_init)
### Lua Example
`bhv_big_bully_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_big_bully_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_big_bully_with_minions_init](#bhv_big_bully_with_minions_init)
### Lua Example
`bhv_big_bully_with_minions_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_big_bully_with_minions_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_big_bully_with_minions_loop](#bhv_big_bully_with_minions_loop)
### Lua Example
`bhv_big_bully_with_minions_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_big_bully_with_minions_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bird_update](#bhv_bird_update)
### Lua Example
`bhv_bird_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bird_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_birds_sound_loop](#bhv_birds_sound_loop)
### Lua Example
`bhv_birds_sound_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_birds_sound_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bitfs_sinking_cage_platform_loop](#bhv_bitfs_sinking_cage_platform_loop)
### Lua Example
`bhv_bitfs_sinking_cage_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bitfs_sinking_cage_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bitfs_sinking_platform_loop](#bhv_bitfs_sinking_platform_loop)
### Lua Example
`bhv_bitfs_sinking_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bitfs_sinking_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_black_smoke_bowser_loop](#bhv_black_smoke_bowser_loop)
### Lua Example
`bhv_black_smoke_bowser_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_black_smoke_bowser_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_black_smoke_mario_loop](#bhv_black_smoke_mario_loop)
### Lua Example
`bhv_black_smoke_mario_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_black_smoke_mario_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_black_smoke_upward_loop](#bhv_black_smoke_upward_loop)
### Lua Example
`bhv_black_smoke_upward_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_black_smoke_upward_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_blue_bowser_flame_init](#bhv_blue_bowser_flame_init)
### Lua Example
`bhv_blue_bowser_flame_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_blue_bowser_flame_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_blue_bowser_flame_loop](#bhv_blue_bowser_flame_loop)
### Lua Example
`bhv_blue_bowser_flame_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_blue_bowser_flame_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_blue_coin_jumping_loop](#bhv_blue_coin_jumping_loop)
### Lua Example
`bhv_blue_coin_jumping_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_blue_coin_jumping_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_blue_coin_sliding_jumping_init](#bhv_blue_coin_sliding_jumping_init)
### Lua Example
`bhv_blue_coin_sliding_jumping_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_blue_coin_sliding_jumping_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_blue_coin_sliding_loop](#bhv_blue_coin_sliding_loop)
### Lua Example
`bhv_blue_coin_sliding_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_blue_coin_sliding_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_blue_coin_switch_loop](#bhv_blue_coin_switch_loop)
### Lua Example
`bhv_blue_coin_switch_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_blue_coin_switch_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_blue_fish_movement_loop](#bhv_blue_fish_movement_loop)
### Lua Example
`bhv_blue_fish_movement_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_blue_fish_movement_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_blue_flames_group_loop](#bhv_blue_flames_group_loop)
### Lua Example
`bhv_blue_flames_group_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_blue_flames_group_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bob_pit_bowling_ball_init](#bhv_bob_pit_bowling_ball_init)
### Lua Example
`bhv_bob_pit_bowling_ball_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bob_pit_bowling_ball_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bob_pit_bowling_ball_loop](#bhv_bob_pit_bowling_ball_loop)
### Lua Example
`bhv_bob_pit_bowling_ball_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bob_pit_bowling_ball_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bobomb_anchor_mario_loop](#bhv_bobomb_anchor_mario_loop)
### Lua Example
`bhv_bobomb_anchor_mario_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bobomb_anchor_mario_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bobomb_buddy_init](#bhv_bobomb_buddy_init)
### Lua Example
`bhv_bobomb_buddy_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bobomb_buddy_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bobomb_buddy_loop](#bhv_bobomb_buddy_loop)
### Lua Example
`bhv_bobomb_buddy_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bobomb_buddy_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bobomb_bully_death_smoke_init](#bhv_bobomb_bully_death_smoke_init)
### Lua Example
`bhv_bobomb_bully_death_smoke_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bobomb_bully_death_smoke_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bobomb_explosion_bubble_init](#bhv_bobomb_explosion_bubble_init)
### Lua Example
`bhv_bobomb_explosion_bubble_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bobomb_explosion_bubble_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bobomb_explosion_bubble_loop](#bhv_bobomb_explosion_bubble_loop)
### Lua Example
`bhv_bobomb_explosion_bubble_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bobomb_explosion_bubble_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bobomb_fuse_smoke_init](#bhv_bobomb_fuse_smoke_init)
### Lua Example
`bhv_bobomb_fuse_smoke_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bobomb_fuse_smoke_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bobomb_init](#bhv_bobomb_init)
### Lua Example
`bhv_bobomb_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bobomb_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bobomb_loop](#bhv_bobomb_loop)
### Lua Example
`bhv_bobomb_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bobomb_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_boo_boss_spawned_bridge_loop](#bhv_boo_boss_spawned_bridge_loop)
### Lua Example
`bhv_boo_boss_spawned_bridge_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_boo_boss_spawned_bridge_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_boo_cage_init](#bhv_boo_cage_init)
### Lua Example
`bhv_boo_cage_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_boo_cage_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_boo_cage_loop](#bhv_boo_cage_loop)
### Lua Example
`bhv_boo_cage_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_boo_cage_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_boo_in_castle_loop](#bhv_boo_in_castle_loop)
### Lua Example
`bhv_boo_in_castle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_boo_in_castle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_boo_init](#bhv_boo_init)
### Lua Example
`bhv_boo_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_boo_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_boo_loop](#bhv_boo_loop)
### Lua Example
`bhv_boo_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_boo_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_boo_with_cage_init](#bhv_boo_with_cage_init)
### Lua Example
`bhv_boo_with_cage_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_boo_with_cage_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_boo_with_cage_loop](#bhv_boo_with_cage_loop)
### Lua Example
`bhv_boo_with_cage_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_boo_with_cage_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_book_switch_loop](#bhv_book_switch_loop)
### Lua Example
`bhv_book_switch_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_book_switch_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bookend_spawn_loop](#bhv_bookend_spawn_loop)
### Lua Example
`bhv_bookend_spawn_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bookend_spawn_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bouncing_fireball_flame_loop](#bhv_bouncing_fireball_flame_loop)
### Lua Example
`bhv_bouncing_fireball_flame_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bouncing_fireball_flame_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bouncing_fireball_loop](#bhv_bouncing_fireball_loop)
### Lua Example
`bhv_bouncing_fireball_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bouncing_fireball_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowling_ball_init](#bhv_bowling_ball_init)
### Lua Example
`bhv_bowling_ball_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowling_ball_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowling_ball_loop](#bhv_bowling_ball_loop)
### Lua Example
`bhv_bowling_ball_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowling_ball_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_body_anchor_init](#bhv_bowser_body_anchor_init)
### Lua Example
`bhv_bowser_body_anchor_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_body_anchor_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_body_anchor_loop](#bhv_bowser_body_anchor_loop)
### Lua Example
`bhv_bowser_body_anchor_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_body_anchor_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_bomb_explosion_loop](#bhv_bowser_bomb_explosion_loop)
### Lua Example
`bhv_bowser_bomb_explosion_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_bomb_explosion_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_bomb_loop](#bhv_bowser_bomb_loop)
### Lua Example
`bhv_bowser_bomb_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_bomb_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_bomb_smoke_loop](#bhv_bowser_bomb_smoke_loop)
### Lua Example
`bhv_bowser_bomb_smoke_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_bomb_smoke_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_course_red_coin_star_loop](#bhv_bowser_course_red_coin_star_loop)
### Lua Example
`bhv_bowser_course_red_coin_star_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_course_red_coin_star_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_flame_spawn_loop](#bhv_bowser_flame_spawn_loop)
### Lua Example
`bhv_bowser_flame_spawn_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_flame_spawn_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_init](#bhv_bowser_init)
### Lua Example
`bhv_bowser_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_key_course_exit_loop](#bhv_bowser_key_course_exit_loop)
### Lua Example
`bhv_bowser_key_course_exit_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_key_course_exit_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_key_init](#bhv_bowser_key_init)
### Lua Example
`bhv_bowser_key_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_key_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_key_loop](#bhv_bowser_key_loop)
### Lua Example
`bhv_bowser_key_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_key_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_key_unlock_door_loop](#bhv_bowser_key_unlock_door_loop)
### Lua Example
`bhv_bowser_key_unlock_door_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_key_unlock_door_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_loop](#bhv_bowser_loop)
### Lua Example
`bhv_bowser_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_shock_wave_loop](#bhv_bowser_shock_wave_loop)
### Lua Example
`bhv_bowser_shock_wave_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_shock_wave_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_tail_anchor_init](#bhv_bowser_tail_anchor_init)
### Lua Example
`bhv_bowser_tail_anchor_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_tail_anchor_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowser_tail_anchor_loop](#bhv_bowser_tail_anchor_loop)
### Lua Example
`bhv_bowser_tail_anchor_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowser_tail_anchor_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bowsers_sub_loop](#bhv_bowsers_sub_loop)
### Lua Example
`bhv_bowsers_sub_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bowsers_sub_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_breakable_box_loop](#bhv_breakable_box_loop)
### Lua Example
`bhv_breakable_box_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_breakable_box_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_breakable_box_small_init](#bhv_breakable_box_small_init)
### Lua Example
`bhv_breakable_box_small_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_breakable_box_small_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_breakable_box_small_loop](#bhv_breakable_box_small_loop)
### Lua Example
`bhv_breakable_box_small_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_breakable_box_small_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bub_loop](#bhv_bub_loop)
### Lua Example
`bhv_bub_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bub_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bub_spawner_loop](#bhv_bub_spawner_loop)
### Lua Example
`bhv_bub_spawner_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bub_spawner_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bubba_loop](#bhv_bubba_loop)
### Lua Example
`bhv_bubba_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bubba_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bubble_cannon_barrel_loop](#bhv_bubble_cannon_barrel_loop)
### Lua Example
`bhv_bubble_cannon_barrel_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bubble_cannon_barrel_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bubble_maybe_loop](#bhv_bubble_maybe_loop)
### Lua Example
`bhv_bubble_maybe_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bubble_maybe_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bubble_player_loop](#bhv_bubble_player_loop)
### Lua Example
`bhv_bubble_player_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bubble_player_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bubble_splash_init](#bhv_bubble_splash_init)
### Lua Example
`bhv_bubble_splash_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bubble_splash_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bubble_wave_init](#bhv_bubble_wave_init)
### Lua Example
`bhv_bubble_wave_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bubble_wave_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bullet_bill_init](#bhv_bullet_bill_init)
### Lua Example
`bhv_bullet_bill_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bullet_bill_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bullet_bill_loop](#bhv_bullet_bill_loop)
### Lua Example
`bhv_bullet_bill_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bullet_bill_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_bully_loop](#bhv_bully_loop)
### Lua Example
`bhv_bully_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_bully_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_butterfly_init](#bhv_butterfly_init)
### Lua Example
`bhv_butterfly_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_butterfly_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_butterfly_loop](#bhv_butterfly_loop)
### Lua Example
`bhv_butterfly_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_butterfly_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_camera_lakitu_init](#bhv_camera_lakitu_init)
### Lua Example
`bhv_camera_lakitu_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_camera_lakitu_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_camera_lakitu_update](#bhv_camera_lakitu_update)
### Lua Example
`bhv_camera_lakitu_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_camera_lakitu_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_cannon_barrel_loop](#bhv_cannon_barrel_loop)
### Lua Example
`bhv_cannon_barrel_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_cannon_barrel_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_cannon_base_loop](#bhv_cannon_base_loop)
### Lua Example
`bhv_cannon_base_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_cannon_base_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_cannon_base_unused_loop](#bhv_cannon_base_unused_loop)
### Lua Example
`bhv_cannon_base_unused_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_cannon_base_unused_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_cannon_closed_init](#bhv_cannon_closed_init)
### Lua Example
`bhv_cannon_closed_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_cannon_closed_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_cannon_closed_loop](#bhv_cannon_closed_loop)
### Lua Example
`bhv_cannon_closed_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_cannon_closed_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_cap_switch_loop](#bhv_cap_switch_loop)
### Lua Example
`bhv_cap_switch_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_cap_switch_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_castle_cannon_grate_init](#bhv_castle_cannon_grate_init)
### Lua Example
`bhv_castle_cannon_grate_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_castle_cannon_grate_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_castle_flag_init](#bhv_castle_flag_init)
### Lua Example
`bhv_castle_flag_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_castle_flag_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_castle_floor_trap_init](#bhv_castle_floor_trap_init)
### Lua Example
`bhv_castle_floor_trap_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_castle_floor_trap_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_castle_floor_trap_loop](#bhv_castle_floor_trap_loop)
### Lua Example
`bhv_castle_floor_trap_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_castle_floor_trap_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ccm_touched_star_spawn_loop](#bhv_ccm_touched_star_spawn_loop)
### Lua Example
`bhv_ccm_touched_star_spawn_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ccm_touched_star_spawn_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_celebration_star_init](#bhv_celebration_star_init)
### Lua Example
`bhv_celebration_star_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_celebration_star_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_celebration_star_loop](#bhv_celebration_star_loop)
### Lua Example
`bhv_celebration_star_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_celebration_star_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_celebration_star_sparkle_loop](#bhv_celebration_star_sparkle_loop)
### Lua Example
`bhv_celebration_star_sparkle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_celebration_star_sparkle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_chain_chomp_chain_part_update](#bhv_chain_chomp_chain_part_update)
### Lua Example
`bhv_chain_chomp_chain_part_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_chain_chomp_chain_part_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_chain_chomp_gate_init](#bhv_chain_chomp_gate_init)
### Lua Example
`bhv_chain_chomp_gate_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_chain_chomp_gate_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_chain_chomp_gate_update](#bhv_chain_chomp_gate_update)
### Lua Example
`bhv_chain_chomp_gate_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_chain_chomp_gate_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_chain_chomp_update](#bhv_chain_chomp_update)
### Lua Example
`bhv_chain_chomp_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_chain_chomp_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_checkerboard_elevator_group_init](#bhv_checkerboard_elevator_group_init)
### Lua Example
`bhv_checkerboard_elevator_group_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_checkerboard_elevator_group_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_checkerboard_elevator_group_loop](#bhv_checkerboard_elevator_group_loop)
### Lua Example
`bhv_checkerboard_elevator_group_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_checkerboard_elevator_group_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_checkerboard_platform_init](#bhv_checkerboard_platform_init)
### Lua Example
`bhv_checkerboard_platform_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_checkerboard_platform_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_checkerboard_platform_loop](#bhv_checkerboard_platform_loop)
### Lua Example
`bhv_checkerboard_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_checkerboard_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_chuckya_anchor_mario_loop](#bhv_chuckya_anchor_mario_loop)
### Lua Example
`bhv_chuckya_anchor_mario_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_chuckya_anchor_mario_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_chuckya_loop](#bhv_chuckya_loop)
### Lua Example
`bhv_chuckya_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_chuckya_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_circling_amp_init](#bhv_circling_amp_init)
### Lua Example
`bhv_circling_amp_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_circling_amp_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_circling_amp_loop](#bhv_circling_amp_loop)
### Lua Example
`bhv_circling_amp_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_circling_amp_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_clam_loop](#bhv_clam_loop)
### Lua Example
`bhv_clam_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_clam_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_cloud_part_update](#bhv_cloud_part_update)
### Lua Example
`bhv_cloud_part_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_cloud_part_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_cloud_update](#bhv_cloud_update)
### Lua Example
`bhv_cloud_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_cloud_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_coffin_loop](#bhv_coffin_loop)
### Lua Example
`bhv_coffin_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_coffin_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_coffin_spawner_loop](#bhv_coffin_spawner_loop)
### Lua Example
`bhv_coffin_spawner_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_coffin_spawner_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_coin_formation_init](#bhv_coin_formation_init)
### Lua Example
`bhv_coin_formation_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_coin_formation_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_coin_formation_loop](#bhv_coin_formation_loop)
### Lua Example
`bhv_coin_formation_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_coin_formation_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_coin_formation_spawn_loop](#bhv_coin_formation_spawn_loop)
### Lua Example
`bhv_coin_formation_spawn_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_coin_formation_spawn_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_coin_init](#bhv_coin_init)
### Lua Example
`bhv_coin_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_coin_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_coin_inside_boo_loop](#bhv_coin_inside_boo_loop)
### Lua Example
`bhv_coin_inside_boo_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_coin_inside_boo_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_coin_loop](#bhv_coin_loop)
### Lua Example
`bhv_coin_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_coin_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_coin_sparkles_loop](#bhv_coin_sparkles_loop)
### Lua Example
`bhv_coin_sparkles_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_coin_sparkles_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_collect_star_init](#bhv_collect_star_init)
### Lua Example
`bhv_collect_star_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_collect_star_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_collect_star_loop](#bhv_collect_star_loop)
### Lua Example
`bhv_collect_star_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_collect_star_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_controllable_platform_init](#bhv_controllable_platform_init)
### Lua Example
`bhv_controllable_platform_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_controllable_platform_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_controllable_platform_loop](#bhv_controllable_platform_loop)
### Lua Example
`bhv_controllable_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_controllable_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_controllable_platform_sub_loop](#bhv_controllable_platform_sub_loop)
### Lua Example
`bhv_controllable_platform_sub_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_controllable_platform_sub_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_courtyard_boo_triplet_init](#bhv_courtyard_boo_triplet_init)
### Lua Example
`bhv_courtyard_boo_triplet_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_courtyard_boo_triplet_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ddd_moving_pole_loop](#bhv_ddd_moving_pole_loop)
### Lua Example
`bhv_ddd_moving_pole_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ddd_moving_pole_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ddd_pole_init](#bhv_ddd_pole_init)
### Lua Example
`bhv_ddd_pole_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ddd_pole_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ddd_pole_update](#bhv_ddd_pole_update)
### Lua Example
`bhv_ddd_pole_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ddd_pole_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ddd_warp_loop](#bhv_ddd_warp_loop)
### Lua Example
`bhv_ddd_warp_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ddd_warp_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_decorative_pendulum_init](#bhv_decorative_pendulum_init)
### Lua Example
`bhv_decorative_pendulum_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_decorative_pendulum_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_decorative_pendulum_loop](#bhv_decorative_pendulum_loop)
### Lua Example
`bhv_decorative_pendulum_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_decorative_pendulum_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_donut_platform_spawner_update](#bhv_donut_platform_spawner_update)
### Lua Example
`bhv_donut_platform_spawner_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_donut_platform_spawner_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_donut_platform_update](#bhv_donut_platform_update)
### Lua Example
`bhv_donut_platform_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_donut_platform_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_door_init](#bhv_door_init)
### Lua Example
`bhv_door_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_door_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_door_loop](#bhv_door_loop)
### Lua Example
`bhv_door_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_door_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_dorrie_update](#bhv_dorrie_update)
### Lua Example
`bhv_dorrie_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_dorrie_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_elevator_init](#bhv_elevator_init)
### Lua Example
`bhv_elevator_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_elevator_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_elevator_loop](#bhv_elevator_loop)
### Lua Example
`bhv_elevator_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_elevator_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_end_birds_1_loop](#bhv_end_birds_1_loop)
### Lua Example
`bhv_end_birds_1_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_end_birds_1_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_end_birds_2_loop](#bhv_end_birds_2_loop)
### Lua Example
`bhv_end_birds_2_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_end_birds_2_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_enemy_lakitu_update](#bhv_enemy_lakitu_update)
### Lua Example
`bhv_enemy_lakitu_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_enemy_lakitu_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_exclamation_box_init](#bhv_exclamation_box_init)
### Lua Example
`bhv_exclamation_box_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_exclamation_box_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_exclamation_box_loop](#bhv_exclamation_box_loop)
### Lua Example
`bhv_exclamation_box_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_exclamation_box_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_explosion_init](#bhv_explosion_init)
### Lua Example
`bhv_explosion_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_explosion_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_explosion_loop](#bhv_explosion_loop)
### Lua Example
`bhv_explosion_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_explosion_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_eyerok_boss_init](#bhv_eyerok_boss_init)
### Lua Example
`bhv_eyerok_boss_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_eyerok_boss_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_eyerok_boss_loop](#bhv_eyerok_boss_loop)
### Lua Example
`bhv_eyerok_boss_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_eyerok_boss_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_eyerok_hand_loop](#bhv_eyerok_hand_loop)
### Lua Example
`bhv_eyerok_hand_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_eyerok_hand_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_fading_warp_loop](#bhv_fading_warp_loop)
### Lua Example
`bhv_fading_warp_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_fading_warp_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_falling_bowser_platform_loop](#bhv_falling_bowser_platform_loop)
### Lua Example
`bhv_falling_bowser_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_falling_bowser_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_falling_pillar_hitbox_loop](#bhv_falling_pillar_hitbox_loop)
### Lua Example
`bhv_falling_pillar_hitbox_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_falling_pillar_hitbox_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_falling_pillar_init](#bhv_falling_pillar_init)
### Lua Example
`bhv_falling_pillar_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_falling_pillar_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_falling_pillar_loop](#bhv_falling_pillar_loop)
### Lua Example
`bhv_falling_pillar_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_falling_pillar_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ferris_wheel_axle_init](#bhv_ferris_wheel_axle_init)
### Lua Example
`bhv_ferris_wheel_axle_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ferris_wheel_axle_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ferris_wheel_platform_update](#bhv_ferris_wheel_platform_update)
### Lua Example
`bhv_ferris_wheel_platform_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ferris_wheel_platform_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_fire_piranha_plant_init](#bhv_fire_piranha_plant_init)
### Lua Example
`bhv_fire_piranha_plant_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_fire_piranha_plant_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_fire_piranha_plant_update](#bhv_fire_piranha_plant_update)
### Lua Example
`bhv_fire_piranha_plant_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_fire_piranha_plant_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_fire_spitter_update](#bhv_fire_spitter_update)
### Lua Example
`bhv_fire_spitter_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_fire_spitter_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_fish_group_loop](#bhv_fish_group_loop)
### Lua Example
`bhv_fish_group_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_fish_group_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_fish_loop](#bhv_fish_loop)
### Lua Example
`bhv_fish_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_fish_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_fish_spawner_loop](#bhv_fish_spawner_loop)
### Lua Example
`bhv_fish_spawner_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_fish_spawner_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flame_bouncing_init](#bhv_flame_bouncing_init)
### Lua Example
`bhv_flame_bouncing_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flame_bouncing_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flame_bouncing_loop](#bhv_flame_bouncing_loop)
### Lua Example
`bhv_flame_bouncing_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flame_bouncing_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flame_bowser_init](#bhv_flame_bowser_init)
### Lua Example
`bhv_flame_bowser_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flame_bowser_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flame_bowser_loop](#bhv_flame_bowser_loop)
### Lua Example
`bhv_flame_bowser_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flame_bowser_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flame_floating_landing_init](#bhv_flame_floating_landing_init)
### Lua Example
`bhv_flame_floating_landing_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flame_floating_landing_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flame_floating_landing_loop](#bhv_flame_floating_landing_loop)
### Lua Example
`bhv_flame_floating_landing_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flame_floating_landing_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flame_large_burning_out_init](#bhv_flame_large_burning_out_init)
### Lua Example
`bhv_flame_large_burning_out_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flame_large_burning_out_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flame_mario_loop](#bhv_flame_mario_loop)
### Lua Example
`bhv_flame_mario_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flame_mario_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flame_moving_forward_growing_init](#bhv_flame_moving_forward_growing_init)
### Lua Example
`bhv_flame_moving_forward_growing_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flame_moving_forward_growing_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flame_moving_forward_growing_loop](#bhv_flame_moving_forward_growing_loop)
### Lua Example
`bhv_flame_moving_forward_growing_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flame_moving_forward_growing_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flamethrower_flame_loop](#bhv_flamethrower_flame_loop)
### Lua Example
`bhv_flamethrower_flame_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flamethrower_flame_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flamethrower_loop](#bhv_flamethrower_loop)
### Lua Example
`bhv_flamethrower_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flamethrower_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_floating_platform_loop](#bhv_floating_platform_loop)
### Lua Example
`bhv_floating_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_floating_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_floor_trap_in_castle_loop](#bhv_floor_trap_in_castle_loop)
### Lua Example
`bhv_floor_trap_in_castle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_floor_trap_in_castle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_fly_guy_flame_loop](#bhv_fly_guy_flame_loop)
### Lua Example
`bhv_fly_guy_flame_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_fly_guy_flame_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_fly_guy_update](#bhv_fly_guy_update)
### Lua Example
`bhv_fly_guy_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_fly_guy_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_flying_bookend_loop](#bhv_flying_bookend_loop)
### Lua Example
`bhv_flying_bookend_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_flying_bookend_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_free_bowling_ball_init](#bhv_free_bowling_ball_init)
### Lua Example
`bhv_free_bowling_ball_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_free_bowling_ball_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_free_bowling_ball_loop](#bhv_free_bowling_ball_loop)
### Lua Example
`bhv_free_bowling_ball_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_free_bowling_ball_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_generic_bowling_ball_spawner_init](#bhv_generic_bowling_ball_spawner_init)
### Lua Example
`bhv_generic_bowling_ball_spawner_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_generic_bowling_ball_spawner_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_generic_bowling_ball_spawner_loop](#bhv_generic_bowling_ball_spawner_loop)
### Lua Example
`bhv_generic_bowling_ball_spawner_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_generic_bowling_ball_spawner_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_giant_pole_loop](#bhv_giant_pole_loop)
### Lua Example
`bhv_giant_pole_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_giant_pole_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_golden_coin_sparkles_loop](#bhv_golden_coin_sparkles_loop)
### Lua Example
`bhv_golden_coin_sparkles_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_golden_coin_sparkles_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_goomba_init](#bhv_goomba_init)
### Lua Example
`bhv_goomba_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_goomba_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_goomba_triplet_spawner_update](#bhv_goomba_triplet_spawner_update)
### Lua Example
`bhv_goomba_triplet_spawner_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_goomba_triplet_spawner_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_goomba_update](#bhv_goomba_update)
### Lua Example
`bhv_goomba_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_goomba_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_grand_star_init](#bhv_grand_star_init)
### Lua Example
`bhv_grand_star_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_grand_star_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_grand_star_loop](#bhv_grand_star_loop)
### Lua Example
`bhv_grand_star_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_grand_star_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_grindel_thwomp_loop](#bhv_grindel_thwomp_loop)
### Lua Example
`bhv_grindel_thwomp_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_grindel_thwomp_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ground_sand_init](#bhv_ground_sand_init)
### Lua Example
`bhv_ground_sand_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ground_sand_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ground_snow_init](#bhv_ground_snow_init)
### Lua Example
`bhv_ground_snow_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ground_snow_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_haunted_bookshelf_loop](#bhv_haunted_bookshelf_loop)
### Lua Example
`bhv_haunted_bookshelf_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_haunted_bookshelf_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_haunted_bookshelf_manager_loop](#bhv_haunted_bookshelf_manager_loop)
### Lua Example
`bhv_haunted_bookshelf_manager_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_haunted_bookshelf_manager_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_haunted_chair_init](#bhv_haunted_chair_init)
### Lua Example
`bhv_haunted_chair_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_haunted_chair_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_haunted_chair_loop](#bhv_haunted_chair_loop)
### Lua Example
`bhv_haunted_chair_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_haunted_chair_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_heave_ho_loop](#bhv_heave_ho_loop)
### Lua Example
`bhv_heave_ho_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_heave_ho_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_heave_ho_throw_mario_loop](#bhv_heave_ho_throw_mario_loop)
### Lua Example
`bhv_heave_ho_throw_mario_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_heave_ho_throw_mario_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_hidden_blue_coin_loop](#bhv_hidden_blue_coin_loop)
### Lua Example
`bhv_hidden_blue_coin_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_hidden_blue_coin_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_hidden_object_loop](#bhv_hidden_object_loop)
### Lua Example
`bhv_hidden_object_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_hidden_object_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_hidden_red_coin_star_init](#bhv_hidden_red_coin_star_init)
### Lua Example
`bhv_hidden_red_coin_star_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_hidden_red_coin_star_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_hidden_red_coin_star_loop](#bhv_hidden_red_coin_star_loop)
### Lua Example
`bhv_hidden_red_coin_star_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_hidden_red_coin_star_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_hidden_star_init](#bhv_hidden_star_init)
### Lua Example
`bhv_hidden_star_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_hidden_star_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_hidden_star_loop](#bhv_hidden_star_loop)
### Lua Example
`bhv_hidden_star_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_hidden_star_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_hidden_star_trigger_loop](#bhv_hidden_star_trigger_loop)
### Lua Example
`bhv_hidden_star_trigger_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_hidden_star_trigger_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_homing_amp_init](#bhv_homing_amp_init)
### Lua Example
`bhv_homing_amp_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_homing_amp_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_homing_amp_loop](#bhv_homing_amp_loop)
### Lua Example
`bhv_homing_amp_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_homing_amp_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_hoot_init](#bhv_hoot_init)
### Lua Example
`bhv_hoot_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_hoot_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_hoot_loop](#bhv_hoot_loop)
### Lua Example
`bhv_hoot_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_hoot_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_horizontal_grindel_init](#bhv_horizontal_grindel_init)
### Lua Example
`bhv_horizontal_grindel_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_horizontal_grindel_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_horizontal_grindel_update](#bhv_horizontal_grindel_update)
### Lua Example
`bhv_horizontal_grindel_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_horizontal_grindel_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_idle_water_wave_loop](#bhv_idle_water_wave_loop)
### Lua Example
`bhv_idle_water_wave_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_idle_water_wave_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_init_changing_water_level_loop](#bhv_init_changing_water_level_loop)
### Lua Example
`bhv_init_changing_water_level_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_init_changing_water_level_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_intro_lakitu_loop](#bhv_intro_lakitu_loop)
### Lua Example
`bhv_intro_lakitu_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_intro_lakitu_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_intro_peach_loop](#bhv_intro_peach_loop)
### Lua Example
`bhv_intro_peach_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_intro_peach_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_intro_scene_loop](#bhv_intro_scene_loop)
### Lua Example
`bhv_intro_scene_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_intro_scene_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_invisible_objects_under_bridge_init](#bhv_invisible_objects_under_bridge_init)
### Lua Example
`bhv_invisible_objects_under_bridge_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_invisible_objects_under_bridge_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_invisible_objects_under_bridge_loop](#bhv_invisible_objects_under_bridge_loop)
### Lua Example
`bhv_invisible_objects_under_bridge_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_invisible_objects_under_bridge_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_jet_stream_loop](#bhv_jet_stream_loop)
### Lua Example
`bhv_jet_stream_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_jet_stream_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_jet_stream_ring_spawner_loop](#bhv_jet_stream_ring_spawner_loop)
### Lua Example
`bhv_jet_stream_ring_spawner_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_jet_stream_ring_spawner_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_jet_stream_water_ring_init](#bhv_jet_stream_water_ring_init)
### Lua Example
`bhv_jet_stream_water_ring_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_jet_stream_water_ring_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_jet_stream_water_ring_loop](#bhv_jet_stream_water_ring_loop)
### Lua Example
`bhv_jet_stream_water_ring_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_jet_stream_water_ring_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_jrb_floating_box_loop](#bhv_jrb_floating_box_loop)
### Lua Example
`bhv_jrb_floating_box_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_jrb_floating_box_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_jrb_sliding_box_loop](#bhv_jrb_sliding_box_loop)
### Lua Example
`bhv_jrb_sliding_box_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_jrb_sliding_box_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_jumping_box_loop](#bhv_jumping_box_loop)
### Lua Example
`bhv_jumping_box_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_jumping_box_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_kickable_board_loop](#bhv_kickable_board_loop)
### Lua Example
`bhv_kickable_board_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_kickable_board_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_king_bobomb_loop](#bhv_king_bobomb_loop)
### Lua Example
`bhv_king_bobomb_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_king_bobomb_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_klepto_init](#bhv_klepto_init)
### Lua Example
`bhv_klepto_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_klepto_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_klepto_update](#bhv_klepto_update)
### Lua Example
`bhv_klepto_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_klepto_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_koopa_init](#bhv_koopa_init)
### Lua Example
`bhv_koopa_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_koopa_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_koopa_race_endpoint_update](#bhv_koopa_race_endpoint_update)
### Lua Example
`bhv_koopa_race_endpoint_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_koopa_race_endpoint_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_koopa_shell_flame_loop](#bhv_koopa_shell_flame_loop)
### Lua Example
`bhv_koopa_shell_flame_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_koopa_shell_flame_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_koopa_shell_loop](#bhv_koopa_shell_loop)
### Lua Example
`bhv_koopa_shell_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_koopa_shell_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_koopa_shell_underwater_loop](#bhv_koopa_shell_underwater_loop)
### Lua Example
`bhv_koopa_shell_underwater_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_koopa_shell_underwater_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_koopa_update](#bhv_koopa_update)
### Lua Example
`bhv_koopa_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_koopa_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_large_bomp_init](#bhv_large_bomp_init)
### Lua Example
`bhv_large_bomp_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_large_bomp_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_large_bomp_loop](#bhv_large_bomp_loop)
### Lua Example
`bhv_large_bomp_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_large_bomp_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_bowser_puzzle_loop](#bhv_lll_bowser_puzzle_loop)
### Lua Example
`bhv_lll_bowser_puzzle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_bowser_puzzle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_bowser_puzzle_piece_loop](#bhv_lll_bowser_puzzle_piece_loop)
### Lua Example
`bhv_lll_bowser_puzzle_piece_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_bowser_puzzle_piece_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_drawbridge_loop](#bhv_lll_drawbridge_loop)
### Lua Example
`bhv_lll_drawbridge_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_drawbridge_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_drawbridge_spawner_init](#bhv_lll_drawbridge_spawner_init)
### Lua Example
`bhv_lll_drawbridge_spawner_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_drawbridge_spawner_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_drawbridge_spawner_loop](#bhv_lll_drawbridge_spawner_loop)
### Lua Example
`bhv_lll_drawbridge_spawner_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_drawbridge_spawner_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_floating_wood_bridge_loop](#bhv_lll_floating_wood_bridge_loop)
### Lua Example
`bhv_lll_floating_wood_bridge_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_floating_wood_bridge_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_moving_octagonal_mesh_platform_loop](#bhv_lll_moving_octagonal_mesh_platform_loop)
### Lua Example
`bhv_lll_moving_octagonal_mesh_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_moving_octagonal_mesh_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_rolling_log_init](#bhv_lll_rolling_log_init)
### Lua Example
`bhv_lll_rolling_log_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_rolling_log_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_rotating_block_fire_bars_loop](#bhv_lll_rotating_block_fire_bars_loop)
### Lua Example
`bhv_lll_rotating_block_fire_bars_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_rotating_block_fire_bars_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_rotating_hex_flame_loop](#bhv_lll_rotating_hex_flame_loop)
### Lua Example
`bhv_lll_rotating_hex_flame_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_rotating_hex_flame_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_rotating_hexagonal_ring_loop](#bhv_lll_rotating_hexagonal_ring_loop)
### Lua Example
`bhv_lll_rotating_hexagonal_ring_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_rotating_hexagonal_ring_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_sinking_rectangular_platform_loop](#bhv_lll_sinking_rectangular_platform_loop)
### Lua Example
`bhv_lll_sinking_rectangular_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_sinking_rectangular_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_sinking_rock_block_loop](#bhv_lll_sinking_rock_block_loop)
### Lua Example
`bhv_lll_sinking_rock_block_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_sinking_rock_block_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_sinking_square_platforms_loop](#bhv_lll_sinking_square_platforms_loop)
### Lua Example
`bhv_lll_sinking_square_platforms_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_sinking_square_platforms_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_lll_wood_piece_loop](#bhv_lll_wood_piece_loop)
### Lua Example
`bhv_lll_wood_piece_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_lll_wood_piece_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_mad_piano_update](#bhv_mad_piano_update)
### Lua Example
`bhv_mad_piano_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_mad_piano_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_manta_ray_init](#bhv_manta_ray_init)
### Lua Example
`bhv_manta_ray_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_manta_ray_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_manta_ray_loop](#bhv_manta_ray_loop)
### Lua Example
`bhv_manta_ray_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_manta_ray_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_manta_ray_water_ring_init](#bhv_manta_ray_water_ring_init)
### Lua Example
`bhv_manta_ray_water_ring_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_manta_ray_water_ring_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_manta_ray_water_ring_loop](#bhv_manta_ray_water_ring_loop)
### Lua Example
`bhv_manta_ray_water_ring_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_manta_ray_water_ring_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_menu_button_init](#bhv_menu_button_init)
### Lua Example
`bhv_menu_button_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_menu_button_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_menu_button_loop](#bhv_menu_button_loop)
### Lua Example
`bhv_menu_button_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_menu_button_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_menu_button_manager_init](#bhv_menu_button_manager_init)
### Lua Example
`bhv_menu_button_manager_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_menu_button_manager_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_menu_button_manager_loop](#bhv_menu_button_manager_loop)
### Lua Example
`bhv_menu_button_manager_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_menu_button_manager_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_merry_go_round_boo_manager_loop](#bhv_merry_go_round_boo_manager_loop)
### Lua Example
`bhv_merry_go_round_boo_manager_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_merry_go_round_boo_manager_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_merry_go_round_loop](#bhv_merry_go_round_loop)
### Lua Example
`bhv_merry_go_round_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_merry_go_round_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_metal_cap_init](#bhv_metal_cap_init)
### Lua Example
`bhv_metal_cap_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_metal_cap_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_metal_cap_loop](#bhv_metal_cap_loop)
### Lua Example
`bhv_metal_cap_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_metal_cap_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_mips_init](#bhv_mips_init)
### Lua Example
`bhv_mips_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_mips_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_mips_loop](#bhv_mips_loop)
### Lua Example
`bhv_mips_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_mips_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_moat_grills_loop](#bhv_moat_grills_loop)
### Lua Example
`bhv_moat_grills_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_moat_grills_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_moneybag_hidden_loop](#bhv_moneybag_hidden_loop)
### Lua Example
`bhv_moneybag_hidden_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_moneybag_hidden_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_moneybag_init](#bhv_moneybag_init)
### Lua Example
`bhv_moneybag_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_moneybag_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_moneybag_loop](#bhv_moneybag_loop)
### Lua Example
`bhv_moneybag_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_moneybag_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_monty_mole_hole_update](#bhv_monty_mole_hole_update)
### Lua Example
`bhv_monty_mole_hole_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_monty_mole_hole_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_monty_mole_init](#bhv_monty_mole_init)
### Lua Example
`bhv_monty_mole_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_monty_mole_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_monty_mole_rock_update](#bhv_monty_mole_rock_update)
### Lua Example
`bhv_monty_mole_rock_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_monty_mole_rock_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_monty_mole_update](#bhv_monty_mole_update)
### Lua Example
`bhv_monty_mole_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_monty_mole_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_moving_blue_coin_init](#bhv_moving_blue_coin_init)
### Lua Example
`bhv_moving_blue_coin_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_moving_blue_coin_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_moving_blue_coin_loop](#bhv_moving_blue_coin_loop)
### Lua Example
`bhv_moving_blue_coin_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_moving_blue_coin_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_moving_yellow_coin_init](#bhv_moving_yellow_coin_init)
### Lua Example
`bhv_moving_yellow_coin_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_moving_yellow_coin_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_moving_yellow_coin_loop](#bhv_moving_yellow_coin_loop)
### Lua Example
`bhv_moving_yellow_coin_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_moving_yellow_coin_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_mr_blizzard_init](#bhv_mr_blizzard_init)
### Lua Example
`bhv_mr_blizzard_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_mr_blizzard_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_mr_blizzard_snowball](#bhv_mr_blizzard_snowball)
### Lua Example
`bhv_mr_blizzard_snowball()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_mr_blizzard_snowball(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_mr_blizzard_update](#bhv_mr_blizzard_update)
### Lua Example
`bhv_mr_blizzard_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_mr_blizzard_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_mr_i_body_loop](#bhv_mr_i_body_loop)
### Lua Example
`bhv_mr_i_body_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_mr_i_body_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_mr_i_loop](#bhv_mr_i_loop)
### Lua Example
`bhv_mr_i_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_mr_i_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_mr_i_particle_loop](#bhv_mr_i_particle_loop)
### Lua Example
`bhv_mr_i_particle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_mr_i_particle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_normal_cap_init](#bhv_normal_cap_init)
### Lua Example
`bhv_normal_cap_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_normal_cap_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_normal_cap_loop](#bhv_normal_cap_loop)
### Lua Example
`bhv_normal_cap_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_normal_cap_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_object_bubble_init](#bhv_object_bubble_init)
### Lua Example
`bhv_object_bubble_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_object_bubble_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_object_bubble_loop](#bhv_object_bubble_loop)
### Lua Example
`bhv_object_bubble_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_object_bubble_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_object_water_wave_init](#bhv_object_water_wave_init)
### Lua Example
`bhv_object_water_wave_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_object_water_wave_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_object_water_wave_loop](#bhv_object_water_wave_loop)
### Lua Example
`bhv_object_water_wave_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_object_water_wave_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_openable_cage_door_loop](#bhv_openable_cage_door_loop)
### Lua Example
`bhv_openable_cage_door_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_openable_cage_door_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_openable_grill_loop](#bhv_openable_grill_loop)
### Lua Example
`bhv_openable_grill_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_openable_grill_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_orange_number_init](#bhv_orange_number_init)
### Lua Example
`bhv_orange_number_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_orange_number_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_orange_number_loop](#bhv_orange_number_loop)
### Lua Example
`bhv_orange_number_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_orange_number_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_particle_init](#bhv_particle_init)
### Lua Example
`bhv_particle_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_particle_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_particle_loop](#bhv_particle_loop)
### Lua Example
`bhv_particle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_particle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_penguin_race_finish_line_update](#bhv_penguin_race_finish_line_update)
### Lua Example
`bhv_penguin_race_finish_line_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_penguin_race_finish_line_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_penguin_race_shortcut_check_update](#bhv_penguin_race_shortcut_check_update)
### Lua Example
`bhv_penguin_race_shortcut_check_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_penguin_race_shortcut_check_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_piranha_particle_loop](#bhv_piranha_particle_loop)
### Lua Example
`bhv_piranha_particle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_piranha_particle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_piranha_plant_bubble_loop](#bhv_piranha_plant_bubble_loop)
### Lua Example
`bhv_piranha_plant_bubble_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_piranha_plant_bubble_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_piranha_plant_loop](#bhv_piranha_plant_loop)
### Lua Example
`bhv_piranha_plant_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_piranha_plant_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_piranha_plant_waking_bubbles_loop](#bhv_piranha_plant_waking_bubbles_loop)
### Lua Example
`bhv_piranha_plant_waking_bubbles_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_piranha_plant_waking_bubbles_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_platform_normals_init](#bhv_platform_normals_init)
### Lua Example
`bhv_platform_normals_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_platform_normals_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_platform_on_track_init](#bhv_platform_on_track_init)
### Lua Example
`bhv_platform_on_track_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_platform_on_track_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_platform_on_track_update](#bhv_platform_on_track_update)
### Lua Example
`bhv_platform_on_track_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_platform_on_track_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_play_music_track_when_touched_loop](#bhv_play_music_track_when_touched_loop)
### Lua Example
`bhv_play_music_track_when_touched_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_play_music_track_when_touched_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pokey_body_part_update](#bhv_pokey_body_part_update)
### Lua Example
`bhv_pokey_body_part_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pokey_body_part_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pokey_update](#bhv_pokey_update)
### Lua Example
`bhv_pokey_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pokey_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pole_base_loop](#bhv_pole_base_loop)
### Lua Example
`bhv_pole_base_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pole_base_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pole_init](#bhv_pole_init)
### Lua Example
`bhv_pole_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pole_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pound_tiny_star_particle_init](#bhv_pound_tiny_star_particle_init)
### Lua Example
`bhv_pound_tiny_star_particle_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pound_tiny_star_particle_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pound_tiny_star_particle_loop](#bhv_pound_tiny_star_particle_loop)
### Lua Example
`bhv_pound_tiny_star_particle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pound_tiny_star_particle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pound_white_puffs_init](#bhv_pound_white_puffs_init)
### Lua Example
`bhv_pound_white_puffs_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pound_white_puffs_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_punch_tiny_triangle_init](#bhv_punch_tiny_triangle_init)
### Lua Example
`bhv_punch_tiny_triangle_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_punch_tiny_triangle_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_punch_tiny_triangle_loop](#bhv_punch_tiny_triangle_loop)
### Lua Example
`bhv_punch_tiny_triangle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_punch_tiny_triangle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_purple_switch_loop](#bhv_purple_switch_loop)
### Lua Example
`bhv_purple_switch_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_purple_switch_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pushable_loop](#bhv_pushable_loop)
### Lua Example
`bhv_pushable_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pushable_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pyramid_elevator_init](#bhv_pyramid_elevator_init)
### Lua Example
`bhv_pyramid_elevator_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pyramid_elevator_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pyramid_elevator_loop](#bhv_pyramid_elevator_loop)
### Lua Example
`bhv_pyramid_elevator_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pyramid_elevator_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pyramid_elevator_trajectory_marker_ball_loop](#bhv_pyramid_elevator_trajectory_marker_ball_loop)
### Lua Example
`bhv_pyramid_elevator_trajectory_marker_ball_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pyramid_elevator_trajectory_marker_ball_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pyramid_pillar_touch_detector_loop](#bhv_pyramid_pillar_touch_detector_loop)
### Lua Example
`bhv_pyramid_pillar_touch_detector_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pyramid_pillar_touch_detector_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pyramid_top_fragment_init](#bhv_pyramid_top_fragment_init)
### Lua Example
`bhv_pyramid_top_fragment_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pyramid_top_fragment_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pyramid_top_fragment_loop](#bhv_pyramid_top_fragment_loop)
### Lua Example
`bhv_pyramid_top_fragment_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pyramid_top_fragment_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pyramid_top_init](#bhv_pyramid_top_init)
### Lua Example
`bhv_pyramid_top_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pyramid_top_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_pyramid_top_loop](#bhv_pyramid_top_loop)
### Lua Example
`bhv_pyramid_top_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_pyramid_top_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_racing_penguin_init](#bhv_racing_penguin_init)
### Lua Example
`bhv_racing_penguin_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_racing_penguin_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_racing_penguin_update](#bhv_racing_penguin_update)
### Lua Example
`bhv_racing_penguin_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_racing_penguin_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_recovery_heart_loop](#bhv_recovery_heart_loop)
### Lua Example
`bhv_recovery_heart_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_recovery_heart_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_red_coin_init](#bhv_red_coin_init)
### Lua Example
`bhv_red_coin_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_red_coin_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_red_coin_loop](#bhv_red_coin_loop)
### Lua Example
`bhv_red_coin_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_red_coin_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_red_coin_star_marker_init](#bhv_red_coin_star_marker_init)
### Lua Example
`bhv_red_coin_star_marker_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_red_coin_star_marker_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_respawner_loop](#bhv_respawner_loop)
### Lua Example
`bhv_respawner_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_respawner_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_rolling_log_loop](#bhv_rolling_log_loop)
### Lua Example
`bhv_rolling_log_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_rolling_log_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_rotating_clock_arm_loop](#bhv_rotating_clock_arm_loop)
### Lua Example
`bhv_rotating_clock_arm_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_rotating_clock_arm_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_rotating_exclamation_box_loop](#bhv_rotating_exclamation_box_loop)
### Lua Example
`bhv_rotating_exclamation_box_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_rotating_exclamation_box_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_rotating_octagonal_plat_init](#bhv_rotating_octagonal_plat_init)
### Lua Example
`bhv_rotating_octagonal_plat_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_rotating_octagonal_plat_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_rotating_octagonal_plat_loop](#bhv_rotating_octagonal_plat_loop)
### Lua Example
`bhv_rotating_octagonal_plat_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_rotating_octagonal_plat_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_rotating_platform_loop](#bhv_rotating_platform_loop)
### Lua Example
`bhv_rotating_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_rotating_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_rr_cruiser_wing_init](#bhv_rr_cruiser_wing_init)
### Lua Example
`bhv_rr_cruiser_wing_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_rr_cruiser_wing_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_rr_cruiser_wing_loop](#bhv_rr_cruiser_wing_loop)
### Lua Example
`bhv_rr_cruiser_wing_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_rr_cruiser_wing_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_rr_rotating_bridge_platform_loop](#bhv_rr_rotating_bridge_platform_loop)
### Lua Example
`bhv_rr_rotating_bridge_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_rr_rotating_bridge_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_sand_sound_loop](#bhv_sand_sound_loop)
### Lua Example
`bhv_sand_sound_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_sand_sound_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_scuttlebug_loop](#bhv_scuttlebug_loop)
### Lua Example
`bhv_scuttlebug_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_scuttlebug_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_scuttlebug_spawn_loop](#bhv_scuttlebug_spawn_loop)
### Lua Example
`bhv_scuttlebug_spawn_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_scuttlebug_spawn_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_seaweed_bundle_init](#bhv_seaweed_bundle_init)
### Lua Example
`bhv_seaweed_bundle_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_seaweed_bundle_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_seaweed_init](#bhv_seaweed_init)
### Lua Example
`bhv_seaweed_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_seaweed_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_seesaw_platform_init](#bhv_seesaw_platform_init)
### Lua Example
`bhv_seesaw_platform_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_seesaw_platform_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_seesaw_platform_update](#bhv_seesaw_platform_update)
### Lua Example
`bhv_seesaw_platform_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_seesaw_platform_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_shallow_water_splash_init](#bhv_shallow_water_splash_init)
### Lua Example
`bhv_shallow_water_splash_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_shallow_water_splash_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ship_part_3_loop](#bhv_ship_part_3_loop)
### Lua Example
`bhv_ship_part_3_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ship_part_3_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_skeeter_update](#bhv_skeeter_update)
### Lua Example
`bhv_skeeter_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_skeeter_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_skeeter_wave_update](#bhv_skeeter_wave_update)
### Lua Example
`bhv_skeeter_wave_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_skeeter_wave_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_sl_snowman_wind_loop](#bhv_sl_snowman_wind_loop)
### Lua Example
`bhv_sl_snowman_wind_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_sl_snowman_wind_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_sl_walking_penguin_loop](#bhv_sl_walking_penguin_loop)
### Lua Example
`bhv_sl_walking_penguin_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_sl_walking_penguin_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_sliding_plat_2_init](#bhv_sliding_plat_2_init)
### Lua Example
`bhv_sliding_plat_2_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_sliding_plat_2_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_sliding_plat_2_loop](#bhv_sliding_plat_2_loop)
### Lua Example
`bhv_sliding_plat_2_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_sliding_plat_2_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_sliding_snow_mound_loop](#bhv_sliding_snow_mound_loop)
### Lua Example
`bhv_sliding_snow_mound_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_sliding_snow_mound_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_small_bomp_init](#bhv_small_bomp_init)
### Lua Example
`bhv_small_bomp_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_small_bomp_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_small_bomp_loop](#bhv_small_bomp_loop)
### Lua Example
`bhv_small_bomp_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_small_bomp_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_small_bubbles_loop](#bhv_small_bubbles_loop)
### Lua Example
`bhv_small_bubbles_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_small_bubbles_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_small_bully_init](#bhv_small_bully_init)
### Lua Example
`bhv_small_bully_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_small_bully_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_small_penguin_loop](#bhv_small_penguin_loop)
### Lua Example
`bhv_small_penguin_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_small_penguin_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_small_piranha_flame_loop](#bhv_small_piranha_flame_loop)
### Lua Example
`bhv_small_piranha_flame_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_small_piranha_flame_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_small_water_wave_loop](#bhv_small_water_wave_loop)
### Lua Example
`bhv_small_water_wave_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_small_water_wave_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_snow_leaf_particle_spawn_init](#bhv_snow_leaf_particle_spawn_init)
### Lua Example
`bhv_snow_leaf_particle_spawn_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_snow_leaf_particle_spawn_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_snow_mound_spawn_loop](#bhv_snow_mound_spawn_loop)
### Lua Example
`bhv_snow_mound_spawn_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_snow_mound_spawn_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_snowmans_body_checkpoint_loop](#bhv_snowmans_body_checkpoint_loop)
### Lua Example
`bhv_snowmans_body_checkpoint_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_snowmans_body_checkpoint_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_snowmans_bottom_init](#bhv_snowmans_bottom_init)
### Lua Example
`bhv_snowmans_bottom_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_snowmans_bottom_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_snowmans_bottom_loop](#bhv_snowmans_bottom_loop)
### Lua Example
`bhv_snowmans_bottom_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_snowmans_bottom_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_snowmans_head_init](#bhv_snowmans_head_init)
### Lua Example
`bhv_snowmans_head_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_snowmans_head_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_snowmans_head_loop](#bhv_snowmans_head_loop)
### Lua Example
`bhv_snowmans_head_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_snowmans_head_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_snufit_balls_loop](#bhv_snufit_balls_loop)
### Lua Example
`bhv_snufit_balls_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_snufit_balls_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_snufit_loop](#bhv_snufit_loop)
### Lua Example
`bhv_snufit_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_snufit_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_sound_spawner_init](#bhv_sound_spawner_init)
### Lua Example
`bhv_sound_spawner_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_sound_spawner_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_sparkle_spawn_loop](#bhv_sparkle_spawn_loop)
### Lua Example
`bhv_sparkle_spawn_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_sparkle_spawn_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_spawn_star_no_level_exit](#bhv_spawn_star_no_level_exit)
### Lua Example
`bhv_spawn_star_no_level_exit(object, params, networkSendEvent)`
### Parameters
| Field | Type |
| ----- | ---- |
| object | [Object ](structs.md#Object ) |
| params | `integer` |
| networkSendEvent | `integer` |
### Returns
- None
### C Prototype
`void bhv_spawn_star_no_level_exit(struct Object* object, u32 params, u8 networkSendEvent);`
[:arrow_up_small: ](# )
< br / >
## [bhv_spawned_star_init](#bhv_spawned_star_init)
### Lua Example
`bhv_spawned_star_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_spawned_star_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_spawned_star_loop](#bhv_spawned_star_loop)
### Lua Example
`bhv_spawned_star_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_spawned_star_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_spindel_init](#bhv_spindel_init)
### Lua Example
`bhv_spindel_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_spindel_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_spindel_loop](#bhv_spindel_loop)
### Lua Example
`bhv_spindel_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_spindel_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_spindrift_loop](#bhv_spindrift_loop)
### Lua Example
`bhv_spindrift_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_spindrift_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_spiny_update](#bhv_spiny_update)
### Lua Example
`bhv_spiny_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_spiny_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_squarish_path_moving_loop](#bhv_squarish_path_moving_loop)
### Lua Example
`bhv_squarish_path_moving_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_squarish_path_moving_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_squarish_path_parent_init](#bhv_squarish_path_parent_init)
### Lua Example
`bhv_squarish_path_parent_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_squarish_path_parent_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_squarish_path_parent_loop](#bhv_squarish_path_parent_loop)
### Lua Example
`bhv_squarish_path_parent_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_squarish_path_parent_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_squishable_platform_loop](#bhv_squishable_platform_loop)
### Lua Example
`bhv_squishable_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_squishable_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ssl_moving_pyramid_wall_init](#bhv_ssl_moving_pyramid_wall_init)
### Lua Example
`bhv_ssl_moving_pyramid_wall_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ssl_moving_pyramid_wall_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ssl_moving_pyramid_wall_loop](#bhv_ssl_moving_pyramid_wall_loop)
### Lua Example
`bhv_ssl_moving_pyramid_wall_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ssl_moving_pyramid_wall_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_star_door_loop](#bhv_star_door_loop)
### Lua Example
`bhv_star_door_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_star_door_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_star_door_loop_2](#bhv_star_door_loop_2)
### Lua Example
`bhv_star_door_loop_2()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_star_door_loop_2(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_star_key_collection_puff_spawner_loop](#bhv_star_key_collection_puff_spawner_loop)
### Lua Example
`bhv_star_key_collection_puff_spawner_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_star_key_collection_puff_spawner_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_star_spawn_init](#bhv_star_spawn_init)
### Lua Example
`bhv_star_spawn_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_star_spawn_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_star_spawn_loop](#bhv_star_spawn_loop)
### Lua Example
`bhv_star_spawn_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_star_spawn_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_static_checkered_platform_loop](#bhv_static_checkered_platform_loop)
### Lua Example
`bhv_static_checkered_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_static_checkered_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_strong_wind_particle_loop](#bhv_strong_wind_particle_loop)
### Lua Example
`bhv_strong_wind_particle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_strong_wind_particle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_sunken_ship_part_loop](#bhv_sunken_ship_part_loop)
### Lua Example
`bhv_sunken_ship_part_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_sunken_ship_part_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_sushi_shark_collision_loop](#bhv_sushi_shark_collision_loop)
### Lua Example
`bhv_sushi_shark_collision_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_sushi_shark_collision_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_sushi_shark_loop](#bhv_sushi_shark_loop)
### Lua Example
`bhv_sushi_shark_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_sushi_shark_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_swing_platform_init](#bhv_swing_platform_init)
### Lua Example
`bhv_swing_platform_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_swing_platform_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_swing_platform_update](#bhv_swing_platform_update)
### Lua Example
`bhv_swing_platform_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_swing_platform_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_swoop_update](#bhv_swoop_update)
### Lua Example
`bhv_swoop_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_swoop_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tank_fish_group_loop](#bhv_tank_fish_group_loop)
### Lua Example
`bhv_tank_fish_group_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tank_fish_group_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_temp_coin_loop](#bhv_temp_coin_loop)
### Lua Example
`bhv_temp_coin_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_temp_coin_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_thi_bowling_ball_spawner_loop](#bhv_thi_bowling_ball_spawner_loop)
### Lua Example
`bhv_thi_bowling_ball_spawner_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_thi_bowling_ball_spawner_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_thi_huge_island_top_loop](#bhv_thi_huge_island_top_loop)
### Lua Example
`bhv_thi_huge_island_top_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_thi_huge_island_top_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_thi_tiny_island_top_loop](#bhv_thi_tiny_island_top_loop)
### Lua Example
`bhv_thi_tiny_island_top_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_thi_tiny_island_top_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tilting_bowser_lava_platform_init](#bhv_tilting_bowser_lava_platform_init)
### Lua Example
`bhv_tilting_bowser_lava_platform_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tilting_bowser_lava_platform_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tilting_inverted_pyramid_loop](#bhv_tilting_inverted_pyramid_loop)
### Lua Example
`bhv_tilting_inverted_pyramid_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tilting_inverted_pyramid_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tiny_star_particles_init](#bhv_tiny_star_particles_init)
### Lua Example
`bhv_tiny_star_particles_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tiny_star_particles_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tower_door_loop](#bhv_tower_door_loop)
### Lua Example
`bhv_tower_door_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tower_door_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tower_platform_group_init](#bhv_tower_platform_group_init)
### Lua Example
`bhv_tower_platform_group_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tower_platform_group_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tower_platform_group_loop](#bhv_tower_platform_group_loop)
### Lua Example
`bhv_tower_platform_group_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tower_platform_group_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tox_box_loop](#bhv_tox_box_loop)
### Lua Example
`bhv_tox_box_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tox_box_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_track_ball_update](#bhv_track_ball_update)
### Lua Example
`bhv_track_ball_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_track_ball_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_treasure_chest_bottom_init](#bhv_treasure_chest_bottom_init)
### Lua Example
`bhv_treasure_chest_bottom_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_treasure_chest_bottom_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_treasure_chest_bottom_loop](#bhv_treasure_chest_bottom_loop)
### Lua Example
`bhv_treasure_chest_bottom_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_treasure_chest_bottom_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_treasure_chest_init](#bhv_treasure_chest_init)
### Lua Example
`bhv_treasure_chest_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_treasure_chest_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_treasure_chest_jrb_init](#bhv_treasure_chest_jrb_init)
### Lua Example
`bhv_treasure_chest_jrb_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_treasure_chest_jrb_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_treasure_chest_jrb_loop](#bhv_treasure_chest_jrb_loop)
### Lua Example
`bhv_treasure_chest_jrb_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_treasure_chest_jrb_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_treasure_chest_loop](#bhv_treasure_chest_loop)
### Lua Example
`bhv_treasure_chest_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_treasure_chest_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_treasure_chest_ship_init](#bhv_treasure_chest_ship_init)
### Lua Example
`bhv_treasure_chest_ship_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_treasure_chest_ship_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_treasure_chest_ship_loop](#bhv_treasure_chest_ship_loop)
### Lua Example
`bhv_treasure_chest_ship_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_treasure_chest_ship_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_treasure_chest_top_loop](#bhv_treasure_chest_top_loop)
### Lua Example
`bhv_treasure_chest_top_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_treasure_chest_top_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tree_snow_or_leaf_loop](#bhv_tree_snow_or_leaf_loop)
### Lua Example
`bhv_tree_snow_or_leaf_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tree_snow_or_leaf_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_triplet_butterfly_update](#bhv_triplet_butterfly_update)
### Lua Example
`bhv_triplet_butterfly_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_triplet_butterfly_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_2d_rotator_init](#bhv_ttc_2d_rotator_init)
### Lua Example
`bhv_ttc_2d_rotator_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_2d_rotator_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_2d_rotator_update](#bhv_ttc_2d_rotator_update)
### Lua Example
`bhv_ttc_2d_rotator_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_2d_rotator_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_cog_init](#bhv_ttc_cog_init)
### Lua Example
`bhv_ttc_cog_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_cog_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_cog_update](#bhv_ttc_cog_update)
### Lua Example
`bhv_ttc_cog_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_cog_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_elevator_init](#bhv_ttc_elevator_init)
### Lua Example
`bhv_ttc_elevator_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_elevator_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_elevator_update](#bhv_ttc_elevator_update)
### Lua Example
`bhv_ttc_elevator_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_elevator_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_moving_bar_init](#bhv_ttc_moving_bar_init)
### Lua Example
`bhv_ttc_moving_bar_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_moving_bar_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_moving_bar_update](#bhv_ttc_moving_bar_update)
### Lua Example
`bhv_ttc_moving_bar_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_moving_bar_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_pendulum_init](#bhv_ttc_pendulum_init)
### Lua Example
`bhv_ttc_pendulum_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_pendulum_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_pendulum_update](#bhv_ttc_pendulum_update)
### Lua Example
`bhv_ttc_pendulum_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_pendulum_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_pit_block_init](#bhv_ttc_pit_block_init)
### Lua Example
`bhv_ttc_pit_block_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_pit_block_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_pit_block_update](#bhv_ttc_pit_block_update)
### Lua Example
`bhv_ttc_pit_block_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_pit_block_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_rotating_solid_init](#bhv_ttc_rotating_solid_init)
### Lua Example
`bhv_ttc_rotating_solid_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_rotating_solid_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_rotating_solid_update](#bhv_ttc_rotating_solid_update)
### Lua Example
`bhv_ttc_rotating_solid_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_rotating_solid_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_spinner_update](#bhv_ttc_spinner_update)
### Lua Example
`bhv_ttc_spinner_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_spinner_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_treadmill_init](#bhv_ttc_treadmill_init)
### Lua Example
`bhv_ttc_treadmill_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_treadmill_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttc_treadmill_update](#bhv_ttc_treadmill_update)
### Lua Example
`bhv_ttc_treadmill_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttc_treadmill_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ttm_rolling_log_init](#bhv_ttm_rolling_log_init)
### Lua Example
`bhv_ttm_rolling_log_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ttm_rolling_log_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tumbling_bridge_loop](#bhv_tumbling_bridge_loop)
### Lua Example
`bhv_tumbling_bridge_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tumbling_bridge_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tumbling_bridge_platform_loop](#bhv_tumbling_bridge_platform_loop)
### Lua Example
`bhv_tumbling_bridge_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tumbling_bridge_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tuxies_mother_loop](#bhv_tuxies_mother_loop)
### Lua Example
`bhv_tuxies_mother_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tuxies_mother_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tweester_loop](#bhv_tweester_loop)
### Lua Example
`bhv_tweester_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tweester_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_tweester_sand_particle_loop](#bhv_tweester_sand_particle_loop)
### Lua Example
`bhv_tweester_sand_particle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_tweester_sand_particle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ukiki_cage_loop](#bhv_ukiki_cage_loop)
### Lua Example
`bhv_ukiki_cage_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ukiki_cage_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ukiki_cage_star_loop](#bhv_ukiki_cage_star_loop)
### Lua Example
`bhv_ukiki_cage_star_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ukiki_cage_star_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ukiki_init](#bhv_ukiki_init)
### Lua Example
`bhv_ukiki_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ukiki_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_ukiki_loop](#bhv_ukiki_loop)
### Lua Example
`bhv_ukiki_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_ukiki_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_unagi_init](#bhv_unagi_init)
### Lua Example
`bhv_unagi_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_unagi_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_unagi_loop](#bhv_unagi_loop)
### Lua Example
`bhv_unagi_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_unagi_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_unagi_subobject_loop](#bhv_unagi_subobject_loop)
### Lua Example
`bhv_unagi_subobject_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_unagi_subobject_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_unused_particle_spawn_loop](#bhv_unused_particle_spawn_loop)
### Lua Example
`bhv_unused_particle_spawn_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_unused_particle_spawn_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_unused_poundable_platform](#bhv_unused_poundable_platform)
### Lua Example
`bhv_unused_poundable_platform()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_unused_poundable_platform(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_vanish_cap_init](#bhv_vanish_cap_init)
### Lua Example
`bhv_vanish_cap_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_vanish_cap_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_volcano_flames_loop](#bhv_volcano_flames_loop)
### Lua Example
`bhv_volcano_flames_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_volcano_flames_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_volcano_sound_loop](#bhv_volcano_sound_loop)
### Lua Example
`bhv_volcano_sound_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_volcano_sound_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_volcano_trap_loop](#bhv_volcano_trap_loop)
### Lua Example
`bhv_volcano_trap_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_volcano_trap_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wall_tiny_star_particle_loop](#bhv_wall_tiny_star_particle_loop)
### Lua Example
`bhv_wall_tiny_star_particle_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wall_tiny_star_particle_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_warp_loop](#bhv_warp_loop)
### Lua Example
`bhv_warp_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_warp_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_air_bubble_init](#bhv_water_air_bubble_init)
### Lua Example
`bhv_water_air_bubble_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_air_bubble_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_air_bubble_loop](#bhv_water_air_bubble_loop)
### Lua Example
`bhv_water_air_bubble_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_air_bubble_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_bomb_cannon_loop](#bhv_water_bomb_cannon_loop)
### Lua Example
`bhv_water_bomb_cannon_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_bomb_cannon_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_bomb_shadow_update](#bhv_water_bomb_shadow_update)
### Lua Example
`bhv_water_bomb_shadow_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_bomb_shadow_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_bomb_spawner_update](#bhv_water_bomb_spawner_update)
### Lua Example
`bhv_water_bomb_spawner_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_bomb_spawner_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_bomb_update](#bhv_water_bomb_update)
### Lua Example
`bhv_water_bomb_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_bomb_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_droplet_loop](#bhv_water_droplet_loop)
### Lua Example
`bhv_water_droplet_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_droplet_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_droplet_splash_init](#bhv_water_droplet_splash_init)
### Lua Example
`bhv_water_droplet_splash_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_droplet_splash_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_level_diamond_loop](#bhv_water_level_diamond_loop)
### Lua Example
`bhv_water_level_diamond_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_level_diamond_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_level_pillar_init](#bhv_water_level_pillar_init)
### Lua Example
`bhv_water_level_pillar_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_level_pillar_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_level_pillar_loop](#bhv_water_level_pillar_loop)
### Lua Example
`bhv_water_level_pillar_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_level_pillar_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_mist_2_loop](#bhv_water_mist_2_loop)
### Lua Example
`bhv_water_mist_2_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_mist_2_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_mist_loop](#bhv_water_mist_loop)
### Lua Example
`bhv_water_mist_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_mist_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_mist_spawn_loop](#bhv_water_mist_spawn_loop)
### Lua Example
`bhv_water_mist_spawn_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_mist_spawn_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_splash_spawn_droplets](#bhv_water_splash_spawn_droplets)
### Lua Example
`bhv_water_splash_spawn_droplets()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_splash_spawn_droplets(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_water_waves_init](#bhv_water_waves_init)
### Lua Example
`bhv_water_waves_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_water_waves_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_waterfall_sound_loop](#bhv_waterfall_sound_loop)
### Lua Example
`bhv_waterfall_sound_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_waterfall_sound_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wave_trail_shrink](#bhv_wave_trail_shrink)
### Lua Example
`bhv_wave_trail_shrink()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wave_trail_shrink(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wdw_express_elevator_loop](#bhv_wdw_express_elevator_loop)
### Lua Example
`bhv_wdw_express_elevator_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wdw_express_elevator_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wf_breakable_wall_loop](#bhv_wf_breakable_wall_loop)
### Lua Example
`bhv_wf_breakable_wall_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wf_breakable_wall_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wf_elevator_tower_platform_loop](#bhv_wf_elevator_tower_platform_loop)
### Lua Example
`bhv_wf_elevator_tower_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wf_elevator_tower_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wf_rotating_wooden_platform_init](#bhv_wf_rotating_wooden_platform_init)
### Lua Example
`bhv_wf_rotating_wooden_platform_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wf_rotating_wooden_platform_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wf_rotating_wooden_platform_loop](#bhv_wf_rotating_wooden_platform_loop)
### Lua Example
`bhv_wf_rotating_wooden_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wf_rotating_wooden_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wf_sliding_platform_init](#bhv_wf_sliding_platform_init)
### Lua Example
`bhv_wf_sliding_platform_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wf_sliding_platform_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wf_sliding_platform_loop](#bhv_wf_sliding_platform_loop)
### Lua Example
`bhv_wf_sliding_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wf_sliding_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wf_sliding_tower_platform_loop](#bhv_wf_sliding_tower_platform_loop)
### Lua Example
`bhv_wf_sliding_tower_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wf_sliding_tower_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wf_solid_tower_platform_loop](#bhv_wf_solid_tower_platform_loop)
### Lua Example
`bhv_wf_solid_tower_platform_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wf_solid_tower_platform_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_whirlpool_init](#bhv_whirlpool_init)
### Lua Example
`bhv_whirlpool_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_whirlpool_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_whirlpool_loop](#bhv_whirlpool_loop)
### Lua Example
`bhv_whirlpool_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_whirlpool_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_white_puff_1_loop](#bhv_white_puff_1_loop)
### Lua Example
`bhv_white_puff_1_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_white_puff_1_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_white_puff_2_loop](#bhv_white_puff_2_loop)
### Lua Example
`bhv_white_puff_2_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_white_puff_2_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_white_puff_exploding_loop](#bhv_white_puff_exploding_loop)
### Lua Example
`bhv_white_puff_exploding_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_white_puff_exploding_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_white_puff_smoke_init](#bhv_white_puff_smoke_init)
### Lua Example
`bhv_white_puff_smoke_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_white_puff_smoke_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_whomp_loop](#bhv_whomp_loop)
### Lua Example
`bhv_whomp_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_whomp_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wiggler_body_part_update](#bhv_wiggler_body_part_update)
### Lua Example
`bhv_wiggler_body_part_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wiggler_body_part_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wiggler_update](#bhv_wiggler_update)
### Lua Example
`bhv_wiggler_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wiggler_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wind_loop](#bhv_wind_loop)
### Lua Example
`bhv_wind_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wind_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wing_cap_init](#bhv_wing_cap_init)
### Lua Example
`bhv_wing_cap_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wing_cap_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wing_vanish_cap_loop](#bhv_wing_vanish_cap_loop)
### Lua Example
`bhv_wing_vanish_cap_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wing_vanish_cap_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_wooden_post_update](#bhv_wooden_post_update)
### Lua Example
`bhv_wooden_post_update()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_wooden_post_update(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_yellow_coin_init](#bhv_yellow_coin_init)
### Lua Example
`bhv_yellow_coin_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_yellow_coin_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_yellow_coin_loop](#bhv_yellow_coin_loop)
### Lua Example
`bhv_yellow_coin_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_yellow_coin_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_yoshi_init](#bhv_yoshi_init)
### Lua Example
`bhv_yoshi_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_yoshi_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_yoshi_loop](#bhv_yoshi_loop)
### Lua Example
`bhv_yoshi_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_yoshi_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [check_if_moving_over_floor](#check_if_moving_over_floor)
### Lua Example
`local integerValue = check_if_moving_over_floor(a0, a1)`
### Parameters
| Field | Type |
| ----- | ---- |
| a0 | `number` |
| a1 | `number` |
### Returns
- `integer`
### C Prototype
`s32 check_if_moving_over_floor(f32 a0, f32 a1);`
[:arrow_up_small: ](# )
< br / >
## [clear_particle_flags](#clear_particle_flags)
### Lua Example
`clear_particle_flags(flags)`
### Parameters
| Field | Type |
| ----- | ---- |
| flags | `integer` |
### Returns
- None
### C Prototype
`void clear_particle_flags(u32 flags);`
[:arrow_up_small: ](# )
< br / >
## [common_anchor_mario_behavior](#common_anchor_mario_behavior)
### Lua Example
`common_anchor_mario_behavior(sp28, sp2C, sp30)`
### Parameters
| Field | Type |
| ----- | ---- |
| sp28 | `number` |
| sp2C | `number` |
| sp30 | `integer` |
### Returns
- None
### C Prototype
`void common_anchor_mario_behavior(f32 sp28, f32 sp2C, s32 sp30);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_spawn_strong_wind_particles](#cur_obj_spawn_strong_wind_particles)
### Lua Example
`cur_obj_spawn_strong_wind_particles(windSpread, scale, relPosX, relPosY, relPosZ)`
### Parameters
| Field | Type |
| ----- | ---- |
| windSpread | `integer` |
| scale | `number` |
| relPosX | `number` |
| relPosY | `number` |
| relPosZ | `number` |
### Returns
- None
### C Prototype
`void cur_obj_spawn_strong_wind_particles(s32 windSpread, f32 scale, f32 relPosX, f32 relPosY, f32 relPosZ);`
[:arrow_up_small: ](# )
< br / >
## [mario_moving_fast_enough_to_make_piranha_plant_bite](#mario_moving_fast_enough_to_make_piranha_plant_bite)
### Lua Example
`local integerValue = mario_moving_fast_enough_to_make_piranha_plant_bite()`
### Parameters
- None
### Returns
- `integer`
### C Prototype
`s32 mario_moving_fast_enough_to_make_piranha_plant_bite(void);`
[:arrow_up_small: ](# )
< br / >
## [obj_set_secondary_camera_focus](#obj_set_secondary_camera_focus)
### Lua Example
`obj_set_secondary_camera_focus()`
### Parameters
- None
### Returns
- None
### C Prototype
`void obj_set_secondary_camera_focus(void);`
[:arrow_up_small: ](# )
< br / >
## [play_penguin_walking_sound](#play_penguin_walking_sound)
### Lua Example
`play_penguin_walking_sound(walk)`
### Parameters
| Field | Type |
| ----- | ---- |
| walk | `integer` |
### Returns
- None
### C Prototype
`void play_penguin_walking_sound(s32 walk);`
[:arrow_up_small: ](# )
< br / >
## [spawn_default_star](#spawn_default_star)
### Lua Example
`local ObjectValue = spawn_default_star(x, y, z)`
### Parameters
| Field | Type |
| ----- | ---- |
| x | `number` |
| y | `number` |
| z | `number` |
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object* spawn_default_star(f32 x, f32 y, f32 z);`
[:arrow_up_small: ](# )
< br / >
## [spawn_mist_from_global](#spawn_mist_from_global)
### Lua Example
`spawn_mist_from_global()`
### Parameters
- None
### Returns
- None
### C Prototype
`void spawn_mist_from_global(void);`
[:arrow_up_small: ](# )
< br / >
## [spawn_mist_particles_variable](#spawn_mist_particles_variable)
### Lua Example
`spawn_mist_particles_variable(count, offsetY, size)`
### Parameters
| Field | Type |
| ----- | ---- |
| count | `integer` |
| offsetY | `integer` |
| size | `number` |
### Returns
- None
### C Prototype
`void spawn_mist_particles_variable(s32 count, s32 offsetY, f32 size);`
[:arrow_up_small: ](# )
< br / >
## [spawn_no_exit_star](#spawn_no_exit_star)
### Lua Example
`local ObjectValue = spawn_no_exit_star(x, y, z)`
### Parameters
| Field | Type |
| ----- | ---- |
| x | `number` |
| y | `number` |
| z | `number` |
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object* spawn_no_exit_star(f32 x, f32 y, f32 z);`
[:arrow_up_small: ](# )
< br / >
## [spawn_red_coin_cutscene_star](#spawn_red_coin_cutscene_star)
### Lua Example
`local ObjectValue = spawn_red_coin_cutscene_star(x, y, z)`
### Parameters
| Field | Type |
| ----- | ---- |
| x | `number` |
| y | `number` |
| z | `number` |
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object* spawn_red_coin_cutscene_star(f32 x, f32 y, f32 z);`
[:arrow_up_small: ](# )
< br / >
## [spawn_triangle_break_particles](#spawn_triangle_break_particles)
### Lua Example
`spawn_triangle_break_particles(numTris, triModel, triSize, triAnimState)`
### Parameters
| Field | Type |
| ----- | ---- |
| numTris | `integer` |
| triModel | `integer` |
| triSize | `number` |
| triAnimState | `integer` |
### Returns
- None
### C Prototype
`void spawn_triangle_break_particles(s16 numTris, s16 triModel, f32 triSize, s16 triAnimState);`
[:arrow_up_small: ](# )
< br / >
## [spawn_wind_particles](#spawn_wind_particles)
### Lua Example
`spawn_wind_particles(pitch, yaw)`
### Parameters
| Field | Type |
| ----- | ---- |
| pitch | `integer` |
| yaw | `integer` |
### Returns
- None
### C Prototype
`void spawn_wind_particles(s16 pitch, s16 yaw);`
[:arrow_up_small: ](# )
< br / >
## [tox_box_move](#tox_box_move)
### Lua Example
`tox_box_move(forwardVel, a1, deltaPitch, deltaRoll)`
### Parameters
| Field | Type |
| ----- | ---- |
| forwardVel | `number` |
| a1 | `number` |
| deltaPitch | `integer` |
| deltaRoll | `integer` |
### Returns
- None
### C Prototype
`void tox_box_move(f32 forwardVel, f32 a1, s16 deltaPitch, s16 deltaRoll);`
[:arrow_up_small: ](# )
< br / >
## [update_angle_from_move_flags](#update_angle_from_move_flags)
### Lua Example
`local integerValue = update_angle_from_move_flags(angle)`
### Parameters
| Field | Type |
| ----- | ---- |
| angle | `Pointer` < `integer`> |
### Returns
- `integer`
### C Prototype
`s32 update_angle_from_move_flags(s32 *angle);`
[:arrow_up_small: ](# )
< br / >
## [vec3f_copy_2](#vec3f_copy_2)
### Lua Example
`vec3f_copy_2(dest, src)`
### Parameters
| Field | Type |
| ----- | ---- |
| dest | [Vec3f ](structs.md#Vec3f ) |
| src | [Vec3f ](structs.md#Vec3f ) |
### Returns
- None
### C Prototype
`void vec3f_copy_2(Vec3f dest, Vec3f src);`
[:arrow_up_small: ](# )
< br / >
2022-02-22 06:46:39 +00:00
---
# functions from behavior_table.h
< br / >
2022-02-23 02:29:30 +00:00
## [get_behavior_from_id](#get_behavior_from_id)
### Lua Example
2022-03-05 07:05:23 +00:00
`local PointerValue = get_behavior_from_id(id)`
2022-02-23 02:29:30 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| id | [enum BehaviorId ](constants.md#enum-BehaviorId ) |
2022-02-23 02:29:30 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `Pointer` < `BehaviorScript`>
2022-02-23 02:29:30 +00:00
### C Prototype
`const BehaviorScript* get_behavior_from_id(enum BehaviorId id);`
[:arrow_up_small: ](# )
< br / >
2022-04-06 08:36:33 +00:00
## [get_behavior_name_from_id](#get_behavior_name_from_id)
### Lua Example
`local stringValue = get_behavior_name_from_id(id)`
### Parameters
| Field | Type |
| ----- | ---- |
| id | [enum BehaviorId ](constants.md#enum-BehaviorId ) |
### Returns
- `string`
### C Prototype
`const char* get_behavior_name_from_id(enum BehaviorId id);`
[:arrow_up_small: ](# )
< br / >
2022-02-23 02:29:30 +00:00
## [get_id_from_behavior](#get_id_from_behavior)
### Lua Example
2022-03-05 07:05:23 +00:00
`local enumValue = get_id_from_behavior(behavior)`
2022-02-23 02:29:30 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
2022-02-23 02:29:30 +00:00
### Returns
2022-03-05 06:22:31 +00:00
[enum BehaviorId ](constants.md#enum-BehaviorId )
2022-02-23 02:29:30 +00:00
### C Prototype
`enum BehaviorId get_id_from_behavior(const BehaviorScript* behavior);`
[:arrow_up_small: ](# )
< br / >
2022-04-06 08:36:33 +00:00
## [get_id_from_behavior_name](#get_id_from_behavior_name)
### Lua Example
`local enumValue = get_id_from_behavior_name(name)`
### Parameters
| Field | Type |
| ----- | ---- |
| name | `string` |
### Returns
[enum BehaviorId ](constants.md#enum-BehaviorId )
### C Prototype
`enum BehaviorId get_id_from_behavior_name(const char* name);`
[:arrow_up_small: ](# )
< br / >
## [get_id_from_vanilla_behavior](#get_id_from_vanilla_behavior)
### Lua Example
`local enumValue = get_id_from_vanilla_behavior(behavior)`
### Parameters
| Field | Type |
| ----- | ---- |
| behavior | `Pointer` < `BehaviorScript`> |
### Returns
[enum BehaviorId ](constants.md#enum-BehaviorId )
### C Prototype
`enum BehaviorId get_id_from_vanilla_behavior(const BehaviorScript* behavior);`
[:arrow_up_small: ](# )
< br / >
2022-01-30 06:47:22 +00:00
---
# functions from camera.h
< br / >
2022-03-26 06:46:37 +00:00
## [approach_camera_height](#approach_camera_height)
### Lua Example
`approach_camera_height(c, goal, inc)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
| goal | `number` |
| inc | `number` |
### Returns
- None
### C Prototype
`void approach_camera_height(struct Camera *c, f32 goal, f32 inc);`
[:arrow_up_small: ](# )
< br / >
## [approach_f32_asymptotic](#approach_f32_asymptotic)
### Lua Example
`local numberValue = approach_f32_asymptotic(current, target, multiplier)`
### Parameters
| Field | Type |
| ----- | ---- |
| current | `number` |
| target | `number` |
| multiplier | `number` |
### Returns
- `number`
### C Prototype
`f32 approach_f32_asymptotic(f32 current, f32 target, f32 multiplier);`
[:arrow_up_small: ](# )
< br / >
## [approach_f32_asymptotic_bool](#approach_f32_asymptotic_bool)
### Lua Example
`local integerValue = approach_f32_asymptotic_bool(current, target, multiplier)`
### Parameters
| Field | Type |
| ----- | ---- |
| current | `Pointer` < `number`> |
| target | `number` |
| multiplier | `number` |
### Returns
- `integer`
### C Prototype
`s32 approach_f32_asymptotic_bool(f32 *current, f32 target, f32 multiplier);`
[:arrow_up_small: ](# )
< br / >
## [approach_s16_asymptotic](#approach_s16_asymptotic)
### Lua Example
`local integerValue = approach_s16_asymptotic(current, target, divisor)`
### Parameters
| Field | Type |
| ----- | ---- |
| current | `integer` |
| target | `integer` |
| divisor | `integer` |
### Returns
- `integer`
### C Prototype
`s32 approach_s16_asymptotic(s16 current, s16 target, s16 divisor);`
[:arrow_up_small: ](# )
< br / >
## [approach_s16_asymptotic_bool](#approach_s16_asymptotic_bool)
### Lua Example
`local integerValue = approach_s16_asymptotic_bool(current, target, divisor)`
### Parameters
| Field | Type |
| ----- | ---- |
| current | `Pointer` < `integer`> |
| target | `integer` |
| divisor | `integer` |
### Returns
- `integer`
### C Prototype
`s32 approach_s16_asymptotic_bool(s16 *current, s16 target, s16 divisor);`
[:arrow_up_small: ](# )
< br / >
## [approach_vec3f_asymptotic](#approach_vec3f_asymptotic)
### Lua Example
`approach_vec3f_asymptotic(current, target, xMul, yMul, zMul)`
### Parameters
| Field | Type |
| ----- | ---- |
| current | [Vec3f ](structs.md#Vec3f ) |
| target | [Vec3f ](structs.md#Vec3f ) |
| xMul | `number` |
| yMul | `number` |
| zMul | `number` |
### Returns
- None
### C Prototype
`void approach_vec3f_asymptotic(Vec3f current, Vec3f target, f32 xMul, f32 yMul, f32 zMul);`
[:arrow_up_small: ](# )
< br / >
## [calc_abs_dist](#calc_abs_dist)
### Lua Example
`local numberValue = calc_abs_dist(a, b)`
### Parameters
| Field | Type |
| ----- | ---- |
| a | [Vec3f ](structs.md#Vec3f ) |
| b | [Vec3f ](structs.md#Vec3f ) |
### Returns
- `number`
### C Prototype
`f32 calc_abs_dist(Vec3f a, Vec3f b);`
[:arrow_up_small: ](# )
< br / >
## [calc_hor_dist](#calc_hor_dist)
### Lua Example
`local numberValue = calc_hor_dist(a, b)`
### Parameters
| Field | Type |
| ----- | ---- |
| a | [Vec3f ](structs.md#Vec3f ) |
| b | [Vec3f ](structs.md#Vec3f ) |
### Returns
- `number`
### C Prototype
`f32 calc_hor_dist(Vec3f a, Vec3f b);`
[:arrow_up_small: ](# )
< br / >
## [calculate_angles](#calculate_angles)
### Lua Example
`calculate_angles(from, to, pitch, yaw)`
### Parameters
| Field | Type |
| ----- | ---- |
| from | [Vec3f ](structs.md#Vec3f ) |
| to | [Vec3f ](structs.md#Vec3f ) |
| pitch | `Pointer` < `integer`> |
| yaw | `Pointer` < `integer`> |
### Returns
- None
### C Prototype
`void calculate_angles(Vec3f from, Vec3f to, s16 *pitch, s16 *yaw);`
[:arrow_up_small: ](# )
< br / >
## [calculate_pitch](#calculate_pitch)
### Lua Example
`local integerValue = calculate_pitch(from, to)`
### Parameters
| Field | Type |
| ----- | ---- |
| from | [Vec3f ](structs.md#Vec3f ) |
| to | [Vec3f ](structs.md#Vec3f ) |
### Returns
- `integer`
### C Prototype
`s16 calculate_pitch(Vec3f from, Vec3f to);`
[:arrow_up_small: ](# )
< br / >
## [calculate_yaw](#calculate_yaw)
### Lua Example
`local integerValue = calculate_yaw(from, to)`
### Parameters
| Field | Type |
| ----- | ---- |
| from | [Vec3f ](structs.md#Vec3f ) |
| to | [Vec3f ](structs.md#Vec3f ) |
### Returns
- `integer`
### C Prototype
`s16 calculate_yaw(Vec3f from, Vec3f to);`
[:arrow_up_small: ](# )
< br / >
## [cam_select_alt_mode](#cam_select_alt_mode)
### Lua Example
`local integerValue = cam_select_alt_mode(angle)`
### Parameters
| Field | Type |
| ----- | ---- |
| angle | `integer` |
### Returns
- `integer`
### C Prototype
`s32 cam_select_alt_mode(s32 angle);`
[:arrow_up_small: ](# )
< br / >
## [camera_approach_f32_symmetric](#camera_approach_f32_symmetric)
### Lua Example
`local numberValue = camera_approach_f32_symmetric(value, target, increment)`
### Parameters
| Field | Type |
| ----- | ---- |
| value | `number` |
| target | `number` |
| increment | `number` |
### Returns
- `number`
### C Prototype
`f32 camera_approach_f32_symmetric(f32 value, f32 target, f32 increment);`
[:arrow_up_small: ](# )
< br / >
## [camera_approach_f32_symmetric_bool](#camera_approach_f32_symmetric_bool)
### Lua Example
`local integerValue = camera_approach_f32_symmetric_bool(current, target, increment)`
### Parameters
| Field | Type |
| ----- | ---- |
| current | `Pointer` < `number`> |
| target | `number` |
| increment | `number` |
### Returns
- `integer`
### C Prototype
`s32 camera_approach_f32_symmetric_bool(f32 *current, f32 target, f32 increment);`
[:arrow_up_small: ](# )
< br / >
## [camera_approach_s16_symmetric_bool](#camera_approach_s16_symmetric_bool)
### Lua Example
`local integerValue = camera_approach_s16_symmetric_bool(current, target, increment)`
### Parameters
| Field | Type |
| ----- | ---- |
| current | `Pointer` < `integer`> |
| target | `integer` |
| increment | `integer` |
### Returns
- `integer`
### C Prototype
`s32 camera_approach_s16_symmetric_bool(s16 *current, s16 target, s16 increment);`
[:arrow_up_small: ](# )
< br / >
## [camera_course_processing](#camera_course_processing)
### Lua Example
`local integerValue = camera_course_processing(c)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
### Returns
- `integer`
### C Prototype
`s16 camera_course_processing(struct Camera *c);`
[:arrow_up_small: ](# )
< br / >
2022-04-10 08:55:11 +00:00
## [camera_set_use_course_specific_settings](#camera_set_use_course_specific_settings)
### Lua Example
`camera_set_use_course_specific_settings(enable)`
### Parameters
| Field | Type |
| ----- | ---- |
| enable | `integer` |
### Returns
- None
### C Prototype
`void camera_set_use_course_specific_settings(u8 enable);`
[:arrow_up_small: ](# )
< br / >
2022-03-26 06:46:37 +00:00
## [clamp_pitch](#clamp_pitch)
### Lua Example
`local integerValue = clamp_pitch(from, to, maxPitch, minPitch)`
### Parameters
| Field | Type |
| ----- | ---- |
| from | [Vec3f ](structs.md#Vec3f ) |
| to | [Vec3f ](structs.md#Vec3f ) |
| maxPitch | `integer` |
| minPitch | `integer` |
### Returns
- `integer`
### C Prototype
`s32 clamp_pitch(Vec3f from, Vec3f to, s16 maxPitch, s16 minPitch);`
[:arrow_up_small: ](# )
< br / >
## [clamp_positions_and_find_yaw](#clamp_positions_and_find_yaw)
### Lua Example
`local integerValue = clamp_positions_and_find_yaw(pos, origin, xMax, xMin, zMax, zMin)`
### Parameters
| Field | Type |
| ----- | ---- |
| pos | [Vec3f ](structs.md#Vec3f ) |
| origin | [Vec3f ](structs.md#Vec3f ) |
| xMax | `number` |
| xMin | `number` |
| zMax | `number` |
| zMin | `number` |
### Returns
- `integer`
### C Prototype
`s32 clamp_positions_and_find_yaw(Vec3f pos, Vec3f origin, f32 xMax, f32 xMin, f32 zMax, f32 zMin);`
[:arrow_up_small: ](# )
< br / >
## [collide_with_walls](#collide_with_walls)
### Lua Example
`local integerValue = collide_with_walls(pos, offsetY, radius)`
### Parameters
| Field | Type |
| ----- | ---- |
| pos | [Vec3f ](structs.md#Vec3f ) |
| offsetY | `number` |
| radius | `number` |
### Returns
- `integer`
### C Prototype
`s32 collide_with_walls(Vec3f pos, f32 offsetY, f32 radius);`
[:arrow_up_small: ](# )
< br / >
## [cutscene_object](#cutscene_object)
### Lua Example
`local integerValue = cutscene_object(cutscene, o)`
### Parameters
| Field | Type |
| ----- | ---- |
| cutscene | `integer` |
| o | [Object ](structs.md#Object ) |
### Returns
- `integer`
### C Prototype
`s16 cutscene_object(u8 cutscene, struct Object *o);`
[:arrow_up_small: ](# )
< br / >
## [cutscene_object_with_dialog](#cutscene_object_with_dialog)
### Lua Example
`local integerValue = cutscene_object_with_dialog(cutscene, o, dialogID)`
### Parameters
| Field | Type |
| ----- | ---- |
| cutscene | `integer` |
| o | [Object ](structs.md#Object ) |
| dialogID | `integer` |
### Returns
- `integer`
### C Prototype
`s16 cutscene_object_with_dialog(u8 cutscene, struct Object *o, s16 dialogID);`
[:arrow_up_small: ](# )
< br / >
## [cutscene_object_without_dialog](#cutscene_object_without_dialog)
### Lua Example
`local integerValue = cutscene_object_without_dialog(cutscene, o)`
### Parameters
| Field | Type |
| ----- | ---- |
| cutscene | `integer` |
| o | [Object ](structs.md#Object ) |
### Returns
- `integer`
### C Prototype
`s16 cutscene_object_without_dialog(u8 cutscene, struct Object *o);`
[:arrow_up_small: ](# )
< br / >
## [cutscene_set_fov_shake_preset](#cutscene_set_fov_shake_preset)
### Lua Example
`cutscene_set_fov_shake_preset(preset)`
### Parameters
| Field | Type |
| ----- | ---- |
| preset | `integer` |
### Returns
- None
### C Prototype
`void cutscene_set_fov_shake_preset(u8 preset);`
[:arrow_up_small: ](# )
< br / >
## [cutscene_spawn_obj](#cutscene_spawn_obj)
### Lua Example
`local integerValue = cutscene_spawn_obj(obj, frame)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | `integer` |
| frame | `integer` |
### Returns
- `integer`
### C Prototype
`s32 cutscene_spawn_obj(u32 obj, s16 frame);`
[:arrow_up_small: ](# )
< br / >
## [find_c_buttons_pressed](#find_c_buttons_pressed)
### Lua Example
`local integerValue = find_c_buttons_pressed(currentState, buttonsPressed, buttonsDown)`
### Parameters
| Field | Type |
| ----- | ---- |
| currentState | `integer` |
| buttonsPressed | `integer` |
| buttonsDown | `integer` |
### Returns
- `integer`
### C Prototype
`s32 find_c_buttons_pressed(u16 currentState, u16 buttonsPressed, u16 buttonsDown);`
[:arrow_up_small: ](# )
< br / >
## [find_mario_floor_and_ceil](#find_mario_floor_and_ceil)
### Lua Example
`find_mario_floor_and_ceil(pg)`
### Parameters
| Field | Type |
| ----- | ---- |
| pg | [PlayerGeometry ](structs.md#PlayerGeometry ) |
### Returns
- None
### C Prototype
`void find_mario_floor_and_ceil(struct PlayerGeometry *pg);`
[:arrow_up_small: ](# )
< br / >
## [get_cutscene_from_mario_status](#get_cutscene_from_mario_status)
### Lua Example
`local integerValue = get_cutscene_from_mario_status(c)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
### Returns
- `integer`
### C Prototype
`u8 get_cutscene_from_mario_status(struct Camera *c);`
[:arrow_up_small: ](# )
< br / >
## [handle_c_button_movement](#handle_c_button_movement)
### Lua Example
`handle_c_button_movement(c)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
### Returns
- None
### C Prototype
`void handle_c_button_movement(struct Camera *c);`
[:arrow_up_small: ](# )
< br / >
## [is_range_behind_surface](#is_range_behind_surface)
### Lua Example
`local integerValue = is_range_behind_surface(from, to, surf, range, surfType)`
### Parameters
| Field | Type |
| ----- | ---- |
| from | [Vec3f ](structs.md#Vec3f ) |
| to | [Vec3f ](structs.md#Vec3f ) |
| surf | [Surface ](structs.md#Surface ) |
| range | `integer` |
| surfType | `integer` |
### Returns
- `integer`
### C Prototype
`s32 is_range_behind_surface(Vec3f from, Vec3f to, struct Surface *surf, s16 range, s16 surfType);`
[:arrow_up_small: ](# )
< br / >
## [is_within_100_units_of_mario](#is_within_100_units_of_mario)
### Lua Example
`local integerValue = is_within_100_units_of_mario(posX, posY, posZ)`
### Parameters
| Field | Type |
| ----- | ---- |
| posX | `number` |
| posY | `number` |
| posZ | `number` |
### Returns
- `integer`
### C Prototype
`s32 is_within_100_units_of_mario(f32 posX, f32 posY, f32 posZ);`
[:arrow_up_small: ](# )
< br / >
## [move_mario_head_c_up](#move_mario_head_c_up)
### Lua Example
`move_mario_head_c_up(c)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
### Returns
- None
### C Prototype
`void move_mario_head_c_up(UNUSED struct Camera *c);`
[:arrow_up_small: ](# )
< br / >
## [next_lakitu_state](#next_lakitu_state)
### Lua Example
`local integerValue = next_lakitu_state(newPos, newFoc, curPos, curFoc, oldPos, oldFoc, yaw)`
### Parameters
| Field | Type |
| ----- | ---- |
| newPos | [Vec3f ](structs.md#Vec3f ) |
| newFoc | [Vec3f ](structs.md#Vec3f ) |
| curPos | [Vec3f ](structs.md#Vec3f ) |
| curFoc | [Vec3f ](structs.md#Vec3f ) |
| oldPos | [Vec3f ](structs.md#Vec3f ) |
| oldFoc | [Vec3f ](structs.md#Vec3f ) |
| yaw | `integer` |
### Returns
- `integer`
### C Prototype
`s16 next_lakitu_state(Vec3f newPos, Vec3f newFoc, Vec3f curPos, Vec3f curFoc, Vec3f oldPos, Vec3f oldFoc, s16 yaw);`
[:arrow_up_small: ](# )
< br / >
## [obj_rotate_towards_point](#obj_rotate_towards_point)
### Lua Example
`obj_rotate_towards_point(o, point, pitchOff, yawOff, pitchDiv, yawDiv)`
### Parameters
| Field | Type |
| ----- | ---- |
| o | [Object ](structs.md#Object ) |
| point | [Vec3f ](structs.md#Vec3f ) |
| pitchOff | `integer` |
| yawOff | `integer` |
| pitchDiv | `integer` |
| yawDiv | `integer` |
### Returns
- None
### C Prototype
`void obj_rotate_towards_point(struct Object *o, Vec3f point, s16 pitchOff, s16 yawOff, s16 pitchDiv, s16 yawDiv);`
[:arrow_up_small: ](# )
< br / >
## [object_pos_to_vec3f](#object_pos_to_vec3f)
### Lua Example
`object_pos_to_vec3f(dst, o)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Vec3f ](structs.md#Vec3f ) |
| o | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void object_pos_to_vec3f(Vec3f dst, struct Object *o);`
[:arrow_up_small: ](# )
< br / >
## [offset_rotated](#offset_rotated)
### Lua Example
`offset_rotated(dst, from, to, rotation)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Vec3f ](structs.md#Vec3f ) |
| from | [Vec3f ](structs.md#Vec3f ) |
| to | [Vec3f ](structs.md#Vec3f ) |
| rotation | [Vec3s ](structs.md#Vec3s ) |
### Returns
- None
### C Prototype
`void offset_rotated(Vec3f dst, Vec3f from, Vec3f to, Vec3s rotation);`
[:arrow_up_small: ](# )
< br / >
## [offset_yaw_outward_radial](#offset_yaw_outward_radial)
### Lua Example
`local integerValue = offset_yaw_outward_radial(c, areaYaw)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
| areaYaw | `integer` |
### Returns
- `integer`
### C Prototype
`s32 offset_yaw_outward_radial(struct Camera *c, s16 areaYaw);`
[:arrow_up_small: ](# )
< br / >
## [play_camera_buzz_if_c_sideways](#play_camera_buzz_if_c_sideways)
### Lua Example
`play_camera_buzz_if_c_sideways()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_camera_buzz_if_c_sideways(void);`
[:arrow_up_small: ](# )
< br / >
## [play_camera_buzz_if_cbutton](#play_camera_buzz_if_cbutton)
### Lua Example
`play_camera_buzz_if_cbutton()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_camera_buzz_if_cbutton(void);`
[:arrow_up_small: ](# )
< br / >
## [play_camera_buzz_if_cdown](#play_camera_buzz_if_cdown)
### Lua Example
`play_camera_buzz_if_cdown()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_camera_buzz_if_cdown(void);`
[:arrow_up_small: ](# )
< br / >
## [play_cutscene](#play_cutscene)
### Lua Example
`play_cutscene(c)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
### Returns
- None
### C Prototype
`void play_cutscene(struct Camera *c);`
[:arrow_up_small: ](# )
< br / >
## [play_sound_button_change_blocked](#play_sound_button_change_blocked)
### Lua Example
`play_sound_button_change_blocked()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_sound_button_change_blocked(void);`
[:arrow_up_small: ](# )
< br / >
## [play_sound_cbutton_down](#play_sound_cbutton_down)
### Lua Example
`play_sound_cbutton_down()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_sound_cbutton_down(void);`
[:arrow_up_small: ](# )
< br / >
## [play_sound_cbutton_side](#play_sound_cbutton_side)
### Lua Example
`play_sound_cbutton_side()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_sound_cbutton_side(void);`
[:arrow_up_small: ](# )
< br / >
## [play_sound_cbutton_up](#play_sound_cbutton_up)
### Lua Example
`play_sound_cbutton_up()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_sound_cbutton_up(void);`
[:arrow_up_small: ](# )
< br / >
## [play_sound_if_cam_switched_to_lakitu_or_mario](#play_sound_if_cam_switched_to_lakitu_or_mario)
### Lua Example
`play_sound_if_cam_switched_to_lakitu_or_mario()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_sound_if_cam_switched_to_lakitu_or_mario(void);`
[:arrow_up_small: ](# )
< br / >
## [play_sound_rbutton_changed](#play_sound_rbutton_changed)
### Lua Example
`play_sound_rbutton_changed()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_sound_rbutton_changed(void);`
[:arrow_up_small: ](# )
< br / >
## [radial_camera_input](#radial_camera_input)
### Lua Example
`local integerValue = radial_camera_input(c, unused)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
| unused | `number` |
### Returns
- `integer`
### C Prototype
`s32 radial_camera_input(struct Camera *c, UNUSED f32 unused);`
[:arrow_up_small: ](# )
< br / >
## [random_vec3s](#random_vec3s)
### Lua Example
`random_vec3s(dst, xRange, yRange, zRange)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Vec3s ](structs.md#Vec3s ) |
| xRange | `integer` |
| yRange | `integer` |
| zRange | `integer` |
### Returns
- None
### C Prototype
`void random_vec3s(Vec3s dst, s16 xRange, s16 yRange, s16 zRange);`
[:arrow_up_small: ](# )
< br / >
## [reset_camera](#reset_camera)
### Lua Example
`reset_camera(c)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
### Returns
- None
### C Prototype
`void reset_camera(struct Camera *c);`
[:arrow_up_small: ](# )
< br / >
## [resolve_geometry_collisions](#resolve_geometry_collisions)
### Lua Example
`resolve_geometry_collisions(pos, lastGood)`
### Parameters
| Field | Type |
| ----- | ---- |
| pos | [Vec3f ](structs.md#Vec3f ) |
| lastGood | [Vec3f ](structs.md#Vec3f ) |
### Returns
- None
### C Prototype
`void resolve_geometry_collisions(Vec3f pos, UNUSED Vec3f lastGood);`
[:arrow_up_small: ](# )
< br / >
## [rotate_camera_around_walls](#rotate_camera_around_walls)
### Lua Example
`local integerValue = rotate_camera_around_walls(c, cPos, avoidYaw, yawRange)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
| cPos | [Vec3f ](structs.md#Vec3f ) |
| avoidYaw | `Pointer` < `integer`> |
| yawRange | `integer` |
### Returns
- `integer`
### C Prototype
`s32 rotate_camera_around_walls(struct Camera *c, Vec3f cPos, s16 *avoidYaw, s16 yawRange);`
[:arrow_up_small: ](# )
< br / >
## [rotate_in_xz](#rotate_in_xz)
### Lua Example
`rotate_in_xz(dst, src, yaw)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Vec3f ](structs.md#Vec3f ) |
| src | [Vec3f ](structs.md#Vec3f ) |
| yaw | `integer` |
### Returns
- None
### C Prototype
`void rotate_in_xz(Vec3f dst, Vec3f src, s16 yaw);`
[:arrow_up_small: ](# )
< br / >
## [rotate_in_yz](#rotate_in_yz)
### Lua Example
`rotate_in_yz(dst, src, pitch)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Vec3f ](structs.md#Vec3f ) |
| src | [Vec3f ](structs.md#Vec3f ) |
| pitch | `integer` |
### Returns
- None
### C Prototype
`void rotate_in_yz(Vec3f dst, Vec3f src, s16 pitch);`
[:arrow_up_small: ](# )
< br / >
## [scale_along_line](#scale_along_line)
### Lua Example
`scale_along_line(dest, from, to, scale)`
### Parameters
| Field | Type |
| ----- | ---- |
| dest | [Vec3f ](structs.md#Vec3f ) |
| from | [Vec3f ](structs.md#Vec3f ) |
| to | [Vec3f ](structs.md#Vec3f ) |
| scale | `number` |
### Returns
- None
### C Prototype
`void scale_along_line(Vec3f dest, Vec3f from, Vec3f to, f32 scale);`
[:arrow_up_small: ](# )
< br / >
## [select_mario_cam_mode](#select_mario_cam_mode)
### Lua Example
`select_mario_cam_mode()`
### Parameters
- None
### Returns
- None
### C Prototype
`void select_mario_cam_mode(void);`
[:arrow_up_small: ](# )
< br / >
## [set_cam_angle](#set_cam_angle)
### Lua Example
`local integerValue = set_cam_angle(mode)`
### Parameters
| Field | Type |
| ----- | ---- |
| mode | `integer` |
### Returns
- `integer`
### C Prototype
`s32 set_cam_angle(s32 mode);`
[:arrow_up_small: ](# )
< br / >
2022-03-01 20:06:06 +00:00
## [set_camera_mode](#set_camera_mode)
### Lua Example
2022-03-26 06:46:37 +00:00
`set_camera_mode(c, mode, frames)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
| mode | `integer` |
| frames | `integer` |
### Returns
- None
### C Prototype
`void set_camera_mode(struct Camera *c, s16 mode, s16 frames);`
[:arrow_up_small: ](# )
< br / >
## [set_camera_mode_fixed](#set_camera_mode_fixed)
### Lua Example
`local integerValue = set_camera_mode_fixed(c, x, y, z)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
| x | `integer` |
| y | `integer` |
| z | `integer` |
### Returns
- `integer`
### C Prototype
`s32 set_camera_mode_fixed(struct Camera* c, s16 x, s16 y, s16 z);`
[:arrow_up_small: ](# )
< br / >
## [set_camera_pitch_shake](#set_camera_pitch_shake)
### Lua Example
`set_camera_pitch_shake(mag, decay, inc)`
### Parameters
| Field | Type |
| ----- | ---- |
| mag | `integer` |
| decay | `integer` |
| inc | `integer` |
### Returns
- None
### C Prototype
`void set_camera_pitch_shake(s16 mag, s16 decay, s16 inc);`
[:arrow_up_small: ](# )
< br / >
## [set_camera_roll_shake](#set_camera_roll_shake)
### Lua Example
`set_camera_roll_shake(mag, decay, inc)`
### Parameters
| Field | Type |
| ----- | ---- |
| mag | `integer` |
| decay | `integer` |
| inc | `integer` |
### Returns
- None
### C Prototype
`void set_camera_roll_shake(s16 mag, s16 decay, s16 inc);`
[:arrow_up_small: ](# )
< br / >
## [set_camera_shake_from_hit](#set_camera_shake_from_hit)
### Lua Example
`set_camera_shake_from_hit(shake)`
### Parameters
| Field | Type |
| ----- | ---- |
| shake | `integer` |
### Returns
- None
### C Prototype
`void set_camera_shake_from_hit(s16 shake);`
[:arrow_up_small: ](# )
< br / >
## [set_camera_shake_from_point](#set_camera_shake_from_point)
### Lua Example
`set_camera_shake_from_point(shake, posX, posY, posZ)`
### Parameters
| Field | Type |
| ----- | ---- |
| shake | `integer` |
| posX | `number` |
| posY | `number` |
| posZ | `number` |
### Returns
- None
### C Prototype
`void set_camera_shake_from_point(s16 shake, f32 posX, f32 posY, f32 posZ);`
[:arrow_up_small: ](# )
< br / >
## [set_camera_yaw_shake](#set_camera_yaw_shake)
### Lua Example
`set_camera_yaw_shake(mag, decay, inc)`
### Parameters
| Field | Type |
| ----- | ---- |
| mag | `integer` |
| decay | `integer` |
| inc | `integer` |
### Returns
- None
### C Prototype
`void set_camera_yaw_shake(s16 mag, s16 decay, s16 inc);`
[:arrow_up_small: ](# )
< br / >
## [set_environmental_camera_shake](#set_environmental_camera_shake)
### Lua Example
`set_environmental_camera_shake(shake)`
### Parameters
| Field | Type |
| ----- | ---- |
| shake | `integer` |
### Returns
- None
### C Prototype
`void set_environmental_camera_shake(s16 shake);`
[:arrow_up_small: ](# )
< br / >
## [set_fixed_cam_axis_sa_lobby](#set_fixed_cam_axis_sa_lobby)
### Lua Example
`set_fixed_cam_axis_sa_lobby(preset)`
### Parameters
| Field | Type |
| ----- | ---- |
| preset | `integer` |
### Returns
- None
### C Prototype
`void set_fixed_cam_axis_sa_lobby(UNUSED s16 preset);`
[:arrow_up_small: ](# )
< br / >
## [set_fov_function](#set_fov_function)
### Lua Example
`set_fov_function(func)`
### Parameters
| Field | Type |
| ----- | ---- |
| func | `integer` |
### Returns
- None
### C Prototype
`void set_fov_function(u8 func);`
[:arrow_up_small: ](# )
< br / >
## [set_fov_shake](#set_fov_shake)
### Lua Example
`set_fov_shake(amplitude, decay, shakeSpeed)`
### Parameters
| Field | Type |
| ----- | ---- |
| amplitude | `integer` |
| decay | `integer` |
| shakeSpeed | `integer` |
### Returns
- None
### C Prototype
`void set_fov_shake(s16 amplitude, s16 decay, s16 shakeSpeed);`
[:arrow_up_small: ](# )
< br / >
## [set_fov_shake_from_point_preset](#set_fov_shake_from_point_preset)
### Lua Example
`set_fov_shake_from_point_preset(preset, posX, posY, posZ)`
### Parameters
| Field | Type |
| ----- | ---- |
| preset | `integer` |
| posX | `number` |
| posY | `number` |
| posZ | `number` |
### Returns
- None
### C Prototype
`void set_fov_shake_from_point_preset(u8 preset, f32 posX, f32 posY, f32 posZ);`
[:arrow_up_small: ](# )
< br / >
## [set_handheld_shake](#set_handheld_shake)
### Lua Example
`set_handheld_shake(mode)`
2022-03-01 20:06:06 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| mode | `integer` |
2022-03-01 20:06:06 +00:00
### Returns
- None
### C Prototype
2022-03-26 06:46:37 +00:00
`void set_handheld_shake(u8 mode);`
2022-03-01 20:06:06 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-26 06:46:37 +00:00
## [set_or_approach_f32_asymptotic](#set_or_approach_f32_asymptotic)
2022-03-01 20:06:06 +00:00
### Lua Example
2022-03-26 06:46:37 +00:00
`local integerValue = set_or_approach_f32_asymptotic(dst, goal, scale)`
2022-03-01 20:06:06 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-26 06:46:37 +00:00
| dst | `Pointer` < `number`> |
| goal | `number` |
| scale | `number` |
2022-03-01 20:06:06 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-01 20:06:06 +00:00
### C Prototype
2022-03-26 06:46:37 +00:00
`s32 set_or_approach_f32_asymptotic(f32 *dst, f32 goal, f32 scale);`
2022-03-01 20:06:06 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-26 06:46:37 +00:00
## [set_or_approach_s16_symmetric](#set_or_approach_s16_symmetric)
2022-02-03 08:41:07 +00:00
### Lua Example
2022-03-26 06:46:37 +00:00
`local integerValue = set_or_approach_s16_symmetric(current, target, increment)`
2022-02-03 08:41:07 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-26 06:46:37 +00:00
| current | `Pointer` < `integer`> |
| target | `integer` |
| increment | `integer` |
### Returns
- `integer`
### C Prototype
`s32 set_or_approach_s16_symmetric(s16 *current, s16 target, s16 increment);`
[:arrow_up_small: ](# )
< br / >
## [set_or_approach_vec3f_asymptotic](#set_or_approach_vec3f_asymptotic)
### Lua Example
`set_or_approach_vec3f_asymptotic(dst, goal, xMul, yMul, zMul)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Vec3f ](structs.md#Vec3f ) |
| goal | [Vec3f ](structs.md#Vec3f ) |
| xMul | `number` |
| yMul | `number` |
| zMul | `number` |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
2022-03-26 06:46:37 +00:00
`void set_or_approach_vec3f_asymptotic(Vec3f dst, Vec3f goal, f32 xMul, f32 yMul, f32 zMul);`
2022-02-03 08:41:07 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-26 06:46:37 +00:00
## [set_pitch_shake_from_point](#set_pitch_shake_from_point)
2022-02-03 08:41:07 +00:00
### Lua Example
2022-03-26 06:46:37 +00:00
`set_pitch_shake_from_point(mag, decay, inc, maxDist, posX, posY, posZ)`
2022-02-03 08:41:07 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| mag | `integer` |
| decay | `integer` |
| inc | `integer` |
2022-03-26 06:46:37 +00:00
| maxDist | `number` |
| posX | `number` |
| posY | `number` |
| posZ | `number` |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
2022-03-26 06:46:37 +00:00
`void set_pitch_shake_from_point(s16 mag, s16 decay, s16 inc, f32 maxDist, f32 posX, f32 posY, f32 posZ);`
2022-02-03 08:41:07 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-26 06:46:37 +00:00
## [shake_camera_handheld](#shake_camera_handheld)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-26 06:46:37 +00:00
`shake_camera_handheld(pos, focus)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-26 06:46:37 +00:00
| pos | [Vec3f ](structs.md#Vec3f ) |
| focus | [Vec3f ](structs.md#Vec3f ) |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-03-26 06:46:37 +00:00
`void shake_camera_handheld(Vec3f pos, Vec3f focus);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-26 06:46:37 +00:00
## [shake_camera_pitch](#shake_camera_pitch)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-26 06:46:37 +00:00
`shake_camera_pitch(pos, focus)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-26 06:46:37 +00:00
| pos | [Vec3f ](structs.md#Vec3f ) |
| focus | [Vec3f ](structs.md#Vec3f ) |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-03-26 06:46:37 +00:00
`void shake_camera_pitch(Vec3f pos, Vec3f focus);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-26 06:46:37 +00:00
## [shake_camera_roll](#shake_camera_roll)
2022-02-03 08:41:07 +00:00
### Lua Example
2022-03-26 06:46:37 +00:00
`shake_camera_roll(roll)`
2022-02-03 08:41:07 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-26 06:46:37 +00:00
| roll | `Pointer` < `integer`> |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
2022-03-26 06:46:37 +00:00
`void shake_camera_roll(s16 *roll);`
2022-02-03 08:41:07 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-26 06:46:37 +00:00
## [shake_camera_yaw](#shake_camera_yaw)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-26 06:46:37 +00:00
`shake_camera_yaw(pos, focus)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-26 06:46:37 +00:00
| pos | [Vec3f ](structs.md#Vec3f ) |
| focus | [Vec3f ](structs.md#Vec3f ) |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-03-26 06:46:37 +00:00
`void shake_camera_yaw(Vec3f pos, Vec3f focus);`
[:arrow_up_small: ](# )
< br / >
## [soft_reset_camera](#soft_reset_camera)
### Lua Example
`soft_reset_camera(c)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
### Returns
- None
### C Prototype
`void soft_reset_camera(struct Camera* c);`
[:arrow_up_small: ](# )
< br / >
## [start_cutscene](#start_cutscene)
### Lua Example
`start_cutscene(c, cutscene)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
| cutscene | `integer` |
### Returns
- None
### C Prototype
`void start_cutscene(struct Camera *c, u8 cutscene);`
[:arrow_up_small: ](# )
< br / >
## [start_object_cutscene_without_focus](#start_object_cutscene_without_focus)
### Lua Example
`local integerValue = start_object_cutscene_without_focus(cutscene)`
### Parameters
| Field | Type |
| ----- | ---- |
| cutscene | `integer` |
### Returns
- `integer`
### C Prototype
`u8 start_object_cutscene_without_focus(u8 cutscene);`
[:arrow_up_small: ](# )
< br / >
## [transition_next_state](#transition_next_state)
### Lua Example
`transition_next_state(c, frames)`
### Parameters
| Field | Type |
| ----- | ---- |
| c | [Camera ](structs.md#Camera ) |
| frames | `integer` |
### Returns
- None
### C Prototype
`void transition_next_state(UNUSED struct Camera *c, s16 frames);`
[:arrow_up_small: ](# )
< br / >
## [trigger_cutscene_dialog](#trigger_cutscene_dialog)
### Lua Example
`local integerValue = trigger_cutscene_dialog(trigger)`
### Parameters
| Field | Type |
| ----- | ---- |
| trigger | `integer` |
### Returns
- `integer`
### C Prototype
`s32 trigger_cutscene_dialog(s32 trigger);`
[:arrow_up_small: ](# )
< br / >
## [vec3f_sub](#vec3f_sub)
### Lua Example
`vec3f_sub(dst, src)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Vec3f ](structs.md#Vec3f ) |
| src | [Vec3f ](structs.md#Vec3f ) |
### Returns
- None
### C Prototype
`void vec3f_sub(Vec3f dst, Vec3f src);`
[:arrow_up_small: ](# )
< br / >
## [vec3f_to_object_pos](#vec3f_to_object_pos)
### Lua Example
`vec3f_to_object_pos(o, src)`
### Parameters
| Field | Type |
| ----- | ---- |
| o | [Object ](structs.md#Object ) |
| src | [Vec3f ](structs.md#Vec3f ) |
### Returns
- None
### C Prototype
`void vec3f_to_object_pos(struct Object *o, Vec3f src);`
[:arrow_up_small: ](# )
< br / >
## [warp_camera](#warp_camera)
### Lua Example
`warp_camera(displacementX, displacementY, displacementZ)`
### Parameters
| Field | Type |
| ----- | ---- |
| displacementX | `number` |
| displacementY | `number` |
| displacementZ | `number` |
### Returns
- None
### C Prototype
`void warp_camera(f32 displacementX, f32 displacementY, f32 displacementZ);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
---
# functions from characters.h
< br / >
2022-02-03 08:43:08 +00:00
## [get_character](#get_character)
### Lua Example
`local CharacterValue = get_character(m)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
[Character ](structs.md#Character )
### C Prototype
`struct Character* get_character(struct MarioState* m);`
[:arrow_up_small: ](# )
< br / >
2022-01-30 06:47:22 +00:00
## [get_character_anim_offset](#get_character_anim_offset)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = get_character_anim_offset(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-01-30 06:47:22 +00:00
### C Prototype
`f32 get_character_anim_offset(struct MarioState* m);`
[:arrow_up_small: ](# )
< br / >
## [play_character_sound](#play_character_sound)
### Lua Example
`play_character_sound(m, characterSound)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| characterSound | [enum CharacterSound ](constants.md#enum-CharacterSound ) |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
`void play_character_sound(struct MarioState* m, enum CharacterSound characterSound);`
[:arrow_up_small: ](# )
< br / >
## [play_character_sound_if_no_flag](#play_character_sound_if_no_flag)
### Lua Example
`play_character_sound_if_no_flag(m, characterSound, flags)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| characterSound | [enum CharacterSound ](constants.md#enum-CharacterSound ) |
| flags | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
`void play_character_sound_if_no_flag(struct MarioState* m, enum CharacterSound characterSound, u32 flags);`
[:arrow_up_small: ](# )
< br / >
## [play_character_sound_offset](#play_character_sound_offset)
### Lua Example
`play_character_sound_offset(m, characterSound, offset)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| characterSound | [enum CharacterSound ](constants.md#enum-CharacterSound ) |
| offset | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
`void play_character_sound_offset(struct MarioState* m, enum CharacterSound characterSound, u32 offset);`
[:arrow_up_small: ](# )
< br / >
## [update_character_anim_offset](#update_character_anim_offset)
### Lua Example
`update_character_anim_offset(m)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
`void update_character_anim_offset(struct MarioState* m);`
[:arrow_up_small: ](# )
< br / >
2022-02-03 08:42:48 +00:00
---
# functions from djui_chat_message.h
< br / >
## [djui_chat_message_create](#djui_chat_message_create)
### Lua Example
`djui_chat_message_create(message)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| message | `string` |
2022-02-03 08:42:48 +00:00
### Returns
- None
### C Prototype
`void djui_chat_message_create(const char* message);`
[:arrow_up_small: ](# )
< br / >
2022-02-16 06:08:01 +00:00
---
2022-02-16 06:12:20 +00:00
# functions from djui_hud_utils.h
2022-02-16 06:08:01 +00:00
< br / >
2022-02-16 06:12:20 +00:00
## [djui_hud_get_screen_height](#djui_hud_get_screen_height)
2022-02-16 06:08:01 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = djui_hud_get_screen_height()`
2022-02-16 06:08:01 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-16 06:08:01 +00:00
### C Prototype
2022-02-16 06:12:20 +00:00
`u32 djui_hud_get_screen_height(void);`
2022-02-16 06:08:01 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-16 06:12:20 +00:00
## [djui_hud_get_screen_width](#djui_hud_get_screen_width)
2022-02-16 06:08:01 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = djui_hud_get_screen_width()`
2022-02-16 06:08:01 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-16 06:08:01 +00:00
### C Prototype
2022-02-16 06:12:20 +00:00
`u32 djui_hud_get_screen_width(void);`
2022-02-16 06:08:01 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-16 06:12:20 +00:00
## [djui_hud_measure_text](#djui_hud_measure_text)
2022-02-16 06:08:01 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = djui_hud_measure_text(message)`
2022-02-16 06:08:01 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| message | `string` |
2022-02-16 06:08:01 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-02-16 06:08:01 +00:00
### C Prototype
2022-02-16 06:12:20 +00:00
`f32 djui_hud_measure_text(const char* message);`
2022-02-16 06:08:01 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-16 06:12:20 +00:00
## [djui_hud_print_text](#djui_hud_print_text)
2022-02-16 06:08:01 +00:00
### Lua Example
2022-02-16 06:12:20 +00:00
`djui_hud_print_text(message, x, y, scale)`
2022-02-16 06:08:01 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| message | `string` |
2022-03-13 05:28:57 +00:00
| x | `number` |
| y | `number` |
| scale | `number` |
2022-02-16 06:08:01 +00:00
### Returns
- None
### C Prototype
2022-02-16 06:12:20 +00:00
`void djui_hud_print_text(const char* message, float x, float y, float scale);`
2022-02-16 06:08:01 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-16 06:15:49 +00:00
## [djui_hud_render_rect](#djui_hud_render_rect)
### Lua Example
`djui_hud_render_rect(x, y, width, height)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| x | `number` |
| y | `number` |
| width | `number` |
| height | `number` |
2022-02-16 06:15:49 +00:00
### Returns
- None
### C Prototype
`void djui_hud_render_rect(f32 x, f32 y, f32 width, f32 height);`
[:arrow_up_small: ](# )
< br / >
2022-02-16 06:12:20 +00:00
## [djui_hud_render_texture](#djui_hud_render_texture)
2022-02-16 06:08:01 +00:00
### Lua Example
2022-02-16 06:13:10 +00:00
`djui_hud_render_texture(texInfo, x, y, scaleW, scaleH)`
2022-02-16 06:12:20 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-02-16 06:13:10 +00:00
| texInfo | [TextureInfo ](structs.md#TextureInfo ) |
2022-03-05 06:22:31 +00:00
| x | `number` |
| y | `number` |
| scaleW | `number` |
| scaleH | `number` |
2022-02-16 06:12:20 +00:00
### Returns
- None
### C Prototype
2022-02-16 06:13:10 +00:00
`void djui_hud_render_texture(struct TextureInfo* texInfo, f32 x, f32 y, f32 scaleW, f32 scaleH);`
2022-02-16 06:12:20 +00:00
[:arrow_up_small: ](# )
< br / >
## [djui_hud_set_color](#djui_hud_set_color)
### Lua Example
`djui_hud_set_color(r, g, b, a)`
2022-02-16 06:08:01 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| r | `integer` |
| g | `integer` |
| b | `integer` |
| a | `integer` |
2022-02-16 06:08:01 +00:00
### Returns
- None
### C Prototype
2022-02-16 06:12:20 +00:00
`void djui_hud_set_color(u8 r, u8 g, u8 b, u8 a);`
2022-02-16 06:08:01 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-16 06:12:20 +00:00
## [djui_hud_set_font](#djui_hud_set_font)
2022-02-16 06:08:01 +00:00
### Lua Example
2022-02-16 06:12:20 +00:00
`djui_hud_set_font(fontType)`
2022-02-16 06:08:01 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| fontType | [enum DjuiFontType ](constants.md#enum-DjuiFontType ) |
2022-02-16 06:08:01 +00:00
### Returns
- None
### C Prototype
2022-02-16 06:12:20 +00:00
`void djui_hud_set_font(enum DjuiFontType fontType);`
2022-02-16 06:08:01 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-16 06:12:20 +00:00
## [djui_hud_set_resolution](#djui_hud_set_resolution)
2022-02-16 06:08:01 +00:00
### Lua Example
2022-02-16 06:12:20 +00:00
`djui_hud_set_resolution(resolutionType)`
2022-02-16 06:08:01 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| resolutionType | [enum HudUtilsResolution ](constants.md#enum-HudUtilsResolution ) |
2022-02-16 06:08:01 +00:00
### Returns
- None
### C Prototype
2022-02-16 06:12:20 +00:00
`void djui_hud_set_resolution(enum HudUtilsResolution resolutionType);`
2022-02-16 06:08:01 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-03 08:41:07 +00:00
---
# functions from djui_popup.h
< br / >
2022-02-03 08:42:31 +00:00
## [djui_popup_create](#djui_popup_create)
### Lua Example
`djui_popup_create(message, lines)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| message | `string` |
2022-03-13 05:28:57 +00:00
| lines | `integer` |
2022-02-03 08:42:31 +00:00
### Returns
- None
### C Prototype
`void djui_popup_create(const char* message, int lines);`
[:arrow_up_small: ](# )
< br / >
2022-01-30 06:47:22 +00:00
---
# functions from external.h
< br / >
2022-02-03 08:41:07 +00:00
## [fade_volume_scale](#fade_volume_scale)
### Lua Example
2022-03-13 08:17:10 +00:00
`fade_volume_scale(player, targetScale, fadeDuration)`
2022-02-03 08:41:07 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| player | `integer` |
| targetScale | `integer` |
2022-03-13 08:17:10 +00:00
| fadeDuration | `integer` |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
2022-03-13 08:17:10 +00:00
`void fade_volume_scale(u8 player, u8 targetScale, u16 fadeDuration);`
2022-02-03 08:41:07 +00:00
[:arrow_up_small: ](# )
< br / >
## [fadeout_background_music](#fadeout_background_music)
### Lua Example
`fadeout_background_music(arg0, fadeOut)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| arg0 | `integer` |
| fadeOut | `integer` |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
`void fadeout_background_music(u16 arg0, u16 fadeOut);`
[:arrow_up_small: ](# )
< br / >
## [play_course_clear](#play_course_clear)
### Lua Example
`play_course_clear()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_course_clear(void);`
[:arrow_up_small: ](# )
< br / >
## [play_dialog_sound](#play_dialog_sound)
### Lua Example
`play_dialog_sound(dialogID)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| dialogID | `integer` |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
`void play_dialog_sound(u8 dialogID);`
[:arrow_up_small: ](# )
< br / >
## [play_music](#play_music)
### Lua Example
`play_music(player, seqArgs, fadeTimer)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| player | `integer` |
| seqArgs | `integer` |
| fadeTimer | `integer` |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
`void play_music(u8 player, u16 seqArgs, u16 fadeTimer);`
[:arrow_up_small: ](# )
< br / >
## [play_peachs_jingle](#play_peachs_jingle)
### Lua Example
`play_peachs_jingle()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_peachs_jingle(void);`
[:arrow_up_small: ](# )
< br / >
## [play_power_star_jingle](#play_power_star_jingle)
### Lua Example
`play_power_star_jingle(arg0)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| arg0 | `integer` |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
`void play_power_star_jingle(u8 arg0);`
[:arrow_up_small: ](# )
< br / >
## [play_puzzle_jingle](#play_puzzle_jingle)
### Lua Example
`play_puzzle_jingle()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_puzzle_jingle(void);`
[:arrow_up_small: ](# )
< br / >
## [play_race_fanfare](#play_race_fanfare)
### Lua Example
`play_race_fanfare()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_race_fanfare(void);`
[:arrow_up_small: ](# )
< br / >
## [play_secondary_music](#play_secondary_music)
### Lua Example
`play_secondary_music(seqId, bgMusicVolume, volume, fadeTimer)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| seqId | `integer` |
| bgMusicVolume | `integer` |
| volume | `integer` |
| fadeTimer | `integer` |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
`void play_secondary_music(u8 seqId, u8 bgMusicVolume, u8 volume, u16 fadeTimer);`
[:arrow_up_small: ](# )
< br / >
2022-01-30 06:47:22 +00:00
## [play_sound](#play_sound)
### Lua Example
`play_sound(soundBits, pos)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| soundBits | `integer` |
2022-01-30 06:47:22 +00:00
| pos | [Vec3f ](structs.md#Vec3f ) |
### Returns
- None
### C Prototype
2022-02-03 08:41:07 +00:00
`void play_sound(s32 soundBits, f32 *pos);`
[:arrow_up_small: ](# )
< br / >
## [play_sound_with_freq_scale](#play_sound_with_freq_scale)
### Lua Example
`play_sound_with_freq_scale(soundBits, pos, freqScale)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| soundBits | `integer` |
2022-02-03 08:41:07 +00:00
| pos | [Vec3f ](structs.md#Vec3f ) |
2022-03-05 06:22:31 +00:00
| freqScale | `number` |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
`void play_sound_with_freq_scale(s32 soundBits, f32* pos, f32 freqScale);`
[:arrow_up_small: ](# )
< br / >
## [play_star_fanfare](#play_star_fanfare)
### Lua Example
`play_star_fanfare()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_star_fanfare(void);`
[:arrow_up_small: ](# )
< br / >
## [play_toads_jingle](#play_toads_jingle)
### Lua Example
`play_toads_jingle()`
### Parameters
- None
### Returns
- None
### C Prototype
`void play_toads_jingle(void);`
[:arrow_up_small: ](# )
< br / >
2022-03-13 08:17:10 +00:00
## [seq_player_fade_out](#seq_player_fade_out)
2022-02-03 08:41:07 +00:00
### Lua Example
2022-03-13 08:17:10 +00:00
`seq_player_fade_out(player, fadeDuration)`
2022-02-03 08:41:07 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| player | `integer` |
2022-03-13 08:17:10 +00:00
| fadeDuration | `integer` |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
2022-03-13 08:17:10 +00:00
`void seq_player_fade_out(u8 player, u16 fadeDuration);`
2022-02-03 08:41:07 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-13 08:17:10 +00:00
## [seq_player_lower_volume](#seq_player_lower_volume)
2022-02-03 08:41:07 +00:00
### Lua Example
2022-03-13 08:17:10 +00:00
`seq_player_lower_volume(player, fadeDuration, percentage)`
2022-02-03 08:41:07 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| player | `integer` |
2022-03-13 08:17:10 +00:00
| fadeDuration | `integer` |
| percentage | `integer` |
2022-02-03 08:41:07 +00:00
### Returns
- None
### C Prototype
2022-03-13 08:17:10 +00:00
`void seq_player_lower_volume(u8 player, u16 fadeDuration, u8 percentage);`
[:arrow_up_small: ](# )
< br / >
## [seq_player_unlower_volume](#seq_player_unlower_volume)
### Lua Example
`seq_player_unlower_volume(player, fadeDuration)`
### Parameters
| Field | Type |
| ----- | ---- |
| player | `integer` |
| fadeDuration | `integer` |
### Returns
- None
### C Prototype
`void seq_player_unlower_volume(u8 player, u16 fadeDuration);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
---
2022-02-05 03:13:15 +00:00
# functions from interaction.h
2022-01-30 06:47:22 +00:00
< br / >
2022-02-19 06:43:38 +00:00
## [does_mario_have_normal_cap_on_head](#does_mario_have_normal_cap_on_head)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = does_mario_have_normal_cap_on_head(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-19 06:43:38 +00:00
`u32 does_mario_have_normal_cap_on_head(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [get_door_save_file_flag](#get_door_save_file_flag)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = get_door_save_file_flag(door)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-02-05 03:13:15 +00:00
| door | [Object ](structs.md#Object ) |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 get_door_save_file_flag(struct Object *door);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_blow_off_cap](#mario_blow_off_cap)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`mario_blow_off_cap(m, capSpeed)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| capSpeed | `number` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void mario_blow_off_cap(struct MarioState *m, f32 capSpeed);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_check_object_grab](#mario_check_object_grab)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_check_object_grab(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 mario_check_object_grab(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_drop_held_object](#mario_drop_held_object)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`mario_drop_held_object(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-02-05 03:13:15 +00:00
| m | [MarioState ](structs.md#MarioState ) |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void mario_drop_held_object(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_get_collided_object](#mario_get_collided_object)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`local ObjectValue = mario_get_collided_object(m, interactType)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| interactType | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
[Object ](structs.md#Object )
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`struct Object *mario_get_collided_object(struct MarioState *m, u32 interactType);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_grab_used_object](#mario_grab_used_object)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`mario_grab_used_object(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void mario_grab_used_object(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_lose_cap_to_enemy](#mario_lose_cap_to_enemy)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_lose_cap_to_enemy(m, arg)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-02-05 03:13:15 +00:00
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| arg | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 mario_lose_cap_to_enemy(struct MarioState* m, u32 arg);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_obj_angle_to_object](#mario_obj_angle_to_object)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_obj_angle_to_object(m, o)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-02-05 03:13:15 +00:00
| o | [Object ](structs.md#Object ) |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s16 mario_obj_angle_to_object(struct MarioState *m, struct Object *o);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_retrieve_cap](#mario_retrieve_cap)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`mario_retrieve_cap(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void mario_retrieve_cap(struct MarioState* m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_stop_riding_and_holding](#mario_stop_riding_and_holding)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`mario_stop_riding_and_holding(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void mario_stop_riding_and_holding(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_stop_riding_object](#mario_stop_riding_object)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`mario_stop_riding_object(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void mario_stop_riding_object(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_throw_held_object](#mario_throw_held_object)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`mario_throw_held_object(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void mario_throw_held_object(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
---
# functions from level_info.h
< br / >
## [get_level_name](#get_level_name)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local stringValue = get_level_name(courseNum, levelNum, areaIndex)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| courseNum | `integer` |
| levelNum | `integer` |
| areaIndex | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `string`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-03-28 08:02:33 +00:00
`const char *get_level_name(s16 courseNum, s16 levelNum, s16 areaIndex);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
---
# functions from mario.h
< br / >
## [adjust_sound_for_speed](#adjust_sound_for_speed)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`adjust_sound_for_speed(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void adjust_sound_for_speed(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [check_common_action_exits](#check_common_action_exits)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_common_action_exits(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 check_common_action_exits(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [check_common_hold_action_exits](#check_common_hold_action_exits)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_common_hold_action_exits(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 check_common_hold_action_exits(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [drop_and_set_mario_action](#drop_and_set_mario_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = drop_and_set_mario_action(m, action, actionArg)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| action | `integer` |
| actionArg | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 drop_and_set_mario_action(struct MarioState *m, u32 action, u32 actionArg);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [execute_mario_action](#execute_mario_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = execute_mario_action(o)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-02-05 03:13:15 +00:00
| o | [Object ](structs.md#Object ) |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 execute_mario_action(UNUSED struct Object *o);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [find_floor_height_relative_polar](#find_floor_height_relative_polar)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = find_floor_height_relative_polar(m, angleFromMario, distFromMario)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| angleFromMario | `integer` |
| distFromMario | `number` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`f32 find_floor_height_relative_polar(struct MarioState *m, s16 angleFromMario, f32 distFromMario);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [find_floor_slope](#find_floor_slope)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = find_floor_slope(m, yawOffset)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| yawOffset | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s16 find_floor_slope(struct MarioState *m, s16 yawOffset);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [find_mario_anim_flags_and_translation](#find_mario_anim_flags_and_translation)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = find_mario_anim_flags_and_translation(o, yaw, translation)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-02-05 03:13:15 +00:00
| o | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| yaw | `integer` |
2022-02-05 03:13:15 +00:00
| translation | [Vec3s ](structs.md#Vec3s ) |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s16 find_mario_anim_flags_and_translation(struct Object *o, s32 yaw, Vec3s translation);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [force_idle_state](#force_idle_state)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = force_idle_state(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 force_idle_state(struct MarioState* m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [hurt_and_set_mario_action](#hurt_and_set_mario_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = hurt_and_set_mario_action(m, action, actionArg, hurtCounter)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| action | `integer` |
| actionArg | `integer` |
| hurtCounter | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 hurt_and_set_mario_action(struct MarioState *m, u32 action, u32 actionArg, s16 hurtCounter);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [is_anim_at_end](#is_anim_at_end)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = is_anim_at_end(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 is_anim_at_end(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [is_anim_past_end](#is_anim_past_end)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = is_anim_past_end(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 is_anim_past_end(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [is_anim_past_frame](#is_anim_past_frame)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = is_anim_past_frame(m, animFrame)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| animFrame | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 is_anim_past_frame(struct MarioState *m, s16 animFrame);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-13 01:00:06 +00:00
## [mario_can_bubble](#mario_can_bubble)
### Lua Example
2022-03-13 05:28:57 +00:00
`local booleanValue = mario_can_bubble(m)`
2022-03-13 01:00:06 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-13 05:28:57 +00:00
- `boolean`
2022-03-13 01:00:06 +00:00
### C Prototype
`bool mario_can_bubble(struct MarioState* m);`
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_facing_downhill](#mario_facing_downhill)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_facing_downhill(m, turnYaw)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| turnYaw | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 mario_facing_downhill(struct MarioState *m, s32 turnYaw);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_floor_is_slippery](#mario_floor_is_slippery)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_floor_is_slippery(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 mario_floor_is_slippery(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_floor_is_slope](#mario_floor_is_slope)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_floor_is_slope(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 mario_floor_is_slope(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_floor_is_steep](#mario_floor_is_steep)
2022-02-03 08:43:08 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_floor_is_steep(m)`
2022-02-03 08:43:08 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-02-05 03:13:15 +00:00
| m | [MarioState ](structs.md#MarioState ) |
2022-02-03 08:43:08 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-03 08:43:08 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 mario_floor_is_steep(struct MarioState *m);`
2022-02-03 08:43:08 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_get_floor_class](#mario_get_floor_class)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_get_floor_class(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 mario_get_floor_class(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_get_terrain_sound_addend](#mario_get_terrain_sound_addend)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_get_terrain_sound_addend(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 mario_get_terrain_sound_addend(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_set_bubbled](#mario_set_bubbled)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`mario_set_bubbled(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void mario_set_bubbled(struct MarioState* m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_set_forward_vel](#mario_set_forward_vel)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`mario_set_forward_vel(m, speed)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| speed | `number` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void mario_set_forward_vel(struct MarioState *m, f32 speed);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_mario_action_sound](#play_mario_action_sound)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_mario_action_sound(m, soundBits, waveParticleType)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| soundBits | `integer` |
| waveParticleType | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_mario_action_sound(struct MarioState *m, u32 soundBits, u32 waveParticleType);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_mario_heavy_landing_sound](#play_mario_heavy_landing_sound)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_mario_heavy_landing_sound(m, soundBits)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| soundBits | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_mario_heavy_landing_sound(struct MarioState *m, u32 soundBits);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_mario_heavy_landing_sound_once](#play_mario_heavy_landing_sound_once)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_mario_heavy_landing_sound_once(m, soundBits)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| soundBits | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_mario_heavy_landing_sound_once(struct MarioState *m, u32 soundBits);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_mario_jump_sound](#play_mario_jump_sound)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_mario_jump_sound(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_mario_jump_sound(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_mario_landing_sound](#play_mario_landing_sound)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_mario_landing_sound(m, soundBits)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| soundBits | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_mario_landing_sound(struct MarioState *m, u32 soundBits);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_mario_landing_sound_once](#play_mario_landing_sound_once)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_mario_landing_sound_once(m, soundBits)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| soundBits | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_mario_landing_sound_once(struct MarioState *m, u32 soundBits);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_mario_sound](#play_mario_sound)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_mario_sound(m, primarySoundBits, scondarySoundBits)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| primarySoundBits | `integer` |
| scondarySoundBits | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_mario_sound(struct MarioState *m, s32 primarySoundBits, s32 scondarySoundBits);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_sound_and_spawn_particles](#play_sound_and_spawn_particles)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_sound_and_spawn_particles(m, soundBits, waveParticleType)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| soundBits | `integer` |
| waveParticleType | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_sound_and_spawn_particles(struct MarioState *m, u32 soundBits, u32 waveParticleType);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_sound_if_no_flag](#play_sound_if_no_flag)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_sound_if_no_flag(m, soundBits, flags)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| soundBits | `integer` |
| flags | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_sound_if_no_flag(struct MarioState *m, u32 soundBits, u32 flags);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [resolve_and_return_wall_collisions](#resolve_and_return_wall_collisions)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`local SurfaceValue = resolve_and_return_wall_collisions(pos, offset, radius)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-02-05 03:13:15 +00:00
| pos | [Vec3f ](structs.md#Vec3f ) |
2022-03-05 06:22:31 +00:00
| offset | `number` |
| radius | `number` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
[Surface ](structs.md#Surface )
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`struct Surface *resolve_and_return_wall_collisions(Vec3f pos, f32 offset, f32 radius);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [return_mario_anim_y_translation](#return_mario_anim_y_translation)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = return_mario_anim_y_translation(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s16 return_mario_anim_y_translation(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [set_anim_to_frame](#set_anim_to_frame)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`set_anim_to_frame(m, animFrame)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| animFrame | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void set_anim_to_frame(struct MarioState *m, s16 animFrame);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [set_jump_from_landing](#set_jump_from_landing)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = set_jump_from_landing(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 set_jump_from_landing(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [set_jumping_action](#set_jumping_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = set_jumping_action(m, action, actionArg)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| action | `integer` |
| actionArg | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 set_jumping_action(struct MarioState *m, u32 action, u32 actionArg);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [set_mario_action](#set_mario_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = set_mario_action(m, action, actionArg)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| action | `integer` |
| actionArg | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 set_mario_action(struct MarioState *m, u32 action, u32 actionArg);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [set_mario_anim_with_accel](#set_mario_anim_with_accel)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = set_mario_anim_with_accel(m, targetAnimID, accel)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| targetAnimID | `integer` |
| accel | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s16 set_mario_anim_with_accel(struct MarioState *m, s32 targetAnimID, s32 accel);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [set_mario_animation](#set_mario_animation)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = set_mario_animation(m, targetAnimID)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| targetAnimID | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s16 set_mario_animation(struct MarioState *m, s32 targetAnimID);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-26 07:01:13 +00:00
## [set_mario_y_vel_based_on_fspeed](#set_mario_y_vel_based_on_fspeed)
### Lua Example
`set_mario_y_vel_based_on_fspeed(m, initialVelY, multiplier)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
| initialVelY | `number` |
| multiplier | `number` |
### Returns
- None
### C Prototype
`void set_mario_y_vel_based_on_fspeed(struct MarioState *m, f32 initialVelY, f32 multiplier);`
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [set_steep_jump_action](#set_steep_jump_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`set_steep_jump_action(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void set_steep_jump_action(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [set_water_plunge_action](#set_water_plunge_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = set_water_plunge_action(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 set_water_plunge_action(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [transition_submerged_to_walking](#transition_submerged_to_walking)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = transition_submerged_to_walking(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 transition_submerged_to_walking(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_mario_pos_for_anim](#update_mario_pos_for_anim)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`update_mario_pos_for_anim(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-01-30 07:02:36 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void update_mario_pos_for_anim(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_mario_sound_and_camera](#update_mario_sound_and_camera)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`update_mario_sound_and_camera(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void update_mario_sound_and_camera(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
---
# functions from mario_actions_airborne.c
< br / >
## [check_common_airborne_cancels](#check_common_airborne_cancels)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_common_airborne_cancels(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 check_common_airborne_cancels(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [check_fall_damage](#check_fall_damage)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_fall_damage(m, hardFallAction)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| hardFallAction | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 check_fall_damage(struct MarioState *m, u32 hardFallAction);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [check_fall_damage_or_get_stuck](#check_fall_damage_or_get_stuck)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_fall_damage_or_get_stuck(m, hardFallAction)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| hardFallAction | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 check_fall_damage_or_get_stuck(struct MarioState *m, u32 hardFallAction);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [check_horizontal_wind](#check_horizontal_wind)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_horizontal_wind(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 check_horizontal_wind(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [check_kick_or_dive_in_air](#check_kick_or_dive_in_air)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_kick_or_dive_in_air(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 check_kick_or_dive_in_air(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [check_wall_kick](#check_wall_kick)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_wall_kick(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 check_wall_kick(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [common_air_action_step](#common_air_action_step)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = common_air_action_step(m, landAction, animation, stepArg)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| landAction | `integer` |
| animation | `integer` |
| stepArg | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 common_air_action_step(struct MarioState *m, u32 landAction, s32 animation, u32 stepArg);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [common_air_knockback_step](#common_air_knockback_step)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = common_air_knockback_step(m, landAction, hardFallAction, animation, speed)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| landAction | `integer` |
| hardFallAction | `integer` |
| animation | `integer` |
| speed | `number` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 common_air_knockback_step(struct MarioState *m, u32 landAction, u32 hardFallAction, s32 animation, f32 speed);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [lava_boost_on_wall](#lava_boost_on_wall)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = lava_boost_on_wall(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 lava_boost_on_wall(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_execute_airborne_action](#mario_execute_airborne_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_execute_airborne_action(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 mario_execute_airborne_action(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_far_fall_sound](#play_far_fall_sound)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_far_fall_sound(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_far_fall_sound(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_flip_sounds](#play_flip_sounds)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_flip_sounds(m, frame1, frame2, frame3)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| frame1 | `integer` |
| frame2 | `integer` |
| frame3 | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_flip_sounds(struct MarioState *m, s16 frame1, s16 frame2, s16 frame3);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_knockback_sound](#play_knockback_sound)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_knockback_sound(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_knockback_sound(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [should_get_stuck_in_ground](#should_get_stuck_in_ground)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = should_get_stuck_in_ground(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 should_get_stuck_in_ground(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_air_with_turn](#update_air_with_turn)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`update_air_with_turn(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void update_air_with_turn(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_air_without_turn](#update_air_without_turn)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`update_air_without_turn(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void update_air_without_turn(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_flying](#update_flying)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`update_flying(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void update_flying(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_flying_pitch](#update_flying_pitch)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`update_flying_pitch(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void update_flying_pitch(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_flying_yaw](#update_flying_yaw)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`update_flying_yaw(m)`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void update_flying_yaw(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_lava_boost_or_twirling](#update_lava_boost_or_twirling)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`update_lava_boost_or_twirling(m)`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void update_lava_boost_or_twirling(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
---
# functions from mario_actions_automatic.c
< br / >
## [add_tree_leaf_particles](#add_tree_leaf_particles)
2022-02-03 08:41:07 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`add_tree_leaf_particles(m)`
2022-02-03 08:41:07 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-02-03 08:41:07 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void add_tree_leaf_particles(struct MarioState *m);`
2022-02-03 08:41:07 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [check_common_automatic_cancels](#check_common_automatic_cancels)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_common_automatic_cancels(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 check_common_automatic_cancels(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [climb_up_ledge](#climb_up_ledge)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`climb_up_ledge(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void climb_up_ledge(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [let_go_of_ledge](#let_go_of_ledge)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = let_go_of_ledge(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 let_go_of_ledge(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_execute_automatic_action](#mario_execute_automatic_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_execute_automatic_action(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-02-05 03:13:15 +00:00
| m | [MarioState ](structs.md#MarioState ) |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 mario_execute_automatic_action(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [perform_hanging_step](#perform_hanging_step)
2022-02-03 08:41:07 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = perform_hanging_step(m, nextPos)`
2022-02-03 08:41:07 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-02-05 03:13:15 +00:00
| nextPos | [Vec3f ](structs.md#Vec3f ) |
2022-02-03 08:41:07 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-03 08:41:07 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 perform_hanging_step(struct MarioState *m, Vec3f nextPos);`
2022-02-03 08:41:07 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_climbing_sounds](#play_climbing_sounds)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_climbing_sounds(m, b)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| b | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_climbing_sounds(struct MarioState *m, s32 b);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [set_pole_position](#set_pole_position)
2022-02-03 08:41:07 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = set_pole_position(m, offsetY)`
2022-02-03 08:41:07 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| offsetY | `number` |
2022-02-03 08:41:07 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-03 08:41:07 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 set_pole_position(struct MarioState *m, f32 offsetY);`
2022-02-03 08:41:07 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_hang_moving](#update_hang_moving)
2022-02-03 08:41:07 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = update_hang_moving(m)`
2022-02-03 08:41:07 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-03 08:41:07 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 update_hang_moving(struct MarioState *m);`
2022-02-03 08:41:07 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_hang_stationary](#update_hang_stationary)
2022-02-03 08:41:07 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`update_hang_stationary(m)`
2022-02-03 08:41:07 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void update_hang_stationary(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_ledge_climb](#update_ledge_climb)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`update_ledge_climb(m, animation, endAction)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| animation | `integer` |
| endAction | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void update_ledge_climb(struct MarioState *m, s32 animation, u32 endAction);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [update_ledge_climb_camera](#update_ledge_climb_camera)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`update_ledge_climb_camera(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void update_ledge_climb_camera(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
---
2022-02-05 03:13:15 +00:00
# functions from mario_actions_cutscene.c
2022-01-30 06:47:22 +00:00
< br / >
2022-02-05 03:13:15 +00:00
## [bhv_end_peach_loop](#bhv_end_peach_loop)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`bhv_end_peach_loop()`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void bhv_end_peach_loop(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [bhv_end_toad_loop](#bhv_end_toad_loop)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`bhv_end_toad_loop()`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void bhv_end_toad_loop(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [common_death_handler](#common_death_handler)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = common_death_handler(m, animation, frameToDeathWarp)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| animation | `integer` |
| frameToDeathWarp | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 common_death_handler(struct MarioState *m, s32 animation, s32 frameToDeathWarp);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [cutscene_put_cap_on](#cutscene_put_cap_on)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`cutscene_put_cap_on(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void cutscene_put_cap_on(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [cutscene_take_cap_off](#cutscene_take_cap_off)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`cutscene_take_cap_off(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void cutscene_take_cap_off(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [general_star_dance_handler](#general_star_dance_handler)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`general_star_dance_handler(m, isInWater)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| isInWater | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void general_star_dance_handler(struct MarioState *m, s32 isInWater);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [generate_yellow_sparkles](#generate_yellow_sparkles)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`generate_yellow_sparkles(x, y, z, radius)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| x | `integer` |
| y | `integer` |
| z | `integer` |
| radius | `number` |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void generate_yellow_sparkles(s16 x, s16 y, s16 z, f32 radius);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [get_star_collection_dialog](#get_star_collection_dialog)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = get_star_collection_dialog(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 get_star_collection_dialog(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [handle_save_menu](#handle_save_menu)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`handle_save_menu(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void handle_save_menu(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [launch_mario_until_land](#launch_mario_until_land)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = launch_mario_until_land(m, endAction, animation, forwardVel)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| endAction | `integer` |
| animation | `integer` |
| forwardVel | `number` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 launch_mario_until_land(struct MarioState *m, s32 endAction, s32 animation, f32 forwardVel);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_execute_cutscene_action](#mario_execute_cutscene_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_execute_cutscene_action(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 mario_execute_cutscene_action(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_ready_to_speak](#mario_ready_to_speak)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_ready_to_speak(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 mario_ready_to_speak(struct MarioState* m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [print_displaying_credits_entry](#print_displaying_credits_entry)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`print_displaying_credits_entry()`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void print_displaying_credits_entry(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [should_start_or_continue_dialog](#should_start_or_continue_dialog)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = should_start_or_continue_dialog(m, object)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-02-05 03:13:15 +00:00
| object | [Object ](structs.md#Object ) |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u8 should_start_or_continue_dialog(struct MarioState* m, struct Object* object);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [stuck_in_ground_handler](#stuck_in_ground_handler)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`stuck_in_ground_handler(m, animation, unstuckFrame, target2, target3, endAction)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| animation | `integer` |
| unstuckFrame | `integer` |
| target2 | `integer` |
| target3 | `integer` |
| endAction | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void stuck_in_ground_handler(struct MarioState *m, s32 animation, s32 unstuckFrame, s32 target2, s32 target3, s32 endAction);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
---
# functions from mario_actions_moving.c
< br / >
## [align_with_floor](#align_with_floor)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`align_with_floor(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void align_with_floor(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [analog_stick_held_back](#analog_stick_held_back)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = analog_stick_held_back(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 analog_stick_held_back(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [anim_and_audio_for_heavy_walk](#anim_and_audio_for_heavy_walk)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`anim_and_audio_for_heavy_walk(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void anim_and_audio_for_heavy_walk(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [anim_and_audio_for_hold_walk](#anim_and_audio_for_hold_walk)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`anim_and_audio_for_hold_walk(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void anim_and_audio_for_hold_walk(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [anim_and_audio_for_walk](#anim_and_audio_for_walk)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`anim_and_audio_for_walk(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void anim_and_audio_for_walk(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [apply_landing_accel](#apply_landing_accel)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = apply_landing_accel(m, frictionFactor)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| frictionFactor | `number` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 apply_landing_accel(struct MarioState *m, f32 frictionFactor);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [apply_slope_accel](#apply_slope_accel)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`apply_slope_accel(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void apply_slope_accel(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [apply_slope_decel](#apply_slope_decel)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = apply_slope_decel(m, decelCoef)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| decelCoef | `number` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 apply_slope_decel(struct MarioState *m, f32 decelCoef);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [begin_braking_action](#begin_braking_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = begin_braking_action(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 begin_braking_action(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [begin_walking_action](#begin_walking_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = begin_walking_action(m, forwardVel, action, actionArg)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| forwardVel | `number` |
| action | `integer` |
| actionArg | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 begin_walking_action(struct MarioState *m, f32 forwardVel, u32 action, u32 actionArg);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [check_common_moving_cancels](#check_common_moving_cancels)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_common_moving_cancels(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 check_common_moving_cancels(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [check_ground_dive_or_punch](#check_ground_dive_or_punch)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_ground_dive_or_punch(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 check_ground_dive_or_punch(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [check_ledge_climb_down](#check_ledge_climb_down)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`check_ledge_climb_down(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void check_ledge_climb_down(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [common_ground_knockback_action](#common_ground_knockback_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = common_ground_knockback_action(m, animation, arg2, arg3, arg4)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| animation | `integer` |
| arg2 | `integer` |
| arg3 | `integer` |
| arg4 | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 common_ground_knockback_action(struct MarioState *m, s32 animation, s32 arg2, s32 arg3, s32 arg4);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [common_landing_action](#common_landing_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = common_landing_action(m, animation, airAction)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| animation | `integer` |
| airAction | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 common_landing_action(struct MarioState *m, s16 animation, u32 airAction);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [common_slide_action](#common_slide_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`common_slide_action(m, endAction, airAction, animation)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| endAction | `integer` |
| airAction | `integer` |
| animation | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void common_slide_action(struct MarioState *m, u32 endAction, u32 airAction, s32 animation);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [common_slide_action_with_jump](#common_slide_action_with_jump)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = common_slide_action_with_jump(m, stopAction, jumpAction, airAction, animation)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| stopAction | `integer` |
| jumpAction | `integer` |
| airAction | `integer` |
| animation | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 common_slide_action_with_jump(struct MarioState *m, u32 stopAction, u32 jumpAction, u32 airAction, s32 animation);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_execute_moving_action](#mario_execute_moving_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_execute_moving_action(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-02-05 03:13:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 mario_execute_moving_action(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [play_step_sound](#play_step_sound)
### Lua Example
`play_step_sound(m, frame1, frame2)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| frame1 | `integer` |
| frame2 | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_step_sound(struct MarioState *m, s16 frame1, s16 frame2);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [push_or_sidle_wall](#push_or_sidle_wall)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`push_or_sidle_wall(m, startPos)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-02-05 03:13:15 +00:00
| startPos | [Vec3f ](structs.md#Vec3f ) |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void push_or_sidle_wall(struct MarioState *m, Vec3f startPos);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [quicksand_jump_land_action](#quicksand_jump_land_action)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = quicksand_jump_land_action(m, animation1, animation2, endAction, airAction)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| animation1 | `integer` |
| animation2 | `integer` |
| endAction | `integer` |
| airAction | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 quicksand_jump_land_action(struct MarioState *m, s32 animation1, s32 animation2, u32 endAction, u32 airAction);`
[:arrow_up_small: ](# )
2022-01-30 06:47:22 +00:00
< br / >
2022-02-05 03:13:15 +00:00
## [set_triple_jump_action](#set_triple_jump_action)
2022-01-30 06:47:22 +00:00
2022-02-05 03:13:15 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = set_triple_jump_action(m, action, actionArg)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| action | `integer` |
| actionArg | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 set_triple_jump_action(struct MarioState *m, UNUSED u32 action, UNUSED u32 actionArg);`
[:arrow_up_small: ](# )
< br / >
## [should_begin_sliding](#should_begin_sliding)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = should_begin_sliding(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-02-05 03:13:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 should_begin_sliding(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [slide_bonk](#slide_bonk)
### Lua Example
`slide_bonk(m, fastAction, slowAction)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| fastAction | `integer` |
| slowAction | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void slide_bonk(struct MarioState *m, u32 fastAction, u32 slowAction);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [stomach_slide_action](#stomach_slide_action)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = stomach_slide_action(m, stopAction, airAction, animation)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| stopAction | `integer` |
| airAction | `integer` |
| animation | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 stomach_slide_action(struct MarioState *m, u32 stopAction, u32 airAction, s32 animation);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [tilt_body_butt_slide](#tilt_body_butt_slide)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`tilt_body_butt_slide(m)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void tilt_body_butt_slide(struct MarioState *m);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [tilt_body_ground_shell](#tilt_body_ground_shell)
### Lua Example
`tilt_body_ground_shell(m, startYaw)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| startYaw | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
- None
### C Prototype
`void tilt_body_ground_shell(struct MarioState *m, s16 startYaw);`
[:arrow_up_small: ](# )
< br / >
## [tilt_body_running](#tilt_body_running)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = tilt_body_running(m)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s16 tilt_body_running(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [tilt_body_walking](#tilt_body_walking)
### Lua Example
`tilt_body_walking(m, startYaw)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| startYaw | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
- None
### C Prototype
`void tilt_body_walking(struct MarioState *m, s16 startYaw);`
[:arrow_up_small: ](# )
< br / >
## [update_decelerating_speed](#update_decelerating_speed)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = update_decelerating_speed(m)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 update_decelerating_speed(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [update_shell_speed](#update_shell_speed)
### Lua Example
`update_shell_speed(m)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
`void update_shell_speed(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [update_sliding](#update_sliding)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = update_sliding(m, stopSpeed)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| stopSpeed | `number` |
2022-02-05 03:13:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 update_sliding(struct MarioState *m, f32 stopSpeed);`
[:arrow_up_small: ](# )
< br / >
## [update_sliding_angle](#update_sliding_angle)
### Lua Example
`update_sliding_angle(m, accel, lossFactor)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| accel | `number` |
| lossFactor | `number` |
2022-02-05 03:13:15 +00:00
### Returns
- None
### C Prototype
`void update_sliding_angle(struct MarioState *m, f32 accel, f32 lossFactor);`
[:arrow_up_small: ](# )
< br / >
## [update_walking_speed](#update_walking_speed)
### Lua Example
`update_walking_speed(m)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
`void update_walking_speed(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
---
# functions from mario_actions_object.c
< br / >
## [animated_stationary_ground_step](#animated_stationary_ground_step)
### Lua Example
`animated_stationary_ground_step(m, animation, endAction)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| animation | `integer` |
| endAction | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
- None
### C Prototype
`void animated_stationary_ground_step(struct MarioState *m, s32 animation, u32 endAction);`
[:arrow_up_small: ](# )
< br / >
## [check_common_object_cancels](#check_common_object_cancels)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_common_object_cancels(m)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 check_common_object_cancels(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [mario_execute_object_action](#mario_execute_object_action)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_execute_object_action(m)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 mario_execute_object_action(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [mario_update_punch_sequence](#mario_update_punch_sequence)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_update_punch_sequence(m)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 mario_update_punch_sequence(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
---
# functions from mario_actions_stationary.c
< br / >
## [check_common_hold_idle_cancels](#check_common_hold_idle_cancels)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_common_hold_idle_cancels(m)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 check_common_hold_idle_cancels(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [check_common_idle_cancels](#check_common_idle_cancels)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_common_idle_cancels(m)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 check_common_idle_cancels(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [check_common_landing_cancels](#check_common_landing_cancels)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_common_landing_cancels(m, action)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| action | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 check_common_landing_cancels(struct MarioState *m, u32 action);`
[:arrow_up_small: ](# )
< br / >
## [check_common_stationary_cancels](#check_common_stationary_cancels)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = check_common_stationary_cancels(m)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 check_common_stationary_cancels(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [landing_step](#landing_step)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = landing_step(m, arg1, action)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| arg1 | `integer` |
| action | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 landing_step(struct MarioState *m, s32 arg1, u32 action);`
[:arrow_up_small: ](# )
< br / >
## [mario_execute_stationary_action](#mario_execute_stationary_action)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_execute_stationary_action(m)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 mario_execute_stationary_action(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [play_anim_sound](#play_anim_sound)
### Lua Example
`play_anim_sound(m, actionState, animFrame, sound)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| actionState | `integer` |
| animFrame | `integer` |
| sound | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
- None
### C Prototype
`void play_anim_sound(struct MarioState *m, u32 actionState, s32 animFrame, u32 sound);`
[:arrow_up_small: ](# )
< br / >
## [stopping_step](#stopping_step)
### Lua Example
`stopping_step(m, animID, action)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| animID | `integer` |
| action | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
- None
### C Prototype
`void stopping_step(struct MarioState *m, s32 animID, u32 action);`
[:arrow_up_small: ](# )
< br / >
---
# functions from mario_actions_submerged.c
< br / >
## [apply_water_current](#apply_water_current)
### Lua Example
`apply_water_current(m, step)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
| step | [Vec3f ](structs.md#Vec3f ) |
### Returns
- None
### C Prototype
`void apply_water_current(struct MarioState *m, Vec3f step);`
[:arrow_up_small: ](# )
< br / >
## [float_surface_gfx](#float_surface_gfx)
### Lua Example
`float_surface_gfx(m)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
`void float_surface_gfx(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [mario_execute_submerged_action](#mario_execute_submerged_action)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_execute_submerged_action(m)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 mario_execute_submerged_action(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [perform_water_full_step](#perform_water_full_step)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = perform_water_full_step(m, nextPos)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
| nextPos | [Vec3f ](structs.md#Vec3f ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`u32 perform_water_full_step(struct MarioState *m, Vec3f nextPos);`
[:arrow_up_small: ](# )
< br / >
## [perform_water_step](#perform_water_step)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = perform_water_step(m)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`u32 perform_water_step(struct MarioState *m);`
[:arrow_up_small: ](# )
< br / >
## [set_swimming_at_surface_particles](#set_swimming_at_surface_particles)
### Lua Example
`set_swimming_at_surface_particles(m, particleFlag)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| particleFlag | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
- None
### C Prototype
`void set_swimming_at_surface_particles(struct MarioState *m, u32 particleFlag);`
[:arrow_up_small: ](# )
< br / >
2022-04-07 08:17:48 +00:00
---
# functions from mario_misc.h
< br / >
## [bhv_toad_message_init](#bhv_toad_message_init)
### Lua Example
`bhv_toad_message_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_toad_message_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_toad_message_loop](#bhv_toad_message_loop)
### Lua Example
`bhv_toad_message_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_toad_message_loop(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_unlock_door_star_init](#bhv_unlock_door_star_init)
### Lua Example
`bhv_unlock_door_star_init()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_unlock_door_star_init(void);`
[:arrow_up_small: ](# )
< br / >
## [bhv_unlock_door_star_loop](#bhv_unlock_door_star_loop)
### Lua Example
`bhv_unlock_door_star_loop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void bhv_unlock_door_star_loop(void);`
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
---
# functions from mario_step.h
< br / >
## [get_additive_y_vel_for_jumps](#get_additive_y_vel_for_jumps)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = get_additive_y_vel_for_jumps()`
2022-02-05 03:13:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-02-05 03:13:15 +00:00
### C Prototype
`f32 get_additive_y_vel_for_jumps(void);`
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [init_bully_collision_data](#init_bully_collision_data)
### Lua Example
`init_bully_collision_data(data, posX, posZ, forwardVel, yaw, conversionRatio, radius)`
### Parameters
| Field | Type |
| ----- | ---- |
| data | [BullyCollisionData ](structs.md#BullyCollisionData ) |
2022-03-05 06:22:31 +00:00
| posX | `number` |
| posZ | `number` |
| forwardVel | `number` |
| yaw | `integer` |
| conversionRatio | `number` |
| radius | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void init_bully_collision_data(struct BullyCollisionData *data, f32 posX, f32 posZ, f32 forwardVel, s16 yaw, f32 conversionRatio, f32 radius);`
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [mario_bonk_reflection](#mario_bonk_reflection)
### Lua Example
`mario_bonk_reflection(arg0, arg1)`
### Parameters
| Field | Type |
| ----- | ---- |
| arg0 | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| arg1 | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
- None
### C Prototype
`void mario_bonk_reflection(struct MarioState *, u32);`
[:arrow_up_small: ](# )
< br / >
## [mario_push_off_steep_floor](#mario_push_off_steep_floor)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_push_off_steep_floor(arg0, arg1, arg2)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| arg0 | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| arg1 | `integer` |
| arg2 | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`u32 mario_push_off_steep_floor(struct MarioState *, u32, u32);`
[:arrow_up_small: ](# )
< br / >
## [mario_update_moving_sand](#mario_update_moving_sand)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_update_moving_sand(arg0)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| arg0 | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`u32 mario_update_moving_sand(struct MarioState *);`
[:arrow_up_small: ](# )
< br / >
## [mario_update_quicksand](#mario_update_quicksand)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_update_quicksand(arg0, arg1)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| arg0 | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| arg1 | `number` |
2022-02-05 03:13:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`u32 mario_update_quicksand(struct MarioState *, f32);`
[:arrow_up_small: ](# )
< br / >
## [mario_update_windy_ground](#mario_update_windy_ground)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_update_windy_ground(arg0)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| arg0 | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`u32 mario_update_windy_ground(struct MarioState *);`
[:arrow_up_small: ](# )
< br / >
## [perform_air_step](#perform_air_step)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = perform_air_step(arg0, arg1)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| arg0 | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| arg1 | `integer` |
2022-02-05 03:13:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 perform_air_step(struct MarioState *, u32);`
[:arrow_up_small: ](# )
< br / >
## [perform_ground_step](#perform_ground_step)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = perform_ground_step(arg0)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| arg0 | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 perform_ground_step(struct MarioState *);`
[:arrow_up_small: ](# )
< br / >
## [set_vel_from_pitch_and_yaw](#set_vel_from_pitch_and_yaw)
### Lua Example
`set_vel_from_pitch_and_yaw(m)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
`void set_vel_from_pitch_and_yaw(struct MarioState* m);`
[:arrow_up_small: ](# )
< br / >
## [stationary_ground_step](#stationary_ground_step)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = stationary_ground_step(arg0)`
2022-02-05 03:13:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| arg0 | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-05 03:13:15 +00:00
### C Prototype
`s32 stationary_ground_step(struct MarioState *);`
[:arrow_up_small: ](# )
< br / >
## [stop_and_set_height_to_floor](#stop_and_set_height_to_floor)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`stop_and_set_height_to_floor(arg0)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-02-05 03:13:15 +00:00
| arg0 | [MarioState ](structs.md#MarioState ) |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void stop_and_set_height_to_floor(struct MarioState *);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-17 02:10:06 +00:00
---
# functions from network_player.h
< br / >
## [get_network_player_from_area](#get_network_player_from_area)
### Lua Example
`local NetworkPlayerValue = get_network_player_from_area(courseNum, actNum, levelNum, areaIndex)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| courseNum | `integer` |
| actNum | `integer` |
| levelNum | `integer` |
| areaIndex | `integer` |
2022-02-17 02:10:06 +00:00
### Returns
[NetworkPlayer ](structs.md#NetworkPlayer )
### C Prototype
`struct NetworkPlayer* get_network_player_from_area(s16 courseNum, s16 actNum, s16 levelNum, s16 areaIndex);`
[:arrow_up_small: ](# )
< br / >
## [get_network_player_from_level](#get_network_player_from_level)
### Lua Example
`local NetworkPlayerValue = get_network_player_from_level(courseNum, actNum, levelNum)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| courseNum | `integer` |
| actNum | `integer` |
| levelNum | `integer` |
2022-02-17 02:10:06 +00:00
### Returns
[NetworkPlayer ](structs.md#NetworkPlayer )
### C Prototype
`struct NetworkPlayer* get_network_player_from_level(s16 courseNum, s16 actNum, s16 levelNum);`
[:arrow_up_small: ](# )
< br / >
## [get_network_player_smallest_global](#get_network_player_smallest_global)
### Lua Example
`local NetworkPlayerValue = get_network_player_smallest_global()`
### Parameters
- None
### Returns
[NetworkPlayer ](structs.md#NetworkPlayer )
### C Prototype
`struct NetworkPlayer* get_network_player_smallest_global(void);`
[:arrow_up_small: ](# )
< br / >
## [network_player_connected_count](#network_player_connected_count)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = network_player_connected_count()`
2022-02-17 02:10:06 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-17 02:10:06 +00:00
### C Prototype
`u8 network_player_connected_count(void);`
[:arrow_up_small: ](# )
< br / >
## [network_player_from_global_index](#network_player_from_global_index)
### Lua Example
`local NetworkPlayerValue = network_player_from_global_index(globalIndex)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| globalIndex | `integer` |
2022-02-17 02:10:06 +00:00
### Returns
[NetworkPlayer ](structs.md#NetworkPlayer )
### C Prototype
`struct NetworkPlayer* network_player_from_global_index(u8 globalIndex);`
[:arrow_up_small: ](# )
< br / >
2022-02-17 06:30:17 +00:00
## [network_player_set_description](#network_player_set_description)
### Lua Example
`network_player_set_description(np, description, r, g, b, a)`
### Parameters
| Field | Type |
| ----- | ---- |
| np | [NetworkPlayer ](structs.md#NetworkPlayer ) |
2022-03-05 06:22:31 +00:00
| description | `string` |
| r | `integer` |
| g | `integer` |
| b | `integer` |
| a | `integer` |
2022-02-17 06:30:17 +00:00
### Returns
- None
### C Prototype
`void network_player_set_description(struct NetworkPlayer* np, const char* description, u8 r, u8 g, u8 b, u8 a);`
[:arrow_up_small: ](# )
< br / >
2022-01-30 06:47:22 +00:00
---
2022-02-05 03:13:15 +00:00
# functions from network_utils.h
2022-01-30 06:47:22 +00:00
< br / >
2022-02-05 03:13:15 +00:00
## [network_get_player_text_color_string](#network_get_player_text_color_string)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local stringValue = network_get_player_text_color_string(localIndex)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| localIndex | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `string`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`char* network_get_player_text_color_string(u8 localIndex);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [network_global_index_from_local](#network_global_index_from_local)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = network_global_index_from_local(localIndex)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| localIndex | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u8 network_global_index_from_local(u8 localIndex);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [network_is_server](#network_is_server)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-13 05:28:57 +00:00
`local booleanValue = network_is_server()`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### Returns
2022-03-13 05:28:57 +00:00
- `boolean`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`bool network_is_server(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [network_local_index_from_global](#network_local_index_from_global)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = network_local_index_from_global(globalIndex)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| globalIndex | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u8 network_local_index_from_global(u8 globalIndex);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-23 06:39:45 +00:00
---
# functions from obj_behaviors.c
< br / >
## [absf_2](#absf_2)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = absf_2(f)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| f | `number` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-02-23 06:39:45 +00:00
### C Prototype
`f32 absf_2(f32 f);`
[:arrow_up_small: ](# )
< br / >
## [calc_new_obj_vel_and_pos_y](#calc_new_obj_vel_and_pos_y)
### Lua Example
`calc_new_obj_vel_and_pos_y(objFloor, objFloorY, objVelX, objVelZ)`
### Parameters
| Field | Type |
| ----- | ---- |
| objFloor | [Surface ](structs.md#Surface ) |
2022-03-05 06:22:31 +00:00
| objFloorY | `number` |
| objVelX | `number` |
| objVelZ | `number` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void calc_new_obj_vel_and_pos_y(struct Surface *objFloor, f32 objFloorY, f32 objVelX, f32 objVelZ);`
[:arrow_up_small: ](# )
< br / >
## [calc_new_obj_vel_and_pos_y_underwater](#calc_new_obj_vel_and_pos_y_underwater)
### Lua Example
`calc_new_obj_vel_and_pos_y_underwater(objFloor, floorY, objVelX, objVelZ, waterY)`
### Parameters
| Field | Type |
| ----- | ---- |
| objFloor | [Surface ](structs.md#Surface ) |
2022-03-05 06:22:31 +00:00
| floorY | `number` |
| objVelX | `number` |
| objVelZ | `number` |
| waterY | `number` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void calc_new_obj_vel_and_pos_y_underwater(struct Surface *objFloor, f32 floorY, f32 objVelX, f32 objVelZ, f32 waterY);`
[:arrow_up_small: ](# )
< br / >
## [calc_obj_friction](#calc_obj_friction)
### Lua Example
`calc_obj_friction(objFriction, floor_nY)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| objFriction | `Pointer` < `number`> |
| floor_nY | `number` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void calc_obj_friction(f32 *objFriction, f32 floor_nY);`
[:arrow_up_small: ](# )
< br / >
## [current_mario_room_check](#current_mario_room_check)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = current_mario_room_check(room)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| room | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s8 current_mario_room_check(s16 room);`
[:arrow_up_small: ](# )
< br / >
2022-03-13 08:22:48 +00:00
## [is_nearest_mario_state_to_object](#is_nearest_mario_state_to_object)
### Lua Example
`local integerValue = is_nearest_mario_state_to_object(m, obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
| obj | [Object ](structs.md#Object ) |
### Returns
- `integer`
### C Prototype
`u8 is_nearest_mario_state_to_object(struct MarioState *m, struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [is_nearest_player_to_object](#is_nearest_player_to_object)
### Lua Example
`local integerValue = is_nearest_player_to_object(m, obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [Object ](structs.md#Object ) |
| obj | [Object ](structs.md#Object ) |
### Returns
- `integer`
### C Prototype
`u8 is_nearest_player_to_object(struct Object *m, struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
2022-03-31 03:03:59 +00:00
## [is_other_player_active](#is_other_player_active)
### Lua Example
`local integerValue = is_other_player_active()`
### Parameters
- None
### Returns
- `integer`
### C Prototype
`u8 is_other_player_active(void);`
[:arrow_up_small: ](# )
< br / >
2022-02-23 06:39:45 +00:00
## [is_player_active](#is_player_active)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = is_player_active(m)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`u8 is_player_active(struct MarioState* m);`
[:arrow_up_small: ](# )
< br / >
2022-03-30 04:12:42 +00:00
## [is_player_in_local_area](#is_player_in_local_area)
### Lua Example
`local integerValue = is_player_in_local_area(m)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- `integer`
### C Prototype
`u8 is_player_in_local_area(struct MarioState* m);`
[:arrow_up_small: ](# )
< br / >
2022-02-23 06:39:45 +00:00
## [is_point_close_to_object](#is_point_close_to_object)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = is_point_close_to_object(obj, x, y, z, dist)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| x | `number` |
| y | `number` |
| z | `number` |
| dist | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
2022-03-13 08:17:10 +00:00
`s8 is_point_close_to_object(struct Object *obj, f32 x, f32 y, f32 z, s32 dist);`
2022-02-23 06:39:45 +00:00
[:arrow_up_small: ](# )
< br / >
## [is_point_within_radius_of_mario](#is_point_within_radius_of_mario)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = is_point_within_radius_of_mario(x, y, z, dist)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| x | `number` |
| y | `number` |
| z | `number` |
| dist | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
2022-03-13 08:17:10 +00:00
`s8 is_point_within_radius_of_mario(f32 x, f32 y, f32 z, s32 dist);`
2022-02-23 06:39:45 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-31 03:03:59 +00:00
## [nearest_interacting_mario_state_to_object](#nearest_interacting_mario_state_to_object)
### Lua Example
`local MarioStateValue = nearest_interacting_mario_state_to_object(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
[MarioState ](structs.md#MarioState )
### C Prototype
`struct MarioState *nearest_interacting_mario_state_to_object(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [nearest_interacting_player_to_object](#nearest_interacting_player_to_object)
### Lua Example
`local ObjectValue = nearest_interacting_player_to_object(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object *nearest_interacting_player_to_object(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
2022-02-23 06:39:45 +00:00
## [nearest_mario_state_to_object](#nearest_mario_state_to_object)
### Lua Example
`local MarioStateValue = nearest_mario_state_to_object(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
[MarioState ](structs.md#MarioState )
### C Prototype
`struct MarioState* nearest_mario_state_to_object(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [nearest_player_to_object](#nearest_player_to_object)
### Lua Example
`local ObjectValue = nearest_player_to_object(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object* nearest_player_to_object(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [obj_check_floor_death](#obj_check_floor_death)
### Lua Example
`obj_check_floor_death(collisionFlags, floor)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| collisionFlags | `integer` |
2022-02-23 06:39:45 +00:00
| floor | [Surface ](structs.md#Surface ) |
### Returns
- None
### C Prototype
`void obj_check_floor_death(s16 collisionFlags, struct Surface *floor);`
[:arrow_up_small: ](# )
< br / >
## [obj_check_if_facing_toward_angle](#obj_check_if_facing_toward_angle)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_check_if_facing_toward_angle(base, goal, range)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| base | `integer` |
| goal | `integer` |
| range | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
2022-03-13 08:17:10 +00:00
`s8 obj_check_if_facing_toward_angle(u32 base, u32 goal, s16 range);`
2022-02-23 06:39:45 +00:00
[:arrow_up_small: ](# )
< br / >
## [obj_find_wall](#obj_find_wall)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_find_wall(objNewX, objY, objNewZ, objVelX, objVelZ)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| objNewX | `number` |
| objY | `number` |
| objNewZ | `number` |
| objVelX | `number` |
| objVelZ | `number` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
2022-03-13 08:17:10 +00:00
`s8 obj_find_wall(f32 objNewX, f32 objY, f32 objNewZ, f32 objVelX, f32 objVelZ);`
2022-02-23 06:39:45 +00:00
[:arrow_up_small: ](# )
< br / >
## [obj_find_wall_displacement](#obj_find_wall_displacement)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_find_wall_displacement(dist, x, y, z, radius)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| dist | [Vec3f ](structs.md#Vec3f ) |
2022-03-05 06:22:31 +00:00
| x | `number` |
| y | `number` |
| z | `number` |
| radius | `number` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
2022-03-13 08:17:10 +00:00
`s8 obj_find_wall_displacement(Vec3f dist, f32 x, f32 y, f32 z, f32 radius);`
2022-02-23 06:39:45 +00:00
[:arrow_up_small: ](# )
< br / >
## [obj_flicker_and_disappear](#obj_flicker_and_disappear)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_flicker_and_disappear(obj, lifeSpan)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| lifeSpan | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
2022-03-13 08:17:10 +00:00
`s8 obj_flicker_and_disappear(struct Object *obj, s16 lifeSpan);`
2022-02-23 06:39:45 +00:00
[:arrow_up_small: ](# )
< br / >
## [obj_lava_death](#obj_lava_death)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_lava_death()`
2022-02-23 06:39:45 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
2022-03-13 08:17:10 +00:00
`s8 obj_lava_death(void);`
2022-02-23 06:39:45 +00:00
[:arrow_up_small: ](# )
< br / >
## [obj_move_xyz_using_fvel_and_yaw](#obj_move_xyz_using_fvel_and_yaw)
### Lua Example
`obj_move_xyz_using_fvel_and_yaw(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_move_xyz_using_fvel_and_yaw(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [obj_orient_graph](#obj_orient_graph)
### Lua Example
`obj_orient_graph(obj, normalX, normalY, normalZ)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| normalX | `number` |
| normalY | `number` |
| normalZ | `number` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_orient_graph(struct Object *obj, f32 normalX, f32 normalY, f32 normalZ);`
[:arrow_up_small: ](# )
< br / >
## [obj_return_and_displace_home](#obj_return_and_displace_home)
### Lua Example
`obj_return_and_displace_home(obj, homeX, homeY, homeZ, baseDisp)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| homeX | `number` |
| homeY | `number` |
| homeZ | `number` |
| baseDisp | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_return_and_displace_home(struct Object *obj, f32 homeX, UNUSED f32 homeY, f32 homeZ, s32 baseDisp);`
[:arrow_up_small: ](# )
< br / >
## [obj_return_home_if_safe](#obj_return_home_if_safe)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_return_home_if_safe(obj, homeX, y, homeZ, dist)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| homeX | `number` |
| y | `number` |
| homeZ | `number` |
| dist | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
2022-03-13 08:17:10 +00:00
`s8 obj_return_home_if_safe(struct Object *obj, f32 homeX, f32 y, f32 homeZ, s32 dist);`
2022-02-23 06:39:45 +00:00
[:arrow_up_small: ](# )
< br / >
## [obj_spawn_yellow_coins](#obj_spawn_yellow_coins)
### Lua Example
`obj_spawn_yellow_coins(obj, nCoins)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| nCoins | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_spawn_yellow_coins(struct Object *obj, s8 nCoins);`
[:arrow_up_small: ](# )
< br / >
## [obj_splash](#obj_splash)
### Lua Example
`obj_splash(waterY, objY)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| waterY | `integer` |
| objY | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_splash(s32 waterY, s32 objY);`
[:arrow_up_small: ](# )
< br / >
## [obj_update_pos_vel_xz](#obj_update_pos_vel_xz)
### Lua Example
`obj_update_pos_vel_xz()`
### Parameters
- None
### Returns
- None
### C Prototype
`void obj_update_pos_vel_xz(void);`
[:arrow_up_small: ](# )
< br / >
## [object_step](#object_step)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = object_step()`
2022-02-23 06:39:45 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s16 object_step(void);`
[:arrow_up_small: ](# )
< br / >
## [object_step_without_floor_orient](#object_step_without_floor_orient)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = object_step_without_floor_orient()`
2022-02-23 06:39:45 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s16 object_step_without_floor_orient(void);`
[:arrow_up_small: ](# )
< br / >
## [set_object_visibility](#set_object_visibility)
### Lua Example
`set_object_visibility(obj, dist)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| dist | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void set_object_visibility(struct Object *obj, s32 dist);`
[:arrow_up_small: ](# )
< br / >
## [set_yoshi_as_not_dead](#set_yoshi_as_not_dead)
### Lua Example
`set_yoshi_as_not_dead()`
### Parameters
- None
### Returns
- None
### C Prototype
`void set_yoshi_as_not_dead(void);`
[:arrow_up_small: ](# )
< br / >
## [spawn_orange_number](#spawn_orange_number)
### Lua Example
`spawn_orange_number(behParam, relX, relY, relZ)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behParam | `integer` |
| relX | `integer` |
| relY | `integer` |
| relZ | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void spawn_orange_number(s8 behParam, s16 relX, s16 relY, s16 relZ);`
[:arrow_up_small: ](# )
< br / >
## [turn_obj_away_from_steep_floor](#turn_obj_away_from_steep_floor)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = turn_obj_away_from_steep_floor(objFloor, floorY, objVelX, objVelZ)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| objFloor | [Surface ](structs.md#Surface ) |
2022-03-05 06:22:31 +00:00
| floorY | `number` |
| objVelX | `number` |
| objVelZ | `number` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
2022-03-13 08:17:10 +00:00
`s8 turn_obj_away_from_steep_floor(struct Surface *objFloor, f32 floorY, f32 objVelX, f32 objVelZ);`
2022-02-23 06:39:45 +00:00
[:arrow_up_small: ](# )
< br / >
## [turn_obj_away_from_surface](#turn_obj_away_from_surface)
### Lua Example
`turn_obj_away_from_surface(velX, velZ, nX, nY, nZ, objYawX, objYawZ)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| velX | `number` |
| velZ | `number` |
| nX | `number` |
| nY | `number` |
| nZ | `number` |
| objYawX | `Pointer` < `number`> |
| objYawZ | `Pointer` < `number`> |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void turn_obj_away_from_surface(f32 velX, f32 velZ, f32 nX, UNUSED f32 nY, f32 nZ, f32 *objYawX, f32 *objYawZ);`
[:arrow_up_small: ](# )
< br / >
---
# functions from obj_behaviors_2.c
< br / >
## [approach_f32_ptr](#approach_f32_ptr)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = approach_f32_ptr(px, target, delta)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| px | `Pointer` < `number`> |
| target | `number` |
| delta | `number` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 approach_f32_ptr(f32 *px, f32 target, f32 delta);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_init_anim_and_check_if_end](#cur_obj_init_anim_and_check_if_end)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_init_anim_and_check_if_end(arg0)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| arg0 | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 cur_obj_init_anim_and_check_if_end(s32 arg0);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_init_anim_check_frame](#cur_obj_init_anim_check_frame)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_init_anim_check_frame(arg0, arg1)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| arg0 | `integer` |
| arg1 | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 cur_obj_init_anim_check_frame(s32 arg0, s32 arg1);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_init_anim_extend](#cur_obj_init_anim_extend)
### Lua Example
`cur_obj_init_anim_extend(arg0)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| arg0 | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void cur_obj_init_anim_extend(s32 arg0);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_play_sound_at_anim_range](#cur_obj_play_sound_at_anim_range)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_play_sound_at_anim_range(arg0, arg1, sound)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| arg0 | `integer` |
| arg1 | `integer` |
| sound | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 cur_obj_play_sound_at_anim_range(s8 arg0, s8 arg1, u32 sound);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_anim_if_at_end](#cur_obj_set_anim_if_at_end)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_set_anim_if_at_end(arg0)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| arg0 | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 cur_obj_set_anim_if_at_end(s32 arg0);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_spin_all_dimensions](#cur_obj_spin_all_dimensions)
### Lua Example
`cur_obj_spin_all_dimensions(arg0, arg1)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| arg0 | `number` |
| arg1 | `number` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void cur_obj_spin_all_dimensions(f32 arg0, f32 arg1);`
[:arrow_up_small: ](# )
< br / >
## [obj_act_knockback](#obj_act_knockback)
### Lua Example
`obj_act_knockback(baseScale)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| baseScale | `number` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_act_knockback(UNUSED f32 baseScale);`
[:arrow_up_small: ](# )
< br / >
## [obj_act_squished](#obj_act_squished)
### Lua Example
`obj_act_squished(baseScale)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| baseScale | `number` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_act_squished(f32 baseScale);`
[:arrow_up_small: ](# )
< br / >
## [obj_bounce_off_walls_edges_objects](#obj_bounce_off_walls_edges_objects)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_bounce_off_walls_edges_objects(targetYaw)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| targetYaw | `Pointer` < `integer`> |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_bounce_off_walls_edges_objects(s32 *targetYaw);`
[:arrow_up_small: ](# )
< br / >
## [obj_check_attacks](#obj_check_attacks)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_check_attacks(hitbox, attackedMarioAction)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| hitbox | [ObjectHitbox ](structs.md#ObjectHitbox ) |
2022-03-05 06:22:31 +00:00
| attackedMarioAction | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_check_attacks(struct ObjectHitbox *hitbox, s32 attackedMarioAction);`
[:arrow_up_small: ](# )
< br / >
## [obj_compute_vel_from_move_pitch](#obj_compute_vel_from_move_pitch)
### Lua Example
`obj_compute_vel_from_move_pitch(speed)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| speed | `number` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_compute_vel_from_move_pitch(f32 speed);`
[:arrow_up_small: ](# )
< br / >
## [obj_die_if_above_lava_and_health_non_positive](#obj_die_if_above_lava_and_health_non_positive)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_die_if_above_lava_and_health_non_positive()`
2022-02-23 06:39:45 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_die_if_above_lava_and_health_non_positive(void);`
[:arrow_up_small: ](# )
< br / >
## [obj_die_if_health_non_positive](#obj_die_if_health_non_positive)
### Lua Example
`obj_die_if_health_non_positive()`
### Parameters
- None
### Returns
- None
### C Prototype
`void obj_die_if_health_non_positive(void);`
[:arrow_up_small: ](# )
< br / >
## [obj_face_pitch_approach](#obj_face_pitch_approach)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_face_pitch_approach(targetPitch, deltaPitch)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| targetPitch | `integer` |
| deltaPitch | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_face_pitch_approach(s16 targetPitch, s16 deltaPitch);`
[:arrow_up_small: ](# )
< br / >
## [obj_face_roll_approach](#obj_face_roll_approach)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_face_roll_approach(targetRoll, deltaRoll)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| targetRoll | `integer` |
| deltaRoll | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_face_roll_approach(s16 targetRoll, s16 deltaRoll);`
[:arrow_up_small: ](# )
< br / >
## [obj_face_yaw_approach](#obj_face_yaw_approach)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_face_yaw_approach(targetYaw, deltaYaw)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| targetYaw | `integer` |
| deltaYaw | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_face_yaw_approach(s16 targetYaw, s16 deltaYaw);`
[:arrow_up_small: ](# )
< br / >
## [obj_forward_vel_approach](#obj_forward_vel_approach)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_forward_vel_approach(target, delta)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| target | `number` |
| delta | `number` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_forward_vel_approach(f32 target, f32 delta);`
[:arrow_up_small: ](# )
< br / >
## [obj_get_pitch_from_vel](#obj_get_pitch_from_vel)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_get_pitch_from_vel()`
2022-02-23 06:39:45 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s16 obj_get_pitch_from_vel(void);`
[:arrow_up_small: ](# )
< br / >
## [obj_get_pitch_to_home](#obj_get_pitch_to_home)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_get_pitch_to_home(latDistToHome)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| latDistToHome | `number` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s16 obj_get_pitch_to_home(f32 latDistToHome);`
[:arrow_up_small: ](# )
< br / >
## [obj_grow_then_shrink](#obj_grow_then_shrink)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_grow_then_shrink(scaleVel, shootFireScale, endScale)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| scaleVel | `Pointer` < `number`> |
| shootFireScale | `number` |
| endScale | `number` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_grow_then_shrink(f32 *scaleVel, f32 shootFireScale, f32 endScale);`
[:arrow_up_small: ](# )
< br / >
## [obj_handle_attacks](#obj_handle_attacks)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_handle_attacks(hitbox, attackedMarioAction, attackHandlers)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| hitbox | [ObjectHitbox ](structs.md#ObjectHitbox ) |
2022-03-05 06:22:31 +00:00
| attackedMarioAction | `integer` |
| attackHandlers | `Pointer` < `integer`> |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_handle_attacks(struct ObjectHitbox *hitbox, s32 attackedMarioAction, u8 *attackHandlers);`
[:arrow_up_small: ](# )
< br / >
## [obj_is_near_to_and_facing_mario](#obj_is_near_to_and_facing_mario)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_is_near_to_and_facing_mario(m, maxDist, maxAngleDiff)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| maxDist | `number` |
| maxAngleDiff | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_is_near_to_and_facing_mario(struct MarioState* m, f32 maxDist, s16 maxAngleDiff);`
[:arrow_up_small: ](# )
< br / >
## [obj_is_rendering_enabled](#obj_is_rendering_enabled)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_is_rendering_enabled()`
2022-02-23 06:39:45 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_is_rendering_enabled(void);`
[:arrow_up_small: ](# )
< br / >
## [obj_move_for_one_second](#obj_move_for_one_second)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_move_for_one_second(endAction)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| endAction | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_move_for_one_second(s32 endAction);`
[:arrow_up_small: ](# )
< br / >
## [obj_move_pitch_approach](#obj_move_pitch_approach)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_move_pitch_approach(target, delta)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| target | `integer` |
| delta | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_move_pitch_approach(s16 target, s16 delta);`
[:arrow_up_small: ](# )
< br / >
## [obj_random_fixed_turn](#obj_random_fixed_turn)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_random_fixed_turn(delta)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| delta | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s16 obj_random_fixed_turn(s16 delta);`
[:arrow_up_small: ](# )
< br / >
## [obj_resolve_collisions_and_turn](#obj_resolve_collisions_and_turn)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_resolve_collisions_and_turn(targetYaw, turnSpeed)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| targetYaw | `integer` |
| turnSpeed | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_resolve_collisions_and_turn(s16 targetYaw, s16 turnSpeed);`
[:arrow_up_small: ](# )
< br / >
## [obj_resolve_object_collisions](#obj_resolve_object_collisions)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_resolve_object_collisions(targetYaw)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| targetYaw | `Pointer` < `integer`> |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_resolve_object_collisions(s32 *targetYaw);`
[:arrow_up_small: ](# )
< br / >
## [obj_roll_to_match_yaw_turn](#obj_roll_to_match_yaw_turn)
### Lua Example
`obj_roll_to_match_yaw_turn(targetYaw, maxRoll, rollSpeed)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| targetYaw | `integer` |
| maxRoll | `integer` |
| rollSpeed | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_roll_to_match_yaw_turn(s16 targetYaw, s16 maxRoll, s16 rollSpeed);`
[:arrow_up_small: ](# )
< br / >
## [obj_rotate_yaw_and_bounce_off_walls](#obj_rotate_yaw_and_bounce_off_walls)
### Lua Example
`obj_rotate_yaw_and_bounce_off_walls(targetYaw, turnAmount)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| targetYaw | `integer` |
| turnAmount | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_rotate_yaw_and_bounce_off_walls(s16 targetYaw, s16 turnAmount);`
[:arrow_up_small: ](# )
< br / >
## [obj_set_dist_from_home](#obj_set_dist_from_home)
### Lua Example
`obj_set_dist_from_home(distFromHome)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| distFromHome | `number` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_set_dist_from_home(f32 distFromHome);`
[:arrow_up_small: ](# )
< br / >
## [obj_set_knockback_action](#obj_set_knockback_action)
### Lua Example
`obj_set_knockback_action(attackType)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| attackType | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_set_knockback_action(s32 attackType);`
[:arrow_up_small: ](# )
< br / >
## [obj_set_squished_action](#obj_set_squished_action)
### Lua Example
`obj_set_squished_action()`
### Parameters
- None
### Returns
- None
### C Prototype
`void obj_set_squished_action(void);`
[:arrow_up_small: ](# )
< br / >
## [obj_smooth_turn](#obj_smooth_turn)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_smooth_turn(angleVel, angle, targetAngle, targetSpeedProportion, accel, minSpeed, maxSpeed)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| angleVel | `Pointer` < `integer`> |
| angle | `Pointer` < `integer`> |
| targetAngle | `integer` |
| targetSpeedProportion | `number` |
| accel | `integer` |
| minSpeed | `integer` |
| maxSpeed | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_smooth_turn(s16 *angleVel, s32 *angle, s16 targetAngle, f32 targetSpeedProportion, s16 accel, s16 minSpeed, s16 maxSpeed);`
[:arrow_up_small: ](# )
< br / >
## [obj_spit_fire](#obj_spit_fire)
### Lua Example
`local ObjectValue = obj_spit_fire(relativePosX, relativePosY, relativePosZ, scale, model, startSpeed, endSpeed, movePitch)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| relativePosX | `integer` |
| relativePosY | `integer` |
| relativePosZ | `integer` |
| scale | `number` |
| model | `integer` |
| startSpeed | `number` |
| endSpeed | `number` |
| movePitch | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object* obj_spit_fire(s16 relativePosX, s16 relativePosY, s16 relativePosZ, f32 scale, s32 model, f32 startSpeed, f32 endSpeed, s16 movePitch);`
[:arrow_up_small: ](# )
< br / >
## [obj_turn_pitch_toward_mario](#obj_turn_pitch_toward_mario)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_turn_pitch_toward_mario(m, targetOffsetY, turnAmount)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| targetOffsetY | `number` |
| turnAmount | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s16 obj_turn_pitch_toward_mario(struct MarioState* m, f32 targetOffsetY, s16 turnAmount);`
[:arrow_up_small: ](# )
< br / >
## [obj_unused_die](#obj_unused_die)
### Lua Example
`obj_unused_die()`
### Parameters
- None
### Returns
- None
### C Prototype
`void obj_unused_die(void);`
[:arrow_up_small: ](# )
< br / >
## [obj_update_blinking](#obj_update_blinking)
### Lua Example
`obj_update_blinking(blinkTimer, baseCycleLength, cycleLengthRange, blinkLength)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| blinkTimer | `Pointer` < `integer`> |
| baseCycleLength | `integer` |
| cycleLengthRange | `integer` |
| blinkLength | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void obj_update_blinking(s32 *blinkTimer, s16 baseCycleLength, s16 cycleLengthRange, s16 blinkLength);`
[:arrow_up_small: ](# )
< br / >
## [obj_update_standard_actions](#obj_update_standard_actions)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_update_standard_actions(scale)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| scale | `number` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_update_standard_actions(f32 scale);`
[:arrow_up_small: ](# )
< br / >
## [obj_y_vel_approach](#obj_y_vel_approach)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_y_vel_approach(target, delta)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| target | `number` |
| delta | `number` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 obj_y_vel_approach(f32 target, f32 delta);`
[:arrow_up_small: ](# )
< br / >
## [oscillate_toward](#oscillate_toward)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = oscillate_toward(value, vel, target, velCloseToZero, accel, slowdown)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| value | `Pointer` < `integer`> |
| vel | `Pointer` < `number`> |
| target | `integer` |
| velCloseToZero | `number` |
| accel | `number` |
| slowdown | `number` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s32 oscillate_toward(s32 *value, f32 *vel, s32 target, f32 velCloseToZero, f32 accel, f32 slowdown);`
[:arrow_up_small: ](# )
< br / >
## [platform_on_track_update_pos_or_spawn_ball](#platform_on_track_update_pos_or_spawn_ball)
### Lua Example
`platform_on_track_update_pos_or_spawn_ball(ballIndex, x, y, z)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| ballIndex | `integer` |
| x | `number` |
| y | `number` |
| z | `number` |
2022-02-23 06:39:45 +00:00
### Returns
- None
### C Prototype
`void platform_on_track_update_pos_or_spawn_ball(s32 ballIndex, f32 x, f32 y, f32 z);`
[:arrow_up_small: ](# )
< br / >
## [random_linear_offset](#random_linear_offset)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = random_linear_offset(base, range)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| base | `integer` |
| range | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s16 random_linear_offset(s16 base, s16 range);`
[:arrow_up_small: ](# )
< br / >
## [random_mod_offset](#random_mod_offset)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = random_mod_offset(base, step, mod)`
2022-02-23 06:39:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| base | `integer` |
| step | `integer` |
| mod | `integer` |
2022-02-23 06:39:45 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 06:39:45 +00:00
### C Prototype
`s16 random_mod_offset(s16 base, s16 step, s16 mod);`
[:arrow_up_small: ](# )
< br / >
2022-03-30 04:12:42 +00:00
## [treat_far_home_as_mario](#treat_far_home_as_mario)
### Lua Example
`treat_far_home_as_mario(threshold, distanceToPlayer, angleToPlayer)`
### Parameters
| Field | Type |
| ----- | ---- |
| threshold | `number` |
| distanceToPlayer | `Pointer` < `integer`> |
| angleToPlayer | `Pointer` < `integer`> |
### Returns
- None
### C Prototype
`void treat_far_home_as_mario(f32 threshold, s32* distanceToPlayer, s32* angleToPlayer);`
[:arrow_up_small: ](# )
< br / >
2022-02-23 02:34:51 +00:00
---
# functions from object_helpers.c
< br / >
2022-03-03 09:04:15 +00:00
## [abs_angle_diff](#abs_angle_diff)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = abs_angle_diff(x0, x1)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| x0 | `integer` |
| x1 | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s16 abs_angle_diff(s16 x0, s16 x1);`
[:arrow_up_small: ](# )
< br / >
## [apply_drag_to_value](#apply_drag_to_value)
### Lua Example
`apply_drag_to_value(value, dragStrength)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| value | `Pointer` < `number`> |
| dragStrength | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void apply_drag_to_value(f32 *value, f32 dragStrength);`
[:arrow_up_small: ](# )
< br / >
2022-02-23 02:34:51 +00:00
## [approach_f32_signed](#approach_f32_signed)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = approach_f32_signed(value, target, increment)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| value | `Pointer` < `number`> |
| target | `number` |
| increment | `number` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
`s32 approach_f32_signed(f32 *value, f32 target, f32 increment);`
[:arrow_up_small: ](# )
< br / >
## [approach_f32_symmetric](#approach_f32_symmetric)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = approach_f32_symmetric(value, target, increment)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| value | `number` |
| target | `number` |
| increment | `number` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-02-23 02:34:51 +00:00
### C Prototype
`f32 approach_f32_symmetric(f32 value, f32 target, f32 increment);`
[:arrow_up_small: ](# )
< br / >
## [approach_s16_symmetric](#approach_s16_symmetric)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = approach_s16_symmetric(value, target, increment)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| value | `integer` |
| target | `integer` |
| increment | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
`s16 approach_s16_symmetric(s16 value, s16 target, s16 increment);`
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [bhv_dust_smoke_loop](#bhv_dust_smoke_loop)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`bhv_dust_smoke_loop()`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void bhv_dust_smoke_loop(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [bhv_init_room](#bhv_init_room)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`bhv_init_room()`
2022-02-23 02:34:51 +00:00
### Parameters
- None
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void bhv_init_room(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [bit_shift_left](#bit_shift_left)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = bit_shift_left(a0)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| a0 | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 bit_shift_left(s32 a0);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [chain_segment_init](#chain_segment_init)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`chain_segment_init(segment)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-03 09:04:15 +00:00
| segment | [ChainSegment ](structs.md#ChainSegment ) |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void chain_segment_init(struct ChainSegment *segment);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [clear_move_flag](#clear_move_flag)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = clear_move_flag(bitSet, flag)`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| bitSet | `Pointer` < `integer`> |
| flag | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 clear_move_flag(u32 *bitSet, s32 flag);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [clear_time_stop_flags](#clear_time_stop_flags)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`clear_time_stop_flags(flags)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| flags | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void clear_time_stop_flags(s32 flags);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [count_objects_with_behavior](#count_objects_with_behavior)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = count_objects_with_behavior(behavior)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 count_objects_with_behavior(const BehaviorScript *behavior);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [count_unimportant_objects](#count_unimportant_objects)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = count_unimportant_objects()`
2022-02-23 02:34:51 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 count_unimportant_objects(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_abs_y_dist_to_home](#cur_obj_abs_y_dist_to_home)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = cur_obj_abs_y_dist_to_home()`
2022-02-23 02:34:51 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`f32 cur_obj_abs_y_dist_to_home(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_advance_looping_anim](#cur_obj_advance_looping_anim)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_advance_looping_anim()`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 cur_obj_advance_looping_anim(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_align_gfx_with_floor](#cur_obj_align_gfx_with_floor)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`cur_obj_align_gfx_with_floor()`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void cur_obj_align_gfx_with_floor(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_angle_to_home](#cur_obj_angle_to_home)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_angle_to_home()`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s16 cur_obj_angle_to_home(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_apply_drag_xz](#cur_obj_apply_drag_xz)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`cur_obj_apply_drag_xz(dragStrength)`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| dragStrength | `number` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void cur_obj_apply_drag_xz(f32 dragStrength);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_become_intangible](#cur_obj_become_intangible)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`cur_obj_become_intangible()`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void cur_obj_become_intangible(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_become_tangible](#cur_obj_become_tangible)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`cur_obj_become_tangible()`
2022-02-23 02:34:51 +00:00
### Parameters
- None
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void cur_obj_become_tangible(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_can_mario_activate_textbox](#cur_obj_can_mario_activate_textbox)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_can_mario_activate_textbox(m, radius, height, unused)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-03 09:04:15 +00:00
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| radius | `number` |
| height | `number` |
| unused | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 cur_obj_can_mario_activate_textbox(struct MarioState* m, f32 radius, f32 height, UNUSED s32 unused);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_can_mario_activate_textbox_2](#cur_obj_can_mario_activate_textbox_2)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_can_mario_activate_textbox_2(m, radius, height)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-03 09:04:15 +00:00
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| radius | `number` |
| height | `number` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 cur_obj_can_mario_activate_textbox_2(struct MarioState* m, f32 radius, f32 height);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_change_action](#cur_obj_change_action)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`cur_obj_change_action(action)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| action | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void cur_obj_change_action(s32 action);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_check_anim_frame](#cur_obj_check_anim_frame)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_check_anim_frame(frame)`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| frame | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 cur_obj_check_anim_frame(s32 frame);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_check_anim_frame_in_range](#cur_obj_check_anim_frame_in_range)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_check_anim_frame_in_range(startFrame, rangeLength)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| startFrame | `integer` |
| rangeLength | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 cur_obj_check_anim_frame_in_range(s32 startFrame, s32 rangeLength);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_check_frame_prior_current_frame](#cur_obj_check_frame_prior_current_frame)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_check_frame_prior_current_frame(a0)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| a0 | `Pointer` < `integer`> |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 cur_obj_check_frame_prior_current_frame(s16 *a0);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_check_grabbed_mario](#cur_obj_check_grabbed_mario)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_check_grabbed_mario()`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 cur_obj_check_grabbed_mario(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_check_if_at_animation_end](#cur_obj_check_if_at_animation_end)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_check_if_at_animation_end()`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 cur_obj_check_if_at_animation_end(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_check_if_near_animation_end](#cur_obj_check_if_near_animation_end)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_check_if_near_animation_end()`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 cur_obj_check_if_near_animation_end(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_check_interacted](#cur_obj_check_interacted)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_check_interacted()`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 cur_obj_check_interacted(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [cur_obj_clear_interact_status_flag](#cur_obj_clear_interact_status_flag)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_clear_interact_status_flag(flag)`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| flag | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_clear_interact_status_flag(s32 flag);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_compute_vel_xz](#cur_obj_compute_vel_xz)
### Lua Example
`cur_obj_compute_vel_xz()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_compute_vel_xz(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_count_objects_with_behavior](#cur_obj_count_objects_with_behavior)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_count_objects_with_behavior(behavior, dist)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
| dist | `number` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`u16 cur_obj_count_objects_with_behavior(const BehaviorScript* behavior, f32 dist);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_detect_steep_floor](#cur_obj_detect_steep_floor)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_detect_steep_floor(steepAngleDegrees)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| steepAngleDegrees | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_detect_steep_floor(s16 steepAngleDegrees);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_disable](#cur_obj_disable)
### Lua Example
`cur_obj_disable()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_disable(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_disable_rendering](#cur_obj_disable_rendering)
### Lua Example
`cur_obj_disable_rendering()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_disable_rendering(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_disable_rendering_and_become_intangible](#cur_obj_disable_rendering_and_become_intangible)
### Lua Example
`cur_obj_disable_rendering_and_become_intangible(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void cur_obj_disable_rendering_and_become_intangible(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_dist_to_nearest_object_with_behavior](#cur_obj_dist_to_nearest_object_with_behavior)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = cur_obj_dist_to_nearest_object_with_behavior(behavior)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-03-03 09:04:15 +00:00
### C Prototype
`f32 cur_obj_dist_to_nearest_object_with_behavior(const BehaviorScript *behavior);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_enable_rendering](#cur_obj_enable_rendering)
### Lua Example
`cur_obj_enable_rendering()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_enable_rendering(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_enable_rendering_2](#cur_obj_enable_rendering_2)
### Lua Example
`cur_obj_enable_rendering_2()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_enable_rendering_2(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_enable_rendering_and_become_tangible](#cur_obj_enable_rendering_and_become_tangible)
### Lua Example
`cur_obj_enable_rendering_and_become_tangible(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void cur_obj_enable_rendering_and_become_tangible(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_enable_rendering_if_mario_in_room](#cur_obj_enable_rendering_if_mario_in_room)
### Lua Example
`cur_obj_enable_rendering_if_mario_in_room()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_enable_rendering_if_mario_in_room(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_end_dialog](#cur_obj_end_dialog)
### Lua Example
`cur_obj_end_dialog(m, dialogFlags, dialogResult)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| dialogFlags | `integer` |
| dialogResult | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_end_dialog(struct MarioState* m, s32 dialogFlags, s32 dialogResult);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_extend_animation_if_at_end](#cur_obj_extend_animation_if_at_end)
### Lua Example
`cur_obj_extend_animation_if_at_end()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_extend_animation_if_at_end(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_find_nearby_held_actor](#cur_obj_find_nearby_held_actor)
### Lua Example
`local ObjectValue = cur_obj_find_nearby_held_actor(behavior, maxDist)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
| maxDist | `number` |
2022-03-03 09:04:15 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object *cur_obj_find_nearby_held_actor(const BehaviorScript *behavior, f32 maxDist);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_find_nearest_object_with_behavior](#cur_obj_find_nearest_object_with_behavior)
### Lua Example
`local ObjectValue = cur_obj_find_nearest_object_with_behavior(behavior, dist)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
| dist | `Pointer` < `number`> |
2022-03-03 09:04:15 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object *cur_obj_find_nearest_object_with_behavior(const BehaviorScript *behavior, f32 *dist);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_find_nearest_pole](#cur_obj_find_nearest_pole)
### Lua Example
`local ObjectValue = cur_obj_find_nearest_pole()`
### Parameters
- None
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object* cur_obj_find_nearest_pole(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_follow_path](#cur_obj_follow_path)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_follow_path(unusedArg)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| unusedArg | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_follow_path(UNUSED s32 unusedArg);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_forward_vel_approach_upward](#cur_obj_forward_vel_approach_upward)
### Lua Example
`cur_obj_forward_vel_approach_upward(target, increment)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| target | `number` |
| increment | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_forward_vel_approach_upward(f32 target, f32 increment);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_get_dropped](#cur_obj_get_dropped)
### Lua Example
`cur_obj_get_dropped()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_get_dropped(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_get_thrown_or_placed](#cur_obj_get_thrown_or_placed)
### Lua Example
`cur_obj_get_thrown_or_placed(forwardVel, velY, thrownAction)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| forwardVel | `number` |
| velY | `number` |
| thrownAction | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_get_thrown_or_placed(f32 forwardVel, f32 velY, s32 thrownAction);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_has_behavior](#cur_obj_has_behavior)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_has_behavior(behavior)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_has_behavior(const BehaviorScript *behavior);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_has_model](#cur_obj_has_model)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_has_model(modelID)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| modelID | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_has_model(u16 modelID);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_hide](#cur_obj_hide)
### Lua Example
`cur_obj_hide()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_hide(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_hide_if_mario_far_away_y](#cur_obj_hide_if_mario_far_away_y)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_hide_if_mario_far_away_y(distY)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| distY | `number` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_hide_if_mario_far_away_y(f32 distY);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_if_hit_wall_bounce_away](#cur_obj_if_hit_wall_bounce_away)
### Lua Example
`cur_obj_if_hit_wall_bounce_away()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_if_hit_wall_bounce_away(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_init_animation](#cur_obj_init_animation)
### Lua Example
`cur_obj_init_animation(animIndex)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| animIndex | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_init_animation(s32 animIndex);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_init_animation_and_anim_frame](#cur_obj_init_animation_and_anim_frame)
### Lua Example
`cur_obj_init_animation_and_anim_frame(animIndex, animFrame)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| animIndex | `integer` |
| animFrame | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_init_animation_and_anim_frame(s32 animIndex, s32 animFrame);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_init_animation_and_check_if_near_end](#cur_obj_init_animation_and_check_if_near_end)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_init_animation_and_check_if_near_end(animIndex)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| animIndex | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_init_animation_and_check_if_near_end(s32 animIndex);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_init_animation_and_extend_if_at_end](#cur_obj_init_animation_and_extend_if_at_end)
### Lua Example
`cur_obj_init_animation_and_extend_if_at_end(animIndex)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| animIndex | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_init_animation_and_extend_if_at_end(s32 animIndex);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_init_animation_with_accel_and_sound](#cur_obj_init_animation_with_accel_and_sound)
### Lua Example
`cur_obj_init_animation_with_accel_and_sound(animIndex, accel)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| animIndex | `integer` |
| accel | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_init_animation_with_accel_and_sound(s32 animIndex, f32 accel);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_init_animation_with_sound](#cur_obj_init_animation_with_sound)
### Lua Example
`cur_obj_init_animation_with_sound(animIndex)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| animIndex | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_init_animation_with_sound(s32 animIndex);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_is_any_player_on_platform](#cur_obj_is_any_player_on_platform)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_is_any_player_on_platform()`
2022-03-03 09:04:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_is_any_player_on_platform(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_is_mario_ground_pounding_platform](#cur_obj_is_mario_ground_pounding_platform)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_is_mario_ground_pounding_platform()`
2022-03-03 09:04:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_is_mario_ground_pounding_platform(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_is_mario_on_platform](#cur_obj_is_mario_on_platform)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_is_mario_on_platform()`
2022-03-03 09:04:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_is_mario_on_platform(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_lateral_dist_from_mario_to_home](#cur_obj_lateral_dist_from_mario_to_home)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = cur_obj_lateral_dist_from_mario_to_home()`
2022-03-03 09:04:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-03-03 09:04:15 +00:00
### C Prototype
`f32 cur_obj_lateral_dist_from_mario_to_home(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_lateral_dist_from_obj_to_home](#cur_obj_lateral_dist_from_obj_to_home)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = cur_obj_lateral_dist_from_obj_to_home(obj)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-03-03 09:04:15 +00:00
### C Prototype
`f32 cur_obj_lateral_dist_from_obj_to_home(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_lateral_dist_to_home](#cur_obj_lateral_dist_to_home)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = cur_obj_lateral_dist_to_home()`
2022-03-03 09:04:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-03-03 09:04:15 +00:00
### C Prototype
`f32 cur_obj_lateral_dist_to_home(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_mario_far_away](#cur_obj_mario_far_away)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_mario_far_away()`
2022-03-03 09:04:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_mario_far_away(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_after_thrown_or_dropped](#cur_obj_move_after_thrown_or_dropped)
### Lua Example
`cur_obj_move_after_thrown_or_dropped(forwardVel, velY)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| forwardVel | `number` |
| velY | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_move_after_thrown_or_dropped(f32 forwardVel, f32 velY);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_standard](#cur_obj_move_standard)
### Lua Example
`cur_obj_move_standard(steepSlopeAngleDegrees)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| steepSlopeAngleDegrees | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_move_standard(s16 steepSlopeAngleDegrees);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_up_and_down](#cur_obj_move_up_and_down)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_move_up_and_down(a0)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| a0 | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_move_up_and_down(s32 a0);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_update_ground_air_flags](#cur_obj_move_update_ground_air_flags)
### Lua Example
`cur_obj_move_update_ground_air_flags(gravity, bounciness)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| gravity | `number` |
| bounciness | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_move_update_ground_air_flags(UNUSED f32 gravity, f32 bounciness);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_update_underwater_flags](#cur_obj_move_update_underwater_flags)
### Lua Example
`cur_obj_move_update_underwater_flags()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_move_update_underwater_flags(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_using_fvel_and_gravity](#cur_obj_move_using_fvel_and_gravity)
### Lua Example
`cur_obj_move_using_fvel_and_gravity()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_move_using_fvel_and_gravity(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_using_vel](#cur_obj_move_using_vel)
### Lua Example
`cur_obj_move_using_vel()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_move_using_vel(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_using_vel_and_gravity](#cur_obj_move_using_vel_and_gravity)
### Lua Example
`cur_obj_move_using_vel_and_gravity()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_move_using_vel_and_gravity(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_xz](#cur_obj_move_xz)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_move_xz(steepSlopeNormalY, careAboutEdgesAndSteepSlopes)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| steepSlopeNormalY | `number` |
| careAboutEdgesAndSteepSlopes | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_move_xz(f32 steepSlopeNormalY, s32 careAboutEdgesAndSteepSlopes);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_xz_using_fvel_and_yaw](#cur_obj_move_xz_using_fvel_and_yaw)
### Lua Example
`cur_obj_move_xz_using_fvel_and_yaw()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_move_xz_using_fvel_and_yaw(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_y](#cur_obj_move_y)
### Lua Example
`cur_obj_move_y(gravity, bounciness, buoyancy)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| gravity | `number` |
| bounciness | `number` |
| buoyancy | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_move_y(f32 gravity, f32 bounciness, f32 buoyancy);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_y_and_get_water_level](#cur_obj_move_y_and_get_water_level)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = cur_obj_move_y_and_get_water_level(gravity, buoyancy)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| gravity | `number` |
| buoyancy | `number` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-03-03 09:04:15 +00:00
### C Prototype
`f32 cur_obj_move_y_and_get_water_level(f32 gravity, f32 buoyancy);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_move_y_with_terminal_vel](#cur_obj_move_y_with_terminal_vel)
### Lua Example
`cur_obj_move_y_with_terminal_vel()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_move_y_with_terminal_vel(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_nearest_object_with_behavior](#cur_obj_nearest_object_with_behavior)
### Lua Example
`local ObjectValue = cur_obj_nearest_object_with_behavior(behavior)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
2022-03-03 09:04:15 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object *cur_obj_nearest_object_with_behavior(const BehaviorScript *behavior);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_outside_home_rectangle](#cur_obj_outside_home_rectangle)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_outside_home_rectangle(minX, maxX, minZ, maxZ)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| minX | `number` |
| maxX | `number` |
| minZ | `number` |
| maxZ | `number` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_outside_home_rectangle(f32 minX, f32 maxX, f32 minZ, f32 maxZ);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_outside_home_square](#cur_obj_outside_home_square)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_outside_home_square(halfLength)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| halfLength | `number` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_outside_home_square(f32 halfLength);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_progress_direction_table](#cur_obj_progress_direction_table)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_progress_direction_table()`
2022-03-03 09:04:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_progress_direction_table(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_push_mario_away](#cur_obj_push_mario_away)
### Lua Example
`cur_obj_push_mario_away(radius)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| radius | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_push_mario_away(f32 radius);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_push_mario_away_from_cylinder](#cur_obj_push_mario_away_from_cylinder)
### Lua Example
`cur_obj_push_mario_away_from_cylinder(radius, extentY)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| radius | `number` |
| extentY | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_push_mario_away_from_cylinder(f32 radius, f32 extentY);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_reflect_move_angle_off_wall](#cur_obj_reflect_move_angle_off_wall)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_reflect_move_angle_off_wall()`
2022-03-03 09:04:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s16 cur_obj_reflect_move_angle_off_wall(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_reset_timer_and_subaction](#cur_obj_reset_timer_and_subaction)
### Lua Example
`cur_obj_reset_timer_and_subaction()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_reset_timer_and_subaction(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_resolve_wall_collisions](#cur_obj_resolve_wall_collisions)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_resolve_wall_collisions()`
2022-03-03 09:04:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_resolve_wall_collisions(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_reverse_animation](#cur_obj_reverse_animation)
### Lua Example
`cur_obj_reverse_animation()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_reverse_animation(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_rotate_face_angle_using_vel](#cur_obj_rotate_face_angle_using_vel)
### Lua Example
`cur_obj_rotate_face_angle_using_vel()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_rotate_face_angle_using_vel(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_rotate_move_angle_using_vel](#cur_obj_rotate_move_angle_using_vel)
### Lua Example
`cur_obj_rotate_move_angle_using_vel()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_rotate_move_angle_using_vel(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_rotate_yaw_toward](#cur_obj_rotate_yaw_toward)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_rotate_yaw_toward(target, increment)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| target | `integer` |
| increment | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_rotate_yaw_toward(s16 target, s16 increment);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_scale](#cur_obj_scale)
### Lua Example
`cur_obj_scale(scale)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| scale | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_scale(f32 scale);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_scale_over_time](#cur_obj_scale_over_time)
### Lua Example
`cur_obj_scale_over_time(a0, a1, sp10, sp14)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| a0 | `integer` |
| a1 | `integer` |
| sp10 | `number` |
| sp14 | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_scale_over_time(s32 a0, s32 a1, f32 sp10, f32 sp14);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_behavior](#cur_obj_set_behavior)
### Lua Example
`cur_obj_set_behavior(behavior)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_set_behavior(const BehaviorScript *behavior);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_direction_table](#cur_obj_set_direction_table)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_set_direction_table(a0)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| a0 | `Pointer` < `integer`> |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_set_direction_table(s8 *a0);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_face_angle_to_move_angle](#cur_obj_set_face_angle_to_move_angle)
### Lua Example
`cur_obj_set_face_angle_to_move_angle()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_set_face_angle_to_move_angle(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_hitbox_and_die_if_attacked](#cur_obj_set_hitbox_and_die_if_attacked)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_set_hitbox_and_die_if_attacked(hitbox, deathSound, noLootCoins)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| hitbox | [ObjectHitbox ](structs.md#ObjectHitbox ) |
2022-03-05 06:22:31 +00:00
| deathSound | `integer` |
| noLootCoins | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_set_hitbox_and_die_if_attacked(struct ObjectHitbox *hitbox, s32 deathSound, s32 noLootCoins);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_hitbox_radius_and_height](#cur_obj_set_hitbox_radius_and_height)
### Lua Example
`cur_obj_set_hitbox_radius_and_height(radius, height)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| radius | `number` |
| height | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_set_hitbox_radius_and_height(f32 radius, f32 height);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_hurtbox_radius_and_height](#cur_obj_set_hurtbox_radius_and_height)
### Lua Example
`cur_obj_set_hurtbox_radius_and_height(radius, height)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| radius | `number` |
| height | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_set_hurtbox_radius_and_height(f32 radius, f32 height);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_model](#cur_obj_set_model)
### Lua Example
`cur_obj_set_model(modelID)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| modelID | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_set_model(s32 modelID);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_pos_relative](#cur_obj_set_pos_relative)
### Lua Example
`cur_obj_set_pos_relative(other, dleft, dy, dforward)`
### Parameters
| Field | Type |
| ----- | ---- |
| other | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| dleft | `number` |
| dy | `number` |
| dforward | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_set_pos_relative(struct Object *other, f32 dleft, f32 dy, f32 dforward);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_pos_relative_to_parent](#cur_obj_set_pos_relative_to_parent)
### Lua Example
`cur_obj_set_pos_relative_to_parent(dleft, dy, dforward)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| dleft | `number` |
| dy | `number` |
| dforward | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_set_pos_relative_to_parent(f32 dleft, f32 dy, f32 dforward);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_pos_to_home](#cur_obj_set_pos_to_home)
### Lua Example
`cur_obj_set_pos_to_home()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_set_pos_to_home(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_pos_to_home_and_stop](#cur_obj_set_pos_to_home_and_stop)
### Lua Example
`cur_obj_set_pos_to_home_and_stop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_set_pos_to_home_and_stop(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_pos_to_home_with_debug](#cur_obj_set_pos_to_home_with_debug)
### Lua Example
`cur_obj_set_pos_to_home_with_debug()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_set_pos_to_home_with_debug(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_pos_via_transform](#cur_obj_set_pos_via_transform)
### Lua Example
`cur_obj_set_pos_via_transform()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_set_pos_via_transform(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_vel_from_mario_vel](#cur_obj_set_vel_from_mario_vel)
### Lua Example
`cur_obj_set_vel_from_mario_vel(m, f12, f14)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
2022-03-05 06:22:31 +00:00
| f12 | `number` |
| f14 | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_set_vel_from_mario_vel(struct MarioState* m, f32 f12, f32 f14);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_set_y_vel_and_animation](#cur_obj_set_y_vel_and_animation)
### Lua Example
`cur_obj_set_y_vel_and_animation(sp18, sp1C)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| sp18 | `number` |
| sp1C | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_set_y_vel_and_animation(f32 sp18, s32 sp1C);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_shake_screen](#cur_obj_shake_screen)
### Lua Example
`cur_obj_shake_screen(shake)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| shake | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_shake_screen(s32 shake);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_shake_y](#cur_obj_shake_y)
### Lua Example
`cur_obj_shake_y(amount)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| amount | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_shake_y(f32 amount);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_shake_y_until](#cur_obj_shake_y_until)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_shake_y_until(cycles, amount)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| cycles | `integer` |
| amount | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_shake_y_until(s32 cycles, s32 amount);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_spawn_loot_blue_coin](#cur_obj_spawn_loot_blue_coin)
### Lua Example
`cur_obj_spawn_loot_blue_coin()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_spawn_loot_blue_coin(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_spawn_loot_coin_at_mario_pos](#cur_obj_spawn_loot_coin_at_mario_pos)
### Lua Example
`cur_obj_spawn_loot_coin_at_mario_pos(m)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
`void cur_obj_spawn_loot_coin_at_mario_pos(struct MarioState* m);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_spawn_particles](#cur_obj_spawn_particles)
### Lua Example
`cur_obj_spawn_particles(info)`
### Parameters
| Field | Type |
| ----- | ---- |
| info | [SpawnParticlesInfo ](structs.md#SpawnParticlesInfo ) |
### Returns
- None
### C Prototype
`void cur_obj_spawn_particles(struct SpawnParticlesInfo *info);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_spawn_star_at_y_offset](#cur_obj_spawn_star_at_y_offset)
### Lua Example
`cur_obj_spawn_star_at_y_offset(targetX, targetY, targetZ, offsetY)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| targetX | `number` |
| targetY | `number` |
| targetZ | `number` |
| offsetY | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_spawn_star_at_y_offset(f32 targetX, f32 targetY, f32 targetZ, f32 offsetY);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_start_cam_event](#cur_obj_start_cam_event)
### Lua Example
`cur_obj_start_cam_event(obj, cameraEvent)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| cameraEvent | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_start_cam_event(UNUSED struct Object *obj, s32 cameraEvent);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_unhide](#cur_obj_unhide)
### Lua Example
`cur_obj_unhide()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_unhide(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_unrender_and_reset_state](#cur_obj_unrender_and_reset_state)
### Lua Example
`cur_obj_unrender_and_reset_state(sp18, sp1C)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| sp18 | `integer` |
| sp1C | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_unrender_and_reset_state(s32 sp18, s32 sp1C);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_unused_init_on_floor](#cur_obj_unused_init_on_floor)
### Lua Example
`cur_obj_unused_init_on_floor()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_unused_init_on_floor(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_unused_play_footstep_sound](#cur_obj_unused_play_footstep_sound)
### Lua Example
`cur_obj_unused_play_footstep_sound(animFrame1, animFrame2, sound)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| animFrame1 | `integer` |
| animFrame2 | `integer` |
| sound | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_unused_play_footstep_sound(s32 animFrame1, s32 animFrame2, s32 sound);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_unused_resolve_wall_collisions](#cur_obj_unused_resolve_wall_collisions)
### Lua Example
`cur_obj_unused_resolve_wall_collisions(offsetY, radius)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| offsetY | `number` |
| radius | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_unused_resolve_wall_collisions(f32 offsetY, f32 radius);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_update_floor](#cur_obj_update_floor)
### Lua Example
`cur_obj_update_floor()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_update_floor(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_update_floor_and_resolve_wall_collisions](#cur_obj_update_floor_and_resolve_wall_collisions)
### Lua Example
`cur_obj_update_floor_and_resolve_wall_collisions(steepSlopeDegrees)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| steepSlopeDegrees | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void cur_obj_update_floor_and_resolve_wall_collisions(s16 steepSlopeDegrees);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_update_floor_and_walls](#cur_obj_update_floor_and_walls)
### Lua Example
`cur_obj_update_floor_and_walls()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_update_floor_and_walls(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_update_floor_height](#cur_obj_update_floor_height)
### Lua Example
`cur_obj_update_floor_height()`
### Parameters
- None
### Returns
- None
### C Prototype
`void cur_obj_update_floor_height(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_update_floor_height_and_get_floor](#cur_obj_update_floor_height_and_get_floor)
### Lua Example
`local SurfaceValue = cur_obj_update_floor_height_and_get_floor()`
### Parameters
- None
### Returns
[Surface ](structs.md#Surface )
### C Prototype
`struct Surface *cur_obj_update_floor_height_and_get_floor(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_wait_then_blink](#cur_obj_wait_then_blink)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_wait_then_blink(timeUntilBlinking, numBlinks)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| timeUntilBlinking | `integer` |
| numBlinks | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_wait_then_blink(s32 timeUntilBlinking, s32 numBlinks);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_was_attacked_or_ground_pounded](#cur_obj_was_attacked_or_ground_pounded)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_was_attacked_or_ground_pounded()`
2022-03-03 09:04:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_was_attacked_or_ground_pounded(void);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_within_12k_bounds](#cur_obj_within_12k_bounds)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = cur_obj_within_12k_bounds()`
2022-03-03 09:04:15 +00:00
### Parameters
- None
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 cur_obj_within_12k_bounds(void);`
[:arrow_up_small: ](# )
< br / >
## [disable_time_stop](#disable_time_stop)
### Lua Example
`disable_time_stop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void disable_time_stop(void);`
[:arrow_up_small: ](# )
< br / >
## [disable_time_stop_including_mario](#disable_time_stop_including_mario)
### Lua Example
`disable_time_stop_including_mario()`
### Parameters
- None
### Returns
- None
### C Prototype
`void disable_time_stop_including_mario(void);`
[:arrow_up_small: ](# )
< br / >
## [dist_between_object_and_point](#dist_between_object_and_point)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = dist_between_object_and_point(obj, pointX, pointY, pointZ)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| pointX | `number` |
| pointY | `number` |
| pointZ | `number` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-03-03 09:04:15 +00:00
### C Prototype
`f32 dist_between_object_and_point(struct Object *obj, f32 pointX, f32 pointY, f32 pointZ);`
[:arrow_up_small: ](# )
< br / >
## [dist_between_objects](#dist_between_objects)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = dist_between_objects(obj1, obj2)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj1 | [Object ](structs.md#Object ) |
| obj2 | [Object ](structs.md#Object ) |
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-03-03 09:04:15 +00:00
### C Prototype
`f32 dist_between_objects(struct Object *obj1, struct Object *obj2);`
[:arrow_up_small: ](# )
< br / >
## [enable_time_stop](#enable_time_stop)
### Lua Example
`enable_time_stop()`
### Parameters
- None
### Returns
- None
### C Prototype
`void enable_time_stop(void);`
[:arrow_up_small: ](# )
< br / >
2022-03-30 04:12:42 +00:00
## [enable_time_stop_if_alone](#enable_time_stop_if_alone)
### Lua Example
`enable_time_stop_if_alone()`
### Parameters
- None
### Returns
- None
### C Prototype
`void enable_time_stop_if_alone(void);`
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [enable_time_stop_including_mario](#enable_time_stop_including_mario)
### Lua Example
`enable_time_stop_including_mario()`
### Parameters
- None
### Returns
- None
### C Prototype
`void enable_time_stop_including_mario(void);`
[:arrow_up_small: ](# )
< br / >
2022-03-31 03:03:59 +00:00
## [find_object_with_behavior](#find_object_with_behavior)
### Lua Example
`local ObjectValue = find_object_with_behavior(behavior)`
### Parameters
| Field | Type |
| ----- | ---- |
| behavior | `Pointer` < `BehaviorScript`> |
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object *find_object_with_behavior(const BehaviorScript *behavior);`
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [find_unimportant_object](#find_unimportant_object)
### Lua Example
`local ObjectValue = find_unimportant_object()`
### Parameters
- None
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object *find_unimportant_object(void);`
[:arrow_up_small: ](# )
< br / >
## [geo_offset_klepto_debug](#geo_offset_klepto_debug)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = geo_offset_klepto_debug(callContext, a1, sp8)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| callContext | `integer` |
2022-03-03 09:04:15 +00:00
| a1 | [GraphNode ](structs.md#GraphNode ) |
2022-03-05 06:22:31 +00:00
| sp8 | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 geo_offset_klepto_debug(s32 callContext, struct GraphNode *a1, UNUSED s32 sp8);`
[:arrow_up_small: ](# )
< br / >
## [get_object_list_from_behavior](#get_object_list_from_behavior)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = get_object_list_from_behavior(behavior)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`u32 get_object_list_from_behavior(const BehaviorScript *behavior);`
[:arrow_up_small: ](# )
< br / >
## [increment_velocity_toward_range](#increment_velocity_toward_range)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = increment_velocity_toward_range(value, center, zeroThreshold, increment)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| value | `number` |
| center | `number` |
| zeroThreshold | `number` |
| increment | `number` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-03-03 09:04:15 +00:00
### C Prototype
`f32 increment_velocity_toward_range(f32 value, f32 center, f32 zeroThreshold, f32 increment);`
[:arrow_up_small: ](# )
< br / >
## [is_item_in_array](#is_item_in_array)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = is_item_in_array(item, array)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| item | `integer` |
| array | `Pointer` < `integer`> |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 is_item_in_array(s8 item, s8 *array);`
[:arrow_up_small: ](# )
< br / >
## [is_mario_moving_fast_or_in_air](#is_mario_moving_fast_or_in_air)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = is_mario_moving_fast_or_in_air(speedThreshold)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| speedThreshold | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 is_mario_moving_fast_or_in_air(s32 speedThreshold);`
[:arrow_up_small: ](# )
< br / >
## [lateral_dist_between_objects](#lateral_dist_between_objects)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = lateral_dist_between_objects(obj1, obj2)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj1 | [Object ](structs.md#Object ) |
| obj2 | [Object ](structs.md#Object ) |
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-03-03 09:04:15 +00:00
### C Prototype
`f32 lateral_dist_between_objects(struct Object *obj1, struct Object *obj2);`
[:arrow_up_small: ](# )
< br / >
## [mario_is_dive_sliding](#mario_is_dive_sliding)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_is_dive_sliding(m)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 mario_is_dive_sliding(struct MarioState* m);`
[:arrow_up_small: ](# )
< br / >
## [mario_is_in_air_action](#mario_is_in_air_action)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_is_in_air_action(m)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 mario_is_in_air_action(struct MarioState* m);`
[:arrow_up_small: ](# )
< br / >
## [mario_is_within_rectangle](#mario_is_within_rectangle)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = mario_is_within_rectangle(minX, maxX, minZ, maxZ)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| minX | `integer` |
| maxX | `integer` |
| minZ | `integer` |
| maxZ | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 mario_is_within_rectangle(s16 minX, s16 maxX, s16 minZ, s16 maxZ);`
[:arrow_up_small: ](# )
< br / >
## [mario_set_flag](#mario_set_flag)
### Lua Example
`mario_set_flag(flag)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| flag | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void mario_set_flag(s32 flag);`
[:arrow_up_small: ](# )
< br / >
## [obj_angle_to_object](#obj_angle_to_object)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_angle_to_object(obj1, obj2)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj1 | [Object ](structs.md#Object ) |
| obj2 | [Object ](structs.md#Object ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s16 obj_angle_to_object(struct Object *obj1, struct Object *obj2);`
[:arrow_up_small: ](# )
< br / >
## [obj_angle_to_point](#obj_angle_to_point)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_angle_to_point(obj, pointX, pointZ)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| pointX | `number` |
| pointZ | `number` |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s16 obj_angle_to_point(struct Object *obj, f32 pointX, f32 pointZ);`
[:arrow_up_small: ](# )
< br / >
## [obj_apply_scale_to_transform](#obj_apply_scale_to_transform)
### Lua Example
`obj_apply_scale_to_transform(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_apply_scale_to_transform(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [obj_attack_collided_from_other_object](#obj_attack_collided_from_other_object)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_attack_collided_from_other_object(obj)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 obj_attack_collided_from_other_object(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [obj_become_tangible](#obj_become_tangible)
### Lua Example
`obj_become_tangible(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_become_tangible(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [obj_build_relative_transform](#obj_build_relative_transform)
### Lua Example
`obj_build_relative_transform(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_build_relative_transform(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [obj_build_transform_from_pos_and_angle](#obj_build_transform_from_pos_and_angle)
### Lua Example
`obj_build_transform_from_pos_and_angle(obj, posIndex, angleIndex)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| posIndex | `integer` |
| angleIndex | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void obj_build_transform_from_pos_and_angle(struct Object *obj, s16 posIndex, s16 angleIndex);`
[:arrow_up_small: ](# )
< br / >
## [obj_build_transform_relative_to_parent](#obj_build_transform_relative_to_parent)
### Lua Example
`obj_build_transform_relative_to_parent(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_build_transform_relative_to_parent(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [obj_build_vel_from_transform](#obj_build_vel_from_transform)
### Lua Example
`obj_build_vel_from_transform(a0)`
### Parameters
| Field | Type |
| ----- | ---- |
| a0 | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_build_vel_from_transform(struct Object *a0);`
[:arrow_up_small: ](# )
< br / >
## [obj_check_if_collided_with_object](#obj_check_if_collided_with_object)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_check_if_collided_with_object(obj1, obj2)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj1 | [Object ](structs.md#Object ) |
| obj2 | [Object ](structs.md#Object ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 obj_check_if_collided_with_object(struct Object *obj1, struct Object *obj2);`
[:arrow_up_small: ](# )
< br / >
## [obj_copy_angle](#obj_copy_angle)
### Lua Example
`obj_copy_angle(dst, src)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Object ](structs.md#Object ) |
| src | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_copy_angle(struct Object *dst, struct Object *src);`
[:arrow_up_small: ](# )
< br / >
## [obj_copy_behavior_params](#obj_copy_behavior_params)
### Lua Example
`obj_copy_behavior_params(dst, src)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Object ](structs.md#Object ) |
| src | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_copy_behavior_params(struct Object *dst, struct Object *src);`
[:arrow_up_small: ](# )
< br / >
## [obj_copy_graph_y_offset](#obj_copy_graph_y_offset)
### Lua Example
`obj_copy_graph_y_offset(dst, src)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Object ](structs.md#Object ) |
| src | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_copy_graph_y_offset(struct Object *dst, struct Object *src);`
[:arrow_up_small: ](# )
< br / >
## [obj_copy_pos](#obj_copy_pos)
### Lua Example
`obj_copy_pos(dst, src)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Object ](structs.md#Object ) |
| src | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_copy_pos(struct Object *dst, struct Object *src);`
[:arrow_up_small: ](# )
< br / >
## [obj_copy_pos_and_angle](#obj_copy_pos_and_angle)
### Lua Example
`obj_copy_pos_and_angle(dst, src)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Object ](structs.md#Object ) |
| src | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_copy_pos_and_angle(struct Object *dst, struct Object *src);`
[:arrow_up_small: ](# )
< br / >
## [obj_copy_scale](#obj_copy_scale)
### Lua Example
`obj_copy_scale(dst, src)`
### Parameters
| Field | Type |
| ----- | ---- |
| dst | [Object ](structs.md#Object ) |
| src | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_copy_scale(struct Object *dst, struct Object *src);`
[:arrow_up_small: ](# )
< br / >
## [obj_create_transform_from_self](#obj_create_transform_from_self)
### Lua Example
`obj_create_transform_from_self(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_create_transform_from_self(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [obj_explode_and_spawn_coins](#obj_explode_and_spawn_coins)
### Lua Example
`obj_explode_and_spawn_coins(sp18, sp1C)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| sp18 | `number` |
| sp1C | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void obj_explode_and_spawn_coins(f32 sp18, s32 sp1C);`
[:arrow_up_small: ](# )
< br / >
## [obj_has_behavior](#obj_has_behavior)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_has_behavior(obj, behavior)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 obj_has_behavior(struct Object *obj, const BehaviorScript *behavior);`
[:arrow_up_small: ](# )
< br / >
## [obj_init_animation](#obj_init_animation)
### Lua Example
`obj_init_animation(obj, animIndex)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| animIndex | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void obj_init_animation(struct Object *obj, s32 animIndex);`
[:arrow_up_small: ](# )
< br / >
## [obj_is_hidden](#obj_is_hidden)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_is_hidden(obj)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s32 obj_is_hidden(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [obj_mark_for_deletion](#obj_mark_for_deletion)
### Lua Example
`obj_mark_for_deletion(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
- None
### C Prototype
`void obj_mark_for_deletion(struct Object *obj);`
[:arrow_up_small: ](# )
< br / >
## [obj_pitch_to_object](#obj_pitch_to_object)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_pitch_to_object(obj, target)`
2022-03-03 09:04:15 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
| target | [Object ](structs.md#Object ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s16 obj_pitch_to_object(struct Object* obj, struct Object* target);`
[:arrow_up_small: ](# )
< br / >
## [obj_scale](#obj_scale)
### Lua Example
`obj_scale(obj, scale)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| scale | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void obj_scale(struct Object *obj, f32 scale);`
[:arrow_up_small: ](# )
< br / >
## [obj_scale_random](#obj_scale_random)
### Lua Example
`obj_scale_random(obj, rangeLength, minScale)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| rangeLength | `number` |
| minScale | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void obj_scale_random(struct Object *obj, f32 rangeLength, f32 minScale);`
[:arrow_up_small: ](# )
< br / >
## [obj_scale_xyz](#obj_scale_xyz)
### Lua Example
`obj_scale_xyz(obj, xScale, yScale, zScale)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| xScale | `number` |
| yScale | `number` |
| zScale | `number` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void obj_scale_xyz(struct Object *obj, f32 xScale, f32 yScale, f32 zScale);`
[:arrow_up_small: ](# )
< br / >
## [obj_set_angle](#obj_set_angle)
### Lua Example
`obj_set_angle(obj, pitch, yaw, roll)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| pitch | `integer` |
| yaw | `integer` |
| roll | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void obj_set_angle(struct Object *obj, s16 pitch, s16 yaw, s16 roll);`
[:arrow_up_small: ](# )
< br / >
## [obj_set_behavior](#obj_set_behavior)
### Lua Example
`obj_set_behavior(obj, behavior)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| behavior | `Pointer` < `BehaviorScript`> |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void obj_set_behavior(struct Object *obj, const BehaviorScript *behavior);`
[:arrow_up_small: ](# )
< br / >
## [obj_set_billboard](#obj_set_billboard)
### Lua Example
`obj_set_billboard(obj)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_set_billboard(struct Object *obj);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_set_cylboard](#obj_set_cylboard)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_set_cylboard(obj)`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_set_cylboard(struct Object *obj);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_set_face_angle_to_move_angle](#obj_set_face_angle_to_move_angle)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_set_face_angle_to_move_angle(obj)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_set_face_angle_to_move_angle(struct Object *obj);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_set_gfx_pos_at_obj_pos](#obj_set_gfx_pos_at_obj_pos)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_set_gfx_pos_at_obj_pos(obj1, obj2)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj1 | [Object ](structs.md#Object ) |
| obj2 | [Object ](structs.md#Object ) |
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_set_gfx_pos_at_obj_pos(struct Object *obj1, struct Object *obj2);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_set_gfx_pos_from_pos](#obj_set_gfx_pos_from_pos)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_set_gfx_pos_from_pos(obj)`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_set_gfx_pos_from_pos(struct Object *obj);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_set_held_state](#obj_set_held_state)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_set_held_state(obj, heldBehavior)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-03 09:04:15 +00:00
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| heldBehavior | `Pointer` < `BehaviorScript`> |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_set_held_state(struct Object *obj, const BehaviorScript *heldBehavior);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_set_hitbox](#obj_set_hitbox)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_set_hitbox(obj, hitbox)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-03 09:04:15 +00:00
| obj | [Object ](structs.md#Object ) |
| hitbox | [ObjectHitbox ](structs.md#ObjectHitbox ) |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_set_hitbox(struct Object *obj, struct ObjectHitbox *hitbox);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_set_parent_relative_pos](#obj_set_parent_relative_pos)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_set_parent_relative_pos(obj, relX, relY, relZ)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-03 09:04:15 +00:00
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| relX | `integer` |
| relY | `integer` |
| relZ | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_set_parent_relative_pos(struct Object *obj, s16 relX, s16 relY, s16 relZ);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_set_pos](#obj_set_pos)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_set_pos(obj, x, y, z)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| x | `integer` |
| y | `integer` |
| z | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_set_pos(struct Object *obj, s16 x, s16 y, s16 z);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_set_pos_relative](#obj_set_pos_relative)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_set_pos_relative(obj, other, dleft, dy, dforward)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-03 09:04:15 +00:00
| other | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| dleft | `number` |
| dy | `number` |
| dforward | `number` |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_set_pos_relative(struct Object *obj, struct Object *other, f32 dleft, f32 dy, f32 dforward);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_set_throw_matrix_from_transform](#obj_set_throw_matrix_from_transform)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_set_throw_matrix_from_transform(obj)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-03 09:04:15 +00:00
| obj | [Object ](structs.md#Object ) |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_set_throw_matrix_from_transform(struct Object *obj);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_spawn_loot_blue_coins](#obj_spawn_loot_blue_coins)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_spawn_loot_blue_coins(obj, numCoins, sp28, posJitter)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-03 09:04:15 +00:00
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| numCoins | `integer` |
| sp28 | `number` |
| posJitter | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_spawn_loot_blue_coins(struct Object *obj, s32 numCoins, f32 sp28, s16 posJitter);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_spawn_loot_coins](#obj_spawn_loot_coins)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_spawn_loot_coins(obj, numCoins, sp30, coinBehavior, posJitter, model)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-03 09:04:15 +00:00
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| numCoins | `integer` |
| sp30 | `number` |
| coinBehavior | `Pointer` < `BehaviorScript`> |
| posJitter | `integer` |
| model | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_spawn_loot_coins(struct Object *obj, s32 numCoins, f32 sp30, const BehaviorScript *coinBehavior, s16 posJitter, s16 model);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_spawn_loot_yellow_coins](#obj_spawn_loot_yellow_coins)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_spawn_loot_yellow_coins(obj, numCoins, sp28)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-03 09:04:15 +00:00
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| numCoins | `integer` |
| sp28 | `number` |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_spawn_loot_yellow_coins(struct Object *obj, s32 numCoins, f32 sp28);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_translate_local](#obj_translate_local)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_translate_local(obj, posIndex, localTranslateIndex)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-03 09:04:15 +00:00
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| posIndex | `integer` |
| localTranslateIndex | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_translate_local(struct Object *obj, s16 posIndex, s16 localTranslateIndex);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_translate_xyz_random](#obj_translate_xyz_random)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_translate_xyz_random(obj, rangeLength)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| rangeLength | `number` |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_translate_xyz_random(struct Object *obj, f32 rangeLength);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_translate_xz_random](#obj_translate_xz_random)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`obj_translate_xz_random(obj, rangeLength)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| rangeLength | `number` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`void obj_translate_xz_random(struct Object *obj, f32 rangeLength);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [obj_turn_toward_object](#obj_turn_toward_object)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = obj_turn_toward_object(obj, target, angleIndex, turnAmount)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
2022-03-03 09:04:15 +00:00
| target | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| angleIndex | `integer` |
| turnAmount | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
### C Prototype
`s16 obj_turn_toward_object(struct Object *obj, struct Object *target, s16 angleIndex, s16 turnAmount);`
[:arrow_up_small: ](# )
< br / >
## [player_performed_grab_escape_action](#player_performed_grab_escape_action)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = player_performed_grab_escape_action()`
2022-03-03 09:04:15 +00:00
### Parameters
2022-02-23 02:34:51 +00:00
- None
2022-03-03 09:04:15 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-03 09:04:15 +00:00
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 player_performed_grab_escape_action(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [random_f32_around_zero](#random_f32_around_zero)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = random_f32_around_zero(diameter)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| diameter | `number` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`f32 random_f32_around_zero(f32 diameter);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [set_mario_interact_hoot_if_in_range](#set_mario_interact_hoot_if_in_range)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`set_mario_interact_hoot_if_in_range(sp0, sp4, sp8)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| sp0 | `integer` |
| sp4 | `integer` |
| sp8 | `number` |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void set_mario_interact_hoot_if_in_range(UNUSED s32 sp0, UNUSED s32 sp4, f32 sp8);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [set_time_stop_flags](#set_time_stop_flags)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`set_time_stop_flags(flags)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| flags | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void set_time_stop_flags(s32 flags);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-30 04:12:42 +00:00
## [set_time_stop_flags_if_alone](#set_time_stop_flags_if_alone)
### Lua Example
`set_time_stop_flags_if_alone(flags)`
### Parameters
| Field | Type |
| ----- | ---- |
| flags | `integer` |
### Returns
- None
### C Prototype
`void set_time_stop_flags_if_alone(s32 flags);`
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [signum_positive](#signum_positive)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = signum_positive(x)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| x | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`s32 signum_positive(s32 x);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [spawn_base_star_with_no_lvl_exit](#spawn_base_star_with_no_lvl_exit)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`spawn_base_star_with_no_lvl_exit()`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void spawn_base_star_with_no_lvl_exit(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [spawn_mist_particles](#spawn_mist_particles)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`spawn_mist_particles()`
2022-02-23 02:34:51 +00:00
### Parameters
2022-03-03 09:04:15 +00:00
- None
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void spawn_mist_particles(void);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [spawn_mist_particles_with_sound](#spawn_mist_particles_with_sound)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`spawn_mist_particles_with_sound(sp18)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| sp18 | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
- None
### C Prototype
2022-03-03 09:04:15 +00:00
`void spawn_mist_particles_with_sound(u32 sp18);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [spawn_star_with_no_lvl_exit](#spawn_star_with_no_lvl_exit)
2022-02-23 02:34:51 +00:00
### Lua Example
2022-03-03 09:04:15 +00:00
`local ObjectValue = spawn_star_with_no_lvl_exit(sp20, sp24)`
2022-02-23 02:34:51 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| sp20 | `integer` |
| sp24 | `integer` |
2022-02-23 02:34:51 +00:00
### Returns
2022-03-03 09:04:15 +00:00
[Object ](structs.md#Object )
2022-02-23 02:34:51 +00:00
### C Prototype
2022-03-03 09:04:15 +00:00
`struct Object *spawn_star_with_no_lvl_exit(s32 sp20, s32 sp24);`
2022-02-23 02:34:51 +00:00
[:arrow_up_small: ](# )
< br / >
## [spawn_water_droplet](#spawn_water_droplet)
### Lua Example
`local ObjectValue = spawn_water_droplet(parent, params)`
### Parameters
| Field | Type |
| ----- | ---- |
| parent | [Object ](structs.md#Object ) |
| params | [WaterDropletParams ](structs.md#WaterDropletParams ) |
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object *spawn_water_droplet(struct Object *parent, struct WaterDropletParams *params);`
[:arrow_up_small: ](# )
< br / >
2022-03-03 09:04:15 +00:00
## [stub_obj_helpers_3](#stub_obj_helpers_3)
### Lua Example
`stub_obj_helpers_3(sp0, sp4)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| sp0 | `integer` |
| sp4 | `integer` |
2022-03-03 09:04:15 +00:00
### Returns
- None
### C Prototype
`void stub_obj_helpers_3(UNUSED s32 sp0, UNUSED s32 sp4);`
[:arrow_up_small: ](# )
< br / >
## [stub_obj_helpers_4](#stub_obj_helpers_4)
### Lua Example
`stub_obj_helpers_4()`
### Parameters
- None
### Returns
- None
### C Prototype
`void stub_obj_helpers_4(void);`
[:arrow_up_small: ](# )
< br / >
2022-04-07 01:24:50 +00:00
---
# functions from object_list_processor.h
< br / >
## [set_object_respawn_info_bits](#set_object_respawn_info_bits)
### Lua Example
`set_object_respawn_info_bits(obj, bits)`
### Parameters
| Field | Type |
| ----- | ---- |
| obj | [Object ](structs.md#Object ) |
| bits | `integer` |
### Returns
- None
### C Prototype
`void set_object_respawn_info_bits(struct Object *obj, u8 bits);`
[:arrow_up_small: ](# )
< br / >
2022-03-13 08:17:10 +00:00
---
# functions from rumble_init.c
< br / >
## [queue_rumble_data](#queue_rumble_data)
### Lua Example
`queue_rumble_data(a0, a1)`
### Parameters
| Field | Type |
| ----- | ---- |
| a0 | `integer` |
| a1 | `integer` |
### Returns
- None
### C Prototype
`void queue_rumble_data(s16 a0, s16 a1);`
[:arrow_up_small: ](# )
< br / >
## [queue_rumble_data_mario](#queue_rumble_data_mario)
### Lua Example
`queue_rumble_data_mario(m, a0, a1)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
| a0 | `integer` |
| a1 | `integer` |
### Returns
- None
### C Prototype
`void queue_rumble_data_mario(struct MarioState* m, s16 a0, s16 a1);`
[:arrow_up_small: ](# )
< br / >
## [queue_rumble_data_object](#queue_rumble_data_object)
### Lua Example
`queue_rumble_data_object(object, a0, a1)`
### Parameters
| Field | Type |
| ----- | ---- |
| object | [Object ](structs.md#Object ) |
| a0 | `integer` |
| a1 | `integer` |
### Returns
- None
### C Prototype
`void queue_rumble_data_object(struct Object* object, s16 a0, s16 a1);`
[:arrow_up_small: ](# )
< br / >
2022-03-19 07:56:59 +00:00
## [reset_rumble_timers](#reset_rumble_timers)
### Lua Example
`reset_rumble_timers(m)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
### Returns
- None
### C Prototype
`void reset_rumble_timers(struct MarioState* m);`
[:arrow_up_small: ](# )
< br / >
## [reset_rumble_timers_2](#reset_rumble_timers_2)
### Lua Example
`reset_rumble_timers_2(m, a0)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
| a0 | `integer` |
### Returns
- None
### C Prototype
`void reset_rumble_timers_2(struct MarioState* m, s32 a0);`
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
---
# functions from save_file.h
< br / >
2022-03-25 02:30:15 +00:00
## [save_file_clear_flags](#save_file_clear_flags)
### Lua Example
`save_file_clear_flags(flags)`
### Parameters
| Field | Type |
| ----- | ---- |
| flags | `integer` |
### Returns
- None
### C Prototype
`void save_file_clear_flags(u32 flags);`
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [save_file_get_cap_pos](#save_file_get_cap_pos)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = save_file_get_cap_pos(capPos)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-02-05 03:13:15 +00:00
| capPos | [Vec3s ](structs.md#Vec3s ) |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 save_file_get_cap_pos(Vec3s capPos);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [save_file_get_course_coin_score](#save_file_get_course_coin_score)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = save_file_get_course_coin_score(fileIndex, courseIndex)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| fileIndex | `integer` |
| courseIndex | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 save_file_get_course_coin_score(s32 fileIndex, s32 courseIndex);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [save_file_get_course_star_count](#save_file_get_course_star_count)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = save_file_get_course_star_count(fileIndex, courseIndex)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| fileIndex | `integer` |
| courseIndex | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 save_file_get_course_star_count(s32 fileIndex, s32 courseIndex);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [save_file_get_flags](#save_file_get_flags)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = save_file_get_flags()`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 save_file_get_flags(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [save_file_get_max_coin_score](#save_file_get_max_coin_score)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = save_file_get_max_coin_score(courseIndex)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| courseIndex | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 save_file_get_max_coin_score(s32 courseIndex);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [save_file_get_sound_mode](#save_file_get_sound_mode)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = save_file_get_sound_mode()`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u16 save_file_get_sound_mode(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [save_file_get_star_flags](#save_file_get_star_flags)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = save_file_get_star_flags(fileIndex, courseIndex)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| fileIndex | `integer` |
| courseIndex | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`u32 save_file_get_star_flags(s32 fileIndex, s32 courseIndex);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [save_file_get_total_star_count](#save_file_get_total_star_count)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = save_file_get_total_star_count(fileIndex, minCourse, maxCourse)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| fileIndex | `integer` |
| minCourse | `integer` |
| maxCourse | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`s32 save_file_get_total_star_count(s32 fileIndex, s32 minCourse, s32 maxCourse);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-25 02:30:15 +00:00
## [save_file_set_flags](#save_file_set_flags)
### Lua Example
`save_file_set_flags(flags)`
### Parameters
| Field | Type |
| ----- | ---- |
| flags | `integer` |
### Returns
- None
### C Prototype
`void save_file_set_flags(u32 flags);`
[:arrow_up_small: ](# )
< br / >
2022-04-10 16:11:45 +00:00
---
# functions from smlua_audio_utils.h
< br / >
## [smlua_audio_utils_replace_sequence](#smlua_audio_utils_replace_sequence)
### Lua Example
2022-04-10 16:47:17 +00:00
`smlua_audio_utils_replace_sequence(sequenceId, bankId, defaultVolume, m64Name)`
2022-04-10 16:11:45 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| sequenceId | `integer` |
| bankId | `integer` |
2022-04-10 16:47:17 +00:00
| defaultVolume | `integer` |
2022-04-10 16:11:45 +00:00
| m64Name | `string` |
### Returns
- None
### C Prototype
2022-04-10 16:47:17 +00:00
`void smlua_audio_utils_replace_sequence(u8 sequenceId, u8 bankId, u8 defaultVolume, const char* m64Name);`
2022-04-10 16:11:45 +00:00
[:arrow_up_small: ](# )
< br / >
2022-04-10 17:11:13 +00:00
## [smlua_audio_utils_reset_all](#smlua_audio_utils_reset_all)
### Lua Example
`smlua_audio_utils_reset_all()`
### Parameters
- None
### Returns
- None
### C Prototype
`void smlua_audio_utils_reset_all(void);`
[:arrow_up_small: ](# )
< br / >
2022-03-05 22:24:58 +00:00
---
2022-03-10 06:58:45 +00:00
# functions from smlua_collision_utils.h
2022-03-05 22:24:58 +00:00
< br / >
## [collision_find_surface_on_ray](#collision_find_surface_on_ray)
### Lua Example
`local RayIntersectionInfoValue = collision_find_surface_on_ray(startX, startY, startZ, endX, endY, endZ)`
### Parameters
| Field | Type |
| ----- | ---- |
| startX | `number` |
| startY | `number` |
| startZ | `number` |
| endX | `number` |
| endY | `number` |
| endZ | `number` |
### Returns
[RayIntersectionInfo ](structs.md#RayIntersectionInfo )
### C Prototype
`struct RayIntersectionInfo* collision_find_surface_on_ray(f32 startX, f32 startY, f32 startZ, f32 endX, f32 endY, f32 endZ);`
[:arrow_up_small: ](# )
< br / >
2022-03-19 07:56:59 +00:00
## [get_water_surface_pseudo_floor](#get_water_surface_pseudo_floor)
### Lua Example
`local SurfaceValue = get_water_surface_pseudo_floor()`
### Parameters
- None
### Returns
[Surface ](structs.md#Surface )
### C Prototype
`struct Surface* get_water_surface_pseudo_floor(void);`
[:arrow_up_small: ](# )
< br / >
2022-03-28 08:02:33 +00:00
## [smlua_collision_util_get](#smlua_collision_util_get)
### Lua Example
`local PointerValue = smlua_collision_util_get(name)`
### Parameters
| Field | Type |
| ----- | ---- |
| name | `string` |
### Returns
- `Pointer` < `Collision`>
### C Prototype
`Collision* smlua_collision_util_get(const char* name);`
[:arrow_up_small: ](# )
< br / >
2022-03-10 06:58:45 +00:00
---
# functions from smlua_misc_utils.h
< br / >
2022-03-17 08:17:34 +00:00
## [allocate_mario_action](#allocate_mario_action)
### Lua Example
`local integerValue = allocate_mario_action(actFlags)`
### Parameters
| Field | Type |
| ----- | ---- |
| actFlags | `integer` |
### Returns
- `integer`
### C Prototype
`u32 allocate_mario_action(u32 actFlags);`
[:arrow_up_small: ](# )
< br / >
2022-04-07 01:24:50 +00:00
## [deref_s32_pointer](#deref_s32_pointer)
### Lua Example
`local integerValue = deref_s32_pointer(pointer)`
### Parameters
| Field | Type |
| ----- | ---- |
| pointer | `Pointer` < `integer`> |
### Returns
- `integer`
### C Prototype
`s32 deref_s32_pointer(s32* pointer);`
2022-04-10 02:50:50 +00:00
[:arrow_up_small: ](# )
< br / >
2022-04-07 08:17:48 +00:00
## [get_current_save_file_num](#get_current_save_file_num)
### Lua Example
`local integerValue = get_current_save_file_num()`
### Parameters
- None
### Returns
- `integer`
### C Prototype
`s16 get_current_save_file_num(void);`
[:arrow_up_small: ](# )
< br / >
2022-04-05 22:53:16 +00:00
## [get_environment_region](#get_environment_region)
### Lua Example
`local numberValue = get_environment_region(index)`
### Parameters
| Field | Type |
| ----- | ---- |
| index | `integer` |
### Returns
- `number`
### C Prototype
`f32 get_environment_region(u8 index);`
[:arrow_up_small: ](# )
< br / >
2022-03-19 07:56:59 +00:00
## [get_hand_foot_pos_x](#get_hand_foot_pos_x)
### Lua Example
`local numberValue = get_hand_foot_pos_x(m, index)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
| index | `integer` |
### Returns
- `number`
### C Prototype
`f32 get_hand_foot_pos_x(struct MarioState* m, u8 index);`
[:arrow_up_small: ](# )
< br / >
## [get_hand_foot_pos_y](#get_hand_foot_pos_y)
### Lua Example
`local numberValue = get_hand_foot_pos_y(m, index)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
| index | `integer` |
### Returns
- `number`
### C Prototype
`f32 get_hand_foot_pos_y(struct MarioState* m, u8 index);`
[:arrow_up_small: ](# )
< br / >
## [get_hand_foot_pos_z](#get_hand_foot_pos_z)
### Lua Example
`local numberValue = get_hand_foot_pos_z(m, index)`
### Parameters
| Field | Type |
| ----- | ---- |
| m | [MarioState ](structs.md#MarioState ) |
| index | `integer` |
### Returns
- `number`
### C Prototype
`f32 get_hand_foot_pos_z(struct MarioState* m, u8 index);`
[:arrow_up_small: ](# )
< br / >
2022-03-10 03:08:41 +00:00
## [get_network_area_timer](#get_network_area_timer)
### Lua Example
`local integerValue = get_network_area_timer()`
### Parameters
- None
### Returns
- `integer`
### C Prototype
`u32 get_network_area_timer(void);`
[:arrow_up_small: ](# )
< br / >
2022-04-07 01:24:50 +00:00
## [get_temp_s32_pointer](#get_temp_s32_pointer)
### Lua Example
`local PointerValue = get_temp_s32_pointer(initialValue)`
### Parameters
| Field | Type |
| ----- | ---- |
| initialValue | `integer` |
### Returns
- `Pointer` < `integer`>
### C Prototype
`s32* get_temp_s32_pointer(s32 initialValue);`
[:arrow_up_small: ](# )
< br / >
2022-03-11 02:33:52 +00:00
## [hud_hide](#hud_hide)
### Lua Example
`hud_hide()`
### Parameters
- None
### Returns
- None
### C Prototype
`void hud_hide(void);`
[:arrow_up_small: ](# )
< br / >
## [hud_show](#hud_show)
### Lua Example
`hud_show()`
### Parameters
- None
### Returns
- None
### C Prototype
`void hud_show(void);`
[:arrow_up_small: ](# )
< br / >
2022-04-09 08:47:20 +00:00
## [movtexqc_register](#movtexqc_register)
### Lua Example
`movtexqc_register(name, level, area, type)`
### Parameters
| Field | Type |
| ----- | ---- |
| name | `string` |
| level | `integer` |
| area | `integer` |
| type | `integer` |
### Returns
- None
### C Prototype
`void movtexqc_register(const char* name, s16 level, s16 area, s16 type);`
[:arrow_up_small: ](# )
< br / >
2022-04-10 07:30:47 +00:00
## [save_file_set_using_backup_slot](#save_file_set_using_backup_slot)
### Lua Example
`save_file_set_using_backup_slot(usingBackupSlot)`
### Parameters
| Field | Type |
| ----- | ---- |
| usingBackupSlot | `boolean` |
### Returns
- None
### C Prototype
`void save_file_set_using_backup_slot(bool usingBackupSlot);`
[:arrow_up_small: ](# )
< br / >
2022-04-05 22:53:16 +00:00
## [set_environment_region](#set_environment_region)
### Lua Example
`set_environment_region(index, value)`
### Parameters
| Field | Type |
| ----- | ---- |
| index | `integer` |
| value | `integer` |
### Returns
- None
### C Prototype
`void set_environment_region(u8 index, s32 value);`
[:arrow_up_small: ](# )
< br / >
2022-03-12 02:11:32 +00:00
## [warp_exit_level](#warp_exit_level)
### Lua Example
2022-03-13 05:28:57 +00:00
`local booleanValue = warp_exit_level(aDelay)`
2022-03-12 02:11:32 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| aDelay | `integer` |
### Returns
2022-03-13 05:28:57 +00:00
- `boolean`
2022-03-12 02:11:32 +00:00
### C Prototype
`bool warp_exit_level(s32 aDelay);`
[:arrow_up_small: ](# )
< br / >
## [warp_restart_level](#warp_restart_level)
### Lua Example
2022-03-13 05:28:57 +00:00
`local booleanValue = warp_restart_level()`
2022-03-12 02:11:32 +00:00
### Parameters
- None
### Returns
2022-03-13 05:28:57 +00:00
- `boolean`
2022-03-12 02:11:32 +00:00
### C Prototype
`bool warp_restart_level(void);`
[:arrow_up_small: ](# )
< br / >
## [warp_to_castle](#warp_to_castle)
### Lua Example
2022-03-13 05:28:57 +00:00
`local booleanValue = warp_to_castle(aLevel)`
2022-03-12 02:11:32 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| aLevel | `integer` |
### Returns
2022-03-13 05:28:57 +00:00
- `boolean`
2022-03-12 02:11:32 +00:00
### C Prototype
`bool warp_to_castle(s32 aLevel);`
[:arrow_up_small: ](# )
< br / >
## [warp_to_level](#warp_to_level)
### Lua Example
2022-03-13 05:28:57 +00:00
`local booleanValue = warp_to_level(aLevel, aArea, aAct)`
2022-03-12 02:11:32 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| aLevel | `integer` |
| aArea | `integer` |
| aAct | `integer` |
### Returns
2022-03-13 05:28:57 +00:00
- `boolean`
2022-03-12 02:11:32 +00:00
### C Prototype
`bool warp_to_level(s32 aLevel, s32 aArea, s32 aAct);`
[:arrow_up_small: ](# )
< br / >
2022-03-14 07:11:36 +00:00
---
# functions from smlua_model_utils.h
< br / >
## [smlua_model_util_get_id](#smlua_model_util_get_id)
### Lua Example
`local integerValue = smlua_model_util_get_id(name)`
### Parameters
| Field | Type |
| ----- | ---- |
| name | `string` |
### Returns
- `integer`
### C Prototype
`u32 smlua_model_util_get_id(const char* name);`
[:arrow_up_small: ](# )
< br / >
2022-02-22 06:46:39 +00:00
---
# functions from smlua_obj_utils.h
< br / >
2022-03-12 02:18:41 +00:00
## [get_temp_object_hitbox](#get_temp_object_hitbox)
### Lua Example
`local ObjectHitboxValue = get_temp_object_hitbox()`
### Parameters
- None
### Returns
[ObjectHitbox ](structs.md#ObjectHitbox )
### C Prototype
`struct ObjectHitbox* get_temp_object_hitbox(void);`
[:arrow_up_small: ](# )
< br / >
2022-04-09 06:01:41 +00:00
## [get_trajectory](#get_trajectory)
### Lua Example
`local PointerValue = get_trajectory(name)`
### Parameters
| Field | Type |
| ----- | ---- |
| name | `string` |
### Returns
- `Pointer` < `Trajectory`>
### C Prototype
`Trajectory* get_trajectory(const char* name);`
[:arrow_up_small: ](# )
< br / >
2022-03-01 20:06:06 +00:00
## [obj_get_first](#obj_get_first)
2022-02-22 06:46:39 +00:00
### Lua Example
2022-03-01 20:06:06 +00:00
`local ObjectValue = obj_get_first(objList)`
2022-02-22 06:46:39 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| objList | [enum ObjectList ](constants.md#enum-ObjectList ) |
2022-02-22 06:46:39 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
2022-03-01 20:06:06 +00:00
`struct Object *obj_get_first(enum ObjectList objList);`
2022-02-22 06:46:39 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-01 20:06:06 +00:00
## [obj_get_first_with_behavior_id](#obj_get_first_with_behavior_id)
2022-02-28 21:15:37 +00:00
### Lua Example
2022-03-01 20:06:06 +00:00
`local ObjectValue = obj_get_first_with_behavior_id(behaviorId)`
2022-02-28 21:15:37 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behaviorId | [enum BehaviorId ](constants.md#enum-BehaviorId ) |
2022-02-28 21:15:37 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
2022-03-01 20:06:06 +00:00
`struct Object *obj_get_first_with_behavior_id(enum BehaviorId behaviorId);`
2022-02-28 21:15:37 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-01 20:06:06 +00:00
## [obj_get_first_with_behavior_id_and_field_f32](#obj_get_first_with_behavior_id_and_field_f32)
2022-02-28 21:15:37 +00:00
### Lua Example
2022-03-01 20:06:06 +00:00
`local ObjectValue = obj_get_first_with_behavior_id_and_field_f32(behaviorId, fieldIndex, value)`
2022-02-28 21:15:37 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behaviorId | [enum BehaviorId ](constants.md#enum-BehaviorId ) |
| fieldIndex | `integer` |
| value | `number` |
2022-02-28 21:15:37 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
2022-03-01 20:06:06 +00:00
`struct Object *obj_get_first_with_behavior_id_and_field_f32(enum BehaviorId behaviorId, s32 fieldIndex, f32 value);`
2022-02-28 21:15:37 +00:00
[:arrow_up_small: ](# )
< br / >
## [obj_get_first_with_behavior_id_and_field_s32](#obj_get_first_with_behavior_id_and_field_s32)
### Lua Example
2022-03-01 20:06:06 +00:00
`local ObjectValue = obj_get_first_with_behavior_id_and_field_s32(behaviorId, fieldIndex, value)`
2022-02-28 21:15:37 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behaviorId | [enum BehaviorId ](constants.md#enum-BehaviorId ) |
| fieldIndex | `integer` |
| value | `integer` |
2022-02-28 21:15:37 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object *obj_get_first_with_behavior_id_and_field_s32(enum BehaviorId behaviorId, s32 fieldIndex, s32 value);`
[:arrow_up_small: ](# )
< br / >
2022-03-01 20:06:06 +00:00
## [obj_get_next](#obj_get_next)
2022-02-28 21:15:37 +00:00
### Lua Example
2022-03-01 20:06:06 +00:00
`local ObjectValue = obj_get_next(o)`
2022-02-28 21:15:37 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-01 20:06:06 +00:00
| o | [Object ](structs.md#Object ) |
2022-02-28 21:15:37 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
2022-03-01 20:06:06 +00:00
`struct Object *obj_get_next(struct Object *o);`
2022-02-28 21:15:37 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-01 20:06:06 +00:00
## [obj_get_next_with_same_behavior_id](#obj_get_next_with_same_behavior_id)
2022-02-28 21:15:37 +00:00
### Lua Example
2022-03-01 20:06:06 +00:00
`local ObjectValue = obj_get_next_with_same_behavior_id(o)`
2022-02-28 21:15:37 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-01 20:06:06 +00:00
| o | [Object ](structs.md#Object ) |
2022-02-28 21:15:37 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
2022-03-01 20:06:06 +00:00
`struct Object *obj_get_next_with_same_behavior_id(struct Object *o);`
2022-02-28 21:15:37 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-01 20:06:06 +00:00
## [obj_get_next_with_same_behavior_id_and_field_f32](#obj_get_next_with_same_behavior_id_and_field_f32)
2022-02-28 21:15:37 +00:00
### Lua Example
2022-03-01 20:06:06 +00:00
`local ObjectValue = obj_get_next_with_same_behavior_id_and_field_f32(o, fieldIndex, value)`
2022-02-28 21:15:37 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-01 20:06:06 +00:00
| o | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| fieldIndex | `integer` |
| value | `number` |
2022-02-28 21:15:37 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
2022-03-01 20:06:06 +00:00
`struct Object *obj_get_next_with_same_behavior_id_and_field_f32(struct Object *o, s32 fieldIndex, f32 value);`
2022-02-28 21:15:37 +00:00
[:arrow_up_small: ](# )
< br / >
## [obj_get_next_with_same_behavior_id_and_field_s32](#obj_get_next_with_same_behavior_id_and_field_s32)
### Lua Example
2022-03-01 20:06:06 +00:00
`local ObjectValue = obj_get_next_with_same_behavior_id_and_field_s32(o, fieldIndex, value)`
2022-02-28 21:15:37 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-01 20:06:06 +00:00
| o | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| fieldIndex | `integer` |
| value | `integer` |
2022-02-28 21:15:37 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object *obj_get_next_with_same_behavior_id_and_field_s32(struct Object *o, s32 fieldIndex, s32 value);`
[:arrow_up_small: ](# )
< br / >
2022-03-10 02:59:55 +00:00
## [obj_get_temp_spawn_particles_info](#obj_get_temp_spawn_particles_info)
### Lua Example
`local SpawnParticlesInfoValue = obj_get_temp_spawn_particles_info(modelId)`
### Parameters
| Field | Type |
| ----- | ---- |
| modelId | [enum ModelExtendedId ](constants.md#enum-ModelExtendedId ) |
### Returns
[SpawnParticlesInfo ](structs.md#SpawnParticlesInfo )
### C Prototype
`struct SpawnParticlesInfo* obj_get_temp_spawn_particles_info(enum ModelExtendedId modelId);`
[:arrow_up_small: ](# )
< br / >
2022-03-05 22:39:55 +00:00
## [obj_has_behavior_id](#obj_has_behavior_id)
### Lua Example
`local integerValue = obj_has_behavior_id(o, behaviorId)`
### Parameters
| Field | Type |
| ----- | ---- |
| o | [Object ](structs.md#Object ) |
| behaviorId | [enum BehaviorId ](constants.md#enum-BehaviorId ) |
### Returns
- `integer`
### C Prototype
`s32 obj_has_behavior_id(struct Object *o, enum BehaviorId behaviorId);`
[:arrow_up_small: ](# )
< br / >
## [obj_has_model_extended](#obj_has_model_extended)
### Lua Example
`local integerValue = obj_has_model_extended(o, modelId)`
### Parameters
| Field | Type |
| ----- | ---- |
| o | [Object ](structs.md#Object ) |
| modelId | [enum ModelExtendedId ](constants.md#enum-ModelExtendedId ) |
### Returns
- `integer`
### C Prototype
`s32 obj_has_model_extended(struct Object *o, enum ModelExtendedId modelId);`
[:arrow_up_small: ](# )
< br / >
2022-03-04 00:46:01 +00:00
## [obj_set_model_extended](#obj_set_model_extended)
### Lua Example
`obj_set_model_extended(o, modelId)`
### Parameters
| Field | Type |
| ----- | ---- |
| o | [Object ](structs.md#Object ) |
2022-03-05 06:22:31 +00:00
| modelId | [enum ModelExtendedId ](constants.md#enum-ModelExtendedId ) |
2022-03-04 00:46:01 +00:00
### Returns
- None
### C Prototype
`void obj_set_model_extended(struct Object *o, enum ModelExtendedId modelId);`
[:arrow_up_small: ](# )
< br / >
2022-03-10 04:11:45 +00:00
## [spawn_non_sync_object](#spawn_non_sync_object)
### Lua Example
`local ObjectValue = spawn_non_sync_object(behaviorId, modelId, x, y, z, objSetupFunction)`
### Parameters
| Field | Type |
| ----- | ---- |
| behaviorId | [enum BehaviorId ](constants.md#enum-BehaviorId ) |
| modelId | [enum ModelExtendedId ](constants.md#enum-ModelExtendedId ) |
| x | `number` |
| y | `number` |
| z | `number` |
| objSetupFunction | `Lua Function` () |
### Returns
[Object ](structs.md#Object )
### C Prototype
`struct Object* spawn_non_sync_object(enum BehaviorId behaviorId, enum ModelExtendedId modelId, f32 x, f32 y, f32 z, LuaFunction objSetupFunction);`
[:arrow_up_small: ](# )
< br / >
2022-03-01 20:06:06 +00:00
## [spawn_sync_object](#spawn_sync_object)
2022-02-28 21:15:37 +00:00
### Lua Example
2022-03-01 20:06:06 +00:00
`local ObjectValue = spawn_sync_object(behaviorId, modelId, x, y, z, objSetupFunction)`
2022-02-28 21:15:37 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| behaviorId | [enum BehaviorId ](constants.md#enum-BehaviorId ) |
| modelId | [enum ModelExtendedId ](constants.md#enum-ModelExtendedId ) |
| x | `number` |
| y | `number` |
| z | `number` |
| objSetupFunction | `Lua Function` () |
2022-02-28 21:15:37 +00:00
### Returns
[Object ](structs.md#Object )
### C Prototype
2022-03-01 20:06:06 +00:00
`struct Object* spawn_sync_object(enum BehaviorId behaviorId, enum ModelExtendedId modelId, f32 x, f32 y, f32 z, LuaFunction objSetupFunction);`
2022-02-28 21:15:37 +00:00
[:arrow_up_small: ](# )
< br / >
2022-04-10 06:28:36 +00:00
---
# functions from smlua_text_utils.h
< br / >
## [smlua_text_utils_castle_secret_stars_replace](#smlua_text_utils_castle_secret_stars_replace)
### Lua Example
`smlua_text_utils_castle_secret_stars_replace(name)`
### Parameters
| Field | Type |
| ----- | ---- |
| name | `string` |
### Returns
- None
### C Prototype
`void smlua_text_utils_castle_secret_stars_replace(const char* name);`
[:arrow_up_small: ](# )
< br / >
## [smlua_text_utils_course_acts_replace](#smlua_text_utils_course_acts_replace)
### Lua Example
`smlua_text_utils_course_acts_replace(courseNum, courseName, act1, act2, act3, act4, act5, act6)`
### Parameters
| Field | Type |
| ----- | ---- |
| courseNum | `integer` |
| courseName | `string` |
| act1 | `string` |
| act2 | `string` |
| act3 | `string` |
| act4 | `string` |
| act5 | `string` |
| act6 | `string` |
### Returns
- None
### C Prototype
`void smlua_text_utils_course_acts_replace(s16 courseNum, const char* courseName, const char* act1, const char* act2, const char* act3, const char* act4, const char* act5, const char* act6);`
[:arrow_up_small: ](# )
< br / >
## [smlua_text_utils_dialog_replace](#smlua_text_utils_dialog_replace)
### Lua Example
`smlua_text_utils_dialog_replace(dialogId, unused, linesPerBox, leftOffset, width, str)`
### Parameters
| Field | Type |
| ----- | ---- |
| dialogId | [enum DialogId ](constants.md#enum-DialogId ) |
| unused | `integer` |
| linesPerBox | `integer` |
| leftOffset | `integer` |
| width | `integer` |
| str | `string` |
### Returns
- None
### C Prototype
`void smlua_text_utils_dialog_replace(enum DialogId dialogId, u32 unused, s8 linesPerBox, s16 leftOffset, s16 width, const char* str);`
[:arrow_up_small: ](# )
< br / >
## [smlua_text_utils_extra_text_replace](#smlua_text_utils_extra_text_replace)
### Lua Example
`smlua_text_utils_extra_text_replace(index, text)`
### Parameters
| Field | Type |
| ----- | ---- |
| index | `integer` |
| text | `string` |
### Returns
- None
### C Prototype
`void smlua_text_utils_extra_text_replace(s16 index, const char* text);`
[:arrow_up_small: ](# )
< br / >
## [smlua_text_utils_reset_all](#smlua_text_utils_reset_all)
### Lua Example
`smlua_text_utils_reset_all()`
### Parameters
- None
### Returns
- None
### C Prototype
`void smlua_text_utils_reset_all(void);`
[:arrow_up_small: ](# )
< br / >
## [smlua_text_utils_secret_star_replace](#smlua_text_utils_secret_star_replace)
### Lua Example
`smlua_text_utils_secret_star_replace(courseNum, courseName)`
### Parameters
| Field | Type |
| ----- | ---- |
| courseNum | `integer` |
| courseName | `string` |
### Returns
- None
### C Prototype
`void smlua_text_utils_secret_star_replace(s16 courseNum, const char* courseName);`
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
---
# functions from sound_init.h
< br / >
## [disable_background_sound](#disable_background_sound)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`disable_background_sound()`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void disable_background_sound(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [enable_background_sound](#enable_background_sound)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`enable_background_sound()`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void enable_background_sound(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [fadeout_cap_music](#fadeout_cap_music)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`fadeout_cap_music()`
2022-01-30 06:47:22 +00:00
### Parameters
- None
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void fadeout_cap_music(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [fadeout_level_music](#fadeout_level_music)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`fadeout_level_music(fadeTimer)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| fadeTimer | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void fadeout_level_music(s16 fadeTimer);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [fadeout_music](#fadeout_music)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`fadeout_music(fadeOutTime)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| fadeOutTime | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void fadeout_music(s16 fadeOutTime);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [lower_background_noise](#lower_background_noise)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`lower_background_noise(a)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| a | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void lower_background_noise(s32 a);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_cap_music](#play_cap_music)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_cap_music(seqArgs)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| seqArgs | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_cap_music(u16 seqArgs);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_cutscene_music](#play_cutscene_music)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_cutscene_music(seqArgs)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| seqArgs | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_cutscene_music(u16 seqArgs);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_infinite_stairs_music](#play_infinite_stairs_music)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_infinite_stairs_music()`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_infinite_stairs_music(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_menu_sounds](#play_menu_sounds)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_menu_sounds(soundMenuFlags)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| soundMenuFlags | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_menu_sounds(s16 soundMenuFlags);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_painting_eject_sound](#play_painting_eject_sound)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_painting_eject_sound()`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_painting_eject_sound(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [play_shell_music](#play_shell_music)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`play_shell_music()`
2022-01-30 06:47:22 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-01-30 06:47:22 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void play_shell_music(void);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [raise_background_noise](#raise_background_noise)
2022-01-30 06:47:22 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`raise_background_noise(a)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| a | `integer` |
2022-01-30 06:47:22 +00:00
### Returns
- None
### C Prototype
2022-02-05 03:13:15 +00:00
`void raise_background_noise(s32 a);`
2022-01-30 06:47:22 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [reset_volume](#reset_volume)
2022-02-04 03:05:59 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`reset_volume()`
2022-02-04 03:05:59 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-02-04 03:05:59 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-02-04 03:05:59 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void reset_volume(void);`
2022-02-04 03:05:59 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [set_background_music](#set_background_music)
2022-02-03 04:24:35 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`set_background_music(a, seqArgs, fadeTimer)`
2022-02-03 04:24:35 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| a | `integer` |
| seqArgs | `integer` |
| fadeTimer | `integer` |
2022-02-03 04:24:35 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-02-03 04:24:35 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void set_background_music(u16 a, u16 seqArgs, s16 fadeTimer);`
2022-02-03 04:24:35 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [stop_cap_music](#stop_cap_music)
2022-02-03 04:24:35 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`stop_cap_music()`
2022-02-03 04:24:35 +00:00
### Parameters
- None
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-02-03 04:24:35 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void stop_cap_music(void);`
2022-02-03 04:24:35 +00:00
[:arrow_up_small: ](# )
< br / >
2022-02-05 03:13:15 +00:00
## [stop_shell_music](#stop_shell_music)
2022-02-03 04:24:35 +00:00
### Lua Example
2022-02-05 03:13:15 +00:00
`stop_shell_music()`
2022-02-03 04:24:35 +00:00
### Parameters
2022-02-05 03:13:15 +00:00
- None
2022-02-03 04:24:35 +00:00
### Returns
2022-02-05 03:13:15 +00:00
- None
2022-02-03 04:24:35 +00:00
### C Prototype
2022-02-05 03:13:15 +00:00
`void stop_shell_music(void);`
2022-02-03 04:24:35 +00:00
[:arrow_up_small: ](# )
< br / >
2022-03-05 04:03:00 +00:00
---
# functions from spawn_sound.c
< br / >
## [calc_dist_to_volume_range_1](#calc_dist_to_volume_range_1)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = calc_dist_to_volume_range_1(distance)`
2022-03-05 04:03:00 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| distance | `number` |
2022-03-05 04:03:00 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-05 04:03:00 +00:00
### C Prototype
`s32 calc_dist_to_volume_range_1(f32 distance);`
[:arrow_up_small: ](# )
< br / >
## [calc_dist_to_volume_range_2](#calc_dist_to_volume_range_2)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = calc_dist_to_volume_range_2(distance)`
2022-03-05 04:03:00 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| distance | `number` |
2022-03-05 04:03:00 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-03-05 04:03:00 +00:00
### C Prototype
`s32 calc_dist_to_volume_range_2(f32 distance);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_play_sound_1](#cur_obj_play_sound_1)
### Lua Example
`cur_obj_play_sound_1(soundMagic)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| soundMagic | `integer` |
2022-03-05 04:03:00 +00:00
### Returns
- None
### C Prototype
`void cur_obj_play_sound_1(s32 soundMagic);`
[:arrow_up_small: ](# )
< br / >
## [cur_obj_play_sound_2](#cur_obj_play_sound_2)
### Lua Example
`cur_obj_play_sound_2(soundMagic)`
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| soundMagic | `integer` |
2022-03-05 04:03:00 +00:00
### Returns
- None
### C Prototype
`void cur_obj_play_sound_2(s32 soundMagic);`
[:arrow_up_small: ](# )
< br / >
## [exec_anim_sound_state](#exec_anim_sound_state)
### Lua Example
`exec_anim_sound_state(soundStates)`
### Parameters
| Field | Type |
| ----- | ---- |
| soundStates | [SoundState ](structs.md#SoundState ) |
### Returns
- None
### C Prototype
`void exec_anim_sound_state(struct SoundState *soundStates);`
[:arrow_up_small: ](# )
< br / >
2022-01-30 06:47:22 +00:00
---
# functions from surface_collision.h
< br / >
2022-03-04 00:46:01 +00:00
## [find_ceil_height](#find_ceil_height)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = find_ceil_height(x, y, z)`
2022-03-04 00:46:01 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| x | `number` |
| y | `number` |
| z | `number` |
2022-03-04 00:46:01 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-03-04 00:46:01 +00:00
### C Prototype
`f32 find_ceil_height(f32 x, f32 y, f32 z);`
[:arrow_up_small: ](# )
< br / >
2022-01-30 06:47:22 +00:00
## [find_floor_height](#find_floor_height)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = find_floor_height(x, y, z)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| x | `number` |
| y | `number` |
| z | `number` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-01-30 06:47:22 +00:00
### C Prototype
`f32 find_floor_height(f32 x, f32 y, f32 z);`
[:arrow_up_small: ](# )
< br / >
## [find_poison_gas_level](#find_poison_gas_level)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = find_poison_gas_level(x, z)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| x | `number` |
| z | `number` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-01-30 06:47:22 +00:00
### C Prototype
`f32 find_poison_gas_level(f32 x, f32 z);`
[:arrow_up_small: ](# )
< br / >
## [find_wall_collisions](#find_wall_collisions)
### Lua Example
2022-03-05 06:38:43 +00:00
`local integerValue = find_wall_collisions(colData)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
| colData | [WallCollisionData ](structs.md#WallCollisionData ) |
### Returns
2022-03-05 06:22:31 +00:00
- `integer`
2022-01-30 06:47:22 +00:00
### C Prototype
`s32 find_wall_collisions(struct WallCollisionData *colData);`
[:arrow_up_small: ](# )
< br / >
## [find_water_level](#find_water_level)
### Lua Example
2022-03-05 06:38:43 +00:00
`local numberValue = find_water_level(x, z)`
2022-01-30 06:47:22 +00:00
### Parameters
| Field | Type |
| ----- | ---- |
2022-03-05 06:22:31 +00:00
| x | `number` |
| z | `number` |
2022-01-30 06:47:22 +00:00
### Returns
2022-03-05 06:22:31 +00:00
- `number`
2022-01-30 06:47:22 +00:00
### C Prototype
`f32 find_water_level(f32 x, f32 z);`
[:arrow_up_small: ](# )
< br / >
2022-03-10 06:58:45 +00:00
---
# functions from surface_load.h
< br / >
## [alloc_surface_pools](#alloc_surface_pools)
### Lua Example
`alloc_surface_pools()`
### Parameters
- None
### Returns
- None
### C Prototype
`void alloc_surface_pools(void);`
[:arrow_up_small: ](# )
< br / >
## [clear_dynamic_surfaces](#clear_dynamic_surfaces)
### Lua Example
`clear_dynamic_surfaces()`
### Parameters
- None
### Returns
- None
### C Prototype
`void clear_dynamic_surfaces(void);`
[:arrow_up_small: ](# )
< br / >
## [get_area_terrain_size](#get_area_terrain_size)
### Lua Example
`local integerValue = get_area_terrain_size(data)`
### Parameters
| Field | Type |
| ----- | ---- |
| data | `Pointer` < `integer`> |
### Returns
- `integer`
### C Prototype
`u32 get_area_terrain_size(s16 *data);`
[:arrow_up_small: ](# )
< br / >
## [load_area_terrain](#load_area_terrain)
### Lua Example
`load_area_terrain(index, data, surfaceRooms, macroObjects)`
### Parameters
| Field | Type |
| ----- | ---- |
| index | `integer` |
| data | `Pointer` < `integer`> |
| surfaceRooms | `Pointer` < `integer`> |
| macroObjects | `Pointer` < `integer`> |
### Returns
- None
### C Prototype
`void load_area_terrain(s16 index, s16 *data, s8 *surfaceRooms, s16 *macroObjects);`
[:arrow_up_small: ](# )
< br / >
## [load_object_collision_model](#load_object_collision_model)
### Lua Example
`load_object_collision_model()`
### Parameters
- None
### Returns
- None
### C Prototype
`void load_object_collision_model(void);`
[:arrow_up_small: ](# )
< br / >
