XRFeitoriaUnreal

class xrfeitoria.factory.XRFeitoriaUnreal(engine_exec: str | Path | None = None, project_path: str | Path | None = None, background: bool = False, reload_rpc_code: bool = False, replace_plugin: bool = False, dev_plugin: bool = False, new_process: bool = False)[source]

Factory class contains all the classes and functions for Unreal.

Members:

ObjectUtils: Object utilities.

Camera: Camera class.

Actor: Actor class.

Shape: Shape wrapper class.

Renderer: Renderer class.

sequence: Sequence wrapper function.

utils: Utilities functions executed in Unreal.

render: Render jobs.

__init__(engine_exec: str | Path | None = None, project_path: str | Path | None = None, background: bool = False, reload_rpc_code: bool = False, replace_plugin: bool = False, dev_plugin: bool = False, new_process: bool = False) → None[source]

Giving arguments to initialize.

Parameters:

  • exec_path (Optional[PathLike], optional) – Path to Unreal executable. Defaults to None.

  • project_path (Optional[PathLike], optional) – Path to Unreal project. Defaults to None.

  • background (bool, optional) – Whether to start Unreal in background. Defaults to False.

  • reload_rpc_code (bool, optional) – whether to reload the registered rpc functions and classes. If you are developing the package or writing a custom remote function, set this to True to reload the code. This will only be in effect when new_process=False if the engine process is reused. Defaults to False.

  • replace_plugin (bool, optional) – Whether to replace the plugin. Defaults to False.

  • dev_plugin (bool, optional) – Whether to use the plugin under local directory. If False, would use the plugin downloaded from a remote server. Defaults to False.

  • new_process (bool, optional) – Whether to start Unreal in a new process. Defaults to False.