ＲＰＧキャラクター制御関数

関数一覧

RpgCharaOn	キャラクターをアクティブにする
RpgCharaOff	キャラクターを非アクティブにする
RpgCharaAllOff	全てのキャラクターを非アクティブにする
RpgCharaTurn	キャラクターの向きを設定する
RpgCharaLookAt	キャラクターを特定のキャラクターの方向へ向ける
RpgCharaPos	キャラクターの位置を設定する
RpgCharaPosX	キャラクターのX座標を取得・設定する
RpgCharaPosY	キャラクターのY座標を取得・設定する
RpgCharaWarp	キャラクターをワープさせる
RpgCharaMove	キャラクターを移動させる
RpgCharaMovePos	キャラクターを指定座標に移動させる
RpgCharaMoveTo	キャラクターを経路探索で移動させる
RpgCharaToPlayer	キャラクターをプレーヤーの位置まで移動させる
RpgCharaDrag	キャラクターをドラッグ移動させる
RpgCharaDragPos	キャラクターを指定座標にドラッグ移動させる
RpgCharaAlpha	キャラクターの不透明度を設定する
RpgCharaColor	キャラクターのカラーを設定する
RpgCharaImage	キャラクターのイメージを設定する
RpgCharaStep	キャラクターの足踏みを設定する
RpgCharaBatch	キャラクターにバッチ処理を設定する
RpgCharaJump	キャラクターにジャンプ演出を設定する
RpgCharaSwing	キャラクターに揺れ演出を設定する
RpgCharaBaloonOn	キャラクターのバルーンを表示する
RpgCharaBaloonOff	キャラクターのバルーンを非表示にする
RpgCharaRegion	キャラクター位置のリージョン番号を取得する

RpgPoliceStan	PRG衛兵を気絶状態にする
RpgPoliceOverlook	PRG衛兵を気絶状態にする
RpgPoliceTumeshoMap	RPG衛兵に設定された詰所のマップ名を取得する

関数詳細

RpgCharaOn()

機能

キャラクターをアクティブにします

書式

void RpgCharaOn( charaName )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)

戻り値

なし

RpgCharaOff()

機能

キャラクターを非アクティブにします

書式

void RpgCharaOff( charaName )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)

戻り値

なし

RpgCharaAllOff()

機能

全てのキャラクターを非アクティブにします

書式

void RpgCharaAllOff( containPlayer )

引数

引数	型	省略	規定値	詳細
containPlayer	真偽値	◯	false	プレーヤーキャラも対象に含めるか

戻り値

なし

RpgCharaTurn()

機能

キャラクターの向きを設定します

書式

void RpgCharaTurn( charaName, direction )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
direction	列挙型	×	―	キャラクターの向きを示す以下の列挙子

戻り値

なし

列挙型

キャラクターの向き

列挙子	略字	説明
Left	L	左向き
Right	R	右向き
Up	U	上向き
Down	D	下向き
LeftUp	LU	左上向き
LeftDown	LD	左下向き
RightUp	RU	右上向き
RightDown	RD	右下向き

RpgCharaLookAt()

機能

キャラクターを特定のキャラクターの方向へ向けます

書式

void RpgCharaLookAt( charaName, cellX, cellY )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
targetName	文字列	×	―	対象のキャラクター名 (オブジェクト名)

戻り値

なし

RpgCharaPos()

機能

キャラクターの位置を設定します

書式

void RpgCharaPos( charaName, cellX, cellY )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
cellX	整数	◯	現在のＸ座標	セルＸ座標
cellY	整数	◯	現在のＹ座標	セルＹ座標

戻り値

なし

RpgCharaPosX()

機能

キャラクターのX座標を取得・設定します

書式

int RpgCharaPosX( charaName, cellX )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
cellX	整数	◯	現在のＸ座標	セルＸ座標

戻り値

キャラクターのセルX座標

RpgCharaPosY()

機能

キャラクターのY座標を取得・設定します

書式

int RpgCharaPosY( charaName, cellY )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
cellY	整数	◯	現在のＹ座標	セルＹ座標

戻り値

キャラクターのセルY座標

RpgCharaWarp()

機能

キャラクターを指定したワープポイントにワープさせます

書式

void RpgCharaWarp( charaName, warpPoint )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
warpPoint	文字列	◯	null	ワープポイント名。null の場合は初期位置にワープします

戻り値

なし

RpgCharaMove()

機能

キャラクターを移動させます

書式

void RpgCharaMove( charaName, direction, distance, speed )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
direction	文字列	×	―	移動方向を示す以下の列挙子
distance	整数	◯	1	移動セル数
speed	実数	◯	デフォルト値	移動速度 (１秒間に進むセル数)

戻り値

なし

列挙型

移動方向

列挙子	略字	説明
Left	L	左
Right	R	右
Up	U	上
Down	D	下

RpgCharaMovePos()

機能

キャラクターを移動させます

書式

void RpgCharaMovePos( charaName, cellX, cellY, speed )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
cellX	整数	◯	現在値	移動先のセルＸ座標
cellY	整数	◯	現在値	移動先のセルＹ座標
speed	実数	◯	デフォルト値	移動速度 (１秒間に進むセル数)

戻り値

なし

RpgCharaMoveTo()

機能

キャラクターを経路探索で移動させます

書式

void RpgCharaMoveTo( charaName, cellX, cellY, speed, maxCost )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
cellX	整数	×	―	移動先のセルＸ座標
cellY	整数	×	―	移動先のセルＹ座標
speed	実数	◯	デフォルト値	移動速度 (１秒間に進むセル数)
maxCost	整数	◯	128	最大移動セル数

戻り値

なし

RpgCharaToPlayer()

機能

キャラクターをプレーヤーの位置まで経路探索で移動させます

書式

void RpgCharaToPlayer( charaName, pos, speed, maxCost )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
pos	列挙型	×	―	目標位置を示す以下の列挙子。プレーヤーから見てどの方向に立つかを指定します
speed	実数	◯	デフォルト値	移動速度 (１秒間に進むセル数)
maxCost	整数	◯	128	最大移動セル数

戻り値

なし

列挙型

目標位置

列挙子	略字	説明
Left	L	左
Right	R	右
Up	U	上
Down	D	下
LeftUp	LU	左上
LeftDown	LD	左下
RightUp	RU	右上
RightDown	RD	右下

RpgCharaDrag()

機能

キャラクターを引きずり移動させます。RpgCharaMove() と異なりキャラクターの向きの変更や歩行アニメーションは行いません

書式

void RpgCharaDrag( charaName, direction, distance, speed )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
direction	文字列	×	―	移動方向を示す以下の列挙子
distance	整数	◯	1	移動セル数
speed	実数	◯	初期速度	移動速度 (１秒間に進むセル数)

戻り値

なし

列挙型

移動方向

列挙子	略字	説明
Left	L	左
Right	R	右
Up	U	上
Down	D	下

RpgCharaDragPos()

機能

キャラクターを指定座標に引きずり移動させます。RpgCharaMovePos() と異なりキャラクターの向きの変更や歩行アニメーションは行いません

書式

void RpgCharaDragPos( charaName, cellX, cellY, speed )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
cellX	整数	◯	現在値	移動先のセルＸ座標
cellY	整数	◯	現在値	移動先のセルＹ座標
speed	実数	◯	デフォルト値	移動速度 (１秒間に進むセル数)

戻り値

なし

RpgCharaAlpha()

機能

キャラクターの不透明度を設定します

書式

void RpgCharaAlpha( charaName, alpha, fadeTime )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
alpha	整数	×	―	不透明度 (0～255)
fadeTime	実数	◯	0.0	フェード時間。0 以下の場合はフェード無し

戻り値

なし

RpgCharaColor()

機能

キャラクターの表示カラーを設定します

書式

void RpgCharaColor( charaName, red, green, blue, alpha, fadeTime )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
red	整数	◯	現在の値	赤色値 (0～255)
green	整数	◯	現在の値	緑色値 (0～255)
blue	整数	◯	現在の値	青色値 (0～255)
alpha	整数	◯	現在の値	不透明度 (0～255)
fadeTime	実数	◯	0.0	フェード時間。0 以下の場合はフェード無し

戻り値

なし

RpgCharaImage()

機能

キャラクターのイメージを設定します

書式

void RpgCharaImage( charaName, chipName )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
chipName	文字列	×	―	イメージ名。キャラに設定されたチップセット内にあるチップ名を指定してください

戻り値

なし

RpgCharaStep()

機能

キャラクターの強制足踏みフラグを設定します。Ｏｎにすると歩行中でなくても足踏みアニメーションを続けます

書式

void RpgCharaStep( charaName, step )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
step	真偽値	◯	true	足踏みさせるか

戻り値

なし

RpgCharaBatch()

機能

キャラクターにバッチ処理を設定します。第二引数以降は {コマンド, パラメータ} の対を連続して記述することができます。パラメータは以下の表にある各コマンドに合わせた値を設定します。移動系のコマンドを使用するとキャラクターが目的地に到達するまで次のコマンドの実行は保留になります

書式

void RpgCharaBatch( charaName [, command, param] ... )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
command	列挙型	×	―	コマンド列挙子
param	不定	×	―	コマンドに対するパラメータ

戻り値

なし

コマンド

コマンド

コマンド	パラメータ		機能
Turn	文字列	向きを示す列挙子	向きを変更します。RpgCharaTurn() と同じ
Speed	実数	移動速度	移動速度を変更します。この値はスクリプトからの移動のみに使用され通常移動には影響しませｎ
MoveLeft	整数	移動セル数	左に移動させます。移動中は次のコマンドの実行を保留する。RpgCharaMove() と同じ
MoveRight	整数	移動セル数	右に移動させます。移動中は次のコマンドの実行を保留する。RpgCharaMove() と同じ
MoveUp	整数	移動セル数	上に移動させます。移動中は次のコマンドの実行を保留する。RpgCharaMove() と同じ
MoveDown	整数	移動セル数	下に移動させます。移動中は次のコマンドの実行を保留する。RpgCharaMove() と同じ
DragLeft	整数	移動セル数	左にドラッグ移動させます。移動中は次のコマンドの実行を保留する。RpgCharaDrag() と同じ
DragRight	整数	移動セル数	右にドラッグ移動させます。移動中は次のコマンドの実行を保留する。RpgCharaDrag() と同じ
DragUp	整数	移動セル数	上にドラッグ移動させます。移動中は次のコマンドの実行を保留する。RpgCharaDrag() と同じ
DragDown	整数	移動セル数	下にドラッグ移動させます。移動中は次のコマンドの実行を保留する。RpgCharaDrag() と同じ
Step	真偽値	足踏みフラグ	強制足踏みフラグを設定します。RpgCharaStep() と同じ
Image	文字列	イメージ名	キャラクターのイメージを設定します。RpgCharaImage() と同じ
FadeIn	実数	フェード時間	キャラクターをフェードインさせます
FadeOut	実数	フェード時間	キャラクターをフェードアウトさせます
DoorOpen	文字列	ドア名	指定したドアを開けます。RpgDoorClose() と同じ
DoorClose	文字列	ドア名	指定したドアを閉めます。RpgDoorOpen() と同じ
PlaySe	文字列	ファイルのパス	効果音を再生します。PlaySe() と同じ
Sleep	実数	待機時間 (秒)	指定秒数バッチ処理を待機させます。他のスクリプト処理には影響しません

ML	整数	移動セル数	MoveLeft コマンドの短縮表記
MR	整数	移動セル数	MoveRight コマンドの短縮表記
MU	整数	移動セル数	MoveUp コマンドの短縮表記
MD	整数	移動セル数	MoveDown コマンドの短縮表記
DL	整数	移動セル数	DragLeft コマンドの短縮表記
DR	整数	移動セル数	DragRight コマンドの短縮表記
DU	整数	移動セル数	DragUp コマンドの短縮表記
DD	整数	移動セル数	DragDown コマンドの短縮表記

キャラクターの向き

列挙子	略字	説明
Left	L	左向き
Right	R	右向き
Up	U	上向き
Down	D	下向き
LeftUp	LU	左上向き
LeftDown	LD	左下向き
RightUp	RU	右上向き
RightDown	RD	右下向き

RpgCharaJump()

機能

キャラクターにジャンプ演出を設定します

書式

void RpgCharaJump( charaName, sizeX, sizeY, count, roundTime, delayTime, ease )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
sizeX	実数	×	―	Ｘ方向のジャンプサイズ (ピクセル単位)
sizeY	実数	×	―	Ｙ方向のジャンプサイズ (ピクセル単位)
count	整数	◯	1	ジャンプ回数
roundTime	実数	◯	0.5	１往復にかかる時間
delayTime	実数	◯	0.0	ディレイ時間
ease	列挙型	◯	"Liner"	イーズ関数を示す列挙子 (イーズ関数を参照)

戻り値

なし

RpgCharaSwing()

機能

キャラクターに揺れ演出を設定します

書式

void RpgCharaSwing( charaName, sizeX, sizeY, count, roundTime, delayTime, ease )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
sizeX	実数	×	―	Ｘ方向の揺れサイズ (ピクセル単位)
sizeY	実数	×	―	Ｙ方向の揺れサイズ (ピクセル単位)
count	整数	◯	1	ジャンプ回数
roundTime	実数	◯	0.5	１往復にかかる時間
delayTime	実数	◯	0.0	ディレイ時間
ease	列挙型	◯	"Liner"	イーズ関数を示す列挙子 (イーズ関数を参照)

戻り値

なし

RpgCharaBaloonOn()

機能

キャラクターに設置されたバルーンを表示します

書式

void RpgCharaBaloonOn( charaName, chipName, direction )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
chipName	文字列	◯	現在値	チップセット内のチップ名
direction	列挙子	◯	現在値	バルーンの向き

戻り値

なし

列挙型

バルーンの向き

列挙子	略字	説明
Left	L	左向き
Right	R	右向き
Up	U	上向き
Down	D	下向き
LeftUp	LU	左上向き
LeftDown	LD	左下向き
RightUp	RU	右上向き
RightDown	RD	右下向き

RpgCharaBaloonOff()

機能

キャラクターに設置されたバルーンを非表示にします

書式

void RpgCharaBaloonOff( charaName )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)

戻り値

なし

RpgCharaRegion()

機能

キャラクター位置のリージョン番号を取得します

書式

int RpgCharaRegion( charaName )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)

戻り値

リージョン番号

RpgPoliceStan()

機能

RPG衛兵を気絶状態にします。この関数はcharaName引数で指定したオブジェクトがRpgPoliceコンポーネントを持っている場合にのみ使用できます

書式

void RpgPoliceStan( charaName )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)

戻り値

なし

RpgPoliceOverlook()

機能

RPG衛兵の見逃しフラグを取得します。overlook引数に値を設定した場合は見逃しフラグを設定します

書式

bool RpgPoliceOverlook( charaName, overlook )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)
overlook	真偽値	◯	既存値	見逃しフラグ

戻り値

現在の見逃しフラグ

RpgPoliceTumeshoMap()

機能

RPG衛兵に設定された詰所のマップ名を取得します。この関数はcharaName引数で指定したオブジェクトがRpgPoliceコンポーネントを持っている場合にのみ使用できます

書式

string RpgPoliceTumeshoMap( charaName )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名 (オブジェクト名)

戻り値

衛兵に設定された詰所のマップ名