phoenix(仮) - コマンドヘルプ

Quit

プログラムを終了する。

※

引数なし

→top

Restart

プログラムを再起動する。

引数を指定するとコマンドライン引数としてプログラム実行時に使用される。

コマンドライン引数の取得はCommandLineArgs関数で行う。

※

Restart args1 args2 args3 ...

args1, args2, args3 ...

プログラム実行時に使用されるコマンドライン引数

→top

GoTo

指定したラベルにジャンプ。

GoTo labelName

labelName

ラベル名。存在しないラベル名を指定した場合、エラーとなる

→top

Call

指定したラベルにジャンプし、Returnコマンド実行時にCallコマンドの次の行に復帰する。

このコマンドは省略が可能。

Call labelName args args ...

labelName args

ラベル名。存在しないラベル名を指定した場合、エラーとなるジャンプ先のラベルで使用できる引数。複数指定ができる。呼び出しはArgs関数を使用する

	テスト:
	    #「テロップ テスト文章」でも呼び出し可能
	    Call テロップ テスト文章
	Exit

	テロップ:
	    PaintString - - args(1)
	Return

→top

Return

最後にCallコマンドが実行された箇所にジャンプする。

Call関数で呼び出されていた場合、引数の値が実行結果として式に渡される。

Return value

value

Call関数で呼び出されていた場合、返却する値

Callコマンド参照

→top

If

条件分岐を実行する。

「If～Then～Endif」までを1セットとして扱い、Then、Endifのない場合はエラーとなる。

また、条件式は半角括弧「()」で括る必要がある。

条件式に使用できる演算子についてはこちらを参照。

If ( condition1 ) Then

commands1

Else

commands2

Else If ( condition2 ) Then

commands3

Endif

condition1 commands1 commands2 condition2 commands3

条件式 condition1が「true」の場合に実行されるコマンド condition1が「false」の場合に実行されるコマンド condition1が「false」の場合に実行される条件式 condition2が「true」の場合に実行されるコマンド

	If (a > 3) then
	    #変数「a」が3より大きいとき
	Else
	    #変数「a」が3未満のとき
	Endif

→top

Switch

条件式の値にあわせて対応するコマンドを実行する。

「Switch～Case～Endsw」までを1セットとして扱い、Endswのない場合はエラーとなる。

Switch ( condition1 )

Case value

commands1

Case Else

commands2

Endsw

condition value commands1 commands2

条件式 conditionと比較される値 conditionとvalueが一致していた場合に実行されるコマンドいずれのvalueとも一致しなかった場合に実行されるコマンド

	Switch (a)
	Case "ABC"
	    #変数「a」が"ABC"であるとき
	Case "DEF"
	    #変数「a」が"DEF"であるとき
	Case Else
	    #いずれにも当てはまらない場合
	Endsw

→top

Do

条件式がtrueである間、コマンドを繰り返し実行する。

「Do～Loop」までを1セットとして扱い、Loopのない場合はエラーとなる。

条件式を指定しない場合、無限ループとなるがBreakコマンドでループを抜けることが可能。

また、Skipコマンドでそのループを1回分飛ばすことが可能。

Do

commands

Loop

commands

繰り返し実行されるコマンド

この場合無限ループとなる。

Do While ( condition )

commands

Loop

condition commands

条件式。最初からfalseだった場合、commandsは実行されない繰り返し実行されるコマンド

	# マウス左ボタンがクリック（して離される）されるまで待つ
	ClickWait:
	    do while (keystate(1) == false)
	    loop
	    do while (keystate(1) == true)
	    loop
	return

Do

commands

Loop While ( condition )

condition commands

条件式。最初からfalseだった場合でも、commandsが実行される繰り返し実行されるコマンド

For

コマンドを一定回数繰り返し実行する。

「For～Next」までを1セットとして扱い、Nextのない場合はエラーとなる。

Breakコマンドでループを抜ける、Skipコマンドでそのループを1回分飛ばすことが可能。

For var = initNum To last [Step stepNum]

commands

カウンタに使用する変数名カウンタを初期化する値カウンタの最終値カウンタの加算値。省略した場合は1、負の値を設定することが可能

	For i = 1 To 10
	    # Beep.wavを再生する
	    PlaySound Beep.wav
	    # 1秒待つ
	    Wait 10
	Next

→top

ForEach

配列の要素に対してコマンドを実行する。

「ForEach～Next」までを1セットとして扱い、Nextのない場合はエラーとなる。

Breakコマンドでループを抜ける、Skipコマンドでそのループを1回分飛ばすことが可能。

ForEach varName in array

commands

arrayの1要素が格納される変数名配列

	# unitIDArrayに格納されたユニットの出撃状態を「未出撃(false)」に変更する
	ForEach unitID in unitIDArray
	    # 出撃状態を「未出撃(false)」に変更
	    UpdateUnit unitID 出撃 false
	Next

→top

Skip

Do、For、ForEachコマンドで実行されているループを一回分スキップする。

Skip

引数なし

	# pilotIDArrayに格納されたパイロットの残り行動回数が3未満だった場合3にする
	ForEach pilotID in pilotIDArray
	    If ( Pilot(パイロット, pilotID, 残り行動回数) > 3 ) Then
	        Skip
	    Endif
	    UpdatePilot pilotID 残り行動回数 3
	Next

→top

Break

Do、For、ForEachコマンドで実行されているループを終了する。

ループを抜けるまでのコマンドは全てスキップされる。

Break

引数なし

	Do
	    # マウスの右クリックが押されたらループを抜ける
	    If ( keystate( 2 )  == true) Then
	        Break
	    Endif
	    
	    ClearPicture
	    Circle Random(480) Random(320) 32
	    Refresh
	    Wait 0.1
	Loop

→top

Global

グローバル変数を作成する。

作成された変数はラベル間で自由に書き換え、読み込みが可能となる。

Global varName1 varName2 …

varName1

作成する変数名

	Global 交戦フラグ
	Set 交戦フラグ false

Global varName1 = expression

varName1 expression

作成する変数名変数に代入する式、または値

	Global 開始日時 = Date()

→top

GlobalByVar

指定された変数に格納された名称でグローバル変数を作成する。

作成された変数はラベル間で自由に書き換え、読み込みが可能となる。

各引数には変数（または式）が指定可能。

GlobalByVar var1 var2 …

varName1

作成する変数名を格納した変数

	Local 変数名1 = "撤退フラグ"
	Local 変数名2 = "突撃フラグ"
	GlobalByVar 変数名1 変数名2
	## グローバル変数「撤退フラグ」「突撃フラグ」が設定される

GlobalByVar var1 = expression

var1 expression

作成する変数名を格納した変数変数に代入する式、または値

	Local 変数名1 = "終了日時"
	GlobalByVar 変数名1 = Date()
	## グローバル変数「終了日時」に値が設定される

→top

Local

ローカル変数を作成する。

作成された変数は作成したラベル内でのみ使用が可能。

別のラベルで同名の変数が作成されていた場合、別のものとして処理される。。

ラベルを移動（Return）した時点で変数は破棄される。

Local varName1 varName2 …

varName1

作成する変数名

	Local 元文字列
	Set 元文字列 "ユニット："

Local varName1 = expression

varName1 expression

作成する変数名変数に代入する式、または値

	Local 描画X座標 = Unit(ユニット, unitID, 画面X) + 32

→top

LocalByVar

指定された変数に格納された名称でローカル変数を作成する。

作成された変数は作成したラベル内でのみ使用が可能。

別のラベルで同名の変数が作成されていた場合、別のものとして処理される。。

ラベルを移動（Return）した時点で変数は破棄される。

各引数には変数（または式）が指定可能。

LocalByVar var1 var2 …

var1

作成する変数名を格納した変数

	Local 変数名1 = "敵攻撃力"
	Local 変数名2 = "味方攻撃力"
	LocalByVar 変数名1 変数名2
	## ローカル変数「敵攻撃力」「味方攻撃力」が設定される

LocalByVar var = expression

var expression

作成する変数名を格納した変数変数に代入する式、または値

	Local 変数名1 = "元文字列"
	LocalByVar 変数名1 = "パイロット："
	## ローカル変数「元文字列」に値が設定される

→top

Set

変数を書き換える。

対象の変数が存在しなかった場合、ローカル変数に設定される（「Local var = expression」と同等）。

Set varName expression

varName expression

対象とする変数名変数に書き込む値。省略時には「true」が設定される

	Local 元文字列
	Set 元文字列 "ユニット："

	Global 交戦フラグ
	Set 交戦フラグ
	#「true」が設定される

→top

SetByVar

指定された変数に格納された名称の変数を書き換える。

対象の変数が存在しなかった場合、ローカル変数に設定される（「Local var = expression」と同等）。

引数「varName」には変数（または式）が指定可能。

SetByVar var expression

var expression

対象とする変数名変数に書き込む値。省略時には「true」が設定される

	Local 元文字列
	Local 変数名1 = "元文字列"
	SetByVar 変数名1 "ユニット："
	# 変数「元文字列」に「ユニット：」が設定される

	Global 交戦フラグ
	Local 変数名1 = "交戦フラグ"
	SetByVar 交戦フラグ
	# 変数「交戦フラグ」に「true」が設定される

→top

Swap

変数の値を入れ替える。

Swap varName1 varName2

varName1 varName2

入れ替えの対象となる変数名入れ替えの対象となる変数名

	Local varA = "あ"
	Local varB = "い"
	Swap varA varB
	# 結果：varA = "い" varB = "あ"

→top

Sort

配列の値をソートする。

Sort arrayName 降順

arrayName 降順

対象とする配列名降順でソートを行う。省略時は昇順

	Local varA
	varA[1] = 3
	varA[2] = 1
	varA[3] = 2
	Sort varA
	# 結果
	# varA[1] = 1
	# varA[2] = 2
	# varA[3] = 3

→top

UnSet

変数を消去する。

同名の配列が存在していた場合、それらも含めて消去される。

Unset varName

varName

消去する変数名

	# 変数「varA」だけでなく変数「varA[***]」も消去される
	Unset varA

	varA[2] = "test"
	varA[2][0] = "test0"
	varA[2][1][3] = "test03"
	
	# 配列の要素を消去
	# この時、varA[2][0]、varA[2][1][3]も同時に削除される
	Unset varA[2]

→top

Array

文字列を分割して変数の配列を作成する。

グローバル変数に同名の変数名が存在した場合、グローバル変数として作成される。

存在しない場合、ローカル変数として作成される。

配列の添え字は1が初期値となる。

Array varName srcString separator

varName srcString separator

作成する配列名元となる文字列区切り文字

	Array arrayA "aaa,bbb,ccc,ddd" ","
	# 結果
	# arrayA[1] = aaa
	# arrayA[2] = bbb
	# arrayA[3] = ccc
	# arrayA[4] = ddd

→top

ArrayByVar

文字列を分割して変数の配列を作成する。

グローバル変数に同名の変数名が存在した場合、グローバル変数として作成される。

存在しない場合、ローカル変数として作成される。

配列の添え字は1が初期値となる。

引数「varName」には変数（または式）が指定可能。

Array varName srcString separator

varName srcString separator

作成する配列名元となる文字列区切り文字

	Array arrayA "aaa,bbb,ccc,ddd" ","
	# 結果
	# arrayA[1] = aaa
	# arrayA[2] = bbb
	# arrayA[3] = ccc
	# arrayA[4] = ddd

→top

CopyArray

配列のコピーを作成する。

グローバル変数に同名の変数名が存在した場合、グローバル変数として作成される。

存在しない場合、ローカル変数として作成される。

CoppyArray arrayName1 arrayName2

arrayName1 arrayName2

コピー元の配列名コピー先の配列名

	Array arrayA "aaa,bbb,ccc,ddd" ","
	CopyArray arrayA arrayB
	# 結果
	# arrayB[1] = aaa
	# arrayB[2] = bbb
	# arrayB[3] = ccc
	# arrayB[4] = ddd

→top

UpVar

Callコマンドの呼び出し元の引数を使用可能にする。

UpVar

引数なし

	元ラベル:
	    Call 呼び出し1 "AAA"
	Exit

	呼び出し1:
	    Call 呼び出し2 "BBB"
	Return

	呼び出し2:
	    # args(1) = "BBB"
	    UpVar
	    # args(1) = "BBB"
	    # args(2) = "AAA"
	Return

→top

Const

定義した後に変更不能なグローバル変数（定数）を作成する。

Const varName = value

varName value

定数の名称定数に設定する値

→top

ClearEvent

ラベルを消去する。

既にラベルが消去されている場合でもエラーは発生しない。

ClearEvent labelName

labelName

消去するラベル名。省略した場合、現在実行しているラベルが指定される

	元ラベル:
	    Call 消去されるラベル
	    ClearEvent 消去されるラベル
	    # エラー
	    Call 消去されるラベル
	Exit

	消去されるラベル:
	    # 処理
	Return

	元ラベル:
	    Call 1回だけ実行
	    # エラー
	    Call 1回だけ実行
	Exit

	1回だけ実行:
	    # 処理
	    ClearEvent
	Return

→top

RestoreEvent

消去されたラベルを復帰する。

既にラベルが復帰している場合でもエラーは発生しない。

RestoreEvent labelName

labelName

復帰するラベル名

	元ラベル:
	    Call 消去されるラベル
	    ClearEvent 消去されるラベル
	    RestoreEvent 消去されるラベル
	    # 実行される
	    Call 消去されるラベル
	Exit

	消去されるラベル:
	    # 処理
	Return

→top

SetLine

指定したラベルの行に現在の実行行を設定する。

SetLine labelName lineNum

labelName lineNum

設定するラベル名設定する行数

→top

SetCallInfo

現在のラベル呼び出し情報を変更する。

ラベル呼び出し情報はReturnコマンドで呼び出し元に戻るときに使用される。

無限ループが発生する可能性があるため、設定するラベル名、行数には注意が必要。

SetCallInfo labelName lineNum

labelName lineNum

設定するラベル名設定する行数

ラベルA:
	SetLayer 最上層 10
	Call ラベルB
	PaintString - - "スキップされる行"
	PaintString - - "スキップされない行"
	Refresh
	Wait 5
return

ラベルB:
	# このラベルが呼び出された行を含むラベル名を取得する
	Local nowCallLabel = Script( "呼び出し元ラベル" )
	# このラベルが呼び出された行数を取得する
	Local nowCallNum = Script( "呼び出し元行" )
	
	SetCallInfo nowCallLabel (nowCallNum + 1)
	## 下記のreturnでは「Call ラベルB」の次の行から再開するのではなく、その次の「PaintString - - "スキップされない行"」から処理が再開する
return

→top

RemoveCallInfo

現在のラベル呼び出し情報を1階層分消去する。

RemoveCallInfo

ラベルA:
	call ラベルB
return

ラベルB:
	RemoveCallInfo
	## 次のreturnでは「ラベルA」には戻らず、「呼び出し元」に戻る
return


呼び出し元:
	call ラベルA
return

→top

SetLayer

描画先レイヤーを設定する。

1つのレイヤーにつき100層のサブレイヤーが設定可能。初期状態は「最下層」の1番。

サブレイヤーは番号の若い順に描画される。(番号が若いほど下)

SetLayer layer subLayerNum

layer subLayerNum

描画先レイヤーサブレイヤー番号(1～100)

最上層

マップ上層レイヤー上（マップ上層）

ユニットレイヤー上（ユニット上）

マップ下層レイヤー上｛マップ下層）

最下層

	# 描画先を最上層レイヤーの1番に設定
	SetLayer 最上層 1
	# 文字列「描画テスト」を描画
	PaintString - - "描画テスト"
	Refresh

!!TODO:画像入れる!!

→top

SetDrawPoint

ウィンドウの基準座標を変更する。

デフォルトは(0,0)。

SetDrawPoint X Y

X Y

X座標 Y座標

	# ウィンドウの基準座標を(32,32)に変更
	SetDrawPoint 32 32

!!TODO:画像入れる!!

→top

Refresh

ウィンドウの描画状態を更新する。

PaintPicture、PaintString、ClearPictureなどの描画コマンドの描画結果を画面に反映する。

このコマンドを実行しない限り、描画した画像などはウィンドウに表示されない。

Refresh

引数なし

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1
	# test.pngを描画
	Paintpicture test.png - -
	# 文字列「描画テスト」を描画
	PaintString - - "描画テスト"
	Refresh

!!TODO:画像入れる!!

→top

ClearPicture

PaintPicture、PaintStringコマンドなどで描画された内容を消去する。

Refreshコマンドを実行するまでウィンドウは更新されない、。

ウィンドウ全体の消去。

ClearPicture

引数なし

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1
	# 文字列「描画テスト1」を描画
	PaintString - - "描画テスト1"
	# 画面を消去
	ClearPicture
	# 文字列「描画テスト2」を描画
	PaintString - - "描画テスト2"
	Refresh

!!TODO:画像入れる!!

レイヤー指定で画像を消去。

ClearPicture layer subLayerNum

layer subLayerNum

描画先レイヤーサブレイヤー番号

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1
	# 文字列「描画テスト1」を描画
	PaintString - - "描画テスト1"
	# 描画先を最上層レイヤーの2番に設定
	SetLarer 最上層 2
	# 文字列「描画テスト2」を描画
	PaintString - - "描画テスト2"
	# 画面を消去
	ClearPicture 最上層 2
	Refresh

!!TODO:画像入れる!!

短径指定で画像を消去。

ClearPicture x1 y1 x2 y2

x1 y1 x2 y2

開始地点X座標開始地点Y座標終了地点X座標終了地点Y座標

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1
	# 文字列「描画テスト1」を描画
	PaintString - - "描画テスト1"
	# 描画先を最上層レイヤーの2番に設定
	ClearPicture 最上層 2
	Refresh

!!TODO:画像入れる!!

ピクチャーID指定で画像を消去。

ClearPicture pictureID

pictureID

PaintOptionコマンドで指定可能なピクチャーID

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1
	# ピクチャーID「test1」を設定し、文字列「描画テスト1」を描画
	PaintOption "test1"
	PaintString - - "描画テスト1"
	# ピクチャーID「test2」を設定し、文字列「描画テスト2」を描画
	PaintOption "test2"
	PaintString - - "描画テスト2"
	# 画面を消去
	ClearPicture "test1"
	Refresh

!!TODO:画像入れる!!

→top

PaintOption

次に実行される描画コマンドの描画オプションを設定する。

オプションは一度で複数を設定可で順番は自由。引数なしでデフォルトに設定を戻す。

PaintOption

PaintOption サイズ width height

PaintOption 左右反転

PaintOption 上下反転

PaintOption 右回転 angle

PaintOption 左回転 angle

PaintOption 変形 x1 y1 x2 y2 x3 y3 x4 y4

PaintOption 切り抜き x y width height

PaintOption pictureID

サイズ-width サイズ-height 左右反転上下反転右回転(左回転)-angle 変形-x1 y1 x2 y2 x3 y3 x4 y4 切り抜き-x y 切り抜き-width 切り抜き-height pictureID

拡大縮小して描画する際の幅拡大縮小して描画する際の高さ左右反転して描画する上下反転して描画する右回転(左回転)して描画する際の角度変形する際の短径XY座標。右回りに指定し、左上座標は0。負の値を指定可能切り抜き描画する際の画像内座標。左上座標は0。負の値を指定可能切り抜き描画する際の幅切り抜き描画する際の高さ描画された画像を識別するID

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	# さんぷるこーど

	Refresh

!!TODO:画像入れる!!

→top

FilterOption

次に実行される描画コマンドのフィルタオプションを設定する。

オプションは一度で複数を設定可で順番は自由。引数なしでデフォルトに設定を戻す。

ぼかしフィルタを適用した場合、描画短径の範囲に効果が適用される。

FilterOption

FilterOption カラー colorCode persent

FilterOption 輝度 colorCode

FilterOption 明度 bright

FilterOption 色調反転

FilterOption ぼかし gauss

FilterOption レベル levelMin levelMax levelGamma levelAfterMin levelAfterMax

FilterOption 色相 hue

FilterOption 彩度 intensity

カラー-colorCode カラー-persent 輝度-colorCode 明度-bright 色調反転ぼかし-gauss レベル-levelMin レベル-levelMax レベル-levelGamma レベル-levelAfterMin レベル-levelAfterMax 彩度-hue 色相-intensity

カラーフィルタで使用する16進数のカラーコードカラーフィルタの濃度 0 から 100 までの整数輝度フィルタで使用する16進数のカラーコード。未設定で#FFFFFF 明度フィルタで使用する -255 から 255 までの整数画像の色調を反転して描画するぼかしフィルタで使用する 0 から 255 までの値レベル補正フィルタで使用する変換元の下限値( 0 ～ 255 ) レベル補正フィルタで使用する変換元の上限値( 0 ～ 255 ) レベル補正フィルタで使用するガンマ値。デフォルトは100 レベル補正フィルタで使用する変換後の下限値( 0 ～ 255 ) レベル補正フィルタで使用する変換後の上限値( 0 ～ 255 ) 彩度フィルタで使用する -255 から 0 までの整数色相フィルタで使用する -180 から 180 までの整数

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	# さんぷるこーど

	Refresh

!!TODO:画像入れる!!

→top

BlendOption

次に実行される描画コマンドの合成オプションを設定する。

引数なしでデフォルトに設定を戻す。

BlendOption

BlendOption blend param

blend param

合成方法 0 から 255 までの整数(通常/noneの場合不要)

合成方法

アルファ、alpha、不透明加算、add 減算、sub 乗算、mula 反転、invsrc 維持、srccolor XOR、xor 通常、none

アルファ（不透明度）合成を行う。0 で完全に透明加算合成を行う。0 で完全に透明減算合成を行う。0 で完全に透明乗算合成を行う。0 で完全に透明反転合成を行う。0 で完全に透明透明度を維持して描画を行う。パラメータは何を指定しても255固定 XOR合成を行う。0 で完全に透明特に合成を行わない。デフォルト

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	# さんぷるこーど

	Refresh

!!TODO:画像入れる!!

→top

PaintPicture

画像を描画する。

対応している画像のフォーマットは「Bmp」「Png」「Jpeg」。

透明度（アルファ値）を持った画像の描画にも対応している。

「ファイル名_a」という画像を同フォルダ内に格納すると、その画像を描画時の透明度情報として使用する。

その場合、透明度情報用画像の色が黒（RGB(0,0,0)）に近いほど描画時に透明となる。

使用する場合「透過」を引数に指定する必要がある。

PaintPicture fileName x y [ 透過 colorCode ]

fileName x y colorCode

画像ファイル名。検索開始フォルダは「.\Database\」描画時のX座標描画時のY座標画像を透過する場合の透過色を表すカラーコード

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	# さんぷるこーど

	Refresh

!!TODO:画像入れる!!

→top

PaintSprite

分割画像を描画する。

対応している画像のフォーマットは「Bmp」「Png」「Jpeg」。

透明度（アルファ値）を持った画像の描画にも対応している。

「ファイル名_a」という画像を同フォルダ内に格納すると、その画像を描画時の透明度情報として使用する。

その場合、透明度情報用画像の色が黒（RGB(0,0,0)）に近いほど描画時に透明となる。

使用する場合「透過」を引数に指定する必要がある。

PaintSprite fileName width height num x y [ 透過 colorCode ]

fileName width height num x y colorCode

画像ファイル名。検索開始フォルダは「.\Database\」分割する際の高さ分割する際の幅分割した画像の番号。0が開始値で左上から順に採番される描画時のX座標描画時のY座標画像を透過する場合の透過色を表すカラーコード

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	# さんぷるこーど

	Refresh

!!TODO:画像入れる!!

→top

PaintAnime

アニメーション画像を描画する。

対応している画像のフォーマットは「Bmp」「Png」「Jpeg」。

透明度（アルファ値）を持った画像の描画にも対応している。

「ファイル名_a」という画像を同フォルダ内に格納すると、その画像を描画時の透明度情報として使用する。

その場合、透明度情報用画像の色が黒（RGB(0,0,0)）に近いほど描画時に透明となる。

使用する場合「透過」を引数に指定する必要がある。

PaintAnime fileName width height start end afterProc afterStart speed x y [ 透過 colorCode ]

fileName width height start end afterProc . . . . . afterStart speed x y colorCode

画像ファイル名。検索開始フォルダは「.\Database\」分割する際の幅分割する際の高さアニメ開始番号。0が開始値で左上から順に採番されるアニメ終了番号。0が開始値で左上から順に採番されるアニメ終了後の処理を表す数値（0 ～ 4） 0 : 最初のコマに戻る 1 : 最後のコマで停止する 2 : 消去される 3 : 「afterStart」からアニメを再生する 4 : 「afterStart」を表示後、停止するアニメ終了後の開始番号アニメ再生スピード( 1/60秒 * speed ) 描画時のX座標描画時のY座標画像を透過する場合の透過色を表すカラーコード

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	# さんぷるこーど

	Refresh

!!TODO:画像入れる!!

→top

Font

PaintStringコマンドで適用されるフォントを変更する。

引数なしでデフォルト設定。

デフォルト：Font "ＭＳゴシック" 16px regular #FFFFFF

フォントファイル(ttf)を「Database」ディレクトリ直下に配置することで使用することが可能。（βv0.05暫定仕様）

Font "Italic" "Bold" "Regular" "アンチエイリアス" (fontSize)px fontName colorCode

"Italic" "Bold" "Regular" "アンチエイリアス" fontSize fontName colorCode

イタリック(斜体)を適用するボールド(太字)を適用するイタリック、ボールドを解除するアンチエイリアスを適用する（フォントとサイズによって文字が潰れる可能性があります）フォントの大きさ。px指定フォント名文字色を表すカラーコード

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	# さんぷるこーど

	Refresh

!!TODO:画像入れる!!

→top

PaintString

文字列を描画する。書体、サイズなどはFontコマンドで設定可能。

画像描画に比べると実行速度が遅い。

このコマンドのみエスケープシーケンスを使用可能。描画時のみ特定の文字に置換される。

エスケープシーケンスは次の四種。「\s」⇒「/」　「\d」⇒「"」　「\p」⇒「(」　「\q」⇒「)」

PaintString X Y string

X Y string

文字列を描画するX座標。"-"を指定すると画面中央に描画される文字列を描画するY座標。"-"を指定すると画面中央に描画される文字列

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	paintstring - 220 "phoenix(仮) ver0.0"
	paintstring - 240 "テストシナリオ"

	Refresh

!!TODO:画像入れる!!

PaintString string

string

文字列

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	paintstring "文字列描画テスト"

	Refresh

!!TODO:画像入れる!!

PaintString X Y string "true"

X Y string "true"

文字列を描画するX座標。"-"を指定すると画面中央に描画される文字列を描画するY座標。"-"を指定すると画面中央に描画される文字列特殊アンチエイリアスフラグ

このオプションを指定した上でFontコマンドにおいて「アンチエイリアス」を指定すると、

小さなサイズのフォント用のアンチエイリアス処理を実行する

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	font "アンチエイリアス"
	paintstring - - "文字列描画テスト" "true"

	Refresh

!!TODO:画像入れる!!

→top

ShapeOption

Circle、Box、Polygonなどの、図形描画コマンドの描画方法を設定する。

引数なしでデフォルト設定。

デフォルト：1px #000000 塗りつぶし #FFFFFF

ShapeOption

ShapeOption thickness borderColor [塗りつぶし isFill]

thickness borderColor fillColor

線の太さ（ 0～）線の色塗りつぶしの色（「-」を指定することで透過）、「塗り潰し」でも可

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1


	Refresh

!!TODO:画像入れる!!

→top

Arc

円弧、または扇形を描画する。

画像描画に比べると実行速度が遅い。

例 X Y radius startAngle endAngle

X Y radius startAngle endAngle

円弧を描画するX座標。円の中心円弧を描画するY座標。円の中心円弧の半径開始角度終端角度

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1


	Refresh

!!TODO:画像入れる!!

→top

Oval

比率を指定可能な楕円を描画する。

画像描画に比べると実行速度が遅い。

Oval X Y radiusH radiusV

X Y radiusH radiusV

楕円を描画するX座標。円の中心楕円を描画するY座標。円の中心楕円の水平方向の半径楕円の水平方向の半径

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1


	Refresh

!!TODO:画像入れる!!

→top

Circle

円を描画する。

画像描画に比べると実行速度が遅い。

Circle X Y radius

X Y radius

円を描画するX座標。円の中心円を描画するY座標。円の中心円の半径

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1


	Refresh

!!TODO:画像入れる!!

→top

Line

線を描画する

画像描画に比べると実行速度が遅い。

Line startX startY endX endY

startX startY endX endY

線の始端X座標線の始端Y座標線の終端X座標線の終端Y座標

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1


	Refresh

!!TODO:画像入れる!!

→top

Box

四角形を描画する。

画像描画に比べると実行速度が遅い。

Box X Y width height

X Y width height

四角形の描画X座標（左上）四角形の描画Y座標（左上）四角形の幅四角形の高さ

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1


	Refresh

!!TODO:画像入れる!!

→top

Polygon

多角形を描画する。

画像描画に比べると実行速度が遅い。

Polygon X1 Y1 X2 Y2 X3 Y3 ... Xn Yn

Xn Yn

多角形の頂点X座標。右回りに指定する多角形の頂点Y座標。右回りに指定する

※座標指定は最低3個が必須指定となり、[ X Y ]はセット。

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1


	Refresh

!!TODO:画像入れる!!

→top

Pixel

1pxの点を描画する。

画像描画に比べると実行速度が遅い。

Pixel X Y color

X Y color

点の描画X座標点の描画Y座標 16進数のカラーコード

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1


	Refresh

!!TODO:画像入れる!!

→top

BasePoint

ウィンドウ左上の描画基準座標を設定する。

初期設定はX=0、Y=0。

このコマンドで設定される描画基準座標はすべての画像描画（マップ、ユニット含む）に適用される。

BasePoint X Y

X Y

描画基準X座標（整数）描画基準Y座標（整数）

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1


	Refresh

!!TODO:画像入れる!!

→top

MapPoint

マップ左上の描画基準座標を設定する。

初期設定はX=0、Y=0。

このコマンドで設定される描画基準座標はマップ、ユニットの描画に適用される。

BasePoint X Y

X Y

描画基準X座標（整数）描画基準Y座標（整数）

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1


	Refresh

!!TODO:画像入れる!!

→top

SetPicturePoint

すでに描画済みの画像、または図形の描画座標を変更する。

このコマンドを使用する場合、PaintOptionコマンドでピクチャーIDを指定しておく必要がある。

座標の変更はRefreshコマンドを実行することで反映される。

SetPicturePoint pictureID X Y

pictureID X Y

PaintOptionコマンドで指定されたピクチャーID 描画基準X座標（整数）描画基準Y座標（整数）

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	# ピクチャーIDを「ピクチャー1」に設定
	PaintOption "ピクチャー1"

	# 画像をX座標100、Y座標100の位置に描画
	PaintPicture "Graphics\Test.png" 100 100
	Refresh
	
	# 5秒待つ
	Wait 5

	# ピクチャーID「ピクチャー1」を設定された画像の座標をX座標200、Y座標200に変更する
	SetPicturePoint "ピクチャー1" 200 200
	Refresh

!!TODO:画像入れる!!

→top

SetZOrder(βv0.12現在廃止中)

指定したピクチャIDを持つ画像の描画順を設定する。

設定した値が小さいほど奥に描画される。また、この値はレイヤー単位で適用される。

座標の変更はRefreshコマンドを実行することで反映される。

このコマンドを実行していない場合、Z座標は0が指定されている。

SetZOrder pictureID Z

pictureID Z

PaintOptionコマンドで指定されたピクチャーID Z座標

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1

	# ピクチャーIDを「ピクチャー1」に設定
	PaintOption "ピクチャー1"

	# 画像をX座標100、Y座標100の位置に描画
	PaintPicture "Graphics\TestA.png" 100 100
	
	# Z座標を設定
	SetZOrder "ピクチャー1" 10
	
	# ピクチャーIDを「ピクチャー1」に設定
	PaintOption "ピクチャー2"

	# 画像をX座標150、Y座標150の位置に描画
	PaintPicture "Graphics\TestBb.png" 150 150
	
	# Z座標を設定
	SetZOrder "ピクチャー2" 5
	Refresh
	
	## ピクチャー2をあとに描画しているが、ピクチャー1のほうが手前に表示される
	
	
	SetLarer 最上層 2
	# ピクチャーIDを「ピクチャー1」に設定
	PaintOption "ピクチャー3"

	# 画像をX座標125、Y座標125の位置に描画
	PaintPicture "Graphics\TestC.png" 125 125
	
	# Z座標を設定
	SetZOrder "ピクチャー3" 0
	refresh
	
	## この場合、ピクチャー3はもっとも低いZ座標を指定しているが手前に表示される
	## ※描画先レイヤーがほかの画像よりも手前であるため

!!TODO:画像入れる!!

→top

PlayMidi

Midiファイルを再生する。または一時停止中のMidiを再生再開する。

引数は順序どおり指定し、指定しなかった場合それ以降を省略する。

PlayMidi fileName "ループ" "停止" volume tempo fadeinTime fadeoutTime seek pitch

fileName "ループ" "停止" volume tempo fadeinTime fadeoutTime seek pitch

ファイル名ループ再生を行う。CC#111の位置がループ開始位置として認識される。しない場合は「-」最初から停止した状態でMIDIファイルをロードする。しない場合は「-」再生ボリューム( 0 ～ 100 ) テンポ( 0.1 ～ 8 )　※デフォルト「1」ピッチ( -8191 ～ 8191 )　※デフォルト「0」再生開始時のフェードイン時間（ミリ秒）再生停止時のフェードイン時間（ミリ秒）再生開始位置（TICK単位）

PlayMidi

引数なし

→top

StopMidi

再生中のMidiを停止する。

フェードアウト時間が設定されていた場合、音量が徐々に小さくなり、音量0になった段階で停止する。

StopMidi

引数なし

→top

PauseMidi

再生中のMidiを一時停止する。

フェードアウト時間が設定されていても、フェードアウトしない。

PauseMidi

引数なし

→top

MidiOption

再生、一時停止中のMidiに再生オプションを設定する。

MidiOption "ループ" [ "音量" volume ] [ "テンポ" tempo ] [ "ピッチ" pitch ] [ "シーク" seek ]

"ループ" [ "音量" volume ] [ "テンポ" tempo ] [ "ピッチ" pitch ] [ "シーク" seek ]

ループ再生を行う。CC#111の位置がループ開始位置として認識される再生ボリューム( 0 ～ 100 ) テンポ( 0.1 ～ 8 )　※デフォルト「1」ピッチ( -8191 ～ 8191 )　※デフォルト「0」再生開始位置（TICK単位）

→top

PlaySound

オーディオファイルを再生する。対応ファイル形式はWav、mp3、ogg。

引数なしの場合、一時停止中のすべてのオーディオを再生再開する。

PlaySound fileName

fileName

ファイル名

※ループなしで1度だけ再生される。

PlaySound fileName volume

fileName volume

ファイル名再生音量

※ループなしで1度だけ再生される。

PlaySound fileName soundID "ループ" "停止" volume pan frequency startPos loopStartPos

fileName soundID "ループ" "停止" volume pan frequency startPos loopStartPos

ファイル名一時停止中のサウンドID ループ再生を行う最初から一時停止した状態にする再生音量（ 0 ～ 100 ）左右の音量バランス（ -10000 ～ 10000 ）再生周波数(デフォルト値は各オーディオファイルによって異なります) 再生開始位置。再生位置はサンプル単位ループ時再生開始位置。再生位置はサンプル単位

※ループ、停止、音量、バランス、周波数、再生開始位置、ループ時再生開始位置は"-"を指定することでデフォルトとなる。

PlaySound soundID

soundID

一時停止中のサウンドID

PlaySound

引数なし

→top

StopSound

オーディオの再生を停止する。指定していたサウンドIDは削除される。

引数なしの場合、全てのオーディオの再生を停止。

StopSound soundID

soundID

再生中のサウンドID

→top

PauseSound

再生中のオーディオを一時停止する。

引数なしの場合、全てのオーディオの再生を一時停止。

PauseSound soundID

soundID

再生中のサウンドID

→top

SoundOption

再生（または一時停止中）のオーディオに再生オプションを設定する。

SoundOption soundID [ "音量" volume ] [ "パン" pan ] [ "周波数" frequency ]

soundID [ "音量" volume ] [ "パン" pan ] [ "周波数" frequency ]

サウンドID 再生音量（ 0 ～ 100 ）左右の音量バランス（ -10000 ～ 10000 ）再生周波数

→top

ChangeMap

マップを変更する。

全てのユニットのマップ上存在フラグがfalseに変更される。

"非同期"オプションを設定した場合、Refreshコマンドを実行するまで画面は更新されない。

また、ファイル名に"-.map"を指定した場合、マップ情報をすべて破棄する。

ChangeMap fileName "非同期"

fileName "非同期"

マップファイル名画面の更新方法

	# 描画先を最上層レイヤーの1番に設定
	SetLarer 最上層 1


	Refresh

!!TODO:画像入れる!!

→top

Load

データフォルダをロードする。

指定したデータフォルダがロード済みであってもエラーは発生せず、ロード処理も実行されない。

Load folderName

folderName

ロードするデータフォルダ名

→top

Forget

Loadコマンドでロードしたデータフォルダを削除する。

そのフォルダに含まれている、既に作成されたユニット、パイロット、アイテムデータは削除される。

Forget folderName

folderName

削除するデータフォルダ名

→top

Unit

ユニットを作成する。

作成したデータにはそれぞれ固有のIDが割り振られる。

Unit dataName

dataName

データ名称

→top

RemoveUnit

Unitコマンドで作成したユニットを削除する。

装備中のアイテム、搭乗中のパイロットのデータは削除されない

RemoveUnit unitID

dataName

ユニットID

→top

ReplaceUnit

ユニットデータを入れ替える。

HP、ENなどのステータスはすべて初期状態に変更される。

座標情報、マップ上存在フラグ、描画フラグは入れ替え前の値が使用される。

ReplaceUnit unitID dataName

unitID dataName

ユニットID データ名称

→top

UpdateUnit

ユニットの持つステータスを書き換える。

UpdateUnit unitID case value ...

unitID case value

ユニットID 書き換えるステータス名値

⇒書き換え可能なステータス名と値

値を参照するためにはUnit()関数を使用する。

→top

Pilot

パイロットを作成する。

作成したデータにはそれぞれ固有のIDが割り振られる。

Pilot dataName

dataName

データ名称

→top

RemovePilot

Pilotコマンドで作成したパイロットを削除する。

RemovePilot pilotID

pilotID

パイロットID

→top

ReplacePilot

パイロットデータを入れ替える。

データで定義されているステータスはすべて初期状態に変更される。

現在SP、獲得EXP、レベル、気力、適用スペシャルパワー、残り行動回数は入れ替え前の値が使用される。

また、ユニットに付与する武器、アビリティの残弾数も入れ替え前の値が使用される。

ReplacePilot pilotID dataName

pilotID dataName

パイロットID データ名称

→top

UpdatePilot

パイロットの持つステータスを書き換える。

UpdatePilot pilotID case value ...

pilotID case value

パイロットID 書き換えるステータス名値

⇒書き換え可能なステータス名と値

値を参照するためにはPilot()関数を使用する。

→top

Item

アイテムを作成する。

作成したデータにはそれぞれ固有のIDが割り振られる。

Item dataName

dataName

データ名称

→top

RemoveItem

Itemコマンドで作成したパイロットを削除する。

RemoveItem itemID

itemID

アイテムID

→top

ReplaceItem

アイテムデータを入れ替える。

ユニットに付与する武器、アビリティの残弾数は入れ替え前の値が使用される。

ReplaceItem itemID dataName

itemID dataName

アイテムID データ名称

実行画面例

→top

UpdateItem

アイテムの持つステータスを書き換える。

UpdatePilot itemID case value ...

itemID case value

アイテムID 書き換えるステータス名値

⇒書き換え可能なステータス名と値

値を参照するためにはItem()関数を使用する。

→top

Require

スクリプトファイルを読み込む。

既に読み込み済みのスクリプトファイルを指定してもエラーは発生せず、処理も行われない。

Require fileName

fileName

ファイル名

→top

Disuse

Requireコマンドで読み込まれたスクリプトファイルを削除する。

現在実行中のラベルが存在するスクリプトファイルは削除できない。

Disuse fileName

fileName

ファイル名

→top

LoadCSV

CSVファイルを読み込む。

既に同じ名称のデータを読み込んでいた場合でもエラーは発生せず、処理を行わない。

CSVファイルは1行目にフィールド名を記述し、二行目からデータ部を記述する。

フィールド名が空白だけで構成されていた場合、エラーとなる。

LoadCSV fileName dataName

fileName dataName

ファイル名データの名称

→top

RemoveCSV

LoadCSVコマンドで読み込まれたCSVデータを削除する。

RemoveCSV dataName

dataName

LoadCSVコマンドで指定したデータの名称

→top

SetTitle

ウィンドウタイトルを設定する。

SetTitle title

title

ウィンドウタイトル

→top

Open

指定したファイルをテキスト形式で読み込む。

一度に操作できるファイルは1つまでで、次のファイルを開くにはCloseコマンドでいったんファイルを閉じる必要がある。

Open fileName for mode

fileName mode

ファイル名ファイルを開くモード。 "出力"：Printコマンドの出力結果でファイルの内容が上書きされる。 "追加出力"：Printコマンドの出力結果はファイル末尾に追加される。 "入力"：LineReadコマンドでファイル内容を読み込む。

→top

Close

Openコマンドで開かれているファイルを閉じる。

Printコマンドの出力結果はこのコマンドが実行される際にファイルへ書き込まれる。

Close

引数なし

→top

Print

Openコマンドで開かれているファイルに文字列を書き込む。

書き込まれた内容はCloseコマンドを実行したタイミングでファイルに反映される。

Print string

string

文字列

→top

LineRead

Openコマンドで開かれているファイルから一行読み込み、変数に格納する。

LineRead var

var

読み込まれた内容を格納する変数名

→top

CopyFile

ファイルを指定したディレクトリにコピーする。

CopyFile srcFileName copyFileName

srcFileName copyFileName

コピー元のファイル名コピー先のファイル名

→top

RemoveFile

ファイルを削除する。

RemoveFile fileName

fileName

ファイル名

→top

RenameFile

ファイル名を変更する

RenameFile fileName toName

fileName toName

元ファイル名変更後ファイル名

→top

CreateFolder

フォルダを作成する。

CreateFolder folderName

folderName

作成するフォルダ名称

→top

RemoveFolder

フォルダを削除する。

RemoveFolder folderName

folderName

削除するフォルダ名称

→top

MoveFolder

フォルダを移動する。

例 srcFolderName toFolderName

srcFolderName toFolderName

移動対象となるフォルダ名移動先のフォルダ名

→top

Input

IME入力を開始する。リターンキーが押されるか、Escキーが押されると入力を終了する。

入力中文字列のフォントはFontコマンド、IME変換ウィンドウの色はSetIMEColorで指定することが可能。

Input strNum X Y

strNum X Y

最大入力文字数（バイト単位）入力中文字列の表示X座標入力中文字列の表示Y座標

入力した値はInputStr関数で取得可能。

Input strNum X Y varName defaultString

strNum X Y varName defaultString

最大入力文字数（バイト単位）入力中文字列の表示X座標入力中文字列の表示Y座標入力結果を保持する変数名デフォルト文字列（省略可）

入力した値は第四引数「varName」に保持されるが、InputStr関数でも取得可能。

→top

SetIMEColor

Inputコマンドでの入力中に表示されるIME変換ウィンドウの色を設定する。

SetIMEColor changingStrColor notChangingStrColor changingAreaCursorColor changingBgColor IMEBorderColor IMEBgColor

changingStrColor notChangingStrColor changingAreaCursorColor changingBgColor IMEBorderColor IMEBgColor

変換候補の文字色未変換時の文字背景色変換範囲カーソル

→top

Wait

指定された秒数だけコマンド実行を一時停止する。

小数点以下の数値を指定可能だが、画面のリフレッシュ時間(1/60秒)未満のウェイトは非推奨。

また、一時停止している状態でもPaintAnimeコマンドなどで描画されたアニメーションは停止しない。

Wait secound

secound

一時停止する時間（秒）

→top

Timer

Timer startを実行した時間を0秒として、指定した時間が経つまでコマンド実行を一時停止する。

小数点以下の数値を指定可能だが、画面のリフレッシュ時間(1/60秒)未満のウェイトは非推奨。

また、一時停止している状態でもPaintAnimeコマンドなどで描画されたアニメーションは停止しない。

Timer "start"

"start"

この引数を指定してTimerコマンドを実行した時間がタイマー基準時間となる。

Timer secound

secound

「Timer "start"」を実行した時間を基準にした一時停止する時間（秒）

Timer "start"
Timer 10
##10秒経つまで停止

##～色々な処理～

Timer 15
##15秒経つまで停止するが、処理の実行によってすでに15秒以上経過していた場合は停止せずスキップされる

→top

SaveScreen

現在表示されている画面を画像ファイルとして保存する。

SaveScreen type fileName

type fileName

画像ファイルの形式(png、bmp、jpeg）ファイル名称

→top

phoenix(仮) - コマンドヘルプ

実行制御

ラベル制御

基本構文

変数操作

画面描画

音声操作

データ制御

スクリプト操作

CSV操作

ファイル操作

入力制御

その他

Quit

Restart

GoTo

Call

Return

If

Switch

Do

For

ForEach

Skip

Break

Global

GlobalByVar

Local

LocalByVar

Set

SetByVar

Swap

Sort

UnSet

Array

ArrayByVar

CopyArray

UpVar

Const

ClearEvent

RestoreEvent

SetLine

SetCallInfo

RemoveCallInfo

SetLayer

SetDrawPoint

Refresh

ClearPicture

PaintOption

FilterOption

BlendOption

PaintPicture

PaintSprite

PaintAnime

Font

PaintString

ShapeOption

Arc

Oval

Circle

Line

Box

Polygon

Pixel

BasePoint

MapPoint

SetPicturePoint

SetZOrder(βv0.12現在廃止中)

PlayMidi

StopMidi

PauseMidi

MidiOption

PlaySound

StopSound

PauseSound

SoundOption

ChangeMap

Load

Forget

Unit