このページをGitHubで編集する

Class: MV.PluginSettings

Type: Object

データベース JSファイル 大域変数
プラグイン plugins.js $plugins (配列)

プラグイン管理用のパラメータ。plugins.js は dataフォルダではなく jsフォルダにある。

プラグインに書かれるパラメータ設定の解説もここに書く。

関連クラス: PluginManager, JsonEx

Properties:

Name Type Description
name String プラグインの[名前](拡張子を含まない)
status String ON/OFF の[状態]
description String [説明]
parameters Object [パラメータ](PluginManager.parameters() の返り値になる)

[パラメータ]

{ "名前": "値", … }のようにプラグインパラメータの[名前]と[値]を組み合わせ、パラメータの数だけ並べたオブジェクト。

値は常に String なので、パラメータの値として文字列以外を指定していた場合、プラグイン個々で構文解析(パース)や型変換(キャスト)をする必要がある。
その際に便利な JsonEx.parse() が用意されている。

以下でプラグインファイルのコメント文でのパラメータ設定を解説している。

プラグインファイルの設定

プラグインファイルのコメント( /*: */ )に書かれるプラグインの設定。
頭の方に言語コード( 日本語の場合 /*:ja )を書くと、言語ごとに別の設定が用意できる。
以下で説明する @ではじまる宣言はディレクティブとも呼ばれる。

※ @があるとディレクティブと判断されてしまうため、全ての設定値に@は使用できない。

プラグイン全体の設定

@plugindesc

[説明]に表示される文字列。

@author

[作者]に表示される文字列。

@help

[ヘルプ]に表示される文字列。次の行から別のディレクティブが書かれるまで記述可能。

@requiredAssets

デプロイメントを実行するときに[未使用ファイルを含まない]にチェックしていた場合。
これでファイルを指定すれば削除されない。

Example
 * @requiredAssets img/example/image_1

パラメータ毎の設定

@param

パラメータ識別子。省略不可。パラメータ毎の設定の先頭に置くこと。
空白文字も使えるが、プラグイン側で値を取り出す時に parameters["param with space "] 形式しか使えず parameters.param with space と書いても正しく認識されないことに注意。

@text

パラメータの[名前](規定値: @param の値) 大体は @param の日本語名。

@desc

パラメータの[説明]に表示される文字列(規定値: 空文字列) 複数行書ける。規定値など書いておくと良い。

@default

規定値(デフォルト)(規定値: 空文字列)

@parent

パラメータをグループ分けする際に小パラメータから親を @param の識別子で指定。
プラグイン側では子の @param 識別子のみで指定し、親の @param 識別子は無視される。
通常、親に指定されるパラメータは値を持たないが、持たせることもできる。
データに親子関係を持たせたい場合、@type *[]@type struct<*>を検討しても良い。

Example
 * @param group
 * @text --- グループ名 ---
 *
 * @param childData
 * @parent group

@type (ver1.5.0 以降)

パラメータの型(詳細は後述)
入力時のUIが型に合わせて変わるが、プラグインに渡される値は全て文字列。

@type

@type string

文字列。規定値なので指定する必要はないが、明示しておいた方が誤解がなくて良い。

Example
 * @param stringData
 * @text 文字列型
 * @desc パラメータ文字列の説明(規定値: こんにちは)
 * @type string
 * @default こんにちは

@type number

数値。数個から選ぶ場合は @type select を使った方が良いかもしれない。
なぜか[アイコンセットビューア]が出なくなる(バージョン1.6.2で確認)ので、タブで[テキスト]に切り替えた後、コンテクストメニューから指定する必要がある。アイコンIDを指定する場合には使わない方が良いかもしれない。
プラグイン側で受け取るのは文字列なので、parseInt()parseFloat() を使って型変換(キャスト)を行うといい。

Name Description
@min 最小値( 規定値 : 0 ) (下限 -9007199254740992 )
@max 最大値 (上限 9007199254740992 )
@decimals 小数点以下桁数( 規定値 : 0 )
Example
 * @param numberData
 * @text 数値型
 * @desc パラメータ数値の説明(規定値: 10.0)
 * @type number
 * @min -100
 * @max 100
 * @decimals 1
 * @default 10.0

@type boolean

真偽値。

Name Description
@on ON の説明
@off OFF の説明
Example
 * @param booleanData
 * @text 論理型
 * @desc パラメータ真偽値の説明(規定値: 無視)
 * @type boolean
 * @on 実行する
 * @off 無視
 * @default false

@type *[]

配列( * の部分に任意のタイプを書く ) プラグイン側は JsonEx.parse() で解析する。
ちなみに[プラグイン管理]上で各項目はドラッグで入れ替え可能。

Example
 * @param arrayData
 * @text 配列型
 * @desc パラメータ配列の説明(規定値: ["甲", "乙", "丙"])
 * @type string[]
 * @default ["甲", "乙", "丙"]

@type struct<*>

データ構造( * の部分に構造名を書く ) プラグイン側は JsonEx.parse() で解析する。
構造の内容は別に以下のような記述をしておく。通常の型と同じ記述が可能。
多言語対応をする場合、例えば 構造名_ja というように言語ごとに異なる構造名にして、言語に合わせた構造を指定する。
@default の値は構造体側より本体の値が優先される。
構造名には _ などの記号は使えない。

Example
 * @param struct
 * @text 構造型
 * @desc パラメータ構造の説明(規定値: x:10, y:20)
 * @type struct<coordinateStruct>
 * @default { "x":"10", "y":"20" }
/*~struct~coordinateStruct:
 * @param x
 * @type number
 * @default 0
 * 
 * @param y
 * @type number
 * @default 0
 */

@type struct<*>[]

データ構造の配列。

Example
 * @param struct
 * @text 構造型
 * @desc パラメータ配列・構造の説明。
 * @type struct<coordinateStruct>[]
 * @default [{ "x":"10", "y":"20" }, { "x":"0", "y":"0" }]

@type file

img か audio フォルダ以下のファイル(拡張子を含まない)
@default にはフォルダだけの指定、あるいはファイルだけ、または両方を指定できる。
なお指定できるフォルダは2階層まで。

Name Description
@dir 参照フォルダ( 前後の/は不要 ) 値としては返らない
@require 1 を設定するとデプロイメントの際[未使用ファイルを含まない]のチェックされた時も、選択したファイルを削除しない
Example
 * @param file
 * @text ファイル
 * @desc ファイルの説明(規定値: Actor2)
 * @type file
 * @dir img/characters
 * @require 1
 * @default Actor2

@type select

セレクトボックスの選択肢から選択。
@default には @value の設定がある場合は @value の値を指定。ない場合は @option の値を指定する。

Name Description
@option 選択肢(必要な数並べる)
@value @option選択時にプラグインに渡す値(規定値 : @optionそのまま)
Example
 * @param selectBox
 * @text セレクトボックス
 * @desc オプションの説明(規定値: 左方向)
 * @type select
 * @option 左方向
 * @value 4
 * @option 右方向
 * @value 6
 * @default 4

@type combo

コンボボックス。文字列の入力、または選択肢から選択。
@type select と異なり @value の指定はできない。

Name Description
@option 選択肢(必要な数並べる)
Example
 * @param combo
 * @text コンボボックス
 * @desc 編集可能オプションの説明(規定値: red)
 * @type combo
 * @option red
 * @option blue
 * @default red

@type note

複数行の文字列が記入できる形式。改行もできる。
プラグインにはJSON文字列化(具体的には " や \のエスケープ、改行の \n への変換)して渡される。
改行が必要なデータ、JSON形式のデータを直接書く場合などに利用する。
@default の指定は他と異なり、ダブルクォーテーション( " )で囲う必要がある。

Example
 * @param note
 * @text ノート
 * @desc メモの説明。
 * @type note
 * @default "一行目\n二行目"

@type variable

変数(Game_Variables)のID( なし: 0 または 空文字列 )

Example
 * @param variableId
 * @text 変数ID
 * @desc 変数の説明(規定値: 1)
 * @type variable
 * @default 1

@type switch

スイッチ(Game_Switches)のID( なし: 0 または 空文字列 )

Example
 * @param switchId
 * @text スイッチID
 * @desc スイッチの説明(規定値: 1)
 * @type switch
 * @default 1

@type actor

アクター(RPG.Actor)のID( なし: 0 または 空文字列 )

Example
 * @param actorId
 * @text アクターID
 * @desc アクターの説明(規定値: 0)
 * @type actor
 * @default 0

@type class

職業(RPG.Class)のID( なし: 0 または 空文字列 )

Example
 * @param classId
 * @text クラスID
 * @desc クラスの説明(規定値: 0)
 * @type class
 * @default 0

@type skill

スキル(RPG.Skill)のID( なし: 0 または 空文字列 )

Example
 * @param skillId
 * @text スキルID
 * @desc スキルの説明(規定値: 0)
 * @type skill
 * @default 0

@type item

アイテム(RPG.Item)のID( なし: 0 または 空文字列 )

Example
 * @param itemId
 * @text アイテムID
 * @desc アイテムの説明(規定値: 0)
 * @type item
 * @default 0

@type weapon

武器(RPG.Weapon)のID( なし: 0 または 空文字列 )

Example
 * @param weaponId
 * @text 武器 ID
 * @desc 武器の説明(規定値: 0)
 * @type weapon
 * @default 0

@type armor

防具(RPG.Armor)のID( なし: 0 または 空文字列 )

Example
 * @param armorId
 * @text 防具ID
 * @desc 防具の説明(規定値: 0)
 * @type armor
 * @default 0

@type enemy

敵キャラ(RPG.Enemy)のID( なし: 0 または 空文字列 )

Example
 * @param enemyId
 * @text 敵キャラID
 * @desc 敵キャラの説明(規定値: 0)
 * @type enemy
 * @default 0

@type troop

敵グループ(RPG.Troop)のID( なし: 0 または 空文字列 )

Example
 * @param troopId
 * @text 敵グループID
 * @desc 敵グループの説明(規定値: 0)
 * @type troop
 * @default 0

@type state

ステート(RPG.State)のID( なし: 0 または 空文字列 )

Example
 * @param stateId
 * @text ステートID
 * @desc ステートの説明(規定値: 0)
 * @type state
 * @default 0

@type animation

アニメーション(RPG.Animation)のID( なし: 0 または 空文字列 )

Name Description
@require 1 を設定すると、選択したファイルを削除しない
Example
 * @param animationId
 * @text アニメーションID
 * @desc アニメーションの説明(規定値: 0)
 * @type animation
 * @require 1
 * @default 0

@type tileset

タイルセット(RPG.Tileset)のID( なし: 0 または 空文字列 )

Example
 * @param tilesetId
 * @text タイルセットID
 * @desc タイルセットの説明(規定値: 0)
 * @type tileset
 * @default 0

@type common_event

コモンイベント(RPG.CommonEvent)のID( なし: 0 または 空文字列 )

Example
 * @param commonEventId
 * @type common_event
 * @text コモンイベントID
 * @desc コモンイベントの説明(規定値: 0)
 * @default 0

ファイルを扱うメモタグの設定

[メモ]のメタタグの値としてファイルを使う場合、そのファイルが。 デプロイメントを実行するときに[未使用ファイルを含まない]にチェックしていた場合。
以下のタグを指定すれば削除されない。

Name Description
@noteParam タグ名
@noteRequire 1 を設定するとデプロイメントの際[未使用ファイルを含まない]のチェックされた時も、選択したファイルを削除しない
@noteDir ファイルがあるディレクトリ
@noteType データに合わせて、file か animation を指定
@noteData メモを利用するオブジェクトを maps, events, actors, classes, skills, items, weapons, armors, enemies, states, tilesets から指定
Example

アイテムのメモの内容が

<sampleImage:img1>

の場合。

 * @noteParam sampleImage
 * @noteRequire 1
 * @noteDir img/sample/
 * @noteType file
 * @noteData items
Menu

  • RPGツクールMV JavaScript 非公式リファレンス
  • Class: Array
  • Class: AudioManager
  • Class: BattleManager
  • Class: Bitmap
  • Class: CacheEntry
  • Class: CacheMap
  • Class: ConfigManager
  • Class: DataManager
  • Class: Decrypter
  • Class: Game_Action
  • Class: Game_ActionResult
  • Class: Game_Actor
  • Class: Game_Actors
  • Class: Game_Battler
  • Class: Game_BattlerBase
  • Class: Game_Character
  • Class: Game_CharacterBase
  • Class: Game_CommonEvent
  • Class: Game_Enemy
  • Class: Game_Event
  • Class: Game_Follower
  • Class: Game_Followers
  • Class: Game_Interpreter
  • Class: Game_Item
  • Class: Game_Map
  • Class: Game_Message
  • Class: Game_Party
  • Class: Game_Picture
  • Class: Game_Player
  • Class: Game_Screen
  • Class: Game_SelfSwitches
  • Class: Game_Switches
  • Class: Game_System
  • Class: Game_Temp
  • Class: Game_Timer
  • Class: Game_Troop
  • Class: Game_Unit
  • Class: Game_Variables
  • Class: Game_Vehicle
  • Class: Graphics
  • Class: Html5Audio
  • Class: ImageCache
  • Class: ImageManager
  • Class: Input
  • Class: JsonEx
  • Class: MV.AudioParameters
  • Class: MV.BattleLogMethod
  • Class: MV.BattleRewards
  • Class: MV.BattlerAnimation
  • Class: MV.Color
  • Class: MV.CommandItem
  • Class: MV.ConfigData
  • Class: MV.CssColor
  • Class: MV.DatabaseFile
  • Class: MV.Matrix
  • Class: MV.Motion
  • Class: MV.PluginSettings
  • Class: MV.SaveContents
  • Class: MV.SaveFileInfo
  • Class: MV.TextState
  • Class: MV.Tone
  • Class: MV.TouchInputEvents
  • Namespace: MV
  • Class: Math
  • Class: Number
  • Class: PIXI.Container
  • Class: PIXI.DisplayObject
  • Class: PIXI.Graphics
  • Class: PIXI.Renderer
  • Class: PIXI.Sprite
  • Class: PluginManager
  • Class: Point
  • Class: RPG.Actor
  • Class: RPG.Animation.Timing
  • Class: RPG.Animation
  • Class: RPG.Armor
  • Class: RPG.AudioFile
  • Class: RPG.BaseItem
  • Class: RPG.BattleEventPage.Conditions
  • Class: RPG.BattleEventPage
  • Class: RPG.Class.Learning
  • Class: RPG.Class
  • Class: RPG.CommonEvent
  • Class: RPG.Damage
  • Class: RPG.Effect
  • Class: RPG.Enemy.Action
  • Class: RPG.Enemy.DropItem
  • Class: RPG.Enemy
  • Class: RPG.EquipItem
  • Class: RPG.Event
  • Class: RPG.EventCommand
  • Class: RPG.EventPage.Conditions
  • Class: RPG.EventPage.Image
  • Class: RPG.EventPage
  • Class: RPG.Item
  • Class: RPG.Map.Encounter
  • Class: RPG.Map
  • Class: RPG.MapInfo
  • Class: RPG.MetaData
  • Class: RPG.MoveCommand
  • Class: RPG.MoveRoute
  • Class: RPG.Skill
  • Class: RPG.State
  • Class: RPG.System.AttackMotion
  • Class: RPG.System.Terms
  • Class: RPG.System.TestBattler
  • Class: RPG.System.Vehicle
  • Class: RPG.System
  • Class: RPG.Tileset
  • Class: RPG.Trait
  • Class: RPG.Troop.Member
  • Class: RPG.Troop
  • Class: RPG.UsableItem
  • Class: RPG.Weapon
  • Namespace: RPG
  • Class: Rectangle
  • Class: RequestQueue
  • Class: ResourceHandler
  • Class: SceneManager
  • Class: Scene_Base
  • Class: Scene_Battle
  • Class: Scene_Boot
  • Class: Scene_Debug
  • Class: Scene_Equip
  • Class: Scene_File
  • Class: Scene_GameEnd
  • Class: Scene_Gameover
  • Class: Scene_Item
  • Class: Scene_ItemBase
  • Class: Scene_Load
  • Class: Scene_Map
  • Class: Scene_Menu
  • Class: Scene_MenuBase
  • Class: Scene_Name
  • Class: Scene_Options
  • Class: Scene_Save
  • Class: Scene_Shop
  • Class: Scene_Skill
  • Class: Scene_Status
  • Class: Scene_Title
  • Class: ScreenSprite
  • Class: ShaderTilemap
  • Class: SoundManager
  • Class: Sprite
  • Class: Sprite_Actor
  • Class: Sprite_Animation
  • Class: Sprite_Balloon
  • Class: Sprite_Base
  • Class: Sprite_Battler
  • Class: Sprite_Button
  • Class: Sprite_Character
  • Class: Sprite_Damage
  • Class: Sprite_Destination
  • Class: Sprite_Enemy
  • Class: Sprite_Picture
  • Class: Sprite_StateIcon
  • Class: Sprite_StateOverlay
  • Class: Sprite_Timer
  • Class: Sprite_Weapon
  • Class: Spriteset_Base
  • Class: Spriteset_Battle
  • Class: Spriteset_Map
  • Class: Stage
  • Class: StorageManager
  • Class: String
  • Class: TextManager
  • Class: Tilemap
  • Class: TilingSprite
  • Class: ToneFilter
  • Class: ToneSprite
  • Class: TouchInput
  • Class: Utils
  • Class: Weather
  • Class: WebAudio
  • Class: Window
  • Class: WindowLayer
  • Class: Window_ActorCommand
  • Class: Window_Base
  • Class: Window_BattleActor
  • Class: Window_BattleEnemy
  • Class: Window_BattleItem
  • Class: Window_BattleLog
  • Class: Window_BattleSkill
  • Class: Window_BattleStatus
  • Class: Window_ChoiceList
  • Class: Window_Command
  • Class: Window_DebugEdit
  • Class: Window_DebugRange
  • Class: Window_EquipCommand
  • Class: Window_EquipItem
  • Class: Window_EquipSlot
  • Class: Window_EquipStatus
  • Class: Window_EventItem
  • Class: Window_GameEnd
  • Class: Window_Gold
  • Class: Window_Help
  • Class: Window_HorzCommand
  • Class: Window_ItemCategory
  • Class: Window_ItemList
  • Class: Window_MapName
  • Class: Window_MenuActor
  • Class: Window_MenuCommand
  • Class: Window_MenuStatus
  • Class: Window_Message
  • Class: Window_NameEdit
  • Class: Window_NameInput
  • Class: Window_NumberInput
  • Class: Window_Options
  • Class: Window_PartyCommand
  • Class: Window_SavefileList
  • Class: Window_ScrollText
  • Class: Window_Selectable
  • Class: Window_ShopBuy
  • Class: Window_ShopCommand
  • Class: Window_ShopNumber
  • Class: Window_ShopSell
  • Class: Window_ShopStatus
  • Class: Window_SkillList
  • Class: Window_SkillStatus
  • Class: Window_SkillType
  • Class: Window_Status
  • Class: Window_TitleCommand
  • Global
  • クラスツリー