To allow Ren'Py to be scripted in python, each Ren'Py statement has a Python equivalent. This usually consists of a Python function, but may also consist of a pattern of Python calls that perform an action equivalent to the statement.
Ren'Py の say ステートメントはキャラクターオブジェクトを関数として呼び出すことと等価です。次は、同じ行を2回表示させるコードです
e "Hello, world."
$ e("Hello, world.")
Displaying narration can be done the same way, by using the
narrator character. When calling a character, it's possible to
supply the keyword argument interact. When interact is false,
Ren'Py will display the character dialogue box, and will then
return before performing an interaction.
This equivalence of characters and function objects works in the other direction as well. It is possible to declare a python function, and then use that function in the place of a character object. For example, the following function uses a variable to choose between two characters.
define lucy_normal = Character("Lucy")
define lucy_evil = Character("Evil Lucy")
init python:
def l(what, **kwargs):
if lucy_is_evil:
lucy_evil(what, **kwargs)
else:
lucy_normal(what, **kwargs)
label start:
$ lucy_is_evil = False
l "Usually, I feel quite normal."
$ lucy_is_evil = True
l "But sometimes, I get really mad!"
このように使用された関数は未知のキーワード引数を無視するか、 キャラクター関数に渡します。このことでゲームは Ren'Py が追加のキーワード引数をキャラクター呼び出しに加えても動作し続けます。
renpy.say(who, what, *args, **kwargs) linksay ステートメントと等価です。
発言するキャラクターか、キャラクター名の文字列です。 None ならナレーターが使用されます。文字列なら say() を使用して発言するキャラクターが作成されます。
発言する文字列です。 % 置換文字列はこの文字列で使用されます。
次の3行が等価なためこの関数は滅多に必要ありません。 :
e "Hello, world."
$ renpy.say(e, "Hello, world.")
$ e("Hello, world.")
The image, scene, show, and hide statements each have an equivalent python function.
renpy.get_at_list(name, layer=None) linklayer 上の name タグの画像に適用されている変換のリストを返します。変換が適用されていなければ空のリストを返し、画像が表示されていなければ None 返します。
layer が None なら、指定されたタグのデフォルトレイヤーを使用します。
renpy.hide(name, layer=None) linkレイヤーから画像を非表示します。 hide ステートメントと等価な python です。
非表示する画像の名前です。画像タグのみが使用され、そのタグのすべての画像が非表示されます。(正確な画像名は必要ありません。)
この関数が処理するレイヤーです。None ならタグのデフォルトレイヤーを使用します。
renpy.image(name, d) link画像を定義する。この関数は image ステートメントと等価な python です。
表示する画像の名前で、文字列です。
その画像名に関連付けられる displayable
この関数は init ブロック内でのみ実行されます。一旦ゲームが実行されてからこの関数が実行されると、エラーになります。
renpy.scene(layer='master') linklayer からすべての displayable を除去します。これは表示する画像が与えられない時の scene ステートメントと等価です。
scene ステートメントは renpy.scene に続いて renpy.show() を呼び出すことと等価です。例えば
scene bg beach
これは次と等価です:
$ renpy.scene()
$ renpy.show("bg beach")
renpy.show(name, at_list=, []layer='master', what=None, zorder=0, tag=None, behind=[]) linkレイヤーに画像を表示します。これは show ステートメントとプログラム的に等価です。
表示する画像の名前で、文字列です。
画像に適用される変換のリストです。 at プロパティーと等価です。
画像が表示されるレイヤーの名前の文字列です。 onlayer と等価です。None ならそのタグに関連付けられたデフォルトレイヤーを使用します。
None でないならこれは画像を 探す代わりに表示される displayable です。 ( これは show expression ステートメントと等価です。 ) what 引数が与えられると、 name はその画像とタグを関連づけるために使用されます。
zorder プロパティーと等価な整数です。 None だと zorder があれば維持され、そうでなければ 0 に設定されます。
表示される画像の画像タグを指定するために使用される文字列です。 as プロパティーと等価です。
この画像が背後に表示される画像タグの文字列のリストです。 behind プロパティーと等価です。
renpy.show_layer_at(at_list, layer='master', reset=True) linkshow layer layer at at_list ステートメントの Python による書き方です。
The equivalent of the with statement is the renpy.with_statement function.
renpy.with_statement(trans, always=False) linkトランジションを実行します。これは with ステートメントと等価な python です。
トランジション
True なら、トランジションはユーザーがトランジションを無効化していても常に実行します。
この関数はユーザーがトランジションの中断を選択するなら True を、そうでないなら False を返します。
The equivalent of the jump statement is the renpy.jump function.
renpy.jump(label) link現在のステートメントを終了し、制御を指定されたラベルに移します。
The equivalent of the call statement is the renpy.call function.
renpy.call(label, *args, **kwargs) link現在の Ren'Py ステートメントを終了し、指定された label にジャンプします。ジャンプから戻ると、現在のステートメントに続くステートメントに制御が移ります。
renpy.return_statement() link現在の Ren'Py の呼び出しレベルから Ren'Py を返します。