Ren'Py にはスクリーンやスクリーン言語での使用を意図したいくつかのアクション、値、関数があります。
アクションは ( imagebutton、textbutton、hotspot のような ) ボタンが押されるか、その上にマウスが出入りすると実行されます。アクションはボタンの有効無効も決定出来ます。
これらのアクション同様に、アクションには引数を取らない関数も使えます。関数はアクションが実行されると呼び出されます。アクションが値を返すと、その値がインタラクションから返されます。
アクションはアクションのリストであってもよいです。その場合、そのリストのアクションが順番に実行されます。
これらはスクリーンや インタラクションの結果、フロー制御を管理するアクションです。
Call(label, *args, **kwargs) link現在のステートメントを終了して label を呼び出します。引数とキーワード引数は renpy.call() に渡されます。
Hide(screen, transition=None, _layer=None) linkscreen と名付けられたスクリーンがもし表示されていれば非表示にします。
None でなければスクリーンを非表示にするときにトランジションが使用されます。
layer 引数として renpy.hide_screen() に渡されます。
Jump(label) link制御を label に移します。
NullAction(*args, **kwargs) link何もしません。
ボタンの hover/unhover イベントに対する反応として、実際には何もしない時に使用されます。
Return(value=None) linkNone でなければ、現在のインタラクションが与えられた value を返すようにします。これはしばしば menu や imagemap で使用してインタラクションから返される値を選択します。スクリーンが call screen ステートメントで呼び出されると、返り値は _return 変数に配置されます。
menu ではこれで menu から戻ります(この場合値は None であるべきです)。
Show(screen, transition=None, *args, **kwargs) link他のスクリーンを表示します。 screen は表示するスクリーンを表す文字列であり、引数はそのスクリーンに渡されます。
None でなければ transition が新しいスクリーンを表示するために使用されます。
ShowTransient(screen, transition=None, *args, **kwargs) link一時的なスクリーンを表示します。一時的なスクリーンは現在のインタラクションが完了すると非表示になります。引数は表示されるスクリーンに渡されます。
None でなければ transition が新しいスクリーンを表示するために使用されます。
ToggleScreen(screen, transition=None, *args, **kwargs) linkscreen の表示をトグルします。現在表示されていなければ、スクリーンは与えられた引数で呼び出され、そうでなければ非表示になります。
None でなければ transition がスクリーンを表示または非表示するのに使用されます。
これらはデータを設定またトグルします。
AddToSet(set, value) linkvalue を set に追加します。
追加される set です。これは python の set またはリストで、 value がそれに追加されます。
追加または削除される値です。
RemoveFromSet(set, value) linkset から value を除去します。
これは set または リストです。
削除される値です。
SetDict(dict, key, value) linkdict の key の値を value に設定します。
SetField(object, field, value) linkオブジェクトのフィールドを与えられた値に設定します。 object にはオブジェクト、 field には設定するフィールドの名前の文字列、 value には設定したい値を入れます。
SetLocalVariable(name, value) link現在のローカルコンテキストで変数 name を value に設定します。
この関数は使用されるスクリーン内の変数を設定できるので、そのスクリーンが他のシーンで使用されている場合のみ有用です。そうでない場合は、 SetScreenVariable() がより有用です。
これはその変数が設定されるコンテキストで作成される必要があり、他からは渡せません。
SetScreenVariable(name, value) link現在のスクリーンに関連づけられた name の変数を value に設定します。
SetVariable(name, value) link変数 name を value に設定します。
name 引数は文字列でなければならず、 "strength" のような単純な名前や "hero.strength" や "persistent.show_cutscenes" のようなフィールドからドットで分けられた変数のような名前が可能です。
ToggleDict(dict, key, true_value=None, false_value=None) linkdict の key の値をトグルします。トグルとはアクションが実行されると、値が True が False に、 False が True になるということです。
None を指定するか、 True として使用する値を指定します。
None を指定するか、 False として使用する値を指定します。
ToggleField(object, field, true_value=None, false_value=None) linkobject の field をトグルします。トグルとは、アクション実行時にそのフィールドの真偽値を反転することです。
None を指定するか、 True として使用する値を指定します。
None を指定するか False として使用する値を指定します。
ToggleLocalVariable(name, true_value=None, false_value=None) link現在のローカルコンテキストでの name の値をトグルします。
この関数は使用されるスクリーン内の変数を設定できるので、そのスクリーンが他のシーンで使用されている場合のみ有用です。そうでない場合は、 ToggleScreenVariable() がより有用です。
これはその変数が設定されるコンテキストで作成される必要があり、他からは渡せません。
None を指定するか、 True として使用する値を指定します。
None を指定するか、 False として使用する値を指定します。
ToggleScreenVariable(name, true_value=None, false_value=None) link現在のスクリーンの name と名付けられた変数の値をトグルします。
None を指定するか、 True として使用する値を指定します。
None を指定するか、 False として使用する値を指定します。
ToggleSetMembership(set, value) linkset から value をトグルします。値が set になければ追加され、そうでなければ削除されます。
このアクションを持つボタンはその set にその値があるときのみ選択状態としてマークされます。
追加する set です。これは python の set またはリストで、値がそれに付け加えられます。
追加または削除される値です。
ToggleVariable(variable, true_value=None, false_value=None) linkvariable をトグルします。
variable 引数は文字列でなければならず、 "strength" のような単純な名前や "hero.strength" や "persistent.show_cutscenes" のようなフィールドからドットで分けられた変数のような名前が可能です。
None を指定するか、 True として使用する値を指定します。
None を指定するか、 False として使用する値を指定します。
これらのアクションはセーブ、ロード、ファイルの削除を扱い、多くは name や page 引数を取ります。
セーブするファイルの名前。これは文字列か整数です。ファイルの名前を作成するために pageと結合されます。
このアクションが動作するページです。これは「 auto 」、「 quick 」、正の整数のいずれかです。 None の場合、 persistent._file_page に基づき自動的に決定されます。
FileAction(name, page=None, **kwargs) linkそのファイルを「 適切に扱います」。これはつまり load スクリーンが表示されていれば (現在のスクリーン名が 「load」 なら ) ファイルをロードし、そうでなければファイルにセーブするということです。
セーブまたはロードするスロット名です。 None なら未使用 ( 現在時刻を元にした大きな数字の ) スロットが使用されます。
セーブまたはロードされるファイルのページです。 None の場合、現在のページが使用されます。
その他のキーワード引数は FileLoad, FileSave に渡されます。
FileDelete(name, confirm=True, page=None, slot=False) linkファイルを削除します。
削除するスロットの名前
True かつメインメニューでなければ、ファイルロード前に確認のためのプロントが表示されます。
ファイルがロードされるページです。 None の場合、現在のページが使用されます。
True なら page は無視され、 name はスロット名となります。
FileLoad(name, confirm=True, page=None, newest=True, cycle=False, slot=False) linkファイルをロードします。
ロードするスロットの名前です。 None の場合、ロードできない未使用のスロットが使用され、そのためそのファイルはロード不可です。
True かつメインメニューでなければ、ファイルロード前に確認のためのプロントが表示されます。
ファイルがロードされるページです。 None の場合、現在のページが使用されます。
True で、これが最新のファイルであれば選択状態になります。
無視されます。
True なら page は無視され、 name はスロット名となります。
FilePage(page) linkページを page に設定します。「 auto 」、 「 quick 」、整数のいずれかです。
FilePageNext(max=None, wrap=False, auto=True, quick=True) link次のファイルページに移動します。
設定する場合は、移動可能なファイルページの最大数を与える整数にします。
True のとき、max が設定されていて最後のファイルページにいるときに最初のページに戻ります。
True かつ wrap が設定されていれば、自動セーブのページに移動します。
True かつ wrap が設定されていれば、自動セーブのページに移動します。
FileSave(name, confirm=True, newest=True, page=None, cycle=False, slot=False) linkファイルにセーブします。
このスロットのボタンが最新のセーブファイルとしてマークされていれば選択状態になります。
セーブするスロット名です。 None なら未使用 ( 現在時刻を元にした大きな数字の ) スロットが使用されます。
True の場合、ファイルを上書きする前に確認します。
無視されます。
スロットのあるページの名前です。 None の場合は現在のページが使用されます。
True の場合、提供されたページのセーブはユーザーに表示される前に一回りします。 config.quicksave_slots が回すときに使用されます。
True なら page は無視され、 name はスロット名となります。
FileTakeScreenshot(*args, **kwargs) linkセーブ時に使用されるスクリーンショットを撮ります。これはセーブスクリーンが表示される前のスクリーンを撮り、スクリーンショットが正しいことを保証するために使用されます。
QuickLoad(confirm=True) linkクイックロードを処理します。
True かつメインメニューでなければ、ファイルロード前に確認のためのプロントが表示されます。
QuickSave(message=u'Quick save complete.', newest=False) linkクイックセーブを処理します。
クイックセーブが終了するとユーザーに表示されるメッセージです。
最新のセーブとしてクイックセーブをマークする場合は True に設定します。
PauseAudio(channel, value=True) linkchannel のポーズフラグを設定します。
value が True なら、そのチャンネルはポーズされます。 False なら、そのチャンネルはポーズ解除されます。 "toggle" なら、パーズフラグはトグルされます。
Play(channel, file, selected=None, **kwargs) linkオーディオファイルを与えられたチャンネルで再生します。
サウンドを再生するチャンネル
再生するファイル
True なら、このアクションを使用するボタンはそのファイルがそのチャンネルで再生中なら選択状態とマークされます。 False ならこのアクションはボタンに再生を開始させません。 None ならボタンはそのチャンネルが music チャンネルなら選択状態になります。
すべての他のキーワード引数は renpy.music.play() に渡されます。
Queue(channel, file, **kwargs) linkオーディオファイルを与えられたチャンネルにキューします。
サウンドを再生するチャンネル
再生するファイル
すべてのキーワード引数は renpy.music.queue() に渡されます。
SetMixer(mixer, volume) linkmixer の音量を value に設定します。
音量を設定するミキサーです。文字列で、通常は 「music」か 「sfx」、「voice」
音量を背呈する値です。 0.0 から 1.0 の間の数字を含みます。
SetMute(mixer, mute) linkひとつ以上のミキサーのミュート状態を設定します。ミキサーがミュートなら、そのミキサーと関連するオーディオチャンネルはオーディオの再生を停止します。
ミキサー名の文字列か、文字列のリストです。文字列はミキサー名で、通常 "music", "sfx", または "voice" です。
True ならミキサーをミュートにし、 False ならミュートを解除します。
Stop(channel, **kwargs) linkオーディオチャンネルを停止します。
再生を停止するチャンネル
その他のキーワード引数は renpy.music.stop() に渡されます。
ToggleMute(mixer) linkひとつ以上のミキサーのミュート状態をトグルします。
ミキサー名の文字列か、文字列のリストです。文字列はミキサー名で、通常 "music", "sfx", または "voice" です。
他に分類されないその他のアクションがあります。
Confirm(prompt, yes, no=None, confirm_selected=False) linkユーザーにアクションの確認を促します。ユーザーが yes をクリックすると、 yes アクションが実行され、そうでなければ no アクションが実行されます。
ユーザーに表示するプロンプトです。
True なら、 yes アクションがすでに選択されていてもプロンプトは表示されます。 False (デフォルト)なら、 yes アクションが選択されていればプロンプトは表示されません。
アクションの有効選択状態は yes アクションのそれらに合致します。
DisableAllInputValues() linkすべての有効な InputValue を無効化します。これでデフォルトの InputValue があれば、フォーカスが戻ります。そうでなければ、 InputValue にはフォーカスされません。
Function(callable, *args, **kwargs) linkこのアクションは callable を args と kwargs を引数に呼び出します。
呼び出し可能オブジェクト
位置引数は callable に渡されます。
キーワード引数は callable に渡されます。
このアクションは任意で _update_screens キーワード引数を取り、これはデフォルトでは True になります。 True ならインテラクションは再開し、スクリーンは関数から処理が返された後更新されます。
関数が None 以外を返すと、インタラクションは停止し、その値を返します( call screen ステートメントで呼び出されると、その結果は _return 変数に配置されます)。
Help(help=None) linkヘルプを表示します。
help という名のスクリーンが定義されていれば、そのスクリーンは ShowMenu() を使用して表示され help は無視されます。
help を探すための文字列です。これは以下の方法で使用します。 :
この名前のラベルが存在したら、そのラベルは新しコンテキストで呼び出されます。
そうでなければ、これはブラウザーで開くべきファイル名として解釈されます。
help が None なら、 config.help がデフォルトの値として使用されます。
HideInterface(*args, **kwargs) linkインターフェースをユーザーがクリックするまで非表示にします。
If(expression, true=None, false=None) linkexpression が True の場合は true を返し、そうでなければ false を返します。 expression に基づいてアクションを選択するにはこれを使用してください。デフォルトでは None はボタンを無効化するアクションとして使用可能なことに気をつけてください。
InvertSelected(action) link与えられたアクションの選択状態を反転し、それ以外のメソッドはそのままにします。
MouseMove(x, y, duration=0) linkマウスポインターを x, y に移動します。デバイスがマウスポインターをサポートしないか _preferences.mouse_move が False ならこれは何もしません。
移動処理にかける秒数です。この時間の間はマウスが反応しません。
Notify(message) linkrenpy.notify() を使用して message を表示します。
OpenURL(url) linkurl をウェブブラウザーで開きます。
QueueEvent(event, up=False) link指定されたイベントを renpy.queue_event() を使用してキューします。
RestartStatement(*args, **kwargs) linkこのアクションは Ren'Py を現在のステートメント以前にロールバックし、現在ステートメントをやりなおします。永続データの変更がそのステートメントによる表示に影響を与えるときこれは使われるでしょう。
メニューコンテキストで実行されると、プレイヤーがトップレベルコンテキストに戻るまでロールバックを待ちます。
RollForward(*args, **kwargs) linkロールフォワードが可能な場合、ロールフォワードを実行します。そうでなければ無効です。
Rollback(*args, **kwargs) linkロールバックが可能な場合、ロールバックを実行します。そうでなけれ何も起こりません。
"menu" への force 引数を除き、引数は renpy.rollback() に与えられます。
RollbackToIdentifier(identifier) linkidentifier へのロールバックを実行します。ロールバック identifier は HistoryEntry オブジェクトの一部として返されます。
Screenshot(*args, **kwargs) linkスクリーンショットを撮ります。
Scroll(id, direction, amount=u'step') linkbar や viewport, vpgrid をスクロールします。
現在のスクリーンの bar や viewport, vpgrid の id です。
vbar に対しては "increase" または "decrease" のどれかです。 viewport や vpgrid に対しては "horizontal increase", "vertical increase", "horizontal decrease", "vertical decrease" のいずれかです。
スクロール量です。これはピクセル数または "step", "page" です。
SelectedIf(expression) linkこれはアクションリストでボタンが選択中かの判定に使用されるアクションを明示します。これは次のようにボタンがアクションリストを持つときのみ意味を持ちます。
# The button is selected only if mars_flag is True
textbutton "Marsopolis":
action [ SelectedIf(SetVariable("mars_flag", True)), SetVariable("on_mars", True) ]
Selectedif ないのアクションは通常ボタンがクリックされると実行されます。
SensitiveIf(expression) linkこれはアクションリストでボタンが有効かの判定に使用されるアクションを明示します。これは次のようにボタンがアクションリストを持つときのみ意味を持ちます。
# The button is sensitive only if mars_flag is True
textbutton "Marsopolis":
action [ SensitiveIf(SetVariable("mars_flag", True)), SetVariable("on_mars", True) ]
Sensitiveif 内のアクションは通常ボタンがクリックされると実行されます。
Skip(fast=False, confirm=False) linkゲームのスキップを開始します。 menu コンテキストの内部にいる場合はゲームに戻ってから開始し、それ以外の場合は単にスキップを開始します。
True なら次の選択肢まで直接スキップします。
True ならスキップを開始する前に確認します。
With(transition) linktransition を実行します。
Bar Value はバーに使用してバーの値を設定し、バーがプロパティーを調整できるようにします。新しい bar value を作成するには BarValue サブクラスを作成します。 step キーワードを持つすべてのクラスは ui.adjustment() で記述されたように振る舞う force_step キーワードも受け取ります。
AnimatedValue(value=0.0, range=1.0, delay=1.0, old_value=None) linkこれはアニメーション用の value で、 delay 秒かけて old_value から value に変化します。
値の数字です。
値の範囲の数字です。
value をアニメーションするための秒数で、デフォルトでは 1.0 です。
元の値です。これが None であれば、値は置き換えた AnimatedValue から受け取られます。それ以外の場合は value に初期化されます。
AudioPositionValue(channel=u'music', update_interval=0.1) linkchannel で再生しているオーディオファイルの再生位置を示す値です。
しばしば値は秒毎に更新されます。
DictValue(dict, key, range, max_is_zero=False, style=u'bar', offset=0, step=None, action=None, force_step=False) linkユーザーが辞書のキーの値を調整出来るようにする value です。
辞書
キー
調整の範囲
True ならキーの値が 0 の時にこのバーの値は最大となり、それ以外の値では 1 に上がっていきます。これはバーが最大に設定されるか、キーの値が 0 に設定されるかの両方の方法で動作します。
作成されるバーのスタイル
値に加えられるオフセット
バーが変更する量。 None の場合、デフォルトでバーの10分の1です。
None でなければ field が変更されたとき呼び出されるアクションです。
FieldValue(object, field, range, max_is_zero=False, style=u'bar', offset=0, step=None, action=None, force_step=False) linkユーザーがオブジェクトのフィールドの値を調整できるようにする bar value です。
オブジェクト
フィールドの文字列
調整の範囲
True ならフィールドが 0 の時にこのバーの値は最大となり、それ以外の値では 1 に上がっていきます。これはバーが最大に設定されるか、フィールドが 0 に設定されるかの両方の方法で動作します。
これはいくつかの preferences の内部で使用されています。
作成されるバーのスタイル
値に加えられるオフセット
バーが変更する量。 None の場合、デフォルトでバーの10分の1です。
None でなければ field が変更されたとき呼び出されるアクションです。
MixerValue(mixer) linkオーディオミキサーの value です。
調整するミキサーの名前です。これは通常 「music」か「sfx」、「voice」ですが、ユーザーは新しいミキサーを作成できます。
ScreenVariableValue(variable, range, max_is_zero=False, style=u'bar', offset=0, step=None, action=None, force_step=False) linkスクリーン変数の値を調整する bar valueです。
調整する変数の名前の文字列
調整の範囲
True ならフィールドが 0 の時にこのバーの値は最大となり、それ以外の値では 1 に上がっていきます。これはバーが最大に設定されるか、フィールドが 0 に設定されるかの両方の方法で動作します。
これはいくつかの preferences の内部で使用されています。
作成されるバーのスタイル
値に加えられるオフセット
バーが変更する量。 None の場合、デフォルトでバーの10分の1です。
None でなければ field が変更されたとき呼び出されるアクションです。
StaticValue(value=0.0, range=1.0) link指定した値に固定します。
値の数字です。
値の範囲
VariableValue(variable, range, max_is_zero=False, style=u'bar', offset=0, step=None, action=None, force_step=False) linkユーザーがデフォルト store の変数の値を調整出来るようにする bar value です。
調整する変数の名前の文字列
調整の範囲
True ならフィールドが 0 の時にこのバーの値は最大となり、それ以外の値では 1 に上がっていきます。これはバーが最大に設定されるか、フィールドが 0 に設定されるかの両方の方法で動作します。
これはいくつかの preferences の内部で使用されています。
作成されるバーのスタイル
値に加えられるオフセット
バーが変更する量。 None の場合、デフォルトでバーの10分の1です。
None でなければ field が変更されたとき呼び出されるアクションです。
XScrollValue(viewport) link現在のスクリーンの指定された id の viewport の水平方向スクロールを調整する value です。その viewport はこの value のバーの定義前に定義されなければいけません。
YScrollValue(viewport) link現在のスクリーンの指定された id の viewport の垂直方向スクロールを調整する value です。その viewport はこの value のバーの定義前に定義されなければいけません。
Input Value はテキスト入力で使用され、デフォルトのテキストを設定し、テキストの変更を受け付け、エンターキーに反応し、テキストがデフォルトで編集可能かどうか設定します。新しい input value を作成するには InputValue のサブクラスを作成してください。
Ren'Py 定義の input value は InputValue を継承していて、すべての value は編集を有効、無効、トグルするアクションを返す Enable(), Disable(), Toggle() メソッドを含んでいます。 DisableAllInputValues() アクションも参照してください。
DictInputValue(dict, key, default=True, returnable=False) linkdict の key を更新する input value です。
True ならこの input はデフォルトで変更可能です。
True なら、ユーザーがエンターを押すと、この入力の値が返されます。
FieldInputValue(object, field, default=True, returnable=False) linkobject の field を更新する input value です。
フィールドの名前の文字列
True ならこの input はデフォルトで変更可能です。
True なら、ユーザーがエンターを押すと、この入力の値が返されます。
FilePageNameInputValue(pattern=u'Page {}', auto=u'Automatic saves', quick=u'Quick saves', page=None, default=False) linkファイルページの名前を更新する input value です。
ページのデフォルト名に使用されます。 Python スタイル置換で処理され、 {} がページ番号で置き換えられます。
オートセーブページの名前です
クイックセーブページの名前です
表示するページの数字です。現在のページを指定するなら None のままにします。
True ならこの input はデフォルトで変更可能です。
ScreenVariableInputValue(variable, default=True, returnable=False) link変数を更新する input value です。
更新する変数の名前の文字列
True ならこの input はデフォルトで変更可能です。
True なら、ユーザーがエンターを押すと、この入力の値が返されます。
VariableInputValue(variable, default=True, returnable=False) linkvariable を更新する input value です。
更新する変数の名前の文字列
True ならこの input はデフォルトで変更可能です。
True なら、ユーザーがエンターを押すと、この入力の値が返されます。
これらの関数やクラスはスクリーンと連携させると便利です。
すべての 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("self voicing volume drop", 0.5) - ボイス以外のミキサー音量を自己発話有効時下げます。
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") - スクリーンへのタッチでロールバックしません。
Preference("gl powersave", True) - 電力節約のため、フレームレートを低下させます。
Preference("gl powersave", False) - 電力節約のため、フレームレートを低下させません。
Preference("gl powersave", "auto") - バッテリー動作時、電力を節約します。
Preference("gl framerate", None) - ディスプレイのフレームレートで実行します。
Preference("gl framerate", 60) - 指定したフレームレートで実行します。
Preference("gl tearing", True) - フレームをスキップせずテアリングを発生させます。
Preference("gl tearing", False) - フレームをスキップしてテアリングを防ぎます。
Preference("font transform", "opendyslexic") - ゲーム内のフォントを opendyslexic に設定します。
Preference("font transform", "dejavusans") -ゲーム内のフォントを dejavusans に設定します。
Preference("font transform", None) - ゲーム内のフォントを無効にします。
Preference("font size", 1.0) - ゲーム内のフォントのサイズのスケーリング率を設定します。
Preference("font line spacing", 1.0) - ゲーム内のフォントの行間スペースのスケーリング率を設定します。
Preference("system cursor", "enable") - config.mouse を無視してシステムカーソルを使用します。
Preference("system cursor", "disable") - config.mouse で定義したカーソルを使用します。
Preference("system cursor", "toggle") - システムカーソルの設定をトグルします。
バーで使用される value :
range 引数は特定のバーの範囲を指定するために使われます。 "text speed" に対しては、デフォルトで 200 cps です。 "auto-forward time" に対してはデフォルトでテキストの一塊毎に 30.0 秒です (これらは最大値になり、デフォルト値にはなりません)。
GetCharacterVolume(voice_tag) linkボイスタグに関連付けられたボリュームを、 voice チャンネル用のミキサーボリュームの音量に対する割合として0.0から1.0の数値で返します。
これらの関数とアクションはゲームパッドで動作します。
GamepadCalibrate() linkゲームパッドの構成ルーチンを実施するアクションです。
GamepadExists(developer=True) linkゲームパッドがあれば True を、そうでなければ False を返す関数です。
config.developer が True である間常に True を返します。
これらの関数は通常ファイルについての情報を返し、ファイルアクション同様のデフォルトページを使用します。
FileCurrentPage() link現在のファイルページを文字列で返します。
FileCurrentScreenshot(empty=None, **properties) linkスクリーンショットがメニューに入るか FileTakeScreenshot() で撮られていれば現在のファイルに保存されるスクリーンショットの displayable です。
現在のスクリーンショットがない場合、その場所に empty を表示します。( empty が None の場合、デフォルトで Null() になります。)
FileJson(name, key=None, empty=None, missing=None, page=None, slot=False) linkname の Json 情報にアクセスします。
key が None なら全く別の Json 情報を、そのスロットが空なら empty を返します。
そうではなくそのセーブの json オブジェクトで key が定義されていればこれは json[key] を返し、指定された名前のセーブはあるが key をがないなら missing を返し、セーブスロットが空なら empty を返します。
config.save_json_callbacks を使用してコールバックが登録されると、Json がセーブスロットに追加されます。
FileLoadable(name, page=None, slot=False) linkこれはファイルがロード可能であれば True を、それ以外の場合は False を返します。
FileNewest(name, page=None, slot=False) linkこれが最も新しいファイルスロットであれば True を返し、それ以外の場合は False を返します。
FilePageName(auto=u'a', quick=u'q') link現在のファイルページの名前を文字列で返します。通常のページであればページ数を返し、それ以外であれば auto か quick です。
FileSaveName(name, empty=u'', page=None, slot=False) linkファイルがセーブされたときの save_name かファイルが存在しなければ empty を返します。
FileScreenshot(name, empty=None, page=None, slot=False) 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」を返します。
アクセスするスロットの番号
ページごとのスロット数
オートページ用の接頭辞
クイックページ用の接頭辞
フォーマットコードです。これは二つの引数を取ります。 : ページ接頭辞の文字列と、スロット番号の整数です。
FileTime(name, format=u'%b %d, %H:%M', empty=u'', page=None, slot=False) linkファイルがセーブされた時間を、与えられた format に適用して返します。ファイルが見つからなければ、 empty が返されます。
返される値は文字列です。
FileUsedSlots(page=None, highest_first=True) linkそのページの使用済みファイルスロットのリストを返します。
探索されるページの名前です。 None の場合は現在のページが使用されます。
True の場合、数字の大きなファイルスロットから最初にリストアップされます。そうでなけらば小さな数字のスロットから最初にリストアップされます。
この関数は使用するサイドイメージを返します。
SideImage() link現在話しているキャラクターに対応するサイドイメージか、そのようなサイドイメージが存在しない場合は Null displayable を返します。
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]"
GetTooltip(screen=None) link現在フォーカスを持つ displayable のツールチップを返し、フォーカスを持つ displayable がなければ None を返します。
None またはスクリーンの名前かタグです。指定されると、フォーカスを持つ displayable がそのスクリーンの一部であるときのみツールチップを返します。
警告
これらは上述のものより旧来のものです。古いプロジェクトで見かけるでしょう。
Tooltip クラスはあるボタンの上にマウスが入ると、スクリーンを変更します。
Tooltip(default) linkTooltip オブジェクトはマウスがあるエリアに入ると更新されるスクリーンの一部を定義するために使用されます。
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