RPGツクールMV JSライブラリ 日本語訳

公式ヘルプの英文を和訳したものです。

※1 原文の不足をそのままにしている部分があります。
※2 原文の不足や誤りを補完している部分があります。

Bitmap Class

画像を表す基本的なオブジェクト

Properties

• baseTexture PIXI.BaseTexture [read-only] 画像を保持する基本テクスチャ
• canvas HTMLCanvasElement [read-only] ビットマップキャンバス
• context CanvasRenderingContext2D [read-only] ビットマップキャンバスの2Dコンテキスト
• fontFace String フォントの書体名
• fontItalic Boolean フォントを斜体にするか
• fontSize Number フォントのサイズ (px)
• height Number [read-only] ビットマップの高さ
• outlineColor String テキストのアウトラインの色 (CSS)
• outlineWidth Number テキストのアウトラインの幅
• paintOpacity Number 描画オブジェクトの不透明度 (0, 255)
• rect Rectangle [read-only] ビットマップの矩形
• smooth Boolean 滑らかな拡縮を適用するか
• textColor String テキストの色 (CSS)
• url String [read-only] 画像ファイルのURL
• width Number [read-only] ビットマップの幅

Bitmap

コンストラクタ

• width Number ビットマップの幅
• height Number ビットマップの高さ

addLoadListener

ビットマップが読み込まれたときに呼び出されるコールバック関数を追加する

• listner Function コールバック関数

adjustTone

ビットマップ全体の色調を変更する

• r Number 範囲内の赤色の強さ (-255, 255)
• g Number 範囲内の緑色の強さ (-255, 255)
• b Number 範囲内の青色の強さ (-255, 255)

blt

ブロック転送を行う

• source Bitmap 描画するビットマップ
• sx Number ソースのX座標
• sy Number ソースのY座標
• sw Number ソース画像の幅
• sh Number ソース画像の高さ
• dx Number 転送先のX座標
• dy Number 転送先のY座標
• [dw=sw] Number [optional] 転送先で画像を描画する幅
• [dh=sh] Number [optional] 転送先で画像を描画する高さ

blur

ビットマップにぼかし効果を適用する

clear

ビットマップ全体を消去する

clearRect

指定された矩形を消去する

• x Number 左上端のX座標
• y Number 左上端のY座標
• width Number 消去する矩形の幅
• height Number 消去する矩形の高さ

drawCircle

塗りつぶされた円を描画する

• x Number 円の中心のX座標
• y Number 円の中心のY座標
• radius Number 円の半径
• color String 円の色 (CSS)

drawText

ビットマップにアウトラインテキストを描画する

• text String 描画するテキスト
• x Number テキストの左端のX座標
• y Number テキストの上端のY座標
• maxWidth Number テキストの最大許容幅
• lineHeight テキスト行の高さ ※1
• align String テキストの配置

fillAll

ビットマップ全体を塗りつぶす

• color String 矩形の色 (CSS)

fillRect

指定された矩形を塗りつぶす

• x Number 左上端のX座標
• y Number 左上端のY座標
• width Number 塗りつぶす矩形の幅 ※2
• height Number 塗りつぶす矩形の高さ ※2
• color String 矩形の色 (CSS)

getAlphaPixel

指定されたピクセルのアルファ値を返す

• x Number ビットマップ内のピクセルのX座標
• y Number ビットマップ内のピクセルのY座標
• Returns: String アルファ値

getPixel

指定されたピクセルの色を返す

• x Number ビットマップ内のピクセルのX座標
• y Number ビットマップ内のピクセルのY座標
• Returns: String ピクセルの色 (16進数)

gradientFillRect

グラデーションで矩形を描画する

• x Number 左上端のX座標
• y Number 左上端のY座標
• width Number 塗りつぶす矩形の幅 ※2
• height Number 塗りつぶす矩形の高さ ※2
• color1 String グラデーションの開始色
• color2 String グラデーションの終了色
• vertical Boolean グラデーションを垂直にするか

isError

読み込みエラーが発生したか確認する

• Returns: Boolean エラーが発生した場合 true を返す

isReady

ビットマップを描画する準備ができているか確認する

• Returns: Boolean 準備ができている場合 true を返す

load

[static] 画像ファイルを読み込み、新しいビットマップオブジェクトを返す

• url String テクスチャ画像のURL
• Returns: Bitmap ※1

measureTextWidth

指定されたテキストの幅を返す

• text String 測定するテキスト
• Returns: Number テキストの幅 (px)

resize

ビットマップをリサイズする

• width Number ビットマップの新しい幅
• height Number ビットマップの新しい高さ

rotateHue

ビットマップ全体の色相を回転する

• offset Number 色相のオフセット (360度)

snap

[static] ゲーム画面のスナップショットを取得し、新しいビットマップオブジェクトを返す

• stage PIXI.Stage ステージオブジェクト
• Returns: Bitmap ※1

Graphics Class

グラフィックス処理を実行する静的クラス

Properties

• BLEND_ADD Number [final] [static] PIXI.blendModes.ADD のエイリアス
• BLEND_MULTIPLY Number [final] [static] PIXI.blendModes.MULTIPLY のエイリアス
• BLEND_NORMAL Number [final] [static] PIXI.blendModes.NORMAL のエイリアス
• BLEND_SCREEN Number [final] [static] PIXI.blendModes.SCREEN のエイリアス
• boxHeight Number [static] ウィンドウ表示領域の高さ
• boxWidth Number [static] ウィンドウ表示領域の幅
• frameCount Number [static] ゲーム画面の総フレーム数
• height Number [static] ゲーム画面の高さ
• scale Number [static] ゲーム画面の拡大率
• width Number [static] ゲーム画面の幅

canPlayVideoType

[static] 指定されたビデオタイプがサポートされているか確認する

• type String サポートを確認するビデオタイプ
• Returns: Boolean サポートされている場合 true を返す

canUseDifferenceBlend

[static] キャンバスブレンドモード「difference」がサポートされているか確認する

• Returns: Boolean サポートされている場合 true を返す

canUseSaturationBlend

[static] キャンバスブレンドモード「saturation」がサポートされているか確認する

• Returns: Boolean サポートされている場合 true を返す

endLoading

[static] 「Now Loading」画像を消去する

hasWebGL

[static] WebGLがサポートされているか確認する

• Returns: Boolean サポートされている場合 true を返す

hideFps

[static] FPSメーターを非表示にする

initialize

[static] グラフィックスシステムを初期化する

• width Number ゲーム画面の幅
• height Number ゲーム画面の高さ
• type String レンダラタイプ (canvas, webgl, auto)

isFontLoaded

[static] フォントファイルが読み込まれているか確認する

• name String フォントの書体名
• Returns: Boolean 読み込まれている場合 true を返す

isInsideCanvas

[static] 指定されたポイントがゲームキャンバス領域内にあるか確認する

• x Number キャンバス領域のX座標
• y Number キャンバス領域のY座標
• Returns: Boolean キャンバス領域内の場合 true を返す

isVideoPlaying

[static] ビデオが再生されているか確認する

• Returns: Boolean 再生されている場合 true を返す

isWebGL

[static] レンダラタイプがWebGLか確認する

• Returns: Boolean WebGLの場合 true を返す

loadFont

[static] フォントファイルを読み込む

• name String フォントの書体名
• url String フォントファイルのURL

pageToCanvasX

[static] ページ上のX座標をキャンバス領域上のX座標に変換する

• x Number 変換するページ上のX座標
• Returns: Number キャンバス領域上のX座標

pageToCanvasY

[static] ページ上のY座標をキャンバス領域上のY座標に変換する

• y Number 変換するページ上のY座標
• Returns: Number キャンバス領域上のY座標

playVideo

[static] ビデオを再生する

• src String ※1

printError

[static] 画面にエラーテキストを表示する

• name String エラーの名前
• message String エラーのメッセージ

render

[static] ゲーム画面にステージを描画する

• stage Stage 描画するステージオブジェクト

setLoadingImage

[static] 「Now Loading」画像のソースを設定する

showFps

[static] FPSメーターを表示する

startLoading

[static] 「Now Loading」画像を表示するためのカウンタを初期化する

tickEnd

[static] FPSメーターの各フレームの終わりをマークする

tickStart

[static] FPSメーターの各フレームの始まりをマークする

updateLoading

[static] 読み込みカウンタをインクリメントし、必要に応じて「Now Loading」画像を表示する

Html5Audio Class

HTML5オーディオを処理する静的クラス

Properties

• url String [read-only] オーディオファイルのURL
• volume Number オーディオの音量

Html5Audio

コンストラクタ

addLoadListener

[static] オーディオデータが読み込まれたときに呼び出されるコールバック関数を追加する

• listner Function コールバック関数

clear

[static] オーディオデータを消去する

fadeIn

[static] オーディオのフェードインを実行する

• duration Number フェードイン時間 (秒)

fadeOut

[static] オーディオのフェードアウトを実行する

• duration Number フェードアウト時間 (秒)

initialize

[static] オーディオシステムを初期化する

• Returns: Boolean オーディオシステムが利用可能な場合 true を返す

isError

[static] 読み込みエラーが発生したか確認する

• Returns: Boolean エラーが発生した場合 true を返す

isPlaying

[static] オーディオが再生されているか確認する

• Returns: Boolean 再生されている場合 true を返す

isReady

[static] オーディオデータを再生する準備ができているか確認する

• Returns: Boolean 準備ができている場合 true を返す

play

[static] オーディオを再生する

• loop Boolean ループ再生するか
• offset Number 再生の開始位置 (秒)

seek

[static] オーディオのシーク位置を取得する

setup

[static] HTML5オーディオを設定する

• url String オーディオファイルのURL

stop

[static] オーディオを停止する

Input Class

キーボードとゲームパッドからの入力データを処理する静的クラス

Properties

• date Number [static] [read-only] 最後の入力時間 (ミリ秒)
• dir4 Number [static] [read-only] 4方向のテンキー上の数値、または0
• dir8 Number [static] [read-only] 8方向のテンキー上の数値、または0
• gamepadMapper Object [static] ゲームパッドボタンからマッピングキー名に変換するハッシュテーブル
• keyMapper Object [static] 仮想キーコマンドからマッピングキー名に変換するハッシュテーブル
• keyRepeatInterval Number [static] キーリピートの間隔 (フレーム)
• keyRepeatWait Number [static] キーリピートまでの待機時間 (フレーム)

clear

[static] すべての入力データを消去する

initialize

[static] 入力システムを初期化する

isLongPressed

[static] キーが長押しされているか確認する

• keyName String キーのマッピング名
• Returns: Boolean 長押しされている場合 true を返す

isPressed

[static] キーが押されているか確認する

• keyName String キーのマッピング名
• Returns: Boolean 押されている場合 true を返す

isRepeated

[static] キーが押されたかキーリピートしているか確認する

• keyName String キーのマッピング名
• Returns: Boolean キーリピートしている場合 true を返す

isTriggered

[static] キーが押されたか確認する

• keyName String キーのマッピング名
• Returns: Boolean 押された場合 true を返す

update

[static] 入力データを更新する

JsExtensions Class

標準のJavaScriptオブジェクトに追加されるいくつかのメソッドが含まれる非クラス

Array.prototype.clone

配列のシャローコピーを作成する

• Returns: Array 配列のシャローコピー

Array.prototype.contains

配列に指定の要素が含まれているか確認する

• element Any 検索する要素
• Returns: Boolean 指定の要素が含まれている場合 true を返す

Array.prototype.equals

二つの配列が同一か確認する

• array Any 比較する配列
• Returns: Boolean 同一の場合 true を返す

Math.randomInt

[static] 範囲内の乱数を作成する (0, max-1)

• max Number 上限 (除外)
• Returns: Number ランダムな整数

Number.prototype.clamp

指定の範囲内に制限された数値を返す

• min Number 下限
• max Number 上限
• Returns: Number 範囲内の数値 (min, max)

Number.prototype.mod

常に正のモジュロ値を返す

• n Number 除数
• Returns: Number モジュロ値

Number.prototype.padZero

先行ゼロを含む数値の文字列を作成する

• length Number 出力文字列の長さ
• Returns: String 先行ゼロを含む文字列

String.prototype.contains

文字列に指定の文字列が含まれているか確認する

• string String 検索する文字列
• Returns: Boolean 指定の文字列が含まれている場合 true を返す

String.prototype.format

文字列中の %1, %2 などを引数に置き換える

• ...args Any フォーマットするオブジェクト
• Returns: String フォーマットされた文字列

String.prototype.padZero

先行ゼロを含む数値の文字列を作成する

• length Number 出力文字列の長さ
• Returns: String 先行ゼロを含む文字列

JsonEx Class

オブジェクト情報を含むJSONを処理する静的クラス

Properties

• maxDepth Number [static] オブジェクトの最大深度 (Default: 100)

makeDeepCopy

[static] 指定されたオブジェクトのディープコピーを作成する

• object Object コピーするオブジェクト
• Returns: Object コピーされたオブジェクト

parse

[static] JSON文字列を解析し、対応するオブジェクトを再構築する

• json String JSON文字列
• Returns: Object 最構成されたオブジェクト

Stringify

[static] オブジェクトをオブジェクト情報を含むJSON文字列に変換する

• object Object 変換するオブジェクト
• Returns: String JSON文字列

Point Class

ポイントクラス

Properties

• x Number X座標
• y Number Y座標

Point

コンストラクタ

• x Number X座標
• y Number Y座標

Rectangle Class

矩形クラス

Properties

• height Number 矩形の高さ
• width Number 矩形の幅
• x Number 左上端のX座標
• y Number 左上端のY座標

Rectangle

コンストラクタ

• x Number 左上端のX座標
• y Number 左上端のY座標
• width Number 矩形の幅
• height Number 矩形の高さ

ScreenSprite Class

ゲーム画面全体をカバーするスプライト

Properties

• opacity Number スプライトの不透明度 (0, 255)

ScreenSprite

コンストラクタ

setBlack

スクリーンスプライトの色を黒に設定する

setColor

スクリーンスプライトの色を値で設定する

• r Number 範囲内の赤色の値 (0, 255)
• g Number 範囲内の緑色の値 (0, 255)
• b Number 範囲内の青色の値 (0, 255)

setWhite

スクリーンスプライトの色を白に設定する

Sprite Class

ゲーム画面に描画される基本的なオブジェクト

Properties

• anchor Point スプライトの原点。(0,0)から(1,1)へ。
• bitmap Bitmap スプライトの画像
• blendMode Number スプライトに適用されるブレンドモード
• children Array [read-only] スプライトの子要素の配列
• filters Array スプライトのフィルタを設定する
• height Number 拡縮なしのスプライトの高さ
• opacity Number スプライトの不透明度 (0, 255)
• parent Object [read-only] スプライトを含むオブジェクト
• rotation Number ラジアン単位のスプライトの回転
• scale Point スプライトの拡縮率
• visible Boolean スプライトの可視性
• width Number 拡縮なしのスプライトの幅
• x Number スプライトのX座標
• y Number スプライトのY座標

Sprite

コンストラクタ

• bitmap Bitmap スプライトの画像

addChild

コンテナに子要素を追加する

• child Object 追加する子要素
• Returns: Object 追加された子要素

addChildAt

コンテナの指定されたインデックスに子要素を追加する

• child Object 追加する子要素
• index Number 子要素を配置するインデックス
• Returns: Object 追加された子要素

getBlendColor

スプライトのブレンドカラーを取得する

• Returns: Array ブレンドカラー [r, g, b, a]

getColorTone

スプライトの色調を取得する

• Returns: Array 色調 [r, g, b, gray]

move

X座標とY座標を一度に設定する

• x Number スプライトのX座標
• y Number スプライトのY座標

removeChild

コンテナから子要素を削除する

• child Object 削除する子要素
• Returns: Object 削除された子要素

removeChildAt

指定されたインデックスから子要素を削除する

• index Number 子要素を特定するインデックス
• Returns: Object 削除された子要素

setBlendColor

スプライトのブレンドカラーを設定する

• color Array ブレンドカラー [r, g, b, a]

setColorTone

スプライトの色調を設定する

• tone Array 色調 [r, g, b, gray]

setFrame

スプライトを表示するビットマップの矩形を設定する

• x Number フレームのX座標
• y Number フレームのY座標
• width Number フレームの幅
• height Number フレームの高さ

update

各フレームのスプライトを更新する

Stage Class

表示ツリーのルートオブジェクト

Properties

• children Array [read-only] スプライトの子要素の配列

Stage

コンストラクタ

addChild

コンテナに子要素を追加する

• child Object 追加する子要素
• Returns: Object 追加された子要素

addChildAt

コンテナの指定されたインデックスに子要素を追加する

• child Object 追加する子要素
• index Number 子要素を配置するインデックス
• Returns: Object 追加された子要素

removeChild

コンテナから子要素を削除する

• child Object 削除する子要素
• Returns: Object 削除された子要素

removeChildAt

指定されたインデックスから子要素を削除する

• index Number 子要素を特定するインデックス
• Returns: Object 削除された子要素

Tilemap Class

2Dタイルベースのゲームマップを表示するタイルマップ

Properties

• animationCount Number オートタイルのアニメーションカウント
• bitmaps Array タイルセットとして使用するビットマップ
• children Array [read-only] スプライトの子要素の配列
• flags Array タイルセットフラグ
• height Number 画面の高さ (px)
• horizontalWrap Boolean タイルマップを水平ループするか
• origin Point スクロール用のタイルマップの原点
• parent Object [read-only] タイルマップを含むオブジェクト
• tileHeight Number タイルの高さ (px)
• tileWidth Number タイルの幅 (px)
• verticalWrap Boolean タイルマップを垂直ループするか
• width Number 画面の幅 (px)

Tilemap

コンストラクタ

addChild

コンテナに子要素を追加する

• child Object 追加する子要素
• Returns: Object 追加された子要素

addChildAt

コンテナの指定されたインデックスに子要素を追加する

• child Object 追加する子要素
• index Number 子要素を配置するインデックス
• Returns: Object 追加された子要素

isReady

タイルセットを描画する準備ができているか確認する

• Returns: Boolean 準備できている場合 true を返す

refresh

タイルマップ全体を再描画する

removeChild

コンテナから子要素を削除する

• child Object 削除する子要素
• Returns: Object 削除された子要素

removeChildAt

指定されたインデックスから子要素を削除する

• index Number 子要素を特定するインデックス
• Returns: Object 削除された子要素

setData

タイルマップデータを設定する

• width Number タイル数によるマップの幅
• height Number タイル数によるマップの高さ
• data Array 地図データの一次元配列

update

各フレームのタイルマップを更新する

TilingSprite Class

タイリング画像用のスプライトオブジェクト

Properties

• bitmap Bitmap タイリングスプライト用の画像
• opacity Number タイリングスプライトの不透明度 (0, 255)
• origin Point スクロール用のタイルスプライトの原点
• visible Boolean タイリングスプライトの可視性
• x Number タイリングスプライトのX座標
• y Number タイリングスプライトのY座標

TilingSprite

コンストラクタ

• Bitmap Bitmap タイリングスプライトの画像

move

X座標、Y座標、幅、高さを一度に設定する

• x Number タイリングスプライトのX座標
• y Number タイリングスプライトのY座標
• width Number タイリングスプライトの幅
• height Number タイリングスプライトの高さ

setFrame

タイリングスプライトが使用する画像の領域を設定する

• x Number フレームのX座標
• y Number フレームのY座標
• width Number フレームの幅
• height Number フレームの高さ

update

各フレームのタイルのスプライトを更新する

ToneFilter Class

WegGLのためのカラーマトリックスフィルタ

adjustHue

色相を変更する

• value Number 範囲内の色相の値 (-360, 360)

adjustSaturation

彩度を変更する

• value Number 範囲内の彩度の値 (-255, 255)

adjustTone

トーンを変更する

• r Number 範囲内の赤色の強さ (-255, 255)
• g Number 範囲内の緑色の強さ (-255, 255)
• b Number 範囲内の青色の強さ (-255, 255)

reset

フィルタをリセットする

ToneSprite Class

2Dキャンバスモードで画面の色を変更するスプライト

reset

トーンをリセットする

setTone

トーンを設定する

• r Number 範囲内の赤色の強さ (-255, 255)
• g Number 範囲内の緑色の強さ (-255, 255)
• b Number 範囲内の青色の強さ (-255, 255)
• gray Number 範囲内のグレースケールの強さ (0, 255)

TouchInput Class

マウスとタッチスクリーンからの入力データを処理する静的クラス

Properties

• date Number [static] [read-only] 最後の入力時間 (ミリ秒)
• keyRepeatInterval Number [static] 疑似キーリピートの間隔 (フレーム)
• keyRepeatWait Number [static] 疑似キーリピートまでの待機時間 (フレーム)
• wheelX Number [static] [read-only] 水平スクロール量
• wheelY Number [static] [read-only] 垂直スクロール量
• x Number [static] [read-only] 最新のタッチイベントのキャンバス領域上のX座標
• y Number [static] [read-only] 最新のタッチイベントのキャンバス領域上のY座標

clear

[static] すべてのタッチデータを消去する

initialize

[static] タッチシステムを初期化する

isCancelled

[static] マウスの右ボタンが押されたか確認する

• Returns: Boolean 押された場合 true を返す

isLongPressed

[static] マウスの左ボタンやタッチスクリーンが長押しされているか確認する

• Returns: Boolean 長押しされている場合 true を返す

isMoved

[static] タッチスクリーン上でマウスや指が移動したか確認する

• Returns: Boolean 移動した場合 true を返す

isPressed

[static] マウスボタンまたはタッチスクリーンが押されているか確認する

• Returns: Boolean 押されている場合 true を返す

isReleased

[static] マウスの左ボタンやタッチスクリーンが離されたか確認する

• Returns: Boolean 離された場合 true を返す

isRepeated

[static] マウスの左ボタンやタッチスクリーンが押されたか、疑似キーリピートしているか確認する

• Returns: Boolean キーリピートしている場合 true を返す

isTriggered

[static] マウスの左ボタンやタッチスクリーンが押されたか確認する

• Returns: Boolean 押された場合 true を返す

update

[static] タッチデータを更新する

Utils Class

ユーティリティメソッドを定義する静的クラス

Properties

• RPGMAKER_NAME String [final] [static] RPGツクールの名前 (MV)

canReadGameFiles

[static] ブラウザがゲームフォルダ内のファイルを読み取れるか確認する

• Returns: Boolean 読み込める場合 true を返す

isAndroidChrome

[static] ブラウザが Android Chrome か確認する

• Returns: Boolean Android Chrome の場合 true を返す

isMobileDevice

[static] プラットフォームがモバイルデバイスか確認する

• Returns: Boolean モバイルデバイスの場合 true を返す

isMobileSafari

[static] ブラウザが Mibile Safari か確認する

• Returns: Boolean Mobile Safari の場合 true を返す

isNwjs

[static] プラットフォームが NW.js か確認する

• Returns: Boolean NW.js の場合 true を返す

isOptionValid

[static] オプションがクエリ文字列内にあるか確認する

• name String オプション名
• Returns: Boolean オプションがある場合 true を返す

rgbToCssColor

[static] RGB値からCSSカラー文字列を作成する

• r Number 範囲内の赤色の値 (0, 255)
• g Number 範囲内の緑色の値 (0, 255)
• b Number 範囲内の青色の値 (0, 255)
• Returns: String CSSカラー文字列

Weather Class

雨、嵐、または雪を表示する天候エフェクト。

Properties

• origin Point スクロール用の天候の原点
• power Number 範囲内の天候の強さ (0, 9)
• type String 天候の種類 (none, rain, storm, snow)

Weather

コンストラクタ

update

各フレームの天候を更新する

WebAudio Class

Web Audio API のオーディオオブジェクト

Properties

• pan Number オーディオの位相
• pitch Number オーディオのピッチ
• url String [read-only] オーディオファイルのURL
• volume Number オーディオの音量

WebAudio

コンストラクタ

• url String オーディオファイルのURL

addLoadListener

オーディオデータが読み込まれたときに呼び出されるコールバック関数を追加する

• listner Function コールバック関数

addStopListener

再生が停止したときに呼び出されるコールバック関数を追加する

• listner Function コールバック関数

canPlayM4a

[static] ブラウザがM4Aファイルを再生できるか確認する

• Returns: Boolean 再生できる場合 true を返す

canPlayOgg

[static] ブラウザがOGGファイルを再生できるか確認する

• Returns: Boolean 再生できる場合 true を返す

clear

オーディオデータを消去する

fadeIn

オーディオのフェードインを実行する

• duration Number フェードイン時間 (秒)

fadeOut

オーディオのフェードアウトを実行する

• duration Number フェードアウト時間 (秒)

initialize

[static] オーディオシステムを初期化する

• noAudio Boolean 無音モードのフラグ
• Returns: Boolean オーディオシステムが利用可能な場合 true を返す

isError

読み込みエラーが発生したか確認する

• Returns: Boolean エラーが発生した場合 true を返す

isPlaying

オーディオが再生されているか確認する

• Returns: Boolean: 再生されている場合 true を返す

isReady

オーディオデータを再生する準備ができているか確認する

• Returns: Boolean 準備ができている場合 true を返す

play

オーディオを再生する ※2

• loop Boolean ループ再生するか
• offset Number 再生の開始位置 (秒)

seek

オーディオのシーク位置を取得する

stop

オーディオを停止する

Window Class

ゲーム内のウィンドウ

Properties

• active Boolean ウィンドウのアクティブ状態
• backOpacity Number ウィンドウ背景の不透明度 (0, 255) ※2
• children Array [read-only] ウィンドウの子要素の配列
• contents Bitmap ※1
• contentsOpacity Number ウィンドウのコンテンツの不透明度 (0, 255)
• downArrowVisible Number スクロールの下矢印の可視性 ※2
• height Number ウィンドウの高さ (px)
• margin Number ウィンドウ背景の余白サイズ
• opacity Number コンテンツのないウィンドウの不透明度 (0, 255)
• openness Number ウィンドウの開放性 (0, 255)
• origin Point スクロール用のウィンドウの原点
• padding Number フレームとコンテンツの間の余白サイズ
• parent Object [read-only] ウィンドウを含むオブジェクト
• pause Boolean ポーズサインの可視性
• upArrowVisible Boolean スクロールの上矢印の可視性
• visible Boolean ウィンドウの可視性
• width Number ウィンドウの幅 (px)
• windowskin Bitmap ウィンドウスキンとして使用する画像
• x Number ウィンドウのX座標
• y Number ウィンドウのY座標

Window

コンストラクタ

addChild

コンテナに子要素を追加する

• child Object 追加する子要素
• Returns: Object 追加された子要素

addChildAt

コンテナの指定されたインデックスに子要素を追加する ※2

• child Object 追加する子要素
• index Number 子要素を配置するインデックス
• Returns: Object 追加された子要素

addChildToBack

背景とコンテンツの間に子要素を追加する

• child Object 追加する子要素
• Returns: Object 追加された子要素

isClosed

ウィンドウが完全に閉じている場合 true を返す (openness == 0)

isOpen

ウィンドウが完全に開いている場合 true を返す (openness == 255)

move

X座標、Y座標、幅、高さを一度に設定する

• x Number ウィンドウのX座標
• y Number ウィンドウのY座標
• width Number ウィンドウの幅
• height Number ウィンドウの高さ

removeChild

コンテナから子要素を削除する

• child Object 削除する子要素
• Returns: Object 削除された子要素

removeChildAt

指定されたインデックスから子要素を削除する

• index Number 子要素を特定するインデックス
• Returns: Object 削除された子要素

setCursorRect

コマンドカーソルの位置を設定する

• x Number カーソルのX座標
• y Number カーソルのY座標
• width Number カーソルの幅
• height Number カーソルの高さ

setTone

背景の色を変更する

• r Number 範囲内の赤色の値 (-255, 255)
• g Number 範囲内の緑色の値 (-255, 255)
• b Number 範囲内の青色の値 (-255, 255)

update

各フレームのウィンドウを更新する

WindowLayer Class

ゲームウィンドウを含むレイヤー

Properties

• children Array [read-only] ウィンドウレイヤーの子要素の配列
• height Number ウィンドウレイヤーの高さ (px)
• parent Object [read-only] ウィンドウレイヤーを含むオブジェクト
• width Number ウィンドウレイヤーの幅 (px)
• x Number ウィンドウレイヤーのX座標
• y Number ウィンドウレイヤーのY座標

WindowLayer

コンストラクタ

addChild

コンテナに子要素を追加する

• child Object 追加する子要素
• Returns: Object 追加された子要素

addChildAt

コンテナの指定されたインデックスに子要素を追加する ※2

• child Object 追加する子要素
• index Number 子要素を配置するインデックス
• Returns: Object 追加された子要素

move

X座標、Y座標、幅、高さを一度に設定する

• x Number ウィンドウレイヤーのX座標
• y Number ウィンドウレイヤーのY座標
• width Number ウィンドウレイヤーの幅
• height Number ウィンドウレイヤーの高さ

removeChild

コンテナから子要素を削除する

• child Object 削除する子要素
• Returns: Object 削除された子要素

removeChildAt

指定されたインデックスから子要素を削除する

• index Number 子要素を特定するインデックス
• Returns: Object 削除された子要素

update

各フレームのウィンドウレイヤーを更新する

JSON

JSONデータ構造

~ Actor

アクターのJSONデータ構造

• battlerName String SV戦闘キャラ画像のファイル名
• characterIndex Number 歩行キャラ画像のインデックス
• characterName String 歩行キャラ画像のファイル名
• classId Number 職業のID
• equips Array 初期装備
• faceIndex Number 顔画像のインデックス
• faceName String 顔画像のファイル名
• id Number ID
• initialLevel Number 初期レベル
• maxLevel Number 最大レベル
• name String 名前
• nickname String 二つ名
• note String メモ
• profile String プロフィール
• traits Array 特徴データの配列

~ Ainmation

アニメーションのJSONデータ構造

• animation1Hue Number 1番目のアニメーション画像の色相
• animation1Name String 1番目のアニメーション画像のファイル名
• animation2Hue Number 2番目のアニメーション画像の色相
• animation2Name String 2番目のアニメーション画像のファイル名
• frames Array フレームの内容を含む三次元配列
• id Number ID
• name String 名前
• position Number 位置
• timings Array タイミングデータの配列

~ Animation::Timing

SEとフラッシュのタイミングのJSONデータ構造

• flashColor Array フラッシュの色
• flashDuration Number フラッシュの時間
• flashScope Number フラッシュの範囲
• frame Number フレームのインデックス
• se ~ AudioFile SE

~ Armor

防具のJSONデータ構造

• atypeId Number 防具タイプのID
• description String 説明
• etypeId Number 装備タイプのID
• iconIndex Number アイコンのインデックス
• id Number ID
• name String 名前
• note String メモ
• params Array 能力値変化量
• price Array 価格
• traits Array 特徴データの配列

~ AudioFile

オーディオファイルのJSONデータ構造

• name String 名前
• volume Number 音量
• pitch Number ピッチ
• pan Number 位相

~ BattleEventPage

バトルイベントページのJSONデータ構造

• conditions ~ BattleEventPage::Conditions 条件
• list Array イベントコマンドデータの配列
• span Number スパン

~ BattleEventPage::Conditions

バトルイベントの条件のJSONデータ構造

• actorHp Number アクターHPの割合
• actorId Number アクターのID
• actorValid Boolean 「アクターHP」の有効化
• enemyHp Number 敵キャラHPの割合
• enemyIndex Number 敵キャラのインデックス
• enemyValid Boolean 「敵キャラHP」の有効化
• switchId Number スイッチのID
• switchValid Boolean 「スイッチ」の有効化
• turnA Number ターン条件値A
• turnB Number ターン条件値B
• turnEnding Boolean 「ターン終了」の有効化
• turnValid Boolean 「ターン」の有効化

~ Class

職業のJSONデータ構造 ※2

• expParams Number 経験値曲線の配列
• id Number ID
• learnings Array 習得するスキルデータの配列
• name String 名前
• note String メモ
• params Array レベルに応じた能力値を含む二次元配列
• traits Array 特徴データの配列

~ Class::Learning

習得するスキルのJSONデータ構造

• level Number レベル
• skillId Number 習得するスキルのID
• note String メモ

~ CommonEvent

コモンイベントのJSONデータ構造

• id Number ID
• list Array イベントコマンドデータの配列
• name String 名前
• trigger Number トリガー
• switchId Number スイッチのID

~ Damage

ダメージのJSONデータ構造

• critical Boolean 会心フラグ
• elementId Number 属性のID
• formula String 計算式
• type Number タイプ
• variance Number 分散度

~ Effect

エフェクトのJSONデータ構造

• code Number エフェクトのコード
• dataId Number エフェクトのタイプに応じたデータ（属性やステートなど）のID
• value1 Number エフェクトのタイプに応じて設定される値1
• value2 Number エフェクトのタイプに応じて設定される値2

~ Enemy

敵キャラのJSONデータ構造

• actions Array 行動パターンデータの配列
• battlerHue Number 敵キャラ画像の色相
• battlerName String 敵キャラ画像のファイル名
• dropItems Array ドロップアイテムデータの配列
• exp Number 経験値
• gold Number 所持金
• id Number ID
• name String 名前
• note String メモ
• params Array 能力値
• traits Array 特徴データの配列

~ Enemy::Action

行動パターンのJSONデータ構造

• conditionParam1 Number 条件の値1
• conditionParam2 Number 条件の値2
• conditionType Number 条件のタイプ
• rating Number レーティング
• skillId Number スキルのID

~ Enemy::DropItem

ドロップアイテムのJSONデータ構造

• dataId Number 種類に応じたアイテムのID
• denominator Number アイテムがドロップされる確率 (1/N)
• kind Number アイテムの種類

~ Event

マップイベントのJSONデータ構造

• id Number ID
• name Number 名前
• note String メモ
• pages Array イベントページデータの配列
• x Number X座標
• y Number Y座標

~ EventCommand

イベントコマンドのJSONデータ構造

• code Number コマンドコード
• indent Number インデントの深さ
• parameters Array イベントコードに応じたパラメータ

~ EventPage

イベントページのJSONデータ構造

• conditions ~ EventPage::Conditions 出現条件
• directionFix Boolean 向き固定のオプション
• image ~ EventPage::Image 画像
• list Array イベントコマンドデータの配列
• moveFrequency Number 移動頻度
• moveRoute ~ MoveRoute 移動ルート
• moveSpeed Number 移動速度
• moveType Number 移動タイプ
• priorityType Number プライオリティ
• stepAnime Boolean 足踏みのオプション
• through Boolean すり抜けのオプション
• trigger Number トリガー
• walkAnime Boolean 歩行アニメのオプション

~ EventPage::Conditions

イベント出現条件のJSONデータ構造 ※2

• actorId Number アクターのID
• actorValid Boolean 「アクター」の有効化
• itemId Number アイテムのID
• itemValid Boolean 「アイテム」の有効化
• selfSwitchCh String セルフスイッチの文字
• selfSwitchValid Boolean 「セルフスイッチ」の有効化
• switch1Id Number 1番目のスイッチのID
• switch1Valid Boolean 1番目の「スイッチ」の有効化
• switch2Id Number 2番目のスイッチのID
• switch2Valid Boolean 2番目の「スイッチ」の有効化
• variableId Number 変数のID
• variableValid Boolean 「変数」の有効化
• variableValue Number 変数の参照値

~ EventPage::Image

イベント画像のJSONデータ構造 ※2

• characterIndex Number キャラ画像のインデックス
• characterName String キャラ画像のファイル名
• direction Number 向き
• pattern Number パターンのインデックス
• tileId Number タイルのID

~ Item

アイテムのJSONデータ構造

• animationId Number アニメーションのID
• consumable Number 消耗フラグ
• damage ~ Damage ダメージ
• description String 説明
• effects Array エフェクトデータの配列
• hitType Number 命中タイプ
• iconIndex Number アイコンのインデックス
• id Number ID
• itypeId Number アイテムタイプのID
• name String 名前
• note String メモ
• occasion Number 使用可能時
• price Number 価格
• repeats Number 連続回数
• scope Number 範囲
• speed Number 速度補正
• successRate Number 成功率
• tpGain Number 得TP

~ Map

マップのJSONデータ構造

• autoplayBgm Boolean 「BGM自動演奏」オプション
• autoplayBgs Boolean 「BGS自動演奏」オプション
• battleback1Name String 戦闘背景の床のファイル名
• battleback2Name String 戦闘背景の壁のファイル名
• bgm ~ AudioFile 自動演奏するBGM
• bgs ~ AudioFile 自動演奏するBGS
• data Array マップデータを含む三次元配列
• disableDashing Boolean 「ダッシュ禁止」オプション
• displayName String 表示名
• encounterList Array エンカウントデータの配列
• encounterStep Number エンカウント歩数
• events Array イベントデータの配列
• hight Number 高さ
• note String メモ
• parallaxLoopX Boolean 遠景の「横方向にループする」オプション
• parallaxLoopY Boolean 遠景の「縦方向にループする」オプション
• parallaxName String 遠景画像のファイル名
• parallaxShow Boolean 遠景の「エディタに表示」オプション
• parallaxSx Number 遠景の横方向スクロールの速度
• parallaxSy Number 遠景の縦方向スクロールの速度
• scrollType Number スクロールタイプ
• specifyBattleback Boolean 「戦闘背景指定」オプション
• tilesetId Number タイルセットのID
• width Number 幅

~ Map::Encounter

エンカウント設定のJSONデータ構造

• regionSet Array リージョンIDの配列
• troopId Number 敵グループのID
• weight Number 重み

~ MapInfo

マップ情報のJSONデータ構造

• expanded Boolean マップツリー内の展開フラグ
• name String 名前
• order Number マップツリー内の順序
• parentId Number 親マップのID
• scrollX Boolean マップエディタの水平スクロール位置
• scrollY Boolean マップエディタの垂直スクロール位置

~ MoveCommand

移動コマンドのJSONデータ構造

• code Number コマンドコード
• parameters Array コマンドコードに応じたパラメータ

~ MoveRoute

移動ルートのJSONデータ構造

• list Array 移動コマンドデータの配列
• repeats Boolean 「動作を繰り返す」オプション
• skippable Boolean 「移動できない場合は飛ばす」オプション
• wait Boolean 「完了までウェイト」オプション

~ Skill

スキルのJSONデータ構造

• animationId Number アニメーションのID
• damage ~ Damage ダメージ
• description String 説明
• effects Array エフェクトデータの配列
• hitType Number 命中タイプ
• iconIndex Number アイコンのインデックス
• id Number ID
• message1 String メッセージ1
• message2 String メッセージ2
• mpCost Number 消費MP
• name String 名前
• note String メモ
• occasion Number 使用可能時
• repeats Number 連続回数
• requiredWtypeId1 Number 必要武器タイプ1のID
• requiredWtypeId2 Number 必要武器タイプ2のID
• scope Number 範囲
• speed Number 速度補正
• stypeId Number スキルタイプのID
• successRate Number 成功率
• tpCost Number 消費TP
• tpGain Number 得TP

~ State

ステートのJSONデータ構造

• autoRemovalTiming Number 自動解除のタイミング
• chanceByDamage Number ダメージで解除する確率
• iconIndex Number アイコンのインデックス
• id Number ID
• maxTurns Number 最大継続ターン数
• message1 String アクターがこの状態になったときのメッセージ
• message2 String 敵キャラがこの状態になったときのメッセージ
• message3 String この状態が継続しているときのメッセージ
• message4 String この状態が解除されたときのメッセージ
• minTurns Number 最小継続ターン数
• motion Number SVモーション
• name String 名前
• note String メモ
• overlay Number SV重ね合わせ
• priority Number 優先度
• removeAtBattleEnd Boolean 「戦闘終了時に解除」のオプション
• removeByDamage Boolean 「ダメージで解除」のオプション
• removeByRestriction Boolean 「行動制約によって解除」のオプション
• removeByWalking Boolean 「歩数で解除」のオプション
• restriction Number 行動制約
• stepsToRemove Number ステートを解除する歩数
• traits Array 特徴データの配列

~ System

システムのJSONデータ構造

• airship ~ System::Vehicle 飛行船の設定
• armorTypes Array 防具タイプのリスト
• attackMotions Array 攻撃モーションデータの配列
• battleback1Name String 戦闘背景の床のファイル名
• battleback2Name String 戦闘背景の壁のファイル名
• battleBgm ~ AudioFile 戦闘時のBGM
• battlerHue Number アニメーション編集に使用する敵画像の色相
• battlerName String アニメーション編集に使用する敵画像のファイル名
• boat ~ System::Vehicle 小型船の設定
• currencyUnit String 通貨単位
• defeatMe ~ AudioFile 敗北時のME
• editMapId Number 編集中のマップのID
• elements Array 属性タイプのリスト
• equipTypes Array 装備タイプのリスト
• gameoverMe ~ AudioFile ゲームオーバー時のME
• gameTitle String ゲームタイトル
• locale String 「ja_JP」や「en_US」などのロケール名
• magicSkills Array 魔法スキルのスキルタイプIDの配列
• menuCommands Array メニューコマンド
• optDisplayTp Boolean 「バトル画面でTPを表示」のオプション
• optDrawTitle Boolean 「ゲームタイトルの描画」のオプション
• optExtraExp Boolean 「控えメンバーも経験値を獲得」のオプション
• optFloorDeath Boolean 「床ダメージで戦闘不能」のオプション
• optFollowers Boolean 「パーティの隊列歩行」のオプション
• optSideView Boolean 「サイドビュー戦闘を使用」のオプション
• optSlipDeath Boolean 「スリップダメージで戦闘不能」のオプション
• optTransparent Boolean 「透明状態で開始」のオプション
• partyMembers Array 初期パーティのアクターIDの配列
• ship ~ System::Vehicle 大型船の設定
• skillTypes Array スキルタイプのリスト
• sounds Array 効果音のオーディオファイルデータの配列
• startMapId Number プレイヤーの初期位置のマップID
• startX Number プレイヤーの初期位置のX座標
• startY Number プレイヤーの初期位置のY座標
• switches Array スイッチ名のリスト
• terms ~ System::Terms 用語
• testBattlers Array テストバトルデータの配列
• testTroopId Number テストバトルの敵グループのID
• title1Name String タイトル画面の背景画像のファイル名
• title2Name String タイトル画面のフレーム画像のファイル名
• titleBgm ~ AudioFile タイトル画面のBGM
• variables Array 変数名のリスト
• versionId Number 更新チェックに使用される乱数
• victoryMe ~ AudioFile 勝利時のME
• weaponTypes Array 武器タイプのリスト
• windowTone Array ウィンドウカラー

~ System::AttackMotion

攻撃モーションのJSONデータ構造

• type Number モーションのタイプ
• weaponImageId Number 武器画像のID

~ System::Terms

用語のJSONデータ構造

• basic Array 基本ステータスの名前
• commands Array コマンドの名前
• messages Object メッセージ
• params Array 能力値の名前

~ System::TestBattler

テストバトルで使用するアクターのJSONデータ構造

• actorId Number アクターのID
• equips Array 装備
• level Number レベル

~ System::Vehicle

乗り物のJSONデータ構造

• bgm ~ AudioFile BGM
• characterIndex Number 乗り物画像のインデックス
• characterName String 乗り物画像のファイル名
• startMapId Number 初期位置のマップID
• startX Number 初期位置のX座標
• startY Number 初期位置のY座標

~ Tileset

タイルセットのJSONデータ構造

• flags Array タイルフラグ
• id Number ID
• mode Number モード
• name String 名前
• note String メモ
• tilesetNames Array タイルセット画像のファイル名

~ Trait

特徴のJSONデータ構造

• code Number 特徴のコード
• dataId Number 特徴のタイプに応じたデータ（属性やステートなど）のID
• value Number 特徴のタイプに応じて設定される値

~ Troop

敵グループのJSONデータ構造

• id Number ID
• members Array メンバーデータの配列
• name String 名前
• pages Array バトルイベントページデータの配列

~ Troop::Member

敵グループメンバーのJSONデータ構造

• enemyId Number 敵キャラのID
• hidden Boolean 「途中から出現」のオプション
• x Number X座標
• y Number Y座標

~ Weapon

武器のJSONデータ構造

• animationId Number アニメーションのID
• description String 説明
• etypeId Number 装備タイプのID
• iconIndex Number アイコンのインデックス
• id Number ID
• name String 名前
• note String メモ
• params Array 能力値変化量
• price Number 価格
• traits Array 特徴データの配列
• wtypeId Number 武器タイプのID

---

以上。