find_unity: Find the Unity executable on a machine.

In unifir: A Unifying API for Calling the 'Unity' '3D' Video Game Engine

Find the Unity executable on a machine.

Description

If the path to Unity is not provided to a function, this function is invoked to attempt to find it. To do so, it goes through the following steps:

1. Attempt to load the "unifir_unity_path" environment variable.

2. Attempt to load the "unifir_unity_path" option.

Assuming that neither points to an actual file, this function will then check the default installation paths for Unity on the user's operating system. If not found, this function will error.

Usage

find_unity(unity = NULL, check_path = TRUE)

Arguments

unity	Character: If provided, this function will quote the provided string (if necessary) and return it.
check_path	Logical: If TRUE, this function will check if the Unity executable provided as an argument, environment variable, or option exists. If it does not, this function will then attempt to find one, and will error if not found. If FALSE, this function will never error.

Value

The path to the Unity executable on the user's machine, as a length-1 character vector.

See Also

Other utilities: add_default_player(), add_prop(), create_unity_project(), get_asset(), load_png(), load_scene(), new_scene(), read_raw(), save_scene(), set_active_scene(), validate_path(), waiver()

Examples

if (interactive()) {
  try(find_unity())
}

unifir documentation built on Dec. 3, 2022, 1:06 a.m.