Function gameobject_find

unity_cli/cli/commands/gameobject.py:26–62

Locate GameObjects in the active scene by name or instance ID. Returns all matching objects with their instance IDs — use the ID for precise follow-up commands when multiple share a name. Examples: u gameobject find -n Player u gameobject find --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,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
)

@gameobject_app.command("find")
@handle_cli_errors
def gameobject_find(
    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,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
) -> None:
    """Locate GameObjects in the active scene by name or instance ID.

    Returns all matching objects with their instance IDs — use the ID for
    precise follow-up commands when multiple share a name.

    Examples:
        u gameobject find -n Player
        u gameobject find --id 12345
    """
    context: CLIContext = ctx.obj

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

    result = context.client.gameobject.find(name=name, instance_id=id)
    if _should_json(context, json_flag):
        print_json(result)
    else:
        objects = result.get("objects", [])
        if is_no_color():
            rows = [[obj.get("name", "Unknown"), str(obj.get("instanceID", ""))] for obj in objects]
            print_plain_table(["Name", "ID"], rows, header=False)
        else:
            print_line(f"[bold]Found {len(objects)} GameObject(s)[/bold]")
            for obj in objects:
                obj_name = escape(obj.get("name", "Unknown"))
                obj_id = obj.get("instanceID", "")
                print_line(f"  {obj_name} (ID: {obj_id})")


@gameobject_app.command("create")