Common engine methods and macros

Godot’s C++ codebase makes use of dozens of custom methods and macros which are used in almost every file. This page is geared towards beginner contributors, but it can also be useful for those writing custom C++ modules.

Print text

  1. // Prints a message to standard output.
  2. print_line("Message");
  4. // Prints a message to standard output, but only when the engine
  5. // is started with the `--verbose` command line argument.
  6. print_verbose("Message");
  8. // Prints a formatted error or warning message with a trace.
  9. ERR_PRINT("Message");
  10. WARN_PRINT("Message");
  12. // Prints an error or warning message only once per session.
  13. // This can be used to avoid spamming the console output.
  14. ERR_PRINT_ONCE("Message");
  15. WARN_PRINT_ONCE("Message");

If you need to add placeholders in your messages, use format strings as described below.

Format a string

The vformat() function returns a formatted String. It behaves in a way similar to C’s sprintf():

  1. vformat("My name is %s.", "Godette");
  2. vformat("%d bugs on the wall!", 1234);
  3. vformat("Pi is approximately %f.", 3.1416);
  5. // Converts the resulting String into a `const char *`.
  6. // You may need to do this if passing the result as an argument
  7. // to a method that expects a `const char *` instead of a String.
  8. vformat("My name is %s.", "Godette").c_str();

In most cases, try to use vformat() instead of string concatenation as it makes for more readable code.

Convert an integer or float to a string

This is mainly useful when printing numbers directly.

  1. // Prints "42" using integer-to-string conversion.
  2. print_line(itos(42));
  4. // Prints "123.45" using real-to-string conversion.
  5. print_line(rtos(123.45));

Internationalize a string

There are two types of internationalization in Godot’s codebase:

  • TTR(): Editor (“tools”) translations will only be processed in the editor. If a user uses the same text in one of their projects, it won’t be translated if they provide a translation for it. When contributing to the engine, this is generally the macro you should use for localizable strings.

  • RTR(): Run-time translations will be automatically localized in projects if they provide a translation for the given string. This kind of translation shouldn’t be used in editor-only code.

  1. // Returns the translated string that matches the user's locale settings.
  2. // Translations are located in `editor/translations`.
  3. // The localization template is generated automatically; don't modify it.
  4. TTR("Exit the editor?");

To insert placeholders in localizable strings, wrap the localization macro in a vformat() call as follows:

  1. String file_path = "example.txt";
  2. vformat(TTR("Couldn't open \"%s\" for reading."), file_path);

Note

When using vformat() and a translation macro together, always wrap the translation macro in vformat(), not the other way around. Otherwise, the string will never match the translation as it will have the placeholder already replaced when it’s passed to TranslationServer.

Clamp a value

Godot provides macros for clamping a value with a lower bound (MAX), an upper bound (MIN) or both (CLAMP):

  1. int a = 3;
  2. int b = 5;
  4. MAX(b, 6); // 6
  5. MIN(2, a); // 2
  6. CLAMP(a, 10, 30); // 10

This works with any type that can be compared to other values (like int and float).

Microbenchmarking

If you want to benchmark a piece of code but don’t know how to use a profiler, use this snippet:

  1. uint64_t begin = OS::get_singleton()->get_ticks_usec();
  3. // Your code here...
  5. uint64_t end = OS::get_singleton()->get_ticks_usec();
  6. print_line(vformat("Snippet took %d microseconds", end - begin));

This will print the time spent between the begin declaration and the end declaration.

Note

You may have to #include "core/os/os.h" if it’s not present already.

When opening a pull request, make sure to remove this snippet as well as the include if it wasn’t there previously.

Get project/editor settings

There are four macros available for this:

  1. // Returns the specified project setting's value,
  2. // defaulting to `false` if it doesn't exist.
  3. GLOBAL_DEF("section/subsection/value", false);
  5. // Returns the specified editor setting's value,
  6. // defaulting to "Untitled" if it doesn't exist.
  7. EDITOR_DEF("section/subsection/value", "Untitled");

If a default value has been specified elsewhere, don’t specify it again to avoid repetition:

  1. // Returns the value of the project setting.
  2. GLOBAL_GET("section/subsection/value");
  3. // Returns the value of the editor setting.
  4. EDITOR_GET("section/subsection/value");

It’s recommended to use GLOBAL_DEF/EDITOR_DEF only once per setting and use GLOBAL_GET/EDITOR_GET in all other places where it’s referenced.

Error macros

Godot features many error macros to make error reporting more convenient.

Warning

Conditions in error macros work in the opposite way of GDScript’s built-in assert() function. An error is reached if the condition inside evaluates to true, not false.

Note

Only variants with custom messages are documented here, as these should always be used in new contributions. Make sure the custom message provided includes enough information for people to diagnose the issue, even if they don’t know C++. In case a method was passed invalid arguments, you can print the invalid value in question to ease debugging.

For internal error checking where displaying a human-readable message isn’t necessary, remove _MSG at the end of the macro name and don’t supply a message argument.

Also, always try to return processable data so the engine can keep running well.

  1. // Conditionally prints an error message and returns from the function.
  2. // Use this in methods which don't return a value.
  3. ERR_FAIL_COND_MSG(!mesh.is_valid(), vformat("Couldn't load mesh at: %s", path));
  5. // Conditionally prints an error message and returns `0` from the function.
  6. // Use this in methods which must return a value.
  7. ERR_FAIL_COND_V_MSG(rect.x < 0 || rect.y < 0, 0,
  8.         "Couldn't calculate the rectangle's area.");
  10. // Prints an error message if `index` is < 0 or >= `SomeEnum::QUALITY_MAX`,
  11. // then returns from the function.
  12. ERR_FAIL_INDEX_MSG(index, SomeEnum::QUALITY_MAX,
  13.         vformat("Invalid quality: %d. See SomeEnum for allowed values.", index));
  15. // Prints an error message if `index` is < 0 >= `some_array.size()`,
  16. // then returns `-1` from the function.
  17. ERR_FAIL_INDEX_V_MSG(index, some_array.size(), -1,
  18.         vformat("Item %d is out of bounds.", index));
  20. // Unconditionally prints an error message and returns from the function.
  21. // Only use this if you need to perform complex error checking.
  22. if (!complex_error_checking_routine()) {
  23.     ERR_FAIL_MSG("Couldn't reload the filesystem cache.");
  24. }
  26. // Unconditionally prints an error message and returns `false` from the function.
  27. // Only use this if you need to perform complex error checking.
  28. if (!complex_error_checking_routine()) {
  29.     ERR_FAIL_V_MSG(false, "Couldn't parse the input arguments.");
  30. }
  32. // Crashes the engine. This should generally never be used
  33. // except for testing crash handling code. Godot's philosophy
  34. // is to never crash, both in the editor and in exported projects.
  35. CRASH_NOW_MSG("Can't predict the future! Aborting.");

See also

See core/error_macros.h in Godot’s codebase for more information about each error macro.

Some functions return an error code (materialized by a return type of Error). This value can be returned directly from an error macro. See the list of available error codes in core/error_list.h.