Mission Pinball Framework v0.55+ User Documentation
latest

Overview

  • Start Here
  • Compatible Pinball Machines

Installation & First Steps

  • Installing MPF
  • Running MPF
  • Tutorial

MPF User Manual

  • Control Systems / Hardware
  • Pinball Mechanisms
  • Game Logic
  • Game Design
  • Displays & Graphics
  • Sound
  • Shows
  • Assets
  • Config Players
  • Machine Management
  • Tools
  • Testing Your Machine
  • Finalizing Your Machine
  • Flowcharts
  • Troubleshooting

Building Machines

  • Physically Building Pinball Machines

Examples

  • Example Config Files
  • Example Games
  • Cookbook

Reference

  • Config File Reference
  • Events Reference
    • Events Overview
    • Conditional Events
    • Handler Priorities
    • Types of events
    • achievement_(name)_changed_state
    • achievement_(name)_state_(state)
    • asset_loading_complete
    • ball_drain
    • ball_ended
    • ball_ending
    • ball_hold_(name)_balls_released
    • ball_hold_(name)_full
    • ball_hold_(name)_held_ball
    • ball_save_(name)_disabled
    • ball_save_(name)_enabled
    • ball_save_(name)_grace_period
    • ball_save_(name)_hurry_up
    • ball_save_(name)_saving_ball
    • ball_save_(name)_timer_start
    • ball_search_failed
    • ball_search_phase_(num)
    • ball_search_prevents_game_start
    • ball_search_started
    • ball_search_stopped
    • ball_start_target
    • ball_started
    • ball_starting
    • ball_will_end
    • ball_will_start
    • balldevice_(name)_ball_count_changed
    • balldevice_(name)_ball_eject_attempt
    • balldevice_(name)_ball_eject_failed
    • balldevice_(name)_ball_eject_success
    • balldevice_(name)_ball_enter
    • balldevice_(name)_ball_entered
    • balldevice_(name)_ball_missing
    • balldevice_(name)_broken
    • balldevice_(name)_ejecting_ball
    • balldevice_ball_missing
    • balldevice_balls_available
    • balldevice_captured_from_(captures_from)
    • balls_in_play
    • bcp_clients_connected
    • bcp_connection_attempt
    • bonus_multiplier
    • bonus_start
    • bonus_subtotal
    • cancel_ball_search
    • clear
    • client_connected
    • client_disconnected
    • collecting_balls
    • collecting_balls_complete
    • (name)_both
    • (name)_inactive
    • (name)_one
    • (name)_switches_1
    • (name)_switches_2
    • credits_added
    • display_(name)_initialized
    • display_(name)_ready
    • displays_initialized
    • diverter_(name)_activating
    • diverter_(name)_deactivating
    • diverter_(name)_disabling
    • diverter_(name)_enabling
    • drop_target_bank_(name)_down
    • drop_target_bank_(name)_mixed
    • drop_target_bank_(name)_up
    • drop_target_(name)_down
    • drop_target_(name)_up
    • enabling_credit_play
    • enabling_free_play
    • extra_ball_award_disabled
    • extra_ball_awarded
    • extra_ball_(name)_award_disabled
    • extra_ball_(name)_awarded
    • extra_ball_(name)_lit
    • extra_ball_group_(name)_award_disabled
    • extra_ball_group_(name)_awarded
    • extra_ball_group_(name)_lit
    • extra_ball_group_(name)_lit_awarded
    • extra_ball_group_(name)_unlit
    • flipper_cancel
    • flipper_cradle
    • flipper_cradle_release
    • game_ended
    • game_ending
    • game_start
    • game_started
    • game_starting
    • game_will_end
    • game_will_start
    • init_done
    • init_phase_1
    • init_phase_2
    • init_phase_3
    • init_phase_4
    • init_phase_5
    • kickback_(name)_fired
    • loading_assets
    • logicblock_(name)_complete
    • logicblock_(name)_hit
    • logicblock_(name)_updated
    • machine_reset_phase_1
    • machine_reset_phase_2
    • machine_reset_phase_3
    • machine_var_(name)
    • magnet_(name)_flinged_ball
    • magnet_(name)_flinging_ball
    • magnet_(name)_grabbed_ball
    • magnet_(name)_grabbing_ball
    • magnet_(name)_released_ball
    • magnet_(name)_releasing_ball
    • master_volume_decrease
    • master_volume_increase
    • match_has_match
    • match_no_match
    • max_credits_reached
    • mc_ready
    • mc_reset_complete
    • mc_reset_phase_1
    • mc_reset_phase_2
    • mc_reset_phase_3
    • mode_(name)_started
    • mode_(name)_starting
    • mode_(name)_stopped
    • mode_(name)_stopping
    • mode_(name)_will_start
    • mode_(name)_will_stop
    • motor_(name)_reached_(position)
    • multi_player_ball_started
    • multiball_lock_(name)_full
    • multiball_lock_(name)_locked_ball
    • multiball_(name)_ended
    • multiball_(name)_lost_ball
    • multiball_(name)_shoot_again
    • multiball_(name)_shoot_again_ended
    • multiball_(name)_started
    • multiplayer_game
    • (name)_timeout
    • not_enough_credits
    • player_add_request
    • player_added
    • player_adding
    • player_(name)
    • player_turn_ended
    • player_turn_ending
    • player_turn_started
    • player_turn_starting
    • player_turn_will_end
    • player_turn_will_start
    • player_will_add
    • (name)_active
    • (name)_ball_count_change
    • playfield_transfer_(playfield_transfer)_ball_transferred
    • reel_(name)_advance
    • request_to_start_game
    • reset_complete
    • (name)_hit
    • (name)_complete
    • (name)_hit
    • (name)_(state)_complete
    • (name)_(state)_hit
    • (name)_hit
    • (name)_(profile)_hit
    • (name)_(profile)_(state)_hit
    • (name)_(state)_hit
    • shutdown
    • single_player_ball_started
    • slam_tilt
    • slide_(name)_active
    • slide_(name)_created
    • slide_(name)_removed
    • spinner_(name)_active
    • spinner_(name)_hit
    • spinner_(name)_idle
    • spinner_(name)_inactive
    • spinner_(name)_(label)_active
    • spinner_(name)_(label)_hit
    • sw_(name)_active
    • sw_(tag)
    • sw_(tag)_active
    • sw_(tag)_inactive
    • (name)_active
    • (name)_inactive
    • switch_(name)_active
    • switch_(name)_inactive
    • text_input_(key)_abort
    • text_input_(key)_complete
    • tilt
    • tilt_clear
    • tilt_warning
    • tilt_warning_(number)
    • (name)_active
    • (name)_released
    • timer_(name)_complete
    • timer_(name)_paused
    • timer_(name)_started
    • timer_(name)_stopped
    • timer_(name)_tick
    • timer_(name)_time_added
    • timer_(name)_time_subtracted
    • twitch_bit_donation
    • twitch_chat_message
    • twitch_command
    • twitch_raid
    • twitch_subscription
    • unexpected_ball_on_(name)
    • achievement
    • ball_device
    • ball_hold
    • ball_save
    • combo_switch
    • display
    • diverter
    • drop_target_bank
    • drop_target
    • extra_ball_group
    • extra_ball
    • kickback
    • machine_var
    • magnet
    • motor
    • multiball_lock
    • multiball
    • player_var
    • playfield_transfer
    • playfield
    • score_reel
    • sequence_shot
    • shot_group
    • shot
    • slide
    • spinner
    • switch
    • timed_switch
    • timer
  • Game Variable Reference
  • Machine Variable Reference
  • Player Variable Reference
  • Log Reference

Developer Documentation

  • Overview

About MPF

  • About this Documentation
  • FAQ
  • Glossary
  • Contributing to MPF
  • Contributing to MPF docs
  • MPF Versions
Mission Pinball Framework v0.55+ User Documentation
  • Docs »
  • Events »
  • cancel_ball_search
  • Edit on GitHub

cancel_ball_searchΒΆ

MPF Event

This event will cancel all running ball searches and mark the balls as lost. This is only a handler so all you have to do is to post the event.

This event does not have any keyword arguments

Next Previous

© Copyright 2013-2022, The Mission Pinball Framework Team Revision 513058c5.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
0.54
0.53
0.52
0.51
0.50
0.33
dev
Downloads
pdf
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.