ファイルアクセス

これらの Python 関数を使用すると、ゲームディレクトリーにあるファイルリソース、RPA アーカイブ、Android のリソースにアクセスできます。

renpy.file(fn, encoding=None)

renpy.open_file() のエイリアスで、古いバージョンの Ren'Py との互換性のためのものです。

renpy.list_files(common=False)

ゲームディレクトリーとアーカイブ内のファイルをリストアップします。ディレクトリーの区切りとして / を使用し、ファイルのリストを返します。

common

True なら、 common ディレクトリーのファイルもリストに含まれます。

renpy.loadable(filename, directory=None, tl=True)

指定されたファイル名がロード可能、つまりそれがディスクかアーカイブ内からロード可能なら True を返します。それ以外の場合 False を返します。

directory

None または game ディレクトリで見つからなかったときにそのファイルを探すディレクトリーです。これをファイル名の先頭に追加して再検索します。

tl

True なら、翻訳サブディレクトリーも同様に考慮されます。

renpy.open_file(fn, encoding=None, directory=None)

fn ファイルにアクセスする、読み込み専用のファイル風オブジェクトを返します。ファイルには Ren'Py の標準検索メソッドによってアクセスするので、 RPA アーカイブの中身や Android アセット、 game ディレクトリにアクセスできます。

オブジェクトはバイナリモードで開かれた時の python 標準のファイルオブジェクトにあるフィールドやメソッドの広範なサブセットをサポートします ( 基本的には読み込み専用ファイルで有効なメソッドの全てです )。

encoding

指定されると、ファイルは指定のエンコードのテキストモードでファイルが開かれます。デフォルトでは None であり、 config.open_file_encoding のエンコーディングが使用されます。 False ならファイルはバイナリモードで開かれます。

directory

None または game ディレクトリで見つからなかったときにそのファイルを探すディレクトリーです。これをファイル名の先頭に追加して再検索します。

encoding が None の場合、これはio.BufferedReader オブジェクト を返します。 encoding が None でない場合、io.TextIOWrapper オブジェクトを返します。

稀に使用される関数

これらの関数は稀に使用されます。

renpy.exists(filename)

サーチパスに指定されたファイル名が見付かれば True を返します。これはディスク上に物理ファイルが存在するときだけ動作し、アーカイブ内にある場合は発見出来ません。

ほとんどの場合この関数より renpy.loadable() を使用した方がよいでしょう。

renpy.fsdecode(s)

ファイルシステムのエンコードから Unicode に変換します。

renpy.fsencode(s, force=False)

Unicode からファイルシステムのエンコードに変換します。

renpy.image_size(im)

イメージマニュピレーターを受け取り、ロードして、そのサイズのタプル (width, height) を返します。

これは画像のキャッシュを利用せずに、画像をディスクから読み込んで展開するため、動作が遅くなりがちです。