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 UnitType値

{number} raceType 作成されたユニット

Returns

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


ページデータ

{Unit} generateUnitFromRefinforcementPage(page)

Parameters

{ReinforcementPage} page 作成されたユニット

Returns

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


EventGenerator

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

メソッド

対象テキスト

messageShowUnit(message, pos, unit)

Parameters

{string} message 表示位置を表すMessagePos値

{number} pos 対象ユニット

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


対象テキスト

messageShowNpc(message, pos, npc)

Parameters

{string} message 表示位置を表すMessagePos値

{number} pos 対象NPC

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


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

messageErase(isTop, isCenter, isBottom)

Parameters

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

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

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


対象テキスト

messageTerop(message, pos, isWindowShow)

Parameters

{string} message 表示位置を表すMessagePos値

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

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


対象テキスト

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 x座標

{number} x 速度を表すSpeedType値

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

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

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


対象テキスト

messageTitle(message, x, y, isCenterShow)

Parameters

{string} message x座標

{number} x y座標

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

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


対象テキスト

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

Parameters

{string} message 情報の種類を表すInfoWindowType値

{number} infoType x座標

{number} x y座標

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

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


目標のx座標

screenScroll(x, y, speedType, isWait)

Parameters

{number} x 目標のy座標

{number} y 速度を表すSpeedType値

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

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


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

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

Parameters

{boolean} isChange 色の値

{number} color 色の透明度

{number} alpha 速度を表すSpeedType値

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

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

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


変更の種類を表すBackgroundChangeType値

backgroundChange(backgroundChangeType, handle, graphicsType, backgroundTransitiontype)

Parameters

{number} backgroundChangeType 背景画像のリソースハンドル

{ResourceHandle} handle 画像の種類を表すGraphicsType値

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

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


音楽のリソースハンドル

musicPlay(handle, musicPlayType)

Parameters

{ResourceHandle} handle 再生の種類を表すMusicPlayType値

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


停止形式を表すMusicStopType値

musicStop(type, speedType)

Parameters

{number} type 速度を表すSpeedType値

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


効果音のリソースハンドル

soundPlay(handle, id)

Parameters

{ResourceHandle} handle 割り当てるID

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


停止する効果音のID

soundStop(id, isAllStop)

Parameters

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

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


アニメ

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

Parameters

{Anime} anime 表示先となるx座標

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

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

{boolean} isCenterShow AnimePlayType値

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

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


割り当てるID

animationStop(id, isAllStop)

Parameters

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

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


シーンの種類を表すSceneType値

sceneChange(type)

Parameters

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


フレーム値

wait(counter)

Parameters

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


ユニット

unitRemove(unit, directionType, option)

Parameters

{Unit} unit DirectionType値

{number} directionType RemoveOption値

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


ユニット

unitAssign(unit, unitType)

Parameters

{Unit} unit UnitType値

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


増減させるゴールド

goldChange(gold, increaseType, isSkipMode)

Parameters

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

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

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


対象アイテム

stockItemChange(*item, increaseType, isSkipMode)

Parameters

{Item} *item 増減の仕方を表すIncreaseType値

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

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


対象ユニット

unitItemChange(unit, *item, increaseType, isSkipMode)

Parameters

{Unit} unit 対象アイテム

{Item} *item 増減の仕方を表すIncreaseType値

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

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


対象ユニット

parameterChange(unit, doping, isSkipMode)

Parameters

{Unit} unit パラメータ

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

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


対象ユニット

skillChange(unit, skill, increaseType, isSkipMode)

Parameters

{Unit} unit 対象スキル

{Skill} skill 増減の仕方を表すIncreaseType値

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

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


対象ユニット

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

Parameters

{Unit} unit 回復アニメ

{Anime} anime 回復値

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

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

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


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

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

Parameters

{Unit} unit ダメージアニメ

{Anime} anime ダメージ値

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

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

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

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


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

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

Parameters

{Unit} unit ダメージアニメ

{Anime} anime ダメージ値

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

{number} damageType 命中率

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

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

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


対象ユニット

experiencePlus(unit, exp, isSkipMode)

Parameters

{Unit} unit 習得経験値

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

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


対象ユニット

experiencePlusEx(unit, exp, type, isSkipMode)

Parameters

{Unit} unit 習得経験値

{number} exp ExperiencePlusType値

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

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


対象ユニット

classChange(unit, cls, isSkipMode)

Parameters

{Unit} unit 対象クラス

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

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


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

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

Parameters

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

{Unit} dest 使用するアイテム

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

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

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

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


攻撃を仕掛けるユニット

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

Parameters

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

{Unit} dest 戦闘形式を表す値

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

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

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


チャプター名を表す文字列

chapterShow(chapterName, mapName, isMapInfo)

Parameters

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

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

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


焦点を合わせるx座標

locationFocus(x, y, isSkipMode)

Parameters

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

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

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


x座標

mapChipChange(x, y, isLayer, handle)

Parameters

{number} x y座標

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

{boolean} isLayer リソースハンドル

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


速度を表すSpeedType値

mapScroll(speedType, isWait, isStopKey)

Parameters

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

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

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


ユニット

unitStateChange(unit, flags, value)

Parameters

{Unit} unit UnitStateChangeFlag値

{number} flags 設定する値

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


ボーナス

bonusChange(bonus, increaseType, isSkipMode)

Parameters

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

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

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


ユニット

trophyChange(unit, increaseType, trophy)

Parameters

{Unit} unit 増減の仕方を表すIncreaseType値

{number} increaseType トロフィー

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


アイテムを所持するユニット

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

Parameters

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

{Unit} item 耐久の値

{number} durability IncreaseType値

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

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


耐久を変更したいアイテム

stockDurabilityChange(item, durability, increaseType, isSkipMode)

Parameters

{Unit} item 耐久の値

{number} durability IncreaseType値

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

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


ステートを受けるユニット

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

Parameters

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

{StateInvocation} obj IncreaseType値

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

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

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


ユニット

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

Parameters

{Unit} unit DirectionType値

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

{number} pixelIndex SlideType値

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

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


ユニット

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

Parameters

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

{Unit} targetUnit フュージョン。FusionActionType.CATCHで有効。

{Fusion} fusion DirectionType値。FusionActionType.RELEASEで有効。

{number} direction FusionActionType値

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

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


ユニット

unitMetamorphoze(unit, metamorphoze, metamorphozeActiontype, isSkipMode)

Parameters

{Unit} unit 形態変化データ

{Metamorphoze} metamorphoze MetamorphozeActionType値

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

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


ユニット

mapPosOperation(unit, x, y, obj)

Parameters

{Unit} unit x座標

{number} x y座標

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

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


作成されたイベント

{Event} execute()

Returns

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