Function gameobject_modify

unity_cli/cli/commands/gameobject.py:126–164

Update a GameObject's position, rotation, and/or scale. Only the Transform options you pass are modified; the rest stay unchanged. Rotation is Euler angles in degrees. Examples: u gameobject modify -n Player --position 1 0 -3 u gameobject modify --id 12345 --rotation 0

(
    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,
    position: Annotated[
        tuple[float, float, float] | None,
        typer.Option("--position", help="Position (X Y Z)"),
    ] = None,
    rotation: Annotated[
        tuple[float, float, float] | None,
        typer.Option("--rotation", help="Rotation (X Y Z)"),
    ] = None,
    scale: Annotated[
        tuple[float, float, float] | None,
        typer.Option("--scale", help="Scale (X Y Z)"),
    ] = None,
)

@gameobject_app.command("modify")
@handle_cli_errors
def gameobject_modify(
    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,
    position: Annotated[
        tuple[float, float, float] | None,
        typer.Option("--position", help="Position (X Y Z)"),
    ] = None,
    rotation: Annotated[
        tuple[float, float, float] | None,
        typer.Option("--rotation", help="Rotation (X Y Z)"),
    ] = None,
    scale: Annotated[
        tuple[float, float, float] | None,
        typer.Option("--scale", help="Scale (X Y Z)"),
    ] = None,
) -> None:
    """Update a GameObject's position, rotation, and/or scale.

    Only the Transform options you pass are modified; the rest stay unchanged.
    Rotation is Euler angles in degrees.

    Examples:
        u gameobject modify -n Player --position 1 0 -3
        u gameobject modify --id 12345 --rotation 0 90 0 --scale 2 2 2
    """
    context: CLIContext = ctx.obj

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

    result = context.client.gameobject.modify(
        name=name,
        instance_id=id,
        position=list(position) if position else None,
        rotation=list(rotation) if rotation else None,
        scale=list(scale) if scale else None,
    )
    print_success(result.get("message", "Transform modified"))


@gameobject_app.command("active")