Function scene_load

unity_cli/cli/commands/scene.py:76–99

Open a scene in the editor (single or additive). Identify the scene by asset path (--path) or by scene name (--name). Paths resolve relative to the project (Assets/...). Unsaved changes in the current scene are discarded unless --additive is set. Examples: u scene load -p A

(
    ctx: typer.Context,
    path: Annotated[str | None, typer.Option("--path", "-p", help="Scene path")] = None,
    name: Annotated[str | None, typer.Option("--name", "-n", help="Scene name")] = None,
    additive: Annotated[bool, typer.Option("--additive", "-a", help="Load additively")] = False,
)

@scene_app.command("load")
@handle_cli_errors
def scene_load(
    ctx: typer.Context,
    path: Annotated[str | None, typer.Option("--path", "-p", help="Scene path")] = None,
    name: Annotated[str | None, typer.Option("--name", "-n", help="Scene name")] = None,
    additive: Annotated[bool, typer.Option("--additive", "-a", help="Load additively")] = False,
) -> None:
    """Open a scene in the editor (single or additive).

    Identify the scene by asset path (--path) or by scene name (--name).
    Paths resolve relative to the project (Assets/...). Unsaved changes in the
    current scene are discarded unless --additive is set.

    Examples:
        u scene load -p Assets/Scenes/Main.unity
        u scene load -n Main
        u scene load -p Assets/Scenes/UI.unity --additive
    """
    context: CLIContext = ctx.obj

    if not path and not name:
        _exit_usage("--path or --name required", "u scene load")

    result = context.client.scene.load(path=path, name=name, additive=additive)
    print_success(result.get("message", "Scene loaded"))


@scene_app.command("save")