Skip to content

Latest commit

 

History

History
181 lines (122 loc) · 6.88 KB

humanoid_creator.md

File metadata and controls

181 lines (122 loc) · 6.88 KB
Raw

HumanoidCreator

from tdw.asset_bundle_creator.humanoid_creator import HumanoidCreator

Create asset bundles of non-physics humanoids from .fbx files.

Class Variables

Variable Type Description Value
PROJECT_PATH Path The path to the asset_bundle_creator Unity project. Path.home().joinpath("asset_bundle_creator")
UNITY_VERSION str Use this version of Unity Editor to launch the asset bundle creator. "2020.3"

Fields

  • quiet If True, don't print any messages to console.

Functions

__init__

__init__

HumanoidCreator()

HumanoidCreator(quiet=False, display="0", unity_editor_path=None, check_version=True)

Parameter Type Default Description
quiet bool False If True, don't print any messages to console.
display str "0" The display to launch Unity Editor on. Ignored if this isn't Linux.
unity_editor_path PATH None The path to the Unity Editor executable, for example C:/Program Files/Unity/Hub/Editor/2020.3.24f1/Editor/Unity.exe. If None, this script will try to find Unity Editor automatically.
check_version bool True If True, check if there is an update to the Unity Editor project.

source_file_to_asset_bundles

self.source_file_to_asset_bundles(name, source_file, output_directory)

self.source_file_to_asset_bundles(name, source_file, output_directory, targets=None)

Convert a source file into 3 asset bundle files (Windows, OS X, and Linux).

Parameter Type Default Description
name str The name of the animation.
source_file PATH The path to the source file as a string or Path.
output_directory PATH The root output directory as a string or Path. If this directory doesn't exist, it will be created.
targets List[str] None A list of build targets. Options: "linux", "osx", "windows", "webgl". If None, defaults to ["linux", "osx", "windows"].

source_directory_to_asset_bundles

self.source_directory_to_asset_bundles(source_directory, output_directory)

self.source_directory_to_asset_bundles(source_directory, output_directory, library_description=None, overwrite=False, continue_on_error=True, search_pattern=None, cleanup=True, targets=None)

Convert a directory of source files to asset bundles.

Calling this is significantly faster than calling self.source_file_to_asset_bundles() multiple times.

Parameter Type Default Description
source_directory PATH The root directory of the source files as a string or Path.
output_directory PATH The root directory of the output files as a string or Path.
library_description str None An optional description of the ModelAnimationLibrarian that will be included in the library.json file.
overwrite bool False If True, overwrite existing asset bundles. If this is set to False (the default value), you can stop/resume the processing of a directory's contents.
continue_on_error bool True If True, continue generating asset bundles even if there is a problem with one file. If False, stop the process if there's an error.
search_pattern str None A search pattern for files, for example "*.fbx". All subdirectories will be recursively searched.
cleanup bool True If True, delete intermediary files such as the prefabs in the asset_bundle_creator Unity Editor project.
targets List[str] None A list of build targets. Options: "linux", "osx", "windows", "webgl". If None, defaults to ["linux", "osx", "windows"].

get_base_unity_call

self.get_base_unity_call()

Returns: The call to launch Unity Editor silently in batchmode, execute something, and then quit.

call_unity

self.call_unity(method, args, log_path)

self.call_unity(method, args, log_path, class_name=None)

Execute a call to Unity Editor. If self.quiet == False this will continuously print the log file.

Parameter Type Default Description
method str The name of the method.
args List[str] Arguments to send to Unity Editor in addition to those send via self.get_base_unity_call() and -executeMethod.
log_path PATH The path to the log file as a string or Path.
class_name str None The name of the Unity C# class. If None, a default class name will be used. See: self.get_creator_class_name().

prefab_to_asset_bundles

self.prefab_to_asset_bundles(name, output_directory)

self.prefab_to_asset_bundles(name, output_directory, targets=None)

Build asset bundles from a .prefab file. This is useful when you want to edit the .prefab file by hand, e.g.:

  1. self.source_file_to_prefab()
  2. Edit .prefab file
  3. self.prefab_to_asset_bundles()

Example source:

~/asset_bundle_creator/
....Assets/
........prefabs/
............name/
................name.prefab
........source_files/
............name/
................name.obj
................Materials/

Example output:

output_directory/
....Darwin/
........name
....Linux/
........name
....Windows/
........name
....log.txt
Parameter Type Default Description
name str The name of the model (the name of the .prefab file, minus the extension).
output_directory PATH The root output directory as a string or Path. If this directory doesn't exist, it will be created.
targets List[str] None A list of build targets. Options: "linux", "osx", "windows", "webgl". If None, defaults to ["linux", "osx", "windows"].

cleanup

self.cleanup()

Delete any intermediary files in the asset_bundle_creator Unity Editor project such as .prefab files.

asset_bundles_exist

AssetBundleCreator.asset_bundles_exist(name, directory)

(Static)

Check whether asset bundles exist for all platforms in the source directory.

Expected directory structure:

directory/
....Darwin/
........name
....Linux/
........name
....Windows/
........name

...where name is an asset bundle file.

Parameter Type Default Description
name str The name of the asset bundle.
directory PATH The source directory as a string or Path.

Returns: True if asset bundles exist for all platforms in the source directory.

get_creator_class_name

self.get_creator_class_name()

Returns: The name of the Unity C# class, e.g. ModelCreator.