Function gameobject_delete

unity_cli/cli/commands/gameobject.py:201–218

Destroy a GameObject from the active scene. Examples: u gameobject delete -n TempSpawn u gameobject delete --id 12345

(
    ctx: typer.Context,
    name: Annotated[str | None, typer.Option("--name", "-n", help="GameObject name")] = None,
    id: Annotated[int | None, typer.Option("--id", help="Instance ID")] = None,
)

@gameobject_app.command("delete")
@handle_cli_errors
def gameobject_delete(
    ctx: typer.Context,
    name: Annotated[str | None, typer.Option("--name", "-n", help="GameObject name")] = None,
    id: Annotated[int | None, typer.Option("--id", help="Instance ID")] = None,
) -> None:
    """Destroy a GameObject from the active scene.

    Examples:
        u gameobject delete -n TempSpawn
        u gameobject delete --id 12345
    """
    context: CLIContext = ctx.obj

    if not name and id is None:
        _exit_usage("--name or --id required", "u gameobject delete")

    result = context.client.gameobject.delete(name=name, instance_id=id)
    print_success(result.get("message", "GameObject deleted"))