Function component_modify

unity_cli/cli/commands/component.py:115–150

Modify a component property. Values are auto-parsed: integers, floats, booleans (true/false), JSON arrays ([1,2,3]), and JSON objects ({"r":1,"g":0,"b":0}) are converted to their appropriate types. Everything else is sent as a string. Examples: u component modify -t "Main C

(
    ctx: typer.Context,
    component_type: Annotated[str, typer.Option("--type", "-T", help="Component type name")],
    prop: Annotated[str, typer.Option("--prop", "-p", help="Property name to modify")],
    value: Annotated[
        str,
        typer.Option("--value", "-v", help="New value (auto-parsed: numbers, booleans, JSON arrays/objects)"),
    ],
    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,
)

@component_app.command("modify")
@handle_cli_errors
def component_modify(
    ctx: typer.Context,
    component_type: Annotated[str, typer.Option("--type", "-T", help="Component type name")],
    prop: Annotated[str, typer.Option("--prop", "-p", help="Property name to modify")],
    value: Annotated[
        str,
        typer.Option("--value", "-v", help="New value (auto-parsed: numbers, booleans, JSON arrays/objects)"),
    ],
    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,
) -> None:
    """Modify a component property.

    Values are auto-parsed: integers, floats, booleans (true/false),
    JSON arrays ([1,2,3]), and JSON objects ({"r":1,"g":0,"b":0}) are
    converted to their appropriate types. Everything else is sent as a string.

    Examples:
        u component modify -t "Main Camera" -T Camera --prop fieldOfView --value 90
        u component modify -t "Cube" -T Transform --prop m_LocalPosition --value "[1,2,3]"
    """
    context: CLIContext = ctx.obj

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

    parsed_value = _parse_cli_value(value)

    result = context.client.component.modify(
        target=target,
        target_id=target_id,
        component_type=component_type,
        prop=prop,
        value=parsed_value,
    )
    print_success(result.get("message", "Property modified"))


@component_app.command("remove")