TOP/拡張スクリプト/Searcher.Entry クラス

Searcher.Entry クラス

概要

BMX2WAV Searcher でのエントリ(一覧中の項目1つ)対するクラスになります。

静的関数

compare( entry_x, entry_y ) -> integer

entry_xentry_y は Searcher.Entry インスタンスです。 entry_xentry_y を比較してその結果を integer で返します。 エントリをソートする際に使用するとファイル等を見つけた順番で並び替える事ができます。

プロパティ

is_file -> boolean

エントリがファイルかどうかの真偽値です。

is_directory -> boolean

エントリがディレクトリかどうかの真偽値です。

path -> string

エントリの絶対パスです。

display_name -> string

エントリを表示する際に使用する文字列です。

type_name -> string

エントリのファイルタイプの文字列です。

bms_data -> [BmsData | null]

エントリに結びついている BmsData インスタンスです。 未だ BMS を構文解析していない場合は null になります。

search_hit -> boolean

エントリが検索ヒットしたかどうかの真偽値です。 検索実行時にこの値を設定し直すと、 BMX2WAV Searcher の検索結果が変化します。

関数

parse_as_bms_data()

プロパティ path で示されるファイルを BMS ファイルと見なして構文解析して、結果の BmsData インスタンスを プロパティ bms_data にセットします。 既に BMS が読み込み済みで bms_data が null でない場合でも構文解析します。

parse_as_bms_data_once()

プロパティ bms_data が null の場合関数 parse_as_bms_data を呼び出します。

TOP/拡張スクリプト/Searcher.Entry クラス