Emuera/exfunc - Revision history

CRER: Fix page linking

2023-07-16T04:11:56Z

Fix page linking

CRER: Move over exfunc page

2023-06-29T17:53:14Z

Move over exfunc page

New page

== 関数 ==

=== @EVENTLOAD ===
----
データをロードした直後に呼び出されます。 
イベント関数なので複数定義することができます。 
@EVENTLOADが定義されていない場合、@SHOW_SHOPへ移行します（eramakerと同じ動作）

=== @TITLE_LOADGAME ===
----
標準のタイトル画面でロードを選択した場合に呼び出されます。 
@TITLE_LOADGAMEを定義することでタイトルでも独自のロード画面を使用することができます。 
定義されていない場合、標準のロード画面が使用されます。 
@SYSTEM_TITLEを定義した場合、明示的にCALLしない限り@TITLE_LOADGAMEが呼ばれることはありません。

=== @SYSTEM_AUTOSAVE ===
----
オートセーブが行われるタイミングで呼び出されます。 
オートセーブの内容を独自に定めることができます。 
定義されていない場合、標準のセーブ機能が使用されます。

=== @SYSTEM_TITLE ===
----
csvのロードが終了したタイミングで呼び出されます。 
また、BEGIN TITLEによっても呼び出されます。 
@SYSTEM_TITLEを定義することで独自のタイトル画面を使用することができます。 
定義されていない場合、標準のタイトル画面が使用されます。

=== @CALLTRAINEND ===
----
CALLTRAINによる自動実行が終了後、システム内部から自動的に呼び出される関数です。 
イベント関数ではないため多重定義できないことに注意してください。

=== 自作関数における引数指定 ===
----
※1.54uまでと1.60以降で仕様が異なります！※ 
==== 書式 ====
----
関数側
<pre>
　　　@(関数名),(引数1),{(引数2)....}
　　　引数は数値ならARG(:0,1,2...)、文字列ならARGS(:0,1,2...)
　　　関数中で#DIM、#DIMSを用いて定義したプライベート変数も引数に指定可能
</pre>
呼び出し側
<pre>
　　　CALL (関数名),(引数1),{(引数2)....}
</pre>
数値は数式または文字列式が使用できます。 
文字列リテラル（定数）を引数にするときは""でくくってください。 
書式付の文字列リテラルを引数にするときは@"～～"で書いてください。 
CALL以外にJUMP、CALLFORM、TRYCALLなどでも同じ書式が使えます。 
関数側の引数はいくつでも指定できます。 
ver1.808現在、関数側と呼び出し側で型が異なる場合、数値から文字列、文字列から数値に関わらず変換せずエラーになります。 
ver1.807以前と同様に文字列型の引数に数値を与えて呼び出したい場合、[config#h5-.E3.83.A6.E3.83.BC.E3.82.B6.E3.83.BC.E9.96.A2.E6.95.B0.E3.81.AE.E5.BC.95.E6.95.B0.E3.81.AB.E8.87.AA.E5.8B.95.E7.9A.84.E3.81.ABTOSTR.E3.82.92.E8.A3.9C.E5.AE.8C.E3.81.99.E3.82.8B コンフィグ設定]を変更するか、[exmeth#h5-str.20TOSTR.28int.20value.2C.20str.20format.20.3D.20.22.22.29 TOSTR関数]を用いてください。 
引数は省略できます。省略した場合、数値型の場合は0、文字列型の場合は空文字列が代入されます（初期値を設定していない場合）。 
呼び出された関数側ではARGとARGSで渡された値を参照できます 
基本的に値渡しなのでARGの中身を変更しても渡した元の変数等の値は変化しないことに注意してください。 
ARGやARGS、または関数中で#DIM、#DIMSを用いて定義したプライベート変数以外の変数（AやSTR）を引数にすることも可能ですが、いくつか制限があります。 
ver1.808現在、これらの変数を用いた場合は初期値を設定できず、また引数を省略できません。
<pre>
;定義
@FOOBAR, ARG:0, ARGS:0
～～
@HOGEHOGE, ARG:0, ARG:1, ARG:2
～～
;呼び出し
;変数で指定
CALL FOOBAR, X , STR:0
;定数で指定
CALL FOOBAR, 123 , "あいう"
;書式付文字列で指定
CALL FOOBAR, 123 , @"[{COUNT}] あいう"
;式で指定
CALL FOOBAR, X + 10, "あいう" * 10
;引数の省略-全部
CALL FOOBAR
;引数の省略-第１引数
CALL FOOBAR, , "あいう"
;引数の省略-第２引数
CALL FOOBAR, 123
<pre/>

<pre>
<エラーになる例>
;エラー(引数が多すぎる)
CALL FOOBAR, X , STR:0, Y
;エラー(引数の型が違う-数値型の第1引数に文字列を代入しようとしている)
CALL FOOBAR, "あいう", "かきく"
;エラー(引数の型が違う-文字列型の第2引数に数値を代入しようとしている)
CALL FOOBAR, 123 , 456
<動作はするが推奨されない例>
;代入先はARG、ARGSでなくても可能ですが、通常はARGを使うことを推奨します
@FOOBAR, X, Y
;代入先を可変にすることも可能ですが可読性が下がります。
@FOOBAR, ARG:X, ARG:Y
;可読性が下がります。
@FOOBAR, ARG:0, ARG:(ARG:0)
</pre>

==== 引数の初期値 ====
----
関数の引数に初期値を設定することができます。 
初期値を設定する場合、関数側は以下のようになります。
<pre>
　　　@(関数名),(引数1 = 初期値1),{(引数2 = 初期値2)....}
　　　引数は数値ならARG(:0,1,2...)、文字列ならARGS(:0,1,2...)、
　　　または関数中で#DIM、#DIMSを用いて定義したプライベート変数
　　　それ以外を指定した場合初期値は設定できません。
</pre>
指定可能な初期値は定数および定文字列のみで、変数は指定できません。 
また文字列の初期値は""でくくってください。 
初期値を設定し、呼び出し側が引数を省略した場合、初期値に設定した値が代入されます。 
省略せずに関数を呼び出した場合は、通常通りARGとARGSに渡された値が代入されます。
<pre>
;初期値設定（部分省略もできます）
@FUNCTION, ARGS:0 = "かきく", ARG:0 = 111, ARG:1, ARG:2 = 200
～～

;エラー(初期値は定数および定文字列のみ)
@FOOBAR, ARG:0 = MASTER, ARG:1 = TARGET
;ARG、ARGS,関数中で#DIM,#DIMSを用いて定義したプライベート変数以外の引数に初期値を設定しても無視されます。
;そのため想定通りの動作ができません。
@FOOBAR, X = 5, Y = 4
</pre>

==== 引数の参照渡し ====
----
ver1.810から、参照型変数を仮引数にすることで引数の参照渡しができるようになりました。 
参照型変数の定義方法は[UserVars#h4-.E5.8F.82.E7.85.A7.E5.9E.8B.E5.A4.89.E6.95.B0 参照型変数]の項を確認してください。 
<xxx.ERB>
<pre>
@SYSTEM_TITLE
A = 0
CALL TEST(A)
B = 1
CALL TEST(B)
PRINTFORML A == {A}
PRINTFORML B == {B}
WAIT

@TEST(HOGE)
#DIM REF HOGE
HOGE = 100
RETURN

</pre>
<実行結果>
<pre>
A == 100
B == 100
</pre>
上の例で関数TESTは仮引数に参照型変数を持ちます。 
1回目にTESTが呼ばれたとき、HOGEは実引数Aを参照するようになります。 
関数TEST中でHOGE = 100とすることで参照先の変数Aに100が代入されるので1回目のPRINTFORMLの結果は100になります。 
同様に2回目のTESTが呼ばれると変数Bに100が代入され、2回目のPRINTFORMLの結果も100になります。

== 属性 ==
----
関数の仕様や動作を決定するプリプロセッサです。 
関数に#から始まるプリプロセッサを記述する場合、関数の直下にしなくてはなりません。
=== #ONLY ===
----
イベント関数専用の属性です。 
#ONLYが指定されたイベント関数がある場合、その1つのみが実行され、他の同名イベント関数を実行されません。 
また#ONLYが指定された同名イベント関数が複数ある場合も実行されるのは「最初の1つ」のみとなります。 

=== #FUNCTION ===
----
式中関数の属性です。 
式中関数は通常のRETURNで終了することはできず、代わりにRETURNF <数式>で終了する必要があります。 
詳しくは[UserMeth ユーザー定義の式中関数]を参照してください。

=== #FUNCTIONS ===
----
式中関数の属性です。 
式中関数は通常のRETURNで終了することはできず、代わりにRETURNF <文字列式>で終了する必要があります。 
詳しくは[UserMeth ユーザー定義の式中関数]を参照してください。

== 定義 ==
----
変数の名前やその仕様を定義するプリプロセッサです。 
関数に#から始まるプリプロセッサを記述する場合、関数の直下にしなくてはなりません。
=== #LOCALSIZE <定数式> ===
----
=== #LOCALSSIZE <定数式> ===
----
関数ごとに個別にLOCALおよびLOCALSの要素数を指定するためのプリプロセッサです。 
定数式の結果は0より大きい整数である必要があり、それ以外もしくは変数を含んだ式や解釈できない文字列が与えられた場合は無視されます。 
無視された場合またはこのプリプロセッサを使用しなかった場合は通常通り!VariableSize.csvの設定値を使用します。 
イベント関数にこのプリプロセッサを使用した場合、一番最初に実行されるものの設定が使用されます(ver1800現在)。

=== #DIM ===
----
ユーザー定義変数宣言です。ERB中の特定の関数内で使用することで、その関数内でのみ使用可能な数値型変数を定義できます。 
詳しくは[UserVars ユーザー定義の変数]を参照してください。 
また、ERH中で使用することで、すべての関数で値を共有できる数値型変数を定義できます。 
詳しくは[ERH ヘッダーファイル（ERH）]を参照してください。

=== #DIMS ===
----
ユーザー定義変数宣言です。ERB中の特定の関数内で使用することで、その関数内でのみ使用可能な文字列型変数を定義できます。 
詳しくは[UserVars ユーザー定義の変数]を参照してください。
また、ERH中で使用することで、すべての関数で値を共有できる文字列型変数を定義できます。 
詳しくは[ERH ヘッダーファイル（ERH）]を参照してください。

=== #DEFINE ===
----
DEFINEマクロの宣言です。ERH中で使用することで、全ERBコード中の文字列をあらかじめ定義した別の文字列へ置換することができます。 
詳しくは[ERH ヘッダーファイル（ERH）]を参照してください。

== 特殊なブロックを表す行 ==
----
これらはプリプロセッサ行です。 
これらを記述した同一行において、その直後に続けて命令や関数やコメントなどを記述してはいけません。 
これらはeramakerでは解釈できないためコーディングするときに場合によっては;!;を使う必要があります。

=== [SKIPSTART] ===
----
=== [SKIPEND] ===
----
<code>[SKIPSTART]から[SKIPEND]までの間に書いた行はEmueraでは読み込まれず実行されません。</code> 
これはEmueraとeramakerで挙動を意図的に変えたいときに使われるものです。 
Emueraでは実行してほしくない文を記述する際に使ってください。 
また、;!;と併用することで、Emuera以外では実行してほしくない文を記述することができます。 
詳しくは[exetc 一般]の項目を参照してください。

=== [IF XXX] ===
----
=== [ELSEIF XXX] ===
----
=== [ELSE] ===
----
=== [ENDIF] ===
----
ある名称XXXのマクロが定義されているかどうかによって複数の行を実行するかどうか、分岐することができます。 
詳しくは[ERH ヘッダーファイル（ERH）]を参照してください。

=== [IF_DEBUG] ===
----
====[ ENDIF] ====
----
<code>[IF_DEBUG]から[ENDIF]までの間に書いた行はデバッグモード時のみ実行されます。</code> 
非デバッグモード時はコメント行と見なされ実行されません。 
ただし、DEBUG系命令は元々非デバッグモード時には無視されるので、;#;を行頭に付ける必要はありません。 
同様にデバッグ変数も非デバッグモード時には空文字列又は0のため、エラーの心配はありません。 
デバッグモードについては[debug こちら]を参照してください。

=== [IF_NDEBUG] ===
----
=== [ENDIF] ===
----
<code>[IF_NDEBUG]から[ENDIF]までの間に書いた行は非デバッグモード時のみ実行されます。</code> 
デバッグモード時はコメント行と見なされ実行されません。 
<code>[IF_DEBUG]とは判定が逆になっています。</code> 
デバッグモードについては[debug こちら]を参照してください。

@@ Line 53: / Line 53: @@
 関数側の引数はいくつでも指定できます。<br>
 ver1.808現在、関数側と呼び出し側で型が異なる場合、数値から文字列、文字列から数値に関わらず変換せずエラーになります。<br>
-ver1.807以前と同様に文字列型の引数に数値を与えて呼び出したい場合、[config#h5-.E3.83.A6.E3.83.BC.E3.82.B6.E3.83.BC.E9.96.A2.E6.95.B0.E3.81.AE.E5.BC.95.E6.95.B0.E3.81.AB.E8.87.AA.E5.8B.95.E7.9A.84.E3.81.ABTOSTR.E3.82.92.E8.A3.9C.E5.AE.8C.E3.81.99.E3.82.8B コンフィグ設定]を変更するか、[exmeth#h5-str.20TOSTR.28int.20value.2C.20str.20format.20.3D.20.22.22.29 TOSTR関数]を用いてください。<br>
+ver1.807以前と同様に文字列型の引数に数値を与えて呼び出したい場合、[[../config#ユーザー関数の引数に自動的にTOSTRを補完する|コンフィグ設定]]を変更するか、[[../exmeth#str TOSTR(int value, str format = "")|TOSTR関数]]を用いてください。<br>
 引数は省略できます。省略した場合、数値型の場合は0、文字列型の場合は空文字列が代入されます（初期値を設定していない場合）。<br>
 呼び出された関数側ではARGとARGSで渡された値を参照できます<br>
@@ Line 128: / Line 128: @@
 ----
 ver1.810から、参照型変数を仮引数にすることで引数の参照渡しができるようになりました。<br>
-参照型変数の定義方法は[UserVars#h4-.E5.8F.82.E7.85.A7.E5.9E.8B.E5.A4.89.E6.95.B0 参照型変数]の項を確認してください。<br>
+参照型変数の定義方法は[[../UserVars#Reference Type Variables|参照型変数]]の項を確認してください。<br>
 <xxx.ERB>
 <pre>
@@ Line 171: / Line 171: @@
 式中関数の属性です。<br>
 式中関数は通常のRETURNで終了することはできず、代わりにRETURNF <数式>で終了する必要があります。<br>
-詳しくは[UserMeth ユーザー定義の式中関数]を参照してください。
+詳しくは[[../UserMeth|ユーザー定義の式中関数]]を参照してください。
 === #FUNCTIONS ===
@@ Line 177: / Line 177: @@
 式中関数の属性です。<br>
 式中関数は通常のRETURNで終了することはできず、代わりにRETURNF <文字列式>で終了する必要があります。<br>
-詳しくは[UserMeth ユーザー定義の式中関数]を参照してください。
+詳しくは[[../UserMeth|ユーザー定義の式中関数]]を参照してください。
 == 定義 ==
@@ Line 195: / Line 195: @@
 ----
 ユーザー定義変数宣言です。ERB中の特定の関数内で使用することで、その関数内でのみ使用可能な数値型変数を定義できます。<br>
-詳しくは[UserVars ユーザー定義の変数]を参照してください。<br>
+詳しくは[[../UserVars|ユーザー定義の変数]]を参照してください。<br>
 また、ERH中で使用することで、すべての関数で値を共有できる数値型変数を定義できます。<br>
-詳しくは[ERH ヘッダーファイル（ERH）]を参照してください。
+詳しくは[[../ERH|ヘッダーファイル（ERH）]]を参照してください。
 === #DIMS ===
 ----
 ユーザー定義変数宣言です。ERB中の特定の関数内で使用することで、その関数内でのみ使用可能な文字列型変数を定義できます。<br>
-詳しくは[UserVars ユーザー定義の変数]を参照してください。
+詳しくは[[../UserVars|ユーザー定義の変数]]を参照してください。
 また、ERH中で使用することで、すべての関数で値を共有できる文字列型変数を定義できます。<br>
-詳しくは[ERH ヘッダーファイル（ERH）]を参照してください。
+詳しくは[[../ERH|ヘッダーファイル（ERH）]]を参照してください。
 === #DEFINE ===
 ----
 DEFINEマクロの宣言です。ERH中で使用することで、全ERBコード中の文字列をあらかじめ定義した別の文字列へ置換することができます。<br>
-詳しくは[ERH ヘッダーファイル（ERH）]を参照してください。
+詳しくは[[../ERH|ヘッダーファイル（ERH）]]を参照してください。
 == 特殊なブロックを表す行 ==
@@ Line 225: / Line 225: @@
 Emueraでは実行してほしくない文を記述する際に使ってください。<br>
 また、;!;と併用することで、Emuera以外では実行してほしくない文を記述することができます。<br>
-詳しくは[exetc 一般]の項目を参照してください。
+詳しくは[[../exetc|一般]]の項目を参照してください。
 === [IF XXX] ===
@@ Line 236: / Line 236: @@
 ----
 ある名称XXXのマクロが定義されているかどうかによって複数の行を実行するかどうか、分岐することができます。<br>
-詳しくは[ERH ヘッダーファイル（ERH）]を参照してください。
+詳しくは[[../ERH|ヘッダーファイル（ERH）]]を参照してください。
 === [IF_DEBUG] ===
 ----
-====[  ENDIF] ====
+====[ENDIF] ====
 ----
 <code>[IF_DEBUG]から[ENDIF]までの間に書いた行はデバッグモード時のみ実行されます。</code><br>
@@ Line 246: / Line 246: @@
 ただし、DEBUG系命令は元々非デバッグモード時には無視されるので、;#;を行頭に付ける必要はありません。<br>
 同様にデバッグ変数も非デバッグモード時には空文字列又は0のため、エラーの心配はありません。<br>
-デバッグモードについては[debug こちら]を参照してください。
+デバッグモードについては[[../debug|こちら]]を参照してください。
 === [IF_NDEBUG] ===
@@ Line 255: / Line 255: @@
 デバッグモード時はコメント行と見なされ実行されません。<br>
 <code>[IF_DEBUG]とは判定が逆になっています。</code><br>
-デバッグモードについては[debug こちら]を参照してください。
+デバッグモードについては[[../debug|こちら]]を参照してください。