はじめに
ゲーム作成の手引き
その他の情報
関数リファレンス
このページでは、Rmakeで使える関数の一覧とその使い方を紹介します。
関数一覧
- 文章表示関連
- メッセージ表示（speak関数）
- 選択肢メッセージ表示（speakWithSelect関数）
- 全画面メッセージ表示（背景なし）（speakFullScreen （背景なし）関数）
- 全画面メッセージ表示（背景あり）（speakFullScreen （背景あり）関数）
- 全画面選択肢メッセージ表示（背景なし）（speakFullScreenWithSelect （背景なし）関数）
- 全画面選択肢メッセージ表示（背景あり）（speakFullScreenWithSelect （背景あり）関数）
- 画面テキスト生成（createText関数）
- 画面テキスト設定（setText関数）
- 画面テキスト表示削除（deleteText関数）
- 画面テキスト全削除（deleteTextAll関数）
- 選択肢メッセージ表示（speakWithSelectArray関数）
- フラグ・変数操作関連
- フラグ取得関数（getFlag関数）
- フラグ設定関数（setFlag関数）
- 変数取得（getVariable関数）
- 変数設定（setVariable関数）
- 保存するグローバル変数設定（addSaveGlobalVariable関数）
- 読み込むグローバル変数設定（addLoadGlobalVariable関数）
- サーバーからグローバル変数読込（loadGlobalVariable関数）
- グローバル変数取得（getLoadedGlobalVariable関数）
- 保存するグローバル変数全消去（clearSaveGlobalVariable関数）
- 読み込むグローバル変数全消去（clearLoadGlobalVariable関数）
- 指定IDゲームクリアチェック（checkGameClear関数）
- URLパラメーターの取得（getURLParam関数）
- プレイヤーキャラクタ操作関連
- プレーヤーキャラクターHP取得（getPlayerHP関数）
- プレーヤーキャラクターHP減少（subPlayerHP関数）
- プレーヤーキャラクターHP増加（addPlayerHP関数）
- プレーヤーキャラクター最大HP取得（getPlayerMaxHP関数）
- プレーヤーキャラクターMP取得（getPlayerMP関数）
- プレーヤーキャラクターMP減少（subPlayerMP関数）
- プレーヤーキャラクターMP増加（addPlayerMP関数）
- プレーヤーキャラクター最大MP取得（getPlayerMaxMP関数）
- プレーヤーX座標取得（getPlayerPosX関数）
- プレーヤーY座標取得（getPlayerPosY関数）
- プレーヤーレベル取得（getLevel関数）
- プレーヤーレベルアップ（levelUp関数）
- プレーヤーが倒した敵の数を取得（getKillCount関数）
- プレーヤーを表示（showPlayer関数）
- プレーヤーを隠す（hidePlayer関数）
- プレーヤーのパラメーター配列取得（getPlayerParam関数）
- キャラクターステータス配列から値を取得（getValueFromCharacterParam関数）
- ゲーム操作関連
- ゲームクリア（goEnding関数）
- プレーヤーワープ（warp関数）
- 時間待ち（waitTime関数）
- カメラ移動（moveCamera関数）
- カメラ移動戻し（moveCamera関数）
- フェードアウト（fadeOut関数）
- フェードイン（fadeIn関数）
- 敵全滅判定（isEnemyWipedOut関数）
- シーンの変更（changeScene関数）
- バッドエンディング（goBadEnding関数）
- ターンバトルの開始（startTurnBattle関数）
- チャプターの変更（changeChapter関数）
- ターンバトル終了状態判定（getTurnBattleResult関数）
- 画面の振動（shakeScreen関数）
- ターンバトル逃亡成功率設定（setTurnBattleRunAwayRate関数）
- エンカウント時ターンバトル逃亡成功率設定（setTurnBattleRunAwayRateOnEncount関数）
- フェードイン・アウト間隔設定（setFadeInterval関数）
- プレーデータの保存（savePlayData関数）
- プレーデータの保存(メッセージ設定)（savePlayDataCustom関数）
- 強制プレーデータの保存(メッセージ設定)（forceSavePlayDataCustom関数）
- 音楽/効果音/画像操作関連
- BGM停止（stopBGM関数）
- BGM再生（playBGM関数）
- 全画面画像表示（showImage関数）
- 全画面画像隠す（hideImage関数）
- 効果音再生（playSound関数）
- 画像表示（showImagePosition関数）
- 画像隠す（hideImagePosition関数）
- 左画像表示（showLeftImage関数）
- 左画像隠す（hideLeftImage関数）
- 中央画像表示（showCenterImage関数）
- 中央画像隠す（hideCenterImage関数）
- 右画像表示（showRightImage関数）
- 右画像隠す（hideRightImage関数）
- 背景以外の画像隠す（hideImageAllWithoutBG関数）
- 効果音の停止（stopSound関数）
- BGM音量設定（setMusicVolume関数）
- 効果音音量設定（setSoundVolume関数）
- BGMをフェードアウトして停止（fadeOutMusicStop関数）
- BGMをフェードアウトして新しいBGMをフェードイン（fadeOutMusicFadeIn関数）
- BGMをフェードインしながら再生（fadeInMusic関数）
- システム関連
- 乱数（rand関数）
- 基本時刻設定（setBaseTime関数）
- 時刻取得（getTime関数）
- 切捨て（floor関数）
- 文字列への変換（toString関数）
- 余弦（cos関数）
- 正弦（sin関数）
- 円周率（pi関数）
- 平方根（sqrt関数）
- 正接（tan関数）
- 逆正接（atan関数）
- yとxの値からラジアンを求める（atan2関数）
- 逆正弦（asin関数）
- 逆余弦（acos関数）
- 文字列を数値に変換（toNumber関数）
- プレイヤーPCの現在時刻（getLocalCurrentDate関数）
- プレイヤーのPCでの時刻(ミリ秒)（getLocalCurrentTimeMillisecond関数）
- ゲーム起動時の時間（getServerGameStartDate関数）
- サーバーの現在の時刻（getServerCurrentDate関数）
- フォントレイアウト関連
- メッセージフォントサイズ取得（getTextFontSize関数）
- メッセージフォント赤成分取得（getTextFontColorR関数）
- メッセージフォント緑成分取得（getTextFontColorG関数）
- メッセージフォント青成分取得（getTextFontColorB関数）
- メッセージフォント太字取得（getTextFontBold関数）
- メッセージフォントイタリック取得（getTextFontItalic関数）
- メッセージ表示方法取得（getTextViewMode関数）
- メッセージフォントサイズ設定（setTextFontSize関数）
- メッセージフォント色設定（setTextFontColor関数）
- メッセージフォント太字設定（setTextFontBold関数）
- メッセージフォントイタリック設定（setTextFontItalic関数）
- メッセージ表示方法設定（setTextViewMode関数）
- 選択肢フォントサイズ取得（getSelectFontSize関数）
- 選択肢フォント赤成分取得（getSelectFontColorR関数）
- 選択肢フォント緑成分取得（getSelectFontColorG関数）
- 選択肢フォント青成分取得（getSelectFontColorB関数）
- 選択肢フォント太字取得（getSelectFontBold関数）
- 選択肢フォントイタリック取得（getSelectFontItalic関数）
- 選択肢フォント高さ取得（getSelectFontHeight関数）
- 選択肢フォントサイズ設定（setSelectFontSize関数）
- 選択肢フォント色設定（setSelectFontColor関数）
- 選択肢フォント太字設定（setSelectFontBold関数）
- 選択肢フォントイタリック設定（setSelectFontItalic関数）
- 選択肢フォント高さ設定（setSelectFontHeight関数）
- メッセージウィンドウX座標取得（getSpeakWindowX関数）
- メッセージウィンドウY座標取得（getSpeakWindowY関数）
- メッセージウィンドウ幅取得（getSpeakWindowWidth関数）
- メッセージウィンドウ高さ取得（getSpeakWindowHeight関数）
- メッセージウィンドウ矩形設定（setSpeakWindowRect関数）
- 選択肢ウィンドウX座標取得（getSelectWindowX関数）
- 選択肢ウィンドウY座標取得（getSelectWindowY関数）
- 選択肢ウィンドウ幅取得（getSelectWindowWidth関数）
- 選択肢ウィンドウ高さ取得（getSelectWindowHeight関数）
- 選択肢ウィンドウ矩形設定（setSelectWindowRect関数）
- 全画面メッセージ表示時選択肢の位置と大きさ設定（setFullScreenSelectLeftWidth関数）
- 全画面メッセージ表示時選択肢の位置と大きさ取得（getFullScreenSelectLeftWidth関数）
- 全画面メッセージ表示時選択肢の背景表示設定（setFullScreenSelectBg関数）
- 全画面メッセージ表示時選択肢の背景表示取得（getFullScreenSelectBg関数）
- 制御文
- イベント操作関連
- メニューカスタマイズ関連
- カスタムパラメーターメインメニュー表示設定（setCustomParamMenuEnable関数）
- カスタムパラメーターメインメニュー表示取得（getCustomParamMenuEnable関数）
- カスタムパラメーターメニュー表示名設定（setCustomParamMenuName関数）
- カスタムパラメーターメニュー表示名取得（getCustomParamMenuName関数）
- カスタムパラメーター項目名設定（setCustomParamName関数）
- カスタムパラメーター項目名取得（getCustomParamName関数）
- カスタムパラメーター値設定（setCustomParamValue関数）
- カスタムパラメーター値取得（getCustomParamValue関数）
- カスタムパラメーターの項目数取得（getCustomParamLength関数）
- カスタムパラメーター項目削除（deleteCustomParam関数）
- カスタムパラメーター描画（drawCustomParam関数）
- メニュー項目表示設定（ノベル）（setMenuItemVisible （ノベル）関数）
- メニュー項目表示取得（ノベル）（getMenuItemVisible （ノベル）関数）
- メニュー項目表示設定（2DRPG）（setMenuItemVisible （2DRPG）関数）
- メニュー項目表示取得（2DRPG）（getMenuItemVisible （2DRPG）関数）
- メニュー項目表示設定（アクションRPG）（setMenuItemVisible （アクションRPG）関数）
- メニュー項目表示取得（アクションRPG）（getMenuItemVisible （アクションRPG）関数）
- ヘルプ表示設定（setHelpVisible関数）
- ヘルプ表示取得（getHelpVisible関数）
- メインメニュー表示キー有効設定（setMenuOpenKeyEnable関数）
- パーティ関連
- パーティメンバー追加（addPartyMember関数）
- パーティメンバー削除（removePartyMember関数）
- パーティ全回復（setPartyMemberHealingAll関数）
- パーティメンバーHP加算（addPartyMemberHP関数）
- パーティメンバーHP減算（subPartyMemberHP関数）
- パーティメンバーHP取得（getPartyMemberHP関数）
- パーティメンバー最大HP取得（getPartyMemberMaxHP関数）
- パーティメンバーMP加算（addPartyMemberMP関数）
- パーティメンバーMP減算（subPartyMemberMP関数）
- パーティメンバーMP取得（getPartyMemberMP関数）
- パーティメンバー最大MP取得（getPartyMemberMaxMP関数）
- パーティ全員HP0（setPartyMemberDeathAll関数）
- パーティメンバーID取得（getPartyMember関数）
- パーティメンバーかどうかの判定（isPartyMember関数）
- パーティメンバーレベル取得（getLevelPartyMember関数）
- パーティメンバーレベルアップ（levelUpPartyMember関数）
- パーティメンバーが倒した敵の数を取得（getKillCountPartyMember関数）
- パーティメンバーのステータス取得（getPartyMemberParam関数）
- 配列/コレクション関連
- 入力関連
- アイテム関連
- プレーヤーにアイテム渡す（giveItem関数）
- プレーヤーにアイテムを渡して装備（giveEquipment関数）
- パーティメンバーにアイテムを渡して装備（giveEquipmentPartyMember関数）
- 所持アイテムID配列取得（getItemIdArray関数）
- プレーヤー装備ID配列取得（getEquipmentIdArray関数）
- 所持アイテム消去（removeItemWithIndex関数）
- プレーヤー装備消去（removeEquipmentWithIndex関数）
- IDで指定した所持アイテムのインデックス取得（getItemIndexWithId関数）
- アイテムIDからプレーヤー装備のインデックス取得（getEquipmentIndexWithId関数）
- アイテムIDからパラメーター取得（getItemParamWithId関数）
- アイテムパラメーターの配列からパラメーター取得（getValueFromItemParam関数）
- 所持アイテムのパラメーター配列取得（getItemParamWithIndex関数）
- 所持アイテムの最大数設定（setMaxItemCount関数）
- 所持アイテムの最大数取得（getMaxItemCount関数）
- パーティメンバー装備IDの配列取得（getPartyMemberEquipmentIdArray関数）
- パーティメンバーの指定インデックスの装備の消去（removePartyMemberEquipmentWithIndex関数）
- アイテムIDからパーティメンバーの装備のインデックス取得（getPartyMemberEquipmentIndexWithId関数）
- パーティメンバーの装備のパラメーター配列をインデックスから取得（getPartyMemberEquipmentParamWithIndex関数）
- プレーヤーの装備からアイテムパラメーター配列の取得（getEquipmentParamWithIndex関数）
- 拡張画像操作関連
- キャンバス表示設定（setCanvasVisible関数）
- キャンバス表示状態取得（getCanvasVisible関数）
- キャンバスへの描画（drawCanvas関数）
- スプライト生成（createSprite関数）
- スプライト削除（deleteSprite関数）
- スプライト全削除（deleteAllSprite関数）
- スプライトコピー矩形設定（setSpriteRect関数）
- スプライト位置設定（setSpritePosition関数）
- スプライト回転設定（setSpriteRotation関数）
- スプライト拡大率設定（setSpriteScale関数）
- スプライトzオーダー設定（setSpriteZOrder関数）
- スプライトカメラ独立設定（setSpriteIndependentCamera関数）
- スプライト用カメラ位置（setSpriteCameraPosition関数）
- スプライト用カメラ回転（setSpriteCameraRotation関数）
- スプライト用カメラの拡大縮小（setSpriteCameraScale関数）
- スプライト画面表示位置（setSpriteCameraOffset関数）
- ソーシャル機能関連
- お金・お店・宿屋関連
文章表示関連
speak関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
speak("はじめまして。")speakの引数には文字列および数値を複数渡すことができます。渡した引数は結合されてひとつのメッセージとして表示されます。
speak("数値は", 5, "です")文字列を改行する場合は文中に\nを記述します。
speak("1行目\n2行目")speakWithSelect関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
case speakWithSelect(2, "はい", "いいえ",
"どっちにしますか？\n以下選択肢")
when 0
speak("はいと答えました!")
when 1
speak("いいえと答えました!")
end
- 第1引数に選択肢の数
- 第2引数から選択肢の数だけ選択肢の内容の文字列
- 選択肢以降はメッセージに表示される文章で、speakのように結合して表示
- 返り値は何番目の選択肢が選択されたかです
ここではspeakWithSelectで選択肢とメッセージウィンドウを表示して、その選択肢の内容に応じて表示するメッセージを変えています。
speakFullScreen （背景なし）関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
speakFullScreen(false, "全画面表示背景つき。")
- 第1引数はメッセージに半透明の黒い背景を表示するかどうか
- 第2引数以降の文字列は結合されて表示
speakFullScreen （背景あり）関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
speakFullScreen(true, "全画面表示背景つき。")
- 第1引数はメッセージに半透明の黒い背景を表示するかどうか
- 第2引数以降の文字列は結合されて表示
speakFullScreenWithSelect （背景なし）関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
case speakFullScreenWithSelect(false, 2, "はい",
"いいえ", "どっちにしますか？\n以下選択肢")
when 0
speakFullScreen(true, "はいと答えました。\n\n!")
when 1
speakFullScreen(true, "いいえと答えました。\n\n!")
end
- 第1引数はメッセージに半透明の黒い背景を表示するかどうか
- 第2引数は選択肢の数
- 第3引数から選択肢の数だけ選択肢用の文字列
- それ以降の引数はメッセージとして表示する文字列で結合して表示
ここではspeakFullScreenWithSelectで選択肢と全画面メッセージを表示して、その選択肢の内容に応じて表示するメッセージを変えています。
speakFullScreenWithSelect （背景あり）関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
case speakFullScreenWithSelect(true, 2, "はい",
"いいえ", "どっちにしますか？\n以下選択肢")
when 0
speakFullScreen(true, "はいと答えました。\n\n!")
when 1
speakFullScreen(true, "いいえと答えました。\n\n!")
end
- 第1引数はメッセージに半透明の黒い背景を表示するかどうか
- 第2引数は選択肢の数
- 第3引数から選択肢の数だけ選択肢用の文字列
- それ以降の引数はメッセージとして表示する文字列で結合して表示
ここではspeakFullScreenWithSelectで選択肢と全画面メッセージを表示して、その選択肢の内容に応じて表示するメッセージを変えています。
createText関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
textID = createText(64, 64, 220, 220)
- 第1引数はx座標（ピクセル単位）
- 第2引数はy座標（ピクセル単位）
- 第3引数は幅（ピクセル単位）
- 第4引数は高さ（ピクセル単位）
- 返り値はテキスト領域のID
setText関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setText(textID, "ああああああああ")
- 第1引数は文字列表示領域のID（createTextの返り値）
- 第2引数は表示する文字列
deleteText関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
deleteText(textID)
- 第1引数は削除する文字列表示領域のID（createTextの返り値）
deleteTextAll関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
deleteTextAll()
speakWithSelectArray関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
選択肢は配列で指定します。
a = createArray()
a[0] = "はい"
a[1] = "いいえ"
case speakWithSelectArray(a, "質問！")
when 0
speak("はい！")
when 1
speak("いいえ！")
end
- 第1引数は選択肢の文字列の配列
- 第2引数以降はメッセージウィンドウに表示する文字列
- 返り値は選択した選択肢のインデックス
フラグ・変数操作関連
getFlag関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
getFlag("test_event_first")- 第1引数はフラグの名前
- 返り値は第1引数のフラグに関連付けられた値
フラグに関連付けられた値を返します。
setFlag関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setFlag("test_event_first", true)- 第1引数はフラグの名前
- 第2引数は設定するフラグに関連付けられた値
フラグの名前に関連付けられた値が設定されます。
getVariable関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
a = getVariable("変数")- 第1引数は変数名です。
setVariable関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setVariable("a", 100)- 第1引数は変数名
- 第2引数は代入する値
addSaveGlobalVariable関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
addSaveGlobalVariable("test1", 0)
addSaveGlobalVariable("test2", "値")
- 第1引数は変数名
- 第2引数は保存する値
詳しい使い方については以下を参照してください。
スクリプト/グローバル変数
addLoadGlobalVariable関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
addLoadGlobalVariable(2, "変数名")
- 第1引数は読み込み元のゲームID
- 第2引数は読み込む変数名
詳しい使い方については以下を参照してください。
スクリプト/グローバル変数
loadGlobalVariable関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
loadGlobalVariable()
- 返り値は読み込みに成功すればtrue、読み込みに失敗すればfalse
詳しい使い方については以下を参照してください。
スクリプト/グローバル変数
getLoadedGlobalVariable関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
getLoadedGlobalVariable(2, "変数名")
- 第1引数はゲームID
- 第2引数は変数名
- 返り値は読み込んだ変数。読み込みに失敗した場合はnilが返る。
詳しい使い方については以下を参照してください。
スクリプト/グローバル変数
clearSaveGlobalVariable関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
つまり、addSaveGlobalVariableで追加した変数を
クリアします。
clearSaveGlobalVariable()
引数と返り値はありません。
詳しい使い方については以下を参照してください。
スクリプト/グローバル変数
clearLoadGlobalVariable関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
つまり、addLoadGlobalVariableで追加された
読み込む変数の情報をクリアします。
clearLoadGlobalVariable()
引数と返り値はありません。
詳しい使い方については以下を参照してください。
スクリプト/グローバル変数
checkGameClear関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
if checkGameClear(2)
speak("id:2のゲームをクリア。")
else
speak("id:2のゲームをまだクリアしていません。")
end
- 第1引数は判定したいゲームのID
- 返り値はクリアしたかどうか
getURLParam関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
urlParam = getURLParam()
- 返り値はURLに渡されたパラメーターの文字列
- URLに渡せるパラメーターは英数字と「_（アンダースコア）」のみ
- URLに渡せるパラメーターの最大文字数は200文字まで
- この関数はURLに含まれるパラメーター「gd」の値を返します
■ 例
以下のようなURLにアクセスされた場合、getURLParam()関数は"paramData"を返します。
http://rmake.jp/games/1/play?gd=paramData
プレイヤーキャラクタ操作関連
getPlayerHP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getPlayerHP()
- 返り値はプレーヤーキャラクターのHP
subPlayerHP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
subPlayerHP(100)
- 第1引数はプレーヤーキャラクターのHPを減らす量
addPlayerHP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
addPlayerHP(100)
- 第1引数はプレーヤーキャラクターのHPを増やす量
getPlayerMaxHP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getPlayerMaxHP()
- 返り値はプレーヤーの最大HP
getPlayerMP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getPlayerMP()
- 返り値はプレーヤーキャラクターのMP
subPlayerMP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
subPlayerMP(100)
- 第1引数はプレーヤーキャラクターのMPを減らす量
addPlayerMP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
addPlayerMP(100)
- 第1引数はプレーヤーキャラクターのMPを増やす量
getPlayerMaxMP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getPlayerMaxMP()
- 返り値はプレーヤーキャラクターの最大MP
getPlayerPosX関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getPlayerPosX()
- 返り値はプレーヤーの位置のX座標（ピクセル単位）
getPlayerPosY関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getPlayerPosY()
- 返り値はプレーヤーの位置のY座標（ピクセル単位）
getLevel関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
speak("level = ", getLevel())
- 返り値はプレーヤーのレベル
levelUp関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
if levelUp()
speak("レベルアップしました。")
else
speak("レベルアップできませんでした。")
end
- 返り値はレベルアップできたかどうか
レベルアップできた場合はtrueを返します。
最大レベル(99)を超える場合など
レベルアップできなかった場合は
はfalseを返します。
getKillCount関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getKillCount()
- 返り値は倒した敵の種類と数の組の配列
たとえば倒した敵のキャラクターIDと倒した数を表示するには
次のようにします。
speak("倒した敵のIDと数")
a = getKillCount()
i = 0
while i < getArrayLength(a)
speak("id = ", a[i][0], " count = ", a[i][1])
i = i + 1
end
showPlayer関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
showPlayer()
引数、返り値ともにありません。
hidePlayer関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
hidePlayer()
引数、返り値ともにありません。
イベントの処理が終了するとプレーヤーは表示されます。
getPlayerParam関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getPlayerParam()
- 返り値はプレーヤーのパラメーターの配列
配列の各要素にアクセスする場合は
getValueFromCharacterParamを使用してください。
getValueFromCharacterParam関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
speak("主人公のID", getValueFromCharacterParam( getPlayerParam(), getCharacterIdIndex()))
- 第1引数はキャラクターステータスの配列
- 第2引数は取得したいキャラクターステータスのインデックス
- 返り値は取得したキャラクターステータス
キャラクターステータスのインデックスの指定は
入力支援からおこなうことをお勧めします。
ゲーム操作関連
goEnding関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
goEnding()
warp関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
warp(3, 1, 1)
- 第1引数は移動先のマップID
- 第2引数は移動先のx座標（32x32のます目単位）
- 第3引数は移動先のy座標（32x32のます目単位）
引数の位置に移動します。
waitTime関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
waitTime(1000)
- 第一引数は待つ時間（ミリ秒）
moveCamera関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
moveCamera(true, 320, 320) moveCamera(false)
- 第1引数はカメラを移動するかどうか
- trueならばそのあとに指定する位置で表示
- falseならばプレーヤーを中心とする位置に表示
- 第2引数はカメラのx座標（ピクセル単位）
- 第3引数はカメラのy座標（ピクセル単位）
第2引数と第3引数は第1引数がfalseのときは省略できます。
moveCamera関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
moveCamera(true, 320, 320) moveCamera(false)
- 第1引数はカメラを移動するかどうか
- trueならばそのあとに指定する位置で表示
- falseならばプレーヤーを中心とする位置に表示
- 第2引数はカメラのx座標（ピクセル単位）
- 第3引数はカメラのy座標（ピクセル単位）
第2引数と第3引数は第1引数がfalseのときは省略できます。
fadeOut関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
fadeOut(255, 255, 255)
- 第1引数はフェードアウトする色の赤の値(0～255)
- 第2引数はフェードアウトする色の緑の値(0～255)
- 第3引数はフェードアウトする色の青の値(0～255)
fadeIn関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
isEnemyWipedOut関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
isEnemyWipedOut()
- 返り値は敵が全滅しているかどうか
changeScene関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | No |
| ノベルゲーム | Yes |
changeScene(9)
- 第1引数は変更先のシーンID
goBadEnding関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | No |
| ノベルゲーム | Yes |
goBadEnding()
startTurnBattle関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
speak("戦いが始まった。")
if startTurnBattle(11, 11, 18)
speak("戦いに勝った。")
else
speak("戦いに負けた。")
end
引数は1～6の間で指定することができます。
いずれの引数も敵のIDで、引数に渡したキャラクターのIDが
敵キャラとして表示されます。
返り値は戦闘に勝利したかどうかです。
changeChapter関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | No |
| ノベルゲーム | Yes |
何もしなければ順々に実行されていきますが、
changeChapter関数を使うことでチャプターを
移動することができます。
changeChapter("chapter0")
- 第1引数は移動先のチャプター名を指定
getTurnBattleResult関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
getTurnBattleResult()
- 返り値は戦闘の結果
戦闘の結果は以下のとおりです。
- 勝ったときはgetTurnBattleWin()の返り値と同じ値
- 負けたときはgetTurnBattleLose()の返り値と同じ値
- 逃げたときはgetTurnBattleRunAway()の返り値と同じ値
たとえば以下のようにして戦闘結果に応じて処理を変えます。
if getTurnBattleResult() ==
getTurnBattleWin()
#勝ったとき
elsif getTurnBattleResult() ==
getTurnBattleLose()
#負けたとき
elsif getTurnBattleResult() ==
getTurnBattleRunAway()
#逃げたとき
end
shakeScreen関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
shakeScreen(2000)
- 第１引数は画面を揺らす時間（ミリ秒）
setTurnBattleRunAwayRate関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
setTurnBattleRunAwayRate(0.75)
startTurnBattle(11, 24, 54, 55)
if getTurnBattleResult() ==
getTurnBattleWin()
#勝ったとき
speak("Win!")
elsif getTurnBattleResult() ==
getTurnBattleLose()
#負けたとき
speak("Lose!")
elsif getTurnBattleResult() ==
getTurnBattleRunAway()
#逃げたとき
speak("Run away!")
end
- 第1引数は逃亡の成功率
逃亡の成功率は0.0～1.0の範囲で設定します。
0.0のときは必ず逃げるのに失敗します。
1.0のときは必ず逃げるのに成功します。
逃亡の成功率の初期値は0.0（必ず逃げるのに失敗）です。
setTurnBattleRunAwayRateOnEncount関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
setTurnBattleRunAwayRateOnEncount(0.0)
- 第1引数は逃亡の成功率
逃亡の成功率は0.0～1.0の範囲で設定します。
0.0のときは必ず逃げるのに失敗します。
1.0のときは必ず逃げるのに成功します。
逃亡の成功率の初期値は0.5です。
setFadeInterval関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setFadeInterval(100)
- 第1引数はフェードイン・フェードアウトにかける時間(ミリ秒)
初期状態でのフェードインフェードアウトにかける時間は
500ミリ秒です。
savePlayData関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
メニューからセーブを選んだ時とほぼ同じ動作をします。
savePlayData()
2DRPG、2DアクションRPGの場合はこの関数を呼んだ
イベントの終了後にセーブがおこなわれます。
ノベルゲームでは、呼んだところでセーブがおこなわれます。
この時再生している音楽などはチャプター開始時のもの、
変数はこの関数を読んだ時のものが保存され、
ロードした時はこの関数を呼んだチャプターの先頭から
開始します。
savePlayDataCustom関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
savePlayDataCustom("せーぶするぅ？", "yeah", "nooooo!!!")
- 第1引数はセーブ確認のメッセージ
- 第2引数はセーブする場合の選択肢テキスト
- 第3引数はキャンセルする場合の選択肢テキスト
2DRPG、2DアクションRPGの場合はこの関数を呼んだ
イベントの終了後にセーブがおこなわれます。
ノベルゲームでは、呼んだところでセーブがおこなわれます。
この時再生している音楽などはチャプター開始時のもの、
変数はこの関数を読んだ時のものが保存され、
ロードした時はこの関数を呼んだチャプターの先頭から
開始します。
forceSavePlayDataCustom関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
保存に成功しないとゲームを先に進めることができません
forceSavePlayDataCustom("強制保存だ！選択の余地はない！", "...はい")
- 第1引数はセーブ確認のメッセージ
- 第2引数はセーブする場合の選択肢テキスト
2DRPG、2DアクションRPGの場合はこの関数を呼んだ
イベントの終了後にセーブがおこなわれます。
ノベルゲームでは、呼んだところでセーブがおこなわれます。
この時再生している音楽などはチャプター開始時のもの、
変数はこの関数を読んだ時のものが保存され、
ロードした時はこの関数を呼んだチャプターの先頭から
開始します。
音楽/効果音/画像操作関連
stopBGM関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
stopBGM()
playBGM関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
playBGM(71)
- 第1引数は再生する音楽のID
showImage関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
showImage(50)
- 第1引数は表示する画像のIDです。
hideImage関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
hideImage()
playSound関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
playSound(73)
- 第1引数は再生する効果音のID
- 返り値は再生した効果音を表わすID（このIDは再生している効果音を停止する際に利用します）
showImagePosition関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setVariable("imageID", showImagePosition(300, 20, 74))
- 第1引数は描画する画像のX座標の位置（ピクセル単位）
- 第2引数は描画する画像のY座標の位置（ピクセル単位）
- 第3引数は描画する画像のID
- 返り値は表示した画像を表わすID（このIDは画像を隠す際に利用します）
hideImagePosition関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
hideImagePosition(getVariable("imageID"))
- 第1引数は隠す画像を表わすID（showImagePositionの返り値）
showLeftImage関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
showLeftImage(132)
- 第1引数は画像ID
hideLeftImage関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
hideLeftImage()
showCenterImage関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
showCenterImage(132)
- 第1引数は画像ID
hideCenterImage関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
showRightImage関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
showRightImage(132)
- 第1引数は画像ID
hideRightImage関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
hideRightImage()
hideImageAllWithoutBG関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
(showImagePositionやshowLeftImageなどの立ち絵表示関数)
を隠します。
hideImageAllWithoutBG()
stopSound関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
soundId = playSound(10620) waitTime(1000) stopSound(soundId)
- 第1引数は再生している効果音のID（playSoundの返り値）
setMusicVolume関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setMusicVolume(0.5)
- 第1引数はBGMに設定する音量
音量は0.0～1.0で設定します。
setSoundVolume関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
soundId = playSound(10620) setSoundVolume(soundId, 0.5)
- 第1引数は再生している効果音を表わすID
- 第2引数は効果音に設定する音量
音量は0.0～1.0で設定します。
fadeOutMusicStop関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
fadeOutMusicStop(2000)
- 第1引数はフェードアウトにかかる時間(ミリ秒)
fadeOutMusicFadeIn関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
fadeOutMusicFadeIn(2000, 136, 2000)
- 第1引数はフェードアウトにかかる時間(ミリ秒)
- 第2引数は新しいBGMのID
- 第3引数はフェードインにかかる時間(ミリ秒)
fadeInMusic関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
fadeInMusic(136, 2000)
- 第1引数は再生するBGMのID
- 第2引数はフェードインにかける時間(ミリ秒)
システム関連
rand関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
rand() rand(5)
引数は無しか1つ設定することができます。引数が設定されなかった場合は0以上で1より小さい値がランダムに返ります。
引数がひとつ設定された場合は0～(第1引数の値-1)の値がランダムに返ります。
setBaseTime関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setBaseTime()
getTime関数はsetBaseTime()が呼ばれた時刻から
何ミリ秒経過したかを返します。
getTime関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
getTime()
前に呼ばれたsetBaseTimeから何ミリ秒たったかを返します。
floor関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
v = floor(v)
- 第１引数は切り捨てたい値
- 返り値は切り捨てた値
toString関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
toString(12.5)
- 第1引数は変換元の値
- 返り値は変換された文字列
cos関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
x = x + cos(theta) * 2.0
- 第1引数は余弦を求めたいラジアンの値
- 返り値は余弦
sin関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
y = y + sin(theta) * 2.0
- 第1引数はラジアンの値
- 返り値は正弦
pi関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
x = cos(pi() / 2) y = sin(pi() / 2)
- 返り値は円周率
sqrt関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
x = sqrt(2)
- 第1引数は平方根を求めたい値
- 返り値は平方根の値
tan関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
[ tangent = tan(tehta) ]
- 第１引数は正接を求めたいラジアンの値
- 返り値は正接
atan関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
arctangent = atan(x)
- 第１引数は逆正接を求めたい値
- 返り値は逆正接のラジアン
atan2関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
radian = atan2(0.5, 0.5)
- 第1引数y座標の値
- 第2引数x座標の値
- 返り値は座標x,yが原点でなす角度のラジアン
asin関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
arcsine = asin(1.0)
- 第１引数は逆正接を求めたい値
- 返り値は逆正接の値ラジアン
acos関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
arccosine = acos(1.0)
- 第1引数は逆余弦を求めたい値
- 返り値は逆余弦の値ラジアン
toNumber関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
num = toNumber("5")
- 第1引数は変換対象の文字列
- 返り値は変換された数値
a = splitString("1, 2", ",")
speak("a[0] + a[1] = " + toString(toNumber(a[0]) + toNumber(a[1])))
# a[0] + a[1] = 3 と出力されます
getLocalCurrentDate関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
tm = getLocalCurrentDate()
- 返り値は時刻の配列
現在時刻が「2012年5月10日 17:53:25 500ms」の場合、以下の配列を返します。
[2012, 5, 10, 17, 53, 25, 500]
■ プレイヤーPCの時刻に関する補足
この関数は、プレイヤーPCに設定されている時刻を返します。
そのため、プレイヤーのPCの時刻がずれていたり、意図的に変更されている場合の影響を受けます。
時間経過に伴うボーナスなどをゲームで与える場合は、この関数を使うとプレイヤーのPCの時刻を変更することによって不正を行うことが可能です。
そのような場合は、サーバーの時刻を取得する関数を使ってください。
getLocalCurrentTimeMillisecond関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
tm = getLocalCurrentTimeMillisecond()
- 返り値は世界時刻1970年1月1日0時から経過した時間のミリ秒
■ プレイヤーPCの時刻に関する補足
この関数は、プレイヤーPCに設定されている時刻を返します。
そのため、プレイヤーのPCの時刻がずれていたり、意図的に変更されている場合の影響を受けます。
時間経過に伴うボーナスなどをゲームで与える場合は、この関数を使うとプレイヤーのPCの時刻を変更することによって不正を行うことが可能です。
そのような場合は、サーバーの時刻を取得する関数を使ってください。
getServerGameStartDate関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
tm = getServerGameStartDate()
- 返り値はゲーム起動時間の配列
この時間はサーバーに設定されたものを返すため、プレイヤーのPCの時刻がずれていたり、意図的に変更されている場合の影響を受けません。
時間によってプレイヤーに得点などを与える場合はこちらの関数を使ってください。
時刻が「2012年5月10日 17:53:25 500ms タイムゾーンが日本 サマータイムなし」の場合、以下の配列を返します。
[2012, 5, 10, 17, 53, 25, 500, 32400, false]
■ サーバー時刻に関する補足
サーバーの時刻は正確であることが期待できますが、取得時に通信の遅延の影響を受けるため、数秒ずれている可能性があります。
■ タイムゾーンに関する補足
協定世界時（UTC）から、日本は32400秒（9時間）進んでいます。
このため、タイムゾーンに関する値として、32400が返されます。
■ サマータイムに関する補足
日本はサマータイムを導入していないため、falseが返されます。
getServerCurrentDate関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
tm = getServerCurrentDate()
- 返り値は時刻の配列
この時間はサーバーに設定されたものを返すため、プレイヤーのPCの時刻がずれていたり、意図的に変更されている場合の影響を受けません。
時間によってプレイヤーに得点などを与える場合はこちらの関数を使ってください。
時刻が「2012年5月10日 17:53:25 500ms タイムゾーンが日本 サマータイムなし」の場合、以下の配列を返します。
[2012, 5, 10, 17, 53, 25, 500, 32400, false]
■ サーバー時刻に関する補足
サーバーの時刻は正確であることが期待できますが、取得時に通信の遅延の影響を受けるため、数秒ずれている可能性があります。
■ タイムゾーンに関する補足
協定世界時（UTC）から、日本は32400秒（9時間）進んでいます。
このため、タイムゾーンに関する値として、32400が返されます。
■ サマータイムに関する補足
日本はサマータイムを導入していないため、falseが返されます。
フォントレイアウト関連
getTextFontSize関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldTextFontSize = getTextFontSize();
- 返り値はメッセージフォントの高さ
getTextFontColorR関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldTextFontColorR = getTextFontColorR()
- 返り値はメッセージのフォントの赤成分
getTextFontColorG関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldTextFontColorG = getTextFontColorG()
- 返り値はメッセージのフォントの緑成分
getTextFontColorB関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldTextFontColorB = getTextFontColorB()
- 返り値はメッセージのフォントの青成分
getTextFontBold関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
getTextFontItalic関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldTextFontItalic = getTextFontItalic()
getTextViewMode関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldTextViewMode = getTextViewMode()
- 返り値はメッセージの表示方法
- 0ならば一度に表示
- 1ならば一文字ずつ表示
setTextFontSize関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setTextFontSize(32)
- 第一引数は設定するフォントのサイズ
setTextFontColor関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setTextFontColor(255, 0, 0)
- 第1引数はフォントの色の赤成分を0～255の値で設定します。
- 第2引数はフォントの色の緑成分を0～255の値で設定します。
- 第3引数はフォントの色の青成分を0～255の値で設定します。
setTextFontBold関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setTextFontBold(true)
- 第1引数は太字にするかどうかの条件式
setTextFontItalic関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setTextFontItalic(true)
- 第1引数はフォントをイタリックにするかどうか
setTextViewMode関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setTextViewMode(0)
- 第1引数は表示方法
- 0ならば一度に表示
- 1ならば一文字ずつ表示
getSelectFontSize関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSelectFontSize = getSelectFontSize()
- 返り値はフォントのサイズ
getSelectFontColorR関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSelectFontColorR = getSelectFontColorR()
- 返り値はフォントの色の赤成分
getSelectFontColorG関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSelectFontColorG = getSelectFontColorG()
- 返り値はフォントの色の緑成分
getSelectFontColorB関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSelectFontColorB = getSelectFontColorB()
- 返り値はフォントの色の青成分
getSelectFontBold関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSelectFontBold = getSelectFontBold()
getSelectFontItalic関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSelectFontItalic = getSelectFontItalic()
- 返り値はフォントがイタリックかどうか
getSelectFontHeight関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
項目の間隔などがこの値で決まるため、
フォントのサイズが大きい場合はこの値も大きくする必要があります。
oldSelectFontHeight = getSelectFontHeight()
- 返り値は項目の高さ
setSelectFontSize関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSelectFontSize(32)
- 第1引数はフォントのサイズです。
setSelectFontColor関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSelectFontColor(255, 0, 0)
- 第1引数はフォントの色の赤成分を0～255の値で設定します。
- 第2引数はフォントの色の緑成分を0～255の値で設定します。
- 第3引数はフォントの色の青成分を0～255の値で設定します。
setSelectFontBold関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSelectFontBold(true)
- 第1引数はフォントが太字かどうかを設定
setSelectFontItalic関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSelectFontItalic(true)
- 第1引数はフォントをイタリックにするかどうか
setSelectFontHeight関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
項目の間隔などがこの値で決まるため、
フォントのサイズが大きい場合はこの値も大きくする必要があります。
setSelectFontHeight(36)
- 第1引数は項目の高さ
getSpeakWindowX関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSpeakWindowX = getSpeakWindowX()
- 返り値はメッセージウィンドウのX座標(pixel単位)
getSpeakWindowY関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSpeakWindowY = getSpeakWindowY()
- 返り値はメッセージウィンドウのY座標(pixel単位)
getSpeakWindowWidth関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSpeakWindowWidth = getSpeakWindowWidth()
- 返り値はメッセージウィンドウの幅(pixel単位)
getSpeakWindowHeight関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSpeakWindowHeight = getSpeakWindowHeight()
- 返り値はメッセージウィンドウの高さ(pixel単位)
setSpeakWindowRect関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSpeakWindowRect(128, 16, 512 - 128 - 16, 384 - 32)
- 第1引数はメッセージウィンドウのx座標(pixel単位)
- 第2引数はメッセージウィンドウのy座標(pixel単位)
- 第3引数はメッセージウィンドウの幅(pixel単位)
- 第4引数はメッセージウィンドウの高さ(pixel単位)
getSelectWindowX関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSelectWindowX = getSelectWindowX()
- getSelectWindowX関数は選択肢ウィンドウのX座標（ピクセル単位）を取得します
getSelectWindowY関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSelectWindowY = getSelectWindowY()
- 返り値は選択肢ウィンドウのY座標（ピクセル単位）
getSelectWindowWidth関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSelectWindowWidth = getSelectWindowWidth()
- 返り値は選択肢ウィンドウの幅（ピクセル単位）
getSelectWindowHeight関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldSelectWindowHeight = getSelectWindowHeight()
- 返り値は選択肢ウィンドウの高さ（ピクセル単位）
setSelectWindowRect関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSelectWindowRect(64, 64, 192, 400)
- 第1引数は選択肢ウィンドウのX座標（ピクセル単位）を設定
- 第2引数は選択肢ウィンドウのy座標（ピクセル単位）を設定
- 第3引数は選択肢ウィンドウの幅（ピクセル単位）を設定
- 第4引数は選択肢ウィンドウの高さ（ピクセル単位）を設定
setFullScreenSelectLeftWidth関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setFullScreenSelectLeftWidth((512 - 300) / 2, 300)
- 第1引数は全画面メッセージ表示時に表示される選択肢の左端の位置
- 第2引数は全画面メッセージ表示時に表示される選択肢の幅
getFullScreenSelectLeftWidth関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
oldLeftWidth = getFullScreenSelectLeftWidth() ... setFullScreenSelectLeftWidth(oldLeftWidth[0], oldLeftWidth[1])
- 返り値は全画面メッセージ表示時選択肢の位置と大きさの配列
返り値の0番目は全画面メッセージ表示時選択肢の位置です。
返り値の1番目は全画面メッセージ表示時選択肢の大きさです。
setFullScreenSelectBg関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setFullScreenSelectBg(false)
- 第1引数は全画面メッセージ表示時選択肢の背景表示をするかどうか
getFullScreenSelectBg関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
取得します。
oldBg = getFullScreenSelectBg() ... setFullScreenSelectBg(oldBg)
- 返り値は全画面メッセージ表示時選択肢の背景表示をするかどうか
制御文
イベント操作関連
getEventDirection関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getEventDirection("日本語キャラクター")
- 第1引数は向きを取得する対象のイベント名
- 返り値はイベントの向き
対象のイベント名に"playerCharacterEvent"を
設定した場合はプレーヤーキャラクターに対して
処理をおこないます。
"this"か"self"を設定した場合は
実行しているイベント自身に対して処理をおこないます。
上の向きを表わす値は以下の関数と返り値が同じです。
getUpDirection()
右の向きを表わす値は以下の関数と返り値が同じです。
getRightDirection()
左の向きを表わす値は以下の関数と返り値が同じです。
getLeftDirection()
下の向きを表わす値は以下の関数と返り値が同じです。
getDownDirection()
setEventDirection関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
setEventDirection("日本語キャラクター",
getDownDirection())
- 第1引数は向きを設定するイベントの名前
- 第2引数はイベントを向かせる方向
対象のイベント名に"playerCharacterEvent"を
設定した場合はプレーヤーキャラクターに対して
処理をおこないます。
"this"か"self"を設定した場合は
実行しているイベント自身に対して処理をおこないます。
上の向きを表わす値は以下の関数と返り値が同じです。
getUpDirection()
右の向きを表わす値は以下の関数と返り値が同じです。
getRightDirection()
左の向きを表わす値は以下の関数と返り値が同じです。
getLeftDirection()
下の向きを表わす値は以下の関数と返り値が同じです。
getDownDirection()
setEventTarget関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
setEventTarget("event136", 18, 12)
- 第1引数は動かすイベントの名前
- 第2引数はイベントの移動先のx座標（マップチップ単位）
- 第3引数はイベントの移動先のy座標（マップチップ単位）
イベントの移動先はエディターの左上に表示される値を使用すると
わかりやすいかと思います。
対象のイベント名に"playerCharacterEvent"を
設定した場合はプレーヤーキャラクターに対して
処理をおこないます。
"this"か"self"を設定した場合は
実行しているイベント自身に対して処理をおこないます。
第4引数以降も設定することができます。
この場合は第2引数と第3引数で設定した座標に移動したあと
第4引数と第5引数の座標という具合に移動します。
setEventTarget("event136", 18, 12,
24, 12, 24, 17,
20, 17, 20, 14,
22, 14
)
setEventTarget("event137", 18, 12,
24, 12, 24, 17,
20, 17, 20, 14,
22, 14
)
setEventTarget("playerCharacterEvent",
18, 20, 18, 12,
24, 12, 24, 17,
20, 17, 20, 14,
22, 14
)
runEventMove()
複数のイベントも同時に動かせます。
イベントが目標にたどり着くか
目標にこれ以上近づけないところまでくると
処理が終了します。
runEventMove関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
runEventMove()
使用例は以下のとおりです。
setEventTarget("event136", 18, 12,
24, 12, 24, 17,
20, 17, 20, 14,
22, 14
)
setEventTarget("event137", 18, 12,
24, 12, 24, 17,
20, 17, 20, 14,
22, 14
)
setEventTarget("playerCharacterEvent",
18, 20, 18, 12,
24, 12, 24, 17,
20, 17, 20, 14,
22, 14
)
runEventMove()
複数のイベントも同時に動かせます。
イベントが目標にたどり着くか
目標にこれ以上近づけないところまでくると
処理が終了します。
resetEvent関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
（倒した敵を復活させることもできます。）
resetEvent()
引数と返り値はともにありません。
setEventTargetで移動させたイベントは、移動先の位置に
設定されます。
それ以外の移動（ランダム移動、主人公の追跡）の結果は
初期位置に戻ります。
warpEvent関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
warpEvent("event21", 10, 18)
- 第1引数は動かすイベントの名前
- 第2引数はイベントの移動先のx座標（左上原点マップチップ単位）
- 第3引数はイベントの移動先のy座標（左上原点マップチップ単位）
イベントの移動先はエディターの左上に表示される値を使用すると
わかりやすいかと思います。
setEventCharacter関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
setEventCharacter("event2", 4)
- 第1引数はキャラクターを変更するイベント
- 第2引数はイベントに設定したいキャラクターのID
対象のイベント名に"playerCharacterEvent"を
設定した場合はプレーヤーキャラクターに対して
処理をおこないます。
"this"か"self"を設定した場合は
実行しているイベント自身に対して処理をおこないます。
初期状態のキャラクターに戻す場合は第2引数を
"default"にしてください。
キャラクターを変更するイベントは現在いるマップの上の
ものを指定しなければなりません
メニューカスタマイズ関連
setCustomParamMenuEnable関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
setCustomParamMenuEnable(true)
- 第1引数はカスタムパラメーターをメインメニューに表示するかどうか
カスタムステータスを開くときには
ユーザーが定義したonShowCustomParameter関数が呼ばれます
def onShowCustomParameter() imageHandle = showImagePosition(300, 32, 74) end
画像などをこのタイミングで表示する場合は、
この関数を定義してください。
getCustomParamMenuEnable関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getCustomParamMenuEnable()
- 返り値はカスタムパラメーターの項目をメインメニューに表示するかどうか
カスタムステータスを開くときには
ユーザーが定義したonShowCustomParameter関数が呼ばれます
def onShowCustomParameter() imageHandle = showImagePosition(300, 32, 74) end
画像などをこのタイミングで表示する場合は、
この関数を定義してください。
setCustomParamMenuName関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
setCustomParamMenuName("マイステータス")
- 第1引数はカスタムパラメーターのメニューに表示する名前
カスタムステータスを開くときには
ユーザーが定義したonShowCustomParameter関数が呼ばれます
def onShowCustomParameter() imageHandle = showImagePosition(300, 32, 74) end
画像などをこのタイミングで表示する場合は、
この関数を定義してください。
getCustomParamMenuName関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getCustomParamMenuName()
- 返り値はカスタムパラメーターのメニューに表示される名前
カスタムステータスを開くときには
ユーザーが定義したonShowCustomParameter関数が呼ばれます
def onShowCustomParameter() imageHandle = showImagePosition(300, 32, 74) end
画像などをこのタイミングで表示する場合は、
この関数を定義してください。
setCustomParamName関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
setCustomParamName(0, "test")
- 第1引数はどの位置のカスタムパラメーターに名前を設定するかを指定
- 第二引数は設定する名前
カスタムステータスを開くときには
ユーザーが定義したonShowCustomParameter関数が呼ばれます
def onShowCustomParameter() imageHandle = showImagePosition(300, 32, 74) end
画像などをこのタイミングで表示する場合は、
この関数を定義してください。
getCustomParamName関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getCustomParamName(0)
- 第1引数はどの位置の項目名を取得するかを指定
- 返り値は項目名
カスタムステータスを開くときには
ユーザーが定義したonShowCustomParameter関数が呼ばれます
def onShowCustomParameter() imageHandle = showImagePosition(300, 32, 74) end
画像などをこのタイミングで表示する場合は、
この関数を定義してください。
setCustomParamValue関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
setCustomParamValue(0, 10)
- 第1引数はカスタムパラメーターの値を設定する位置
- 第2引数は設定するカスタムパラメーターの値
カスタムステータスを開くときには
ユーザーが定義したonShowCustomParameter関数が呼ばれます
def onShowCustomParameter() imageHandle = showImagePosition(300, 32, 74) end
画像などをこのタイミングで表示する場合は、
この関数を定義してください。
getCustomParamValue関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getCustomParamValue(0)
- 第1引数は取得するカスタムパラメーターの値の位置
- 返り値はカスタムパラメーターの値
カスタムステータスを開くときには
ユーザーが定義したonShowCustomParameter関数が呼ばれます
def onShowCustomParameter() imageHandle = showImagePosition(300, 32, 74) end
画像などをこのタイミングで表示する場合は、
この関数を定義してください。
getCustomParamLength関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
正確にはカスタムパラメーターのインデックスの最大値+1の値が返ります。
getCustomParamLength()
- 返り値はカスタムパラメーターの項目数
カスタムステータスを開くときには
ユーザーが定義したonShowCustomParameter関数が呼ばれます
def onShowCustomParameter() imageHandle = showImagePosition(300, 32, 74) end
画像などをこのタイミングで表示する場合は、
この関数を定義してください。
deleteCustomParam関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
deleteCustomParam(0)
- 第1引数は削除する項目のインデックス
カスタムステータスを開くときには
ユーザーが定義したonShowCustomParameter関数が呼ばれます
def onShowCustomParameter() imageHandle = showImagePosition(300, 32, 74) end
画像などをこのタイミングで表示する場合は、
この関数を定義してください。
drawCustomParam関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
drawCustomParam（）
onShowCustomParameter関数が呼び終わったときに
カスタムパラメーターは描画されますが、
speakなど待ちが入る命令がある場合、この関数を呼ぶとすぐに描画されます。
setMenuItemVisible （ノベル）関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | No |
| ノベルゲーム | Yes |
setMenuItemVisible(getMenuBackLog(), false)
- 第１引数はメニューの項目を表わすID
- 第２引数は指定したメニューの項目を表示するかどうか
第１引数に入れる値は入力支援から選択することができます。
getMenuItemVisible （ノベル）関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | No |
| ノベルゲーム | Yes |
getMenuItemVisible(getMenuBackLog())
- 第１引数はメニューの項目を表わすID
- 返り値は指定したメニューの項目を表示するかどうか
第１引数に入れる値は入力支援から選択することができます。
setMenuItemVisible （2DRPG）関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
setMenuItemVisible(getMenuBackLog(), false)
- 第１引数はメニューの項目を表わすID
- 第２引数は指定したメニューの項目を表示するかどうか
第１引数に入れる値は入力支援から選択することができます。
getMenuItemVisible （2DRPG）関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
getMenuItemVisible(getMenuBackLog())
- 第１引数はメニューの項目を表わすID
- 返り値は指定したメニューの項目を表示するかどうか
第１引数に入れる値は入力支援から選択することができます。
setMenuItemVisible （アクションRPG）関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | No |
| ノベルゲーム | No |
setMenuItemVisible(getMenuBackLog(), false)
- 第１引数はメニューの項目を表わすID
- 第２引数は指定したメニューの項目を表示するかどうか
第１引数に入れる値は入力支援から選択することができます。
getMenuItemVisible （アクションRPG）関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | No |
| ノベルゲーム | No |
getMenuItemVisible(getMenuBackLog())
- 第１引数はメニューの項目を表わすID
- 返り値は指定したメニューの項目を表示するかどうか
第１引数に入れる値は入力支援から選択することができます。
setHelpVisible関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
これにより、ヘルプを表示できるかどうかを設定することができます。
setHelpVisible(false)
- 第1引数はヘルプを表示できるようにするかどうか
getHelpVisible関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
つまり、ヘルプが表示できるかどうかを設定することができます。
oldVisible = getHelpVisible()
- 返り値はヘルプボタンが表示されているかどうか
setMenuOpenKeyEnable関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setMenuOpenKeyEnable(false)
- 第1引数はメインメニューをキー入力で表示するかどうか
x, cなどを押したときにメニューを開きたくない場合
setMenuOpenKeyEnable(false)
を設定することで、xやcキーを押しても
メニューが開かれないようになります。
パーティ関連
addPartyMember関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
if addPartyMember(9)
speak("仲間に加わりました。")
else
speak("仲間を加えられませんでした。")
end
- 第1引数はパーティに追加するキャラクターのID
- 返り値はパーティに追加できたかどうか
パーティには同じキャラクターを複数追加することはできません。
1つのキャラクターは1体だけ追加することができます。
過去に追加したキャラクターは、一度メンバーから外れてから
再度追加されたとき、アイテムおよび装備は外される前の状態で
追加されます。
removePartyMember関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
if removePartyMember(24)
speak("パーティからはずしました。")
else
speak("パーティからはずせませんでした。")
end
- 第1引数はパーティメンバーのキャラクターのID
- 返り値はパーティメンバーを外せたかどうか
setPartyMemberHealingAll関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
setPartyMemberHealingAll()
addPartyMemberHP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
addPartyMemberHP(24, 1);
speak("killerのHPを1上げました")
- 第1引数はパーティメンバーのID
- 第2引数はHPに加算する値
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
subPartyMemberHP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
subPartyMemberHP(24, 2);
speak("killerのHPを2下げました")
- 第1引数はパーティメンバーのID
- 第2引数はHPから減算する値
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
getPartyMemberHP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
speak("killerのHPは",
getPartyMemberHP(24), "です。")
- 第1引数はパーティメンバーのID
- 返り値は指定したパーティメンバーのHP
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
getPartyMemberMaxHP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
speak("killerのMaxHPは",
getPartyMemberMaxHP(24), "です。")
- 第1引数はパーティメンバーのID
- 返り値は指定したパーティメンバーの最大HP
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
addPartyMemberMP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
addPartyMemberMP(24, 1)
- 第1引数はパーティメンバーのID
- 第2引数はMPに加算する値
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
subPartyMemberMP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
subPartyMemberMP(24, 2)
- 第1引数はパーティメンバーのID
- 第2引数はMPを減算する値
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
getPartyMemberMP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
speak("killerのMPは",
getPartyMemberMP(24), "です。")
- 第1引数はパーティメンバーのID
- 返り値は指定したパーティメンバーのMP
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
getPartyMemberMaxMP関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
speak("killerのMaxMPは",
getPartyMemberMaxMP(24), "です。")
- 第1引数はパーティメンバーのID
- 返り値は指定したパーティメンバーの最大MP
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
setPartyMemberDeathAll関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
そのままイベントスクリプトを終了するとデッドエンドです。
setPartyMemberDeathAll()
getPartyMember関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
getPartyMember(0)
- 第１引数は何番目のパーティメンバのIDを取得するかの指定
- 返り値はパーティーメンバーのID
パーティメンバーのIDはキャラクターIDを返します。
プレーヤーキャラクターの場合は"playerCharacter"を
返します。
キャラクターがいない場合は-1を返します。
isPartyMember関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
if isPartyMember(20)
speak("パーティメンバーに勇者がいます。")
end
- 第１引数はパーティメンバーのID
- 返り値は指定したキャラクターがパーティメンバーにいるかどうか
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
getLevelPartyMember関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
speak("player level = ",
getLevelPartyMember("playerCharacter"))
speak("member level = ",
getLevelPartyMember(24))
- 第1引数はパーティメンバーのID
- 返り値はレベル
levelUpPartyMember関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
speak("level up! ",
levelUpPartyMember("playerCharacter"))
speak("level up! ",
levelUpPartyMember(24))
- 第1引数はパーティメンバーのID
- 返り値はレベルアップできたかどうかです。
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
レベルアップができた場合はtrueを返します。
最大レベル(99)を超える場合などレベルアップできない場合は
falseを返します。
getKillCountPartyMember関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
a = getKillCountPartyMember(
"playerCharacter")
a = getKillCountPartyMember(
24)
- 第1引数はパーティメンバーのID
- 返り値は倒した敵のIDと数の組の配列
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
以下はパーティメンバー全員の倒した敵のIDと数を
列挙するスクリプトです。
speak("倒した敵の数")
i = 0
while i < 4
speak("id = ", getPartyMember(i))
a = getKillCountPartyMember(
getPartyMember(i))
j = 0
while j < getArrayLength(a)
speak("enemy id ", a[j][0],
" count ", a[j][1])
j = j + 1
end
i = i + 1
end
getPartyMemberParam関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
[ getPartyMemberParam(12) ]
- 第1引数はパーティメンバーのID
- 返り値は指定したパーティメンバーのステータス配列
パーティメンバーのIDはプレーヤーキャラクターならば
"playerCharacter"を指定、
それ以外のキャラクターの場合は
キャラクターのIDを指定してください。
たとえばパーティメンバー全員の名前を列挙する場合は
以下のようにします。
i = 0
while i < 4
m = getPartyMember(i)
if isPartyMember(m)
speak("パーティメンバーの名前 ",
getValueFromCharacterParam(
getPartyMemberParam(m),
getCharacterViewNameIndex()))
end
i = i + 1
end
配列/コレクション関連
createArray関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
a = createArray()
- 返り値は生成された配列
[]関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
具体的には、配列へ代入したり、配列の値を取得したりします。
以下の例では生成した配列に値を代入しています。
a = createArray() a[0] = 0.5 a[1] = 2.5 a[2] = 4.5
配列の要素は"代入した配列のインデックス+1"だけ作られます。
配列の長さも"代入した配列のインデックス+1"となります。
代入した値を取得するにはたとえば次のようにします。
b = a[2]
bにaのインデックス2に対応する値（配列の3番目の値）を返します。
配列の内容をすべて表示するコードはたとえば以下のようにします。
i = 0
while i < getArrayLength(a)
speak("a[", i, "] = ", a[i])
i = i + 1
end
getArrayLength関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
len = getArrayLength(a)
- 第１引数は長さを求めたい配列
- 返り値は配列の長さ
pushArray関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
pushArray(a, 6)
- 第１引数は配列です。
- 第２引数は配列に追加する値
この関数を呼ぶと配列の長さが１つ長くなります。
popArray関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
popArray(a)
- 第１引数は削除対象の配列
- 返り値は削除した値
この関数を呼ぶと配列の長さが１つ短くなります。
使用例を以下に示します。
a = createArray()
pushArray(a, 6)
pushArray(a, 8)
speak("pop ", popArray(a))
sliceArray関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
sliceArray(a, 1, 2)
- 第１引数は切り出すもとの配列
- 第２引数はインデックスがいくつの値から切り出すかの指定
- 第３引数はいくつ値を切り出すかの指定
- 返り値は切り出された配列
joinArray関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
s = joinArray(a, ",")
- 第1引数は文字列の配列
- 第2引数は文字列結合時に間に挟む文字列
- 返り値は結合された文字列
使用例は以下の通りです。
a = createArray()
a[0] = "a"
a[1] = "b"
a[2] = "c"
s = joinArray(a, "_")
speak("joinArray(a, \"_\") -> ", s)
#joinArray(a, "_") -> a_b_c が出力される
splitString関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
a = splitString("abc,def,ghi", ",")
- 第1引数は分割対象の文字列
- 第2引数は分割する区切り文字
- 返り値は分割された文字列の配列
a = splitString("abc,def,ghi", ",")
i = 0
while i < getArrayLength(a)
speak("i = ", i, ", ", a[i])
i = i + 1
end
# 以下のように表示されます。
# i = 0, abc
# i = 1, def
# i = 2, ghi
入力関連
startInput関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
startInput()
引数、返り値はともにありません。
スクリプト/キー・マウス入力
endInput関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
endInput()
引数、返り値はともにありません。
スクリプト/キー・マウス入力
hasInput関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
hasInput()
- 返り値はキー、マウス入力の有無
スクリプト/キー・マウス入力
takeInput関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
takeInput()
引数返り値ともにありません。
キーやマウス入力は、startInputが呼ばれた後
Rmakeのシステム内部に保存されていきます。
takeInputに保存されている入力の中から
一番古いものをとりだして一時領域に移動させ、
Rmakeのシステム内部から削除します。
一時領域に入っている入力の内容を判断するために
isMouseDownやisKeyDownの関数などを使って
処理をおこないます。
スクリプト/キー・マウス入力
isMouseDown関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
isMouseDown()
- 返り値はマウスのボタンが押されたときの入力かどうか
takeInputで取り出した入力が
マウスを押したものかどうかを判定します。
スクリプト/キー・マウス入力
isMouseMove関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
isMouseMove()
- 返り値はマウスが動いたときの入力かどうか
takeInputで取り出した入力が
マウスを動かしたものかどうかを判定します。
スクリプト/キー・マウス入力
isMouseUp関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
isMouseUp()
- 返り値はマウスのボタンを離したときの入力かどうか
takeInputで取り出した入力が
マウスのボタンを離したときのものかどうかを判定します。
スクリプト/キー・マウス入力
getMousePosition関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
getMousePosition()
- 返り値はマウスの座標の配列です。
返り値の座標は配列で、x座標は0番目にy座標は1番目に入っています。
pos = getMousePosition()
speak("clicked x = ", pos[0], ", y = ", pos[1])
座標は画面のピクセル値で、左上が原点です。
yの値は下の方向が正です。
スクリプト/キー・マウス入力
isKeyDown関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
isKeyDown("A")
- 第1引数は押されているかどうかを判定したいキーを表わす文字列
- 返り値はキーが押されたかどうか
takeInputで取り出した入力が
キーを押したものかどうかを判定します。
スクリプト/キー・マウス入力
isKeyUp関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
isKeyUp("A")
- 第1引数は離されたかどうかを判定したいキーを表わす文字列
- 返り値はキーが離されたかどうか
takeInputで取り出した入力が
キーを離したものかどうかを判定します。
スクリプト/キー・マウス入力
アイテム関連
giveItem関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
if giveItem(5)
speak("渡しました")
else
speak("渡せませんでした。")
end
- 第一引数は渡すアイテムのID
- 返り値は渡すことができたかどうか
上記の例ではアイテムが渡せたかどうかでメッセージ表示内容を変えています。
持っているアイテムがいっぱいのときなどは、アイテムを渡すのに失敗することがあります。
giveEquipment関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
if giveEquipment(24)
speak("アイテムを装備させました。")
else
speak("アイテムを装備させられませんでした。")
end
- 第１引数は装備させるアイテムのID
- 返り値は装備することができたかどうか
プレーヤーが装備させるアイテムと
同じ種類のアイテムを装備していて、空きがない場合は
falseを返します。装備できた場合はtrueを返します。
giveEquipmentPartyMember関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
if giveEquipmentPartyMember(20, 24)
speak("勇者にアイテムを装備させました。")
else
speak("勇者にアイテムを装備させられませんでした。")
end
- 第1引数はパーティメンバーのID
- 第２引数は装備させるアイテムのID
- 返り値は装備できたかどうか。
パーティメンバーのIDはプレーヤーキャラクター以外の値の場合は
キャラクターIDを指定します。
プレーヤーキャラクターの場合は"playerCharacter"の
文字列を指定します。
対象のパーティメンバーが装備させるアイテムと
同じ種類のアイテムを装備していて、空きがない場合は
falseを返します。装備できた場合はtrueを返します。
getItemIdArray関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getItemIdArray()
- 返り値は所持しているアイテムのIDの配列
getEquipmentIdArray関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getEquipmentIdArray()
- 返り値はプレーヤーが装備しているアイテムのIDの配列
removeItemWithIndex関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
removeItemWithIndex(0)
- 第１引数は消去するアイテムのインデックス(先頭なら0)
removeEquipmentWithIndex関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
removeEquipmentWithIndex(0)
- 第１引数は消去する装備のインデックス(先頭は0)
- 返り値は消去できたかどうか
getItemIndexWithId関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getItemIndexWithId(7)
- 第１引数はインデックスを取得したいアイテムのID
- 返り値は所持アイテムのインデックス
所持していないアイテムが指定された場合は-1が返ります。
getEquipmentIndexWithId関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getEquipmentIndexWithId(32)
- 第1引数はインデックスを求めたいアイテムのID
- 返り値は指定したIDのアイテムの装備位置のインデックス
指定したIDのアイテムを装備していない場合は-1が返ります。
getItemParamWithId関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getItemParamWithId(32)
- 第1引数はアイテムのID
- 返り値はアイテムのパラメーターの配列
返り値の配列からパラメーターを取得するには
getValueFromItemParam関数の入力支援を
使用することをお勧めします。
getValueFromItemParam関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
アイテムパラメーターの配列はgetItemParamWithIdなどアイテムのパラメーターを取得する関数の返り値です。
getValueFromItemParam(getItemParamWithId(36), getItemViewNameIndex())
- 第1引数はアイテムパラメーターの配列
- 第2引数は取得したいアイテムパラメーターのインデックス
- 返り値はインデックスに対応したアイテムパラメーターの値
次の例では、アイテムのIDと、表示用の名前を表示しています。
a = getItemParamWithId(36)
speak("アイテムID:36 = ", getValueFromItemParam(a, getItemIdIndex()))
speak("アイテムName:36 = ", getValueFromItemParam(a, getItemViewNameIndex()))
アイテムパラメーターのインデックスは入力支援を使用して
入力することをお勧めします。
getItemParamWithIndex関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getItemParamWithIndex(0)
- 第1引数はパラメーター配列を取得したい所持アイテムのインデックス
- 返り値はアイテムパラメーター配列
setMaxItemCount関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
すでに持っているアイテム数より少ない値が設定された場合は、最大数以上のインデックスのアイテムを消去します。
setMaxItemCount(2)
- 第1引数は所持できるアイテムの最大数
getMaxItemCount関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getMaxItemCount()
- 返り値は所持できるアイテムの最大数
getPartyMemberEquipmentIdArray関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
getPartyMemberEquipmentIdArray(getPartyMember(0))
- 第1引数はパーティメンバーのID
- 返り値は装備しているアイテムのIDの配列
removePartyMemberEquipmentWithIndex関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
removePartyMemberEquipmentWithIndex(getPartyMember(0), 0)
- 第1引数はパーティメンバーのID
- 第2引数は消去するアイテムのインデックス
getPartyMemberEquipmentIndexWithId関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
getPartyMemberEquipmentIndexWithId(getPartyMember(0), 3)
- 第1引数はパーティメンバーのID
- 第2引数はアイテムのID
- 返り値は装備のインデックス
装備アイテムが見つからなかった場合は-1を返します。
getPartyMemberEquipmentParamWithIndex関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | No |
| 2DRPG | Yes |
| ノベルゲーム | No |
getPartyMemberEquipmentParamWithIndex(getPartyMember(0), 0)
- 第1引数はパーティメンバーのID
- 第2引数は装備のインデックス
- 返り値は装備のパラメーターの配列
getEquipmentParamWithIndex関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getEquipmentParamWithIndex(0)
- 第1引数はプレーヤーの装備のインデックス
- 返り値はアイテムパラメーター配列
拡張画像操作関連
setCanvasVisible関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setCanvasVisible(true)
- 第1引数はキャンバスを表示するかどうか
createSpriteなどを使用した描画をおこなう際は
キャンバスを表示する必要があります。
getCanvasVisible関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
getCanvasVisible()
- 返り値はキャンバスが表示状態にあるかどうか
キャンバスはcreateSpriteで作成されたスプライトの
表示先です。
drawCanvas関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
drawCanvas()
引数、返り値ともにありません。
createSprite関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
spriteHandle = createSprite(127)
- 第1引数はスプライトに割り当てる画像のID
- 返り値はスプライトを表わすID
返り値のスプライトを表わすIDはsetSpritePositionや
deleteSpriteなどスプライトに対する
操作をおこなう場合に使用します。
deleteSprite関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
deleteSprite(spriteHandle)
- 第1引数は削除対象のスプライトのID
deleteAllSprite関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
deleteAllSprite()
引数、返り値ともにありません。
setSpriteRect関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSpriteRect(spriteHandle,
32 + 0.5, 32 + 0.5, 128 - 1.0, 128 - 1.0,
-32, -32, 64, 64
)
- 第1引数はスプライトのID（createSpriteの返り値）
- 第2引数はコピー元の矩形のx座標
- 第3引数はコピー元の矩形のy座標
- 第4引数はコピー元の矩形の幅
- 第5引数はコピー元の矩形の高さ
- 第6引数はコピー先の矩形のx座標
- 第7引数はコピー先の矩形のy座標
- 第8引数はコピー先の矩形の幅
- 第9引数はコピー先の矩形の高さ
矩形の要素の単位はピクセルで、画像の左上が原点です。
setSpritePosition関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
x = 512 / 2 y = 384 / 2 - 100 setSpritePosition(spriteHandle, x, y)
- 第1引数はスプライトのID(createSpriteの返り値)
- 第2引数はスプライトのx座標
- 第3引数はスプライトのy座標
位置はピクセル単位で、原点は画面の左上です。
setSpriteRotation関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
theta = 0.0 setSpriteRotation(spriteHandle, theta)
- 第1引数はスプライトのID(createSpriteの返り値)
- 第2引数は回転量（ラジアン）
回転の方向は正の値を設定した場合は時計回りに回ります。
ラジアンは(角度 * 2.0 * pi() / 360.0)で角度から
変換することができます。
setSpriteScale関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSpriteScale(spriteHandle, 1.0, 1.0)
- 第1引数はスプライトのID(createSpriteの返り値)
- 第2引数はx軸方向の拡大率
- 第3引数はy軸方向の拡大率
setSpriteZOrder関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSpriteZOrder(spriteHandle, 5)
- 第1引数はスプライトのID(createSpriteの返り値)
- 第2引数はzオーダー
zオーダーは値が大きければ大きいほど手前に描かれます。
setSpriteIndependentCamera関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
sp0 = createSprite(74) ... setSpriteIndependentCamera(sp0, true)
- 第1引数はスプライトのID(createSpriteの返り値)
- 第2引数はカメラの位置の影響を受けないかどうか
setSpriteCameraPositionなどの影響を受けずに
スプライトを描画します。
setSpriteCameraPosition関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSpriteCameraPosition(800 / 2, 600 / 2)
- 第1引数はスプライト用カメラのx座標
- 第2引数はスプライト用カメラのy座標
setSpriteCameraRotation関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSpriteCameraRotation(0.5 * pi())
- 第1引数はスプライト用カメラの回転量(ラジアン)
setSpriteCameraScale関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSpriteCameraScale(1.0, 1.0)
- 第1引数はx軸方向の拡大量（1ならば等倍）
- 第1引数はy軸方向の拡大量（1ならば等倍）
setSpriteCameraOffset関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
setSpriteCameraOffset(800 / 2, 600 / 2)
- 第1引数はx軸方向のずらす量
- 第2引数はy軸方向のずらす量
画面の大きさが800x600の場合
以下のように書いて
setSpriteCameraPosition(800 / 2, 600 / 2) setSpriteCameraOffset(800 / 2, 600 / 2)
setSpriteCameraRotationで
回転させると、画面の中心で回転する。
ソーシャル機能関連
openActivityFeedWindow関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
openActivityFeedWindow("アイテムを手に入れました。")
- 第１引数はアクティビティフィードに流す文字列（40文字以内）
- 返り値はアクティビティフィードが流されたかどうか（true/false）
アクティビティフィードとは、ゲームのプレー内容を他のユーザーに公開する機能です。
公開されたフィードは、ゲームのプレー画面やマイページなどに表示されます。
具体的な動作
1. この関数を実行すると、アクティビティフィードを送信するかどうかをプレイヤーに確認するウィンドウが表示されます
2. プレイヤーが「はい」を選択すると、アクティビティフィードがサーバーに保存され、この関数はtrueを返します
（プレイヤーが「いいえ」を選択するとfalseを返します）
注意点
外部サイトやブログなどへの埋め込みの場合、この関数は常にfalseを返し、ウィンドウも表示されません。
テストプレー時には、ウィンドウがフィードを流すかどうか確認する選択肢が表示されます。
フィードを流すように選択しても、実際には流れません。
ゲストユーザーの場合は、この関数は常にfalseを返し、ウィンドウも表示されません。
saveGameData関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
（この関数で保存したデータは別のゲームから呼び出すことはできません。）
saveGameData("key", "value")
- 第1引数は後でデータを読み込む際にどのデータを取ってくるか指定する文字列(40文字以内)
- 第2引数は保存する文字列(500文字以内)
saveGameData, loadGameData, removeGameDataは
1秒間に1回以上の頻度で呼べません。
登録できるkey(にどのデータを取ってくるか指定する文字列)
とvalue(保存する文字列)のペアの数は100個までです。
この関数は、ログインしたプレイヤーのみ呼び出すことができます。
loadGameData関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
value = loadGameData("key")
- 第1引数はどのデーターを取得するか指定する文字列(40文字以内)
- 返り値は保存されている文字列
saveGameData, loadGameData, removeGameDataは
1秒間に1回以上の頻度で呼べません。
この関数は、ログインしたプレイヤーのみ呼び出すことができます。
removeGameData関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
removeGameData("key")
- 第1引数は削除対象のデータを指定する文字列(40文字以内)
- 返り値は削除できたかどうか
saveGameData, loadGameData, removeGameDataは
1秒間に1回以上の頻度で呼べません。
この関数は、ログインしたプレイヤーのみ呼び出すことができます。
isLogin関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | Yes |
if isLogin()
speak("ログインしています")
end
- 返り値はログインしているかどうか
お金・お店・宿屋関連
setSalePrice関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
setSalePrice(2, 100)
- 第１引数は店が買い取るアイテムのID
- 第２引数はそのアイテムを買う時の値段
開始スクリプトで
まとめて書いておくのがよいかと思います。
この値を設定しなかったアイテムは
店に売ることができません
setItemToShop関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
setItemToShop(2, 200)
- 第１引数は販売するアイテムのID
- 第２引数はアイテムの販売価格
この設定はrunShop関数、つまりお店の処理が走るたびに
クリアされるためrunShop関数を呼ぶ前に毎回設定する必要があります。
runShop関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
runShop()
引数返り値ともにありません。
setSalePrice関数とsetItemToShop関数で
設定された内容をもとにお店の処理をおこないます。
setItemToShop関数による設定は
このrunShop関数を呼ぶことでクリアされます。
あらたにrunShop関数を呼ぶ場合はその前にsetItemToShop関数で
販売するアイテムを記述してください。
addMoney関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
addMoney(1000)
- 第1引数は追加する金額
subMoney関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
subMoney(100)
- 第1引数は所持金を減らす金額
getMoney関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
money = getMoney()
- 返り値は所持金の金額
runInn関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
runInn(100)
- 第1引数はHPとMPを全快するために必要な金額
死んでいるキャラはそのままです。
setMoneyName関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
setMoneyName("お金")
- 第1引数は設定するお金の名前
この場合、お店の処理などを行ったときに
お金 (所持金)
というような表示がされます。
setDenomination関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
setDenomination("gold")
- 第１引数は表示されるお金の単位
getDenomination関数
| ゲームタイプ | 利用 |
|---|---|
| 2DアクションRPG | Yes |
| 2DRPG | Yes |
| ノベルゲーム | No |
getDenomination()
- 返り値は表示されるお金の単位