TOP/拡張スクリプト/BMX2WAV テーブル

BMX2WAV テーブル

概要

主に BMX2WAV 上でシステム(OS)に関わるプロパティ・関数についてまとめてあります。

プロパティ

ShowState -> table

後述の create_process で使用する、起動するアプリケーションのウィンドウ状態を指定する integer 定数が定義されています。

  • FORCE_MINIMIZE
  • HIDE
  • RESTORE
  • MINIMIZE
  • MAXIMIZE
  • SHOW
  • SHOW_NO_ACTIVE
  • SHOW_MINIMIZED
  • SHOW_MINIMIZED_NO_ACTIVE
  • SHOW_RESTORED
  • SHOW_RESTORED_NO_ACTIVATE
  • SHOW_DEFAULT

関数

system( path ) -> integer

path は string です。 path で指定されたコマンドを実行します。起動したアプリケーションが終了するまで待ち合わせます。 その起動したアプリケーションの終了ステータスが戻り値になります。 標準にある system 関数と似ていますが、この関数は標準の system 関数と異なる部分は DOS 窓は開かずに起動されたアプリケーションの標準出力はスクリプトの出力にリダイレクトされます。

create_process( filename, arguments, current_directory, show_state, need_to_wait ) -> integer or null

filename は string 、 arguments, current_directory は string または null 、 show_state は integer 、 need_to_wait は boolean です。 Windows のシステム関数である CreateProcess を呼び出し、実行ファイルを実行します。 BMX2WAV.system 関数では出来ない細かい指定をして実行ファイルを実行できるようになっています。

  • filename は起動する実行ファイルを指定します。
  • arguments はコマンドラインパラメータを指定します。
  • current_directory は起動時のカレントディレクトリを指定します。
  • show_state は起動するアプリケーションの表示状態の数値(前述の BMX2WAV.ShowState のこと)を指定します。
  • need_to_wait は起動したアプリケーションの終了を待ち合わせるかどうかを指定します。

戻り値は、need_to_waitfalse の場合は null 。 true の場合は起動したアプリケーションの終了ステータスになります。

実行に失敗した場合は例外が投げられます。

shell_execute( operation, file, parameters, current_directory ) -> boolean

operation, file は string 、 parameters, current_directory は string または null です。 戻り値は関数が成功した場合は true 、失敗した場合は false が返ります。 Windows のシステム関数である ShellExecute を呼び出します。 詳しくは ShellExecute について調べてください。

以下のように指定すると、指定したファイルを「開く」ことができます(だいたいファイルをダブルクリックした時と同じ動作)。

BMX2WAV.shell_execute( "open", path, null, null );
expand_environment_string( target ) -> string

target は string です。 target の中の環境変数を展開した文字列を返します。

integer_to_word_string( target ) -> string

target は integer です。 target の数値を BMS のオブジェクト文字列(00~ZZ)に変換した文字列を返します。

word_string_to_integer( target ) -> integer

target は string です。 target の文字列中の先頭 2 文字を BMS のオブジェクト文字列(00~ZZ)と見なしそれを数値にした値を返却します。

replace_string( target, pattern, replacement ) -> string

targetpatternreplacement は string です。 target の文字列の中の pattern の文字列を replacement に置換した文字列を返します。

play_wav_file_async( path, volume )

path は string 、 volume は integer です。 path で指定された WAV ファイルを volume で指定した % の音量で再生します。 関数は呼び出したら直ぐに戻ってきて、非同期で音が再生されます。

play_ogg_file_async( path, volume )

path は string 、 volume は integer です。 path で指定された ogg ファイルを volume で指定した % の音量で再生します。 関数は呼び出したら直ぐに戻ってきて、非同期で音が再生されます。

play_wav_or_ogg_file_async( path, volume )

path は string 、 volume は integer です。 path で指定されたファイルが拡張子が.wav の場合は WAV ファイルとして、 .ogg の場合は ogg ファイルとして、 volume で指定した % の音量で再生します。 関数は呼び出したら直ぐに戻ってきて、非同期で音が再生されます。

TOP/拡張スクリプト/BMX2WAV テーブル