SRPG Studio スクリプト・マニュアル

root

ResourceHandle

リソースハンドルに関する情報を管理します。

メソッド

ハンドルの種類を取得します。

{number} getHandleType()

Returns

{number} ハンドルの種類


リソースIDを取得します。

{number} getResourceId()

Returns

{number} リソースID


カラーのインデックスを取得します。

{number} getColorIndex()

Returns

{number} カラーのインデックス


リソース上のx座標を取得します。

{number} getSrcX()

Returns

{number} x座標


リソース上のy座標を取得します。

{number} getSrcY()

Returns

{number} y座標


指定したハンドルと中身が一致する場合はtrue、そうでない場合はfalseを返します。

{boolean} isEqualHandle(destHandle)

Parameters

{ResourceHandle} destHandle 比較するハンドル

Returns

{boolean} 真偽値


空のハンドルである場合はtrue、そうでない場合はfalseを返します。

{boolean} isNullHandle()

Returns

{boolean} 真偽値


Parameter

パラメータに関する情報を管理します。

メソッド

指定されたパラメータを取得します。

{number} getAssistValue(index)

Parameters

{number} index パラメータのインデックス

Returns

{number} パラメータ値


指定されたパラメータを設定します。

setAssistValue(index, value)

Parameters

{number} index パラメータのインデックス

{number} value パラメータ値


Calculation

計算オブジェクト管理します。

メソッド

指定されたパラメータを取得します。

{number} getValue(index)

Parameters

{number} index パラメータのインデックス

Returns

{number} パラメータ値


演算子を取得します。

{number} getOperatorSymbol(index)

Parameters

{number} index パラメータのインデックス

Returns

{number} OperatorSymbol値


「子の能力」におけるパラメータタイプを取得します。

{number} getParameterType(index)

Parameters

{number} index パラメータのインデックス

Returns

{number} ParameterType値


「子の能力」におけるパラメータインデックスを取得します。

{number} getParameterValue(index)

Parameters

{number} index パラメータのインデックス

Returns

{number} パラメータ値


「子の能力」における演算子を取得します。

{number} getParameterOperatorSymbol(index)

Parameters

{number} index パラメータのインデックス

Returns

{number} OperatorSymbol値


「子の能力」を参照する場合はtrue、そうでない場合はfalseを返します。

{boolean} isChildCheck(index)

Parameters

{number} index パラメータのインデックス

Returns

{boolean} 真偽値


Aggregation

データ条件を管理します。

メソッド

オブジェクトの数を取得します。

{number} getObjectCount()

Returns

{number} オブジェクトの数


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

{object} getObjectData(index)

Parameters

{number} index インデックス

Returns

{object} オブジェクト


オブジェクトの形式を取得します。

{number} getObjectType(index)

Parameters

{number} index インデックス

Returns

{number} ObjectType値


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

{boolean} isCondition(unit)

Parameters

{Unit} unit 条件を確認するユニット

Returns

{boolean} 真偽値


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

{boolean} isConditionFromWeapon(data, weapon)

Parameters

{object} data 条件を確認するユニット

{Weapon} weapon 装備中として仮定する武器

Returns

{boolean} 真偽値


条件をどのように確認するか示す値を取得します。

{number} getMatchType()

Returns

{number} MatchType値


SupportStatus

補正ステータスを管理します。

メソッド

「攻撃補正」を取得します。

{number} getPower()

Returns

{number} 攻撃補正


「防御補正」を取得します。

{number} getDefense()

Returns

{number} 防御補正


「命中補正」を取得します。

{number} getHit()

Returns

{number} 命中補正


「回避補正」を取得します。

{number} getAvoid()

Returns

{number} 回避補正


「クリティカル補正」を取得します。

{number} getCritical()

Returns

{number} クリティカル補正


「クリティカル回避補正」を取得します。

{number} getCriticalAvoid()

Returns

{number} クリティカル回避補正


Trophy

トロフィーに関する情報を管理します。

メソッド

トロフィーの内容を示す値を取得します。

{number} getFlag()

Returns

{number} TrophyFlag値


アイテムを取得します。

{Item} getItem()

Returns

{Item} アイテム


ゴールドを取得します。

{number} getGold()

Returns

{number} ゴールド


ボーナスを取得します。

{number} getBonus()

Returns

{number} ボーナス


トロフィーを直ちに入手できる場合はtrue、そうでない場合はfalseを返します。

{boolean} isImmediately()

Returns

{boolean} 真偽値


getItemで取得できるアイテムの初期耐久値を設定します。

setLimit(limit)

Parameters

{number} limit 耐久


Inventory

アイテムの在庫を管理します。

メソッド

現在の在庫を取得します。

{number} getAmount()

Returns

{number} 在庫の値


新しい在庫を設定します。

setAmount(value)

Parameters

{number} value 在庫の値


QuestReward

クエストの報酬に関する情報を管理します。

メソッド

報酬の種類を示す値を取得します。

{number} getType()

Returns

{number} RewardType値


アイテムを取得します。

{Item} getItem()

Returns

{Item} アイテム


ゴールドを取得します。

{number} getGold()

Returns

{number} ゴールド


ボーナスを取得します。

{number} getBonus()

Returns

{number} ボーナス


テキストを取得します。

{string} getText()

Returns

{string} テキスト


数値を取得します。

{number} getValue()

Returns

{number} 数値


PrototypeInfo

プロトタイプ情報を取得します。

メソッド

名前を取得します。

{string} getName()

Returns

{string} 名前


説明文を取得します。

{string} getDescription()

Returns

{string} 説明文


「顔画像」のリソースハンドルを取得します。

{ResourceHadle} getFaceResourceHandle()

Returns

{ResourceHadle} 「顔画像」のリソースハンドル


初期パラメータの配列を取得します。

{object} getInitialArray()

Returns

{object} 配列を取得します。


プロトタイプ情報の成長値設定を取得します。

{object} getGrowthArray(lv)

Parameters

{number} lv レベル

Returns

{object} 成長値の配列


UnitStyle

フュージョンに関するメソッドを管理します。

メソッド

オブジェクトに関連しているユニットを取得します。

{Unit} getSourceUnit()

Returns

{Unit} ユニット


現在、ユニットに関連付けられているフュージョンを取得します。

{Fusion} getFusionData()

Returns

{Fusion} フュージョン


現在、ユニットがキャッチしている親ユニットを取得します。

{Unit} getFusionChild()

Returns

{Unit} ユニット


現在、ユニットをキャッチしている親ユニットを取得します。

{Unit} getFusionParent()

Returns

{Unit} ユニット


ユニットに関連付けるフュージョンを設定します。

setFusionData(fusion)

Parameters

{Fusion} fusion フュージョン


キャッチした子ユニットを設定します。

setFusionChild(unit)

Parameters

{Unit} unit ユニット


キャッチされた親ユニットを設定します。

setFusionParent(unit)

Parameters

{Unit} unit ユニット


setFusionData、setFusionChild、setFusionParentの設定内容をクリアします。

clearFusionInfo()

「フュージョン攻撃」に使用するフュージョンを設定します。

startFusionAttack(fusion)

Parameters

{Fusion} fusion フュージョン


「フュージョン攻撃」を終了する際に呼び出します。

endFusionAttack()

startFusionAttackで設定したフュージョンを取得します。

{Fusion} getFusionAttackData()

Returns

{Fusion} フュージョン


現在、ユニットに関連付けられている「形態変化」データを取得します。

{Metamorphoze} getMetamorphozeData()

Returns

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


ユニットに関連付ける「形態変化」データを設定します。

setMetamorphozeData(metamorphoze)

Parameters

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


設定されている「形態変化」データをクリアします。

clearMetamorphozeData()

「形態変化」してからの経過ターン数を取得します。

{number} getMetamorphozeTurn()

Returns

{number} ターン数


「形態変化」してからの経過ターン数を設定します。

setMetamorphozeTurn(turn)

Parameters

{number} turn ターン数


「形態変化」する前のクラスを取得します。

{Class} getSourceClass()

Returns

{Class} クラス


StateInvocation

ステート発動オブジェクトに関する情報を管理します。

メソッド

発動されるステートを取得します。

{State} getState()

Returns

{State} ステート


発動率のタイプを取得します。

{number} getInvocationType()

Returns

{number} InvocationType値


発動率の値を取得します。

{number} getInvocationValue()

Returns

{number} 発動率の値


StateGroup

ステート発動オブジェクトに関する情報を管理します。

メソッド

全てのバッドステートを対象にする場合はtrue、そうでない場合はfalseを返します。

{boolean} isAllBadState()

Returns

{boolean} 真偽値


ステートのリストを取得します。

{ReferenceList} getStateReferenceList()

Returns

{ReferenceList} ステートのリスト


TurnState

ユニットに設定されているステート情報を取得します。

メソッド

ステートの経過ターンを取得します。

{number} getTurn()

Returns

{number} ターン


ステートの経過ターンを設定します。

setTurn(turn)

Parameters

{number} turn ターン


ステートの「自動解除条件」の現在回数を取得します。

{number} getRemovalCount()

Returns

{number} 回数


ステートの「自動解除条件」の現在回数を設定します。

setRemovalCount(count)

Parameters

{number} count 回数


関連するステートを取得します。

{State} getState()

Returns

{State} ステート


経過ターンを考慮したドーピング情報を取得します。

{Parameter} getDopingParameter()

Returns

{Parameter} ドーピング情報


MotionIdCollection

モーションIDの情報を管理します。

メソッド

戦士系のモーションIDを取得します。

{number} getFighterId(type)

Parameters

{number} type MotionFighter値

Returns

{number} モーションID


弓兵系のモーションIDを取得します。

{number} getArcherId(type)

Parameters

{number} type MotionArcher値

Returns

{number} モーションID


魔道士系のモーションIDを取得します。

{number} getMageId(type)

Parameters

{number} type MotionMage値

Returns

{number} モーションID


ScreenEffect

画面効果の情報を管理します。

メソッド

色を取得します。

{number} getColor()

Returns

{number} 色


色を設定します。

setColor(color)

Parameters

{number} color 色


アルファ値を取得します。

{number} getAlpha()

Returns

{number} アルファ値


アルファ値を設定します。

setAlpha(alpha)

Parameters

{number} alpha アルファ値


範囲を取得します。

{number} getRange()

Returns

{number} EffectRangeType値


範囲を設定します。

setRange(range)

Parameters

{number} range EffectRangeType値


情報をリセットします。

resetEffect()

SaveFileInfo

セーブファイルの情報を管理します。

メソッド

プレイ時間を取得します。

{number} getPlayTime()

Returns

{number} プレイ時間


経過ターン数を取得します。

{number} getTurnCount()

Returns

{number} 経過ターン数


難易度を取得します。

{Difficulty} getDifficulty()

Returns

{Difficulty} 難易度


ゴールドを取得します。

{number} getGold()

Returns

{number} ゴールド


ボーナスを取得します。

{number} getBonus()

Returns

{number} ボーナス


シーンタイプを取得します。

{number} getSceneType()

Returns

{number} SceneType値


マップ情報を取得します。

{MapData} getMapInfo()

Returns

{MapData} マップ情報


クリアを済みファイルの場合はtrue、そうでない場合はfalseを返します。

{boolean} isCompleteFile()

Returns

{boolean} 真偽値


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

{object} custom()

Returns

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


ClippingArea

クリッピング領域に関する情報を管理します。

メソッド

クリッピングx座標を取得します。

{number} getClippingX()

Returns

{number} x座標


クリッピングy座標を取得します。

{number} getClippingY()

Returns

{number} y座標


クリッピング幅を取得します。

{number} getClippingWidth()

Returns

{number} 幅


クリッピング高さを取得します。

{number} getClippingHeight()

Returns

{number} 高さ


FormattedText

整形済みテキストの情報を管理します。

メソッド

テキスト内の文字の表示範囲を設定します。

setValidArea(start, end)

Parameters

{number} start 始点

{number} end 終点


指定範囲に文字色と不透明度を設定します。

setColorAlpha(start, end, color, alpha)

Parameters

{number} start 始点

{number} end 終点

{number} color 色

{number} alpha 不透明度


指定範囲にフォントを設定します。

setFont(start, end, font)

Parameters

{number} start 始点

{number} end 終点

{object} font フォント


指定範囲にフォントのサイズを設定します。

setFontSize(start, end, size)

Parameters

{number} start 始点

{number} end 終点

{number} size サイズ


指定範囲にフォントの太さを示す値を設定します。

setFontWeight(start, end, weight)

Parameters

{number} start 始点

{number} end 終点

{number} weight 1を設定します。


指定範囲にフォントスタイルを示す値を設定します。

setFontStyle(start, end, style)

Parameters

{number} start 始点

{number} end 終点

{number} style 斜体にする場合は0、イタリック体にする場合は1を設定します。


指定範囲に打ち消し線を設定します。

setStrikethrough(start, end)

Parameters

{number} start 始点

{number} end 終点


指定範囲に下線を設定します。

setUnderline(start, end)

Parameters

{number} start 始点

{number} end 終点


整形済みテキストを描画します。

drawFormattedText(x, y, color, alpha)

Parameters

{number} x x座標

{number} y y座標

{number} color 色

{number} alpha 不透明度


GraphicsCanvas

図形描画に必要なメソッドを管理します。

メソッド

GraphicsGradientオブジェクトを作成します。

{GraphicsGradient} createGradient()

Returns

{GraphicsGradient} GraphicsGradientオブジェクト


GraphicsFigureオブジェクトを作成します。

{GraphicsFigure} createFigure()

Returns

{GraphicsFigure} GraphicsFigureオブジェクト


四角形を描画します。

drawRectangle(x, y, nWidth, nHeight)

Parameters

{number} x x座標

{number} y y座標

{number} nWidth 幅

{number} nHeight 高さ


角丸四角形を描画します。

drawRoundedRectangle(x, y, nWidth, nHeight, radiusX, radiusY)

Parameters

{number} x x座標

{number} y y座標

{number} nWidth 幅

{number} nHeight 高さ

{number} radiusX 1/4のX半径

{number} radiusY 1/4のY半径


楕円を描画します。

drawEllipse(x, y, nWidth, nHeight)

Parameters

{number} x x座標

{number} y y座標

{number} nWidth 幅

{number} nHeight 高さ


直線を描画します。

drawLine(x1, y1, x2, y2, weight)

Parameters

{number} x1 始点のx座標

{number} y1 始点のy座標

{number} x2 終点のx座標

{number} y2 終点のy座標

{number} weight 直線のサイズ


図形を描画します。

drawFigure(x, y, figure)

Parameters

{number} x x座標

{number} y y座標

{GraphicsFigure} figure GraphicsFigureオブジェクト


輪郭の情報を設定します。

setStrokeInfo(nColor, nAlpha, weight, isStrokeFirst)

Parameters

{number} nColor 色

{number} nAlpha アルファ値

{number} weight 輪郭のサイズ

{boolean} isStrokeFirst 内部より輪郭を先行して描画する場合はtrue、そうでない場合はfalse


内部の色を設定します。

setFillColor(nColor, nAlpha)

Parameters

{number} nColor 色

{number} nAlpha アルファ値


setFillColorの代わりに、内部を塗りつぶすGradientオブジェクトを設定します。

setGradient(gradient)

Parameters

{GraphicsGradient} gradient GraphicsGradientオブジェクト


拡大率を設定します。既定値は100です。

setScale(scale)

Parameters

{number} scale 拡大率


回転率を設定します。既定値は0です。

setDegree(degree)

Parameters

{number} degree 回転率


GraphicsFigure

直線やベジェ曲線で構成される独自の図形を管理します。

メソッド

図形の構成を開始します。

beginFigure(x, y)

Parameters

{number} x 始点のx座標

{number} y 始点のy座標


図形の構成を終了します。

endFigure()

直線を追加します。

addLine(x, y)

Parameters

{number} x 終点のx座標

{number} y 終点のy座標


ベジェ曲線を追加します。

addBezier(x1, y1, x2, y2, x3, y3)

Parameters

{number} x1 最初の制御点のx座標

{number} y1 最初の制御点のy座標

{number} x2 2つ目の制御点のx座標

{number} y2 2つ目の制御点のy座標

{number} x3 終点のx座標

{number} y3 終点のy座標


弧を追加します。

addArc(x1, y1, radiusX, radiusY)

Parameters

{number} x1 終点のx座標

{number} y1 終点のy座標

{number} radiusX 弧のx半径

{number} radiusY 弧のy半径


GraphicsGradient

複数の色で構成されるグラデーションを管理します。

メソッド

グラデーションの構成を開始します。

beginGradient(type)

Parameters

{number} type GradientType値


グラデーションの構成を終了します。

endGradient()

色を追加します。5回まで呼ぶことができます。

addColor(color, alpha)

Parameters

{number} color 色

{number} alpha アルファ値


GraphicsDecoration

マップ上のユニットがgame側で描画される際に装飾を追加できます。

メソッド

装飾を開始します。

beginDecoration()

装飾を終了します。

endDecoration()

hp描画を追加します。

addHp(x, y, colorIndex)

Parameters

{number} x x座標

{number} y y座標

{number} colorIndex 色のインデックス


ゲージ描画を追加します。

addGauge(x, y, nCount)

Parameters

{number} x x座標

{number} y y座標

{number} nCount ゲージの長さ。1か2


イメージ描画を追加します。MaterialManager.createImageのイメージなどを指定できます。

addImage(x, y, xSrc, ySrc, width, height, img)

Parameters

{number} x x座標

{number} y y座標

{number} xSrc 描画元のx座標

{number} ySrc 描画元のy座標

{number} width 幅

{number} height 高さ

{Image} img Imageオブジェクト


四角形の描画を追加します。

addRectangle(x, y, width, height)

Parameters

{number} x x座標

{number} y y座標

{number} width 幅

{number} height 高さ


角丸四角形の描画を追加します。

addRoundedRectangle(x, y, width, height, radiusX, radiusY)

Parameters

{number} x x座標

{number} y y座標

{number} width 幅

{number} height 高さ

{number} radiusX 1/4のX半径

{number} radiusY 1/4のY半径


楕円の描画を追加します。

addEllipse(x, y, width, height)

Parameters

{number} x x座標

{number} y y座標

{number} width 幅

{number} height 高さ


直線の描画を追加します。

addLine(x, y, x2, y2, weight)

Parameters

{number} x 始点のx座標

{number} y 始点のy座標

{number} x2 終点のx座標

{number} y2 終点のy座標

{number} weight 直線のサイズ


輪郭の情報を設定します。

setStrokeInfo(nColor, nAlpha, weight, isStrokeFirst)

Parameters

{number} nColor 色

{number} nAlpha アルファ値

{number} weight 輪郭のサイズ

{boolean} isStrokeFirst 内部より輪郭を先行して描画する場合はtrue、そうでない場合はfalse


内部の色を設定します。

setFillColor(nColor, nAlpha)

Parameters

{number} nColor 色

{number} nAlpha アルファ値


クラスのサイズがLサイズ以上の場合のオフセットを設定します。

setLargeSize(x, y, width, height)

Parameters

{number} x x座標

{number} y y座標

{number} width 幅

{number} height 高さ


BacklogCommand

バックログにおける1つのコマンドデータを管理します。

メソッド

テキストを取得します。

{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


コマンドのタイプを取得します。

{number} getCommandType()

Returns

{number} CommandType値


MapSimulator

マップ上での移動ポイントを管理します。

メソッド

ユニットの現在位置をベースに検索を開始します。

startSimulation(unit, moveMaxCount)

Parameters

{Unit} unit ユニット

{number} moveMaxCount 検索する広さの値


指定位置と間隔をベースに検索を開始します。

startSimulationRange(x, y, startRange, endRange)

Parameters

{number} x x座標

{number} y y座標

{number} startRange 開始位置

{number} endRange 終了位置


ユニットの現在位置と武器の範囲をベースに検索を開始します。

startSimulationWeapon(unit, moveMaxCount, startRange, endRange)

Parameters

{Unit} unit ユニット

{number} moveMaxCount 検索する広さの値

{number} startRange 武器の開始射程

{number} endRange 武器の終了射程


全てのユニットの現在位置と武器の範囲をベースに検索を開始します。

startSimulationWeaponAll(unitFilter)

Parameters

{number} unitFilter UnitFilterFlag値


指定ユニットの一定周囲のみマーキングを行います。事前にstartSimulationWeaponAllが呼ばれている必要があります。

startSimulationWeaponPlus(unit)

Parameters

{Unit} unit ユニット


startSimulation系の呼び出しで、マップ上に存在するユニットを考慮しないようにします。

disableMapUnit()

startSimulation系の呼び出しで、地形効果を考慮しないようにします。

disableTerrain()

startSimulation系の呼び出しで、「通れる地形」設定を考慮しないようにします。

disableRestrictedPass()

startSimulation(Range)によって内部で生成された配列を返します。この配列には、検索の範囲内に存在するマップ上のインデックスが含まれます。

{object} getSimulationIndexArray()

Returns

{object} 配列


startSimulationWeapon(All, Plus)によって内部で生成された配列を返します。この配列には、検索の範囲内に存在するマップ上のインデックスが含まれます。

{object} getSimulationWeaponIndexArray()

Returns

{object} 配列


マップ上のインデックスから、そのインデックスに対しての移動ポイントを取得します。

{number} getSimulationMovePoint(mapIndex)

Parameters

{number} mapIndex インデックス

Returns

{number} 移動ポイント


マップ上のインデックスから、そのインデックスに対しての方向を取得します。

{number} getSimulationDirection(mapIndex)

Parameters

{number} mapIndex インデックス

Returns

{number} DirectionType値


マップ上のインデックスがマーク済みである場合はtrue、そうでない場合はfalseを返します。

{boolean} isSimulationMark(mapIndex)

Parameters

{number} mapIndex インデックス

Returns

{boolean} 真偽値


マップ上のインデックスに対して調査済みを示すマークを設定します。

setSimulationMark(mapIndex, flag)

Parameters

{number} mapIndex インデックス

{boolean} flag マーク済みにする場合はtrue、そうでない場合はfalse


設定したマークを全て解除します。

resetSimulationMark()

有効な検索結果の総数を取得します。この総数は、ループ文の長さに指定されることを想定しています。

{number} getLoopCount()

Returns

{number} ループ数


ループインデックスから移動ポイントを取得します。

{number} getMovePointFromLoopIndex(loopIndex)

Parameters

{number} loopIndex ループインデックス

Returns

{number} 移動ポイント


ループインデックスから位置インデックスを取得します。

{number} getPosIndexFromLoopIndex(loopIndex)

Parameters

{number} loopIndex ループインデックス

Returns

{number} 位置インデックス


startSimulationで指定した検索値を返します。

{number} getAreaValue()

Returns

{number} 検索値