Function gameobject_active

unity_cli/cli/commands/gameobject.py:169–196

Enable or disable a GameObject (equivalent to the Inspector's top-left toggle). Use --no-active to disable. The default --active enables the object. Examples: u gameobject active -n HUD --no-active u gameobject active --id 12345 --active

(
    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,
    active: Annotated[
        bool,
        typer.Option("--active/--no-active", help="Set active (true) or inactive (false)"),
    ] = True,
)

@gameobject_app.command("active")
@handle_cli_errors
def gameobject_active(
    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,
    active: Annotated[
        bool,
        typer.Option("--active/--no-active", help="Set active (true) or inactive (false)"),
    ] = True,
) -> None:
    """Enable or disable a GameObject (equivalent to the Inspector's top-left toggle).

    Use --no-active to disable. The default --active enables the object.

    Examples:
        u gameobject active -n HUD --no-active
        u gameobject active --id 12345 --active
    """
    context: CLIContext = ctx.obj

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

    result = context.client.gameobject.set_active(
        active=active,
        name=name,
        instance_id=id,
    )
    print_success(result.get("message", f"Active set to {active}"))


@gameobject_app.command("delete")