スクリプトの形式

HSPはプログラム（命令と実行の順序を記したもの）によって動作します。 そのもとになるのがスクリプト（ソースファイル）です。これはテキスト ファイルの形式で、拡張子は .AS になります。 スクリプトはHSPに付属しているHSPスクリプトエディタ(HSED2.EXE)や、 テキストエディタなどのアプリケーションで作成することができます。

スクリプトの編集と実行

HSPスクリプトエディタ(HSED2.EXE)を使用すると、非常に簡単にHSPの スクリプトを作成、編集、実行することが可能です。HSPスクリプト エディタを使用した場合は、

という手順だけで、簡単にHSPのスクリプトを実行して動作を確かめることができます。

HSPスクリプトエディタの基本的な使い方

HSPスクリプトエディタ(HSED2.EXE)は、HSPのスクリプト編集用のエデ ィタです。コンパイルや実行なども自動的に行なうことができます。 HSPスクリプトエディタを使用する場合には、HSED2.EXEと同じディレクトリに 以下のファイルが存在している必要があります。

HSPスクリプトエディタは、本体(HSED2.EXE)とHSP実行ファイル(HSP2.EXE) が必ず同じディレクトリに存在していなければなりません。 また、実行ファイル(EXEファイル)を作成するためには、ランタイム ファイル(HSPRT)も、同じディレクトリに必要です。

HSPスクリプトエディタを起動すると、新規のテキスト編集ウインドゥ が表示されます。あとは普通のテキストエディタと同じように、ファイルをロードしたり、 セーブしたりしながらHSPのスクリプトを記述していきます。 基本的な操作は、Windowsに付属している「メモ帳」とほぼ同じです。 文字列のカット&ペースト、検索などもメニューから選ぶことができます。

編集しているHSPスクリプトを実行させてみるには、メニューから 「コンパイル+実行」を選ぶか、またはファンクションキーのF5を押します。 「実行」またはCTRL+F5を押すと、最後にコンパイルされたスクリプトを実行します。

コンパイル中にエラーが発生した場合は、コンパイル後にエラーの内容と エラーの出た行番号を知らせるダイアログが表示されます。

例： error xxx in line 15 (HSPTMP) --> ラベルが重複している

上の例では、「ラベルが重複している」エラーが行番号15で発生したと いうことを示しています。エラーが発生した場合は、「ｶｰｿﾙ」メニューの 「指定行に移動」（またはCTRL+J）を選んで、エラーが発生した行へ移動して その内容をチェックしてみてください。

一般的な使い方としては、HSPスクリプトエディタで編集、 実行を繰り返しながらスクリプトを作成して、完成したらメニューから 「オブジェクトファイル作成」を使って完成したスクリプトのオブジェクトファイル を作成。最終的には、EXEファイルやSCRファイル(スクリーンセーバー)を 作成して１本のソフトができあがります。

HSPのスクリプトエディタでは、以下のファイルを実行時に作成します。 これらのファイルは、コンパイル時にのみ必要なファイルなのでスクリ プトができあがった時には削除してかまいません。

スクリプトエディタのドラッグ&ドロップについて

ソーススクリプトのアイコンを、HSED2.EXEのアイコンの上かまたは、 ウインドゥ内にドロップするだけで編集をすることができるようになっています。
ソーススクリプトがドロップされると、そのソースファイルが格納されている ディレクトリがカレントディレクトリとなります。
より便利な使い方としては、「.as」という拡張子を「HSED2.EXE」と関連 付けしておけば、「.as」の拡張子を持つファイルをダブルクリックするだけで、 ソースを開くことができるようになります。
また、デスクトップに「HSED2.EXE」のショートカットを置いておき、そこに ソーススクリプトをドロップするような使い方も可能です。

スクリプトエディタの「外部ファイル実行」ボタンの使い道

外部のテキストエディタでHSPのソースファイルを編集したものを手軽に コンパイル＋実行させるために、スクリプトエディタでは「外部ファイル実行」の ボタンがツールバーの一番右端に用意されています。 これにより、使い慣れた他のテキストエディタを使いHSPのスクリプトを記述 することが比較的容易になります。主な作業手順は以下のようになります。

• HSPスクリプトエディタを開き、実行させたいソーススクリプトのファイルを開きます(たとえば「test.as」など)。一度開いたら、そのソースがあるディレクトリがカレントディレクトリとなるので、あとは「新規作成」のメニューでスクリプトの編集をやめてください。
• 別のエディタ(秀丸など)で、さきほどスクリプトエディタで開いたものと同じファイルを開きます。あとは、これを自由に編集してかまいません。さきほどのスクリプトエディタは、そのままにしておきます。
• 編集したスクリプトを実行したくなった場合には、マウスカーソルを移動させてスクリプトエディタの「外部ファイル実行」ボタンを押します。そして、実行させるファイル名を入力するダイアログが出ますので、そこに外部で編集しているソースファイルの名前を入力します。たとえば、「test.as」ならば「test」のように拡張の「.as」は省略して入力します。
• 「OK」のボタンを押すと、外部で編集されたファイルがコンパイル＋実行されます。外部で編集しているソースファイル名の入力は一度しておけば、次からは前の名前を覚えているので再び入力する必要はなくなります。

このような手順で、外部のエディタでスクリプトを編集することができます。この場合、 HSPスクリプトエディタは、コンパイル＋実行をするためのランチャーのような状態だと 考えるといいでしょう。ウインドゥのサイズを小さくして、編集部分をなくしてしまえば 画面上にコンパクトに配置することが可能です。

スクリプトエディタの「ラベル一覧」について

ver2.55よりスクリプトエディタの「カーソル」メニューに 「ラベル一覧」([F11])が追加されました。 [F11]を押すと、現在編集中のスクリプトに含まれるラベルの一覧がリストボックス に表示され、任意のラベルを選ぶことでダイレクトに該当する行にジャンプすることができます。 スクリプトが大きくなって移動が不便な場合や、どのあたりにラベルを振ったか 忘れてしまった時などに便利です。

ワンキーヘルプ機能について

スクリプトエディタで編集している文字列から、HSP命令のヘルプをボタン１つで呼び出す機能が 「ワンキーヘルプ機能」です。

使用方法は、調べたいキーワードにキャレット(エディタ内のカーソル位置)を合わせて、 [F1]キーを押すだけです。
該当する命令の説明、パラメータの意味などが表示されます。 もしキーワードに該当するヘルプがなかった場合は、アルファベット順のキーワード検索ヘルプが表示されます。
サンプルスクリプトが何をしているのかを調べる時、命令の詳細が思い出せない時などに便利な機能です。

ワンキーヘルプは、いくつかの表示方法を選ぶことができます。 標準では、HSPヘルプマネージャによるヘルプ閲覧に設定されています。

HSPスクリプトエディタでは、この他にもhtmlによる表示、Windows HLP形式による表示や、HSPヘルプマネージャによる表示など、4つの形式をサポートしています。 (HSPヘルプマネージャ形式以外は、対応するヘルプデータを別途用意して頂く必要があります)

1. HTML形式 (オプション)


ver2.5までの標準であるHTML形式ヘルプ表示を行ないます。 指定されたディレクトリに拡張子htmのヘルプファイルが必要になります。


2. Windows HELP形式 (オプション)


Windows標準のWinHelpによるヘルプ表示を行ないます。 HSP標準ではサポートされていませんが、ユーザーなどによって作られた ヘルプデータの表示が可能です。キーワードによる検索に対応しています。 指定されたディレクトリにHSP.HLPというファイルが必要になります。


3. HSPヘルプマネージャ形式 (標準)


HSP ver2.55からサポートされるヘルプマネージャを呼び出してヘルプの 表示を行ないます。 指定されたディレクトリにHELPMAN.EXEというファイルと、インデックス データ(idxファイル)およびヘルプデータ(hsファイル)が必要です。


4. Windows HTML HELP形式 (オプション)


Windows98標準のHtmlHelpによるヘルプ表示を行ないます。 HSP標準ではサポートされていませんが、ユーザーなどによって作られた ヘルプデータの表示が可能です。キーワードによる検索に対応しています。 指定されたディレクトリにHSP.CHMというファイルが必要になります。

これらは、HSPスクリプトエディタの「ヘルプ」→「HSPヘルプ設定」メニューを選択して、 設定することが可能です。

ヘルプのデータは、通常はスクリプトエディタ(HSED2.EXE)の下にある、hsphelpという ディレクトリに格納されています。もし、他のディレクトリに移したい場合や、 ヘルプ表示をしようとした際にエラーが出る場合は、「ヘルプ」→「HSPヘルプ設定」メニューを選択して、 ヘルプデータのディレクトリを再設定してください。(たとえば、「c:\hsp24\hsphelp」など)
入力が空白の場合は、HSED2.EXEの下にあるHSPHELPというディレクトリを参照します。

HSPヘルプツールについて

ＨＳＰのエラー

スクリプトの書き間違いや、指定のミスなどでＨＳＰの実行中にエラーを 発見した時には、エラーコードとエラー行番号が表示されるようになって います。ダイアログが出て、

のような表示が出た時は、スクリプトのxxx行がコードnnのエラーだと いうことを示しています。 エラーコードとメッセージの関係は次のようになっています。

1 "解釈できないHSPコードです"


	コンパイルされたHSPの中間コードが間違っています。
	通常は表示されないエラーです。ファイルが破損している場合や、
	予期しない事態が起こった時に表示されます。

2 "文法が間違っています"


	命令や、変数名、ラベル名の書き方が間違っている時に表示されます。

3 "パラメータの数値が異常です"


	パラメータの数値が許容範囲を越えている場合に表示されます。

4 "計算式でエラーが発生しました"


	計算式の書き方が間違っていたり、使用できない記号や演算をしようと
	した時に表示されます。

5 "パラメータの省略はできません"


	パラメータの省略ができない部分が省略されている時に表示されます。

6 "パラメータの型が違います"


	パラメータに指定された型(文字列型、数値型)が、規定のものではない
	時に表示されます。変数が指定されている場合は、変数の型が間違っています。

7 "配列の要素が大きすぎます"


	配列の要素として指定した値が、dim、sdim命令などで設定した数を
	越えている時に表示されます。

8 "有効なラベルが指定されていません"


	ラベルとして指定すべきパラメータが間違っている場合や、
	ラベルを示す「*」の後に何もない時に表示されます。

9 "gosub,repeatのネストが深すぎます"


	gosub命令、repeat命令を多重に実行しすぎた時に表示されます。

10 "サブルーチン外のreturnは無効です"


	gosub命令で呼ばれていないのに、return命令が実行された時に表示されます。

11 "repeat外でのloopは無効です"


	repeat命令がないのに、loop命令が実行された時に表示されます。

12 "ファイルが見つからないか無効な名前です"


	ファイル操作をする時に、指定されたファイルが見つからなかったか、
	またはアクセスできないファイルである時に表示されます。

13 "画像ファイルがありません"


	picload命令で読み込むための画像ファイルが見つからない時に表示されます。

14 "外部ファイル呼び出し中のエラーです"


	exec命令で外部ファイルを呼び出す際に、何らかの問題が発生した時に
	表示されます。

15 "計算式でカッコの記述が違います"


	計算式で使われている括弧「(、)」の書式が正しくない、または対応が
	おかしい時に表示されます。

16 "パラメータの数が多すぎます"


	命令に指定されたパラメータの数が多すぎる時に表示されます。

17 "扱える文字列の上限を越えています"


	文字列を扱う上での許容量を越えた時に表示されます。

18 "代入できない変数名を指定しています"


	システム変数や予約キーワードに対して代入しようとした時に表示されます。

HSPのしくみ

HSPは、以下のような流れでスクリプトを実行しています。

１．コンパイル

ソーススクリプト(テキストファイル)を解析し、HSP用のオブジェクトファイル(AXファイル) を作成します。(ここまでの作業はスクリプトエディタ(HSED2.EXE)が行なっています)

２．実行

オブジェクトファイル(AXファイル)を読み込み、それを実行します。 (この部分は、HSP本体(HSP2.EXE)が行なっています)

ソーススクリプトのコンパイルは、瞬時に行なわれオブジェクトファイルを作成します。 オブジェクトファイルは、ソーススクリプトの余計な部分、コメントなどを排除して コンパクトに、そして高速に実行できる形式になっています。

HSP本体は指定された オブジェクトファイルを読み込み実行するための核となる部分です。 これはHSP2.EXEですべて行われますので、それ以外に余計なDLLやモジュールは必要としません。 もちろん、HSP2.EXE本体には、サンプルデモのデータやスクリプトは入っていません。 スクリプトを最低限動作させるだけの部分なのです。

もし、あなたがHSPで作ったソフトを配布したいと思ったら、単体で実行できるEXE(実行) ファイルを作成することができます。EXEファイルを作成すると、 そのファイルをダブルクリックするだけでスクリプトが動作するようになります。 オンラインソフトや同人ソフトとして配布する際には便利な機能です。
EXEファイルやスクリーンセーバーモジュールを作成する時には、オブジェクトファイルが 必要になります。その際には、スクリプトエディタの「オブジェクトファイル作成」や、 「START.AXファイル作成」のメニューを使います。詳細は、次の項を参照してください。

バッチファイルやコマンドプロンプトから直接HSP2.EXEをファイル名指定 付きで実行させることもできます。

	hsp2 demo.ax

のように入力すると、"demo.ax"というオブジェクトファイルが実行されます。

EXE,SCRファイルの作成方法

HSPでは、ユーザーが作成したスクリプトや、そこで使用されるデータ ファイルなどを、ひとまとめにしてEXEファイルを作成することができる ようになっています。また、EXEファイルの一種であるSCRファイル( スクリーンセーバーモジュール)も同じ手順で作成できます。

EXEファイルを作成するためには次の手順で行ないます。

EXEファイルやSCRファイルを作成するには、必ずPACKFILEが必要に なります。PACKFILEとは、複数のファイルをひとまとめにして、EXE， SCRファイルの中に埋め込むための定義ファイルです。PACKFILEで指定 されたファイルは、スクリプトからは使用できますが、外部からは見え なくなります。これには次のような効果があります。

この機能を使えば、EXEの中に埋め込まれた画像ファイルやデータファ イルなどを使うことができ、１ファイルだけの画像や音声を使った ソフトを作ることができます。(ただしMIDIファイルやDLLなど一部のデータ ファイルは埋め込むことができません。また、埋め込んだファイルの 内容を変更して上からセーブすることはできません)

もちろん、スクリプトで使用されているすべてのデータファイルを EXEの中に埋め込む必要はありません。必要だと思ったものだけを、 埋め込み、それ以外は通常の外部ファイルとして置いておいても問題 ありません。ただし、最初に実行されるスクリプト「start.ax」だけは 必ず埋め込んでおく必要がありますので注意してください。 「start.ax」というオブジェクトファイルは、スクリプトエディタのツールメニューで 「START.AXファイル作成」のメニューで作成することができます。

PACKFILEは、スクリプトエディタの「PACKFILE編集...」で簡単にファイルを 選択して編集することができます。ただし、ここで指定するファイル名は スペースを含まない半角で11文字以内のMS-DOSファイルネームでなければなりません。

HSPでは、次のような順序でファイルのロードを行なっています。

EXEファイルを作成し終わったら、まず必要最低限と思われるファイル だけを、新しく作ったディレクトリに移して実行できるかどうかを 確認しておくといいでしょう。通常作業を行なっているディレクトリ には、EXEに埋め込む前のファイルがカレントディレクトリに置かれて いるので、PACKFILEで指定を忘れてファイルが埋め込まれていない 場合でも、正常に動作してしまうためです。

「外部ファイル実行」を使用している場合は、「オブジェクトファイルのみ作成」の チェックボックスをONにしてから、外部ファイル実行をすることで、 オブジェクトファイルの作成が可能です。

PACKFILEの編集について

「PACKFILE一覧」ダイアログでは、EXEファイルやSCRファイルを作成する際に必要な データファイル群を選択、管理することができます。ここで選択されたファイルの データは、PACKFILEというファイル名でカレントディレクトリに保存されます。 まず、メニューから「ツール」→「PACKFILE編集...」を選んでください。 「PACKFILE一覧」のダイアログが出ます。これは、おおまかに次のように分かれて います。

ファイル選択ウインドゥには、中央のファイルマスクウインドゥ(通常は"*.*")で指定 されたファイルだけが表示されます。たとえば、ファイルマスクを"*.AX"とすると、 拡張子が"AX"のファイルだけが表示されるようになります。 表示されるディレクトリを変更したい場合は、左下のディレクトリ選択ウインドゥを ダブルクリックしてください。[..]は、ディレクトリを１つ戻ることを、[-a-]や[-c-] は、ドライブを意味しています。

PACKFILE一覧に、ファイルを追加するには次のように操作します。

PACKFILEから指定したファイルを除外するには次のように操作します。

「全追加>>」ボタンは、ファイル選択ウインドゥに表示されているすべてのファイル をPACKFILE一覧に追加します。 「全削除->」ボタンは、PACKFILE一覧のファイルをすべてクリアします。

PACKFILEの編集が終了したら、「閉じる」ボタンを押してください。選択された 情報ファイルとして、PACKFILEというファイルがセーブされます。 PACKFILE編集によって、実際のファイルが削除されたりコピーされることはありません。 「キャンセル」ボタンを押すと、ウインドゥが閉じ、いままでの選択はすべて 無効になります。

現在のバージョンでは、PACKFILEは、スペースを含むディレクトリをサポートして いません。「Program Files」などのスペースを含むディレクトリ下にあるファイルを 指定すると、うまく動作しないことがありますので注意してください。

ver2.55から実行ファイルに含まれるデータに暗号化を施し、外部からの解析や抜き出しに 対処できるようになりました。
暗号化を行なう場合には、スクリプトエディタの「PACKFILE編集」ダイアログ において、PACKFILEに含めるファイルを追加する際に「暗号化」のチェック をONにしておいてください。PACKFILEに含めるファイル一覧の中で先頭に「+」 がつけられファイルは暗号化の対象になります。

ファイルの暗号化は、「start.ax」などのオブジェクトファイルを始めとして 画像ファイルや、テキストファイルなどHSPから読み込まれるファイルすべてに 適用することができます。PACKFILEに含めることのできないファイル、MIDIや 動画ファイルなどは対象にはなりません。

暗号化されたファイルは、bloadなどの命令で読み込んだ場合には、正常な 内容に復号されます。これをbsaveで保存した場合には暗号化されません。 現状では、他の人が作成した暗号化済みのDPMファイルなどからファイル名が 判明している場合は取り出しが可能ですが、将来のバージョンでは保護される ようになる予定です。

スクリーンセーバーの作成

HSPでは、Windows95/NTで動作するスクリーンセーバーモジュールの 作成が可能です。これは、特殊な命令を使いフルスクリーン画面を 作成してそこに描画された内容がそのままセーバーとなるもので、 通常のスクリプトにちょっと手直しをするだけで作成できます。 スクリーンセーバーの詳細については、サンプルファイルのあるディレクトリ 「ssaver」にある、「start.as」ファイルを開いてみてください。 スクリプトの書き方と実際の作成手順、そしてサンプルスクリプト本体が 書かれていますので参考にしてみてください。

起動オプションのパース機能

HSPでは、起動オプションを取り込みスクリプトでそれに応じた 処理をすることができます。これにより、色々な機能を持たせた EXEをバッチファイルから呼び出したり、EXEファイルのアイコン上 にファイルをドロップするような処理することが可能になります。
この機能をスクリプトエディタ上から試すために、HSPメニューに 「起動オプション...」があります。これを選択すると、スクリプト エディタ上から起動した時にも、擬似的に起動オプションをつける ことができます。 実際にスクリプトで起動オプションの内容を調べる場合には、 cmdlineというシステム変数を使用します。詳しくは、システム変数 一覧を参照してください。

フルスクリーン表示機能

HSPでは大きくノーマルウインドゥモードと、フルスクリーンモード を選ぶことができます。ノーマルウインドゥモードは、通常の Windowsアプリケーションと同じくデスクトップ上に任意の大きさの ウインドゥが開いて、それ以外の領域にはデスクトップ画面が見えて います。フルスクリーンモードでは、デスクトップのかわりにユー ザーが任意に指定した壁紙をバックにした画面になり、ディスプレイ 全体がHSPの画面となります。HSPのスクリプトが終了しない限り 別のウインドゥアプリケーションには移ることができません。 この２つのモードは、スクリプトエディタのHSPメニューにある、 「フルスクリーンモード」を選択することで切り替えることができ ます。

EXE,SCRファイルのアイコン書き換え

HSPスクリプト・ミニミニサンプル

サンプル付属しているファイル"samples.as"には、HSPで使うことのできる簡単な 例が集められています。この中には、多数のサンプルスクリプトが収録されて います。この一部を切り出してスクリプトの一部として使用することができます。 HSPの機能を活用するための参考にしてみてください。 "samples.as"に含まれているサンプルスクリプトは以下の通りです。

• 文字列の先頭文字をasciiコードで取り出す
  
• 文字列の取り出し1 (右からn文字を取り出す)
  
• 文字列の取り出し2 (左からn文字を取り出す)
  
• 文字列の取り出し3 (n1文字目からn2文字を取り出す)
  
• 「,」で区切られた文字列を１つ１つ取り出す
  
• テキストファイルの内容をそのまま表示1
  
• mesbox命令による簡易テキストエディタ
  
• テキストファイルの内容をそのまま表示2
  
• テキストファイルの内容チェック
  
• テキストファイルを自動生成
  
• 現在の日付と時刻を表示
  
• 現在時刻をエディットボックスに表示
  
• 今日の曜日を表示
  
• 複数行メッセージを影文字で表示
  
• 複数行メッセージをゆっくりと表示
  
• 入力ボックスの内容を後から変更する
  
• 乱数でキャラクタを大量に描画
  
• 画像のフェードイン・アウト
  
• 画像のパレット表示
  
• 指定した画像ファイルをメインウインドゥの壁紙にする
  
• 押したボタンに応じた画像を表示
  
• 乱数で大量の線を描画
  
• チェックボックスを表示
  
• カーソルキーによるメニュー選択
  
• メッセージボックスに後から文字列を追加
  
• onexit命令を使った終了時チェック
  
• 簡易CD playerサンプル
  

命令の書き方

スクリプトはどのような順番で、どのような処理をするかをまとめた テキストファイルです。その中の、どのような処理をするかを指示する ものを命令(ステートメント)と呼びます。

BASICやCと同じように、命令はファイルの先頭行から下に向かって順に 実行されていきます。

命令（ステートメント）は、プログラムの流れを制御したり、画面や ファイルなどの入出力を行ないます。 大きくわけて、プログラム制御命令と、入出力制御命令の２つからなる多くの命令が存在します。 スクリプトはアルファベットの大文字・小文字を区別しません。 どちらで記述してもかまいません。

パラメータ

HSPでは、命令の後にパラメータを付加する書式が基本になっています。 命令に付加するパラメータと、命令の間はスペースで空けておく必要があり ます。またパラメータが複数ある場合は、「,(カンマ)」で区切ります。 たとえば、

		width 640,480

というスクリプトは、「width」が命令(ステートメント)にあたり、 640と480という数値がパラメータになります。この組み合わせで、 「ウインドゥサイズを640x480にする」という意味になります。

	例 : ドキュメントファイルの「命令のリファレンス」の説明で、

		statement p1,p2
		
		p1=0〜3(1)
		p2=0〜65535(0)

とあった場合は、この命令にはp1,p2の2つのパラメータが指定でき、 p1のとれる値が0〜3まで、省略した場合の値が1。p2のとれる値が、0〜 65535まで、省略した場合の値が0であることを示しています。 パラメータの省略をすることもできます。上の例では、p2の値を省略して

		statement 3

と書くこともできます。その場合は、省略した時の値が自動的に設定 されて、

		statement 3,0

と書いたのと同じことになります。 パラメータの途中だけを省略する場合は、

		statement ,100

のように省略したパラメータを飛び越えて別のパラメータを指定すること ができます。この場合は、

		statement 1,100

と書いたのと同じことになります。

		statement

とだけ書いてパラメータを指定しなかった場合でも、自動的に「1,0」と いう値が設定されます。基本的にパラメーターは重要な順番に並んでいる ので、すべてを省略することはあまりありません。また、文字列を指定す るパラメータや、変数名でなければならないパラメータなどは省略ができ ないことがあります。

マルチステートメント

命令と命令の間を:（ｺﾛﾝ）で区切って1行に複数の命令を記述することも 可能です。これをマルチステートメントと呼びます。たとえば、

	例：
		mes "こんにちは" : mes "さようなら"

は、

		mes "こんにちは"
		mes "さようなら"

のように書くのと同じことです。 このように複数の命令を１行にまとめて書くことができます。 1行は最大256文字まで認識されますが、テキストエディタで見やすい程度に 納めるようにした方がいいでしょう。

コメント

1行の中で;（ｾﾐｺﾛﾝ）以降はコメントとみなし無視されます。

	例：
		pos 320,100 : print "(^_^)"		; 顔マーク表示

また、スペース、タブは見やすくするために自由に入れられます。

数式

命令のパラメータに数値を指定する場所では、以下のような演算子を 使った式を書くことができます。

たとえば、

		statement 1+2+3+4

は、

		statement 10

と書いたのと同じになります。これを数式といいます。 数式の評価は常に左から順に行なわれます。乗除算の優先はありません。 たとえば、

		2+7*2

は、18になります。計算の順番を変更したい場合はカッコを使って、

		2+(7*2)

のように書けば、カッコ内の7*2が先に計算されて結果は16になります。 条件式や論理演算は、後に説明する条件判断の際に使われます。 カッコは、８重までネスティングすることが可能です。もし、カッコの使い方が 間違っている場合は、「priority error」というエラーが表示されます。

HSPの標準機能では実数をサポートしていませんが、拡張プラグインに実数(小数)を 渡すための仕組みが用意されています。詳しくは、「小数値の記述について」を参照してください。

文字列

命令のパラメータに文字列を指定する場所では、文字列を"(ﾀﾞﾌﾞﾙｸｫｰﾃｰｼｮﾝ) で囲んでください。

	例：
		mes "This is test message..."

「+」を使って文字列同士、または変数との結合をすることができます。 たとえば、

	"ABCD"+"EFGH"　は、 "ABCDEFGH"　と同じになります。
	"VALUE="+val   は、 "VALUE=5"（変数valが5の場合）になります。

ただし、「\」は特殊な意味を持つキャラクタとして解釈されます。

	「\n」 は、改行して次の行にするという意味になります。
	「\t」 は、TABコードを表わします。
	「\r」 は、リターンコード(0x0d)を表わします。
	「\"」 は、ダブルクォート(")を表わします。
	「\\」 は、ただの「\」になります。

ですから、ディレクトリを示すための文字列、たとえば、

	"C:\WINDOWS\SYSTEM"  などの文字列は、
	"C:\\WINDOWS\\SYSTEM"  と記述しないと認識されません。

また、１行に収まりきらない長い文字列をまとめて記述することも可能です。

	mes {"
	ここには、１行まるまる直接メッセージを
	書いてもいいです。
	"}

このように、「{"」から「"}」までの間はすべて文字列として解釈されます。 複数行に渡っている時は、１行の最後に改行コードが挿入されます。 文字列の結合や複数行での文字列を指定する場合には、最大32768文字までが 有効となります。 ver2.3c以降では、半角カナも使用可能です。

変数

名前をつけた変数を扱うことができます。変数とは、代入により内容 を変化させることのできる容れ物のようなものです。
変数は、アルファベットまたは日本語で始まる59文字(半角)以下の文字列で 識別されます。変数は代入により数値か文字列、または数値の配列を記憶させる ことができます。
数値として記憶できる範囲は、数式で指定できる値と同じ-2147483647 から2147483647までの32ビット整数値です。
変数にラベルと同じ名前や、命令と同じ名前は使用できません。 変数は、代入命令や、数式の中で使うことができます。
代入命令は次のようなものです。

例：
	x=100				; 変数xに100という数値を代入
	y=200				; 変数yに200という数値を代入

命令の数値指定として使うと、

例：
	x=100:y=200:pos x,y		; (100,200)に移動

のようになります。
変数に値を代入すると、以前まで記憶されていたものは消され、新しい 値が保持されることになります。
変数に文字列を代入する場合にも同じように、

例：
	x="strings"		; 変数xに「strings」という文字列を代入
	print x			; 変数xの内容を画面に表示

代入は"="の先にあるものが数値ならば数値を、文字列ならば文字列として 記憶します。このことから変数には、記憶しているものが文字列だった場合の 文字列型と、数値だった場合の数値型の２つの状態があります。
パラメーターが数値を必要としている命令に文字列型の変数を指定しても、 またパラメーターが文字列を必要としている命令に数値型の変数を指定しても、 「Type mismatch」エラーが出てしまうので注意してください。

変数に文字列を代入する場合には、通常63文字までとなります。もし、それ 以上の文字数を取り扱いたい場合はdim命令によりサイズを指定する必要があり ます。詳しくは「配列変数」の項目で解説されています。

また、いくつかの特殊な代入命令があります。

例：
	a=10		; 変数aに10を代入
	a+=1		; 変数aに1を加算(a=a+1と同じ)

上の例では、変数aは１１という値になります。 このように、「+=」を使用すると"="以降が変数a自身に対して加算されます。
同じように「-=」も使用することができます。さらに、

例：
	a+		; 変数aに1を加算
	a-		; 変数aから1を減算

のような表現で変数に＋１と−１をすることができます。 (C言語やJavaと互換のある書式、a++やa--でも同じ結果になります)

変数の型を特定するために、変数の型を強制的に変更することができます。 そのための命令がintとstrです。

例：
	int a		; 変数aを数値型にする
	str b		; 変数bを文字列型にする

変数の型を変更しても、できる限りその内容を保持しようとします。
"123"という文字列を含んだ変数を数値型に変更すると、123という数値に なりますし、逆に123という数値型の変数を文字列型に変更すると"123"と いう文字列に変換されます。
また、str命令で数値型変数を文字列に変換する際には、通常の10進数文字列の他にも 16進数、0を省略しないで指定した桁数の文字列に変換することができます。

配列変数

配列変数を使うと、変数に記憶させるものに対して番号をつけて大量に管理 することができるようになります。 通常は、変数aには１つの数値、または文字列しか記憶させることができま せん。しかし配列変数を使えば、これに複数の数値、または文字列を記憶させ ることができます。 配列変数は次のようにして使われます。

	例：
		a.0=10		; 変数aの要素0に10を代入
		a.1=20		; 変数aの要素1に20を代入
		a.2=30		; 変数aの要素2に30を代入

変数の後に"."(ピリオド)をつけ、その後に数値による番号を指定します。 この番号を「配列の要素」といい変数の中のどこに記憶されているかを 特定します。要素は０から始まって、通常は１５まで指定できます。 要素が変わっても同じ変数なので、要素ごとに数値型、文字列型をまぜる ことはできません。変数aが文字列型ならば、すべての要素も文字列型となり ます。数値型も同様です。 要素に変数を使用することもできます。

	例：
		i=0
		a.i=123		; 変数aの要素0に123を代入

ただし、要素に数式を使うことはできません。要素として判断されるのは "."(ピリオド)の後に続く１項目だけです。ですから、

	例：
		a.1=5
		a.2=10
		print a.1+1

は、変数aの要素2ではなく、変数aの要素1に１を加算したもの、つまり６に なるので注意してください。

配列変数の要素がもっとたくさん欲しい場合にはdim命令で拡張することが できます。

	例：
		dim a,20	; 変数aの要素は0〜19まで使えるようになります

また、dim命令を使って多次元配列を作成することも可能です。

	例：
		dim a,10,5	; 変数aは２次元配列が使用できます
		a.0.0=1		; 要素(0,0)に1を代入
		a.1.0=2		; 要素(1,0)に2を代入
		a.0.1=3		; 要素(0,1)に3を代入

この場合は、「変数名.１つめの要素．２つめの要素」のように"."(ピリオド) を２つ使って要素を指定しなければなりません。 同じようにdim命令を使って４次元までの配列を作成することができます。

文字列型の変数に配列を使う場合にはsdim命令を使います。 sdim命令では、まず扱う文字列の最大文字数を指定してから、要素の数を 指定します。たとえば、

	例：
		sdim a,32,5  ; 変数aは32文字までの文字列を５つの要素で扱えます
		a.0="test"
		a.1="message"

のように変数名の次に２つのパラメータを指定します。 また、sdim命令は通常使う文字列の最大文字数を拡張することもできます。

	例：
		sdim a,200	; 変数aは200文字までの文字列を扱えます

これは配列変数ではなく、通常の変数になります。 通常の変数は64文字までしか文字列を扱うことができませんが、sdim命令を 使用することで、最大文字数を増やすことができます。

代入するパラメータに「,」をつけることで、配列変数への代入を連続して行なうこともできます。

	例：
		tmp=1,5,10	; 配列に連続して代入をする

上の例では、「tmp.0=1:tmp.1=5:tmp.2=10」と同じことになります。 配列の途中から代入を開始するには、

	例：
		tmp.2=10,20,50	; 要素2から連続して代入をする

この例では、「tmp.2=10:tmp.3=20:tmp.4=50」と同じことになります。 「tmp="ABC","DEF","GHI"」のように文字列を連続して代入することもできます。 この場合は、あらかじめsdim命令などで文字列型の配列を用意しなければなりません。

ラベル

プログラム上の位置を示すためにラベルとして名前をつけることができます。 ラベルは*(ｱｽﾀﾘｽｸ)の後に続く59文字(半角)以下の文字列で示します。
ラベルは行の先頭になければなりません。また、原則としてラベルのある 行には命令を書かないようにしてください。

例：

*label
	mes "Wait.":wait 100
	goto *label			; 無限ループを生成

ラベルは主に、goto命令、gosub命令またはbutton命令の飛び先を指定する のに使用されます。

条件判断

条件判断を行う場合には、if命令を使用します。if命令は、パラメータで 示された条件が満たされた場合は、それ以降の命令を実行し、そうでなければ 次の行から実行を続けます。

例：
	a=10
	if a=10 : mes "aは10です。"

上の例では、「a=10」の部分が条件式になります。条件式には主に、

の４つを使います。if＋条件式の後は：(コロン)で区切り、それに続いて 条件が満たされた場合に実行される部分を書きます。
(C言語やJavaと同じように「=」「!」を「==」「!=」のように記述することも可能です)
もし、条件によってプログラムの流れを変えたい場合には、

例：
	a=10
	if a>10 : goto *over10
	mes "aは10以下です。"
	stop
*over10
	mes "aは10より大きいです。"
	stop

上のように、goto命令で別なラベルに飛ばすことも可能です。 また、else命令を使って条件が満たされなかった場合の処理を同じ行に書く ことも可能です。

例：
	a=10
	mes "aは、"
	if a=10 : mes "10です。" : else : mes "10ではありません。"
	stop

この場合は、else命令のある部分までは、条件を満たした場合に実行され、 else命令以降は、条件を満たされなかった場合に実行されます。 次の行以降は、条件に関わらず通常通りに実行されます。

より複雑な条件判断をするために、論理演算式を使うこともできます。

これによって複数の条件を一度に記述することができます。

例：
	a=10:b=20
	if (a=10)|(b=10) : mes "aかbのどちらかが10です。"

上の例では、「a=10」と「b=10」という条件式を|(or)でつないで、 どちらかが正しい場合には、正しいという結果が出るようにしています。 論理演算は、「|」「&」といった記号の他に「or」「and」という文字列 でも記述することができます。

例：
	if (a=10)or(b=10) : mes "aかbのどちらかが10です。"

上のように書いても、結果は同じになります。
HSPでは、論理演算はビットごとの演算として扱われているため、 C言語やJavaなどで用いられる「&&」「||」などの論理演算子とは等価ではありませんので ご注意下さい。

より複雑な条件判断

ver2.5では、いままで1行しか記述できなかった条件判断の実行を、複数行で行なう ことができるようになっています。 if命令の条件が正しい時に実行されるスクリプトを複数行に渡って記述する場合は、

例:
	a=10
	if a>5 {
		mes "TRUE"
		mes "(MULTILINE IF)"
	}

のように「{」で始めて「}」で終わる部分までを指定します。 (上の例では、見やすくするためにC言語風に行の最初にTABを入れてありますが、 特に必要なものではありません。ユーザーの見やすいように記述してください)

例:
	a=10
	if a>5 : mes "TRUE"

「{」を使わなかった場合には、if命令以降の1行のみが実行されます。 また、else命令は、条件が正しくない時に実行されるスクリプトを指定します。

例:
	a=10
	if a>5 : mes "TRUE" : else : mes "FALSE"

上の例では、aが5より大きい場合は、「mes "TRUE"」が、そうでない場合は、 「mes "FALSE"」が実行されます。 else命令でも複数行の指定ができます。

例:
	a=10
	if a>5 {
		mes "TRUE"
		mes "(MULTILINE IF)"
	}
	else {
		mes "  FALSE"
		mes "  (MULTILINE IF)"
	}
	return

ただし、elseの後に「{」を記述しなければ複数行にはならないので注意して ください。

例:
	if a>5 {
		mes "TRUE"
	}
	else					; <- 間違い
	{
		mes "FALSE"
	}

上の例は間違いです。エラーになります。 else命令もまたif命令と同じように、「{」がない限りは、その１行のみが有効範囲に なります。
また、if命令を多重に実行させることも可能です。

例:
	a=10
	b=10
	c=10
	if a>5 {
		if b>5 {
			if c>5 { mes "--3" } else { mes "--2" }
		}
		else {
			mes "--1"
		}
	}

上の例では、変数aが10より大きい場合は「--1」を、変数a,bが10より大きい 場合は「--2」を、変数a,b,cが10より大きい場合は「--3」を表示します。 if命令の多重化は、スクリプトがだんだんと複雑になっていくので、注意して 使ってください。HSPでは、8重までの多重化が可能です。

*現在のHSPでは、if命令で「{」「}」を使った複数行記述と、通常の１行のみの
分岐を混在した場合の動作は保証されません。「{」「}」内でさらに条件分岐を
行なう場合には、「{」「}」を使用するようにしてください。
この問題は、今後のバージョンアップで解消していく予定です。

繰り返し命令

repeat〜loop命令は、HSPで繰り返しの動作をさせる場合に欠かすことのできない重要な 命令です。

		repeat 5
		mes "繰り返し["+cnt+"]"
		loop

のように、repeat命令の後に回数を指定すると、loop命令までを指定回数だけ繰り返し ます。繰り返し中は、システム変数cntが0、1、2、3…と自動的にカウントアップされ ていきます。

繰り返し回数に0が指定された場合には、repeat〜loopの範囲は実行されずに通過します。 また、繰り返し回数指定を省略するかまたはマイナス値を指定すると無限ループに なります。

repeat〜loop命令と、break、continue命令を組み合わせることにより、さらに高度な 処理が可能になります。 repeat〜loop命令の繰り返しを、途中で強制的に脱出させるのがbreak命令です。

		repeat 5
		if cnt=2 : break
		mes "繰り返し["+cnt+"]"
		loop

上の例では、システム変数が2になった時点、つまり３回目のループになると、 if命令の判断によって、break命令が実行されるしくみになっています。 break命令が実行されると、繰り返しの回数がまだ残っていても、強制的に繰り返し から抜け出し、loop命令の次にある命令から実行を続けます。 break命令以降(上の例では、mes命令)は実行されません。 この命令を使うと、たとえば次のようなスクリプトが作成可能です。

		repeat
		getkey a,1
		if a>0 : break
		await 10
		loop

上のスクリプトでは、マウスの左ボタンを押すまで待つループになります。 repeat命令の回数指定を省略するかまたはマイナス値を指定すると無限ループに なります。それを利用してボタンの状態が1になるまでは、ずっと同じところを 繰り返すようになっています。 ボタンが押されると、break命令が実行され繰り返しから抜け出します。 いままでは、このようなスクリプトはgoto命令を使って繰り返しの構造を記述する 必要がありましたが、repeat〜loopとbreak命令を使うことにより、ラベルを 用意することなく手軽に条件付きの無限ループが実現できます。

continue命令は、逆に繰り返しをやり直すための命令です。

		repeat 5
		if cnt=2 : continue
		mes "cnt="+cnt
		loop

上の例では、システム変数cntが2になった時点で、continue命令が実行される しくみになっています。 continue命令が実行されると、repeat命令まで戻り次の繰り返しを実行します。 上のスクリプトが実行されると、

		cnt=0
		cnt=1
		cnt=3
		cnt=4

のような表示になり、システム変数cntが２の時だけmes命令が実行されないのが わかります。 最初はわかりにくいかもしれませんが、continue命令は、loop命令の場所ではないが、 loop命令と同じ働きをするとも言えます。 繰り返しのカウンタは、continue命令が実行された場合でも、loop命令と同様１つ 増加します。もし、最後の繰り返しでcontinue命令が実行されると、repeat〜loopが 終わった状態、つまりloop命令の次の命令から実行を続けます。

さらにもう１つ、continue命令にはパラメータを指定する使い方が存在します。 continueの後に、数値または数値型変数を指定することにより、繰り返しのカウンタ を示すシステム変数cntの内容を変更することができます。 たとえば、「continue 1」と指定した場合は、システム変数cntの内容は1になり、 その値のままrepeat命令の次から繰り返しを続けます。 パラメータを省略して、ただの「continue」だけの場合はloop命令と同様の処理、 数値を指定すると、カウンタの値を変更して繰り返しをやり直すことになります。 ですから、

		repeat 1
		await 10
		getkey a,1
		if a=0 : continue 0
		loop

このようなスクリプトでは、通常1回だけしか実行されないはずの、repeat〜loopの 繰り返しですが、マウスの左ボタンが押されていない場合は、カウンタが0に戻され 無限ループの状態になります。これで、ボタンを押すまで待つという動作になります。

このbreak命令と、continue命令は、ともにrepeat〜loop命令の中で使用しなければ なりません。また、repeat〜loop命令の中であれば、いくつでも使用できます。

注意しなければならないのは、プログラムの流れとしてrepeat〜loop命令は、順番に つながっていなければなりません。repeat命令があったら、そこから下の行に必ず loop命令がなければいけないということです。 repeat命令だけを、gosubでジャンプしたサブルーチンの中で実行したり、 goto命令でスクリプト上の別な場所にジャンプしてloop命令を実行させたりして、 repeat〜loop命令の順番が狂ってしまうとコンパイラはエラーを出してしまいます。

repeat〜loop命令は、多重に使うことができます。

		repeat 5
		if cnt=2 : continue
			repeat 2
			mes "中のループcnt="+cnt
			loop
		mes "外のループcnt="+cnt
		loop

上の例では、わかりやすいようにTABを入れて記述していますが、５回繰り返す構造の 中に、さらに２回繰り返すrepeat〜loop命令があります。 繰り返しが多重になった場合でも、break、continue命令は対応するループに対して 機能します。これは、システム変数cntが、やはり対応したループに対しての値を示す のと同様です。

repeat〜loop命令は、多様な使い方のできる構文です。C言語や、Javaにおける、 while文や、do〜until文などに近い記述もできますし、もちろんfor文のような 繰り返しの記述にも使えます。

プリプロセッサ命令

プリプロセッサ命令は、プログラム実行時ではなく、コンパイル時に解釈し 実行される命令のことです。プリプロセッサ命令は、他の命令と区別がつく ように、行の最初に「#」に続けて記述しなければなりません。
プリプロセッサ命令により、スクリプトの記述そのものをカスタマイズする ことも可能になります。ただし、使いすぎるとプログラムそのものがわかり にくくなったりするので、HSPを一通り使った上級者の方に使用をおすすめ します。

#include "filename"			別ファイルを結合

"filename"で指定されたファイルも同時にコンパイルされます。
スクリプトエディタで入りきらないスクリプトも、includeで別ファイルに 分割すればコンパイルすることができるようになります。

#define 新規名称  元名称		新規名称を登録する

HSPに新しい命令の名前を追加するためのものです。
HSPの従来ある命令の名前を、別な名前でも使用できるようになります。 新規名称は、予約されている命令語や変数名と重ならない20文字以内の、 スペースを含まない英文字列でなければなりません。

例：
	#define pr print
	pr "message..."
	stop

上のように#defineの後に、新規名称と元の名称をスペースで区切り記述 します。すると、「pr」という命令が新しく登録され、「print」命令と まったく同様に使うことができるようになります。
元の名称は、命令の名前である必要はありません。数値や、記号なども 新規の名称として登録することが可能です。

例：
	#define max 10
	a=max
	mes "A="+a
	stop

上の例では、maxという名称は10という数値を表わすものになっています。
このように、定数として名称を定義しておくことが可能です。一見、変数と 変わりませんが、defineで定義したものは変数メモリを消費しないので、 あとから書き替えることのない定数の定義をするのに便利です。

また、計算式で扱う記号そのものを置き換えることが可能です。

例：
	#define is =
	#define plus +
	a is 5 plus 10
	print "A="+a
	stop

上の例では、「=」という記号を「is」という言葉に、「+」という記号を 「plus」という言葉にそれぞれ置き換えるように定義しています。
すると、「a is 5 plus 10」という行は、「a=5+10」と同じことになります。 ただし、記号の置き換えは式の演算子のみ行なうことができます。

#uselib "filename"			外部DLLの指定
#func 新規名称  関数名  タイプ		外部DLL呼び出し命令登録

外部DLL内のプログラムを呼び出すための命令を増やすことができます。 これにより、HSP本体のプログラムから、C言語やDelphiなどで作成した DLL内の関数を呼び出すことが可能になります。
func命令により、外部の関数もHSPの命令として定義できるので、 HSPを自由に機能拡張することが可能です。外部DLL作成の方法や、 HSPとのパラメータ受け渡しの詳細は、インターネット上のONION software ホームページにて別途ファイルをダウンロードすることができるように なっていますので、そちらの付属サンプルプログラムソースなどを 参照してください。
普通に使う場合には、まったく必要のない命令ですので、特に覚えて おかなくても問題ありません。

メモリノートパッド命令

HSP ver2.4からは、メモリノートパッド命令という新たな命令セットが追加されました。 これは、行単位で文字列扱うことのできるユニークで便利な機能です。これにより、 テキストファイルを読み込み解析したり加工することが容易になります。 また、コンボボックスやリストボックスを表示するための命令(combox,listbox命令)のパラメータ指定に使う文字列や、 ディレクトリの内容を調べるdirlist命令が返す文字列なども、メモリノートパッド命令を使うことでシンプルに処理できるようになります。
メモリノートパッド命令は、簡単に言えばWindowsの「メモ帳」のようなテキストエディタを使うような感覚で、複数行を含んだ文字列を扱うための命令セットです。 通常の文字列は、「ABCDEFG」のように任意の文字が集まったものです。複数行を含んだ文字列というのは、 「ABCD\nEFGH」のように間に改行(\n)があり1行目は「ABCD」、2行目は「EFGH」というようにちょっと複雑な構造になっている文字列のことです。 テキストエディタなどでロード・セーブすることのできるテキストファイルも、このような複数行を含んだ文字列と言えます。 これらの文字列を行単位で取り出したり、修正をしたりすることがメモリノートパッド命令で可能です。 メモリノートパッド命令セットは、以下の種類があります。

基本的な使い方は、まずnotesel命令で文字列型の変数を指定します。それ以降は、メモリノートパッド命令はすべて、そこで指定した変数が対象になります。 指定した変数には、あらかじめ文字列が代入されているか、または中身をカラ(a=""のように)にしておかなければなりません。 notesel命令で変数を指定した後は、自由にnotemax,noteadd,noteget,notedel命令を使って変数の内容(文字列)にアクセスすることができるようになります。

例：
	a="ONION\nTOMATO\nCARROT"
	notesel a
	noteget b,0
	print "index0="+b
	noteget b,1
	print "index1="+b
	noteget b,2
	print "index2="+b
	stop

上の例では、変数aに「ONION」「TOMATO」「CARROT」という3行が代入されています。 まずnotesel命令で、変数aを指定してから、各行の内容をnoteget命令を使って取り出して表示しています。 メモリノートパッド命令では、行の指定に「インデックス」という単位を使用しています。 最初の行はインデックス0、その次はインデックス1、そのまた次はインデックス2…というふうに続きます。 行数だと最初は１行目ということになりますが、インデックスは0から始まるので注意してください。 つまり、「noteget b,0」は最初の行を変数bに読み出す…という意味になります。

例：
	a="ONION\nTOMATO\nCARROT"
	notesel a
	noteadd "POTATO"
	mes a
	stop

上の例では、変数aに代入されている「ONION」「TOMATO」「CARROT」という３つの要素に、「POTATO」 という行を追加しています。4行目の「mes a」で、その結果を表示しているので確認することができます。 内容を追加するには、noteadd命令を使用します。「noteadd "POTATO"」は、最後の行に「POTATO」 を追加します。

	noteadd "POTATO",1

と指定をすると、インデックス1の位置に追加されます。 それまでインデックス1以降にあった内容は下にずれることになります。また、

	noteadd "POTATO",1,0

は、同じくインデックス1の位置に追加されますが同じ行に上書きで追加されます。 それまでインデックス1にあった内容は消去され、かわりに指定した内容になります。
指定したインデックスの行を削除する命令も用意されています。

	notedel 1

は、インデックス1を削除します。
これらのメモリノートパッド命令は、他の命令と組み合わせた時に威力を発揮します。 メモリノートパッド命令は、テキストファイル、mesbox命令で入力される複数行テキスト、dirlist命令の結果、comboxおよびlistbox命令で指定するパラメータの処理に使用することができます。 また、1行単位で取り出した文字列は、poke,peek命令などで1文字単位で扱うことが可能です。 いままでは、getstr命令などを使わなければできなかった行単位の処理が大幅に便利になることでしょう。

例：
	nmax=0
	alloc a,32000
	bload "aaa.txt",a
	notesel a
	notemax nmax
	idx=0
	repeat nmax
	noteget b,idx
	print "index"+idx+"="+b
	idx++
	loop
	stop

上の例では、"aaa.txt"という名前のテキストファイルを読み込み、そのすべての行をインデックス番号 とともに表示します。 全体の行数がわからない場合は、notemax命令を使用します。これは、メモリノートパッドの対象になっているテキストの行数を調べて変数に代入します。
テキストファイルなどの大きさのわからないデータを読み込む場合には、あらかじめalloc命令でバッファを確保しておかなければなりません。 上の例では、変数aのバッファを32000バイト確保しています。 メモリノートパッド命令セットは、扱えるデータの大きさに制限はありませんが、データが大きくなるほど処理スピードがかかるようになります。通常32000〜65535バイト程度のデータならば問題ありません。

例：
	alloc a,32000
	alloc tmem,32000
	tmem=""
	fname=""
	;
	dirlist a,"*.*"
	sel=0
	objsize 160,24
	listbox sel,150,a	; ID=0
	button "SELECT",*ok	; ID=1
	pos 180,0
	mesbox tmem,450,200	; ID=2
	stop
*ok
	notesel a
	noteget fname,sel
	exist fname
	if (strsize=0)or(strsize>32000) : goto *lderr
	bload fname,tmem
	objprm 2,tmem
	stop
*lderr
	dialog "LOAD ERROR!"
	stop

これは、メモリノートパッド命令と、その他の命令を組み合わせたサンプルです。 カレントディレクトリにあるファイル一覧をリストボックスに表示して、そこで選んだファイルの内容を、 右側にあるメッセージボックスの中に表示します。 dirlist命令やlistbox命令で使われている文字列は、いずれもメモリノートパッド命令で扱うことのできる複数行のテキストです。 最初は複雑に感じるかもしれませんが、多くのデータを一度に扱うことができ、使い方次第で応用範囲がさらに広がります。

システム変数一覧

次の変数はシステム起動時、または特定の命令を実行した時に自動的に 値が代入される変数です。普通の変数と同じように参照することができ ます。ただし、システム変数に対して値を代入することはできません。 (ただし、モジュール内では例外的に、値を返すためシステム変数に値を代入する ことが可能です)

*1 以下の情報がすべて合計された値になります。
   ( デバッグモード = 1 )
   ( IMEが有効 = 2 )
*2 バージョンコード + マイナーバージョンコードの値になります。
   (2.5は$0205??になる)

HSPシステムの許容範囲

現バージョンでのシステムリソースの許容範囲は以下の通りです。 この値をオーバーしてしまった場合、正常な動作の保証はできません。

HSPのタスク

HSPは中間言語処理によるシングルタスクのインタプリタです。 HSPと他のWindowsアプリケーションはマルチタスクで同時に走らせることができます。 (HSP2.EXEを複数同時に走らせることもできますが、RAM容量の少ない環境ではおすすめできません)

ただし、そのために１つだけHSPのスクリプトを作る上で約束事があります。 DOSのBASICをいじっていた人などには、最初はわかりにくいと思いますが、HSPでは 「キーを押さないと進まないなどの無限にループになる可能性のある部分では、必ずwaitかawait命令を入れる必要がある」 という約束事を覚えておいてください。 waitやawait命令はWindowsの他のタスクに空き時間を回すための重要な役割があります。 これを守らないと、無限ループでWindowsのほぼすべてのタスクを奪ってしまい、 マルチタスク動作に影響が出ます。その結果、ウインドゥが正常にドラッグできなくなったり、 タスクの切り替えができなくなったりと変な状態になります。 (Windowsそれものが動かなくなるなどの致命的な状態にはなりません。 誤ってHSPで無限ループを作ってしまった場合は、[Ctrl]+[Alt]+[Del]を同時に押してHSPのタスクを終了させればもとの状態に戻ります)
しかし、この約束事を気にしすぎる必要もありません。1秒以内に確実に終わる程度のループであれば、 waitを入れる必要はありません。waitを入れることでさらに処理速度が遅くなってしまいます。 最も問題になるのは、たとえば「マウスのボタンを押すまで待つ」というような部分を、

例：
*mwait
	getkey a,0
	if a=0 : goto *mwait

のように記述すると、そこで無限ループになってしまいます。これを、

例：
*mwait
	getkey a,0
	await 5
	if a=0 : goto *mwait

このように修正すれば、無限ループは回避され正常にタスクが実行されます。 「await 5」は、非常に短い単位でのウェイトなので、これによってボタンの入力がしにくくなることもありません。

await命令を使うとwait命令よりも高精度で細かいウエイトが可能ですが、 wait命令よりもCPUのタスクを消費します。 リアルタイムに画像を書き換えるなどの処理でなければ、wait命令を使用した方がCPU(Windows)の負担が軽くなります。 常にデスクトップに配置するようなアクセサリにはwait命令を、 ゲームアプリケーションなどにはawait命令を使うといった使い分けをするといいでしょう。

画面とウインドゥ

HSPの中心となる機能は、画面に文字や画像、そして点、線などを描画する ものです。HSPでは複数の描画バッファが用意されていて、それぞれに ウインドゥを割り当て、複数のウインドゥ画面を操作することが可能です。

HSPでは描画対象となる仮想的な画面を32個まで持つことができます。 これらの仮想画面は、ウインドゥIDと呼ばれる数値で管理されます。 それらは次のように使うことができます。

ウインドゥID0は、最初に現れる画面を指します。２つ以上のウインドゥを 開くことがないのであれば、ウインドゥIDは特に意識せずに使用できます。 ウインドゥID1は、システム側で使用する画面なのでユーザーは自由に使用 できません。
HSPのメイン画面とは別に新しいウインドゥを開いたり、メモリ上に仮想 画面を作成する場合には、ウインドゥID2〜31を使うことになります。
新しい仮想画面は、初期化してから使用しなければなりません。そのための 命令がscreen命令およびbuffer命令です。screen命令で初期化をすると、 その画面は新しいウインドゥとしてディスプレイ上に表示されます。この ウインドゥはサイズを変更することができ、スクロールバーを使ってスク ロールさせることができるので、大きなサイズの画像でも表示可能です。 それに対して、buffer命令で初期化をすると、その画面はメモリ上に存在 するだけとなり、ディスプレイからはその内容は見えません。このような 画面は、ほかの画面に画像の一部をコピーするためのテンポラリとして、 また一時的な画像の保存場所などに使用することができます。

＊一度初期化された仮想画面の属性は変更できません。 つまり、screen命令で初期化された画面を消したり、buffer命令でメモリ 上のバッファにすることもできません。

通常画面の基本的な使い方は、まずcls命令で画面をクリアするか、picload 命令で画像を画面に表示して初期化します。その後、メッセージやボタンを 配置します。

カレントポジション

メッセージの出力、グラフィックデータのコピー、ボタンの配置などは カレントポジションと呼ばれる座標を対象に行なわれます。
カレントポジションはDOS画面のカーソルのようなもので、メッセージが出力 された後は、カレントポジションも改行した次の行に自動的に移動します。 カレントポジションは、pos命令によって変更することが可能です。また、 objsize命令によって、カレントポジションの移動量を調節することができます。 cls命令などで画面が初期化された時は、カレントポジションも(0,0)にリセ ットされます。
カレントポジョンがどこにあるかは、システム変数のcsrx,csryを参照する ことで得られます。

オブジェクト

HSPでは、押しボタン、入力ボックスなどの部品をオブジェクトと呼び、画面内で自由に配置することが可能です。
HSPでは、以下のようなオブジェクトを使用することができます。

それぞれのオブジェクトには、オブジェクトIDという番号が割り振られ管理されています。 このオブジェクトIDは、画面内に配置した順に自動的に0,1,2,3…とついていくもので、 普通は意識する必要はありません。 オブジェクトIDの把握が必要な時は、オブジェクトの一部を後から消したい時、オブジェクトの状態を変更したい時などです。
また、押しボタンが押された時には、システム変数statに押されたボタンのオブジェクトIDが代入されます。 そこで、ボタンの飛び先を同じ場所にしておき、この値を調べて、 それに応じた処理を行なうことも可能になります。
オブジェクトは簡単に配置して使うことができますが、より奥深い使い方をマスターすれば、 さらに高度なスクリプトを書くことも可能になります。 オブジェクトの内容を後から変更するための、objprm命令や、オブジェクトにWin32メッセージを直接送るobjsend命令はそのような高度な使用のために用意された命令です。

カレントカラー

メッセージの出力、点、線、矩形の描画などに使用される色がカレントカラー です。これは、palcolor命令、color命令で変更することができます。
cls命令などで画面が初期化された時は、カレントカラーは黒色にリセットされ ます。

メモリバッファの使用

HSPでは、通常の変数や、配列変数が割り当てられるメモリをファイルに セーブしたり、ファイルからロードをするための命令が用意されています。 メモリバッファは、Windowsが許す限りのメモリを扱うことができ、上限は ありません。
基本的なメモリバッファの使い方は、sdim命令やdim命令で変数の配列として メモリバッファを初期化します。 よりメモリサイズが明確に指定できるalloc命令も使用できます。
メモリバッファのファイル入出力は、bload命令、bsave命令で行ないます。

マルチメディア再生

HSP2では、WAV形式のPCM音声ファイル、SMF(MID)形式の標準MIDIファイル、 CDの音声トラック再生、AVI動画ファイルなどを手軽に扱うことができます。

また、MCIコントロールデバイスとして登録されている機器のコントロール も可能です。

再生するためのファイルは、sndload命令によってHSPに登録され、snd命令で 再生を開始することができます(再生中断はsndoff命令)。 それぞれのサウンドは、ループ再生、再生終了までのウエイトを選択できます。

ただし、MIDIのループ再生には問題があり完全なループ演奏にはなりません。 WindowsのMIDIシーケンサーが演奏開始まで時間がかかるのと、MIDIデータには 最初に音源を初期化するコードや音色の指定などで時間がかかる場合が多いため 演奏終了から、ループまでがうまくつながらないことが多いからです。
ですから、この機能はあくまで簡易のループということをご了承ください。 そもそもループポインタが指定できないので、前奏まで戻るのも変なんですが、 ゲーム中にBGMが終わってしまうのが寂しいのを避けるためと割り切って使う ことはできるかもしれません。

MIDIのデバイスドライバによっては、MIDI演奏をストップした直後に、再びMIDI演奏を開始すると Windowsがフリーズしたり演奏されないものがあるようです。 そのような場合には、MIDI演奏終了後に１〜２秒ほどのウエイト(wait 20など)を入れてから、 次の演奏を開始するようにしてみてください。

WAV形式のPCM音声だけは、最初にすべてメモリにロードされてから再生される のでループ再生も問題なく行われます。ただし、WAVファイルのサイズだけメモリ を占有するので、あまりにも巨大なファイルは、mci命令で再生するようにしてください。

高速な描画をするには

より高速な処理や、ちらつきのない書き換えを行なう場合には、 redraw命令が有効です。redraw命令により、描画スイッチを一時的にOFFに しておき(redraw 0)、普通に描画処理を行ない、すべてが終わったところで 描画スイッチをONにします(redraw 1)。
これにより、描画中の状態を画面では見えなくし、しかも高速に処理されます。 高速化のためには、何はなくともまずredrawの制御を行なってください。

グラフィックの描画速度はビデオカードの性能とCPU速度に左右されます。 また、画面の色数モードにも大きく関わってきます。
スプライト制御やMAG画像ファイルのロードなどは256色モードの方が高速 に動作しますし、逆にフルカラーのJPGファイルは256色モードの方が減色 処理のために遅くなってしまいます。

screen命令および、buffer命令で仮想画面を初期化する際にも、 パレットモードで初期化する方法と、フルカラーモードで初期化する方法の ２つがあります。指定を省略すると、現在の画面モードに合わせて自動的に 設定されますが、そこに表示される画像が256色のものだけであれば、 パレットモードで初期化しておく方が効率がいいでしょう。
逆にフルカラーモードで初期化した仮想画面を、256色表示のディスプレイ 上に表示させようとすると、フルカラーのデータをパレットにマッチング させるためウインドゥの表示が遅くなることがあるので注意してください。 (詳しくは、パレットモードでの注意点を参照してください)

変化する文字列の表示

mes,print命令で変数の内容などを常に更新したい場合などは、文字が 重なりあってしまって都合がよくありません。同じ画面で、何度も表示を 書き換えたい時は、title命令を使ってキャプションバーに表示すること をおすすめします。title命令はmes,print命令に比べても高速です。 たとえば、

	title "X,Yの内容="+x+","+y

のように変数x,yの内容を表示する時に使用するといいでしょう。

パレットモードでの注意点

HSPでは、パレットモードとフルカラーモードという2つのモードをなる べく同等に扱えるように作られていますが、仕様上ある程度気をつけな いといけない点があります。256色の画像ファイルを扱う場合や、同時に 複数の画像を表示する高度なスクリプトを作成する時には特に注意して 下さい。まず、以下のようなOS上の制限からくるHSPの仕様があることを 覚えておいてください。

1.フルカラーモード

65536色、1670万色、または8ビットを越えるカラーモードのこ とを言います。1670万色モードでは、指定された色がそのまま 発色され、65536色では指定された色に近い色が発色します。 色数の多い画像を同時に表示しても、色が変になることはあり ません。ただし、一般的にパレットモードよりも描画スピード が遅くなることが多く、HSPで使用するRAMの量も増加します。

2.パレットモード

256色以下のカラーモードのこと。
画面上に256色までしか同時に使用できないうえに、すでに Windowsでは20色のスタティックカラーを使っているので、 HSPで自由に使えるのは236色以下になります。
従って、色数の多い画像を同時に表示させると、色がおかし くなったり、元と違う色で表示されることがあります。
HSPでは、パレットモードでもJPEG画像が表示できるように、 自動的に220色のパレットを設定してフルカラーに近い色で表 示されるようになっています。
パレットモードでは、一般的にフルカラーモードよりも描画 速度が速くなり、HSPで使用するRAMの量も少なくて済みます。

以上の点から、フルカラーモードでも、パレットモードでも動作する スクリプトを作る場合には、以下のような注意が必要です。
普段、フルカラーモードでスクリプトが正常に動いていたのに、パレ ットモードに変更したとたんに表示がおかしくなった場合なども、多 くは次のような原因によるものです。

1. 16色、256色の画像を同時に表示しない

パレットモードでは、16,256色の画像をロードした時点で、 それまで表示されていた画像がウインドゥ内に残っていた場合、 色がおかしくなることがあります。JPEG画像はフルカラーな ので問題はありませんが、MAG,BMPファイルを複数のウインドゥ で表示する時には注意しなければなりません。その場合には、 一番手前にあるウインドゥのパレットがすべての画像に適用 されて正確な色が再現されなくなります。
パレットモードでも、複数の画像を同時に正確に表示したい 場合は、すべてのパレットを同じにしておいてください。

2. 8ビットカラーは256色でなく230色までを使用するようにする

パレットモードでは上にあるように、236色以下しか使用でき ません。256色をフルに使っている画像などは、画像の一部が 変な色になってしまう可能性があります。これを避けるため に、最初から230色程度までしか使用しないで画像を作っておく か、ツールなどで減色しておくことをおすすめします。

以上の点に注意してスクリプトやデータを作成すれば、パレットモード でも正常に動作するはずです。どうしても、この制限が回避できない 時は、フルカラーモードのみで動作するスクリプトになってしまいま す。そのような場合は、システム変数paluseで判断して、フルカラー モード専用を知らせるメッセージを出すように作っておくと、より親切 です。

gcopy命令を使う時の注意点

HSPでは、高速化のために画面の点(ドット)を４つで一組にして取り扱うことがあります。 screen,buffer,bgscr命令などで初期化するウインドゥの 横方向(X)サイズが4の倍数でない 場合には、gcopy命令で高速なコピー、透明色付きのコピーなどを行なう時に、画像が 斜めに崩れることがあります。(通常モード、gmode 0の時には起こりません) 初期化されるウインドゥのサイズはデフォルトの640などは4の倍数ですが、 150とか、250など4の倍数でない横サイズは、高速な処理には向いていないので避けるよう お願いします。

また、gcopyでのコピーモード設定は、描画対象になっているウインドゥIDに設定されることに 注意してください。たとえば、ID2からID0に画像をコピーしたい場合には、gcopy命令をID0に 対して実行するので、 ID0に対してgmodeの設定をしなければなりません。 (ウインドゥIDごとにgmodeの設定が保持されているため) 正常にモードが設定されないと感じる時には、以上の点に注意してgmode命令を記述してください。

さらにおまけ情報ですが、gcopy命令を使ってフルカラーモードでのフェードイン・アウトを実現できます。 コピーモード3(半透明合成コピー)を指定して半透明合成時のブレンド率を変化させながら、コピーを行なうことでフェードの表現を行ないます。ブレンド率は0〜256の値となり、256で完全なコピーになり、0の場合はコピーしていないのと同じことになります。 gmode命令のパラメータ設定については以下わ参考にしてください。

gmode p1,p2,p3,p4			[画面コピーモード設定]

	p1=0〜4(0)   : 画面コピーモード
	                0 = 通常のコピー(bitblt)
	                1 = メモリ間コピー
	                2 = 透明色付きコピー
	                3 = 半透明合成コピー
	                4 = 透明色付き半透明合成コピー
	p2,p3        : コピーする大きさX,Y（ドット単位）
	p4=0〜256(0) : 半透明合成時のブレンド率

小数値の記述について

スクリプト中にパラメータとして小数値を記述することができます。 ただし、これは実数を完全にサポートしているということではありません。 小数値を32bitまたは64bitのバイナリデータとして扱い、プラグインやAPIに データを受け渡すことを可能にするものです。 HSPでの完全な実数サポートは、多くの方からご要望を頂いていて、実現したい ことの1つですが、実行速度をあまり損なわずにサポートするためには、 システムの大幅な改修が必要なため、それまでは拡張プラグイン側での 小数サポートを可能にする措置として取り急ぎ実装したものとお考え下さい。

スクリプトに記述可能な値として以下の型が用意されています。

モード	型	記述形式
0	整数値	1
1	固定小数値	1.0k
2	単精度浮動小数値(float)	1.0f
3	倍精度浮動小数値(double)	1.0d

記述した数値の最後に「k」「f」「d」などの識別子が付いているものを 小数値として扱います。識別子がないものは通常の整数として扱われ 小数点がある場合にはエラーとなります。

識別子「k」は、固定小数値(整数のうち何ビットかを小数部とする) として扱うための整数値に変換して扱います。 固定小数値の小数部ビットは#fpbit命令で設定可能です。 識別子「f」は、単精度浮動小数(float)値を32bitの整数値データ として扱います。通常の整数と同様に変数に代入して扱うことが できますが、あくまで特殊な意味を持つfloat値のデータだという ことに注意してください。 識別子「d」は、倍精度浮動小数(double)値を8文字の文字列データ として扱います。double値のデータは可読不可能な64bit(8文字)の バイナリデータとなります。 小数を記述していても、あくまで"abcdefgh"のような文字列として 判断されますので注意してください。

モード2,3は、拡張プラグインや外部DLL呼び出しなどでfloat値や double値を扱う必要がある場合のため用意されたものです。 HSP単体での浮動小数の演算や変換はできませんのでご了承ください。

ver2.55においてモード3(倍精度浮動小数)は正常に動作致しません。
将来的には倍精度のサポートを行なっていく予定ですが、現状では未サポートとなっていますのでご了承ください。

#fpbit p1

	p1 : 固定小数値の小数部bit数(0〜31)

	小数値格納モードが固定小数値(モード1)の場合に変換される
	固定小数部のビット数を設定します。
	デフォルトは16bitになっています。
	この場合に「1.0」という小数を指定したとすると、固定小数では
	「65536」という整数として扱われます。

スクリプト内での小数の記述は、

「1.23f」、「0.5d」、「10k」

のように識別子を含む形で書いてください。小数点は省略が可能です。 ただし「0.5」を「.5」と書くことはできません。数字で始まり、 小数点を含んでいる必要があります。 また、小数点の後には数字が続いていなければなりません。 (1.0fや1fと書くことはできますが、1.fと書くことはできません)

Windowsシャットダウン時の動作について

ver2.55から、Windowsシャットダウン時(再起動、電源を落とす等)にも onexit命令による終了処理が実行されるように変更されました。 これにより、スクリプト実行中にシャットダウンが起こった場合でも、 それを検知して適切な終了処理を行なうことが可能になりましたが、 以下のような制限がありますので、終了時を判定するスクリプトを作成 する場合は、留意しておいてください。

• onexitでジャンプされた直後は、システム変数iparamに終了要因が値として保存されています。
  iparam = 0 の場合は、ユーザーの意思でプログラムを終了。
  iparam = 1 の場合は、Windowsシャットダウンによる終了です。
  
• Windowsシャットダウン時の終了処理には、await、wait、stop命令 などでシステムにアイドルタイム(待ち時間)を発生させた場合には、 シャットダウン処理を中止します(シャットダウンされません)。 await、wait、stop命令を使わずにend命令で終了した場合には、 そのままシャットダウン処理が継続されます。

シャットダウン処理を中止させないで、終了処理を行ないたい場合には、 待ち時間の発生する命令(await、wait、stop命令など)は使用できません。 (ただし、コモンダイアログ(dialog命令)などは使用できます) 最小限の終了処理だけを行なって、そのまま終了するようにしてください。

キー入力割り込み命令について

ver2.55では、ver2.6で完全にサポートされる予定の割り込み機能が一部のみですが 実装されています。これらの命令(onkey、onclick)などは、現在以下のような仕様で 使うことができます。これらの命令はβ扱いとして組み込まれているもので、将来の バージョンで仕様が変更される可能性もありますのでご了承下さい。

onkey goto *label			キー割り込み実行指定
onclick goto *label			マウスクリック割り込み実行指定

	*label : 割り込み時に実行されるラベル

キーおよびマウスクリック時に割り込み実行を行なう設定をします。 onkey命令でラベルを指定すると、それ以降はHSPのウインドゥがアクティブな時に キー入力があるたびに*labelで指定したラベルにジャンプします。 onclick命令でラベルを指定すると、それ以降はHSPのウインドゥ上でマウスクリック が行なわれるたびに*labelで指定したラベルにジャンプします。

割り込みジャンプは、stop命令および、wait、await命令で停止している時に 割り込みを受け付けてジャンプを行います。 また、割り込みによりジャンプを行なった後は以下のシステム変数がセットされ ます。

割り込み要因	iparam	wparam	lparam
onkey	文字コード	wParam	lParam
onclick	マウスボタンID	wParam	lParam

システム変数iparamには、割り込み要因ごとのパラメータが代入されます。 また、wparam,lparamはWindowsメッセージとして渡されたパラメータが そのまま格納されています。

イベント割り込み実行の一時的なON/OFFをすることも可能です。

	onkey 0

で一時的にキー割り込みを停止します。

	onkey 1

で一時停止したキー割り込みを再開させることができます。 同様に、

	onclick 0 / onclick 1

も使用できます。 また、前のバージョンで使用されていたonexit命令も割り込み実行の一部として 管理されるようになりました。これも、onkeyやonclickと同様に、

	onexit goto *label

のような使い方や、

	onexit 0 / onexit 1

のように使用することが可能です。

割り込み要因	iparam	wparam	lparam
onexit	終了要因	wParam	lParam

ver2.55では、以上の機能までしか含まれていませんが、最終的には onkey gosubやon click gosubのような復帰可能な割り込み処理ルーチンの 作成が可能になります。復帰可能な割り込み処理ルーチン内を実行中は、 他の割り込みは保留(キューイング)されて多重に割り込みが発生するのを 保護します。 また、ユーザーが任意のWindowsメッセージを取得できる機能も追加される予定です。