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

root

CommandMessageShow

イベントコマンドの「メッセージの表示」に関する情報を管理します。

メソッド

描画テキストを取得します。

{string} getText()

Returns

{string} 描画テキスト


テキストを描画する位置を示す値を取得します。

{number} getTextPosValue()

Returns

{number} MessagePos値


メッセージを出す対象を示す値を取得します。

{number} getSpeakerType()

Returns

{number} SpeakerType値


対象ユニットを取得します。

{Unit} getUnit()

Returns

{Unit} 対象ユニット


対象NPCを取得します。

{Npc} getNpc()

Returns

{Npc} 対象NPC


顔画像の表情IDを取得します。

{number} getFacialExpressionId()

Returns

{number} 表情ID


CommandMessageTerop

イベントコマンドの「メッセージテロップ」に関する情報を管理します。

メソッド

描画テキストを取得します。

{string} getText()

Returns

{string} 描画テキスト


テキストを描画する位置を表す値を取得します。

{number} getTextPosValue()

Returns

{number} MessagePos値


ウインドウを表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isTeropWindowDisplayable()

Returns

{boolean} 真偽値


メッセージを出す対象を示す値を取得します。

{number} getSpeakerType()

Returns

{number} SpeakerType値


対象ユニットを取得します。

{Unit} getUnit()

Returns

{Unit} 対象ユニット


対象NPCを取得します。

{Npc} getNpc()

Returns

{Npc} 対象NPC


顔画像の表情IDを取得します。

{number} getFacialExpressionId()

Returns

{number} 表情ID


CommandStillMessage

イベントコマンドの「スチルメッセージ」に関する情報を管理します。

メソッド

描画テキストを取得します。

{string} getText()

Returns

{string} 描画テキスト


メッセージを出す対象を示す値を取得します。

{number} getSpeakerType()

Returns

{number} SpeakerType値


対象ユニットを取得します。

{Unit} getUnit()

Returns

{Unit} 対象ユニット


対象NPCを取得します。

{Npc} getNpc()

Returns

{Npc} 対象NPCユニット


顔画像の表情IDを取得します。

{number} getFacialExpressionId()

Returns

{number} 表情ID


CommandMessageScroll

イベントコマンドの「メッセージスクロール」に関する情報を管理します。

メソッド

描画テキストを取得します。

{string} getText()

Returns

{string} 描画テキスト


描画範囲のx座標を取得します。

{number} getX()

Returns

{number} 描画範囲のx座標


中央に描画する場合はtrue、そうでない場合はfalseを返します。

{boolean} isCenterShow()

Returns

{boolean} 真偽値


描画速度を取得します。

{number} getSpeedType()

Returns

{number} SpeedType値


スタッフロールとして扱う場合はtrue、そうでない場合はfalseを返します。

{boolean} isStaffRoll()

Returns

{boolean} 真偽値


CommandMessageTitle

イベントコマンドの「メッセージタイトル」に関する情報を管理します。

メソッド

描画テキストを取得します。

{string} getText()

Returns

{string} 描画テキスト


描画位置のx座標を取得します。

{number} getX()

Returns

{number} x座標


描画位置のy座標を取得します。

{number} getY()

Returns

{number} y座標


中央に描画する場合はtrue、そうでない場合はfalseを返します。

{boolean} isCenterShow()

Returns

{boolean} 真偽値


特定の背景を対象にする場合はtrue、そうでない場合はfalseを返します。

{boolean} isBackTarget()

Returns

{boolean} 真偽値


CommandInfoWindow

イベントコマンドの「情報ウインドウ」に関する情報を管理します。

メソッド

描画テキストを取得します。

{string} getMessage()

Returns

{string} 描画テキスト


情報の種類を表す値を取得します。

{number} getInfoType()

Returns

{number} 情報の種類を表す値


表示位置のx座標を取得します。

{number} getX()

Returns

{number} x座標


表示位置のy座標を取得します。

{number} getY()

Returns

{number} y座標


中央に表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isCenterShow()

Returns

{boolean} 真偽値


特定の背景を対象にする場合はtrue、そうでない場合はfalseを返します。

{boolean} isBackTarget()

Returns

{boolean} 真偽値


CommandChoiceShow

イベントコマンドの「選択肢の表示」に関する情報を管理します。

メソッド

選択肢の数を取得します。

{number} getChoiceCount()

Returns

{number} 選択肢の数


選択肢の内容を表わす文字列を取得します。

{string} getMessage(index)

Parameters

{number} index 選択肢のインデックス

Returns

{string} 対象文字列


選択肢に関連するセルフスイッチのIDを取得します。

{number} getSelfSwitchId(index)

Parameters

{number} index 選択肢のインデックス

Returns

{number} セルフスイッチのID


選択肢に関連するアイコンのリソースハンドルを取得します。

{ResourceHandle} getIconResourceHandle(index)

Parameters

{number} index 選択肢のインデックス

Returns

{ResourceHandle} リソースハンドル


選択肢が表示条件を満たしている場合はtrue、そうでない場合はfalseを返します。

{boolean} isChoiceDisplayable(index)

Parameters

{number} index 選択肢のインデックス

Returns

{boolean} 真偽値


2列で表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isTwoLines()

Returns

{boolean} 真偽値


CommandBackgroundChange

イベントコマンドの「背景画像の変更」に関する情報を管理します。

メソッド

変更するか変更しないかを表す値を取得します。

{number} getBackgroundChangeType()

Returns

{number} BackgroundChangeType値


トランジションの種類を表す値を取得します。

{number} getBackgroundTransitionType()

Returns

{number} BackgroundTransitionType値


CommandScriptExecute

イベントコマンドの「スクリプトの実行」に関する情報を管理します。

メソッド

イベントコマンド呼び出しにおけるオブジェクト名を取得します。

{string} getEventCommandName()

Returns

{string} オブジェクト名


イベントコマンドに渡す引数を表すオブジェクトを取得します。

{object} getEventCommandArgument()

Returns

{object} 引数を表すオブジェクト


オリジナルコンテンツを表すオブジェクトを取得します。

{OriginalContent} getOriginalContent()

Returns

{OriginalContent} オリジナルコンテンツ


CommandSaveCall

イベントコマンドの「セーブ画面呼び出し」に関する情報を管理します。

メソッド

種類を取得します。

{number} getSaveCallType()

Returns

{number} SaveCallType値


エンディングでセーブを実行する場合は、このメソッドを呼び出します。

setCompleteSaveFlag()

CommandGoldChange

イベントコマンドの「ゴールドの増減」に関する情報を管理します。

メソッド

増減させるゴールド値を取得します。

{number} getGold()

Returns

{number} 増減させるゴールド値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandItemChange

イベントコマンドの「アイテムの増減」に関する情報を管理します。

メソッド

対象ユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} 対象ユニット


対象アイテムを取得します。

{Item} getTargetItem()

Returns

{Item} 対象アイテム


増減の種類を表す値を取得します。

{number} getIncreaseValue()

Returns

{number} IncreaseType値


ストックが対象である場合はtrue、そうでない場合はfalseを返します。

{boolean} isStockChange()

Returns

{boolean} 真偽値


アイテム解除時にストックへ送る場合はtrue、そうでない場合はfalseを返します。

{boolean} isStockSend()

Returns

{boolean} 真偽値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandParameterChange

イベントコマンドの「パラメータの増減」に関する情報を管理します。

メソッド

対象ユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} 対象ユニット


パラメータ情報を取得します。

{Parameter} getDopingParameter()

Returns

{Parameter} パラメータ


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandSkillChange

イベントコマンドの「スキルの増減」に関する情報を管理します。

メソッド

スキルを増減させるユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} 対象ユニット


増減対象のスキルを取得します。

{Skill} getTargetSkill()

Returns

{Skill} 対象スキル


スキルに対する操作値を取得します。

{number} getIncreaseValue()

Returns

{number} IncreaseType値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandHpRecovey

イベントコマンドの「HPの回復」に関する情報を管理します。

メソッド

対象ユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} 対象ユニット


回復のアニメを取得します。

{Anime} getRecoveryAnime()

Returns

{Anime} アニメ


回復値を取得します。

{number} getRecoveryValue()

Returns

{number} 回復値


回復の仕方を表す値を取得します。

{number} getRecoveryType()

Returns

{number} RecoveryType値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandDamageHit

イベントコマンドの「ダメージを与える」に関する情報を管理します。

メソッド

ダメージを与えるユニットを取得します。

{Unit} getLaunchUnit()

Returns

{Unit} ダメージを与えるユニット


ダメージを受けるユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} ダメージを受けるユニット


ダメージのアニメを取得します。

{Anime} getDamageAnime()

Returns

{Anime} アニメ


ダメージ値を取得します。

{number} getDamageValue()

Returns

{number} ダメージ値


ダメージの与え方を表す値を取得します。

{number} getDamageType()

Returns

{number} DamageType値


命中率を取得します。

{number} getHit()

Returns

{number} 命中率


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandExperiencePlus

イベントコマンドの「経験値を与える」に関する情報を管理します。

メソッド

対象ユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} 対象ユニット


経験値を取得します。

{number} getExperienceValue()

Returns

{number} 経験値


経験値のタイプを取得します。

{number} getExperiencePlusType()

Returns

{number} ExperiencePlusType値


画像を表示する場合はtrue、そうでない場合はfalseを返します。種類がレベルアップの場合は、常にfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandClassChange

イベントコマンドの「クラスチェンジ」に関する情報を管理します。

メソッド

対象ユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} 対象ユニット


対象クラスを取得します。

{Class} getTargetClass()

Returns

{Class} 対象クラス


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandItemUse

イベントコマンドの「アイテムの使用」に関する情報を管理します。

メソッド

アイテムを使用するユニットを取得します。

{Unit} getUseUnit()

Returns

{Unit} アイテムを使用するユニット


使用するアイテムを取得します。

{Item} getUseItem()

Returns

{Item} 使用するアイテム


使用されるユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} 使用されるユニット


アイテムを使用するx座標を取得します。

{number} getTargetX()

Returns

{number} x座標


アイテムを使用するy座標を取得します。

{number} getTargetY()

Returns

{number} y座標


使用されるアイテムを取得します。

{Item} getTargetItem()

Returns

{Item} 使用されるアイテム


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandForceBattle

イベントコマンドの「強制戦闘」に関する情報を管理します。

メソッド

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

{Unit} getForceSrc()

Returns

{Unit} 「攻撃をする側」のユニット


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

{Unit} getForceDest()

Returns

{Unit} 「攻撃をされる側」のユニット


「戦闘形式」を取得します。

{number} getBattleType()

Returns

{number} BattleType値


攻撃を仕掛ける側のエントリ値を取得します。

{number} getSrcForceEntryType(index)

Parameters

{number} index エントリ値のインデックス

Returns

{number} エントリ値


攻撃を受ける側のエントリ値を取得します。

{number} getDestForceEntryType(index)

Parameters

{number} index エントリ値のインデックス

Returns

{number} エントリ値


経験値を考慮する場合はtrue、そうでない場合はfalseを返します。

{boolean} isExperienceEnabled()

Returns

{boolean} 真偽値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandChapterShow

イベントコマンドの「チャプターの表示」に関する情報を管理します。

メソッド

チャプター名を取得します。

{string} getChapterName()

Returns

{string} チャプター名


マップ名を取得します。

{string} getMapName()

Returns

{string} マップ名


マップ情報のデータを参照する場合はtrue、そうでない場合はfalseを返します。

{boolean} isMapInfoRef()

Returns

{boolean} 真偽値


CommandLocationFocus

イベントコマンドの「場所注目」に関する情報を管理します。

メソッド

表示位置のx座標を取得します。

{number} getX()

Returns

{number} x座標


表示位置のy座標を取得します。

{number} getY()

Returns

{number} y座標


焦点を合わせるユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} 焦点を合わせるユニット


ユニットではなく(x, y)を優先する場合はtrue、そうでない場合はfalseを返します。

{boolean} isPosBase()

Returns

{boolean} 真偽値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandBonusChange

イベントコマンドの「ボーナスの増減」に関する情報を管理します。

メソッド

増減させるボーナス値を取得します。

{number} getBonus()

Returns

{number} 増減させるボーナス値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandTrophyChange

イベントコマンドの「トロフィーの増減」に関する情報を管理します。

メソッド

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

{Trophy} getTrophy()

Returns

{Trophy} トロフィー


対象ユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} ユニット


トロフィーの取得がクリア後か、あるいはドロップになるかなどを表す値を返します。

{number} getTrophyTargetType()

Returns

{number} TrophyTargetType値


増減の種類を表す値を取得します。

{number} getIncreaseValue()

Returns

{number} IncreaseType値


CommandDurabilityChange

イベントコマンドの「アイテムの耐久変更」に関する情報を管理します。

メソッド

対象ユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} ユニット


対象アイテムを取得します。

{Item} getTargetItem()

Returns

{Item} アイテム


耐久値を取得します。

{number} getDurability()

Returns

{number} 耐久値


増減の種類を表す値を取得します。

{number} getIncreaseValue()

Returns

{number} IncreaseType値


ストックが対象である場合はtrue、そうでない場合はfalseを返します。

{boolean} isStockChange()

Returns

{boolean} 真偽値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandUnitStateAddition

イベントコマンドの「ユニットのステート付加」に関する情報を管理します。

メソッド

ステートを与えるユニットを取得します。

{Unit} getLaunchUnit()

Returns

{Unit} ユニット


ステートを受けるユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} ユニット


ステート発動オブジェクトを取得します。

{StateInvocation} getStateInvocation()

Returns

{StateInvocation} ステート発動オブジェクト


増減の種類を表す値を取得します。

{number} getIncreaseValue()

Returns

{number} IncreaseType値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandUnitSlide

イベントコマンドの「ユニットのスライド」に関する情報を管理します。

メソッド

対象ユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} ユニット


方向を取得します。

{number} getDirectionType()

Returns

{number} DirectionType値


ピクセル数を示すインデックスを取得します。

{number} getPixelIndex()

Returns

{number} インデックス


スライドの種類を取得します。

{number} getSlideType()

Returns

{number} SlideType値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandUnitFusion

イベントコマンドの「ユニットのフュージョン」に関する情報を管理します。

メソッド

対象ユニットを取得します。

{Unit} getUnit()

Returns

{Unit} ユニット


キャッチするユニット、またはトレードするユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} ユニット


キャッチする際に使用するフュージョンを取得します。

{Fusion} getFusionData()

Returns

{Fusion} フュージョン


リリースする際の方向を取得します。

{number} getDirectionType()

Returns

{number} DirectionType値


フュージョンの種類を取得します。

{number} getFusionActionType()

Returns

{number} FusionActionType値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandUnitMetamorphoze

イベントコマンドの「ユニットの形態変化」に関する情報を管理します。

メソッド

対象ユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} ユニット


「形態変化」データを取得します。

{Metamorphoze} getMetamorphozeData()

Returns

{Metamorphoze} 「形態変化」データ


「形態変化」の種類を取得します。

{number} getMetamorphozeActionType()

Returns

{number} MetamorphozeActionType値


画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGraphicsSkip()

Returns

{boolean} 真偽値


CommandUnitAllCommand

イベントコマンドの「ユニットの全体処理」に関する情報を管理します。

メソッド

フィルタを取得します。

{number} getFilterFlag()

Returns

{number} UnitFilterFlag値


アニメを取得します。

{Anime} getAnime()

Returns

{Anime} アニメ


アニメの再生方法を取得します。

{number} getAnimePlayType()

Returns

{number} AnimePlayType値


ユニットが有効相手である場合はtrue、そうでない場合はfalseを返します。

{boolean} isDataCondition(unit)

Parameters

{Unit} unit ユニット

Returns

{boolean} 真偽値


実行するイベントコマンドを取得します。

{object} getSubEventCommandObject()

Returns

{object} イベントコマンド


実行するイベントコマンドの種類を取得します。

{number} getSubEventCommandType()

Returns

{number} EventCommandType値


CommandMapPosChoose

イベントコマンドの「マップ座標の抽出」に関する情報を管理します。

メソッド

x座標を取得します。

{number} getX()

Returns

{number} x座標


y座標を取得します。

{number} getY()

Returns

{number} y座標


ユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} ユニット


ユニットではなく(x, y)を優先する場合はtrue、そうでない場合はfalseを返します。

{boolean} isPosBase()

Returns

{boolean} 真偽値


範囲の種類を取得します。

{number} getRangeType()

Returns

{number} RangeType値


射程を取得します。

{number} getRangeValue()

Returns

{number} 射程


フィルタを取得します。

{number} getFilterFlag()

Returns

{number} フィルタ


ユニットのみ選択可能な場合はtrue、そうでない場合はfalseを返します。

{boolean} isUnitOnlyMode()

Returns

{boolean} 真偽値


ユニットの選択条件を満たす場合はtrue、そうでない場合はfalseを返します。

{boolean} isDataCondition(unit)

Parameters

{Unit} unit ユニット

Returns

{boolean} 真偽値


位置選択時の種類を取得します。

{number} getPosChooseType()

Returns

{number} PosChooseType値


ベースユニットを取得します。

{Unit} getBaseUnit()

Returns

{Unit} ベースユニット


変数にx座標を設定します。

setXToVariable(x)

Parameters

{number} x x座標


変数にy座標を設定します。

setYToVariable(y)

Parameters

{number} y y座標


変数にユニットIDを設定します。

setUnitIdToVariable(unitId)

Parameters

{number} unitId ユニットID


キャンセルを許可しない場合はtrue、そうでない場合はfalseを返します。

{boolean} isCancelDisabled()

Returns

{boolean} 真偽値


セルフスイッチを取得します。

{number} getSelfSwitchId()

Returns

{number} セルフスイッチ


ユニットウインドウを表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isWindowDisplayable()

Returns

{boolean} 真偽値


選択時にメッセージを表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isQuestionDisplayable()

Returns

{boolean} 真偽値


CommandMapPosOperation

イベントコマンドの「マップ座標の操作」に関する情報を管理します。

メソッド

x座標を取得します。

{number} getX()

Returns

{number} x座標


y座標を取得します。

{number} getY()

Returns

{number} y座標


ユニットを取得します。

{Unit} getTargetUnit()

Returns

{Unit} ユニット


ユニットではなく(x, y)を優先する場合はtrue、そうでない場合はfalseを返します。

{boolean} isPosBase()

Returns

{boolean} 真偽値


操作の種類を取得します。

{number} getMapPosOperationType()

Returns

{number} MapPosOperationType値


アニメを取得します。

{Anime} getMapAnime()

Returns

{Anime} アニメ


マップチップのリソースハンドルを取得します。

{ResourceHandle} getMapChipGraphicsHandle()

Returns

{ResourceHandle} リソースハンドル