Abstract base class for the game's main loop.
[MainLoop] is the abstract base class for a Godot project's game loop. It is inherited by [SceneTree], which is the default game loop implementation used in Godot projects, though it is also possible to write and use one's own [MainLoop] subclass instead of the scene tree. Upon the application start, a [MainLoop] implementation must be provided to the OS; otherwise, the application will exit. This happens automatically (and a [SceneTree] is created) unless a main [Script] is provided from the command line (with e.g. [code]godot -s my_loop.gd[/code], which should then be a [MainLoop] implementation. Here is an example script implementing a simple [MainLoop]: [b]FIXME:[/b] No longer valid after DisplayServer split and Input refactoring. [codeblock] extends MainLoop

var time_elapsed = 0 var keys_typed = [] var quit = false

func _initialize(): print("Initialized:") print(" Starting time: %s" % str(time_elapsed))

func _idle(delta): time_elapsed += delta # Return true to end the main loop. return quit

func _input_event(event): # Record keys. if event is InputEventKey and event.pressed and !event.echo: keys_typed.append(OS.get_keycode_string(event.keycode)) # Quit on Escape press. if event.keycode == KEY_ESCAPE: quit = true # Quit on any mouse click. if event is InputEventMouseButton: quit = true

func _finalize(): print("Finalized:") print(" End time: %s" % str(time_elapsed)) print(" Keys typed: %s" % var2str(keys_typed)) [/codeblock]
Called before the program exits.
Called each idle frame with the time since the last idle frame as argument (in seconds). Equivalent to [method Node._process]. If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame.
Called once during initialization.
Called each physics frame with the time since the last physics frame as argument (in seconds). Equivalent to [method Node._physics_process]. If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame.
Should not be called manually, override [method _finalize] instead. Will be removed in Godot 4.0.
Should not be called manually, override [method _idle] instead. Will be removed in Godot 4.0.
Should not be called manually, override [method _initialize] instead. Will be removed in Godot 4.0.
Should not be called manually, override [method _iteration] instead. Will be removed in Godot 4.0.
Emitted when a user responds to a permission request.
Notification received from the OS when the application is exceeding its allocated memory. Specific to the iOS platform.
Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like [method Object.tr].
Notification received from the OS when a request for "About" information is sent. Specific to the macOS platform.
Notification received from Godot's crash handler when the engine is about to crash. Implemented on desktop platforms if the crash handler is enabled.
Notification received from the OS when an update of the Input Method Engine occurs (e.g. change of IME cursor position or composition string). Specific to the macOS platform.
Notification received from the OS when the app is resumed. Specific to the Android platform.
Notification received from the OS when the app is paused. Specific to the Android platform.