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

root

ResourceHandle

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

メソッド

ハンドルの種類

{number} getHandleType()

Returns

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


リソースID

{number} getResourceId()

Returns

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


カラーのインデックス

{number} getColorIndex()

Returns

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


x座標

{number} getSrcX()

Returns

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


y座標

{number} getSrcY()

Returns

{number} 指定したハンドルと中身が一致する場合は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 OperatorSymbol値

Returns

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


パラメータのインデックス

{number} getParameterType(index)

Parameters

{number} index ParameterType値

Returns

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


パラメータのインデックス

{number} getParameterValue(index)

Parameters

{number} index パラメータ値

Returns

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


パラメータのインデックス

{number} getParameterOperatorSymbol(index)

Parameters

{number} index OperatorSymbol値

Returns

{number} 「子の能力」を参照する場合は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 ObjectType値

Returns

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


条件を確認するユニット

{boolean} isCondition(unit)

Parameters

{Unit} unit 真偽値

Returns

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


条件を確認するユニット

{boolean} isConditionFromWeapon(data, weapon)

Parameters

{object} data 装備中として仮定する武器

{Weapon} weapon 真偽値

Returns

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


MatchType値

{number} getMatchType()

Returns

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


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

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

メソッド

TrophyFlag値

{number} getFlag()

Returns

{number} アイテムを取得します。


アイテム

{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

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

メソッド

RewardType値

{number} getType()

Returns

{number} アイテムを取得します。


アイテム

{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 「フュージョン攻撃」を終了する際に呼び出します。


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

endFusionAttack()

フュージョン

{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} 発動率のタイプを取得します。


InvocationType値

{number} getInvocationType()

Returns

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


発動率の値

{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} モーションIDの情報を管理します。


MotionIdCollection

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

メソッド

MotionFighter値

{number} getFighterId(type)

Parameters

{number} type モーションID

Returns

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


MotionArcher値

{number} getArcherId(type)

Parameters

{number} type モーションID

Returns

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


MotionMage値

{number} getMageId(type)

Parameters

{number} type モーションID

Returns

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


ScreenEffect

色を取得します。

メソッド

{number} getColor()

Returns

{number} 色を設定します。


setColor(color)

Parameters

{number} color アルファ値を取得します。


アルファ値

{number} getAlpha()

Returns

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


アルファ値

setAlpha(alpha)

Parameters

{number} alpha 範囲を取得します。


EffectRangeType値

{number} getRange()

Returns

{number} 範囲を設定します。


EffectRangeType値

setRange(range)

Parameters

{number} range 情報をリセットします。


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

resetEffect()

SaveFileInfo

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

メソッド

プレイ時間

{number} getPlayTime()

Returns

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


経過ターン数

{number} getTurnCount()

Returns

{number} 難易度を取得します。


難易度

{Difficulty} getDifficulty()

Returns

{Difficulty} ゴールドを取得します。


ゴールド

{number} getGold()

Returns

{number} ボーナスを取得します。


ボーナス

{number} getBonus()

Returns

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


SceneType値

{number} getSceneType()

Returns

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


マップ情報

{MapData} getMapInfo()

Returns

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


真偽値

{boolean} isCompleteFile()

Returns

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


カスタムパラメータ

{object} custom()

Returns

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


ClippingArea

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

メソッド

x座標

{number} getClippingX()

Returns

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


y座標

{number} getClippingY()

Returns

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


{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 1を設定します。

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


始点

setFontStyle(start, end, style)

Parameters

{number} start 終点

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

{number} style 指定範囲に打ち消し線を設定します。


始点

setStrikethrough(start, end)

Parameters

{number} start 終点

{number} end 指定範囲に下線を設定します。


始点

setUnderline(start, end)

Parameters

{number} start 終点

{number} end 整形済みテキストを描画します。


x座標

drawFormattedText(x, y, color, alpha)

Parameters

{number} x y座標

{number} y 色

{number} color 不透明度

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


GraphicsCanvas

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

メソッド

GraphicsGradientオブジェクト

{GraphicsGradient} createGradient()

Returns

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


GraphicsFigureオブジェクト

{GraphicsFigure} createFigure()

Returns

{GraphicsFigure} 四角形を描画します。


x座標

drawRectangle(x, y, nWidth, nHeight)

Parameters

{number} x y座標

{number} y 幅

{number} nWidth 高さ

{number} nHeight 角丸四角形を描画します。


x座標

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

Parameters

{number} x y座標

{number} y 幅

{number} nWidth 高さ

{number} nHeight 1/4のX半径

{number} radiusX 1/4のY半径

{number} radiusY 楕円を描画します。


x座標

drawEllipse(x, y, nWidth, nHeight)

Parameters

{number} x y座標

{number} y 幅

{number} nWidth 高さ

{number} nHeight 直線を描画します。


始点のx座標

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

Parameters

{number} x1 始点のy座標

{number} y1 終点のx座標

{number} x2 終点のy座標

{number} y2 直線のサイズ

{number} weight 図形を描画します。


x座標

drawFigure(x, y, figure)

Parameters

{number} x y座標

{number} y GraphicsFigureオブジェクト

{GraphicsFigure} figure 輪郭の情報を設定します。


setStrokeInfo(nColor, nAlpha, weight, isStrokeFirst)

Parameters

{number} nColor アルファ値

{number} nAlpha 輪郭のサイズ

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

{boolean} isStrokeFirst 内部の色を設定します。


setFillColor(nColor, nAlpha)

Parameters

{number} nColor アルファ値

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


GraphicsGradientオブジェクト

setGradient(gradient)

Parameters

{GraphicsGradient} gradient 拡大率を設定します。既定値は100です。


拡大率

setScale(scale)

Parameters

{number} scale 回転率を設定します。既定値は0です。


回転率

setDegree(degree)

Parameters

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


GraphicsFigure

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

メソッド

始点のx座標

beginFigure(x, y)

Parameters

{number} x 始点のy座標

{number} y 図形の構成を終了します。


直線を追加します。

endFigure()

終点のx座標

addLine(x, y)

Parameters

{number} x 終点のy座標

{number} y ベジェ曲線を追加します。


最初の制御点のx座標

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

Parameters

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

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

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

{number} y2 終点のx座標

{number} x3 終点のy座標

{number} y3 弧を追加します。


終点のx座標

addArc(x1, y1, radiusX, radiusY)

Parameters

{number} x1 終点のy座標

{number} y1 弧のx半径

{number} radiusX 弧のy半径

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


GraphicsGradient

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

メソッド

GradientType値

beginGradient(type)

Parameters

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


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

endGradient()

addColor(color, alpha)

Parameters

{number} color アルファ値

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


GraphicsDecoration

装飾を開始します。

メソッド

装飾を終了します。

beginDecoration()

hp描画を追加します。

endDecoration()

x座標

addHp(x, y, colorIndex)

Parameters

{number} x y座標

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

{number} colorIndex ゲージ描画を追加します。


x座標

addGauge(x, y, nCount)

Parameters

{number} x y座標

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

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


x座標

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

Parameters

{number} x y座標

{number} y 描画元のx座標

{number} xSrc 描画元のy座標

{number} ySrc 幅

{number} width 高さ

{number} height Imageオブジェクト

{Image} img 四角形の描画を追加します。


x座標

addRectangle(x, y, width, height)

Parameters

{number} x y座標

{number} y 幅

{number} width 高さ

{number} height 角丸四角形の描画を追加します。


x座標

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

Parameters

{number} x y座標

{number} y 幅

{number} width 高さ

{number} height 1/4のX半径

{number} radiusX 1/4のY半径

{number} radiusY 楕円の描画を追加します。


x座標

addEllipse(x, y, width, height)

Parameters

{number} x y座標

{number} y 幅

{number} width 高さ

{number} height 直線の描画を追加します。


始点のx座標

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

Parameters

{number} x 始点のy座標

{number} y 終点のx座標

{number} x2 終点のy座標

{number} y2 直線のサイズ

{number} weight 輪郭の情報を設定します。


setStrokeInfo(nColor, nAlpha, weight, isStrokeFirst)

Parameters

{number} nColor アルファ値

{number} nAlpha 輪郭のサイズ

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

{boolean} isStrokeFirst 内部の色を設定します。


setFillColor(nColor, nAlpha)

Parameters

{number} nColor アルファ値

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


x座標

setLargeSize(x, y, width, height)

Parameters

{number} x y座標

{number} y 幅

{number} width 高さ

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


BacklogCommand

テキストを取得します。

メソッド

テキスト

{string} getText()

Returns

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


MessagePos値

{number} getTextPosValue()

Returns

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


SpeakerType値

{number} getSpeakerType()

Returns

{number} ユニットを取得します。


ユニット

{Unit} getUnit()

Returns

{Unit} NPCを取得します。


NPC

{Npc} getNpc()

Returns

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


表情ID

{number} getFacialExpressionId()

Returns

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


CommandType値

{number} getCommandType()

Returns

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


MapSimulator

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

メソッド

ユニット

startSimulation(unit, moveMaxCount)

Parameters

{Unit} unit 検索する広さの値

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


x座標

startSimulationRange(x, y, startRange, endRange)

Parameters

{number} x y座標

{number} y 開始位置

{number} startRange 終了位置

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


ユニット

startSimulationWeapon(unit, moveMaxCount, startRange, endRange)

Parameters

{Unit} unit 検索する広さの値

{number} moveMaxCount 武器の開始射程

{number} startRange 武器の終了射程

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


UnitFilterFlag値

startSimulationWeaponAll(unitFilter)

Parameters

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


ユニット

startSimulationWeaponPlus(unit)

Parameters

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


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

disableMapUnit()

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

disableTerrain()

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

disableRestrictedPass()

配列

{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 DirectionType値

Returns

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


インデックス

{boolean} isSimulationMark(mapIndex)

Parameters

{number} mapIndex 真偽値

Returns

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


インデックス

setSimulationMark(mapIndex, flag)

Parameters

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

{boolean} flag 設定したマークを全て解除します。


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

resetSimulationMark()

ループ数

{number} getLoopCount()

Returns

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


ループインデックス

{number} getMovePointFromLoopIndex(loopIndex)

Parameters

{number} loopIndex 移動ポイント

Returns

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


ループインデックス

{number} getPosIndexFromLoopIndex(loopIndex)

Parameters

{number} loopIndex 位置インデックス

Returns

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


検索値

getAreaValue()