Skip to content

UBTCommand

Full path: schola.core.utils.ubt.UBTCommand

Dataclass for constructing Unreal Build Tool (UBT) command line arguments.

UBTCommand(ubt_path, project_file, target_platform = 'Win64',
           should_package = True, should_clean = False, should_cook = True,
           fast_cook = True, should_build = True, no_p4 = True, prereqs = True,
           no_compile = True, no_compile_uat = True,
           configuration = 'Development', no_debug_info = True,
           unattended = True, staging_dir = None, force_monolithic = False,
           maps = <factory>, all_maps = True, stdout = True)

Parameters

  • ubt_path (Path)

  • project_file (Path)

  • target_platform (str)

  • should_package (bool)

  • should_clean (bool)

  • should_cook (bool)

  • fast_cook (bool)

  • should_build (bool)

  • no_p4 (bool)

  • prereqs (bool)

  • no_compile (bool)

  • no_compile_uat (bool)

  • configuration (Literal)

  • no_debug_info (bool)

  • unattended (bool)

  • staging_dir (Path)

  • force_monolithic (bool)

  • maps (List)

  • all_maps (bool)

  • stdout (bool)

Methods

init

__init__(ubt_path, project_file, target_platform = 'Win64',
         should_package = True, should_clean = False, should_cook = True,
         fast_cook = True, should_build = True, no_p4 = True, prereqs = True,
         no_compile = True, no_compile_uat = True,
         configuration = 'Development', no_debug_info = True, unattended = True,
         staging_dir = None, force_monolithic = False, maps = <factory>,
         all_maps = True, stdout = True)

Parameters

  • ubt_path (Path)

  • project_file (Path)

  • target_platform (str)

  • should_package (bool)

  • should_clean (bool)

  • should_cook (bool)

  • fast_cook (bool)

  • should_build (bool)

  • no_p4 (bool)

  • prereqs (bool)

  • no_compile (bool)

  • no_compile_uat (bool)

  • configuration (Literal)

  • no_debug_info (bool)

  • unattended (bool)

  • staging_dir (Path)

  • force_monolithic (bool)

  • maps (List)

  • all_maps (bool)

  • stdout (bool)

build_args

build_args()

Build and return the complete list of UBT command line arguments.

Returns

The complete list of UBT command line arguments.

run

run()

Run the UBT command.

Returns

Return type: CompletedProcess

Attributes

all_maps

all_maps

configuration

configuration

fast_cook

fast_cook

force_monolithic

force_monolithic

maps

maps

no_compile

no_compile

no_compile_uat

no_compile_uat

no_debug_info

no_debug_info

no_p4

no_p4

prereqs

prereqs

project_file

project_file

should_build

should_build

should_clean

should_clean

should_cook

should_cook

should_package

should_package

staging_dir

staging_dir

stdout

stdout

target_platform

target_platform

ubt_path

ubt_path

unattended

unattended