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

root

Event

イベントに関する情報を管理します。

メソッド

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

{number} getId()

Returns

{number} ID


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

{string} getName()

Returns

{string} 名前


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

{string} getDescription()

Returns

{string} 説明文


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

{ResourceHandle} getIconResourceHandle()

Returns

{ResourceHandle} アイコンリソースハンドル


イベントの種類を取得します。

{number} getEventType()

Returns

{number} EventType値


実行済みを示す値を取得します。

{number} getExecutedMark()

Returns

{number} EventExecutedType値


実行済みを示す値を設定します。

setExecutedMark(mark)

Parameters

{number} mark EventExecutedType値


イベントが実行条件を満たしている場合はtrue、そうでない場合はfalseを返します。

{boolean} isEvent()

Returns

{boolean} 真偽値


イベントを実行します。戦闘時のユニットイベントを実行する場合は、startBattleEventを呼び出します。

startEvent()

「戦闘時」ユニットイベントが実行条件を満たしている場合はtrue、そうでない場合はfalseを返します。

{boolean} isBattleEvent(unit)

Parameters

{Unit} unit ユニット

Returns

{boolean} 真偽値


「戦闘時」のユニットイベントを実行します。

startBattleEvent(unit)

Parameters

{Unit} unit ユニット


イベントに関連付けられた「回想イベント」を取得します。

{Event} getAssociateRecollectionEvent()

Returns

{Event} 「回想イベント」


「場所イベント」に関する情報を取得します。

{PlaceEventInfo} getPlaceEventInfo()

Returns

{PlaceEventInfo} 「場所イベント」に関する情報


「会話イベント」に関する情報を取得します。

{TalkEventInfo} getTalkEventInfo()

Returns

{TalkEventInfo} 「会話イベント」に関する情報


「コミュニケーションイベント」に関する情報を取得します。

{CommunicationEventInfo} getCommunicationEventInfo()

Returns

{CommunicationEventInfo} 「コミュニケーションイベント」に関する情報


「回想イベント」に関する情報を取得します。

{RecollectionEventInfo} getRecollectionEventInfo()

Returns

{RecollectionEventInfo} 「回想イベント」に関する情報


「ユニットイベント」に関する情報を取得します。

{UnitEventInfo} getUnitEventInfo()

Returns

{UnitEventInfo} 「ユニットイベント」に関する情報


「マップ共有イベント」に関する情報を取得します。

{CommonEventInfo} getCommonEventInfo()

Returns

{CommonEventInfo} 「マップ共有イベント」に関する情報


「拠点イベント」に関する情報を取得します。

{RestEventInfo} getRestEventInfo()

Returns

{RestEventInfo} 「拠点イベント」に関する情報


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

{object} custom()

Returns

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


PlaceEventInfo

「場所イベント」に関する情報を管理します。

メソッド

イベントのx座標を取得します。

{number} getX()

Returns

{number} x座標


イベントのy座標を取得します。

{number} getY()

Returns

{number} y座標


「場所イベント」の種類を取得します。

{number} getPlaceEventType()

Returns

{number} PlaceEventType値


トロフィーを取得します。

{Trophy} getTrophy()

Returns

{Trophy} トロフィー


カスタムの「キーワード」を取得します。

{string} getCustomKeyword()

Returns

{string} 「キーワード」


カスタムの「文字列」を取得します。

{string} getCommandText()

Returns

{string} 「文字列」


カスタムイベントの種類を取得します。

{number} getPlaceCustomType()

Returns

{number} PlaceCustomType値


ショップデータを取得します。

{ShopData} getShopData()

Returns

{ShopData} ショップデータ


マップチップを変更します。

startMapChipChange()

TalkEventInfo

「会話イベント」に関する情報を管理します。

メソッド

「会話する側」のユニットを取得します。

{Unit} getSrcUnit()

Returns

{Unit} 「会話する側」のユニット


「会話される側」のユニットを取得します。

{Unit} getDestUnit()

Returns

{Unit} 「会話される側」のユニット


どちらからでも会話可能な場合はtrue、そうでない場合はfalseを返します。

{boolean} isMutual()

Returns

{boolean} 真偽値


話しかけるユニットがアクティブである場合はtrue、そうでない場合はfalseを返します。

{boolean} isSrcActive()

Returns

{boolean} 真偽値


コマンドのテキストを取得します。

{string} getCommandText()

Returns

{string} テキスト


CommunicationEventInfo

「コミュニケーションイベント」に関する情報を管理します。

メソッド

コミュニケーションの種類を取得します。

{number} getCommunicationEventType()

Returns

{number} CommunicationType値


RecollectionEventInfo

回想イベントに関する情報を管理します。

メソッド

1番目の「関連ユニット」を取得します。

{Unit} getFirstUnit()

Returns

{Unit} ユニット1


2番目の「関連ユニット」を取得します。

{Unit} getSecondUnit()

Returns

{Unit} ユニット2


ランクを取得します。

{number} getRank()

Returns

{number} ランク


「ランダム背景」の場合はtrue、そうでない場合はfalseを返します。

{boolean} isRandomBackground()

Returns

{boolean} 真偽値


エクストラ画面で表示可能な場合はtrue、そうでない場合はfalseを返します。

{boolean} isExtraDisplayable()

Returns

{boolean} 真偽値


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

{ResourceHandle} getThumbnailResourceHandle()

Returns

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


UnitEventInfo

「ユニットイベント」に関する情報を管理します。

メソッド

「ユニットイベント」の種類を取得します。

{number} getUnitEventType()

Returns

{number} UnitEventType値


戦闘相手になるユニットを取得します。

{Unit} getBattleUnit()

Returns

{Unit} ユニット


コマンド時に表示する文字列を取得します。

{string} getCommandText()

Returns

{string} 文字列


CommonEventInfo

コミュニケーションイベントに関する情報を管理します。

メソッド

イベントの種類を取得します

{number} getEventType()

Returns

{number} EventType値


実行順序が前の場合はtrue、そうでない場合はfalseを返します。

{boolean} isFirst()

Returns

{boolean} 真偽値


RestEventInfo

「拠点イベント」に関する情報を管理します。

メソッド

「自動開始イベント」の種類を取得します

{number} getRestAutoType()

Returns

{number} RestAutoType値


コミュニケーションの種類を取得します。

{number} getCommunicationEventType()

Returns

{number} CommunicationType値


会話選択時の画像を取得します。

{Image} getTalkImage()

Returns

{Image} 画像


会話選択時の画像の表示位置を取得します

{number} getPos()

Returns

{number} MessagePos値