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

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

アクション link

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

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

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

制御用のアクション link

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

Hide(screen, transition=None) link

これは screen と名付けられたスクリーンを、もし表示されていれば非表示にします。

transition

None でなければスクリーンを非表示にするときにトランジションが使用されます。

Jump(label) link

制御を与えられたラベルに移します。これは実行するとあるラベルにジャンプする Imagemap を定義するために、 renpy.run_screenと連携して使用できます。

NullAction(*args, **kwargs) link

何もしません。

これはボタンの hover/unhover イベントに対する反応として、実際には何もしない時に使用されます。

Return(value=None) link

None でなければ、現在のインタラクションが与えられた value を返すようにします。これはインタラクションから返される値を選択するために、しばしば menu や imagemap で使用されます。スクリーンが call screen ステートメントで呼び出されると、返り値は _return 変数に配置されます。

menu ではこれで menu から戻ります。(この場合値は None であるべきです。)

Show(screen, transition=None, *args, **kwargs) link

これは他のスクリーンを表示します。 screen はスクリーンの名前の文字列です。キーワード引数は表示されるスクリーンに渡されます。

None でなければ transition が新しいスクリーンを表示するために使用されます。

ShowTransient(screen, *args, **kwargs) link

一時的なスクリーンを表示します。一時的なスクリーンは現在のインタラクションが完了すると非表示になります。

データアクション link

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

AddToSet(set, value) link

valueset に追加します。

set

追加する set です。これは python の set またはリストで、値がそれに付け加えられます。

value

追加または削除される値です。

RemoveFromSet(set, value) link

set から value を除去します。

set

これは set または リストです。

value

追加または削除される値です。

SetDict(dict, key, value) link

dictkey の値を value に設定します。

SetField(object, field, value) link

オブジェクトのフィールドを与えられた値に設定します。 object にはオブジェクト、 field には設定するフィールドの名前の文字列、 value には設定したい値を入れます。

SetScreenVariable(name, value) link

現在のスクリーンに関連づけられた name の変数を value に設定します。

SetVariable(variable, value) link

variablevalue に設定します。

ToggleDict(dict, key, true_value=None, false_value=None) link

dictkey の値をトグルします。トグルとはアクションが実行されると、値が True が False に、 False が True になるということです。

true_value

None を指定するか、 True として使用する値を指定します。

false_value

None を指定するか False として使用する値を指定します。

ToggleField(object, field, true_value=None, false_value=None) link

objectfield をトグルします。トグルとは、アクション実行時にそのフィールドの真偽値を反転することです。

true_value

None を指定するか、 True として使用する値を指定します。

false_value

None を指定するか False として使用する値を指定します。

ToggleScreenVariable(name, true_value=None, false_value=None) link

現在のスクリーンの name と名付けられた変数の値をトグルします。

true_value

None を指定するか、 True として使用する値を指定します。

false_value

None を指定するか False として使用する値を指定します。

ToggleSetMembership(set, value) link

set から value をトグルします。値が set になければ追加され、そうでなければ削除されます。

このアクションを持つボタンはその set にその値があるときのみ選択状態としてマークされます。

set

追加する set です。これは python の set またはリストで、値がそれに付け加えられます。

value

追加または削除される値です。

ToggleVariable(variable, true_value=None, false_value=None) link

variable をトグルします。

true_value

None を指定するか、 True として使用する値を指定します。

false_value

None を指定するか False として使用する値を指定します。

ファイルアクション link

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

name

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

page

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

FileAction(name, page=None, **kwargs) link

そのファイルを「 適切に扱います」。これはつまり load スクリーンが表示されていれば (現在のスクリーン名が 「load」 なら ) ファイルをロードし、そうでなければファイルにセーブするということです。

name

セーブまたはロードするスロット名です。 None なら未使用 ( 現在時刻を元にした大きな数字の ) スロットが使用されます。

page

セーブまたはロードされるファイルのページです。 None の場合、現在のページが使用されます。

その他のキーワード引数は FileLoad, FileSave に渡されます。

FileDelete(name, confirm=True, page=None) link

ファイルを削除します。

confirm

True の場合、ファイルを削除する前に尋ねます。

FileLoad(name, confirm=True, page=None, newest=True) link

ファイルをロードします。

name

ロードするスロットの名前です。 None の場合、ロードできない未使用のスロットが使用されます。

confirm

True かつメインメニューでなければ、ファイルロード前に確認のためのプロントが表示されます。

page

ファイルがロードされるページです。 None の場合、現在のページが使用されます。

newest

True で、これが最新のファイルであれば選択状態になります。

cycle

無視されます。

FilePage(page) link

ページを page に設定します。「 auto 」、 「 quick 」、整数のいずれかです。

FilePageNext(max=None, wrap=False) link

次のファイルページに移動します。

max

設定する場合は、移動可能なファイルページの最大数を与える整数にします。

wrap

True のとき、max が設定されていれば、最後のファイルページにいるときに最初のページに戻ります。

FilePagePrevious(max=None, wrap=False) link

可能であれば前のファイルページに移動します。

max

設定する場合は、移動可能なファイルページの最大数を与える整数にします。これは wrap を有効にするときに必要です。

wrap

True のとき、max が設定されていれば、最初のファイルページにいるときに最後のページに行きます。

FileSave(name, confirm=True, newest=True, page=None, cycle=False) link

ファイルにセーブします。

このスロットのボタンが最新のセーブファイルとしてマークされていれば選択状態になります。

name

セーブするスロット名です。 None なら未使用 ( 現在時刻を元にした大きな数字の ) スロットが使用されます。

confirm

True の場合、ファイルを上書きする前に確認します。

newest

無視されます。

page

スロットのあるページの名前です。 None の場合は現在のページが使用されます。

cycle

True の場合、提供されたページのセーブはユーザーに表示される前に一回りします。 config.quicksave_slots が回すときに使用されます。

FileTakeScreenshot(*args, **kwargs) link

セーブ時に使用されるスクリーンショットを撮ります。これはセーブスクリーンが表示される前のスクリーンを撮り、スクリーンショットが正しいことを保証するために使用されます。

QuickLoad(confirm=True) link

クイックロードを処理します。

confirm

True かつメインメニューでなければ、ファイルロード前に確認のためのプロントが表示されます。

QuickSave(message=u'Quick save complete.', newest=False) link

クイックセーブを処理します。

message

クイックセーブが終了するとユーザーに表示されるメッセージです。

newest

最新のセーブとしてクイックセーブをマークする場合は True に設定します。

オーディオアクション link

PauseAudio(channel, value=True) link

channel のポーズフラグを設定します。

value が True なら、そのチャンネルはポーズされます。 False なら、そのチャンネルはポーズ解除されます。 "toggle" なら、パーズフラグはトグルされます。

Play(channel, file, selected=None, **kwargs) link

オーディオファイルを与えられたチャンネルで再生します。

channel

サウンドを再生するチャンネル

file

再生するファイル

selected

True なら、このアクションを使用するボタンはそのファイルがそのチャンネルで再生中なら選択状態とマークされます。 False ならこのアクションはボタンに再生を開始させません。 None ならボタンはそのチャンネルが music チャンネルなら選択状態になります。

すべての他のキーワード引数は renpy.music.play() に渡されます。

Queue(channel, file, **kwargs) link

オーディオファイルを与えられたチャンネルにキューします。

channel

サウンドを再生するチャンネル

file

再生するファイル

すべてのキーワード引数は renpy.music.queue() に渡されます。

SetMixer(mixer, volume) link

mixer の音量を value に設定します。

mixer

音量を設定するミキサーです。文字列で、通常は 「music」か 「sfx」、「voice」

value

音量を背呈する値です。 0.0 から 1.0 の間の数字を含みます。

SetMute(mixer, mute) link

ひとつ以上のミキサーのミュート状態を設定します。ミキサーがミュートなら、そのミキサーと関連するオーディオチャンネルはオーディオの再生を停止します。

mixer

ミキサー名の文字列か、文字列のリストです。文字列はミキサー名で、通常 "music", "sfx", または "voice" です。

mute

True ならミキサーをミュートにし、 False ならミュートを解除します。

Stop(channel, **kwargs) link

オーディオチャンネルを停止します。

channel

再生を停止するチャンネル

その他のキーワード引数は renpy.music.stop() に渡されます。

ToggleMute(mixer) link

ひとつ以上のミキサーのミュート状態をトグルします。

mixer

ミキサー名の文字列か、文字列のリストです。文字列はミキサー名で、通常 "music", "sfx", または "voice" です。

その他のアクション link

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

Confirm(prompt, yes, no=None, confirm_selected=False) link

ユーザーにアクションの確認を促します。ユーザーが yes をクリックすると、 yes アクションが実行され、そうでなければ no アクションが実行されます。

prompt

ユーザーに表示するプロンプトです。

confirm_selected

True なら、 yes アクションがすでに選択されていてもプロンプトは表示されます。 False (デフォルト)なら、 yes アクションが選択されていればプロンプトは表示されません。

アクションの有効選択状態は yes アクションのそれらに合致します。

DisableAllInputValues() link

すべての有効な InputValue を無効化します。これでデフォルトの InputValue があれば、フォーカスが戻ります。そうでなければ、 InputValue にはフォーカスされません。

Function(callable, *args, **kwargs) link

このアクションは callableargskwargs を引数に呼び出します。

callable

呼び出し可能オブジェクト

args

位置引数は callable に渡されます。

kwargs

キーワード引数は callable に渡されます。

このアクションは任意で _update_screens キーワード引数を取り、これはデフォルトでは True になります。 True ならインテラクションは再開し、スクリーンは関数から処理が返された後更新されます。

関数が None 以外を返すと、インタラクションは停止し、その値を返します。( call screen ステートメントで呼び出されると、その結果は _return 変数に配置されます)

Help(help=None) link

ヘルプを表示します。

help という名のスクリーンが定義されていれば、そのスクリーンは ShowMenu() を使用して表示され help は無視されます。

help

help を探すための文字列です。これは以下の方法で使用します。 :

  • この名前のラベルが存在したら、そのラベルは新しコンテキストで呼び出されます。

  • そうでなければ、これはブラウザーで開くべきファイル名として解釈されます。

help が None なら、 config.help がデフォルトの値として使用されます。

HideInterface(*args, **kwargs) link

インターフェースをユーザーがクリックするまで非表示にします。

If(expression, true=None, false=None) link

expression が True の場合は True を返し、そうでなければ False を返します。 expression に基づいてアクションを選択するにはこれを使用してください。デフォルトでは None はボタンを無効化するアクションとして使用可能なことに気をつけてください。

InvertSelected(action) link

与えられたアクションの選択状態を反転し、それ以外のメソッドはそのままにします。

MouseMove(x, y, duration=0) link

マウスポインターを x, y に移動します。デバイスがマウスポインターをサポートしないか _preferences.mouse_move が False ならこれは何もしません。

duration

移動処理にかける秒数です。この時間の間はマウスが反応しません。

Notify(message) link

renpy.notify() を使用して message を表示します。

OpenURL(url) link

url をウェブブラウザーで開きます。

QueueEvent(event, up=False) link

指定されたイベントを renpy.queue_event() を使用してキューします。

RestartStatement(*args, **kwargs) link

このアクションは Ren'Py を現在のステートメント以前にロールバックし、現在ステートメントをやりなおします。永続データの変更がそのステートメントによる表示に影響を与えるときこれは使われるでしょう。

メニューコンテキストで実行されると、プレイヤーがトップレベルコンテキストに戻るまでロールバックを待ちます。

RollForward(*args, **kwargs) link

ロールフォワードが可能な場合、ロールフォワードを実行します。そうでなければ無効です。

Rollback(*args, **kwargs) link

ロールバックが可能な場合、ロールバックを実行します。そうでなけれ何も起こりません。

RollbackToIdentifier(identifier) link

identifier へのロールバックを実行します。ロールバック identifier は HistoryEntry オブジェクトの一部として返されます。

Screenshot(*args, **kwargs) link

スクリーンショットを撮ります。

SelectedIf(expression) link

これは expreesion をボタンが選択されているかどうかを制御するために利用できるようにします。一つ以上のアクションのリストの一部として使用されるはずです。

# The button is selected if mars_flag is True
textbutton "Marsopolis":
    action [ Jump("mars"), SelectedIf(mars_flag) ]
SensitiveIf(expression) link

これは expreesion でボタンが選択可能か制御できるようにします。一つ以上のアクションのリストの一部として使用されるはずです。

# The button is sensitive if mars_flag is True
textbutton "Marsopolis":
    action [ Jump("mars"), SensitiveIf(mars_flag) ]
Skip(fast=False, confirm=False) link

ゲームのスキップを開始します。 menu コンテキストの内部にいる場合はゲームに戻ってから開始し、それ以外の場合は単にスキップを開始します。

fast

True なら次の選択肢まで直接スキップします。

confirm

True ならスキップを開始する前に確認します。

With(transition) link

transition を実行します。

Bar Values link

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

AnimatedValue(value=0.0, range=1.0, delay=1.0, old_value=None) link

これはアニメーション用の value で、 delay 秒かけて old_value から value に変化します。

value

値の数字です。

range

値の範囲の数字です。

delay

value をアニメーションするための秒数で、デフォルトでは 1.0 です。

old_value

元の値です。これが None であれば、値は置き換えた AnimatedValue から受け取られます。それ以外の場合は value に初期化されます。

AudioPositionValue(channel=u'music', update_interval=0.1) link

channel で再生しているオーディオファイルの再生一を示す値です。

update_interval

しばしば値は秒毎に更新されます。

DictValue(dict, key, range, max_is_zero=False, style=u'bar', offset=0, step=None) link

ユーザーが辞書のキーの値を調整出来るようにする value です。

dict

辞書

key

キー

range

調整の範囲

max_is_zero

True ならキーの値が 0 の時にこのバーの値は最大となり、それ以外の値では 1 に上がっていきます。これはバーが最大に設定されるか、キーの値が 0 に設定されるかの両方の方法で動作します。

style

作成されるバーのスタイル

offset

値に加えられるオフセット

step

バーが変更する量。 None の場合、デフォルトでバーの10分の1です。

FieldValue(object, field, range, max_is_zero=False, style=u'bar', offset=0, step=None) link

ユーザーがオブジェクトのフィールドの値を調整できるようにする bar value です。

object

オブジェクト

field

フィールドの文字列

range

調整の範囲

max_is_zero

True ならフィールドが 0 の時にこのバーの値は最大となり、それ以外の値では 1 に上がっていきます。これはバーが最大に設定されるか、フィールドが 0 に設定されるかの両方の方法で動作します。

これはいくつかの preferences の内部で使用されています。

style

作成されるバーのスタイル

offset

値に加えられるオフセット

step

バーが変更する量。 None の場合、デフォルトでバーの10分の1です。

MixerValue(mixer) link

オーディオミキサーの value です。

mixer

調整するミキサーの名前です。これは通常 「music」か「sfx」、「voice」ですが、ユーザーは新しいミキサーを作成できます。

ScreenVariableValue(variable, range, max_is_zero=False, style=u'bar', offset=0, step=None) link

スクリーン変数の値を調整する bar valueです。

variable

調整する変数の名前の文字列

range

調整の範囲

max_is_zero

True ならフィールドが 0 の時にこのバーの値は最大となり、それ以外の値では 1 に上がっていきます。これはバーが最大に設定されるか、フィールドが 0 に設定されるかの両方の方法で動作します。

これはいくつかの preferences の内部で使用されています。

style

作成されるバーのスタイル

offset

値に加えられるオフセット

step

バーが変更する量。 None の場合、デフォルトでバーの10分の1です。

StaticValue(value=0.0, range=1.0) link

指定した値に固定します。

value

値の数字です。

range

値の範囲

VariableValue(variable, range, max_is_zero=False, style=u'bar', offset=0, step=None) link

ユーザーがデフォルト store の変数の値を調整出来るようにする bar value です。

variable

調整する変数の名前の文字列

range

調整の範囲

max_is_zero

True ならフィールドが 0 の時にこのバーの値は最大となり、それ以外の値では 1 に上がっていきます。これはバーが最大に設定されるか、フィールドが 0 に設定されるかの両方の方法で動作します。

これはいくつかの preferences の内部で使用されています。

style

作成されるバーのスタイル

offset

値に加えられるオフセット

step

バーが変更する量。 None の場合、デフォルトでバーの10分の1です。

XScrollValue(viewport) link

The value of an adjustment that horizontally scrolls the viewport with the given id, on the current screen. The viewport must be defined before a bar with this value is.

YScrollValue(viewport) link

The value of an adjustment that vertically scrolls the viewport with the given id, on the current screen. The viewport must be defined before a bar with this value is.

Input Values link

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

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

DictInputValue(dict, key, default=True, returnable=False) link

dictkey を更新する input value です。

default

True ならこの input はデフォルトで変更可能です。

returnable

True なら、ユーザーがエンターを押すと、この入力の値が返されます。

FieldInputValue(object, field, default=True, returnable=False) link

objectfield を更新する input value です。

field

フィールドの名前の文字列

default

True ならこの input はデフォルトで変更可能です。

returnable

True なら、ユーザーがエンターを押すと、この入力の値が返されます。

FilePageNameInputValue(pattern=u'Page {}', auto=u'Automatic saves', quick=u'Quick saves', page=None, default=False) link

ファイルページの名前を更新する input value です。

pattern

ページのデフォルト名に使用されます。 Python スタイル補完が、 {} がページ番号で置き換えられるように処理されます。

auto

オートセーブページの名前です

quick

クイックセーブページの名前です

page

表示するページの数字です。現在のページを指定するなら None のままにします。

default

True ならこの input はデフォルトで変更可能です。

ScreenVariableInputValue(variable, default=True, returnable=False) link

変数を更新する input value です。

variable

更新する変数の名前の文字列

default

True ならこの input はデフォルトで変更可能です。

returnable

True なら、ユーザーがエンターを押すと、この入力の値が返されます。

VariableInputValue(variable, default=True, returnable=False) link

variable を更新する input value です。

variable

更新する変数の名前の文字列

default

True ならこの input はデフォルトで変更可能です。

returnable

True なら、ユーザーがエンターを押すと、この入力の値が返されます。

関数とクラス link

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

Preferences link

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

Preference(name, value=None, range=None) link

これは設定に適切なアクションや値を構築します。設定の name は標準のメニューで使用される名前であるべきで、値は選択の名前、選択をトグルする「 toggle 」、特定の値のいずれかで、ボタン以外ならばいりません。

button や hotspot で使用されるアクション :

  • Preference("display", "fullscreen") - フルスクリーンモードで表示する。

  • Preference("display", "window") - 1倍のノーマルサイズでウィンドウモードを表示する。

  • Preference("display", 2.0) - 2倍のノーマルサイズでウィンドウモードを表示する。

  • Preference("display", "any window") - 以前のサイズでウィンドウモードを表示します。

  • Preference("display", "toggle") - 表示モードをトグルする。

  • Preference("transitions", "all") - すべてのトランジションを表示する。

  • Preference("transitions", "none") - トランジションを表示しない。

  • Preference("transitions", "toggle") - トランジションの表示をトグルする。

  • Preference("video sprites", "show") - すべてのビデオスプライトを表示する

  • Preference("video sprites", "hide") - 可能ならビデオスプライトを画像で代用します。

  • Preference("video sprites", "toggle") - ビデオスプライトの表示をトグルします。

  • Preference("show empty window", "show") - "window show"、"window auto" ステートメントを許可し、say ステートメント以外の場所で空のウィンドウを表示できるようにします。

  • Preference("show empty window", "hide") - 上の処理を無効化します。

  • Preference("show empty window", "toggle") - 上の処理を切り替えます。

  • Preference("text speed", 0) - テキストを瞬間表示にする

  • Preference("text speed", 142) - テキストの表示スピードを1秒で142文字にする。

  • Preference("joystick") - ジョイスティックの設定を表示する。

  • Preference("skip", "seen") - 既読のメッセージのみスキップする。

  • Preference("skip", "all") - 未読のメッセージもスキップする。

  • Preference("skip", "toggle") - 既読スキップと未読スキップをトグルする。

  • Preference("begin skipping") - スキップを開始する。

  • Preference("after choices", "skip") - 選択肢後もスキップを続ける。

  • Preference("after choices", "stop") - 選択肢後はスキップを停止する。

  • Preference("after choices", "toggle") - 選択肢後のスキップ継続をトグルする。

  • Preference("auto-forward time", 0) - 自動進行の待ち時間を無限大にします。

  • Preference("auto-forward time", 10) - 自動進行の ( 250 文字ごとの ) 待ち時間です。

  • Preference("auto-forward", "enable") - 自動進行を有効化する。

  • Preference("auto-forward", "disable") - 自動進行を無効化する。

  • Preference("auto-forward", "toggle") - 自動進行をトグルする。

  • Preference("auto-forward after click", "enable") - クリック後も自動進行モードを維持します。

  • Preference("auto-forward after click", "disable") - クリック後に自動進行モードを無効化します。

  • Preference("auto-forward after click", "toggle") - クリック後に自動進行を切り替えます。

  • Preference("automatic move", "enable") - マウス自動移動を有効化します。

  • Preference("automatic move", "disable") - マウス自動移動を無効化します。

  • Preference("automatic move", "toggle") - マウス自動移動をトグルします。

  • Preference("wait for voice", "enable") - 現在再生中のボイスが完了するまで自動進行を待機します。

  • reference("wait for voice", "disable") - 現在再生中のボイスの完了を待たずに自動進行を開始します。

  • reference("wait for voice", "toggle") - ボイス待ち状態をトグルします。

  • Preference("voice sustain", "enable") - 現在のインタラクション終了後もボイス再生を継続する。

  • Preference("voice sustain", "enable") - 現在のインタラクションの終了後もボイスを停止しません。

  • Preference("voice sustain", "enable") - インタラクションのボイス停止をトグルします。

  • Preference("music mute", "enable") - ミュージックミキサーをミュートにする。

  • Preference("music mute", "disable") - ミュージックミキサーのミュートを解除する。

  • Preference("music mute", "toggle") - ミュージックのミュートをトグルする。

  • Preference("sound mute", "enable") - 効果音ミキサーをミュートにする。

  • Preference("sound mute", "disable") - 効果音ミキサーのミュートを解除する。

  • Preference("sound mute", "toggle") - 効果音のミュートをトグルする。

  • Preference("voice mute", "enable") - ボイスミキサーをミュートにする。

  • Preference("voice mute", "disable") - ボイスミキサーのミュートを解除する。

  • Preference("voice mute", "toggle") - ボイスミキサーのミュートをトグルする。

  • Preference("mixer <mixer> mute", "enable") - 指定のミキサーをミュートにする。.

  • Preference("mixer <mixer> mute", "disable") - 指定のミキサーのミュートを解除します。

  • Preference("mixer <mixer> mute", "toggle") - 特定のミキサーのミュートをトグルする。

  • Preference("all mute", "enable") - すべてのミキサーをミュートにする。

  • Preference("all mute", "disable") - すべてのミキサーのミュートを解除する。

  • Preference("all mute", "toggle") - すべてのミキサーのミュートをトグルする。

  • Preference("music volume", 0.5) - 曲のボリュームを設定する。

  • Preference("sound volume", 0.5) - 効果音のボリュームを設定する。

  • Preference("voice volume", 0.5) - ボイス音量を設定します。

  • Preference("mixer <mixer> volume", 0.5) - 特定のミキサーのボリュームを設定する。

  • Preference("emphasize audio", "enable") - config.emphasize_audio_channels にあるオーディオチャンネルを強調します。

  • Preference("emphasize audio", "disable") - オーディオチャンネルを強調しません。

  • Preference("emphasize audio", "toggle") - オーディオチャンネルの強調をトグルします。

  • Preference("self voicing", "enable") - 自己発話を有効化します。

  • Preference("self voicing", "disable") - 自己発話を無効化します。

  • Preference("self /voicing", "toggle") - 自己発話をトグルします。

  • Preference("auto-forward", "enable") - 自動進行を有効化する。

  • Preference("clipboard voicing", "disable") - クリップボードボイシングを無効化する。

  • Preference("clipboard voicing", "toggle") - クリップボードボイシングをトグルする。

  • Preference("debug voicing", "enable") - 自己発話のデバッグを有効化します。

  • Preference("debug voicing", "disable") - 自己発話のデバッグを無効化します。

  • Preference("debug voicing", "toggle") - 自己発話のデバッグの有効無効をトグルします。

  • Preference("rollback side", "left") - スクリーンの左側へのタッチでロールバックします。

  • Preference("rollback side", "right") スクリーンの右側へのタッチでロールバックします。

  • Preference("rollback side", "disable") - スクリーンへのタッチでロールバックしません。

バーで使用される value :

  • Preference("text speed")
  • Preference("auto-forward time")
  • Preference("music volume")
  • Preference("sound volume")
  • Preference("voice volume")
  • Preference("mixer <mixer> volume")

range 引数は特定のバーの範囲を指定するために使われます。 "text speed" に対しては、デフォルトで 200 cps です。 "auto-forward time" に対してはデフォルトでテキストの一塊毎に 30.0 秒です。 (これらは最大値になり、デフォルト値にはなりません)

Gamepad link

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

GamepadCalibrate() link

ゲームパッドの構成ルーチンを実施するアクションです。

GamepadExists(developer=True) link

ゲームパッドがあれば True を、そうでなければ False を返す関数です。

developer

config.developer が True である間常に True を返します。

ファイル関数 link

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

FileCurrentPage() link

現在のファイルページを文字列で返します。

FileCurrentScreenshot(empty=None, **properties) link

スクリーンショットがメニューに入るか FileTakeScreenshot() で撮られていれば現在のファイルに保存されるスクリーンショットの displayable です。

現在のスクリーンショットがない場合、その場所に empty を表示します。( empty が None の場合、デフォルトで Null() になります。)

FileJson(name, key=None, empty=None, missing=None, page=None) link

name の Json 情報にアクセスします。

key が None なら全く別の Json 情報を、そのスロットが空なら empty を返します。

そうではなくそのセーブの json オブジェクトで key が定義されていればこれは json[key] を返し、指定された名前のセーブはあるが key をがないなら missing を返し、セーブスロットが空なら empty を返します。

config.save_json_callbacks を使用してコールバックが登録されると、Json がセーブスロットに追加されます。

FileLoadable(name, page=None) link

これはファイルがロード可能であれば True を、それ以外の場合は False を返します。

FileNewest(name, page=None) link

これが最も新しいファイルスロットであれば True を返し、それ以外の場合は False を返します。

FilePageName(auto=u'a', quick=u'q') link

現在のファイルページの名前を文字列で返します。通常のページであればページ数を返し、それ以外であれば autoquick です。

FileSaveName(name, empty=u'', page=None) link

ファイルがセーブされたときの save_name かファイルが存在しなければ empty を返します。

FileScreenshot(name, empty=None, page=None) link

与えられたファイルに関連づけられたスクリーンショットを返します。ファイルがロード不能なとき、None でなければ empty が返され、None であれば Null displayable が作成されます。

返す値は displayable です。

FileSlotName(slot, slots_per_page, auto=u'a', quick=u'q', format=u'%s%d') link

番号付けされたスロットの名前を返します。当然のことですが、通常のページのスロットは 1 から始まる連番で、ページ番号は 1 から始まります。スロットが 2、slots_per_page が 10、その他の変数が既定値の時:

  • 最初のページが表示されていると、これは「2」を返します。

  • 2番目のページが表示されていると、「12」を返します。

  • オートページが表示されていると、「a2」を返します。

  • クイックページが表示されていると、「q2」を返します。

slot

アクセスするスロットの番号

slots_per_page

ページごとのスロット数

auto

オートページ用の接頭辞

quick

クイックページ用の接頭辞

format

フォーマットコードです。これは二つの引数を取ります。 : ページ接頭辞の文字列と、スロット番号の整数です。

FileTime(name, format=u'%b %d, %H:%M', empty=u'', page=None) link

ファイルがセーブされた時間を、与えられた format に適用して返します。ファイルが見つからなければ、 empty が返されます。

返される値は文字列です。

FileUsedSlots(page=None, highest_first=True) link

そのページの使用済みファイルスロットのリストを返します。

page

探索されるページの名前です。 None の場合は現在のページが使用されます。

highest_first

True の場合、数字の大きなファイルスロットから最初にリストアップされます。そうでなけらば小さな数字のスロットから最初にリストアップされます。

サイドイメージ関数 link

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

SideImage() link

現在話しているキャラクターに関連づけられたサイドイメージか、そのようなサイドイメージが存在しない場合は Null displayable を返します。

Tooltip link

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

class Tooltip(default) link

Tooltip オブジェクトはマウスがあるエリアに入ると更新されるスクリーンの一部を定義するために使用されます。

Tooltip オブジェクトは value フィールドを持ち、これは Tooltip アクションが作成されるときにコンストラクターに渡される default の値に設定されます。Tooltip により作成されたアクションを使用するボタンにマウスが入ると、 value フィールドはその Action に関連づけられた値に変わります。

Action(value) link

通常ボタンの hovered プロパティーに使用されるアクションを返します。そのボタンがフォーカスを持つと、この Tooltip の value フィールドは value に設定されます。ボタンがフォーカスを失うとこの Tooltip の value フィールドはデフォルトに戻ります。

スクリーンで 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