SRPG Studio スクリプト・リファレンス

root

CharacterDictionary

「世界観設定」における「キャラクター解説」の情報を管理します。

メソッド

データの名前を取得します。

{string} getName()

Returns

{string} データの名前


データの正式名を取得します。

{string} getFormalName()

Returns

{string} データの正式名


アイコンのリソースハンドルを取得します。

{ResourceHandle} getIconResourceHandle()

Returns

{ResourceHandle} リソースハンドル


テキストのページ数を取得します。

{number} getPageCount()

Returns

{number} ページ数


指定ページのテキストを取得します。

{string} getPageText(index)

Parameters

{number} index ページのインデックス

Returns

{string} テキスト


指定ページが閲覧可能である場合はtrue、そうでない場合はfalseを返します。

{boolean} isPageEnabled(index)

Parameters

{number} index ページのインデックス

Returns

{boolean} 真偽値


キャラクターイラストを取得します。

{Image} getCharIllustImage()

Returns

{Image} 画像


リソースハンドルを取得します。

{ResourceHandle} getResourceHandle()

Returns

{ResourceHandle} リソースハンドル


画像のオフセットx座標を取得します。

{number} getImageOffsetX()

Returns

{number} x座標


画像のオフセットy座標を取得します。

{number} getImageOffsetY()

Returns

{number} y座標


カスタムパラメータを取得します。

{object} custom()

Returns

{object} カスタムパラメータ


WordDictionary

「世界観設定」における「用語解説」の情報を管理します。

メソッド

データの名前を取得します。

{string} getName()

Returns

{string} データの名前


データの正式名を取得します。

{string} getFormalName()

Returns

{string} データの正式名


アイコンのリソースハンドルを取得します。

{ResourceHandle} getIconResourceHandle()

Returns

{ResourceHandle} リソースハンドル


テキストのページ数を取得します。

{number} getPageCount()

Returns

{number} ページ数


指定ページのテキストを取得します。

{string} getPageText(index)

Parameters

{number} index ページのインデックス

Returns

{string} テキスト


指定ページが閲覧可能である場合はtrue、そうでない場合はfalseを返します。

{boolean} isPageEnabled(index)

Parameters

{number} index ページのインデックス

Returns

{boolean} 真偽値


画像を取得します。

{Image} getPictureImage()

Returns

{Image} 画像


画像のオフセットx座標を取得します。

{number} getImageOffsetX()

Returns

{number} x座標


画像のオフセットy座標を取得します。

{number} getImageOffsetY()

Returns

{number} y座標


カスタムパラメータを取得します。

{object} custom()

Returns

{object} カスタムパラメータ


GraphicsDictionary

「世界観設定」における「ギャラリー」の情報を管理します。

メソッド

データの名前を取得します。

{string} getName()

Returns

{string} データの名前


データの説明文を取得します。

{string} getDescription()

Returns

{string} データの説明文


アイコンのリソースハンドルを取得します。

{ResourceHandle} getIconResourceHandle()

Returns

{ResourceHandle} リソースハンドル


画像のページ数を取得します。

{number} getPageCount()

Returns

{number} ページ数


画像を表すリソースハンドルを取得します。

{ResourceHandle} getGraphicsResourceHandle(index)

Parameters

{number} index ページのインデックス

Returns

{ResourceHandle} リソースハンドル


画像を表すタイプを取得します。

{number} getGraphicsType(index)

Parameters

{number} index ページのインデックス

Returns

{number} タイプ


指定ページが閲覧可能である場合はtrue、そうでない場合はfalseを返します。

{boolean} isPageEnabled(index)

Parameters

{number} index ページのインデックス

Returns

{boolean} 真偽値


サムネイルのリソースハンドルを取得します。

{ResourceHandle} getThumbnailResourceHandle()

Returns

{ResourceHandle} サムネイルのリソースハンドル


カスタムパラメータを取得します。

{object} custom()

Returns

{object} カスタムパラメータ


MediaDictionary

「世界観設定」における「サウンドルーム」の情報を管理します。

メソッド

データの名前を取得します。

{string} getName()

Returns

{string} データの名前


データの説明文を取得します。

{string} getDescription()

Returns

{string} データの説明文


アイコンのリソースハンドルを取得します。

{ResourceHandle} getIconResourceHandle()

Returns

{ResourceHandle} リソースハンドル


メディアのリソースハンドルを取得します。

{ResourceHandle} getMediaHandle()

Returns

{ResourceHandle} リソースハンドル


メディアのタイプを取得します。

{number} getMediaType()

Returns

{number} MediaType値


メディアが視聴可能である場合はtrue、そうでない場合はfalseを返します。

{boolean} isMediaEnabled()

Returns

{boolean} 真偽値


カスタムパラメータを取得します。

{object} custom()

Returns

{object} カスタムパラメータ


RestShop

拠点のショップ情報を管理します。

メソッド

このデータのIDを取得します。

{number} getId()

Returns

{number} ID


このデータの名前を取得します。

{string} getName()

Returns

{string} 名前


このデータの説明文を取得します。

{string} getDescription()

Returns

{string} 説明文


このデータのリソースハンドルを取得します。

{ResourceHandle} getIconResourceHandle()

Returns

{ResourceHandle} リソースハンドル


「ショップレイアウト」を取得します。

{ShopLayout} getShopLayout()

Returns

{ShopLayout} 「ショップレイアウト」


ショップアイテムの配列を取得します。

{object} getShopItemArray()

Returns

{object} 配列


アイテムの在庫の配列を取得します。

{object} getInventoryNumberArray()

Returns

{object} 配列


「必要ボーナス」を格納した配列を取得します。

{object} getBonusNumberArray()

Returns

{object} 配列


条件を満たしている場合はtrue、そうでない場合はfalseを返します。

{boolean} isShopDisplayable()

Returns

{boolean} 真偽値


カスタムパラメータを取得します。

{object} custom()

Returns

{object} カスタムパラメータ


RestQuest

「拠点」のクエスト情報を管理します。

メソッド

このデータのIDを取得します。

{number} getId()

Returns

{number} ID


このデータの名前を取得します。

{string} getName()

Returns

{string} 名前


このデータの説明文を取得します。

{string} getDescription()

Returns

{string} 説明文


このデータのリソースハンドルを取得します。

{ResourceHandle} getIconResourceHandle()

Returns

{ResourceHandle} リソースハンドル


攻略マップを取得します。

{Map} getFreeMap()

Returns

{Map} 攻略マップ


「攻略可能時イベント」を取得します。

{Event} getEnabledEvent()

Returns

{Event} 攻略可能時イベント


「攻略不可能時イベント」を取得します。

{Event} getDisabledEvent()

Returns

{Event} 攻略不可能時イベント


攻略可能でない場合にマップを隠す場合はtrue、そうでない場合はfalseを返します。

{boolean} isPrivateQuest()

Returns

{boolean} 真偽値


「報酬リスト」を取得します。

{DataList} getRewardList()

Returns

{DataList} 報酬リスト


「攻略条件」を満たす場合はtrue、そうでない場合はfalseを返します。

{boolean} isQuestAvailable()

Returns

{boolean} 真偽値


「表示条件」を満たす場合はtrue、そうでない場合はfalseを返します。

{boolean} isQuestDisplayable()

Returns

{boolean} 真偽値


カスタムパラメータを取得します。

{object} custom()

Returns

{object} カスタムパラメータ


RestArea

拠点の「エリア設定」を管理します。

メソッド

idを取得します。

{number} getId()

Returns

{number} id


エリア名を取得します。

{string} getAreaName()

Returns

{string} エリア名


背景を取得します。

{Image} getBackgroundImage()

Returns

{Image} 背景


音楽のリソースハンドルを取得します。

{ResourceHandle} getMusicHandle()

Returns

{ResourceHandle} 音楽のリソースハンドル


表示条件を満たす場合はtrue、そうでない場合はfalseを返します。

{boolean} isAreaDisplayable()

Returns

{boolean} 真偽値


カスタムパラメータを取得します。

{object} custom()

Returns

{object} カスタムパラメータ


InteropTextUI

見出し画像やメニューウインドウにおけるテキスト情報を管理します。

メソッド

フォントを取得します。

{Font} getFont()

Returns

{Font} フォント


色を取得します。

{number} getColor()

Returns

{number} 色


UI画像を取得します。

{Image} getUIImage()

Returns

{Image} UI画像


InteropScreen

画面情報を管理します。

メソッド

スクリーンのタイトルを取得します。

{string} getScreenTitleName()

Returns

{string} タイトル


スクリーンの内部名を取得します。

{string} getScreenInternalName()

Returns

{string} 内部名


スクリーンの背景画像を取得します。

{Image} getScreenBackgroundImage()

Returns

{Image} 背景画像


スクリーンの音楽のリソースハンドルを取得します。

{ResourceHandle} getScreenMusicHandle()

Returns

{ResourceHandle} リソースハンドル


上フレームのTextUI情報を取得します。

{InteropTextUI} getTopFrameTextUI()

Returns

{InteropTextUI} TextUI


下フレームのTextUI情報を取得します。

{InteropTextUI} getBottomFrameTextUI()

Returns

{InteropTextUI} TextUI


ShopLayout

ショップ画面を構成するデータを管理します。

メソッド

このデータのIDを取得します。

{number} getId()

Returns

{number} ID


コマンド表示での文字列を取得します。

{string} getCommandName()

Returns

{string} 文字列


店主の顔を示すリソースハンドルを取得します。

{ResourceHandle} getFaceResourceHandle()

Returns

{ResourceHandle} リソースハンドル


画面オブジェクトを取得します。

{InteropScreen} getShopInteropData()

Returns

{InteropScreen} 画面オブジェクト


ショップ内での会話メッセージを取得します。

{string} getMessage(index)

Parameters

{number} index インデックス

Returns

{string} メッセージ


MessageLayout

メッセージのUIを構成するデータを管理します。

メソッド

ウインドウのx座標を取得します。

{number} getWindowX()

Returns

{number} x座標


ウインドウのy座標を取得します。

{number} getWindowY()

Returns

{number} y座標


テキストのx座標を取得します。

{number} getTextX()

Returns

{number} x座標


テキストのy座標を取得します。

{number} getTextY()

Returns

{number} y座標


名前のx座標を取得します。

{number} getNameX()

Returns

{number} x座標


名前のy座標を取得します。

{number} getNameY()

Returns

{number} y座標


カーソルのx座標を取得します。

{number} getCursorX()

Returns

{number} x座標


カーソルのy座標を取得します。

{number} getCursorY()

Returns

{number} y座標


「顔画像」のx座標を取得します。

{number} getFaceX()

Returns

{number} x座標


「顔画像」のy座標を取得します。

{number} getFaceY()

Returns

{number} y座標


「立ち絵画像」のx座標を取得します。

{number} getCharIllustX()

Returns

{number} x座標


「立ち絵画像」のy座標を取得します。

{number} getCharIllustY()

Returns

{number} y座標


「顔画像」の表示形式を取得します。

{number} getFaceVisualType()

Returns

{number} FaceVisualType値


「顔画像」を反転する場合はtrue、そうでない場合はfalseを返します。

{boolean} isFaceReverse()

Returns

{boolean} 真偽値


「顔画像」が表情を考慮する場合はtrue、そうでない場合はfalseを返します。

{boolean} isFacialExpressionEnabled()

Returns

{boolean} 真偽値


立ち絵の表示形式を取得します。

{number} getCharIllustVisualType()

Returns

{number} CharIllustVisualType値


「立ち絵画像」を反転する場合はtrue、そうでない場合はfalseを返します。

{boolean} isCharIllustReverse()

Returns

{boolean} 真偽値


「立ち絵画像」が表情を考慮する場合はtrue、そうでない場合はfalseを返します。

{boolean} isCharIllustFacialExpressionEnabled()

Returns

{boolean} 真偽値


メッセージウインドウに対するTextUI情報を取得します。

{InteropTextUI} getWindowTextUI()

Returns

{InteropTextUI} TextUI


名前見出しに対するTextUI情報を取得します。

{InteropTextUI} getNameTextUI()

Returns

{InteropTextUI} TextUI


ページカーソルの画像を取得します。

{Image} getPageCursorUI()

Returns

{Image} Image


改ページ音を取得します。

{ResourceHandle} getPageSoundHandle()

Returns

{ResourceHandle} リソースハンドル


ボイス音を取得します。

{ResourceHandle} getVoiceSoundHandle()

Returns

{ResourceHandle} リソースハンドル


CommandLayout

コマンドを構成するデータを管理します。

メソッド

コマンドの名前を取得します。

{string} getName()

Returns

{string} 文字列


コマンドのカテゴリを取得します。

{number} getCommandLayoutType()

Returns

{number} CommandLayoutType値


コマンドの操作内容を取得します。

{number} getCommandActionType()

Returns

{number} CommandActionType値


コマンドの表示形式を取得します。

{number} getCommandVisibleType()

Returns

{number} CommandVisibleType値


設定されたグローバルスイッチがオンの場合はtrue、そうでない場合はfalseを返します。

{boolean} isGlobalSwitchOn()

Returns

{boolean} 真偽値