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

root

ObjectGenerator

オブジェクトを動的に作成できるオブジェクトです。

メソッド

イベントユニットを実際に作成します。たとえば、mapData.getListFromUnitGroup(UnitGroup.ENEMYEVENT)から取得したユニットを指定した場合は、gameSession.getEnemyListで返されるリストに新しいユニットが含まれます。

{Unit} generateUnitFromBaseUnit(baseUnit)

Parameters

{Unit} baseUnit ベースユニット

Returns

{Unit} 作成されたユニット


ブックマークユニットを特定の種類のユニットとして作成します。

{Unit} generateUnitFromBookmarkUnit(baseUnit, raceType)

Parameters

{Unit} baseUnit ベースユニット

{number} raceType UnitType値

Returns

{Unit} 作成されたユニット


援軍のページ情報からユニットを作成します。

{Unit} generateUnitFromRefinforcementPage(page)

Parameters

{ReinforcementPage} page ページデータ

Returns

{Unit} 作成されたユニット


EventGenerator

イベントコマンドを動的に実行できるオブジェクトです。

メソッド

ユニットをベースに、イベントコマンドの「メッセージの表示」を実行できるように設定します。

messageShowUnit(message, pos, unit)

Parameters

{string} message 対象テキスト

{number} pos 表示位置を表すMessagePos値

{Unit} unit 対象ユニット


NPCをベースに、イベントコマンドの「メッセージの表示」を実行できるように設定します。

messageShowNpc(message, pos, npc)

Parameters

{string} message 対象テキスト

{number} pos 表示位置を表すMessagePos値

{Npc} npc 対象NPC


イベントコマンドの「メッセージの消去」を実行できるように設定します。

messageErase(isTop, isCenter, isBottom)

Parameters

{boolean} isTop 上部を消去する場合はtrue、そうでない場合はfalse

{boolean} isCenter 中央部を消去する場合はtrue、そうでない場合はfalse

{boolean} isBottom 下部を消去する場合はtrue、そうでない場合はfalse


イベントコマンドの「メッセージテロップ」を実行できるように設定します。

messageTerop(message, pos, isWindowShow)

Parameters

{string} message 対象テキスト

{number} pos 表示位置を表すMessagePos値

{boolean} isWindowShow 文字を中央に寄せる場合はtrue、そうでない場合はfalse


ユニットをベースに、イベントコマンドの「スチルメッセージ」を実行できるように設定します。

stillMessageUnit(message, unit)

Parameters

{string} message 対象テキスト

{Unit} unit 対象ユニット


NPCをベースに、イベントコマンドの「スチルメッセージ」を実行できるように設定します。

stillMessageNpc(message, npc)

Parameters

{string} message 対象テキスト

{Npc} npc 対象ユニット


イベントコマンドの「メッセージスクロール」を実行できるように設定します。

messageScroll(message, x, speed, isStaffRoll, isCenterShow)

Parameters

{string} message 対象テキスト

{number} x x座標

{number} speed 速度を表すSpeedType値

{boolean} isStaffRoll スタッフロールとして扱う場合はtrue、そうでない場合はfalse

{boolean} isCenterShow 中央に表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「メッセージタイトル」を実行できるように設定します。

messageTitle(message, x, y, isCenterShow)

Parameters

{string} message 対象テキスト

{number} x x座標

{number} y y座標

{boolean} isCenterShow 中央に表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「情報ウインドウ」を実行できるように設定します。

infoWindow(message, infoType, x, y, isCenterShow)

Parameters

{string} message 対象テキスト

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

{number} x x座標

{number} y y座標

{boolean} isCenterShow 中央に表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「画面スクロール」を実行できるように設定します。

screenScroll(x, y, speedType, isWait)

Parameters

{number} x 目標のx座標

{number} y 目標のy座標

{number} speedType 速度を表すSpeedType値

{boolean} isWait 処理が完了するまで待機する場合はtrue、そうでない場合はfalse


イベントコマンドの「画面効果」を実行できるように設定します。

screenEffect(isChange, color, alpha, speed, effectType, isWait)

Parameters

{boolean} isChange 色を変更する場合はtrue、そうでない場合はfalse

{number} color 色の値

{number} alpha 色の透明度

{number} speed 速度を表すSpeedType値

{number} effectType 色変更の範囲を表すEffectRangeType値

{boolean} isWait 処理が完了するまで待機する場合はtrue、そうでない場合はfalse


イベントコマンドの「背景画像の変更」を実行できるように設定します。

backgroundChange(backgroundChangeType, handle, graphicsType, backgroundTransitiontype)

Parameters

{number} backgroundChangeType 変更の種類を表すBackgroundChangeType値

{ResourceHandle} handle 背景画像のリソースハンドル

{number} graphicsType 画像の種類を表すGraphicsType値

{number} backgroundTransitiontype トランジションを表すBackgroundTransitionType


イベントコマンドの「音楽の再生」を実行できるように設定します。

musicPlay(handle, musicPlayType)

Parameters

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

{number} musicPlayType 再生の種類を表すMusicPlayType値


イベントコマンドの「音楽の停止」を実行できるように設定します。

musicStop(type, speedType)

Parameters

{number} type 停止形式を表すMusicStopType値

{number} speedType 速度を表すSpeedType値


イベントコマンドの「効果音の再生」を実行できるように設定します。

soundPlay(handle, id)

Parameters

{ResourceHandle} handle 効果音のリソースハンドル

{number} id 割り当てるID


イベントコマンドの「音楽の停止」を実行できるように設定します。

soundStop(id, isAllStop)

Parameters

{number} id 停止する効果音のID

{boolean} isAllStop 全ての効果音を停止する場合はtrue、そうでない場合はfalse


イベントコマンドの「アニメーションの再生」を実行できるように設定します。

animationPlay(anime, x, y, isCenterShow, option, id)

Parameters

{Anime} anime アニメ

{number} x 表示先となるx座標

{number} y 表示先となるy座標

{boolean} isCenterShow 中央に表示する場合はtrue、そうでない場合はfalse

{number} option AnimePlayType値

{number} id アニメを識別するために設定するID


イベントコマンドの「アニメーションの停止」を実行できるように設定します。

animationStop(id, isAllStop)

Parameters

{number} id 割り当てるID

{boolean} isAllStop 全て停止にする場合はtrue、そうでない場合はfalse


イベントコマンドの「シーンの変更」を実行できるように設定します。

sceneChange(type)

Parameters

{number} type シーンの種類を表すSceneType値


イベントコマンドの「ウェイト」を実行できるように設定します。

wait(counter)

Parameters

{number} counter フレーム値


イベントコマンドの「ユニットの消去」を実行できるように設定します。

unitRemove(unit, directionType, option)

Parameters

{Unit} unit ユニット

{number} directionType DirectionType値

{number} option RemoveOption値


イベントコマンドの「ユニットの所属変更」を実行できるように設定します。

unitAssign(unit, unitType)

Parameters

{Unit} unit ユニット

{number} unitType UnitType値


イベントコマンドの「ゴールドの増減」を実行できるように設定します。

goldChange(gold, increaseType, isSkipMode)

Parameters

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

{number} increaseType 増減の仕方を表すIncreaseType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


ストックをベースに、イベントコマンドの「アイテムの増減」を実行できるように設定します。

stockItemChange(*item, increaseType, isSkipMode)

Parameters

{Item} *item 対象アイテム

{number} increaseType 増減の仕方を表すIncreaseType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


ユニットをベースに、イベントコマンドの「アイテムの増減」を実行できるように設定します。

unitItemChange(unit, *item, increaseType, isSkipMode)

Parameters

{Unit} unit 対象ユニット

{Item} *item 対象アイテム

{number} increaseType 増減の仕方を表すIncreaseType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「パラメータの増減」を実行できるように設定します。

parameterChange(unit, doping, isSkipMode)

Parameters

{Unit} unit 対象ユニット

{Parameter} doping パラメータ

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「スキルの増減」を実行できるように設定します。

skillChange(unit, skill, increaseType, isSkipMode)

Parameters

{Unit} unit 対象ユニット

{Skill} skill 対象スキル

{number} increaseType 増減の仕方を表すIncreaseType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「HPの回復」を実行できるように設定します。

hpRecovery(unit, anime, value, recoveryType, isSkipMode)

Parameters

{Unit} unit 対象ユニット

{Anime} anime 回復アニメ

{number} value 回復値

{number} recoveryType 回復の仕方を表すRecoveryType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「ダメージを与える」を実行できるように設定します。ダメージは確実に命中します。

damageHit(unit, anime, value, damageType, launchUnit, isSkipMode)

Parameters

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

{Anime} anime ダメージアニメ

{number} value ダメージ値

{number} damageType ダメージの与え方を表すDamageType値

{Unit} launchUnit ダメージを与える元になったユニット

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「ダメージを与える」を実行できるように設定します。

damageHitEx(unit, anime, value, damageType, hit, launchUnit, isSkipMode)

Parameters

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

{Anime} anime ダメージアニメ

{number} value ダメージ値

{number} damageType ダメージの与え方を表すDamageType値

{number} hit 命中率

{Unit} launchUnit ダメージを与える元になったユニット

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「経験値を与える」を実行できるように設定します。

experiencePlus(unit, exp, isSkipMode)

Parameters

{Unit} unit 対象ユニット

{number} exp 習得経験値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「経験値を与える」を実行できるように設定します。

experiencePlusEx(unit, exp, type, isSkipMode)

Parameters

{Unit} unit 対象ユニット

{number} exp 習得経験値

{number} type ExperiencePlusType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「クラスチェンジ」を実行できるように設定します。

classChange(unit, cls, isSkipMode)

Parameters

{Unit} unit 対象ユニット

{Class} cls 対象クラス

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「アイテムの使用」を実行できるように設定します。

itemUse(src, dest, *item, x, y, isSkipMode)

Parameters

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

{Unit} dest アイテムが使用されるユニット

{Item} *item 使用するアイテム

{number} x アイテムの使用先となるx座標

{number} y アイテムの使用先となるy座標

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「強制戦闘」を実行できるように設定します。

forceBattle(src, dest, battleType, isExperienceEnabled, isSkipMode)

Parameters

{Unit} src 攻撃を仕掛けるユニット

{Unit} dest 攻撃を受けるユニット

{number} battleType 戦闘形式を表す値

{boolean} isExperienceEnabled 経験値を考慮する場合はtrue、そうでない場合はfalse

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「チャプターの表示」を実行できるように設定します。

chapterShow(chapterName, mapName, isMapInfo)

Parameters

{string} chapterName チャプター名を表す文字列

{string} mapName マップ名を表す文字列

{boolean} isMapInfo マップ情報のデータを使用する場合はtrue、そうでない場合はfalse


イベントコマンドの「マップクリア」を実行できるように設定します。

victoryMap(mapId, actionType, isLogo)

Parameters

{number} mapId マップID

{number} actionType セーブ形式を示すRestSaveType値

{boolean} isLogo ロゴを表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「場所注目」を実行できるように設定します。

locationFocus(x, y, isSkipMode)

Parameters

{number} x 焦点を合わせるx座標

{number} y 焦点を合わせるy座標

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「マップチップの変更」を実行できるように設定します。

mapChipChange(x, y, isLayer, handle)

Parameters

{number} x x座標

{number} y y座標

{boolean} isLayer 透過チップを設定する場合はtrue、そうでない場合はfalse

{ResourceHandle} handle リソースハンドル


イベントコマンドの「マップスクロール」を実行できるように設定します。

mapScroll(speedType, isWait, isStopKey)

Parameters

{number} speedType 速度を表すSpeedType値

{boolean} isWait 処理が完了するまで待機する場合はtrue、そうでない場合はfalse

{boolean} isStopKey 決定キーでスクロールを止めれるようにする場合はtrue、そうでない場合はfalse


イベントコマンドの「ユニットの状態変更」を実行できるように設定します。

unitStateChange(unit, flags, value)

Parameters

{Unit} unit ユニット

{number} flags UnitStateChangeFlag値

{number} value 設定する値


イベントコマンドの「ボーナスの増減」を実行できるように設定します。

bonusChange(bonus, increaseType, isSkipMode)

Parameters

{number} bonus ボーナス

{number} increaseType 増減の仕方を表すIncreaseType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「トロフィーの増減」を実行できるように設定します。

trophyChange(unit, increaseType, trophy)

Parameters

{Unit} unit ユニット

{number} increaseType 増減の仕方を表すIncreaseType値

{Trophy} trophy トロフィー


イベントコマンドの「アイテムの耐久変更」を実行できるように設定します。

itemDurabilityChange(unit, item, durability, increaseType, isSkipMode)

Parameters

{Unit} unit アイテムを所持するユニット

{Unit} item 耐久を変更したいアイテム

{number} durability 耐久の値

{number} increaseType IncreaseType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「アイテムの耐久変更」をストックベースで実行できるように設定します。

stockDurabilityChange(item, durability, increaseType, isSkipMode)

Parameters

{Unit} item 耐久を変更したいアイテム

{number} durability 耐久の値

{number} increaseType IncreaseType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「ユニットのステート付加」を実行できるように設定します。

unitStateAddition(unit, obj, increaseType, launchUnit, isSkipMode)

Parameters

{Unit} unit ステートを受けるユニット

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

{number} increaseType IncreaseType値

{Unit} launchUnit ステートを与える元になったユニット

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「ユニットのスライド」を実行できるように設定します。

unitSlide(unit, directionType, pixelIndex, slideType, isSkipMode)

Parameters

{Unit} unit ユニット

{number} directionType DirectionType値

{number} pixelIndex ピクセル数を示すインデックス

{number} slideType SlideType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「ユニットのフュージョン」を実行できるように設定します。

unitFusion(unit, targetUnit, fusion, direction, fusionActiontype, isSkipMode)

Parameters

{Unit} unit ユニット

{Unit} targetUnit 対象ユニット。FusionActionType.CATCHとFusionActionType.TRADEで有効。

{Fusion} fusion フュージョン。FusionActionType.CATCHで有効。

{number} direction DirectionType値。FusionActionType.RELEASEで有効。

{number} fusionActiontype FusionActionType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「ユニットの形態変化」を実行できるように設定します。

unitMetamorphoze(unit, metamorphoze, metamorphozeActiontype, isSkipMode)

Parameters

{Unit} unit ユニット

{Metamorphoze} metamorphoze 形態変化データ

{number} metamorphozeActiontype MetamorphozeActionType値

{boolean} isSkipMode 画像を表示する場合はtrue、そうでない場合はfalse


イベントコマンドの「マップ座標の操作」を実行できるように設定します。

mapPosOperation(unit, x, y, obj)

Parameters

{Unit} unit ユニット

{number} x x座標

{number} y y座標

{object} obj アニメまたはリソースハンドル


設定されたイベントコマンドから成立するイベントを作成し、それを実行します。

{Event} execute()

Returns

{Event} 作成されたイベント


設定されたイベントコマンドをリセットします。

reset()