スクリーンのアクション、値、関数 link

Ren'Py にはスクリーンやスクリーン言語での使用を意図したいくつかのアクション、値、関数があります。

アクション link

アクションは ( imagebutton、textbutton、hotspot のような ) ボタンが押されるか、その上にマウスが出入りすると実行されます。アクションはボタンの有効無効も決定することがあります。

これらのアクション同様に、アクションには引数を取らない関数も使えます。関数はアクションが実行されると呼び出されます。アクションが値を返すと、その値がインタラクションから返されます。

アクションはアクションのリストでもいいです。その場合、そのリストのアクションは順番に実行されます。

制御用のアクション link

これらはスクリーンや インタラクションの結果、フロー制御を管理するアクションです。

データアクション link

これらはデータを設定またトグルします。

ファイルアクション link

これらのアクションはセーブ、ロード、ファイルの削除を扱い、多くは namepage 引数を取ります。

name

セーブするファイルの名前。これは文字列か整数です。ファイルの名前を作成するために pageと結合されます。

page

このアクションが動作するページです。これは「 auto 」、「 quick 」、正の整数のいずれかです。 None の場合、 persistent._file_page に基づき自動的に決定されます。

オーディオアクション link

その他のアクション link

他に分類されないその他のアクションがあります。

Bar Values link

Bar Value はバーに使用してバーの値を設定し、バーがプロパティーを調整できるようにします。新しい bar value を作成するには BarValue サブクラスを作成します。

Input Values link

Input Value はテキスト入力で使用され、デフォルトのテキストを設定し、テキストの変更を受け付け、エンターキーに反応し、テキストがデフォルトで編集可能かどうか設定します。新しい input value を作成するには InputValue のサブクラスを作成してください。

Ren'Py 定義の input value は InputValue を継承していて、すべての value は編集を有効、無効、トグルするアクションを返す Enable(), Disable(), Toggle() メソッドを含んでいます。 DisableAllInputValues() アクションも参照してください。

関数とクラス link

これらの関数やクラスはスクリーンと連携させると便利です。

Preferences link

すべての preferences は上記のアクションや value で定義できますが、正しく使用するためにはある程度の Ren'Py の知識が必要です。 preferences のコンストラクターは、デフォルトの設定画面で使用される名前に基づき適切なアクションや value を作成することでこれを簡単にします。

Gamepad link

これらの関数とアクションはゲームパッドで動作します。

ファイル関数 link

これらの関数は通常ファイルについての情報を返し、ファイルアクション同様のデフォルトページを使用します。

サイドイメージ関数 link

この関数は使用するサイドイメージを返します。

Tooltip link

Tooltips はすべての displayable に対し利用可能な tooltip プロパティーと GetTooltip 関数からアクセス可能になりました。 GetTooltip 関数は displayable がフォーカスを得たとき、その displayable の tooltip プロパティーの値を返します。

screen tooltip_example():
    vbox:
        textbutton "North":
            action Return("n")
            tooltip "To meet a polar bear."

        textbutton "South":
            action Return("s")
            tooltip "All the way to the tropics."

        textbutton "East":
            action Return("e")
            tooltip "So we can embrace the dawn."

        textbutton "West":
            action Return("w")
            tooltip "Where to go to see the best sunsets."

        $ tooltip = GetTooltip()

        if tooltip:
            text "[tooltip]"

Legacy link

警告

これらは上述のものより旧来のものです。古いプロジェクトで見かけるでしょう。

Tooltip クラスはあるボタンの上にマウスが入ると、スクリーンを変更します。

スクリーンで Tooltipを使用するときは通常 default ステートメントで Tooltip オブジェクトを作成します。 Tooltip とその Action メソッドの value はスクリーンに使用されます。スクリーンでの使用順は問題にはなりません - Action の前に値を利用することも可能です。

Tooltip はどんな値もとれます。以下の例ではスクリーンに文字を表示するため text ステートメントを使用していますが、 add ステートメントによって displayable を追加することも可能です。さらに複雑な動作も可能です。

screen tooltip_test:

    default tt = Tooltip("No button selected.")

    frame:
        xfill True

        has vbox

        textbutton "One.":
            action Return(1)
            hovered tt.Action("The loneliest number.")

        textbutton "Two.":
            action Return(2)
            hovered tt.Action("Is what it takes.")

        textbutton "Three.":
            action Return(3)
            hovered tt.Action("A crowd.")

        text tt.value