Skip to content

utils.ubt

Full path: schola.core.utils.ubt

schola.core.utils.ubt

Utility Functions and classes for working with Unreal Engine’s UBT (Unreal Build Tool) system.

Functions

ItemDescription
build_executable(project_file, build_dir, …)Build an Unreal Engine project executable using the Unreal Build Tool.
get_editor_executable_path(engine_path)Get the path to the Unreal Editor command-line executable.
get_engine_path_from_sln(sln_file)Extract the Unreal Engine path from a Visual Studio solution file.
get_project_file(project_folder)Find the .uproject file in a project folder.
get_sln_file_from_project(project_folder)Find the Visual Studio solution file in a project folder.
get_ubt_path(project_folder[, ue_version])Get the path to the Unreal Build Tool (UBT) RunUAT script.
get_ue_version(project_file)Extract the Unreal Engine version from a .uproject file.
get_unreal_platform()Get the current platform for Unreal Engine.
quick_build_unreal_project(project_folder, …)Build function with reasonable defaults to build an Unreal Engine project and return the path to the executable.

Classes

ItemDescription
UBTCommand(ubt_path, project_file[, …])Dataclass for constructing Unreal Build Tool (UBT) command line arguments.