Function component_inspect

unity_cli/cli/commands/component.py:54–82

Dump all serialized property values of a Component on a GameObject. Example: u component inspect -t "Main Camera" -T Camera

(
    ctx: typer.Context,
    component_type: Annotated[str, typer.Option("--type", "-T", help="Component type name")],
    target: Annotated[str | None, typer.Option("--target", "-t", help="Target GameObject name")] = None,
    target_id: Annotated[int | None, typer.Option("--target-id", help="Target GameObject ID")] = None,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
)

@component_app.command("inspect")
@handle_cli_errors
def component_inspect(
    ctx: typer.Context,
    component_type: Annotated[str, typer.Option("--type", "-T", help="Component type name")],
    target: Annotated[str | None, typer.Option("--target", "-t", help="Target GameObject name")] = None,
    target_id: Annotated[int | None, typer.Option("--target-id", help="Target GameObject ID")] = None,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
) -> None:
    """Dump all serialized property values of a Component on a GameObject.

    Example:
        u component inspect -t "Main Camera" -T Camera
    """
    context: CLIContext = ctx.obj

    if not target and target_id is None:
        _exit_usage("--target or --target-id required", "u component inspect")

    result = context.client.component.inspect(
        target=target,
        target_id=target_id,
        component_type=component_type,
    )
    if _should_json(context, json_flag):
        print_json(result, None)
    else:
        print_key_value(result, component_type)


@component_app.command("add")