※この翻訳ドキュメントはスクリプトによって出力・同期されています。内容が怪しそうな場合はGitHubにissueを追加したり英語の原文の確認をお願いします。

Return クラス

このページではReturnクラスについて説明します。

このページを読み進める前に以下のページを確認しておくと役に立つかもしれません（apyscライブラリではReturnクラスを各データクラスと同じような理由で使用しています）。

Return クラスの概要

ReturnクラスはJavaScriptのreturn;のコードのように振る舞います。従って、このクラスはイベントハンドラの関数もしくはメソッド内のスコープでのみ使用することができます。

基本的な使い方

Returnクラスのコンストラクタは引数を必要としません。このクラスはap.Ifなどの条件分岐の記述内などで使うことができます。

以下のコード例では四角をクリックするたびに塗りの色を変更しています。各ap.Ifでの分岐内ではReturnクラスを使用しているため、1回のクリックでは1回の色変更のみ行われます:

import apysc as ap


def on_click(e: ap.MouseEvent[ap.Rectangle], options: dict) -> None:
    """
    The handler that the rectangle calls when clicked.

    Parameters
    ----------
    e : ap.MouseEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    rectangle: ap.Rectangle = e.this
    fill_color: ap.Color = rectangle.fill_color
    with ap.If(fill_color == ap.Color("#00aaff")):
        rectangle.fill_color = ap.Color("#ff00aa")
        ap.Return()
    with ap.If(fill_color == ap.Color("#ff00aa")):
        rectangle.fill_color = ap.Color("#00ffaa")
        ap.Return()
    with ap.If(fill_color == ap.Color("#00ffaa")):
        rectangle.fill_color = ap.Color("#00aaff")
        ap.Return()


ap.Stage(
    stage_width=150,
    stage_height=150,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)
sprite: ap.Sprite = ap.Sprite()
sprite.graphics.begin_fill(color=ap.Color("#00aaff"))
rectangle: ap.Rectangle = sprite.graphics.draw_rect(x=50, y=50, width=50, height=50)
rectangle.click(on_click)

ap.save_overall_html(dest_dir_path="return_basic_usage/")

Return API

特記事項: このAPIドキュメントはドキュメントビルド用のスクリプトによって自動で生成・同期されています。そのためもしかしたらこの節の内容は前節までの内容と重複している場合があります。

[インターフェイスの構造] __init__(self) -> None

[インターフェイス概要]

return のコード表現のためのクラスです。

[特記事項]

このクラスはイベントハンドラのスコープ内でのみインスタンス化することができます。

[コードサンプル]

>>> import apysc as ap
>>> def on_timer(e: ap.TimerEvent, options: dict) -> None:
...     '''
...     The handler that the timer calls.
...