UBTCommand

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

schola.core.utils.ubt.UBTCommand

UBTCommand

UBTCommand(ubt_path, project_file, target_platform='Win64', should_package=True, should_clean=True, 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=True, maps=<factory>, stdout=True)

Bases: object

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

Methods

Item	Description
init	—
build_args	Build and return the complete list of UBT command line arguments.

Attributes

Item	Description
all_maps	—
configuration	—
fast_cook	—
force_monolithic	—
no_compile	—
no_compile_uat	—
no_debug_info	—
no_p4	—
prereqs	—
should_build	—
should_clean	—
should_cook	—
should_package	—
staging_dir	—
stdout	—
target_platform	—
unattended	—
ubt_path	—
project_file	—
maps	—

Parameters

ubt_path (Path | str)

project_file (Path | str)

target_platform (str | None)

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['Development', 'Shipping'])

no_debug_info (bool)

unattended (bool)

staging_dir (str | None)

force_monolithic (bool)

maps (List[str])

stdout (bool)

init

__init__(ubt_path, project_file, target_platform='Win64', should_package=True, should_clean=True, 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=True, maps=<factory>, stdout=True)

Parameters

ubt_path (Path | str)

project_file (Path | str)

target_platform (str | None)

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['Development', 'Shipping'])

no_debug_info (bool)

unattended (bool)

staging_dir (str | None)

force_monolithic (bool)

maps (List[str])

stdout (bool)

Returns

None

---

all_maps

all_maps: 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.

Return type: List[str]

---

configuration

= 'Development' configuration: Literal['Development', 'Shipping']

---

fast_cook

= True fast_cook: bool

---

force_monolithic

= True force_monolithic: bool

---

maps

maps: List[str]

---

no_compile

= True no_compile: bool

---

no_compile_uat

= True no_compile_uat: bool

---

no_debug_info

= True no_debug_info: bool

---

no_p4

= True no_p4: bool

---

prereqs

= True prereqs: bool

---

project_file

project_file: Path | str

---

should_build

= True should_build: bool

---

should_clean

= True should_clean: bool

---

should_cook

= True should_cook: bool

---

should_package

= True should_package: bool

---

staging_dir

= None staging_dir: str | None

---

stdout

= True stdout: bool

---

target_platform

= 'Win64' target_platform: str | None

---

ubt_path

ubt_path: Path | str

---

unattended

= True unattended: bool

---