ユーザ定義関数の定義

Magicエンジン > ユーザ定義関数

[ロジック]エディタからCtrl+Hを押下することでヘッダラインが追加されます。ここに、以下の情報を入力することで機能を定義することができます。

名前

ユーザ定義関数の名前を入力します。最大30字の文字を入力できます。同じ名前を入力することもできます。関数名には、文字や数字、アンダスコアを含めることができます。空白やDBCSまたは特殊文字を含めることはできません。

スコープ

以下のオプションがあります。

  • T=タスク …… 関数は、現在のタスクでのみ有効です。

  • S=サブツリー …… 関数は、サブタスクでも有効です。

  • G=グローバル(メインプログラム) …… 関数をコンポーネントの一部として公開することができます。

戻り値

呼出したタスクに返す値を式で設定することができます。

戻り値の設定は、必須でありません。

戻り値は、どのような型の値でも指定できます。

実行

ロジックユニットの実行先を指定します。この特性はリッチクライアントタスクでのみ表示されます。オプションは以下の通りです。

  • O=最適化:(デフォルト) …… 処理フローに基づいてサーバ上かクライアント上で実行されます。

  • S=サーバ …… サーバ上で実行されます。

この特性は、[関数]か[イベント]ロジックユニットでのみ有効です。「サーバ」と指定されたロジックユニット内では、ニュートラル(どちらでも実行可能)、またはサーバ側の処理コマンドのみ有効です。

ヘルプ文字列

F12を押下して、コメントボックス内にテキストを入力することによって、ユーザ定義関数に関する簡単なヘルプを作成することができます。

/*Replaces a specified token by another string*/

というように、/*と*/の間に文字列を入力します。

表示可能な文字数は58桁です。改行することで縦3桁まで表示できます。

ユーザ定義関数を選択すると、ヘルプが[関数一覧]の底辺に表示されます。

参照