├── .gitignore
├── LICENSE
├── README.md
├── docs
├── _includes
│ ├── meta.html
│ └── nav.html
├── _layouts
│ └── default.html
├── index.md
└── jsdoc
│ ├── Array.md
│ ├── AudioManager.md
│ ├── BattleManager.md
│ ├── Bitmap.md
│ ├── CacheEntry.md
│ ├── CacheMap.md
│ ├── ConfigManager.md
│ ├── DataManager.md
│ ├── Decrypter.md
│ ├── Game_Action.md
│ ├── Game_ActionResult.md
│ ├── Game_Actor.md
│ ├── Game_Actors.md
│ ├── Game_Battler.md
│ ├── Game_BattlerBase.md
│ ├── Game_Character.md
│ ├── Game_CharacterBase.md
│ ├── Game_CommonEvent.md
│ ├── Game_Enemy.md
│ ├── Game_Event.md
│ ├── Game_Follower.md
│ ├── Game_Followers.md
│ ├── Game_Interpreter.md
│ ├── Game_Item.md
│ ├── Game_Map.md
│ ├── Game_Message.md
│ ├── Game_Party.md
│ ├── Game_Picture.md
│ ├── Game_Player.md
│ ├── Game_Screen.md
│ ├── Game_SelfSwitches.md
│ ├── Game_Switches.md
│ ├── Game_System.md
│ ├── Game_Temp.md
│ ├── Game_Timer.md
│ ├── Game_Troop.md
│ ├── Game_Unit.md
│ ├── Game_Variables.md
│ ├── Game_Vehicle.md
│ ├── Graphics.md
│ ├── Html5Audio.md
│ ├── ImageCache.md
│ ├── ImageManager.md
│ ├── Input.md
│ ├── JsonEx.md
│ ├── MV.AudioParameters.md
│ ├── MV.BattleLogMethod.md
│ ├── MV.BattleRewards.md
│ ├── MV.BattlerAnimation.md
│ ├── MV.Color.md
│ ├── MV.CommandItem.md
│ ├── MV.ConfigData.md
│ ├── MV.CssColor.md
│ ├── MV.DatabaseFile.md
│ ├── MV.Matrix.md
│ ├── MV.Motion.md
│ ├── MV.PluginSettings.md
│ ├── MV.SaveContents.md
│ ├── MV.SaveFileInfo.md
│ ├── MV.TextState.md
│ ├── MV.Tone.md
│ ├── MV.TouchInputEvents.md
│ ├── MV.md
│ ├── Math.md
│ ├── Number.md
│ ├── PIXI.Container.md
│ ├── PIXI.DisplayObject.md
│ ├── PIXI.Graphics.md
│ ├── PIXI.Renderer.md
│ ├── PIXI.Sprite.md
│ ├── PluginManager.md
│ ├── Point.md
│ ├── RPG.Actor.md
│ ├── RPG.Animation.Timing.md
│ ├── RPG.Animation.md
│ ├── RPG.Armor.md
│ ├── RPG.AudioFile.md
│ ├── RPG.BaseItem.md
│ ├── RPG.BattleEventPage.Conditions.md
│ ├── RPG.BattleEventPage.md
│ ├── RPG.Class.Learning.md
│ ├── RPG.Class.md
│ ├── RPG.CommonEvent.md
│ ├── RPG.Damage.md
│ ├── RPG.Effect.md
│ ├── RPG.Enemy.Action.md
│ ├── RPG.Enemy.DropItem.md
│ ├── RPG.Enemy.md
│ ├── RPG.EquipItem.md
│ ├── RPG.Event.md
│ ├── RPG.EventCommand.md
│ ├── RPG.EventPage.Conditions.md
│ ├── RPG.EventPage.Image.md
│ ├── RPG.EventPage.md
│ ├── RPG.Item.md
│ ├── RPG.Map.Encounter.md
│ ├── RPG.Map.md
│ ├── RPG.MapInfo.md
│ ├── RPG.MetaData.md
│ ├── RPG.MoveCommand.md
│ ├── RPG.MoveRoute.md
│ ├── RPG.Skill.md
│ ├── RPG.State.md
│ ├── RPG.System.AttackMotion.md
│ ├── RPG.System.Terms.md
│ ├── RPG.System.TestBattler.md
│ ├── RPG.System.Vehicle.md
│ ├── RPG.System.md
│ ├── RPG.Tileset.md
│ ├── RPG.Trait.md
│ ├── RPG.Troop.Member.md
│ ├── RPG.Troop.md
│ ├── RPG.UsableItem.md
│ ├── RPG.Weapon.md
│ ├── RPG.md
│ ├── Rectangle.md
│ ├── RequestQueue.md
│ ├── ResourceHandler.md
│ ├── SceneManager.md
│ ├── Scene_Base.md
│ ├── Scene_Battle.md
│ ├── Scene_Boot.md
│ ├── Scene_Debug.md
│ ├── Scene_Equip.md
│ ├── Scene_File.md
│ ├── Scene_GameEnd.md
│ ├── Scene_Gameover.md
│ ├── Scene_Item.md
│ ├── Scene_ItemBase.md
│ ├── Scene_Load.md
│ ├── Scene_Map.md
│ ├── Scene_Menu.md
│ ├── Scene_MenuBase.md
│ ├── Scene_Name.md
│ ├── Scene_Options.md
│ ├── Scene_Save.md
│ ├── Scene_Shop.md
│ ├── Scene_Skill.md
│ ├── Scene_Status.md
│ ├── Scene_Title.md
│ ├── ScreenSprite.md
│ ├── ShaderTilemap.md
│ ├── SoundManager.md
│ ├── Sprite.md
│ ├── Sprite_Actor.md
│ ├── Sprite_Animation.md
│ ├── Sprite_Balloon.md
│ ├── Sprite_Base.md
│ ├── Sprite_Battler.md
│ ├── Sprite_Button.md
│ ├── Sprite_Character.md
│ ├── Sprite_Damage.md
│ ├── Sprite_Destination.md
│ ├── Sprite_Enemy.md
│ ├── Sprite_Picture.md
│ ├── Sprite_StateIcon.md
│ ├── Sprite_StateOverlay.md
│ ├── Sprite_Timer.md
│ ├── Sprite_Weapon.md
│ ├── Spriteset_Base.md
│ ├── Spriteset_Battle.md
│ ├── Spriteset_Map.md
│ ├── Stage.md
│ ├── StorageManager.md
│ ├── String.md
│ ├── TextManager.md
│ ├── Tilemap.md
│ ├── TilingSprite.md
│ ├── ToneFilter.md
│ ├── ToneSprite.md
│ ├── TouchInput.md
│ ├── Utils.md
│ ├── Weather.md
│ ├── WebAudio.md
│ ├── Window.md
│ ├── WindowLayer.md
│ ├── Window_ActorCommand.md
│ ├── Window_Base.md
│ ├── Window_BattleActor.md
│ ├── Window_BattleEnemy.md
│ ├── Window_BattleItem.md
│ ├── Window_BattleLog.md
│ ├── Window_BattleSkill.md
│ ├── Window_BattleStatus.md
│ ├── Window_ChoiceList.md
│ ├── Window_Command.md
│ ├── Window_DebugEdit.md
│ ├── Window_DebugRange.md
│ ├── Window_EquipCommand.md
│ ├── Window_EquipItem.md
│ ├── Window_EquipSlot.md
│ ├── Window_EquipStatus.md
│ ├── Window_EventItem.md
│ ├── Window_GameEnd.md
│ ├── Window_Gold.md
│ ├── Window_Help.md
│ ├── Window_HorzCommand.md
│ ├── Window_ItemCategory.md
│ ├── Window_ItemList.md
│ ├── Window_MapName.md
│ ├── Window_MenuActor.md
│ ├── Window_MenuCommand.md
│ ├── Window_MenuStatus.md
│ ├── Window_Message.md
│ ├── Window_NameEdit.md
│ ├── Window_NameInput.md
│ ├── Window_NumberInput.md
│ ├── Window_Options.md
│ ├── Window_PartyCommand.md
│ ├── Window_SavefileList.md
│ ├── Window_ScrollText.md
│ ├── Window_Selectable.md
│ ├── Window_ShopBuy.md
│ ├── Window_ShopCommand.md
│ ├── Window_ShopNumber.md
│ ├── Window_ShopSell.md
│ ├── Window_ShopStatus.md
│ ├── Window_SkillList.md
│ ├── Window_SkillStatus.md
│ ├── Window_SkillType.md
│ ├── Window_Status.md
│ ├── Window_TitleCommand.md
│ ├── global.md
│ └── index.md
├── format.js
├── jsdocFIles
├── README.md
├── gulpfile.js
├── jsdoc.conf.json
└── jsdoc.layout.tmpl
├── package-lock.json
└── package.json
/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 | yarn-debug.log*
6 | yarn-error.log*
7 |
8 | # Runtime data
9 | pids
10 | *.pid
11 | *.seed
12 | *.pid.lock
13 |
14 | # Directory for instrumented libs generated by jscoverage/JSCover
15 | lib-cov
16 |
17 | # Coverage directory used by tools like istanbul
18 | coverage
19 |
20 | # nyc test coverage
21 | .nyc_output
22 |
23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24 | .grunt
25 |
26 | # Bower dependency directory (https://bower.io/)
27 | bower_components
28 |
29 | # node-waf configuration
30 | .lock-wscript
31 |
32 | # Compiled binary addons (https://nodejs.org/api/addons.html)
33 | build/Release
34 |
35 | # Dependency directories
36 | node_modules/
37 | jspm_packages/
38 |
39 | # TypeScript v1 declaration files
40 | typings/
41 |
42 | # Optional npm cache directory
43 | .npm
44 |
45 | # Optional eslint cache
46 | .eslintcache
47 |
48 | # Optional REPL history
49 | .node_repl_history
50 |
51 | # Output of 'npm pack'
52 | *.tgz
53 |
54 | # Yarn Integrity file
55 | .yarn-integrity
56 |
57 | # dotenv environment variables file
58 | .env
59 |
60 | # next.js build output
61 | .next
62 |
63 | # mac local directory info
64 | .DS_Store
65 |
66 | # オリジナル
67 | _jsdoc
68 | src
69 | _site
70 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2018 はどはど / Hadhad / Had2Apps
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # [リファレンスページ はこちら](https://katai5plate.github.io/RPGMV-CoreScript-Reference/)
2 |
3 | # このプロジェクトについて
4 |
5 | - [rpgtkoolmv/corescript](https://github.com/rpgtkoolmv/corescript) で開発されている、[RPG ツクール MV](http://www.rpgmakerweb.com/products/programs/rpg-maker-mv)のコアスクリプトのリファレンスを作る非公式プロジェクトです。
6 | - コアスクリプトを JSDoc によりドキュメント生成したものを Markdown に変換したドキュメントを元に編集を行っていきます。
7 |
8 | # 編集について
9 |
10 | ## コントリビューターを募集中
11 |
12 | - このプロジェクトは始まったばかりです!ぜひ皆さんもご協力お願いします。
13 |
14 | ## 編集の基本方針
15 |
16 | - [`docs/jsdoc/`](https://github.com/katai5plate/RPGMV-CoreScript-Reference/tree/master/docs/jsdoc) を直接書き換える。
17 | - 相談が必要な内容の変更はブランチを分けて行い、切りのよいところで PullRequest を提出
18 | - PullRequest が問題なければ、 master ブランチにマージを行う
19 |
20 | ## 編集上の注意
21 |
22 | - GitHub-Pages 上のリファレンスページに対応するようにリンクの連携を行ってください。
23 | - GitHub-Pages での反映には数分~数十分時間がかかることがあります。
24 | - 編集後・マージ後は必ず[コミットログ](https://github.com/katai5plate/RPGMV-CoreScript-Reference/commits/master)を確認してください。:heavy_check_mark:のときは成功、:full_moon:は検証中、:x:のときは失敗です。失敗を直さないとずっと自動更新が止まり続ける可能性があります。
25 | - 絶対に`git reset --hard`しないでください。
26 |
27 | ## 編集する上で望ましいこと
28 |
29 | ### 基本
30 |
31 | - ジャイアントコミット(大きな変更を一気に行う)を避ける
32 | - 相談事や不具合報告はすべて[Issues](https://github.com/katai5plate/RPGMV-CoreScript-Reference/issues)にスレ立てする
33 | - 編集後、必ずコミットログと反映後のリファレンスページを確認して、問題がないことを確認する
34 |
35 | ### 上級
36 |
37 | - 大きな変更や一括変更を行う場合、ローカルに落として作業してブランチを分けてからプルリクを投げる。
38 | - ブランチ名は`feature/YYYYMMDD-this-is-branch-name`に従う
39 |
40 | ## 編集手順
41 |
42 | #### 通常の変更
43 |
44 | 0. GitHub アカウントを作る
45 | 1. [`docs/jsdoc/`](https://github.com/katai5plate/RPGMV-CoreScript-Reference/tree/master/docs/jsdoc) から編集するファイルを選ぶ
46 | 2. 右上にある鉛筆マークをクリック
47 | 3. エディタが開くので、編集作業を行う
48 | 4. 編集が終わったら一番下にある`Commit changes`を入力する
49 |
50 | - 上から1つ目の小さい入力欄は`編集内容を1行で表し`入力する
51 | - 上から2つ目の入力欄は`編集内容を詳しく説明し`入力する(省略可)
52 | - チェックボックスは`Commit directly to the master branch`を選ぶ
53 |
54 | 6. `Commit changes`を押して決定
55 |
56 | ### 相談が必要な内容の場合
57 |
58 | 0. GitHub アカウントを作る
59 | 1. [`docs/jsdoc/`](https://github.com/katai5plate/RPGMV-CoreScript-Reference/tree/master/docs/jsdoc) から編集するファイルを選ぶ
60 | 2. 右上にある鉛筆マークをクリック
61 | 3. エディタが開くので、編集作業を行う
62 | 4. 編集が終わったら一番下にある`Commit changes`を入力する
63 |
64 | - 上から1つ目の小さい入力欄は`編集内容を1行で表し`入力する
65 | - 上から2つ目の入力欄は`編集内容を詳しく説明し`入力する(省略可)
66 | - チェックボックスは`Create a new branch for this commit and start a pull request.`を選ぶ
67 |
68 | 5. `Will be created as`の横にある入力欄はデフォルトのままで OK
69 |
70 | - できれば、`feature/20181104-update-XXXX`のようにわかりやすいネーミングにするとより良い
71 |
72 | 6. `Propose file change`を押して決定
73 | 7. プルリクエスト登録画面が開くので、タイトルの入力欄に相談内容のタイトル、大きな入力欄に相談内容の詳細を入力
74 | 8. `Create pull request`をクリック
75 | 9. 管理者がマージするのを待つ
76 |
77 | ### (上級者向け)ファイルを一括で編集を行う場合
78 |
79 | 0. GitHub アカウントを作り、[Git をインストール](https://git-scm.com/)
80 | 1. コマンドプロンプトで `git clone https://github.com/katai5plate/RPGMV-CoreScript-Reference.git`
81 | 2. コマンドプロンプトのカレントディレクトリにファイルがダウンロードされるので、そこで直接ファイルを編集する
82 | 3. 編集を行う内容でブランチを作成する。`RPGMV-CoreScript-Reference`ディレクトリをカレントディレクトリにして、コマンドプロンプトから`git checkout -b "feature/YYYYMMDD-ブランチ名"`を入力。`YYYYMMDD`は 2018/11/04 なら 20181104 というように書く。`ブランチ名`は英数とハイフン区切りで編集内容を短く書く。例:`feature/20181104-update-XXXX-pages`
83 | 4. 編集を開始し、一段落終わったらちょくちょくコミット作業を行う
84 |
85 | - `RPGMV-CoreScript-Reference`ディレクトリをカレントディレクトリにして、コマンドプロンプトから`git add -A`を入力。すると変更がターゲティングされる。
86 | - つぎに`git commit -m "コミット内容"`を入力。`コミット内容`にここまでの変更内容を簡単に書く。
87 |
88 | 5. 作業中のブランチでの編集を終わらせたら、コミット作業を終えて、`RPGMV-CoreScript-Reference`ディレクトリをカレントディレクトリにしたコマンドプロンプトから`git push origin ブランチ名`を入力。ブランチ名は`3.`で入力したものと同じ。例:`git push origin feature/20181104-update-XXXX-pages`
89 | 6. 成功したら[ここにアクセス](https://github.com/katai5plate/RPGMV-CoreScript-Reference/compare)
90 | 7. `base:master`になっていることを確認し、`compare:`から自分のブランチを選ぶ。
91 | 8. プルリクエスト登録画面が開くので、タイトルの入力欄に相談内容のタイトル、大きな入力欄に相談内容の詳細を入力
92 | 9. `Create pull request`をクリック
93 | 10. 管理者がマージするのを待つ
94 |
--------------------------------------------------------------------------------
/docs/_includes/meta.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
{{page.title}}
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/_includes/nav.html:
--------------------------------------------------------------------------------
1 | {% for post in site.pages %}{% if post.title != "" %}{{post.title}}{% endif %}{% endfor %}
--------------------------------------------------------------------------------
/docs/_layouts/default.html:
--------------------------------------------------------------------------------
1 | {%- assign articleDir = "https://github.com/katai5plate/RPGMV-CoreScript-Reference/blob/master/docs/" -%}
2 |
3 |
4 |
5 | {% include meta.html %}
6 |
7 |
8 | このページをGitHubで編集する
9 |
10 | {{content}}
11 |
12 |
Menu
13 | {% include nav.html %}
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
1 | # RPG ツクール MV JavaScript 非公式リファレンス
2 |
3 | KADOKAWA から発売されている 'RPG ツクール MV' の JavaScript リファレンスです。
4 | 有志によって制作されているもので、オフィシャルなものではありません。
5 |
6 | ※Github にアカウント持ってる人は、お気軽に参加できます。Github ってなに?って人は見るだけにしておいた方が無難です。
7 |
8 | # [クラスツリー](jsdoc/)
9 |
--------------------------------------------------------------------------------
/docs/jsdoc/Array.md:
--------------------------------------------------------------------------------
1 | # Class: Array
2 |
3 | ### new Array ()
4 |
5 | JavaScript の配列にいくつか RPG ツクール MV 独自のメソッドが追加してある。
6 |
7 | 詳細は [MDN の Array のページ](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Array)を見てもらうとして。
8 | ここでは追加されたメソッドのみ解説。
9 |
10 | ### Methods
11 |
12 | #### clone () → {[Array](Array.md)}
13 |
14 | 配列を(シャロー)コピーして返す。
15 | 多分、標準の slice() を使った方がいい。
16 |
17 | #### contains (element) → {Boolean}
18 |
19 | 指定した値が配列に含まれるか。
20 | 多分、標準の includes()を使った方がいい。
21 |
22 | ##### Parameters:
23 |
24 | | Name | Type | Description |
25 | | --------- | ---- | ---------------- |
26 | | `element` | \* | 配列を検索する値 |
27 |
28 | #### equals (array) → {Boolean}
29 |
30 | 配列が同じものか。
31 |
32 | ##### Parameters:
33 |
34 | | Name | Type | Description |
35 | | ------- | ----------------- | ------------ |
36 | | `array` | [Array](Array.md) | 比較する配列 |
37 |
--------------------------------------------------------------------------------
/docs/jsdoc/CacheEntry.md:
--------------------------------------------------------------------------------
1 | # Class: CacheEntry
2 |
3 | ### new CacheEntry (cache, key, item)
4 |
5 | 画像・音声のデータを確保しておくクラス。バージョン 1.3.4 で追加された。
6 |
7 | TTL とは time to live の略で、ガベッジコレクション(データの破棄)されるまでの生存時間のこと。
8 |
9 | 関連クラス: [Bitmap](Bitmap.md), [HTML5Audio](HTML5Audio.md), [WebAudio](WebAudio.md)
10 |
11 | #### Parameters:
12 |
13 | | Name | Type | Description |
14 | | ------- | ----------------------- | ------------------------------------------------------------ |
15 | | `cache` | [CacheMap](CacheMap.md) | キャッシュマップ |
16 | | `key` | [String](String.md) | データ指定するキー(ファイルの URL) |
17 | | `item` | [String](String.md) | 保持しているデータの種類('Bitmap', 'HTML5Audio', 'WebAudio') |
18 |
19 | ### Properties:
20 |
21 | | Name | Type | Description |
22 | | -------------- | ----------------------- | ------------------------------------------------------------- |
23 | | `cache` | [CacheMap](CacheMap.md) | キャッシュマップ |
24 | | `cached` | Boolean | キャッシュされているか |
25 | | `freedByTTL` | Boolean | TTL で解放するか |
26 | | `key` | [String](String.md) | データ指定するキー(ファイルの URL) |
27 | | `item` | [String](String.md) | 保持しているデータの種類 ('Bitmap', 'HTML5Audio', 'WebAudio') |
28 | | `touchSeconds` | [Number](Number.md) | touch 時間 |
29 | | `touchTicks` | [Number](Number.md) | touch 時間 |
30 | | `ttlSeconds` | [Number](Number.md) | TTL (0: 設定なし) |
31 | | `ttlTicks` | [Number](Number.md) | TTL (0: 設定なし) |
32 |
33 | ### Methods
34 |
35 | #### allocate () → {[CacheEntry](CacheEntry.md)}
36 |
37 | リソースを割り当てて、自身を返す。
38 |
39 | #### free (byTTL opt)
40 |
41 | 割り当てたリソースを解放。
42 |
43 | ##### Parameters:
44 |
45 | | Name | Type | Attributes | Description |
46 | | ------- | ------- | ---------------- | ----------- |
47 | | `byTTL` | Boolean | <optional> | TTL か |
48 |
49 | #### isStillAlive () → {Boolean}
50 |
51 | 生存しているか。
52 |
53 | #### setTimeToLive (ticks opt, seconds opt) → {[CacheEntry](CacheEntry.md)}
54 |
55 | TTL を設定し、自身を返す。
56 |
57 | ##### Parameters:
58 |
59 | | Name | Type | Attributes | Description |
60 | | --------- | ------------------- | ---------------- | ----------- |
61 | | `ticks` | [Number](Number.md) | <optional> | TTL 0: 即時 |
62 | | `seconds` | [Number](Number.md) | <optional> | TTL 0: 即時 |
63 |
64 | #### touch ()
65 |
66 | 解放されていたらキャッシュマップに再追加するなど、キャッシュの延命。
67 |
--------------------------------------------------------------------------------
/docs/jsdoc/CacheMap.md:
--------------------------------------------------------------------------------
1 | # Class: CacheMap
2 |
3 | ### new CacheMap (manager)
4 |
5 | 画像や音声のキャッシュをまとめて扱うクラス。バージョン 1.3.4 で追加された。
6 |
7 | 関連クラス: [CacheEntry](CacheEntry.md), [Bitmap](Bitmap.md), [HTML5Audio](HTML5Audio.md), [WebAudio](WebAudio.md)
8 |
9 | #### Parameters:
10 |
11 | | Name | Type | Description |
12 | | --------- | ------------------------------- | ------------------ |
13 | | `manager` | [ImageManager](ImageManager.md) | 所属するマネージャ |
14 |
15 | ### Properties:
16 |
17 | | Name | Type | Description |
18 | | --------------------- | ---------------------------------------------------- | ------------------------------ |
19 | | `manager` | [ImageManager](ImageManager.md) | 所属するマネージャ |
20 | | `updateSeconds` | [Number](Number.md) | アップデート時間 |
21 | | `updateTicks` | [Number](Number.md) | アップデート時間 |
22 | | `lastCheckTTL` | [Number](Number.md) | 次の TTL |
23 | | `delayCheckTTL` | [Number](Number.md) | 遅延 TTL |
24 | | `_inner` | [Array](Array.md)<[CacheEntry](CacheEntry.md)> | CacheEntry の配列 |
25 | | `_lastRemovedEntries` | [Array](Array.md)<[CacheEntry](CacheEntry.md)> | 次に破棄する CacheEntry の配列 |
26 |
27 | ### Methods
28 |
29 | #### clear ()
30 |
31 | キャッシュのクリア。
32 |
33 | #### checkTTL ()
34 |
35 | TTL をチェックして、時間が過ぎている CacheEntry を解放。
36 |
37 | #### getItem (key) → {[String](String.md) | null}
38 |
39 | 指定キーのデータの種類を返す。
40 |
41 | ##### Parameters:
42 |
43 | | Name | Type | Description |
44 | | ----- | ------------------- | ---------------------------------- |
45 | | `key` | [String](String.md) | データ指定するキー(ファイルの URL) |
46 |
47 | #### setItem (key, item) → {[CacheEntry](CacheEntry.md)}
48 |
49 | 指定キーにデータの種類を設定した、CacheEntry を返す。
50 |
51 | ##### Parameters:
52 |
53 | | Name | Type | Description |
54 | | ------ | ------------------- | ------------------------------------------------------------ |
55 | | `key` | [String](String.md) | データ指定するキー(ファイルの URL) |
56 | | `item` | [String](String.md) | 保持しているデータの種類('Bitmap', 'HTML5Audio', 'WebAudio') |
57 |
58 | #### update (ticks, delta)
59 |
60 | アップデート。
61 |
62 | ##### Parameters:
63 |
64 | | Name | Type | Description |
65 | | ------- | ------------------- | ----------- |
66 | | `ticks` | [Number](Number.md) | 開始時刻 |
67 | | `delta` | [Number](Number.md) | 間隔 |
68 |
--------------------------------------------------------------------------------
/docs/jsdoc/ConfigManager.md:
--------------------------------------------------------------------------------
1 | # Class: ConfigManager
2 |
3 | [オプション]のデータを扱う、静的クラス。
4 |
5 | ### Properties:
6 |
7 | | Name | Type | Description |
8 | | ------------------ | ------------------- | ----------------------- |
9 | | `alwaysDash ` | Boolean | [static] [常時ダッシュ] |
10 | | `commandRemember ` | Boolean | [static] [コマンド記憶] |
11 | | `bgmVolume` | [Number](Number.md) | [static] [BGM 音量] |
12 | | `bgsVolume` | [Number](Number.md) | [static] [BGS 音量] |
13 | | `meVolume` | [Number](Number.md) | [static] [ME 音量] |
14 | | `seVolume` | [Number](Number.md) | [static] [SE 音量] |
15 |
16 | ### Methods
17 |
18 | #### (static) applyData (config)
19 |
20 | 指定オプションを適用。
21 |
22 | ##### Parameters:
23 |
24 | | Name | Type | Description |
25 | | -------- | --------------------------------- | ---------------- |
26 | | `config` | [MV.ConfigData](MV.ConfigData.md) | オプションデータ |
27 |
28 | #### (static) load ()
29 |
30 | オプションデータの読み込み。
31 |
32 | #### (static) makeData () → {[MV.ConfigData](MV.ConfigData.md)}
33 |
34 | オプションデータを生成して返す。
35 |
36 | #### (static) readFlag (config, name) → {Boolean}
37 |
38 | 指定オプションデータのフラグを返す。
39 |
40 | ##### Parameters:
41 |
42 | | Name | Type | Description |
43 | | -------- | --------------------------------- | ----------------------------------------- |
44 | | `config` | [MV.ConfigData](MV.ConfigData.md) | オプションデータ |
45 | | `name` | [String](String.md) | 設定名( 'alwaysDash', 'commandRemember' ) |
46 |
47 | #### (static) readVolume (config, name) → {[Number](Number.md)}
48 |
49 | 指定オプションデータの音量を返す。
50 |
51 | ##### Parameters:
52 |
53 | | Name | Type | Description |
54 | | -------- | --------------------------------- | ---------------------------------------------------------- |
55 | | `config` | [MV.ConfigData](MV.ConfigData.md) | |
56 | | `name` | [String](String.md) | 設定名( 'bgmVolume', 'bgsVolume', 'meVolume', 'seVolume' ) |
57 |
58 | #### (static) save ()
59 |
60 | オプションデータの保存。
61 |
--------------------------------------------------------------------------------
/docs/jsdoc/Decrypter.md:
--------------------------------------------------------------------------------
1 | # Class: Decrypter
2 |
3 | データの復号を行う、静的クラス。
4 |
5 | ### Properties:
6 |
7 | | Name | Type | Description |
8 | | -------------------- | --------------------------------------------- | ----------- |
9 | | `SIGNATURE` | [String](String.md) | [static] |
10 | | `VER` | [String](String.md) | [static] |
11 | | `REMAIN` | [String](String.md) | [static] |
12 | | `hasEncryptedImages` | Boolean | [static] |
13 | | `hasEncryptedAudio` | Boolean | [static] |
14 | | `_requestImgFile` | [Array](Array.md).<[String](String.md)> | [static] |
15 | | `_headerlength` | [Number](Number.md) | [static] |
16 | | `_xhrOk` | [Number](Number.md) | [static] |
17 | | `_encryptionKey` | [String](String.md) | [static] |
18 | | `_ignoreList` | [Array](Array.md).<[String](String.md)> | [static] |
19 |
20 | ### Methods
21 |
22 | #### (static) checkImgIgnore (url) → {Boolean}
23 |
24 | ##### Parameters:
25 |
26 | | Name | Type | Description |
27 | | ----- | ------------------- | ----------- |
28 | | `url` | [String](String.md) | |
29 |
30 | #### (static) createBlobUrl (arrayBuffer) → {[String](String.md)}
31 |
32 | ##### Parameters:
33 |
34 | | Name | Type | Description |
35 | | ------------- | ----------- | ----------- |
36 | | `arrayBuffer` | ArrayBuffer | |
37 |
38 | #### (static) cutArrayHeader (arrayBuffer, length) → {ArrayBuffer}
39 |
40 | ##### Parameters:
41 |
42 | | Name | Type | Description |
43 | | ------------- | ------------------- | ----------- |
44 | | `arrayBuffer` | ArrayBuffer | |
45 | | `length` | [Number](Number.md) | |
46 |
47 | #### (static) decryptArrayBuffer (arrayBuffer)
48 |
49 | ##### Parameters:
50 |
51 | | Name | Type | Description |
52 | | ------------- | ----------- | ----------- |
53 | | `arrayBuffer` | ArrayBuffer | |
54 |
55 | #### (static) decryptHTML5Audio (url, bgm, pos opt)
56 |
57 | ##### Parameters:
58 |
59 | | Name | Type | Attributes | Description |
60 | | ----- | ------------------------------------------- | ---------- | ----------- |
61 | | `url` | [String](String.md) | | |
62 | | `bgm` | [MV.AudioParameters](MV.AudioParameters.md) | | |
63 | | `pos` | [Number](Number.md) | | |
64 |
65 | #### (static) decryptImg (url, bitmap)
66 |
67 | ##### Parameters:
68 |
69 | | Name | Type | Description |
70 | | -------- | ------------------- | ----------- |
71 | | `url` | [String](String.md) | |
72 | | `bitmap` | [Bitmap](Bitmap.md) | |
73 |
74 | #### (static) extToEncryptExt (url) → {[String](String.md)}
75 |
76 | ##### Parameters:
77 |
78 | | Name | Type | Description |
79 | | ----- | ------------------- | ----------- |
80 | | `url` | [String](String.md) | |
81 |
82 | #### (static) readEncryptionkey ()
83 |
--------------------------------------------------------------------------------
/docs/jsdoc/Game_Actors.md:
--------------------------------------------------------------------------------
1 | # Class: Game_Actors
2 |
3 | ### new Game_Actors ()
4 |
5 | | データベース | JSON データ | 大域変数 | セーブデータ |
6 | | ------------ | ------------------------- | ----------------------------------------------- | ------------ |
7 | | [アクター] | [RPG.Actor](RPG.Actor.md) | [$gameActors](global.md#gameactors-game_actors) | 保存される |
8 |
9 | [Game_Actor](Game_Actor.md) をまとめて扱えるようにしたクラス。ほぼ、[$dataActors](global.md#dataactors-arrayrpgactor)と同じ。
10 |
11 | 関連クラス: [Game_Party](Game_Party.md)、[Game_Follower](Game_Follower.md)
12 |
13 | ### Properties:
14 |
15 | | Name | Type | Description |
16 | | ------- | ----------------------------------------------------- | -------------- |
17 | | `_data` | [Array](Array.md).<[Game_Actor](Game_Actor.md)> | アクターの配列 |
18 |
19 | ### Methods
20 |
21 | #### actor (actorId) → {[Game_Actor](Game_Actor.md)}
22 |
23 | 指定 ID のアクターを返す。
24 |
25 | ##### Parameters:
26 |
27 | | Name | Type | Description |
28 | | --------- | ------------------- | ----------- |
29 | | `actorId` | [Number](Number.md) | アクター ID |
30 |
31 | #### initialize ()
32 |
33 | オブジェクト生成時の初期化。
34 |
--------------------------------------------------------------------------------
/docs/jsdoc/Game_CommonEvent.md:
--------------------------------------------------------------------------------
1 | # Class: Game_CommonEvent
2 |
3 | ### new Game_CommonEvent ()
4 |
5 | | データベース | JSON データ |
6 | | ---------------- | ------------------------------------- |
7 | | [コモンイベント] | [RPG.CommonEvent](RPG.CommonEvent.md) |
8 |
9 | 関連クラス: [Game_Map](Game_Map.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ---------------- | --------------------------------------- | -------------------- |
15 | | `_commonEventId` | [Number](Number.md) | コモンイベント ID |
16 | | `_interpreter` | [Game_Interpreter](Game_Interpreter.md) | コマンドインタプリタ |
17 |
18 | ### Methods
19 |
20 | #### event () → {[RPG.CommonEvent](RPG.CommonEvent.md)}
21 |
22 | JSON の定義データを返す。
23 |
24 | #### initialize ()
25 |
26 | オブジェクト生成時の初期化。
27 |
28 | #### isActive () → {Boolean}
29 |
30 | この[コモンイベント]がアクティブか。
31 |
32 | #### list () → {[Array](Array.md).<[RPG.EventCommand](RPG.EventCommand.md)>}
33 |
34 | [イベントコマンド]を配列で返す。
35 |
36 | #### refresh ()
37 |
38 | [コモンイベント]を更新。
39 |
40 | #### update ()
41 |
42 | フレーム毎のアップデート。
43 |
--------------------------------------------------------------------------------
/docs/jsdoc/Game_Followers.md:
--------------------------------------------------------------------------------
1 | # Class: Game_Followers
2 |
3 | ### new Game_Followers ()
4 |
5 | [Game_Follower](Game_Follower.md) をまとめた[隊列メンバー]の並びなどを管理するクラス。
6 |
7 | [$gamePlayer.followers()](Game_Player.md#followers---game_followers) メソッドで得られる。
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | ------------ | ----------------------------------------------------------- | ---------------------- |
13 | | `_visible` | Boolean | [パーティの隊列歩行]か |
14 | | `_gathering` | Boolean | 集合しているか |
15 | | `_data` | [Array](Array.md).<[Game_Follower](Game_Follower.md)> | [隊列メンバー]の配列 |
16 |
17 | ### Methods
18 |
19 | #### areGathered () → {Boolean}
20 |
21 | [隊列メンバー]が集合しているか。
22 |
23 | #### areGathering () → {Boolean}
24 |
25 | [隊列メンバー]の集合中か。
26 |
27 | #### areMoving () → {Boolean}
28 |
29 | [隊列メンバー]が移動中か。
30 |
31 | #### follower (index) → {[Game_Follower](Game_Follower.md)}
32 |
33 | 指定した番号の[隊列メンバー]を返す。
34 | プレイヤー(先頭のキャラ)は隊列メンバーに含まれず、 0:2 番目, 1:3 番目, 2:4 番目と index は 0 から始まり 2 番目のキャラから指定される。
35 |
36 | ##### Parameters:
37 |
38 | | Name | Type | Description |
39 | | ------- | ------------------- | ------------------ |
40 | | `index` | [Number](Number.md) | [隊列メンバー]番号 |
41 |
42 | #### forEach (callback, thisObject)
43 |
44 | 各[隊列メンバー]オブジェクトを対象に関数を実行する。
45 |
46 | ##### Parameters:
47 |
48 | | Name | Type | Description |
49 | | ------------ | -------- | ----------------------------- |
50 | | `callback` | function | コールバック関数 |
51 | | `thisObject` | \* | 現在のオブジェクト(通常 this) |
52 |
53 | #### gather ()
54 |
55 | [隊列メンバーの集合]。
56 |
57 | #### hide ()
58 |
59 | [隊列メンバー]を表示しない。
60 |
61 | #### initialize ()
62 |
63 | オブジェクト生成時の初期化。
64 |
65 | #### isSomeoneCollided (x, y) → {Boolean}
66 |
67 | 指定位置に[隊列メンバー]の誰かがいるか。
68 |
69 | ##### Parameters:
70 |
71 | | Name | Type | Description |
72 | | ---- | ------------------- | ---------------- |
73 | | `x` | [Number](Number.md) | x 座標(タイル数) |
74 | | `y` | [Number](Number.md) | y 座標(タイル数) |
75 |
76 | #### isVisible () → {Boolean}
77 |
78 | [隊列メンバー]が表示されているか。
79 |
80 | #### jumpAll ()
81 |
82 | [隊列メンバー]全員を、プレイヤーキャラクタの[ジャンプ]高さに揃える。
83 |
84 | #### refresh ()
85 |
86 | [隊列メンバー]を更新。
87 |
88 | #### reverseEach (callback, thisObject)
89 |
90 | 各[隊列メンバー]オブジェクトを対象に逆順に関数を実行する。
91 |
92 | ##### Parameters:
93 |
94 | | Name | Type | Description |
95 | | ------------ | -------- | ----------------------------- |
96 | | `callback` | function | コールバック関数 |
97 | | `thisObject` | \* | 現在のオブジェクト(通常 this) |
98 |
99 | #### show ()
100 |
101 | [隊列メンバー]を表示。
102 |
103 | #### synchronize (x, y, d)
104 |
105 | 指定の位置と向きに[隊列メンバー]を揃える。
106 |
107 | ##### Parameters:
108 |
109 | | Name | Type | Description |
110 | | ---- | ------------------- | ------------------ |
111 | | `x` | [Number](Number.md) | タイル数 |
112 | | `y` | [Number](Number.md) | タイル数 |
113 | | `d` | [Number](Number.md) | 向き(テンキー対応) |
114 |
115 | #### update ()
116 |
117 | [隊列メンバー]をアップデート。
118 |
119 | #### updateMove ()
120 |
121 | [隊列メンバー]の移動をアップデート。
122 |
123 | #### visibleFollowers () → {[Array](Array.md).<[Game_Follower](Game_Follower.md)>}
124 |
125 | 表示中の[隊列メンバー]の配列を返す。
126 |
--------------------------------------------------------------------------------
/docs/jsdoc/Game_Item.md:
--------------------------------------------------------------------------------
1 | # Class: Game_Item
2 |
3 | ### new Game_Item ()
4 |
5 | | データベース | JSON データ |
6 | | ------------------------------ | ------------------------------- |
7 | | [アイテム][武器][防具][スキル] | [RPG.BaseItem](RPG.BaseItem.md) |
8 |
9 | アイテム全般とスキルをまとめて扱うクラス。
10 |
11 | 関連クラス: [RPG.UsableItem](RPG.UsableItem.md), [RPG.Item](RPG.Item.md), [RPG.Skill](RPG.Skill.md), [RPG.EquipItem](RPG.EquipItem.md), [RPG.Weapon](RPG.Weapon.md), [RPG.Armor](RPG.Armor.md), [Game_Actor](Game_Actor.md), [Game_Action](Game_Action.md)
12 |
13 | ##### Properties:
14 |
15 | | Name | Type | Description |
16 | | ------------ | ------------------- | -------------------------------------------------------- |
17 | | `_dataClass` | [String](String.md) | アイテムの種類( 'item', 'skill', 'weapon', 'armor', '' ) |
18 | | `_itemId` | [Number](Number.md) | アイテム ID(種類毎に異なる) |
19 |
20 | ### Methods
21 |
22 | #### initialize ()
23 |
24 | オブジェクト生成時の初期化。
25 |
26 | #### isArmor () → {Boolean}
27 |
28 | 防具か。
29 |
30 | #### isEquipItem () → {Boolean}
31 |
32 | 装備品か。
33 |
34 | #### isItem () → {Boolean}
35 |
36 | アイテムか。
37 |
38 | #### isNull () → {Boolean}
39 |
40 | 未設定か。
41 |
42 | #### isSkill () → {Boolean}
43 |
44 | スキルか。
45 |
46 | #### isUsableItem () → {Boolean}
47 |
48 | 使用できるアイテムか。
49 |
50 | #### isWeapon () → {Boolean}
51 |
52 | 武器か。
53 |
54 | #### itemId () → {[Number](Number.md)}
55 |
56 | アイテム ID を返す。
57 |
58 | #### object () → {[RPG.BaseItem](RPG.BaseItem.md)}
59 |
60 | JSON データを返す。
61 |
62 | #### setEquip (isWeapon, itemId)
63 |
64 | 指定アイテムで装備品の設定。
65 |
66 | ##### Parameters:
67 |
68 | | Name | Type | Description |
69 | | ---------- | ------------------- | ----------- |
70 | | `isWeapon` | Boolean | 武器か |
71 | | `itemId` | [Number](Number.md) | アイテム ID |
72 |
73 | #### setObject (item)
74 |
75 | 指定 JSON データで書き換える。
76 |
77 | ##### Parameters:
78 |
79 | | Name | Type | Description |
80 | | ------ | ------------------------------- | ----------- |
81 | | `item` | [RPG.BaseItem](RPG.BaseItem.md) | アイテム |
82 |
--------------------------------------------------------------------------------
/docs/jsdoc/Game_SelfSwitches.md:
--------------------------------------------------------------------------------
1 | # Class: Game_SelfSwitches
2 |
3 | ### new Game_SelfSwitches ()
4 |
5 | | 大域変数 | セーブデータ |
6 | | ----------------------------------------------------------------- | ------------ |
7 | | [$gameSelfSwitches](global.md#gameselfswitches-game_selfswitches) | 保存される |
8 |
9 | [EV ページ]の条件判定で使われる[セルフスイッチ]を扱うためのクラス。
10 |
11 | 関連クラス: [Game_Variables](Game_Variables.md), [Game_Switches](Game_Switches.md), [RPG.EventPage](RPG.EventPage.md), [RPG.EventPage.Conditions](RPG.EventPage.Conditions.md), [RPG.BattleEventPage](RPG.BattleEventPage.md), [RPG.BattleEventPage.Conditions](RPG.BattleEventPage.Conditions.md)
12 |
13 | ### Properties:
14 |
15 | | Name | Type | Description |
16 | | ------- | ------ | -------------------- |
17 | | `_data` | Object | {key: Array, …} の形 |
18 |
19 | ### Methods
20 |
21 | #### clear ()
22 |
23 | [セルフスイッチ]のデータを初期化。
24 |
25 | #### initialize ()
26 |
27 | オブジェクト生成時の初期化。
28 |
29 | #### onChange ()
30 |
31 | スイッチの変更時に呼ばれるハンドラ。
32 | (マップの書き換えを予約)
33 |
34 | #### setValue (key, value)
35 |
36 | 指定した[セルフスイッチ]に値を設定。
37 | タイプは A,B,C,D いずれかの文字。
38 |
39 | ##### Parameters:
40 |
41 | | Name | Type | Description |
42 | | ------- | ---------------------------- | ----------------------------------------- |
43 | | `key` | [Array](Array.md).<\*> | [ マップ ID, イベント ID, タイプ ] の配列 |
44 | | `value` | Boolean | スイッチが ON か |
45 |
46 | #### value (key) → {Boolean}
47 |
48 | 指定キーの値が ON か。
49 | タイプは A,B,C,D いずれかの文字。
50 |
51 | ##### Parameters:
52 |
53 | | Name | Type | Description |
54 | | ----- | ---------------------------- | ----------------------------------------- |
55 | | `key` | [Array](Array.md).<\*> | [ マップ ID, イベント ID, タイプ ] の配列 |
56 |
--------------------------------------------------------------------------------
/docs/jsdoc/Game_Switches.md:
--------------------------------------------------------------------------------
1 | # Class: Game_Switches
2 |
3 | ### new Game_Switches ()
4 |
5 | | 大域変数 | セーブデータ |
6 | | ----------------------------------------------------- | ------------ |
7 | | [$gameSwitches](global.md#gameswitches-game_switches) | 保存される |
8 |
9 | 条件判定で使われる[スイッチ]を扱うためのクラス。
10 |
11 | スイッチは ID で管理されているが、[RPG.System](RPG.System.md)([$dataSystem](global.md#datasystem-rpgsystem)) の switches プロパティに文字列も存在している。
12 |
13 | 関連クラス: [Game_Variables](Game_Variables.md), [Game_SelfSwitches](Game_SelfSwitches.md)
14 |
15 | ### Properties:
16 |
17 | | Name | Type | Description |
18 | | ------- | --------------------------------- | ------------ |
19 | | `_data` | [Array](Array.md).<Boolean> | 真偽値の配列 |
20 |
21 | ### Methods
22 |
23 | #### clear ()
24 |
25 | 値を初期化。
26 |
27 | #### initialize ()
28 |
29 | オブジェクト生成時の初期化。
30 |
31 | #### onChange ()
32 |
33 | スイッチの変更時に呼ばれるハンドラ。
34 | (マップの書き換えを予約)
35 |
36 | #### setValue (switchId, value)
37 |
38 | 指定した[スイッチ]に値を設定。
39 |
40 | ##### Parameters:
41 |
42 | | Name | Type | Description |
43 | | ---------- | ------------------- | ---------------- |
44 | | `switchId` | [Number](Number.md) | スイッチ ID |
45 | | `value` | Boolean | スイッチが ON か |
46 |
47 | #### value (switchId)
48 |
49 | 指定した[スイッチ]の値を返す。
50 |
51 | ##### Parameters:
52 |
53 | | Name | Type | Description |
54 | | ---------- | ------------------- | ----------- |
55 | | `switchId` | [Number](Number.md) | スイッチ ID |
56 |
--------------------------------------------------------------------------------
/docs/jsdoc/Game_Temp.md:
--------------------------------------------------------------------------------
1 | # Class: Game_Temp
2 |
3 | ### new Game_Temp ()
4 |
5 | | 大域変数 |
6 | | ----------------------------------------- |
7 | | [$GameTemp](global.md#gametemp-game_temp) |
8 |
9 | ゲームの一時データを保持しておくクラス。
10 |
11 | 関連クラス: [Game_CommonEvent](Game_CommonEvent.md)
12 |
13 | ### Properties:
14 |
15 | | Name | Type | Description |
16 | | ---------------- | ------------------- | ----------- |
17 | | `_isPlaytest` | Boolean | |
18 | | `_commonEventId` | [Number](Number.md) | |
19 | | `_destinationX` | [Number](Number.md) | |
20 | | `_destinationY` | [Number](Number.md) | |
21 |
22 | ### Methods
23 |
24 | #### clearCommonEvent ()
25 |
26 | 一時保存の[コモンイベント]を消去。
27 |
28 | #### clearDestination ()
29 |
30 | プレイヤーの移動目標データを消去。
31 |
32 | #### destinationX () → {[Number](Number.md)}
33 |
34 | 移動目標の x 座標を返す。
35 |
36 | #### destinationY () → {[Number](Number.md)}
37 |
38 | 移動目標の y 座標を返す。
39 |
40 | #### initialize ()
41 |
42 | オブジェクト生成時の初期化。
43 |
44 | #### isCommonEventReserved () → {Boolean}
45 |
46 | [コモンイベント]が保存されているか。
47 |
48 | #### isDestinationValid () → {Boolean}
49 |
50 | 目標位置が正しいデータか。
51 |
52 | #### isPlaytest () → {Boolean}
53 |
54 | テストモードか。
55 |
56 | #### reserveCommonEvent (commonEventId)
57 |
58 | 指定[コモンイベント]を、あとで処理するために保持。
59 |
60 | ##### Parameters:
61 |
62 | | Name | Type | Description |
63 | | --------------- | ------------------- | ----------------- |
64 | | `commonEventId` | [Number](Number.md) | コモンイベント ID |
65 |
66 | #### reservedCommonEvent () → {\*}
67 |
68 | 一時保存された[コモンイベント]を返す。
69 |
70 | #### setDestination (x, y)
71 |
72 | 移動目標の座標を設定。
73 |
74 | ##### Parameters:
75 |
76 | | Name | Type | Description |
77 | | ---- | ------------------- | ---------------- |
78 | | `x` | [Number](Number.md) | x 座標(タイル数) |
79 | | `y` | [Number](Number.md) | y 座標(タイル数) |
80 |
--------------------------------------------------------------------------------
/docs/jsdoc/Game_Timer.md:
--------------------------------------------------------------------------------
1 | # Class: Game_Timer
2 |
3 | ### new Game_Timer ()
4 |
5 | | イベントコマンド | 大域変数 | セーブデータ | スプライト |
6 | | ---------------- | -------------------------------------------- | ------------ | ------------------------------- |
7 | | [タイマーの操作] | [$gameTimer](global.md#gametimer-game_timer) | 保存される | [Sprite_Timer](Sprite_Timer.md) |
8 |
9 | 関連クラス: [Scene_Map](Scene_Map.md), [Scene_Battle](Scene_Battle.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ---------- | ------------------- | -------------------- |
15 | | `_frames` | [Number](Number.md) | 残り時間(フレーム数) |
16 | | `_working` | Boolean | 動作しているか |
17 |
18 | ### Methods
19 |
20 | #### initialize ()
21 |
22 | オブジェクト生成時の初期化。
23 |
24 | #### isWorking () → {Boolean}
25 |
26 | タイマーが動作しているか。
27 |
28 | #### onExpire ()
29 |
30 | タイマーが完了した時に呼ばれるハンドラ。
31 |
32 | #### seconds () → {[Number](Number.md)}
33 |
34 | 残り秒数を返す。
35 |
36 | #### start (count)
37 |
38 | 指定されたカウントでタイマーを開始。
39 |
40 | ##### Parameters:
41 |
42 | | Name | Type | Description |
43 | | ------- | ------------------- | ------------------------ |
44 | | `count` | [Number](Number.md) | カウント時間(フレーム数) |
45 |
46 | #### stop ()
47 |
48 | タイマーを停止。
49 |
50 | #### update (sceneActive)
51 |
52 | シーンがアクティブな場合、タイマーをアップデート。
53 |
54 | ##### Parameters:
55 |
56 | | Name | Type | Description |
57 | | ------------- | ------- | -------------------- |
58 | | `sceneActive` | Boolean | シーンがアクティブか |
59 |
--------------------------------------------------------------------------------
/docs/jsdoc/Game_Troop.md:
--------------------------------------------------------------------------------
1 | # Class: Game_Troop
2 |
3 | ## Extends: [Game_Unit](Game_Unit.md)
4 |
5 | ### new Game_Troop ()
6 |
7 | | データベース | JSON データ | 大域変数 |
8 | | ------------ | ------------------------- | -------------------------------------------- |
9 | | [敵グループ] | [RPG.Troop](RPG.Troop.md) | [$gameTroop](global.md#gametroop-game_troop) |
10 |
11 | 戦闘シーンでの[敵グループ]を定義したクラス。
12 |
13 | 関連クラス: [Game_Enemy](Game_Enemy.md), [Game_Actor](Game_Actor.md), [Game_Party](Game_Party.md), [Scene_Battle](Scene_Battle.md), [BattleManager](BattleManager.md)
14 |
15 | ### Properties:
16 |
17 | | Name | Type | Description |
18 | | ------------------- | ----------------------------------------------------- | -------------------------------------- |
19 | | `LETTER_TABLE_HALF` | [Array](Array.md).<[String](String.md)> | [static] 名前の接尾辞(A〜Z の半角記号) |
20 | | `LETTER_TABLE_FULL` | [Array](Array.md).<[String](String.md)> | [static] 名前の接尾辞(A〜Z の全角記号) |
21 | | `_interpreter` | [Game_Interpreter](Game_Interpreter.md) | コマンドインタプリタ |
22 | | `_troopId` | [Number](Number.md) | 敵グループ ID |
23 | | `_eventFlags` | Object | {[page: Number]: Boolean} |
24 | | `_enemies` | [Array](Array.md).<[Game_Enemy](Game_Enemy.md)> | [敵キャラ]の配列 |
25 | | `_turnCount` | [Number](Number.md) | ターンカウンタ |
26 | | `_namesCount` | Object | {[name: String]: Number} |
27 |
28 | ### Inherited From
29 |
30 | #### [Game_Unit](Game_Unit.md)
31 |
32 | - [agility ()](Game_Unit.md#agility---number)
33 | - [aliveMembers ()](Game_Unit.md#alivemembers---arraygame_battler)
34 | - [clearActions ()](Game_Unit.md#clearactions-)
35 | - [clearResults ()](Game_Unit.md#clearresults-)
36 | - [deadMembers ()](Game_Unit.md#deadmembers---arraygame_battler)
37 | - [inBattle ()](Game_Unit.md#inbattle---boolean)
38 | - [isAllDead ()](Game_Unit.md#isalldead---boolean)
39 | - [makeActions ()](Game_Unit.md#makeactions-)
40 | - [movableMembers ()](Game_Unit.md#movablemembers---arraygame_battler)
41 | - [onBattleEnd ()](Game_Unit.md#onbattleend-)
42 | - [onBattleStart ()](Game_Unit.md#onbattlestart-)
43 | - [randomDeadTarget ()](Game_Unit.md#randomdeadtarget---game_battler)
44 | - [randomTarget ()](Game_Unit.md#randomtarget---game_battler)
45 | - [select (activeMember)](Game_Unit.md#select-activemember)
46 | - [smoothDeadTarget (index)](Game_Unit.md#smoothdeadtarget-index--game_battler)
47 | - [smoothTarget (index)](Game_Unit.md#smoothtarget-index--game_battler)
48 | - [substituteBattler ()](Game_Unit.md#substitutebattler---game_battler)
49 | - [tgrSum ()](Game_Unit.md#tgrsum---number)
50 |
51 | ### Methods
52 |
53 | #### clear ()
54 |
55 | データの初期化。
56 |
57 | #### enemyNames () → {[Array](Array.md).<[String](String.md)>}
58 |
59 | [敵キャラ]の名前を配列で返す。
60 |
61 | #### expTotal () → {[Number](Number.md)}
62 |
63 | [敵キャラ]の合計 EXP を返す。
64 |
65 | #### goldRate () → {[Number](Number.md)}
66 |
67 | プレイヤーパーティが持つ金額の取得倍率を返す。スキルやアイテムの効果で上下する。
68 |
69 | #### goldTotal () → {[Number](Number.md)}
70 |
71 | [敵キャラ]からの合計取得金額を返す。
72 |
73 | #### increaseTurn ()
74 |
75 | ターンを進める。
76 |
77 | #### initialize ()
78 |
79 | Overrides:[Game_Unit](Game_Unit.md#initialize-)
80 |
81 | #### isEventRunning () → {Boolean}
82 |
83 | イベントが実行中か。
84 |
85 | #### letterTable () → {[Array](Array.md).<[String](String.md)>}
86 |
87 | 名前の接尾辞(A〜Z)を配列で返す。
88 |
89 | #### makeDropItems () → {[Array](Array.md).<[RPG.BaseItem](RPG.BaseItem.md)>}
90 |
91 | ドロップアイテムを作成して配列で返す。
92 |
93 | #### makeUniqueNames ()
94 |
95 | 全[敵キャラ]に(A〜Z を割り振って)固有名をつける。
96 |
97 | #### meetsConditions (page) → {Boolean}
98 |
99 | 指定ページが条件に合っているか。
100 |
101 | ##### Parameters:
102 |
103 | | Name | Type | Description |
104 | | ------ | --------------------------------------------- | ---------------- |
105 | | `page` | [RPG.BattleEventPage](RPG.BattleEventPage.md) | バトル EV ページ |
106 |
107 | #### members () → {[Array](Array.md).<[Game_Enemy](Game_Enemy.md)>}
108 |
109 | Overrides:[Game_Unit](Game_Unit.md#members---arraygame_battler)
110 |
111 | #### setup (troopId)
112 |
113 | 指定した[敵グループ]を準備。
114 |
115 | ##### Parameters:
116 |
117 | | Name | Type | Description |
118 | | --------- | ------------------- | ------------- |
119 | | `troopId` | [Number](Number.md) | 敵グループ ID |
120 |
121 | #### setupBattleEvent ()
122 |
123 | バトルイベントの準備。
124 |
125 | #### troop () → {[RPG.Troop](RPG.Troop.md)}
126 |
127 | [敵グループ]の定義情報を返す。
128 |
129 | #### turnCount () → {[Number](Number.md)}
130 |
131 | ターン数を返す。
132 |
133 | #### updateInterpreter ()
134 |
135 | コマンドインタプリタを更新する。
136 |
--------------------------------------------------------------------------------
/docs/jsdoc/Game_Unit.md:
--------------------------------------------------------------------------------
1 | # Class: Game_Unit
2 |
3 | ### new Game_Unit ()
4 |
5 | 戦闘時のグループを扱うクラス。
6 |
7 | ### Sub Classes
8 |
9 | - [Game_Party](Game_Party.md)
10 | - [Game_Troop](Game_Troop.md)
11 |
12 | ### Properties:
13 |
14 | | Name | Type | Description |
15 | | ----------- | ------- | ----------- |
16 | | `_inBattle` | Boolean | 戦闘中か |
17 |
18 | ### Methods
19 |
20 | #### agility () → {[Number](Number.md)}
21 |
22 | ユニットの素早さを返す。
23 |
24 | #### aliveMembers () → {[Array](Array.md).<[Game_Battler](Game_Battler.md)>}
25 |
26 | 生存しているバトラーを配列で返す。
27 |
28 | #### clearActions ()
29 |
30 | アクションを取り消す。
31 |
32 | #### clearResults ()
33 |
34 | アクションの結果を取り消す。
35 |
36 | #### deadMembers () → {[Array](Array.md).<[Game_Battler](Game_Battler.md)>}
37 |
38 | 死亡しているバトラーを配列で返す。
39 |
40 | #### inBattle () → {Boolean}
41 |
42 | 戦闘中か。
43 |
44 | #### initialize ()
45 |
46 | オブジェクト生成時の初期化。
47 |
48 | #### isAllDead () → {Boolean}
49 |
50 | 全バトラーが死亡したか。
51 |
52 | #### makeActions ()
53 |
54 | 戦闘行動を作成する。
55 |
56 | #### members () → {[Array](Array.md).<[Game_Battler](Game_Battler.md)>}
57 |
58 | 戦闘中のバトラー生死問わず全て配列で返す。
59 |
60 | #### movableMembers () → {[Array](Array.md).<[Game_Battler](Game_Battler.md)>}
61 |
62 | 動ける(死亡や麻痺などでない)バトラーを配列で返す。
63 |
64 | #### onBattleEnd ()
65 |
66 | 戦闘終了時に呼ばれるハンドラ。
67 |
68 | #### onBattleStart ()
69 |
70 | 戦闘開始時に呼ばれるハンドラ。
71 |
72 | #### randomDeadTarget () → {[Game_Battler](Game_Battler.md)}
73 |
74 | 死亡したバトラーからランダムに 1 体を返す。
75 |
76 | #### randomTarget () → {[Game_Battler](Game_Battler.md)}
77 |
78 | 含まれるバトラーからランダムに 1 体を返す。
79 |
80 | #### select (activeMember)
81 |
82 | 指定されたバトラーを選択する。
83 |
84 | ##### Parameters:
85 |
86 | | Name | Type | Description |
87 | | -------------- | ------------------------------- | ----------- |
88 | | `activeMember` | [Game_Battler](Game_Battler.md) | バトラー |
89 |
90 | #### smoothDeadTarget (index) → {[Game_Battler](Game_Battler.md)}
91 |
92 | 指定番号のメンバーを優先して死亡しているメンバーを返す。
93 |
94 | ##### Parameters:
95 |
96 | | Name | Type | Description |
97 | | ------- | ------------------- | ------------ |
98 | | `index` | [Number](Number.md) | メンバー番号 |
99 |
100 | #### smoothTarget (index) → {[Game_Battler](Game_Battler.md)}
101 |
102 | 指定番号のメンバーを優先して生きているメンバーを返す。
103 |
104 | ##### Parameters:
105 |
106 | | Name | Type | Description |
107 | | ------- | ------------------- | ------------ |
108 | | `index` | [Number](Number.md) | メンバー番号 |
109 |
110 | #### substituteBattler () → {[Game_Battler](Game_Battler.md)}
111 |
112 | 身代わりのバトラーを返す。
113 |
114 | #### tgrSum () → {[Number](Number.md)}
115 |
116 | 生きているメンバーの[狙われ率]の合計を返す。
117 |
--------------------------------------------------------------------------------
/docs/jsdoc/Game_Variables.md:
--------------------------------------------------------------------------------
1 | # Class: Game_Variables
2 |
3 | ### new Game_Variables ()
4 |
5 | | 大域変数 | セーブデータ |
6 | | -------------------------------------------------------- | ------------ |
7 | | [$gameVariables](global.md#gamevariables-game_variables) | 保存される |
8 |
9 | 条件判定で使われる[変数]を扱うためのクラス。
10 |
11 | 変数は ID で管理されているが、[RPG.System](RPG.System.md)([$dataSystem](global.md#datasystem-rpgsystem)) の variables プロパティに文字列も存在している。
12 |
13 | 関連クラス: [Game_Switches](Game_Switches.md), [Game_SelfSwitches](Game_SelfSwitches.md)
14 |
15 | ### Properties:
16 |
17 | | Name | Type | Description |
18 | | ------- | --------------------------------------------- | ---------------- |
19 | | `_data` | [Array](Array.md).<[Number](Number.md)> | 変数の内容の配列 |
20 |
21 | ### Methods
22 |
23 | #### clear ()
24 |
25 | 値を初期化。
26 |
27 | #### initialize ()
28 |
29 | オブジェクト生成時の初期化。
30 |
31 | #### onChange ()
32 |
33 | スイッチの変更時に呼ばれるハンドラ。
34 | (マップの書き換えを予約)
35 |
36 | #### setValue (variableId, value)
37 |
38 | 指定した[変数]に値を設定。
39 |
40 | ##### Parameters:
41 |
42 | | Name | Type | Description |
43 | | ------------ | ------------------- | ----------- |
44 | | `variableId` | [Number](Number.md) | 変数 ID |
45 | | `value` | \* | 値 |
46 |
47 | #### value (variableId) → {\*}
48 |
49 | 指定した[変数]の値を返す。
50 |
51 | ##### Parameters:
52 |
53 | | Name | Type | Description |
54 | | ------------ | ------------------- | ----------- |
55 | | `variableId` | [Number](Number.md) | 変数 ID |
56 |
--------------------------------------------------------------------------------
/docs/jsdoc/ImageCache.md:
--------------------------------------------------------------------------------
1 | # Class: ImageCache
2 |
3 | ### new ImageCache ()
4 |
5 | 画像を保持(キャッシュ)するクラス。Ver.1.5.0 で追加されたクラス。
6 |
7 | 関連クラス: [ImageManager](ImageManager.md), [CacheEntry](CacheEntry.md), [CacheMap](CacheMap.md), [Bitmap](Bitmap.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | ------- | ------------------- | --------------------------------- |
13 | | `limit` | [Number](Number.md) | [static] 上限(規定値: 10,000,000) |
14 |
15 | ### Methods
16 |
17 | #### add (key, value)
18 |
19 | 指定画像をキャッシュに追加。
20 |
21 | ##### Parameters:
22 |
23 | | Name | Type | Description |
24 | | ------- | ------------------- | --------------- |
25 | | `key` | [String](String.md) | キー文字列(URL) |
26 | | `value` | [Bitmap](Bitmap.md) | 画像 |
27 |
28 | #### get (key) → {null | [Bitmap](Bitmap.md)}
29 |
30 | 指定キーに対応した画像を返す。
31 |
32 | ##### Parameters:
33 |
34 | | Name | Type | Description |
35 | | ----- | ------------------- | --------------- |
36 | | `key` | [String](String.md) | キー文字列(URL) |
37 |
38 | #### getErrorBitmap () → {null | [Bitmap](Bitmap.md)}
39 |
40 | エラー画像を得る。
41 |
42 | #### initialize ()
43 |
44 | オブジェクト生成時の初期化。
45 |
46 | #### isReady () → {Boolean}
47 |
48 | キャッシュされたか。
49 |
50 | #### releaseReservation (reservationId)
51 |
52 | 指定 ID のキャッシュを解放。
53 |
54 | ##### Parameters:
55 |
56 | | Name | Type | Description |
57 | | --------------- | ------------------- | ------------- |
58 | | `reservationId` | [Number](Number.md) | キャッシュ ID |
59 |
60 | #### reserve (key, value, reservationId)
61 |
62 | 指定画像をキャッシュへ保存。
63 |
64 | ##### Parameters:
65 |
66 | | Name | Type | Description |
67 | | --------------- | ------------------- | --------------- |
68 | | `key` | [String](String.md) | キー文字列(URL) |
69 | | `value` | [Bitmap](Bitmap.md) | 画像 |
70 | | `reservationId` | [Number](Number.md) | キャッシュ ID |
71 |
--------------------------------------------------------------------------------
/docs/jsdoc/JsonEx.md:
--------------------------------------------------------------------------------
1 | # Class: JsonEx
2 |
3 | JSON ファイルを扱う静的ビルトインクラス [JSON](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/JSON) のラッパークラス。
4 |
5 | 一応( \_が前についた) private メソッドも書いているが、実際使うのは [parse()](JsonEx.md#static-parse-json--object) と [stringify()](JsonEx.md#static-stringify-object--string)。
6 | [makeDeepCopy()](JsonEx.md#static-makedeepcopy-object--object) は JSON の変換ができればできる処理なので、ついでにこのクラスに付属している。
7 |
8 | Namespace [RPG](RPG.md) に分類しているのが JSON データ。
9 |
10 | 関連クラス: [PluginManager](PluginManager.md), [MV.PluginSettings](MV.PluginSettings.md), [DataManager](DataManager.md)
11 |
12 | ### Properties:
13 |
14 | | Name | Type | Description |
15 | | ---------- | ------------------- | ------------------------------------------- |
16 | | `maxDepth` | [Number](Number.md) | [static] オブジェクトの最高深度(規定値:100) |
17 |
18 | ### Methods
19 |
20 | #### (static) \_cleanMetadata (object)
21 |
22 | 指定オブジェクトからエンコード・デコードで使うメタデータ('@'、'@c')を取り除く。
23 |
24 | ##### Parameters:
25 |
26 | | Name | Type | Description |
27 | | -------- | ------ | ------------ |
28 | | `object` | Object | オブジェクト |
29 |
30 | #### (static) \_decode (value, circular, registry) → {Object}
31 |
32 | parse の前処理。
33 |
34 | ##### Parameters:
35 |
36 | | Name | Type | Description |
37 | | ---------- | ----------------- | --------------------------- | ------------------------ |
38 | | `value` | | Object \| [Array](Array.md) | デコードするオブジェクト |
39 | | `circular` | [Array](Array.md) | 循環参照チェック配列 |
40 | | `registry` | Object | レジストリ |
41 |
42 | #### (static) \_encode (value, circular, depth) → {Object}
43 |
44 | stringify の前処理。
45 |
46 | ##### Parameters:
47 |
48 | | Name | Type | Description |
49 | | ---------- | --------------------------- | -------------------------- |
50 | | `value` | Object \| [Array](Array.md) | エンコードするオブジェクト |
51 | | `circular` | [Array](Array.md) | 循環参照チェック配列 |
52 | | `depth` | [Number](Number.md) | 深さ |
53 |
54 | #### (static) \_generateId () → {[Number](Number.md)}
55 |
56 | ID を生成して返す。
57 |
58 | #### (static) \_getConstructorName (value) → {[String](String.md)}
59 |
60 | 指定オブジェクトのコンストラクタの名前を返す。
61 |
62 | ##### Parameters:
63 |
64 | | Name | Type | Description |
65 | | ------- | ------ | ------------ |
66 | | `value` | Object | オブジェクト |
67 |
68 | #### (static) \_linkCircularReference (contents, circular, registry) → {Object}
69 |
70 | 循環参照のリンク。
71 |
72 | ##### Parameters:
73 |
74 | | Name | Type | Description |
75 | | ----------- | ----------------- | ------------------------ |
76 | | `contents ` | Object | デコードするオブジェクト |
77 | | `circular` | [Array](Array.md) | 循環参照チェック配列 |
78 | | `registry` | Object | レジストリ |
79 |
80 | #### (static) \_resetPrototype (value, prototype) → {Object}
81 |
82 | 指定オブジェクトに、指定プロトタイプを再定義して返す。
83 |
84 | ##### Parameters:
85 |
86 | | Name | Type | Description |
87 | | ----------- | ------ | ------------------------ |
88 | | `value` | Object | オブジェクト |
89 | | `prototype` | Object | プロトタイプオブジェクト |
90 |
91 | #### (static) \_restoreCircularReference (circulars)
92 |
93 | 循環参照チェック配列から復帰。
94 |
95 | ##### Parameters:
96 |
97 | | Name | Type | Description |
98 | | ---------- | ----------------- | -------------------- |
99 | | `circular` | [Array](Array.md) | 循環参照チェック配列 |
100 |
101 | #### (static) makeDeepCopy (object) → {Object}
102 |
103 | 指定オブジェクトのディープコピー(参照関係のない別データ)を返す。
104 |
105 | ##### Parameters:
106 |
107 | | Name | Type | Description |
108 | | -------- | ------ | -------------------- |
109 | | `object` | Object | コピー元オブジェクト |
110 |
111 | #### (static) parse (json) → {Object}
112 |
113 | JSON 文字列をオブジェクトに変換して返す。
114 | 正確には JSON 文字列でない、配列なども変換する。
115 |
116 | ##### Parameters:
117 |
118 | | Name | Type | Description |
119 | | ------ | ------------------- | ----------- |
120 | | `json` | [String](String.md) | JSON 文字列 |
121 |
122 | #### (static) stringify (object) → {[String](String.md)}
123 |
124 | オブジェクトを JSON 文字列に変換して返す。
125 |
126 | ##### Parameters:
127 |
128 | | Name | Type | Description |
129 | | -------- | ------ | -------------------- |
130 | | `object` | Object | 変換するオブジェクト |
131 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.AudioParameters.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).AudioParameters
2 |
3 | ## Type: Object
4 |
5 | 音声に指定するパラメータ。
6 |
7 | 関連クラス: [AudioManager](AudioManager.md), [BattleManager](BattleManager.md), [Decrypter](Decrypter.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | -------- | ------------------- | ----------- |
13 | | `name` | [String](String.md) | 名前 |
14 | | `volume` | [Number](Number.md) | 音量 |
15 | | `pitch` | [Number](Number.md) | ピッチ |
16 | | `pan` | [Number](Number.md) | パン |
17 | | `pos` | [Number](Number.md) | 再生位置 |
18 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.BattleLogMethod.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).BattleLogMethod
2 |
3 | ## Type: Object
4 |
5 | [Window_BattleLog](Window_BattleLog.md) のメソッドを、後から呼ぶために貯めておくパラメータ。
6 |
7 | 関連クラス: [TextManager](TextManager.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | -------- | ------------------- | ---------------------------------------------- |
13 | | `name` | [String](String.md) | [メソッド名](MV.BattleLogMethod.md#メソッド名) |
14 | | `params` | [Array](Array.md) | 引数の配列(詳細は各メソッドの解説を参照) |
15 |
16 | #### メソッド名
17 |
18 | BaseLine は表示の区切り行数で、連続してダメージを与えた場合など、一旦表示した後その行数まで戻す処理で使う。
19 | なお、popBaseLine で記録上の行は戻るが、次に行が表示されるまで表示は消えない。
20 |
21 | 行数は
22 |
23 | | Method | Description | param1 | param2 | param3 |
24 | | ------------------------------------------------------------------------------ | ------------------------ | ------------------------------- | --------------------------------------------------------- | ------------------- |
25 | | [addText](Window_BattleLog.md#addtext-text) | 行を追加 | [String](String.md) |
26 | | [clear](Window_BattleLog.md#clear-) | 表示を消去 |
27 | | [performAction ](Window_BattleLog.md#performaction-subject-action) | 行動を適用 | [Game_Battler](Game_Battler.md) | [ Game_Action](Game_Action.md) |
28 | | [performActionEnd](Window_BattleLog.md#performactionend-subject) | 行動の終了を適用 | [Game_Battler](Game_Battler.md) |
29 | | [performActionStart](Window_BattleLog.md#performactionstart-subject-action) | 行動の開始を適用 | [Game_Battler](Game_Battler.md) | [ Game_Action](Game_Action.md) |
30 | | [performCollapse](Window_BattleLog.md#performcollapse-target) | 倒れたことを適用 | [Game_Battler](Game_Battler.md) |
31 | | [performCounter](Window_BattleLog.md#performcounter-target) | カウンター攻撃を適用 | [Game_Battler](Game_Battler.md) |
32 | | [performDamage](Window_BattleLog.md#performdamage-target) | ダメージを適用 | [Game_Battler](Game_Battler.md) |
33 | | [performEvasion](Window_BattleLog.md#performevasion-target) | 回避を適用 | [Game_Battler](Game_Battler.md) |
34 | | [performMagicEvasion](Window_BattleLog.md#performmagicevasion-target) | 魔法反射を適用 | [Game_Battler](Game_Battler.md) |
35 | | [performMiss](Window_BattleLog.md#performmiss-target) | 攻撃失敗を適用 | [Game_Battler](Game_Battler.md) |
36 | | [performRecovery](Window_BattleLog.md#performrecovery-target) | 回復を適用 | [Game_Battler](Game_Battler.md) |
37 | | [performReflection](Window_BattleLog.md#performreflection-target) | 反射を適用 | [Game_Battler](Game_Battler.md) |
38 | | [performSubstitute](Window_BattleLog.md#performsubstitute-target) | [かばう]行動を適用 | [Game_Battler](Game_Battler.md) |
39 | | [popBaseLine](Window_BattleLog.md#popbaseline-) | 記録した区切り行数に戻る |
40 | | [popupDamage](Window_BattleLog.md#popupdamage-target) | ダメージを表示 | [Game_Battler](Game_Battler.md) |
41 | | [pushBaseLine](Window_BattleLog.md#pushbaseline-) | 区切り行数を記録 |
42 | | [showAnimation](Window_BattleLog.md#showanimation-subject-targets-animationid) | アニメを表示 | [Game_Battler](Game_Battler.md) | [Array](Array.md).<[Game_Battler](Game_Battler.md)> | [Number](Number.md) |
43 | | [wait](Window_BattleLog.md#wait-) | 待つ |
44 | | [waitForEffect](Window_BattleLog.md#waitforeffect-) | エフェクトを待つ |
45 | | [waitForMovement ](Window_BattleLog.md#waitformovement-) | 動作を待つ |
46 | | [waitForNewLine](Window_BattleLog.md#waitfornewline-) | 新たな行を待つ |
47 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.BattleRewards.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).BattleRewards
2 |
3 | ## Type: Object
4 |
5 | 戦闘の報酬パラメータ。
6 |
7 | 関連クラス: [BattleManager](BattleManager.md), [RPG.Enemy](RPG.Enemy.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | ------- | --------------------------------------------------------- | -------------- |
13 | | `gold` | [Number](Number.md) | 所持金 |
14 | | `exp` | [Number](Number.md) | 経験値 |
15 | | `items` | [Array](Array.md).<[RPG.BaseItem](RPG.BaseItem.md)> | アイテムの配列 |
16 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.BattlerAnimation.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).BattlerAnimation
2 |
3 | ## Type: Object
4 |
5 | バトラーのアニメーションのパラメータ。
6 |
7 | 関連クラス: [Game_Battler](Game_Battler.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | ------------- | ------------------- | ----------------- |
13 | | `animationId` | [Number](Number.md) | アニメーション ID |
14 | | `mirror` | Boolean | 反転しているか |
15 | | `delay` | [Number](Number.md) | 継続時間 |
16 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.Color.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).Color
2 |
3 | ## Type: [Array](Array.md).<[Number](Number.md)>
4 |
5 | [色]データ用配列。
6 |
7 | 例えば赤の場合 [ 255, 0, 0, 255 ] となる。
8 |
9 | 関連クラス: [Sprite](Sprite.md), [MV.Tone](MV.Tone.md), [MV.CssColor](MV.CssColor.md)
10 |
11 | ### Contents:
12 |
13 | | Index | Description |
14 | | ----- | ------------------ |
15 | | 0 | 赤( 0〜255 ) |
16 | | 1 | 緑( 0〜255 ) |
17 | | 2 | 青( 0〜255 ) |
18 | | 3 | 不透明度( 0〜255 ) |
19 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.CommandItem.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).CommandItem
2 |
3 | ## Type: Object
4 |
5 | コマンドウィンドウ( [Window_Command](Window_Command.md) )の項目のパラメータ。
6 |
7 | シンボルは、[Window_Selectable.setHandler()](Window_Selectable.md#sethandler-symbol-method)メソッドでコールバック関数に紐づけられるのがパターン。
8 |
9 | 関連クラス:
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | --------- | ------------------- | --------------------------------------------- |
15 | | `name` | [String](String.md) | 表示名 |
16 | | `symbol` | [String](String.md) | シンボル(内部的な名前) |
17 | | `enabled` | Boolean | 選択可能か( true:選択可, false:グレーアウト ) |
18 | | `ext` | \* | 追加情報(例:スキル ID) |
19 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.ConfigData.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).ConfigData
2 |
3 | ## Type: Object
4 |
5 | [オプション]に含まれるパラメータ。
6 |
7 | 関連クラス: [ConfigManager](ConfigManager.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | ----------------- | ------------------- | -------------- |
13 | | `alwaysDash` | Boolean | [常時ダッシュ] |
14 | | `commandRemember` | Boolean | [コマンド記憶] |
15 | | `bgmVolume` | [Number](Number.md) | [BGM 音量] |
16 | | `bgsVolume` | [Number](Number.md) | [BGS 音量] |
17 | | `meVolume` | [Number](Number.md) | [ME 音量] |
18 | | `seVolume` | [Number](Number.md) | [SE 音量] |
19 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.CssColor.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).CssColor
2 |
3 | ## Type: [String](String.md)
4 |
5 | CSS 形式の文字列による色指定方法。
6 |
7 | 16 進による'#ff4000' のような形式の他、関数 rgb( 255, 64, 0 )' や色名'red'などでの指定が可能。
8 |
9 | 簡単に説明すると、'#ff4000' は '#' で始まり RGB(赤・緑・青)の順に二桁区切りで 16 進数を並べた文字列で、返り値はだいたいこの形式で返ってくる( rgba() 形式もある )
10 |
11 | メソッドの引数の場合は、[Utils.rgbToCssColor()](Utils.md#static-rgbtocsscolor-r-g-b--mvcsscolor) を使って上記 16 進形式の文字列を生成できる。
12 |
13 | 詳しくは[MDN の CSS 色](https://developer.mozilla.org/ja/docs/Web/CSS/CSS_Color)などを参照。
14 |
15 | 関連クラス: [Bitmap](Bitmap.md), [Window_Base](Window_Base.md), [Window_NameEdit](Window_NameEdit.md), [MV.Color](MV.Color.md), [MV.Tone](MV.Tone.md)
16 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.DatabaseFile.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).DatabaseFile
2 |
3 | ## Type: Object
4 |
5 | JSON ファイルを読み込む際に使われるパラメータ。
6 |
7 | 関連クラス: [DataManager](DataManager.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | ------ | ------------------- | ---------------------- |
13 | | `name` | [String](String.md) | 大域変数名('$dataXxx') |
14 | | `src` | [String](String.md) | ファイル名('Xxx.json') |
15 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.Matrix.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).Matrix
2 |
3 | ## Type: Object
4 |
5 | どこで使われているかよくわからないパラメータ。
6 | もしかしたら使われていないかもしれないので、そうだったら消す。
7 |
8 | 関連クラス:
9 |
10 | ### Properties:
11 |
12 | | Name | Type | Description |
13 | | ------- | --------------------------------------------- | ----------- |
14 | | `type` | [String](String.md) | |
15 | | `value` | [Array](Array.md).<[Number](Number.md)> | |
16 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.Motion.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).Motion
2 |
3 | ## Type: Object
4 |
5 | サイドビューのアニメーションを指定するパラメータ。
6 |
7 | sv_actors フォルダの画像には、3 パターンのアニメーションが 18 種類あり、index で指定する。
8 |
9 | 関連クラス: [Sprite_Actor](Sprite_Actor.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ------- | ------------------- | -------------------------- |
15 | | `index` | [Number](Number.md) | アニメーションパターン番号 |
16 | | `loop` | Boolean | ループするか |
17 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.SaveContents.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).SaveContents
2 |
3 | ## Type: Object
4 |
5 | セーブされるデータをまとめたパラメータ。
6 |
7 | なお、$gameTemp, $gameMessage, $gameTroop は含まない、$game から始まる大域変数。
8 |
9 | 関連クラス: [DataManager](DataManager.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | -------------- | ----------------------------------------- | ------------------------------------------------------------------ |
15 | | `system` | [Game_System](Game_System.md) | [$gameSystem](global.md#gamesystem-game_system) |
16 | | `screen` | [Game_Screen](Game_Screen.md) | [$gameScreen](global.md#gamescreen-game_screen) |
17 | | `timer` | [Game_Timer](Game_Timer.md) | [$gameTimer](global.md#gametimer-game_timer) |
18 | | `switches` | [Game_Switches](Game_Switches.md) | [$gameSwitches](global.md#gameswitches-game_switches) |
19 | | `variables` | [Game_Variables](Game_Variables.md) | [$gameVariables](global.md#gamevariables-game_variables) |
20 | | `selfSwitches` | [Game_SelfSwitches](Game_SelfSwitches.md) | [$gameSelfSwitches](global.md#$gameselfswitches-game_selfswitches) |
21 | | `actors` | [Game_Actors](Game_Actors.md) | [$gameActors](global.md#gameactors-game\_ actors) |
22 | | `party` | [Game_Party](Game_Party.md) | [$gameParty](global.md#gameparty-game_party) |
23 | | `map` | [Game_Map](Game_Map.md) | [$gameMap](global.md#gamemap-game_map) |
24 | | `player` | [Game_Player](Game_Player.md) | [$gamePlayer](global.md#gameplayer-game_player) |
25 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.SaveFileInfo.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).SaveFileInfo
2 |
3 | ## Type: Object
4 |
5 | セーブファイル情報のパラメータ。
6 |
7 | 関連クラス: [DataManager](DataManager.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | ------------ | ------------------------------------------------------ | ------------- |
13 | | `globalId` | [String](String.md) | グローバル ID |
14 | | `title` | [String](String.md) | タイトル |
15 | | `characters` | [Array](Array.md).<[Array](Array.md).<\*>> | キャラクタ |
16 | | `faces` | [Array](Array.md).<[Array](Array.md).<\*>> | 顔 |
17 | | `playtime` | [String](String.md) | プレイ時間 |
18 | | `timestamp` | Date | 現在時刻 |
19 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.TextState.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).TextState
2 |
3 | ## Type: Object
4 |
5 | テキストの表示に使われるパラメータ。
6 |
7 | 関連クラス: [Window_Base](Window_Base.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | -------- | ------------------- | ------------------ |
13 | | `index` | [Number](Number.md) | 処理中の文字の位置 |
14 | | `x` | [Number](Number.md) | x 座標 |
15 | | `y` | [Number](Number.md) | y 座標 |
16 | | `left` | [Number](Number.md) | 残り |
17 | | `text` | [String](String.md) | 文字列 |
18 | | `height` | [Number](Number.md) | 行高さ |
19 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.Tone.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).Tone
2 |
3 | ## Type: [Array](Array.md).<[Number](Number.md)>
4 |
5 | [色調]データ用配列。
6 |
7 | 例えばセピアの場合 [ 34, -34, -68, 170 ] となる。
8 |
9 | 関連クラス: [Game_Screen](Game_Screen.md), [Game_Picture](Game_Picture.md), [Sprite](Sprite.md),[Spriteset_Base](Spriteset_Base.md), [Window](Window.md), [MV.Color](MV.Color.md), [MV.CssColor](MV.CssColor.md)
10 |
11 | ### Contents:
12 |
13 | | Index | Description |
14 | | ----- | ---------------- |
15 | | 0 | 赤( -255〜255 ) |
16 | | 1 | 緑( -255〜255 ) |
17 | | 2 | 青( -255〜255 ) |
18 | | 3 | グレー( 0〜255 ) |
19 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.TouchInputEvents.md:
--------------------------------------------------------------------------------
1 | # Class: [MV](MV.md).TouchInputEvents
2 |
3 | ## Type: Object
4 |
5 | タッチ入力のイベントのパラメータ。
6 |
7 | 関連クラス: [TouchInput](TouchInput.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | ----------- | ------------------- | ------------------- |
13 | | `trigger` | Boolean | トリガが発生したか |
14 | | `cancelled` | Boolean | キャンセルされたか |
15 | | `moved` | Boolean | 移動中か |
16 | | `released` | Boolean | 離したか |
17 | | `wheelX` | [Number](Number.md) | ホイールの x 移動量 |
18 | | `wheelY` | [Number](Number.md) | ホイールの y 移動量 |
19 |
--------------------------------------------------------------------------------
/docs/jsdoc/MV.md:
--------------------------------------------------------------------------------
1 | # Namespace: MV
2 |
3 | RPG ツクール MV で使われるメソッドのパラメータとなるオブジェクト。
4 |
5 | ネームスペースに MV とか、クラス名を便宜上つけているが、JavaScript 上は単なる Object・Array・String データ。
6 |
7 | ### Objects
8 |
9 | - [AudioParameters](MV.AudioParameters.md)
10 | - [BattleLogMethod](MV.BattleLogMethod.md)
11 | - [BattlerAnimation](MV.BattlerAnimation.md)
12 | - [BattleRewards](MV.BattleRewards.md)
13 | - [CommandItem](MV.CommandItem.md)
14 | - [ConfigData](MV.ConfigData.md)
15 | - [DatabaseFile](MV.DatabaseFile.md)
16 | - [Matrix](MV.Matrix.md)
17 | - [Motion](MV.Motion.md)
18 | - [PluginSettings](MV.PluginSettings.md)
19 | - [SaveContents](MV.SaveContents.md)
20 | - [SaveFileInfo](MV.SaveFileInfo.md)
21 | - [TextState](MV.TextState.md)
22 | - [TouchInputEvents](MV.TouchInputEvents.md)
23 |
24 | ### Arrays
25 |
26 | - [Color](MV.Color.md)
27 | - [Tone](MV.Tone.md)
28 |
29 | ### Strings
30 |
31 | - [CssColor](MV.CssColor.md)
32 |
--------------------------------------------------------------------------------
/docs/jsdoc/Math.md:
--------------------------------------------------------------------------------
1 | # Class: Math
2 |
3 | ### new Math ()
4 |
5 | JavaScript の Math オブジェクトにいくつか RPG ツクール MV 独自のメソッドが追加してある。
6 |
7 | 詳細は [MDN の Math のページ](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Math)を見てもらうとして。
8 | ここでは追加されたメソッドのみ解説。
9 |
10 | ### Methods
11 |
12 | #### (static) randomInt (max) → {[Number](Number.md)}
13 |
14 | 0 以上、指定された数値未満のランダムな整数を返す。
15 |
16 | ##### Parameters:
17 |
18 | | Name | Type | Description |
19 | | ----- | ------------------- | ---------------------------- |
20 | | `max` | [Number](Number.md) | 上限の数値(返るのはこれ未満) |
21 |
--------------------------------------------------------------------------------
/docs/jsdoc/Number.md:
--------------------------------------------------------------------------------
1 | # Class: Number
2 |
3 | ### new Number ()
4 |
5 | JavaScript の数値にいくつか RPG ツクール MV 独自のメソッドが追加してある。
6 |
7 | 詳細は [MDN の Number のページ](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Number)を見てもらうとして。
8 | ここでは追加されたメソッドのみ解説。
9 |
10 | ### Methods
11 |
12 | #### clamp (min, max) → {[Number](Number.md)}
13 |
14 | 指定範囲に収まる値を返す。
15 |
16 | ##### Parameters:
17 |
18 | | Name | Type | Description |
19 | | ----- | ------------------- | ----------- |
20 | | `min` | [Number](Number.md) | 最小値 |
21 | | `max` | [Number](Number.md) | 最大値 |
22 |
23 | #### mod (n) → {[Number](Number.md)}
24 |
25 | 割り算の余りの値を返す。
26 |
27 | % に近いが常に正の値を返す。
28 |
29 | ##### Parameters:
30 |
31 | | Name | Type | Description |
32 | | ---- | ------------------- | ----------- |
33 | | `n` | [Number](Number.md) | 割る数値 |
34 |
35 | #### padZero (length) → {[String](String.md)}
36 |
37 | 数値の頭を 0 で埋めて指定の長さの文字列にして返す。
38 |
39 | ##### Parameters:
40 |
41 | | Name | Type | Description |
42 | | -------- | ------------------- | ------------ |
43 | | `length` | [Number](Number.md) | 文字列の長さ |
44 |
--------------------------------------------------------------------------------
/docs/jsdoc/PluginManager.md:
--------------------------------------------------------------------------------
1 | # Class: PluginManager
2 |
3 | プラグインを管理する静的クラス。
4 |
5 | 関連クラス: [JsonEx](JsonEx.md)
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | ------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
11 | | `_path` | [String](String.md) | [static] プラグインフォルダのパス |
12 | | `_scripts` | [Array](Array.md).<[String](String.md)> | [static] スクリプト名の配列 |
13 | | `_errorUrls` | [Array](Array.md).<[String](String.md)> | [static] 読み込みエラーを記録した配列 |
14 | | `_parameters` | Object | [static] パラメータのオブジェクト { スクリプト名: [Parameters](MV.PluginSettings.md#parameters), … } |
15 |
16 | ### Methods
17 |
18 | #### (static) checkErrors ()
19 |
20 | エラーを検査。
21 |
22 | #### (static) loadScript (name)
23 |
24 | プラグインファイルを読み込む。
25 |
26 | ##### Parameters:
27 |
28 | | Name | Type | Description |
29 | | ------ | ------------------- | ---------------------------- |
30 | | `name` | [String](String.md) | ファイル名(拡張子.js を含む) |
31 |
32 | #### (static) onError (e)
33 |
34 | エラーハンドラ。
35 |
36 | ##### Parameters:
37 |
38 | | Name | Type | Description |
39 | | ---- | ----- | -------------- |
40 | | `e` | Event | エラーイベント |
41 |
42 | #### (static) parameters (name) → {Object}
43 |
44 | 指定プラグイン名に対応するパラメータをオブジェクトで返す。
45 | 返り値の内容は [MV.PluginSettings](MV.PluginSettings.md) の項目を参照。
46 |
47 | ##### Parameters:
48 |
49 | | Name | Type | Description |
50 | | ------ | ------------------- | ------------------------------------ |
51 | | `name` | [String](String.md) | プラグイン名(英字の大小を区別しない) |
52 |
53 | #### (static) setParameters (name, parameters)
54 |
55 | パラメータを設定。
56 |
57 | ##### Parameters:
58 |
59 | | Name | Type | Description |
60 | | ------------ | --------------------------------------------- | ------------------------------------ |
61 | | `name` | [String](String.md) | プラグイン名(英字の大小を区別しない) |
62 | | `parameters` | [Parameters](MV.PluginSettings.md#parameters) | パラメータの[名前]と[値]の組み合わせ |
63 |
64 | #### (static) setup (plugins)
65 |
66 | プラグインの初期化。
67 |
68 | ##### Parameters:
69 |
70 | | Name | Type | Description |
71 | | --------- | ------------------------------------------------------------------- | -------------------- |
72 | | `plugins` | [Array](Array.md).<[MV.PluginSettings](MV.PluginSettings.md)> | プラグイン設定の配列 |
73 |
--------------------------------------------------------------------------------
/docs/jsdoc/Point.md:
--------------------------------------------------------------------------------
1 | # Class: Point
2 |
3 | ## Extends: [PIXI.Point](http://pixijs.download/release/docs/PIXI.Point.html)
4 |
5 | ### new Point (x oot, y opt)
6 |
7 | 座標点を表すクラス。
8 |
9 | 関連クラス: [Rectangle](Rectangle.md)
10 |
11 | #### Parameters:
12 |
13 | | Name | Type | Attributes | Default | Description |
14 | | ---- | ------------------- | ---------------- | ------- | ---------------- |
15 | | `x` | [Number](Number.md) | <optional> | 0 | x 座標(ピクセル) |
16 | | `y` | [Number](Number.md) | <optional> | 0 | y 座標(ピクセル) |
17 |
18 | ### Properties:
19 |
20 | | Name | Type | Description |
21 | | ---- | ------------------- | ---------------- |
22 | | `x` | [Number](Number.md) | x 座標(ピクセル) |
23 | | `y` | [Number](Number.md) | y 座標(ピクセル) |
24 |
25 | ### Methods
26 |
27 | #### initialize ()
28 |
29 | オブジェクト生成時の初期化。
30 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Actor.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Actor
2 |
3 | ## Extends: [RPG.MetaData](RPG.MetaData.md)
4 |
5 | | データベース | JSON ファイル | 大域変数 | オブジェクト | スプライト |
6 | | ------------ | ------------- | -------------------------------------------------------- | --------------------------------- | --------------------------------------- |
7 | | [アクター] | Actors.json | [$dataActors](global.md#dataactors-arrayrpgactor) (配列) | [Game_Actor](Game_Actor.md) | [Sprite_Actor](Sprite_Actor.md) |
8 | | [プレイヤー] | 〃 | 〃 | [Game_Player](Game_Player.md) | [Sprite_Character](Sprite_Character.md) |
9 | | [フォロワー] | 〃 | 〃 | [Game_Follower](Game_Follower.md) | 〃 |
10 |
11 | 関連クラス: [Game_Actors](Game_Actors.md), [Game_Followers](Game_Followers.md)
12 |
13 | ### Properties:
14 |
15 | | Name | Type | Description |
16 | | ---------------- | --------------------------------------------------- | ---------------------------------------------------------- |
17 | | `id` | [Number](Number.md) | アクター ID |
18 | | `name` | [String](String.md) | [名前] |
19 | | `nickname` | [String](String.md) | [二つ名] |
20 | | `classId` | [Number](Number.md) | クラス ID |
21 | | `initialLevel` | [Number](Number.md) | [初期レベル] |
22 | | `maxLevel` | [Number](Number.md) | [最大レベル] |
23 | | `characterName` | [String](String.md) | [歩行キャラ]画像ファイル名(拡張子を含まない) |
24 | | `characterIndex` | [Number](Number.md) | 8 分割された[歩行キャラ]画像のひとつを指定する番号(0 〜 7) |
25 | | `faceName` | [String](String.md) | [顔]画像のファイル名(拡張子を含まない) |
26 | | `faceIndex` | [Number](Number.md) | 8 分割された[顔]画像のひとつを指定する番号(0 〜 7) |
27 | | `battlerName` | [String](String.md) | [[SV]戦闘キャラ]画像ファイル名(拡張子を含まない) |
28 | | `equips` | [Array](Array.md).<[Number](Number.md)> | [初期装備] \(装備アイテム ID の配列) |
29 | | `profile` | [String](String.md) | [プロフィール]の文 |
30 | | `traits` | [Array](Array.md).<[RPG.Trait](RPG.Trait.md)> | [特徴]の配列 |
31 |
32 | `faceName`、`faceIndex` は [Game_Message](Game_Message.md) で顔画像を表示する場合に利用される。
33 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Animation.Timing.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[Animation](RPG.Animation.md).Timing
2 |
3 | [アニメーション]の[SE とフラッシュのタイミング]を記述したデータ。
4 |
5 | 関連クラス: [Sprite_Animation](Sprite_Animation.md)
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | --------------- | --------------------------------------------- | -------------------------------------------------------- |
11 | | `frame` | [Number](Number.md) | [フレーム]番号(エディタで表示されるより 1 少ない) |
12 | | `se` | [RPG.AudioFile](RPG.AudioFile.md) | [SE] |
13 | | `flashScope` | [Number](Number.md) | [フラッシュ範囲](RPG.Animation.Timing.md#フラッシュ範囲) |
14 | | `flashColor` | [Array](Array.md).<[Number](Number.md)> | フラッシュの色の配列 [ 赤, 緑, 青, 強さ ] |
15 | | `flashDuration` | [Number](Number.md) | フラッシュの[時間] \(1/15 秒単位) |
16 |
17 | #### フラッシュ範囲
18 |
19 | 対象消去は対象としているバトラーの画像を消去するので、。
20 |
21 | | 番号 | フラッシュ範囲 |
22 | | ---- | ------------------------------------------------- |
23 | | 0 | なし |
24 | | 1 | 対象(のバトラーがフラッシュ) |
25 | | 2 | 画面(全体がフラッシュ) |
26 | | 3 | 対象消去(されるので、flashColor の値は無視される) |
27 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Animation.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Animation
2 |
3 | | データベース | JSON ファイル | 大域変数 | スプライト |
4 | | ---------------- | --------------- | ------------------------------------------------------------------- | --------------------------------------- |
5 | | [アニメーション] | Animations.json | [$dataAnimations](global.md#dataanimations-arrayrpganimation)(配列) | [Sprite_Animation](Sprite_Animation.md) |
6 |
7 | 同時表示可能な画像 2 種類があり。画像には複数のパターンが含まれる。
8 | 2 つの画像は連結され、パターン番号は共有される。
9 |
10 | 関連クラス: [RPG.UsableItem](RPG.UsableItem.md), [RPG.Weapon](RPG.Weapon.md)
11 |
12 | ### Properties:
13 |
14 | | Name | Type | Description |
15 | | ---------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
16 | | `id` | [Number](Number.md) | アニメーション ID |
17 | | `name` | [String](String.md) | エディタで表示される[名前] |
18 | | `animation1Name` | [String](String.md) | [画像]1 のファイル名(img/animations/ フォルダで、拡張子を含まない) |
19 | | `animation1Hue` | [Number](Number.md) | [画像]1 の色相(0〜360) |
20 | | `animation2Name` | [String](String.md) | [画像]2 のファイル名((img/animations/ フォルダで、拡張子を含まない) |
21 | | `animation2Hue` | [Number](Number.md) | [画像]2 の色相(0〜360) |
22 | | `position` | [Number](Number.md) | [[位置](RPG.Animation.md#位置)] |
23 | | `frameMax` | [Number](Number.md) | 最大[フレーム数] |
24 | | `frames` | [Array](Array.md).<[Array](Array.md).<[Array](Array.md).<[Number](Number.md)>>> | [フレーム情報](RPG.Animation.md#フレーム情報) |
25 | | `timings` | [Array](Array.md).<[RPG.Animation.Timing](RPG.Animation.Timing.md)> | [SE とフラッシュのタイミング]の配列 |
26 |
27 | #### 位置
28 |
29 | [頭上][中心][足元]が全体攻撃で使用された場合、個別のバトラーに表示される。
30 |
31 | | 番号 | [位置] |
32 | | ---- | ------ |
33 | | 0 | 頭上 |
34 | | 1 | 中心 |
35 | | 2 | 足下 |
36 | | 3 | 画面 |
37 |
38 | #### フレーム情報
39 |
40 | 3 次元配列で frames[フレーム番号][セル番号][データ] という構造を持っている。
41 |
42 | | 番号 | [データ] |
43 | | ---- | -------------------------------- |
44 | | 0 | [パターン]番号 |
45 | | 1 | [X]座標(ピクセル) |
46 | | 2 | [Y]座標(ピクセル) |
47 | | 3 | [拡大率]\(%) |
48 | | 4 | [回転角度]\(360 度) |
49 | | 5 | [左右反転]\(0:なし, 1:あり) |
50 | | 6 | [不透明度] |
51 | | 7 | [[合成方法]](Sprite.md#合成方法) |
52 |
53 | ### Classes
54 |
55 | - [RPG.Animation.Timing](RPG.Animation.Timing.md)
56 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Armor.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Armor
2 |
3 | ## Extends: [RPG.EquipItem](RPG.EquipItem.md)
4 |
5 | | データベース | JSON ファイル | 大域変数 | オブジェクト |
6 | | ------------ | ------------- | ------------------------------------------------------- | ------------------------- |
7 | | [防具] | Armors.json | [$dataArmors](global.md#dataarmors-arrayrpgarmor)(配列) | [Game_Item](Game_Item.md) |
8 |
9 | [Game_Item](Game_Item.md) の \_dataClass プロパティは 'armor' になる。
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | --------- | ------------------- | ------------------------------------------ |
15 | | `atypeId` | [Number](Number.md) | [防具タイプ ID](RPG.Armor.md#防具タイプid) |
16 |
17 | #### 防具タイプ ID
18 |
19 | [データベース]-[タイプ]-[防具タイプ] で設定された ID。
20 |
21 | [System](RPG.System.md) の armorTypes プロパティに登録されている。
22 |
23 | 下表は規定値。
24 |
25 | | ID | [防具タイプ] |
26 | | --- | ------------ |
27 | | 1 | 一般防具 |
28 | | 2 | 魔法防具 |
29 | | 3 | 軽装防具 |
30 | | 4 | 重装防具 |
31 | | 5 | 小型盾 |
32 | | 6 | 大型盾 |
33 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.AudioFile.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).AudioFile
2 |
3 | 音声ファイル情報を記述した JSON データ。
4 |
5 | 関連クラス: [RPG.Animation.Timing](RPG.Animation.Timing.md), [SoundManager](SoundManager.md), [WebAudio](WebAudio.md), [Html5Audio](Html5Audio.md)
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | -------- | ------------------- | --------------- |
11 | | `name` | [String](String.md) | 音声ファイル名 |
12 | | `pan` | [Number](Number.md) | パン |
13 | | `pitch` | [Number](Number.md) | ピッチ(50〜150) |
14 | | `volume` | [Number](Number.md) | 音量(0〜100) |
15 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.BaseItem.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).BaseItem
2 |
3 | ## Extends: [RPG.MetaData](RPG.MetaData.md)
4 |
5 | [アイテム]はもちろん、[武器][防具][敵キャラ][状態]などにも使われる基本クラス。
6 |
7 | 関連クラス: [DataManager](DataManager.md)
8 |
9 | ### Sub Classes
10 |
11 | - [RPG.UsableItem](RPG.UsableItem.md)
12 | - [RPG.EquipItem](RPG.EquipItem.md)
13 |
14 | ### Properties:
15 |
16 | | Name | Type | Description |
17 | | ------------- | ------------------- | ----------------------------------------- |
18 | | `id` | [Number](Number.md) | [アイテム ID](RPG.BaseItem.md#アイテムid) |
19 | | `name` | [String](String.md) | [名前] |
20 | | `iconIndex` | [Number](Number.md) | [アイコン]番号 |
21 | | `description` | [String](String.md) | [説明]文 |
22 |
23 | #### アイテム ID
24 |
25 | [データベース]-[アイテム] の番号。
26 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.BattleEventPage.Conditions.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[BattleEventPage](RPG.BattleEventPage.md).Conditions
2 |
3 | [敵グループ]の [EV ページ] の [条件] を構成する JSON データ。
4 |
5 | 関連クラス: [RPG.BattleEventPage](RPG.BattleEventPage.md), [RPG.EventPage.Conditions](RPG.EventPage.Conditions.md)、[RPG.CommonEvent](RPG.CommonEvent.md)
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | ------------- | ------------------- | ---------------------------- |
11 | | `turnEnding` | Boolean | [ターン終了] を使うか |
12 | | `turnValid` | Boolean | [ターン] を使うか |
13 | | `turnA` | [Number](Number.md) | [ターン] + の前の数値 |
14 | | `turnB` | [Number](Number.md) | [ターン] + の後の数値 |
15 | | `enemyValid` | Boolean | [敵キャラ HP] を使うか |
16 | | `enemyIndex` | [Number](Number.md) | [敵キャラ HP] の敵キャラ番号 |
17 | | `enemyHp` | [Number](Number.md) | [敵キャラ HP] \(%) |
18 | | `actorValid` | Boolean | [アクター HP] を使うか |
19 | | `actorId` | [Number](Number.md) | [アクター HP] のアクター ID |
20 | | `actorHp` | [Number](Number.md) | [アクター HP] \(%) |
21 | | `switchValid` | Boolean | [スイッチ] を使うか |
22 | | `switchId` | [Number](Number.md) | [スイッチ] の ID |
23 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.BattleEventPage.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).BattleEventPage
2 |
3 | [RPG.Troop](RPG.Troop.md) の [EV ページ] を構成する JSON データ。
4 |
5 | 関連クラス: [RPG.EventPage](RPG.EventPage.md)
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | ------------ | ------------------------------------------------------------------- | ----------------------------------------- |
11 | | `conditions` | [RPG.BattleEventPage.Conditions](RPG.BattleEventPage.Conditions.md) | [条件] |
12 | | `list` | [Array](Array.md).<[RPG.EventCommand](RPG.EventCommand.md)> | [実行内容] |
13 | | `span` | [Number](Number.md) | [[スパン]](RPG.BattleEventPage.md#スパン) |
14 |
15 | #### [スパン]
16 |
17 | | 番号 | [スパン] |
18 | | ---- | ---------- |
19 | | 0 | バトル |
20 | | 1 | ターン |
21 | | 2 | モーメント |
22 |
23 | ### Classes
24 |
25 | - [RPG.BattleEventPage.Conditions](RPG.BattleEventPage.Conditions.md)
26 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Class.Learning.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[Class](RPG.Class.md).Learning
2 |
3 | スキル取得に必要な条件。[RPG.Class](RPG.Class.md) の learnings プロパティに含まれる。
4 |
5 | ### Properties:
6 |
7 | | Name | Type | Description |
8 | | --------- | ------------------- | ---------------------------------- |
9 | | `level` | [Number](Number.md) | [レベル] |
10 | | `skillId` | [Number](Number.md) | [スキル ID](RPG.Skill.md#スキルid) |
11 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Class.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Class
2 |
3 | ## Extends: [RPG.MetaData](RPG.MetaData.md)
4 |
5 | | データベース | JSON ファイル | 大域変数 | オブジェクト |
6 | | ------------ | ------------- | --------------------------------------------------------- | ------------ |
7 | | [職業] | Classes.json | [$dataClasses](global.md#dataclasses-arrayrpgclass)(配列) | |
8 |
9 | [Game_Actor](Game_Actor.md) の \_classId プロパティで参照される。
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ----------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
15 | | `id` | [Number](Number.md) | 職業 ID |
16 | | `name` | [String](String.md) | [名前] |
17 | | `expParams` | [Array](Array.md).<[Number](Number.md)> | [経験値曲線]
配列の内容(0: 基本値, 1: 補正値, 2: 増加度 A 3:増加度 B) |
18 | | `params` | [Array](Array.md).<[Array](Array.md).<[Number](Number.md)>> | [能力値曲線] \([能力値 ID](RPG.Enemy.md#能力値id)の順の配列に、レベル毎の能力値の配列が入っている) |
19 | | `learnings` | [Array](Array.md).<[RPG.Class.Learning](RPG.Class.Learning.md)> | [取得するスキル]に必要な条件の配列 |
20 | | `traits` | [Array](Array.md).<[RPG.Trait](RPG.Trait.md)> | [特徴]の配列 |
21 |
22 | ### Classes
23 |
24 | - [RPG.Class.Learning](RPG.Class.Learning.md)
25 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.CommonEvent.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).CommonEvent
2 |
3 | | データベース | JSON ファイル | 大域変数 | オブジェクト |
4 | | ---------------- | ----------------- | ------------------------------------------------------------------------- | --------------------------------------- |
5 | | [コモンイベント] | CommonEvents.json | [$dataCommonEvents](global.md#datacommonevents-arrayrpgcommonevent)(配列) | [Game_CommonEvent](Game_CommonEvent.md) |
6 |
7 | 関連クラス: [RPG.Event](RPG.Event.md)、[RPG.Troop](RPG.Troop.md), [RPG.EventPage.Conditions](RPG.EventPage.Conditions.md), [RPG.BattleEventPage.Conditions](RPG.BattleEventPage.Conditions.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | ---------- | ----------------------------------------------------------------- | -------------------------------------------------------- |
13 | | `id` | [Number](Number.md) | [コモンイベント ID](RPG.CommonEvent.md#コモンイベントid) |
14 | | `name` | [String](String.md) | [名前] |
15 | | `trigger` | [Number](Number.md) | [[トリガー](RPG.CommonEvent.md#トリガー)] |
16 | | `switchId` | [Number](Number.md) | [[スイッチ](RPG.CommonEvent.md#スイッチ)] |
17 | | `list` | [Array](Array.md).<[RPG.EventCommand](RPG.EventCommand.md)> | [実行内容] |
18 |
19 | #### コモンイベント ID
20 |
21 | [データベース]-[コモンイベント] の番号。
22 |
23 | #### [トリガー]
24 |
25 | | 番号 | Description |
26 | | ---- | ----------- |
27 | | 0 | [なし] |
28 | | 1 | [自動実行] |
29 | | 2 | [並列処理] |
30 |
31 | #### [スイッチ]
32 |
33 | trigger が 1 か 2 の場合に使われる [Game_Switches](Game_Switches.md)の value() に指定する番号。
34 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Damage.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Damage
2 |
3 | [ダメージ]のデータ。
4 |
5 | 関連クラス: [RPG.UsableItem](RPG.UsableItem.md), [Game_Action](Game_Action.md)
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | ----------- | ------------------- | -------------------------------- |
11 | | `type` | [Number](Number.md) | [タイプ](RPG.Damage.md#タイプ) |
12 | | `elementId` | [Number](Number.md) | [属性 ID](RPG.Damage.md#属性id) |
13 | | `formula` | [String](String.md) | [[計算式]](RPG.Damage.md#計算式) |
14 | | `variance` | [Number](Number.md) | [分散度] % (0〜100) |
15 | | `critical` | Boolean | [会心]するか |
16 |
17 | #### タイプ
18 |
19 | | 番号 | [タイプ] |
20 | | ---- | ----------- |
21 | | 0 | なし |
22 | | 1 | HP ダメージ |
23 | | 2 | MP ダメージ |
24 | | 3 | HP 回復 |
25 | | 4 | MP 回復 |
26 | | 5 | HP 吸収 |
27 | | 6 | MP 吸収 |
28 |
29 | #### 属性 ID
30 |
31 | [データベース]-[タイプ]-[属性] で設定された ID。
32 |
33 | [System](RPG.System.md) の elements プロパティに登録されている。
34 |
35 | 下表の -1 と 0 は固定、1 以降は規定値。
36 |
37 | | ID | [属性] |
38 | | --- | -------- |
39 | | -1 | 通常攻撃 |
40 | | 0 | なし |
41 | | 1 | 物理 |
42 | | 2 | 炎 |
43 | | 3 | 氷 |
44 | | 4 | 雷 |
45 | | 5 | 水 |
46 | | 6 | 土 |
47 | | 7 | 風 |
48 | | 8 | 光 |
49 | | 9 | 闇 |
50 |
51 | #### [計算式]
52 |
53 | 計算式は eval ( [Game_Action.evalDamageFormula](Game_Action.md#evaldamageformula-target--number) )によって処理されるので、例えば Math.random() メソッドなど JavaScript がそのまま記述できる。
54 | また、以下の変数が利用できる。
55 |
56 | | 変数 | 値 |
57 | | ---- | -------------------------------------------------------------------- |
58 | | a | 攻撃側の [Game_BattlerBase](Game_BattlerBase.md) |
59 | | b | 防御側の [Game_BattlerBase](Game_BattlerBase.md) ( target で代用可 ) |
60 | | v | [Game_Variables](Game_Variables.md) の \_data プロパティ |
61 | | item | [RPG.UsableItem](RPG.UsableItem.md) |
62 | | this | [Game_Action](Game_Action.md) |
63 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Effect.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Effect
2 |
3 | アイテムやスキルの[使用効果]のデータ。
4 |
5 | 関連クラス: [Game_Action](Game_Action.md), [RPG.UsableItem](RPG.UsableItem.md)
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | -------- | ------------------- | ---------------------------------------------------- |
11 | | `code` | [Number](Number.md) | [使用効果]コード \([下表](RPG.Effect.md#code)を参照) |
12 | | `dataId` | [Number](Number.md) | code 毎に意味の異なる ID |
13 | | `value1` | [Number](Number.md) | code 毎に意味の異なる値 1 |
14 | | `value2` | [Number](Number.md) | code 毎に意味の異なる値 2 |
15 |
16 | ### code
17 |
18 | code は [Game_Action](Game_Action.md) の定数として定義されている。例えば、Game_Action.EFFECT_RECOVER_HP
のような形で使う。
19 | 下表で、_0_ や _1_ のようなイタリック部分は、数字が入っているが未使用。
20 |
21 | #### [回復]
22 |
23 | | code | 定数 | 使用効果 | dataId | value1 | value2 |
24 | | ---- | ------------------- | -------- | ------ | ----------------- | --------------- |
25 | | 11 | `EFFECT_RECOVER_HP` | HP 回復 | _0_ | 回復量 % (0〜100) | 回復量 (固定値) |
26 | | 12 | `EFFECT_RECOVER_MP` | MP 回復 | _0_ | 回復量 % (0〜100) | 回復量 (固定値) |
27 | | 13 | `EFFECT_GAIN_TP` | TP 増加 | _0_ | 増加量(固定値) | _0_ |
28 |
29 | #### [ステート]
30 |
31 | | code | 定数 | 使用効果 | dataId | value1 | value2 |
32 | | ---- | --------------------- | ------------ | -------------------------------------- | --------------- | ------ |
33 | | 21 | `EFFECT_ADD_STATE` | ステート付加 | [ステート ID](RPG.State.md#ステートID) | 確率 % (0〜100) | _0_ |
34 | | 22 | `EFFECT_REMOVE_STATE` | ステート解除 | [ステート ID](RPG.State.md#ステートID) | 確率 % (0〜100) | _0_ |
35 |
36 | #### [能力値]
37 |
38 | | code | 定数 | 使用効果 | dataId | value1 | value2 |
39 | | ---- | ---------------------- | ---------- | ---------------------------------- | ------------------- | ------ |
40 | | 31 | `EFFECT_ADD_BUFF` | 強化 | [能力値 ID](RPG.Enemy.md#能力値id) | ターン数(1 ~ 1000) | _0_ |
41 | | 32 | `EFFECT_ADD_DEBUFF` | 弱体 | [能力値 ID](RPG.Enemy.md#能力値id) | ターン数(1 ~ 1000) | _0_ |
42 | | 33 | `EFFECT_REMOVE_BUFF` | 強化の解除 | [能力値 ID](RPG.Enemy.md#能力値id) | _1_ | _0_ |
43 | | 34 | `EFFECT_REMOVE_DEBUFF` | 弱体の解除 | [能力値 ID](RPG.Enemy.md#能力値id) | _1_ | _0_ |
44 |
45 | #### [その他]
46 |
47 | | code | 定数 | 使用効果 | dataId | value1 | value2 |
48 | | ---- | --------------------- | -------------- | --------------------------------------- | ------ | ------ |
49 | | 41 | `EFFECT_SPECIAL` | [特殊効果] | [特殊効果 ID](RPG.Effect.md#特殊効果id) | _1_ | _0_ |
50 | | 42 | `EFFECT_GROW` | 成長 | [能力値 ID](RPG.Enemy.md#能力値id) | 上昇値 | _0_ |
51 | | 43 | `EFFECT_LEARN_SKILL` | スキル習得 | [スキル ID](RPG.Skill.md#スキルid) | _1_ | _0_ |
52 | | 44 | `EFFECT_COMMON_EVENT` | コモンイベント | コモンイベント ID | _1_ | _0_ |
53 |
54 | ##### 特殊効果 ID
55 |
56 | | dataId | 定数 | 使用効果 |
57 | | ------ | ----------------------- | -------- |
58 | | 0 | `SPECIAL_EFFECT_ESCAPE` | 逃げる |
59 |
60 | ##### dataId:コモンイベント ID
61 |
62 | [$dataCommonEvents](global.md#datacommonevents-arrayrpgcommonevent) ([CommonEvent](RPG.CommonEvent.md) の配列)の番号。
63 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Enemy.Action.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[Enemy](RPG.Enemy.md).Action
2 |
3 | [敵キャラ]の[行動パターン]の JSON データ。
4 |
5 | 関連クラス: [Game_Enemy](Game_Enemy.md)
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | ----------------- | ------------------- | ---------------------------------- |
11 | | `skillId` | [Number](Number.md) | [スキル ID](RPG.Skill.md#スキルid) |
12 | | `conditionType` | [Number](Number.md) | [[条件](RPG.Enemy.Action.md#条件)] |
13 | | `conditionParam1` | [Number](Number.md) | [条件] パラメータ 1 |
14 | | `conditionParam2` | [Number](Number.md) | [条件] パラメータ 2 |
15 | | `rating` | [Number](Number.md) | [レーティング] \(1〜10) |
16 |
17 | #### [条件]
18 |
19 | _0_ のようなイタリック部分は、数字が入っているが未使用。
20 |
21 | | 番号 | [条件] | conditionParam1 | conditionParam2 |
22 | | ---- | ----------- | -------------------------------------- | --------------- |
23 | | 0 | 常時 | _0_ | _0_ |
24 | | 1 | ターン | 開始ターン | ターン間隔 |
25 | | 2 | HP | 下限% | 上限% |
26 | | 3 | MP | 下限% | 上限% |
27 | | 4 | ステート | [ステート ID](RPG.State.md#ステートid) | _0_ |
28 | | 5 | パーティ Lv | 下限 Lv | _0_ |
29 | | 6 | スイッチ | スイッチ ID | _0_ |
30 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Enemy.DropItem.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[Enemy](RPG.Enemy.md).DropItem
2 |
3 | [ドロップアイテム]の JSON データ。
4 |
5 | ### Properties:
6 |
7 | | Name | Type | Description |
8 | | ------------- | ------------------- | ---------------------------------- |
9 | | `kind` | [Number](Number.md) | [種類](RPG.Enemy.DropItem.md#種類) |
10 | | `dataId` | [Number](Number.md) | 種類毎の ID |
11 | | `denominator` | [Number](Number.md) | 1/N で表される[出現率]の N の部分 |
12 |
13 | #### 種類
14 |
15 | | 番号 | 種類 | dataId |
16 | | ---- | -------- | ----------- |
17 | | 0 | なし | |
18 | | 1 | アイテム | アイテム ID |
19 | | 2 | 武器 | 武器 ID |
20 | | 3 | 防具 | 防具 ID |
21 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Enemy.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Enemy
2 |
3 | ## Extends: [RPG.MetaData](RPG.MetaData.md)
4 |
5 | | データベース | JSON ファイル | 大域変数 | オブジェクト |
6 | | ------------ | ------------- | ---------------------------------------------------------- | --------------------------- |
7 | | [敵キャラ] | Enemies.json | [$dataEnemies](global.md#dataenemies-arrayrpgenemy) (配列) | [Game_Enemy](Game_Enemy.md) |
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | ------------- | --------------------------------------------------------------- | ---------------------------------------------------------- |
13 | | `battlerName` | [String](String.md) | 画像ファイル名(拡張子なし) |
14 | | `battlerHue` | [Number](Number.md) | [色相] \(0~360) |
15 | | `name` | [String](String.md) | [名前] |
16 | | `id` | [Number](Number.md) | 敵キャラ ID |
17 | | `params` | [Array](Array.md).<[Number](Number.md)> | [能力値 ID](RPG.Enemy.md#能力値id)の順に値が記録された配列 |
18 | | `exp` | [Number](Number.md) | [経験値] |
19 | | `gold` | [Number](Number.md) | [所持金] |
20 | | `dropItems` | [Array](Array.md).<[RPG.Enemy.DropItem](RPG.Enemy.DropItem.md)> | [ドロップアイテム]の配列 |
21 | | `actions` | [Array](Array.md).<[RPG.Enemy.Action](RPG.Enemy.Action.md)> | [行動パターン]の配列 |
22 | | `traits` | [Array](Array.md).<[RPG.Trait](RPG.Trait.md)> | [特徴]の配列 |
23 |
24 | #### 能力値 ID
25 |
26 | | ID | [能力値] |
27 | | --- | -------- |
28 | | 0 | 最大 HP |
29 | | 1 | 最大 MP |
30 | | 2 | 攻撃力 |
31 | | 3 | 防御力 |
32 | | 4 | 魔法力 |
33 | | 5 | 魔法防御 |
34 | | 6 | 敏捷性 |
35 | | 7 | 運 |
36 |
37 | ### Classes
38 |
39 | - [RPG.Enemy.Action](RPG.Enemy.Action.md)
40 | - [RPG.Enemy.DropItem](RPG.Enemy.DropItem.md)
41 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.EquipItem.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).EquipItem
2 |
3 | ## Extends: [RPG.BaseItem](RPG.BaseItem.md)
4 |
5 | ### Sub Classes
6 |
7 | - [RPG.Armor](RPG.Armor.md)
8 | - [RPG.Weapon](RPG.Weapon.md)
9 |
10 | ### Properties:
11 |
12 | | Name | Type | Description |
13 | | --------- | --------------------------------------------------- | -------------------------------------------------------------------- |
14 | | `price` | [Number](Number.md) | [価格] |
15 | | `etypeId` | [Number](Number.md) | [装備タイプ ID](RPG.EquipItem.md#装備タイプID) |
16 | | `params` | [Array](Array.md).<[Number](Number.md)> | [能力値 ID](RPG.Enemy.md#能力値id)の順に[能力値変化量]が書かれた配列 |
17 | | `traits` | [Array](Array.md).<[RPG.Trait](RPG.Trait.md)> | [特徴]の配列 |
18 |
19 | #### 装備タイプ ID
20 |
21 | [データベース]-[タイプ]-[装備タイプ] で設定された ID。
22 |
23 | [System](RPG.System.md) の equipTypes プロパティに登録されている。
24 |
25 | 下表は規定値。
26 |
27 | | ID | [装備タイプ] |
28 | | --- | ------------ |
29 | | 0 | なし |
30 | | 1 | 盾 |
31 | | 2 | 頭 |
32 | | 3 | 身体 |
33 | | 4 | 装飾品 |
34 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Event.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Event
2 |
3 | ## Extends: [RPG.MetaData](RPG.MetaData.md)
4 |
5 | | データベース | オブジェクト | スプライト |
6 | | ------------ | --------------------------- | --------------------------------------- |
7 | | [イベント] | [Game_Event](Game_Event.md) | [Sprite_Character](Sprite_Character.md) |
8 |
9 | マップ[イベント]を構成する JSON データ。
10 |
11 | [RPG.Map](RPG.Map.md)の events プロパティに含まれ、[Game_Event.event()](Game_Event.md#event---rpgevent) メソッドでも得られる。
12 |
13 | 関連クラス: [RPG.CommonEvent](RPG.CommonEvent.md), [RPG.Troop](RPG.Troop.md)
14 |
15 | ### Properties:
16 |
17 | | Name | Type | Description |
18 | | ------- | ----------------------------------------------------------- | ----------------- |
19 | | `id` | [Number](Number.md) | イベント ID |
20 | | `name` | [String](String.md) | イベント名 |
21 | | `x` | [Number](Number.md) | x 座標(タイル数) |
22 | | `y` | [Number](Number.md) | y 座標(タイル数) |
23 | | `pages` | [Array](Array.md).<[RPG.EventPage](RPG.EventPage.md)> | [EV ページ]の配列 |
24 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.EventCommand.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).EventCommand
2 |
3 | [実行内容]に記述される[イベントコマンド] を構成する JSON データ。
4 |
5 | 記述された内容は [Game_Interpreter](Game_Interpreter.md) の commandXXX メソッドで処理される。
6 |
7 | 関連クラス: [RPG.EventPage](RPG.EventPage.md), [RPG.BattleEventPage](RPG.BattleEventPage.md), [RPG.CommonEvent](RPG.CommonEvent.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | ------------ | ---------------------------- | ------------------------------------------------------------------------------------ |
13 | | `code` | [Number](Number.md) | イベント番号 |
14 | | `indent` | [Number](Number.md) | 階層(インデント)の深さ
(通常は 0 で[条件分岐]コマンドにより 1 階層ずつ深くなる) |
15 | | `parameters` | [Array](Array.md).<\*> | コマンドに渡される引数の配列 |
16 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.EventPage.Conditions.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[EventPage](RPG.EventPage.md).Conditions
2 |
3 | イベントの [EV ページ] の [出現条件] を構成する JSON データ。
4 | [RPG.EventPage](RPG.EventPage.md) の conditions プロパティに含まれる。
5 |
6 | 関連クラス: [RPG.CommonEvent](RPG.CommonEvent.md)、[RPG.BattleEventPage.Conditions](RPG.BattleEventPage.Conditions.md)
7 |
8 | ### Properties:
9 |
10 | | Name | Type | Description |
11 | | ----------------- | ------------------- | ----------------------------------------- |
12 | | `switch1Valid` | Boolean | 1 番目の [スイッチ] を使うか |
13 | | `switch1Id` | [Number](Number.md) | 1 番目の [スイッチ] の ID |
14 | | `switch2Valid` | Boolean | 2 番目の [スイッチ] を使うか |
15 | | `switch2Id` | [Number](Number.md) | 2 番目の [スイッチ] の ID |
16 | | `variableValid` | Boolean | [変数] を使うか |
17 | | `variableId` | [Number](Number.md) | [変数] の ID |
18 | | `variableValue` | [Number](Number.md) | [変数] の数値 |
19 | | `selfSwitchValid` | Boolean | [セルフスイッチ] を使うか |
20 | | `selfSwitchCh` | [String](String.md) | [セルフスイッチ] の記号(A,B,C,D いずれか) |
21 | | `itemValid` | Boolean | [アイテム] を使うか |
22 | | `itemId` | [Number](Number.md) | [アイテム] の ID |
23 | | `actorValid` | Boolean | [アクター] を使うか |
24 | | `actorId` | [Number](Number.md) | [アクター] の ID |
25 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.EventPage.Image.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[EventPage](RPG.EventPage.md).Image
2 |
3 | イベントの [EV ページ] の [画像] を構成する JSON データ。
4 |
5 | [RPG.EventPage](RPG.EventPage.md) の image プロパティに含まれる。
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | ---------------- | ------------------- | ------------------------------------------------------- |
11 | | `tileId` | [Number](Number.md) | タイル ID (0 : タイルでない場合) |
12 | | `characterName` | [String](String.md) | 画像ファイル名(characters フォルダ以下 .png を含まない) |
13 | | `characterIndex` | [Number](Number.md) | ファイル内のキャラ番号(0 〜 7) |
14 | | `direction` | [Number](Number.md) | キャラの向き (2: 下, 4: 左, 6: 右, 8: 上). |
15 | | `pattern` | [Number](Number.md) | キャラのアニメパターン(0,1,2) |
16 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.EventPage.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).EventPage
2 |
3 | イベントの[EV ページ]を構成する JSON データ。
4 |
5 | [RPG.Event](RPG.Event.md) pages プロパティに含まれている。
6 |
7 | 関連クラス: [RPG.BattleEventPage](RPG.BattleEventPage.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | --------------- | ----------------------------------------------------------------- | ------------------------------------------------------- |
13 | | `conditions` | [RPG.EventPage.Conditions](RPG.EventPage.Conditions.md) | [出現条件] |
14 | | `image` | [RPG.EventPage.Image](RPG.EventPage.Image.md) | [画像] |
15 | | `moveType` | [Number](Number.md) | [自律移動の[タイプ]](RPG.EventPage.md#自律移動のタイプ) |
16 | | `moveSpeed` | [Number](Number.md) | [自律移動の[速度]](RPG.EventPage.md#自律移動の速度) |
17 | | `moveFrequency` | [Number](Number.md) | [自律移動の[頻度]](RPG.EventPage.md#自律移動の頻度) |
18 | | `moveRoute` | [Array](Array.md).<[RPG.MoveRoute](RPG.MoveRoute.md)> | [ルート] \(moveType が 3: カスタム の場合に有効) |
19 | | `walkAnime` | Boolean | [歩行アニメ] |
20 | | `stepAnime` | Boolean | [足踏みアニメ] |
21 | | `directionFix` | Boolean | [向き固定] |
22 | | `through` | Boolean | [すり抜け] |
23 | | `priorityType` | [Number](Number.md) | [[プライオリティ]](RPG.EventPage.md#プライオリティ) |
24 | | `trigger` | [Number](Number.md) | [[トリガー]](RPG.EventPage.md#トリガー) |
25 | | `list` | [Array](Array.md).<[RPG.EventCommand](RPG.EventCommand.md)> | [実行内容] |
26 |
27 | #### 自律移動の[タイプ]
28 |
29 | | 番号 | [タイプ] |
30 | | ---- | -------- |
31 | | 0 | 固定 |
32 | | 1 | ランダム |
33 | | 2 | 近づく |
34 | | 3 | カスタム |
35 |
36 | #### 自律移動の[速度]
37 |
38 | | 番号 | [速度] |
39 | | ---- | -------- |
40 | | 1 | 1/8 倍速 |
41 | | 2 | 1/4 倍速 |
42 | | 3 | 1/2 倍速 |
43 | | 4 | 標準速 |
44 | | 5 | 2 倍速 |
45 | | 6 | 4 倍速 |
46 |
47 | #### 自律移動の[頻度]
48 |
49 | | 番号 | [頻度] |
50 | | ---- | ------ |
51 | | 1 | 最低 |
52 | | 2 | 低 |
53 | | 3 | 標準 |
54 | | 4 | 高 |
55 | | 5 | 最高 |
56 |
57 | #### [プライオリティ]
58 |
59 | | 番号 | [プライオリティ] |
60 | | ---- | ---------------- |
61 | | 0 | 通常キャラの下 |
62 | | 1 | 通常キャラと同じ |
63 | | 2 | 通常キャラの上 |
64 |
65 | #### [トリガー]
66 |
67 | | 番号 | [トリガー] |
68 | | ---- | ------------------ |
69 | | 0 | 決定ボタン |
70 | | 1 | プレイヤーから接触 |
71 | | 2 | イベントから接触 |
72 | | 3 | 自動実行 |
73 | | 4 | 並列処理 |
74 |
75 | ### Classes
76 |
77 | - [RPG.EventPage.Conditions](RPG.EventPage.Conditions.md)
78 | - [RPG.EventPage.Image](RPG.EventPage.Image.md)
79 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Item.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Item
2 |
3 | ## Extends: [RPG.UsableItem](RPG.UsableItem.md)
4 |
5 | | データベース | JSON ファイル | 大域変数 | オブジェクト |
6 | | ------------ | ------------- | ---------------------------------------------------- | ------------------------- |
7 | | [アイテム] | Items.json | [$dataItems](global.md#dataitems-arrayrpgitem)(配列) | [Game_Item](Game_Item.md) |
8 |
9 | [Game_Item](Game_Item.md) の \_dataClass プロパティは 'item' になる。
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ------------ | ------------------- | ------------------------------------------------- |
15 | | `itypeId` | [Number](Number.md) | [アイテムタイプ ID](RPG.Item.md#アイテムタイプid) |
16 | | `price` | [Number](Number.md) | [価格] |
17 | | `consumable` | Boolean | [消耗]するか |
18 |
19 | #### アイテムタイプ ID
20 |
21 | | ID | [アイテムタイプ] |
22 | | --- | ---------------- |
23 | | 1 | 通常アイテム |
24 | | 2 | 大事なもの |
25 | | 3 | 隠しアイテム A |
26 | | 4 | 隠しアイテム B |
27 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Map.Encounter.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[Map](RPG.Map.md).Encounter
2 |
3 | [エンカウント]の JSON データ。
4 |
5 | ### Properties:
6 |
7 | | Name | Type | Description |
8 | | ----------- | --------------------------------------------- | ----------------------------------------------- |
9 | | `troopId` | [Number](Number.md) | 敵グループ ID ([RPG.Troop](RPG.Troop.md)を参照) |
10 | | `weight` | [Number](Number.md) | [重み] |
11 | | `regionSet` | [Array](Array.md).<[Number](Number.md)> | リージョン ID の配列 |
12 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Map.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Map
2 |
3 | ## Extends: [RPG.MetaData](RPG.MetaData.md)
4 |
5 | | データベース | JSON ファイル | 大域変数 | オブジェクト | スプライトセット |
6 | | ------------ | ------------- | ------------------------------------ | ----------------------- | --------------------------------- |
7 | | マップ | MapXXX.json | [$dataMap](global.md#datamap-rpgmap) | [Game_Map](Game_Map.md) | [Spriteset_Map](Spriteset_Map.md) |
8 |
9 | JSON ファイルの XXX は 3 桁の数値。
10 |
11 | 関連クラス: [Scene_Map](Scene_Map.md), [ShaderTilemap](ShaderTilemap.md), [RPG.MapInfo](RPG.MapInfo.md)
12 |
13 | ### Properties:
14 |
15 | | Name | Type | Description |
16 | | ------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------- |
17 | | `displayName` | [String](String.md) | [表示名] |
18 | | `tilesetId` | [Number](Number.md) | [タイルセット]の ID |
19 | | `width` | [Number](Number.md) | マップの[幅] \(タイル数) |
20 | | `height` | [Number](Number.md) | マップの[高さ] \(タイル数) |
21 | | `scrollType` | [Number](Number.md) | [[スクロールタイプ]](RPG.Map.md#スクロールタイプ) |
22 | | `specifyBattleback` | Boolean | [戦闘背景指定]するか |
23 | | `battleback1Name` | [String](String.md) | レイヤー奥の戦闘背景画像 1(地面)のファイル名 |
24 | | `battleback2Name` | [String](String.md) | レイヤー手前の戦闘背景画像 2(壁)のファイル名 |
25 | | `autoplayBgm` | Boolean | [BGM 自動演奏]するか |
26 | | `bgm` | [RPG.AudioFile](RPG.AudioFile.md) | BGM の音声 |
27 | | `autoplayBgs` | Boolean | [BGS 自動演奏]するか |
28 | | `bgs` | [RPG.AudioFile](RPG.AudioFile.md) | BGS の音声 |
29 | | `disableDashing` | Boolean | [ダッシュ禁止]か |
30 | | `encounterList` | [Array](Array.md).<[RPG.Map.Encounter](RPG.Map.Encounter.md)> | [エンカウント]の配列 |
31 | | `encounterStep` | [Number](Number.md) | [敵出現歩数] |
32 | | `parallaxName` | [String](String.md) | [遠景]の画像ファイル名 |
33 | | `parallaxLoopX` | Boolean | [遠景]が[横方向にループする]か |
34 | | `parallaxLoopY` | Boolean | [遠景]が[縦方向にループする]か |
35 | | `parallaxSx` | [Number](Number.md) | [遠景]が[横方向にループする]場合の[スクロール]量 |
36 | | `parallaxSy` | [Number](Number.md) | [遠景]が[縦方向にループする]場合の[スクロール]量 |
37 | | `parallaxShow` | Boolean | [遠景]を[エディターに表示する]か |
38 | | `data` | [Array](Array.md).<[Number](Number.md)> | タイル ID の配列による[マップデータ](RPG.Map.md#マップデータ) |
39 | | `events` | [Array](Array.md).<[RPG.Event](RPG.Event.md)> | [イベント]データの配列 |
40 |
41 | #### [スクロールタイプ]
42 |
43 | | 番号 | [スクロールタイプ] |
44 | | ---- | ------------------ |
45 | | 0 | ループしない |
46 | | 1 | 縦方向にループする |
47 | | 2 | 横方向にループする |
48 | | 3 | 縦横共にループする |
49 |
50 | #### マップデータ
51 |
52 | data プロパティは一次元配列で、data[ x + ( y + z\*h )\*w ]
の形で取り出せる。
53 | x: x 座標, y: y 座標, w: マップ幅, h: マップ高さ, z: マップレイヤー
54 |
55 | ##### z:マップレイヤー
56 |
57 | | z | Description |
58 | | --- | ------------- |
59 | | 5 | リージョン |
60 | | 4 | 影ペン |
61 | | 3 | B〜E タイル |
62 | | 2 | B〜E タイル |
63 | | 1 | A2 右側タイル |
64 | | 0 | A タイル |
65 |
66 | ### Classes
67 |
68 | - [RPG.Map.Encounter](RPG.Map.Encounter.md)
69 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.MapInfo.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).MapInfo
2 |
3 | | データベース | JSON ファイル | 大域変数 |
4 | | ------------ | ------------- | ------------------------------------------------------------- |
5 | | マップ一覧 | MapInfos.json | [$dataMapInfos](global.md#datamapInfos-arrayrpgmapInfo)(配列) |
6 |
7 | 含まれる情報はエディタ用。
8 |
9 | 関連クラス: [RPG.Map](RPG.Map.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ---------- | ------------------- | ------------------------------ |
15 | | `id` | [Number](Number.md) | [ID] \(おそらく未使用) |
16 | | `name` | [String](String.md) | [名前] |
17 | | `parentId` | [Number](Number.md) | 親のマップ ID |
18 | | `order` | [Number](Number.md) | エディタへの表示順 |
19 | | `expanded` | Boolean | エディタでリストが開いているか |
20 | | `scrollX` | [Number](Number.md) | エディタで開く x 位置 |
21 | | `scrollY` | [Number](Number.md) | エディタで開く y 位置 |
22 |
23 | ※ `id` は実装上は配列番号が使われていて、このプロパティは使われていないようだ。
24 | そのため、MapInfos.json に並んだ null, 行を削除するなどして配列番号が変わると ID がずれてしまう。
25 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.MetaData.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).MetaData
2 |
3 | 多くのデータに含まれる[メモ]のデータ。
4 |
5 | note から meta への変換は[DataManager.extractMetadata](DataManager.md#static-extractmetadata-data)メソッドで行われる。
6 | meta プロパティに記録されたデータは、プラグイン用のパラメータとして使う。
7 |
8 | ### Sub Classes
9 |
10 | - [RPG.Actor](RPG.Actor.md)
11 | - [RPG.Class](RPG.Class.md)
12 | - [RPG.Enemy](RPG.Enemy.md)
13 | - [RPG.Event](RPG.Event.md)
14 | - [RPG.BaseItem](RPG.BaseItem.md)
15 | - [RPG.Map](RPG.Map.md)
16 | - [RPG.State](RPG.State.md)
17 | - [RPG.Tileset](RPG.Tileset.md)
18 |
19 | ### Properties:
20 |
21 | | Name | Type | Description |
22 | | ------ | ------------------- | --------------------------------------------------- |
23 | | `note` | [String](String.md) | [メモ]の内容 |
24 | | `meta` | Object | note 内の <名前:値>形式のデータを解析した結果 |
25 |
26 | #### meta の形式
27 |
28 | [メモ]の中に <名前:値> もしくは <名前> の形で書く。
29 | <名前:値> の場合の値は String が返ってくる。
30 | <名前> の場合の値は Boolean の true
が返る。
31 |
32 | RPG.MetaData が入った変数 e から値を取り出す場合。
33 | e.名前 か e[ '名前' ] と書く。
34 |
35 | 各オブジェクトの初期化メソッド( initialize ) で meta の値を取り出し、オブジェクトの変数に保存しておくのが、定番の処理方法。
36 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.MoveCommand.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).MoveCommand
2 |
3 | [移動コマンド]を構成する JSON データ。
4 |
5 | [RPG.MoveRoute](RPG.MoveRoute.md) の list に配列として含まれる。
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | ------------ | ---------------------------- | ------------------------------------------------------------------------------ |
11 | | `code` | [Number](Number.md) | コマンドのコード番号([Game_Character](Game_Character.md) に定数が定義してある) |
12 | | `parameters` | [Array](Array.md).<\*> | コマンド毎に必要な引数 |
13 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.MoveRoute.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).MoveRoute
2 |
3 | [移動ルート]を構成する JSON データ。
4 |
5 | 関連クラス: [Game_Character](Game_Character.md)
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | ----------- | --------------------------------------------------------------- | -------------------------- |
11 | | `repeat` | Boolean | [動作をくり返す] |
12 | | `skippable` | Boolean | [移動できない場合は飛ばす] |
13 | | `wait` | Boolean | [完了までウエイト] |
14 | | `list` | [Array](Array.md).<[RPG.MoveCommand](RPG.MoveCommand.md)> | [移動コマンド]の配列 |
15 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Skill.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Skill
2 |
3 | ## Extends: [RPG.UsableItem](RPG.UsableItem.md)
4 |
5 | | データベース | JSON ファイル | 大域変数 | オブジェクト |
6 | | ------------ | ------------- | ------------------------------------------------------- | ------------------------- |
7 | | [スキル] | Skills.json | [$dataSkills](global.md#dataskills-arrayrpgskill)(配列) | [Game_Item](Game_Item.md) |
8 |
9 | [Game_Item](Game_Item.md) の \_dataClass プロパティは 'skill' になる。
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ------------------ | ------------------- | ---------------------------------------------- |
15 | | `stypeId` | [Number](Number.md) | [スキルタイプ ID](RPG.Skill.md#スキルタイプid) |
16 | | `mpCost` | [Number](Number.md) | [消費 MP] |
17 | | `tpCost` | [Number](Number.md) | [消費 TP] |
18 | | `message1` | [String](String.md) | 上段[メッセージ] |
19 | | `message2` | [String](String.md) | 下段[メッセージ] |
20 | | `requiredWtypeId1` | [Number](Number.md) | [必要武器]の[武器タイプ 1] |
21 | | `requiredWtypeId2` | [Number](Number.md) | [必要武器]の[武器タイプ 2] |
22 |
23 | #### スキル ID
24 |
25 | [データベース]-[スキル] で設定された ID。大域変数 [$dataSkills](global.md#dataskills-arrayrpgskill) の配列の番号でもある。
26 | 下表 0〜2 は固定、他は規定値で変更可能。
27 |
28 | | ID | [スキル] |
29 | | --- | ---------- |
30 | | 0 | なし |
31 | | 1 | 攻撃 |
32 | | 2 | 防御 |
33 | | 3 | 連続攻撃 |
34 | | 4 | 2 回攻撃 |
35 | | 5 | 3 回攻撃 |
36 | | 6 | 逃げる |
37 | | 7 | 様子を見る |
38 | | 5 | ヒール |
39 | | 6 | ファイア |
40 | | 7 | スパーク |
41 |
42 | #### スキルタイプ ID
43 |
44 | [データベース]-[タイプ]-[スキルタイプ] で設定された ID。
45 | スキルタイプ名は [System](RPG.System.md) の skillTypes プロパティに登録されている。
46 |
47 | 下表 0 は固定、他は規定値で変更可能。
48 |
49 | | ID | [スキルタイプ] |
50 | | --- | -------------- |
51 | | 0 | なし |
52 | | 1 | 魔法 |
53 | | 2 | 必殺技 |
54 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.State.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).State
2 |
3 | ## Extends: [RPG.MetaData](RPG.MetaData.md)
4 |
5 | | データベース | JSON ファイル | 大域変数 | スプライト |
6 | | ------------ | ------------- | ------------------------------------------------------- | --------------------------------------- |
7 | | [ステート] | States.json | [$dataStates](global.md#datastates-arrayrpgstate)(配列) | [Sprite_StateIcon](Sprite_StateIcon.md) |
8 |
9 | エディタ上の利用方法については公式の [RPG ツクール MV 初心者講座 ステート作成例](https://tkool.jp/mv/guide/004_007c.html) を参照。
10 |
11 | 関連クラス: [Game_BattlerBase](Game_BattlerBase.md), [Game_Battler](Game_Battler.md), [Game_Actor](Game_Actor.md), [Game_Enemy](Game_Enemy.md), [Game_ActionResult](Game_ActionResult.md), [Window_BattleLog](Window_BattleLog.md), [RPG.Effect](RPG.Effect.md), [RPG.Trait](RPG.Trait.md)
12 |
13 | ### Properties:
14 |
15 | | Name | Type | Description |
16 | | --------------------- | --------------------------------------------------- | ----------------------------------------------------------- |
17 | | `id` | [Number](Number.md) | [ステート ID](RPG.State.md#ステートid) |
18 | | `name` | [String](String.md) | [名前] |
19 | | `restriction` | [Number](Number.md) | [[行動制約]](RPG.State.md#行動制約)) |
20 | | `priority` | [Number](Number.md) | [優先度] \(0~100) |
21 | | `removeAtBattleEnd` | Boolean | [戦闘終了時に解除] |
22 | | `removeByRestriction` | Boolean | [行動制約によって解除] |
23 | | `autoRemovalTiming` | [Number](Number.md) | [[自動解除のタイミング]](RPG.State.md#自動解除のタイミング) |
24 | | `minTurns` | [Number](Number.md) | [継続ターン数]の下限 |
25 | | `maxTurns` | [Number](Number.md) | [継続ターン数]の上限 |
26 | | `removeByDamage` | Boolean | [ダメージで解除] |
27 | | `chanceByDamage` | [Number](Number.md) | [ダメージで解除]の%確率 |
28 | | `removeByWalking` | Boolean | [歩数で解除] |
29 | | `stepToRemove` | [Number](Number.md) | [歩数で解除]の歩数 |
30 | | `iconIndex` | [Number](Number.md) | [アイコン]番号 |
31 | | `message1` | [String](String.md) | [アクターがこの状態になったとき] |
32 | | `message2` | [String](String.md) | [敵キャラがこの状態になったとき] |
33 | | `message3` | [String](String.md) | [この状態が継続しているとき] |
34 | | `message4` | [String](String.md) | [この状態が解除されたとき] |
35 | | `motion` | [Number](Number.md) | [[SV]モーション] |
36 | | `overlay` | [Number](Number.md) | [[SV]重ね合わせ] |
37 | | `traits` | [Array](Array.md).<[RPG.Trait](RPG.Trait.md)> | [特徴]の配列 |
38 |
39 | #### ステート ID
40 |
41 | 以下 ID 0 は固定、他は規定値。ID 1 は HP が 0 になった時に自動的に付加されるステート。
42 |
43 | | ID | [ステート] |
44 | | --- | ---------- |
45 | | 0 | 通常 |
46 | | 1 | 戦闘不能 |
47 | | 2 | 防御 |
48 | | 3 | 不死身 |
49 | | 4 | 毒 |
50 | | 5 | 暗闇 |
51 | | 6 | 沈黙 |
52 | | 7 | 激昂 |
53 | | 8 | 混乱 |
54 | | 9 | 魅了 |
55 | | 10 | 睡眠 |
56 |
57 | #### [行動制約]
58 |
59 | | 番号 | [行動制約] |
60 | | ---- | ------------ |
61 | | 0 | なし |
62 | | 1 | 敵に攻撃 |
63 | | 2 | 誰かを攻撃 |
64 | | 3 | 味方を攻撃 |
65 | | 4 | 行動できない |
66 |
67 | #### [自動解除のタイミング]
68 |
69 | | 番号 | [自動解除のタイミング] |
70 | | ---- | ---------------------- |
71 | | 0 | なし |
72 | | 1 | 行動終了時 |
73 | | 2 | 誰ターン終了時 |
74 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.System.AttackMotion.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[System](RPG.System.md).AttackMotion
2 |
3 | [[SV]攻撃モーション]の JSON データ。
4 |
5 | ### Properties:
6 |
7 | | Name | Type | Description |
8 | | --------------- | ------------------- | ------------- |
9 | | `type` | [Number](Number.md) | タイプ |
10 | | `weaponImageId` | [Number](Number.md) | 武器の画像 ID |
11 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.System.Terms.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[System](RPG.System.md).Terms
2 |
3 | [用語]の JSON データ。
4 |
5 | 関連クラス: [TextManager](TextManager.md)
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | ---------- | --------------------------------------------- | -------------------------------------------------------- |
11 | | `basic` | [Array](Array.md).<[String](String.md)> | [[基本ステータス]](RPG.System.Terms.md#[基本ステータス]) |
12 | | `params` | [Array](Array.md).<[String](String.md)> | [[能力値]](RPG.System.Terms.md#[能力値]) |
13 | | `commands` | [Array](Array.md).<[String](String.md)> | [[コマンド]](RPG.System.Terms.md#[コマンド]) |
14 | | `messages` | Object | [メッセージ]{ [key: String]: String } |
15 |
16 | #### [基本ステータス]
17 |
18 | | 番号 | 用語 |
19 | | ---- | ----------- |
20 | | 0 | レベル |
21 | | 1 | レベル(略) |
22 | | 2 | HP |
23 | | 3 | HP (略) |
24 | | 4 | MP |
25 | | 5 | MP (略) |
26 | | 6 | TP |
27 | | 7 | TP (略) |
28 | | 8 | 経験値 |
29 | | 9 | 経験値 (略) |
30 |
31 | #### [能力値]
32 |
33 | | 番号 | 用語 |
34 | | ---- | -------- | --- |
35 | | 0 | 最大 HP |
36 | | 1 | 最大 MP |
37 | | 2 | 攻撃力 |
38 | | 3 | 防御力 |
39 | | 4 | 魔法力 |
40 | | 5 | 魔法防御 |
41 | | 6 | 敏捷性 |
42 | | 7 | 運 |
43 | | 8 | 命中率 |
44 | | 9 | 回避率 | |
45 |
46 | #### [コマンド]
47 |
48 | | 番号 | 用語 |
49 | | ---- | -------------- |
50 | | 0 | 戦う |
51 | | 1 | 逃げる |
52 | | 2 | 攻撃 |
53 | | 3 | 防御 |
54 | | 4 | アイテム |
55 | | 5 | スキル |
56 | | 6 | 装備 |
57 | | 7 | ステータス |
58 | | 8 | 並び替え |
59 | | 9 | セーブ |
60 | | 10 | ゲーム終了 |
61 | | 11 | オプション |
62 | | 12 | 武器 |
63 | | 13 | 防具 |
64 | | 14 | 大事なもの |
65 | | 15 | 装備 |
66 | | 16 | 最強装備 |
67 | | 17 | 全て外す |
68 | | 18 | ニューゲーム |
69 | | 19 | コンティニュー |
70 | | 20 | (不使用) |
71 | | 21 | タイトルへ |
72 | | 22 | やめる |
73 | | 23 | (不使用) |
74 | | 24 | 購入する |
75 | | 25 | 売却する |
76 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.System.TestBattler.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[System](RPG.System.md).TestBattler
2 |
3 | [戦闘テスト]用のバトラー(パーティメンバ)を渡すための JSON データ。
4 |
5 | 実際のゲームのプレイで使われることはない。
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | --------- | --------------------------------------------- | -------------------------------------------------------------------- |
11 | | `actorId` | [Number](Number.md) | アクター ID |
12 | | `level` | [Number](Number.md) | アクターの[レベル] |
13 | | `equips` | [Array](Array.md).<[Number](Number.md)> | アクターの[装備]の ID の配列( 0:武器, 1:盾, 2:頭, 3:身体, 4:装飾品 ) |
14 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.System.Vehicle.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[System](RPG.System.md).Vehicle
2 |
3 | [乗り物]の JSON データ。
4 |
5 | 画像指定については [RPG.Actor](RPG.Actor.md) と同じような作り。
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | ---------------- | --------------------------------- | -------------------------------- |
11 | | `characterName` | [String](String.md) | 画像ファイル名(拡張子を含まない) |
12 | | `characterIndex` | [Number](Number.md) | 画像番号 (0〜7) |
13 | | `bgm` | [RPG.AudioFile](RPG.AudioFile.md) | BGM |
14 | | `startMapId` | [Number](Number.md) | [初期位置] マップ ID |
15 | | `startX` | [Number](Number.md) | [初期位置] x 座標(タイル数) |
16 | | `startY` | [Number](Number.md) | [初期位置] y 座標(タイル数) |
17 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Tileset.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Tileset
2 |
3 | ## Extends: [RPG.MetaData](RPG.MetaData.md)
4 |
5 | | データベース | JSON ファイル | 大域変数 |
6 | | -------------- | ------------- | ------------------------------------------------------------- |
7 | | [タイルセット] | Tilesets.json | [$dataTilesets](global.md#datatilesets-arrayrpgtileset)(配列) |
8 |
9 | 関連クラス: [Game_Map](Game_Map.md), [ShaderTilemap](ShaderTilemap.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | -------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
15 | | `id` | [Number](Number.md) | タイルセットの ID |
16 | | `name` | [String](String.md) | [名前] |
17 | | `mode` | [Number](Number.md) | [[モード]](RPG.Tileset.md#モード) |
18 | | `tilesetNames` | [Array](Array.md).<[String](String.md)> | タイルセットに使われる画像ファイル名の配列
( 0:A1, 1:A2, 2:A3, 3:A4, 4:A5, 5:B, 6:C, 7:D, 8:E ) |
19 | | `flags` | [Array](Array.md).<[Number](Number.md)> | [ビットフラグ](RPG.Tileset.md#ビットフラグ)の配列 |
20 |
21 | #### [モード]
22 |
23 | VX 互換タイプ とあるが、使われていない。
24 |
25 | | 番号 | Description |
26 | | ---- | ---------------- |
27 | | 0 | フィールドタイプ |
28 | | 1 | エリアタイプ |
29 | | 2 | VX 互換タイプ |
30 |
31 | #### ビットフラグ
32 |
33 | タイルの性質を記録したフラグのビット位置。
34 |
35 | | Bit | Description |
36 | | ------ | -------------- |
37 | | 0x0001 | 下通行不可 |
38 | | 0x0002 | 左通行不可 |
39 | | 0x0004 | 右通行不可 |
40 | | 0x0008 | 上通行不可 |
41 | | 0x0010 | 高層に表示[☆] |
42 | | 0x0020 | 梯子 |
43 | | 0x0040 | 茂み |
44 | | 0x0080 | カウンター |
45 | | 0x0100 | ダメージ床 |
46 | | 0x0200 | 小型船通行不可 |
47 | | 0x0400 | 大型船通行不可 |
48 | | 0x0800 | 飛行船着地不可 |
49 | | 0xF000 | 地形タグ |
50 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Troop.Member.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).[Troop](RPG.Troop.md).Member
2 |
3 | [RPG.Troop](RPG.Troop.md) のメンバーを構成する JSON データ。
4 |
5 | ### Properties:
6 |
7 | | Name | Type | Description |
8 | | --------- | ------------------- | ---------------- |
9 | | `enemyId` | [Number](Number.md) | 敵キャラ ID |
10 | | `x` | [Number](Number.md) | x 座標(ピクセル) |
11 | | `y` | [Number](Number.md) | y 座標(ピクセル) |
12 | | `hidden` | Boolean | [途中から出現] |
13 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Troop.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Troop
2 |
3 | | データベース | JSON ファイル | 大域変数 | オブジェクト |
4 | | ------------ | ------------- | ------------------------------------------------------- | --------------------------- |
5 | | [敵グループ] | Troops.json | [$dataTroops](global.md#datatroops-arrayrpgtroop)(配列) | [Game_Troop](Game_Troop.md) |
6 |
7 | 関連クラス: [RPG.Event](RPG.Event.md), [RPG.CommonEvent](RPG.CommonEvent.md)
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | --------- | ----------------------------------------------------------------------- | ---------------- |
13 | | `id` | [Number](Number.md) | 敵グループ ID |
14 | | `name` | [String](String.md) | 敵グループ名 |
15 | | `members` | [Array](Array.md).<[RPG.Troop.Member](RPG.Troop.Member.md)> | メンバー |
16 | | `pages` | [Array](Array.md).<[RPG.BattleEventPage](RPG.BattleEventPage.md)> | [バトルイベント] |
17 |
18 | ### Classes
19 |
20 | - [RPG.Troop.Member](RPG.Troop.Member.md)
21 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.UsableItem.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).UsableItem
2 |
3 | ## Extends: [RPG.BaseItem](RPG.BaseItem.md)
4 |
5 | アイテム・スキルの基本情報。
6 |
7 | ### Sub Classes
8 |
9 | - [RPG.Skill](RPG.Skill.md)
10 | - [RPG.Item](RPG.Item.md)
11 |
12 | ### Properties:
13 |
14 | | Name | Type | Description |
15 | | ------------- | ----------------------------------------------------- | ------------------------------------------------------- |
16 | | `scope` | [Number](Number.md) | [範囲](RPG.UsableItem.md#範囲) |
17 | | `occasion` | [Number](Number.md) | [使用可能時](RPG.UsableItem.md#使用可能時) |
18 | | `speed` | [Number](Number.md) | [速度補正] |
19 | | `successRate` | [Number](Number.md) | [成功率] % (0〜100) |
20 | | `repeats` | [Number](Number.md) | [連続回数] \(1〜9) |
21 | | `tpGain` | [Number](Number.md) | [得 TP] \(0〜100) |
22 | | `hitType` | [Number](Number.md) | [命中タイプ](RPG.UsableItem.md#命中タイプ) |
23 | | `animationId` | [Number](Number.md) | [アニメーション ID](RPG.UsableItem.md#アニメーションid) |
24 | | `damage` | [RPG.Damage](RPG.Damage.md) | [ダメージ] |
25 | | `effects` | [Array](Array.md).<[RPG.Effect](RPG.Effect.md)> | [使用効果]の配列 |
26 |
27 | #### 範囲
28 |
29 | | 番号 | [範囲] |
30 | | ---- | ------------------ |
31 | | 0 | なし |
32 | | 1 | 敵単体 |
33 | | 2 | 敵全体 |
34 | | 3 | 敵 1 体ランダム |
35 | | 4 | 敵 2 体ランダム |
36 | | 5 | 敵 3 体ランダム |
37 | | 6 | 敵 4 体ランダム |
38 | | 7 | 味方単体 |
39 | | 8 | 味方全体 |
40 | | 9 | 味方単体(戦闘不能) |
41 | | 10 | 味方全体(戦闘不能) |
42 | | 11 | 使用者 |
43 |
44 | #### 使用可能時
45 |
46 | | 番号 | [使用可能時] |
47 | | ---- | ------------ |
48 | | 0 | 常時 |
49 | | 1 | バトル画面 |
50 | | 2 | メニュー画面 |
51 | | 3 | 使用不可 |
52 |
53 | #### 命中タイプ
54 |
55 | hitType は [Game_Action](Game_Action.md) の定数として定義されている。例えば、Game_Action.HITTYPE_CERTAIN
のような形で使う。
56 |
57 | | 番号 | 定数 | [命中タイプ] |
58 | | ---- | ------------------ | ------------ |
59 | | 0 | `HITTYPE_CERTAIN` | 必中 |
60 | | 1 | `HITTYPE_PHYSICAL` | 物理攻撃 |
61 | | 2 | `HITTYPE_MAGICAL` | 魔法攻撃 |
62 |
63 | #### アニメーション ID
64 |
65 | [データベース]-[[アニメーション](RPG.Animation.md)]で設定された ID。
66 |
67 | | ID | [アニメーション] | 説明 |
68 | | --- | ---------------- | -------------------------------------------------------------- |
69 | | -1 | 通常攻撃 | 装備中の [RPG.Weapon](RPG.Weapon.md) の animationId が使われる |
70 | | 0 | なし |
71 | | 1〜 | 任意 | [アニメーション]で設定した内容 |
72 |
73 | [通常攻撃]で武器を装備していない場合、[Game_Actor.bareHandsAnimationId()](Game_Actor.md#barehandsanimationid---number) (規定値:1) の ID が使われる。
74 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.Weapon.md:
--------------------------------------------------------------------------------
1 | # Class: [RPG](RPG.md).Weapon
2 |
3 | ## Extends: [RPG.EquipItem](RPG.EquipItem.md)
4 |
5 | | データベース | JSON ファイル | 大域変数 | オブジェクト |
6 | | ------------ | ------------- | ---------------------------------------------------------- | ------------------------- |
7 | | [武器] | Weapons.json | [$dataWeapons](global.md#dataweapons-arrayrpgweapon)(配列) | [Game_Item](Game_Item.md) |
8 |
9 | [Game_Item](Game_Item.md) の \_dataClass プロパティは 'weapon' になる。
10 |
11 | 関連クラス: [RPG.BaseItem](RPG.BaseItem.md)
12 |
13 | ### Properties:
14 |
15 | | Name | Type | Description |
16 | | ------------- | ------------------- | ----------------------------------------- |
17 | | `wtypeId` | [Number](Number.md) | [武器タイプ ID](RPG.Weapon#武器タイプid) |
18 | | `animationId` | [Number](Number.md) | [[アニメーション](RPG.Animation.md)]の ID |
19 |
20 | #### 武器タイプ ID
21 |
22 | [データベース]-[タイプ]-[武器タイプ] で設定された ID。
23 |
24 | [System](RPG.System.md) の weaponTypes プロパティに登録されている。
25 |
26 | 下表は規定値。
27 |
28 | | ID | [武器タイプ] |
29 | | --- | ------------ |
30 | | 0 | なし |
31 | | 1 | 短剣 |
32 | | 2 | 剣 |
33 | | 3 | フレイル |
34 | | 4 | 斧 |
35 | | 5 | ムチ |
36 | | 6 | 杖 |
37 | | 7 | 弓 |
38 | | 8 | クロスボウ |
39 | | 9 | 銃 |
40 | | 10 | 爪 |
41 | | 11 | グローブ |
42 | | 11 | 槍 |
43 |
--------------------------------------------------------------------------------
/docs/jsdoc/RPG.md:
--------------------------------------------------------------------------------
1 | # Namespace: RPG
2 |
3 | 主に data フォルダ以下の JSON ファイル(.json)の構造を表すデータ群。
4 |
5 | ネームスペースに RPG とか、クラス名を便宜上つけているが、JavaScript 上は単なる Object の一種。
6 |
7 | ### Objects
8 |
9 | - [Animation](RPG.Animation.md) . [Timing](RPG.Animation.Timing.md)
10 | - [AudioFile](RPG.AudioFile.md)
11 | - [BattleEventPage](RPG.BattleEventPage.md) . [Conditions](RPG.BattleEventPage.Conditions.md)
12 | - [CommonEvent](RPG.CommonEvent.md)
13 | - [Damage](RPG.Damage.md)
14 | - [Effect](RPG.Effect.md)
15 | - [EventCommand](RPG.EventCommand.md)
16 | - [EventPage](RPG.EventPage.md) . [Conditions](RPG.EventPage.Conditions.md) \| [Image](RPG.EventPage.Image.md)
17 | - [MapInfo](RPG.MapInfo.md)
18 | - [MoveCommand](RPG.MoveCommand.md)
19 | - [MoveRoute](RPG.MoveRoute.md)
20 | - [System](RPG.System.md) . [AttackMotion](RPG.System.AttackMotion.md) \| [Terms](RPG.System.Terms.md) \| [TestBattler](RPG.System.TestBattler.md) \| [Vehicle](RPG.System.Vehicle.md)
21 | - [Trait](RPG.Trait.md)
22 | - [Troop](RPG.Troop.md) . [Member](RPG.Troop.Member.md)
23 | - [MetaData](RPG.MetaData.md)
24 | - [Actor](RPG.Actor.md)
25 | - [Class](RPG.Class.md) . [Learning](RPG.Class.Learning.md)
26 | - [Enemy](RPG.Enemy.md) . [Action](RPG.Enemy.Action.md) \| [DropItem](RPG.Enemy.DropItem.md)
27 | - [Event](RPG.Event.md)
28 | - [Map](RPG.Map.md) . [Encounter](RPG.Map.Encounter.md)
29 | - [State](RPG.State.md)
30 | - [Tileset](RPG.Tileset.md)
31 | - [BaseItem](RPG.BaseItem.md)
32 | - [UsableItem](RPG.UsableItem.md)
33 | - [Item](RPG.Item.md)
34 | - [Skill](RPG.Skill.md)
35 | - [EquipItem](RPG.EquipItem.md)
36 | - [Armor](RPG.Armor.md)
37 | - [Weapon](RPG.Weapon.md)
38 |
--------------------------------------------------------------------------------
/docs/jsdoc/Rectangle.md:
--------------------------------------------------------------------------------
1 | # Class: Rectangle
2 |
3 | ## Extends: [PIXI.Rectangle](http://pixijs.download/release/docs/PIXI.Rectangle.html)
4 |
5 | ### new Rectangle (x, y, width, height)
6 |
7 | 矩形範囲を表すクラス。
8 |
9 | 関連クラス: [Point](Point.md), [Window](Window.md), [Window_NameEdit](Window_NameEdit.md), [Window_NameInput](Window_NameInput.md), [Window_SavefileList](Window_SavefileList.md), [Window_Selectable](Window_Selectable.md), [Window_BattleLog](Window_BattleLog.md), [Window_BattleStatus](Window_BattleStatus.md) [Sprite_Button](Sprite_Button.md)
10 |
11 | #### Parameters:
12 |
13 | | Name | Type | Description |
14 | | -------- | ------------------- | ------------------------- |
15 | | `x` | [Number](Number.md) | 矩形左の x 座標(ピクセル) |
16 | | `y` | [Number](Number.md) | 矩形上の y 座標(ピクセル) |
17 | | `width` | [Number](Number.md) | 幅(ピクセル) |
18 | | `height` | [Number](Number.md) | 高さ(ピクセル) |
19 |
20 | ### Properties:
21 |
22 | | Name | Type | Description |
23 | | ---------------- | ------------------------- | ------------------------- |
24 | | `x` | [Number](Number.md) | 矩形左の x 座標(ピクセル) |
25 | | `y` | [Number](Number.md) | 矩形上の y 座標(ピクセル) |
26 | | `width` | [Number](Number.md) | 幅(ピクセル) |
27 | | `height` | [Number](Number.md) | 高さ(ピクセル) |
28 | | `emptyRectangle` | [Rectangle](Rectangle.md) | 空(0, 0, 0, 0)の矩形範囲 |
29 |
30 | ### Methods
31 |
32 | #### initialize ()
33 |
34 | オブジェクト生成時の初期化。
35 |
--------------------------------------------------------------------------------
/docs/jsdoc/RequestQueue.md:
--------------------------------------------------------------------------------
1 | # Class: RequestQueue
2 |
3 | ### new RequestQueue ()
4 |
5 | 画像の読み込み順番待ち行列(キュー)。Ver.1.5.0 で追加されたクラス。
6 |
7 | 保持している画像( [Bitmap](Bitmap.md) )の isRequestReady() が成立したらキューから外し、次の優先度の画像に startRequest() を送る、という処理を update() で行なっている。
8 | [読み込みの状態](Bitmap.md#読み込みの状態) でいうと、'purged' から 'requestCompleted' までの順番待ち行列。
9 |
10 | 関連クラス: [ImageManager](ImageManager.md)
11 |
12 | ### Properties:
13 |
14 | | Name | Type | Description |
15 | | -------- | -------------------------------- | --------------------------------------------------------------------- |
16 | | `_queue` | [Array](Array.md).<Object> | [static] {key: [String](String.md), value: [Bitmap](Bitmap.md)}の配列 |
17 |
18 | ### Methods
19 |
20 | #### clear ()
21 |
22 | 予約を消去し 0 に。
23 |
24 | #### enqueue (key, value)
25 |
26 | 指定画像をキューに追加。
27 |
28 | ##### Parameters:
29 |
30 | | Name | Type | Description |
31 | | ------- | ------------------- | ----------- |
32 | | `key` | [String](String.md) | キー文字列 |
33 | | `value` | [Bitmap](Bitmap.md) | 画像 |
34 |
35 | #### initialize ()
36 |
37 | オブジェクト生成時の初期化。
38 |
39 | #### raisePriority (key)
40 |
41 | 指定キーの優先度をあげる。
42 |
43 | ##### Parameters:
44 |
45 | | Name | Type | Description |
46 | | ----- | ------------------- | ----------- |
47 | | `key` | [String](String.md) | キー文字列 |
48 |
49 | #### update ()
50 |
51 | フレーム毎のアップデート。
52 |
--------------------------------------------------------------------------------
/docs/jsdoc/ResourceHandler.md:
--------------------------------------------------------------------------------
1 | # Class: ResourceHandler
2 |
3 | データの読み込みの制御に使われる静的クラス。
4 |
5 | 関連クラス: [Bitmap](Bitmap.md), [Graphics](Graphics.md), [WebAudio](WebAudio.md), [DataManager](DataManager.md), [Input](Input.md)
6 |
7 | ### Properties:
8 |
9 | | Name | Type | Description |
10 | | ----------------------- | --------------------------------------------- | ------------------------------- |
11 | | `_reloaders` | [Array](Array.md).<Object> | [static] リトライ関数情報の配列 |
12 | | `_defaultRetryInterval` | [Array](Array.md).<[Number](Number.md)> | [static] リトライ間隔の配列 |
13 |
14 | ### Methods
15 |
16 | #### (static) createLoader (url, retryMethod, resignMethod opt, retryInterval opt) → {Function}
17 |
18 | 指定した値で、ローダーを作って返す。
19 |
20 | ##### Parameters:
21 |
22 | | Name | Type | Attributes | Default | Description |
23 | | --------------- | --------------------------------------------- | ---------------- | ----------------- | ------------------------------ |
24 | | `url` | [String](String.md) | | | プロジェクト以下のファイルパス |
25 | | `retryMethod` | Function | | | リトライに使われる関数 |
26 | | `resignMethod` | Function | <optional> | | エラー時に呼ばれる関数 |
27 | | `retryInterval` | [Array](Array.md).<[Number](Number.md)> | <optional> | [500, 1000, 3000] | リトライ間隔の配列 |
28 |
29 | #### (static) exists () → {Boolean}
30 |
31 | 未実行のリトライ関数が存在するか。
32 |
33 | #### (static) retry ()
34 |
35 | リトライ関数の実行。
36 |
--------------------------------------------------------------------------------
/docs/jsdoc/Scene_Boot.md:
--------------------------------------------------------------------------------
1 | # Class: Scene_Boot
2 |
3 | ## Extends: [Scene_Base](Scene_Base.md)
4 |
5 | ### new Scene_Boot ()
6 |
7 | 起動時の初期化を行うシーン。システムに必要なデータや画像を読み込み、戦闘・イベントテストの分岐なども行う。
8 |
9 | 関連シーン: [Scene_Title](Scene_Title.md), [Scene_Map](Scene_Map.md), [Scene_Battle](Scene_Battle.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ------------ | ---- | ----------- |
15 | | `_startDate` | Date | 開始時刻 |
16 |
17 | ### Inherited From
18 |
19 | #### [PIXI.DisplayObject](PIXI.DisplayObject.md)
20 |
21 | - [(static) mixin (source)](PIXI.DisplayObject.md#static-mixin-source)
22 | - [\_recursivePostUpdateTransform ()](PIXI.DisplayObject.md#_recursivepostupdatetransform-)
23 | - [displayObjectUpdateTransform ()](PIXI.DisplayObject.md#displayobjectupdatetransform-)
24 | - [getBounds (skipUpdate, rect)](PIXI.DisplayObject.md#getbounds-skipupdate-rect--pixirectangle)
25 | - [getGlobalPosition (point, skipUpdate)](PIXI.DisplayObject.md#getglobalposition-point-skipupdate--pixipoint)
26 | - [setParent (container)](PIXI.DisplayObject.md#setparent-container--pixicontainer)
27 | - [setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)](PIXI.DisplayObject.md#settransform-x-y-scalex-scaley-rotation-skewx-skewy-pivotx-pivoty--pixidisplayobject)
28 | - [toGlobal (position, point, skipUpdate)](PIXI.DisplayObject.md#toglobal-position-point-skipupdate--pixipoint)
29 | - [toLocal (position, from, point, skipUpdate)](PIXI.DisplayObject.md#tolocal-position-from-point-skipupdate--pixipoint)
30 |
31 | #### [PIXI.Container](PIXI.Container.md)
32 |
33 | - [addChild (child) ](PIXI.Container.md#addchild-child--pixidisplayobject)
34 | - [addChildAt (child, index)](PIXI.Container.md#addchildat-child-index--pixidisplayobject)
35 | - [calculateBounds ()](PIXI.Container.md#calculatebounds-)
36 | - [destroy ()](PIXI.Container.md#destroy-)
37 | - [getChildAt (index)](PIXI.Container.md#getchildat-index--pixidisplayobject)
38 | - [getChildByName (name)](PIXI.Container.md#getchildbyname-name--pixidisplayobject)
39 | - [getChildIndex (child)](PIXI.Container.md#getchildindex-child--pixidisplayobject)
40 | - [onChildrenChange ()](PIXI.Container.md#onchildrenchange-)
41 | - [removeChild (child)](PIXI.Container.md#removechild-child--pixidisplayobject)
42 | - [removeChildAt (index)](PIXI.Container.md#removechildat-index--pixidisplayobject)
43 | - [removeChildren (beginIndex, endIndex)](PIXI.Container.md#removechildren-beginindex-endindex--arraypixidisplayobject)
44 | - [render (renderer)](PIXI.Container.md#render-renderer)
45 | - [renderAdvanced (renderer)](PIXI.Container.md#renderadvanced-renderer)
46 | - [renderCanvas (renderer)](PIXI.Container.md#rendercanvas-renderer)
47 | - [setChildIndex (child, index)](PIXI.Container.md#setchildindex-child-index)
48 | - [sortChildren ()](PIXI.Container.md#sortchildren-)
49 | - [swapChildren (child, child2)](PIXI.Container.md#swapchildren-child-child2)
50 | - [updateTransform ()](PIXI.Container.md#updatetransform-)
51 |
52 | #### [Scene_Base](Scene_Base.md)
53 |
54 | - [addWindow (Window)](Scene_Base.md#addwindow-window)
55 | - [attachReservation ()](Scene_Base.md#attachreservation-)
56 | - [checkGameover ()](Scene_Base.md#checkgameover-)
57 | - [createFadeSprite ()](Scene_Base.md#createfadesprite-)
58 | - [createWindowLayer ()](Scene_Base.md#createwindowlayer-)
59 | - [detachReservation ()](Scene_Base.md#detachreservation-)
60 | - [fadeOutAll ()](Scene_Base.md#fadeoutall-)
61 | - [fadeSpeed ()](Scene_Base.md#fadespeed---number)
62 | - [isActive () ](Scene_Base.md#isactive---boolean)
63 | - [isBusy ()](Scene_Base.md#isbusy---boolean)
64 | - [popScene ()](Scene_Base.md#popscene-)
65 | - [slowFadeSpeed ()](Scene_Base.md#slowfadespeed---number)
66 | - [startFadeIn (duration opt, white opt)](Scene_Base.md#startfadein-duration-opt-white-opt)
67 | - [startFadeOut (duration opt, white opt)](Scene_Base.md#startfadeout-duration-opt-white-opt)
68 | - [stop ()](Scene_Base.md#stop-)
69 | - [terminate ()](Scene_Base.md#terminate-)
70 | - [update ()](Scene_Base.md#update-)
71 | - [updateChildren ()](Scene_Base.md#updatechildren-)
72 | - [updateFade ()](Scene_Base.md#updatefade-)
73 |
74 | ### Methods
75 |
76 | #### (static) loadSystemImages ()
77 |
78 | 各種アイコンなどのシステムに必要なデータを読み込む。
79 |
80 | #### checkPlayerLocation ()
81 |
82 | プレイヤーの場所が設定されているか検査し、設定されていないならエラーを出力。
83 |
84 | #### create ()
85 |
86 | Overrides: [Scene_Base](Scene_Base.md#create-)
87 |
88 | #### initialize ()
89 |
90 | Overrides: [Scene_Base](Scene_Base.md#initialize-)
91 |
92 | #### isGameFontLoaded () → {Boolean}
93 |
94 | フォントが読み込まれているか。
95 |
96 | #### isReady () → {Boolean}
97 |
98 | Overrides: [Scene_Base](Scene_Base.md#isReady-)
99 |
100 | #### loadSystemWindowImage ()
101 |
102 | ウィンドウに必要な画像を読み込む。
103 |
104 | #### start ()
105 |
106 | Overrides: [Scene_Base](Scene_Base.md#start-)
107 |
108 | #### updateDocumentTitle ()
109 |
110 | ゲームのタイトルをアップデート。
111 |
--------------------------------------------------------------------------------
/docs/jsdoc/Scene_GameEnd.md:
--------------------------------------------------------------------------------
1 | # Class: Scene_GameEnd
2 |
3 | ## Extends: [Scene_MenuBase](Scene_MenuBase.md)
4 |
5 | ### new Scene_GameEnd ()
6 |
7 | [ゲーム終了]のシーン。
8 |
9 | 関連シーン: [Scene_Menu](Scene_Menu.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ---------------- | ----------------------------------- | -------------------------- |
15 | | `_commandWindow` | [Window_GameEnd](Window_GameEnd.md) | [ゲーム終了]選択ウィンドウ |
16 |
17 | ### Inherited From
18 |
19 | #### [PIXI.DisplayObject](PIXI.DisplayObject.md)
20 |
21 | - [(static) mixin (source)](PIXI.DisplayObject.md#static-mixin-source)
22 | - [\_recursivePostUpdateTransform ()](PIXI.DisplayObject.md#_recursivepostupdatetransform-)
23 | - [displayObjectUpdateTransform ()](PIXI.DisplayObject.md#displayobjectupdatetransform-)
24 | - [getBounds (skipUpdate, rect)](PIXI.DisplayObject.md#getbounds-skipupdate-rect--pixirectangle)
25 | - [getGlobalPosition (point, skipUpdate)](PIXI.DisplayObject.md#getglobalposition-point-skipupdate--pixipoint)
26 | - [setParent (container)](PIXI.DisplayObject.md#setparent-container--pixicontainer)
27 | - [setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)](PIXI.DisplayObject.md#settransform-x-y-scalex-scaley-rotation-skewx-skewy-pivotx-pivoty--pixidisplayobject)
28 | - [toGlobal (position, point, skipUpdate)](PIXI.DisplayObject.md#toglobal-position-point-skipupdate--pixipoint)
29 | - [toLocal (position, from, point, skipUpdate)](PIXI.DisplayObject.md#tolocal-position-from-point-skipupdate--pixipoint)
30 |
31 | #### [PIXI.Container](PIXI.Container.md)
32 |
33 | - [addChild (child) ](PIXI.Container.md#addchild-child--pixidisplayobject)
34 | - [addChildAt (child, index)](PIXI.Container.md#addchildat-child-index--pixidisplayobject)
35 | - [calculateBounds ()](PIXI.Container.md#calculatebounds-)
36 | - [destroy ()](PIXI.Container.md#destroy-)
37 | - [getChildAt (index)](PIXI.Container.md#getchildat-index--pixidisplayobject)
38 | - [getChildByName (name)](PIXI.Container.md#getchildbyname-name--pixidisplayobject)
39 | - [getChildIndex (child)](PIXI.Container.md#getchildindex-child--pixidisplayobject)
40 | - [onChildrenChange ()](PIXI.Container.md#onchildrenchange-)
41 | - [removeChild (child)](PIXI.Container.md#removechild-child--pixidisplayobject)
42 | - [removeChildAt (index)](PIXI.Container.md#removechildat-index--pixidisplayobject)
43 | - [removeChildren (beginIndex, endIndex)](PIXI.Container.md#removechildren-beginindex-endindex--arraypixidisplayobject)
44 | - [render (renderer)](PIXI.Container.md#render-renderer)
45 | - [renderAdvanced (renderer)](PIXI.Container.md#renderadvanced-renderer)
46 | - [renderCanvas (renderer)](PIXI.Container.md#rendercanvas-renderer)
47 | - [setChildIndex (child, index)](PIXI.Container.md#setchildindex-child-index)
48 | - [sortChildren ()](PIXI.Container.md#sortchildren-)
49 | - [swapChildren (child, child2)](PIXI.Container.md#swapchildren-child-child2)
50 | - [updateTransform ()](PIXI.Container.md#updatetransform-)
51 |
52 | #### [Scene_Base](Scene_Base.md)
53 |
54 | - [addWindow (Window)](Scene_Base.md#addwindow-window)
55 | - [attachReservation ()](Scene_Base.md#attachreservation-)
56 | - [checkGameover ()](Scene_Base.md#checkgameover-)
57 | - [createFadeSprite ()](Scene_Base.md#createfadesprite-)
58 | - [createWindowLayer ()](Scene_Base.md#createwindowlayer-)
59 | - [detachReservation ()](Scene_Base.md#detachreservation-)
60 | - [fadeOutAll ()](Scene_Base.md#fadeoutall-)
61 | - [fadeSpeed ()](Scene_Base.md#fadespeed---number)
62 | - [isActive () ](Scene_Base.md#isactive---boolean)
63 | - [isBusy ()](Scene_Base.md#isbusy---boolean)
64 | - [isReady ()](Scene_Base.md#isready---boolean)
65 | - [popScene ()](Scene_Base.md#popscene-)
66 | - [slowFadeSpeed ()](Scene_Base.md#slowfadespeed---number)
67 | - [startFadeIn (duration opt, white opt)](Scene_Base.md#startfadein-duration-opt-white-opt)
68 | - [startFadeOut (duration opt, white opt)](Scene_Base.md#startfadeout-duration-opt-white-opt)
69 | - [terminate ()](Scene_Base.md#terminate-)
70 | - [update ()](Scene_Base.md#update-)
71 | - [updateChildren ()](Scene_Base.md#updatechildren-)
72 | - [updateFade ()](Scene_Base.md#updatefade-)
73 |
74 | #### [Scene_MenuBase](Scene_MenuBase.md)
75 |
76 | - [actor ()](Scene_MenuBase.md#actor---game_actor)
77 | - [createHelpWindow ()](Scene_MenuBase.md#createhelpwindow-)
78 | - [nextActor ()](Scene_MenuBase.md#nextactor-)
79 | - [onActorChange ()](Scene_MenuBase.md#onactorchange-)
80 | - [previousActor ()](Scene_MenuBase.md#previousactor-)
81 | - [setBackgroundOpacity (opacity)](Scene_MenuBase.md#setbackgroundopacity-opacity)
82 | - [start ()](Scene_Base.md#start-)
83 | - [updateActor ()](Scene_MenuBase.md#updateactor-)
84 |
85 | ### Methods
86 |
87 | #### commandToTitle ()
88 |
89 | [タイトルへ]コマンドの実行。
90 |
91 | #### create ()
92 |
93 | Overrides: [Scene_MenuBase](Scene_MenuBase.md#create-)
94 |
95 | #### createBackground ()
96 |
97 | 背景の生成。
98 |
99 | #### createCommandWindow ()
100 |
101 | コマンド選択ウィンドウの生成。
102 |
103 | #### initialize ()
104 |
105 | Overrides: [Scene_MenuBase](Scene_MenuBase.md#initialize-)
106 |
107 | #### stop ()
108 |
109 | Overrides: [Scene_Base](Scene_Base.md#stop-)
110 |
--------------------------------------------------------------------------------
/docs/jsdoc/Scene_Gameover.md:
--------------------------------------------------------------------------------
1 | # Class: Scene_Gameover
2 |
3 | ## Extends: [Scene_Base](Scene_Base.md)
4 |
5 | ### new Scene_Gameover ()
6 |
7 | ゲームオーバーのシーン。
8 |
9 | 関連クラス: [BattleManager](BattleManager.md), [Game_Interpreter](Game_Interpreter.md)
10 | 関連シーン: [Scene_Title](Scene_Title.md), [Scene_Base](Scene_Base.md), [Scene_Battle](Scene_Battle.md)
11 |
12 | ### Properties:
13 |
14 | | Name | Type | Description |
15 | | ------------- | ------------------- | ----------- |
16 | | `_backSprite` | [Sprite](Sprite.md) | 背景画像 |
17 |
18 | ### Inherited From
19 |
20 | #### [PIXI.DisplayObject](PIXI.DisplayObject.md)
21 |
22 | - [(static) mixin (source)](PIXI.DisplayObject.md#static-mixin-source)
23 | - [\_recursivePostUpdateTransform ()](PIXI.DisplayObject.md#_recursivepostupdatetransform-)
24 | - [displayObjectUpdateTransform ()](PIXI.DisplayObject.md#displayobjectupdatetransform-)
25 | - [getBounds (skipUpdate, rect)](PIXI.DisplayObject.md#getbounds-skipupdate-rect--pixirectangle)
26 | - [getGlobalPosition (point, skipUpdate)](PIXI.DisplayObject.md#getglobalposition-point-skipupdate--pixipoint)
27 | - [setParent (container)](PIXI.DisplayObject.md#setparent-container--pixicontainer)
28 | - [setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)](PIXI.DisplayObject.md#settransform-x-y-scalex-scaley-rotation-skewx-skewy-pivotx-pivoty--pixidisplayobject)
29 | - [toGlobal (position, point, skipUpdate)](PIXI.DisplayObject.md#toglobal-position-point-skipupdate--pixipoint)
30 | - [toLocal (position, from, point, skipUpdate)](PIXI.DisplayObject.md#tolocal-position-from-point-skipupdate--pixipoint)
31 |
32 | #### [PIXI.Container](PIXI.Container.md)
33 |
34 | - [addChild (child) ](PIXI.Container.md#addchild-child--pixidisplayobject)
35 | - [addChildAt (child, index)](PIXI.Container.md#addchildat-child-index--pixidisplayobject)
36 | - [calculateBounds ()](PIXI.Container.md#calculatebounds-)
37 | - [destroy ()](PIXI.Container.md#destroy-)
38 | - [getChildAt (index)](PIXI.Container.md#getchildat-index--pixidisplayobject)
39 | - [getChildByName (name)](PIXI.Container.md#getchildbyname-name--pixidisplayobject)
40 | - [getChildIndex (child)](PIXI.Container.md#getchildindex-child--pixidisplayobject)
41 | - [onChildrenChange ()](PIXI.Container.md#onchildrenchange-)
42 | - [removeChild (child)](PIXI.Container.md#removechild-child--pixidisplayobject)
43 | - [removeChildAt (index)](PIXI.Container.md#removechildat-index--pixidisplayobject)
44 | - [removeChildren (beginIndex, endIndex)](PIXI.Container.md#removechildren-beginindex-endindex--arraypixidisplayobject)
45 | - [render (renderer)](PIXI.Container.md#render-renderer)
46 | - [renderAdvanced (renderer)](PIXI.Container.md#renderadvanced-renderer)
47 | - [renderCanvas (renderer)](PIXI.Container.md#rendercanvas-renderer)
48 | - [setChildIndex (child, index)](PIXI.Container.md#setchildindex-child-index)
49 | - [sortChildren ()](PIXI.Container.md#sortchildren-)
50 | - [swapChildren (child, child2)](PIXI.Container.md#swapchildren-child-child2)
51 | - [updateTransform ()](PIXI.Container.md#updatetransform-)
52 |
53 | #### [Scene_Base](Scene_Base.md)
54 |
55 | - [addWindow (Window)](Scene_Base.md#addwindow-window)
56 | - [attachReservation ()](Scene_Base.md#attachreservation-)
57 | - [checkGameover ()](Scene_Base.md#checkgameover-)
58 | - [createFadeSprite ()](Scene_Base.md#createfadesprite-)
59 | - [createWindowLayer ()](Scene_Base.md#createwindowlayer-)
60 | - [detachReservation ()](Scene_Base.md#detachreservation-)
61 | - [fadeOutAll ()](Scene_Base.md#fadeoutall-)
62 | - [fadeSpeed ()](Scene_Base.md#fadespeed---number)
63 | - [isActive () ](Scene_Base.md#isactive---boolean)
64 | - [isBusy ()](Scene_Base.md#isbusy---boolean)
65 | - [isReady ()](Scene_Base.md#isready---boolean)
66 | - [popScene ()](Scene_Base.md#popscene-)
67 | - [slowFadeSpeed ()](Scene_Base.md#slowfadespeed---number)
68 | - [startFadeIn (duration opt, white opt)](Scene_Base.md#startfadein-duration-opt-white-opt)
69 | - [startFadeOut (duration opt, white opt)](Scene_Base.md#startfadeout-duration-opt-white-opt)
70 | - [updateChildren ()](Scene_Base.md#updatechildren-)
71 | - [updateFade ()](Scene_Base.md#updatefade-)
72 |
73 | ### Methods
74 |
75 | #### create ()
76 |
77 | Overrides: [Scene_Base](Scene_Base.md#create-)
78 |
79 | #### createBackground ()
80 |
81 | 背景を生成。
82 |
83 | #### gotoTitle ()
84 |
85 | [Scene_Title](Scene_Title.md)へ遷移。
86 |
87 | #### initialize ()
88 |
89 | Overrides: [Scene_Base](Scene_Base.md#initialize-)
90 |
91 | #### isTriggered ()
92 |
93 | 決定操作(OK キー・ボタン、クリック・タップ)が行われたか。
94 |
95 | #### playGameoverMusic ()
96 |
97 | [ゲームオーバー]の音楽の再生。
98 |
99 | #### start ()
100 |
101 | Overrides: [Scene_Base](Scene_Base.md#start-)
102 |
103 | #### stop ()
104 |
105 | Overrides: [Scene_Base](Scene_Base.md#stop-)
106 |
107 | #### terminate ()
108 |
109 | Overrides: [Scene_Base](Scene_Base.md#terminate-)
110 |
111 | #### update ()
112 |
113 | Overrides: [Scene_Base](Scene_Base.md#update-)
114 |
--------------------------------------------------------------------------------
/docs/jsdoc/Scene_Options.md:
--------------------------------------------------------------------------------
1 | # Class: Scene_Options
2 |
3 | ## Extends: [Scene_MenuBase](Scene_MenuBase.md)
4 |
5 | ### new Scene_Options ()
6 |
7 | [オプション]のシーン。
8 |
9 | 関連シーン: [Scene_Title](Scene_Title.md), [Scene_Menu](Scene_Menu.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ---------------- | ----------------------------------- | -------------------- |
15 | | `_optionsWindow` | [Window_Options](Window_Options.md) | オプションウィンドウ |
16 |
17 | ### Inherited From
18 |
19 | #### [PIXI.DisplayObject](PIXI.DisplayObject.md)
20 |
21 | - [(static) mixin (source)](PIXI.DisplayObject.md#static-mixin-source)
22 | - [\_recursivePostUpdateTransform ()](PIXI.DisplayObject.md#_recursivepostupdatetransform-)
23 | - [displayObjectUpdateTransform ()](PIXI.DisplayObject.md#displayobjectupdatetransform-)
24 | - [getBounds (skipUpdate, rect)](PIXI.DisplayObject.md#getbounds-skipupdate-rect--pixirectangle)
25 | - [getGlobalPosition (point, skipUpdate)](PIXI.DisplayObject.md#getglobalposition-point-skipupdate--pixipoint)
26 | - [setParent (container)](PIXI.DisplayObject.md#setparent-container--pixicontainer)
27 | - [setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)](PIXI.DisplayObject.md#settransform-x-y-scalex-scaley-rotation-skewx-skewy-pivotx-pivoty--pixidisplayobject)
28 | - [toGlobal (position, point, skipUpdate)](PIXI.DisplayObject.md#toglobal-position-point-skipupdate--pixipoint)
29 | - [toLocal (position, from, point, skipUpdate)](PIXI.DisplayObject.md#tolocal-position-from-point-skipupdate--pixipoint)
30 |
31 | #### [PIXI.Container](PIXI.Container.md)
32 |
33 | - [addChild (child) ](PIXI.Container.md#addchild-child--pixidisplayobject)
34 | - [addChildAt (child, index)](PIXI.Container.md#addchildat-child-index--pixidisplayobject)
35 | - [calculateBounds ()](PIXI.Container.md#calculatebounds-)
36 | - [destroy ()](PIXI.Container.md#destroy-)
37 | - [getChildAt (index)](PIXI.Container.md#getchildat-index--pixidisplayobject)
38 | - [getChildByName (name)](PIXI.Container.md#getchildbyname-name--pixidisplayobject)
39 | - [getChildIndex (child)](PIXI.Container.md#getchildindex-child--pixidisplayobject)
40 | - [onChildrenChange ()](PIXI.Container.md#onchildrenchange-)
41 | - [removeChild (child)](PIXI.Container.md#removechild-child--pixidisplayobject)
42 | - [removeChildAt (index)](PIXI.Container.md#removechildat-index--pixidisplayobject)
43 | - [removeChildren (beginIndex, endIndex)](PIXI.Container.md#removechildren-beginindex-endindex--arraypixidisplayobject)
44 | - [render (renderer)](PIXI.Container.md#render-renderer)
45 | - [renderAdvanced (renderer)](PIXI.Container.md#renderadvanced-renderer)
46 | - [renderCanvas (renderer)](PIXI.Container.md#rendercanvas-renderer)
47 | - [setChildIndex (child, index)](PIXI.Container.md#setchildindex-child-index)
48 | - [sortChildren ()](PIXI.Container.md#sortchildren-)
49 | - [swapChildren (child, child2)](PIXI.Container.md#swapchildren-child-child2)
50 | - [updateTransform ()](PIXI.Container.md#updatetransform-)
51 |
52 | #### [Scene_Base](Scene_Base.md)
53 |
54 | - [addWindow (Window)](Scene_Base.md#addwindow-window)
55 | - [attachReservation ()](Scene_Base.md#attachreservation-)
56 | - [checkGameover ()](Scene_Base.md#checkgameover-)
57 | - [createFadeSprite ()](Scene_Base.md#createfadesprite-)
58 | - [createWindowLayer ()](Scene_Base.md#createwindowlayer-)
59 | - [detachReservation ()](Scene_Base.md#detachreservation-)
60 | - [fadeOutAll ()](Scene_Base.md#fadeoutall-)
61 | - [fadeSpeed ()](Scene_Base.md#fadespeed---number)
62 | - [isActive () ](Scene_Base.md#isactive---boolean)
63 | - [isBusy ()](Scene_Base.md#isbusy---boolean)
64 | - [isReady ()](Scene_Base.md#isready---boolean)
65 | - [popScene ()](Scene_Base.md#popscene-)
66 | - [slowFadeSpeed ()](Scene_Base.md#slowfadespeed---number)
67 | - [startFadeIn (duration opt, white opt)](Scene_Base.md#startfadein-duration-opt-white-opt)
68 | - [startFadeOut (duration opt, white opt)](Scene_Base.md#startfadeout-duration-opt-white-opt)
69 | - [stop ()](Scene_Base.md#stop-)
70 | - [update ()](Scene_Base.md#update-)
71 | - [updateChildren ()](Scene_Base.md#updatechildren-)
72 | - [updateFade ()](Scene_Base.md#updatefade-)
73 |
74 | #### [Scene_MenuBase](Scene_MenuBase.md)
75 |
76 | - [actor ()](Scene_MenuBase.md#actor---game_actor)
77 | - [createHelpWindow ()](Scene_MenuBase.md#createhelpwindow-)
78 | - [nextActor ()](Scene_MenuBase.md#nextactor-)
79 | - [onActorChange ()](Scene_MenuBase.md#onactorchange-)
80 | - [previousActor ()](Scene_MenuBase.md#previousactor-)
81 | - [setBackgroundOpacity (opacity)](Scene_MenuBase.md#setbackgroundopacity-opacity)
82 | - [start ()](Scene_Base.md#start-)
83 | - [updateActor ()](Scene_MenuBase.md#updateactor-)
84 |
85 | ### Methods
86 |
87 | #### create ()
88 |
89 | Overrides: [Scene_MenuBase](Scene_MenuBase.md#create-)
90 |
91 | #### initialize ()
92 |
93 | Overrides: [Scene_MenuBase](Scene_MenuBase.md#initialize-)
94 |
95 | #### terminate ()
96 |
97 | Overrides: [Scene_Base](Scene_Base.md#terminate-)
98 |
--------------------------------------------------------------------------------
/docs/jsdoc/Scene_Save.md:
--------------------------------------------------------------------------------
1 | # Class: Scene_Save
2 |
3 | ## Extends: [Scene_File](Scene_File.md)
4 |
5 | #### new Scene_Save ()
6 |
7 | セーブ画面のシーン。
8 |
9 | 関連クラス: [DataManager](DataManager.md), [Game_Interpreter](Game_Interpreter.md)
10 | 関連シーン: [Scene_Load](Scene_Load.md), [Scene_Menu](Scene_Menu.md)
11 |
12 | ### Inherited From
13 |
14 | #### [PIXI.DisplayObject](PIXI.DisplayObject.md)
15 |
16 | - [(static) mixin (source)](PIXI.DisplayObject.md#static-mixin-source)
17 | - [\_recursivePostUpdateTransform ()](PIXI.DisplayObject.md#_recursivepostupdatetransform-)
18 | - [displayObjectUpdateTransform ()](PIXI.DisplayObject.md#displayobjectupdatetransform-)
19 | - [getBounds (skipUpdate, rect)](PIXI.DisplayObject.md#getbounds-skipupdate-rect--pixirectangle)
20 | - [getGlobalPosition (point, skipUpdate)](PIXI.DisplayObject.md#getglobalposition-point-skipupdate--pixipoint)
21 | - [setParent (container)](PIXI.DisplayObject.md#setparent-container--pixicontainer)
22 | - [setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)](PIXI.DisplayObject.md#settransform-x-y-scalex-scaley-rotation-skewx-skewy-pivotx-pivoty--pixidisplayobject)
23 | - [toGlobal (position, point, skipUpdate)](PIXI.DisplayObject.md#toglobal-position-point-skipupdate--pixipoint)
24 | - [toLocal (position, from, point, skipUpdate)](PIXI.DisplayObject.md#tolocal-position-from-point-skipupdate--pixipoint)
25 |
26 | #### [PIXI.Container](PIXI.Container.md)
27 |
28 | - [addChild (child) ](PIXI.Container.md#addchild-child--pixidisplayobject)
29 | - [addChildAt (child, index)](PIXI.Container.md#addchildat-child-index--pixidisplayobject)
30 | - [calculateBounds ()](PIXI.Container.md#calculatebounds-)
31 | - [destroy ()](PIXI.Container.md#destroy-)
32 | - [getChildAt (index)](PIXI.Container.md#getchildat-index--pixidisplayobject)
33 | - [getChildByName (name)](PIXI.Container.md#getchildbyname-name--pixidisplayobject)
34 | - [getChildIndex (child)](PIXI.Container.md#getchildindex-child--pixidisplayobject)
35 | - [onChildrenChange ()](PIXI.Container.md#onchildrenchange-)
36 | - [removeChild (child)](PIXI.Container.md#removechild-child--pixidisplayobject)
37 | - [removeChildAt (index)](PIXI.Container.md#removechildat-index--pixidisplayobject)
38 | - [removeChildren (beginIndex, endIndex)](PIXI.Container.md#removechildren-beginindex-endindex--arraypixidisplayobject)
39 | - [render (renderer)](PIXI.Container.md#render-renderer)
40 | - [renderAdvanced (renderer)](PIXI.Container.md#renderadvanced-renderer)
41 | - [renderCanvas (renderer)](PIXI.Container.md#rendercanvas-renderer)
42 | - [setChildIndex (child, index)](PIXI.Container.md#setchildindex-child-index)
43 | - [sortChildren ()](PIXI.Container.md#sortchildren-)
44 | - [swapChildren (child, child2)](PIXI.Container.md#swapchildren-child-child2)
45 | - [updateTransform ()](PIXI.Container.md#updatetransform-)
46 |
47 | #### [Scene_Base](Scene_Base.md)
48 |
49 | - [addWindow (Window)](Scene_Base.md#addwindow-window)
50 | - [attachReservation ()](Scene_Base.md#attachreservation-)
51 | - [checkGameover ()](Scene_Base.md#checkgameover-)
52 | - [createFadeSprite ()](Scene_Base.md#createfadesprite-)
53 | - [createWindowLayer ()](Scene_Base.md#createwindowlayer-)
54 | - [detachReservation ()](Scene_Base.md#detachreservation-)
55 | - [fadeOutAll ()](Scene_Base.md#fadeoutall-)
56 | - [fadeSpeed ()](Scene_Base.md#fadespeed---number)
57 | - [isActive () ](Scene_Base.md#isactive---boolean)
58 | - [isBusy ()](Scene_Base.md#isbusy---boolean)
59 | - [isReady ()](Scene_Base.md#isready---boolean)
60 | - [popScene ()](Scene_Base.md#popscene-)
61 | - [slowFadeSpeed ()](Scene_Base.md#slowfadespeed---number)
62 | - [startFadeIn (duration opt, white opt)](Scene_Base.md#startfadein-duration-opt-white-opt)
63 | - [startFadeOut (duration opt, white opt)](Scene_Base.md#startfadeout-duration-opt-white-opt)
64 | - [stop ()](Scene_Base.md#stop-)
65 | - [update ()](Scene_Base.md#update-)
66 | - [updateChildren ()](Scene_Base.md#updatechildren-)
67 | - [updateFade ()](Scene_Base.md#updatefade-)
68 |
69 | #### [Scene_MenuBase](Scene_MenuBase.md)
70 |
71 | - [actor ()](Scene_MenuBase.md#actor---game_actor)
72 | - [nextActor ()](Scene_MenuBase.md#nextactor-)
73 | - [onActorChange ()](Scene_MenuBase.md#onactorchange-)
74 | - [previousActor ()](Scene_MenuBase.md#previousactor-)
75 | - [setBackgroundOpacity (opacity)](Scene_MenuBase.md#setbackgroundopacity-opacity)
76 | - [updateActor ()](Scene_MenuBase.md#updateactor-)
77 |
78 | #### [Scene_File](Scene_File.md)
79 |
80 | - [activateListWindow ()](Scene_File.md#activatelistwindow-)
81 | - [create ()](Scene_File.md#create-)
82 | - [createHelpWindow ()](Scene_File.md#createhelpwindow-)
83 | - [createListWindow ()](Scene_File.md#createlistwindow-)
84 | - [savefileId ()](Scene_File.md#savefileid---number)
85 | - [start ()](Scene_File.md#start-)
86 |
87 | ### Methods
88 |
89 | #### firstSavefileIndex () → {[Number](Number.md)}
90 |
91 | Overrides: [Scene_File](Scene_File.md#firstsavefileindex---number)
92 |
93 | #### helpWindowText () → {[String](String.md)}
94 |
95 | Overrides: [Scene_File](Scene_File.md#helpwindowtext---string)
96 |
97 | #### initialize ()
98 |
99 | Overrides: [Scene_File](Scene_File.md#initialize-)
100 |
101 | #### mode () → {[String](String.md)}
102 |
103 | Overrides: [Scene_File](Scene_File.md#mode---string)
104 |
105 | #### onSaveFailure ()
106 |
107 | セーブに失敗した時に呼ばれるハンドラ。
108 |
109 | #### onSavefileOk ()
110 |
111 | Overrides: [onSavefileOk ()](Scene_File.md#onsavefileok-)
112 |
113 | #### onSaveSuccess ()
114 |
115 | セーブに成功した時に呼ばれるハンドラ。
116 |
--------------------------------------------------------------------------------
/docs/jsdoc/Scene_Status.md:
--------------------------------------------------------------------------------
1 | # Class: Scene_Status
2 |
3 | ## Extends: [Scene_MenuBase](Scene_MenuBase.md)
4 |
5 | ### new Scene_Status ()
6 |
7 | [ステータス]のシーン。
8 |
9 | 関連シーン: [Scene_Menu](Scene_Menu.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | --------------- | --------------------------------- | -------------------- |
15 | | `_statusWindow` | [Window_Status](Window_Status.md) | ステータスウィンドウ |
16 |
17 | ### Inherited From
18 |
19 | #### [PIXI.DisplayObject](PIXI.DisplayObject.md)
20 |
21 | - [(static) mixin (source)](PIXI.DisplayObject.md#static-mixin-source)
22 | - [\_recursivePostUpdateTransform ()](PIXI.DisplayObject.md#_recursivepostupdatetransform-)
23 | - [displayObjectUpdateTransform ()](PIXI.DisplayObject.md#displayobjectupdatetransform-)
24 | - [getBounds (skipUpdate, rect)](PIXI.DisplayObject.md#getbounds-skipupdate-rect--pixirectangle)
25 | - [getGlobalPosition (point, skipUpdate)](PIXI.DisplayObject.md#getglobalposition-point-skipupdate--pixipoint)
26 | - [setParent (container)](PIXI.DisplayObject.md#setparent-container--pixicontainer)
27 | - [setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)](PIXI.DisplayObject.md#settransform-x-y-scalex-scaley-rotation-skewx-skewy-pivotx-pivoty--pixidisplayobject)
28 | - [toGlobal (position, point, skipUpdate)](PIXI.DisplayObject.md#toglobal-position-point-skipupdate--pixipoint)
29 | - [toLocal (position, from, point, skipUpdate)](PIXI.DisplayObject.md#tolocal-position-from-point-skipupdate--pixipoint)
30 |
31 | #### [PIXI.Container](PIXI.Container.md)
32 |
33 | - [addChild (child) ](PIXI.Container.md#addchild-child--pixidisplayobject)
34 | - [addChildAt (child, index)](PIXI.Container.md#addchildat-child-index--pixidisplayobject)
35 | - [calculateBounds ()](PIXI.Container.md#calculatebounds-)
36 | - [destroy ()](PIXI.Container.md#destroy-)
37 | - [getChildAt (index)](PIXI.Container.md#getchildat-index--pixidisplayobject)
38 | - [getChildByName (name)](PIXI.Container.md#getchildbyname-name--pixidisplayobject)
39 | - [getChildIndex (child)](PIXI.Container.md#getchildindex-child--pixidisplayobject)
40 | - [onChildrenChange ()](PIXI.Container.md#onchildrenchange-)
41 | - [removeChild (child)](PIXI.Container.md#removechild-child--pixidisplayobject)
42 | - [removeChildAt (index)](PIXI.Container.md#removechildat-index--pixidisplayobject)
43 | - [removeChildren (beginIndex, endIndex)](PIXI.Container.md#removechildren-beginindex-endindex--arraypixidisplayobject)
44 | - [render (renderer)](PIXI.Container.md#render-renderer)
45 | - [renderAdvanced (renderer)](PIXI.Container.md#renderadvanced-renderer)
46 | - [renderCanvas (renderer)](PIXI.Container.md#rendercanvas-renderer)
47 | - [setChildIndex (child, index)](PIXI.Container.md#setchildindex-child-index)
48 | - [sortChildren ()](PIXI.Container.md#sortchildren-)
49 | - [swapChildren (child, child2)](PIXI.Container.md#swapchildren-child-child2)
50 | - [updateTransform ()](PIXI.Container.md#updatetransform-)
51 |
52 | #### [Scene_Base](Scene_Base.md)
53 |
54 | - [addWindow (Window)](Scene_Base.md#addwindow-window)
55 | - [attachReservation ()](Scene_Base.md#attachreservation-)
56 | - [checkGameover ()](Scene_Base.md#checkgameover-)
57 | - [createFadeSprite ()](Scene_Base.md#createfadesprite-)
58 | - [createWindowLayer ()](Scene_Base.md#createwindowlayer-)
59 | - [detachReservation ()](Scene_Base.md#detachreservation-)
60 | - [fadeOutAll ()](Scene_Base.md#fadeoutall-)
61 | - [fadeSpeed ()](Scene_Base.md#fadespeed---number)
62 | - [isActive () ](Scene_Base.md#isactive---boolean)
63 | - [isBusy ()](Scene_Base.md#isbusy---boolean)
64 | - [isReady ()](Scene_Base.md#isready---boolean)
65 | - [popScene ()](Scene_Base.md#popscene-)
66 | - [slowFadeSpeed ()](Scene_Base.md#slowfadespeed---number)
67 | - [startFadeIn (duration opt, white opt)](Scene_Base.md#startfadein-duration-opt-white-opt)
68 | - [startFadeOut (duration opt, white opt)](Scene_Base.md#startfadeout-duration-opt-white-opt)
69 | - [stop ()](Scene_Base.md#stop-)
70 | - [terminate ()](Scene_Base.md#terminate-)
71 | - [update ()](Scene_Base.md#update-)
72 | - [updateChildren ()](Scene_Base.md#updatechildren-)
73 | - [updateFade ()](Scene_Base.md#updatefade-)
74 |
75 | #### [Scene_MenuBase](Scene_MenuBase.md)
76 |
77 | - [actor ()](Scene_MenuBase.md#actor---game_actor)
78 | - [createHelpWindow ()](Scene_MenuBase.md#createhelpwindow-)
79 | - [nextActor ()](Scene_MenuBase.md#nextactor-)
80 | - [previousActor ()](Scene_MenuBase.md#previousactor-)
81 | - [setBackgroundOpacity (opacity)](Scene_MenuBase.md#setbackgroundopacity-opacity)
82 | - [updateActor ()](Scene_MenuBase.md#updateactor-)
83 |
84 | ### Methods
85 |
86 | #### create ()
87 |
88 | Overrides: [Scene_MenuBase](Scene_MenuBase.md#create-)
89 |
90 | #### initialize ()
91 |
92 | Overrides: [Scene_MenuBase](Scene_MenuBase.md#initialize-)
93 |
94 | #### onActorChange ()
95 |
96 | Overrides: [Scene_MenuBase](Scene_MenuBase.md#onactorchange-)
97 |
98 | #### refreshActor ()
99 |
100 | アクターの再描画。
101 |
102 | #### start ()
103 |
104 | Overrides: [Scene_Base](Scene_Base.md#start-)
105 |
--------------------------------------------------------------------------------
/docs/jsdoc/ScreenSprite.md:
--------------------------------------------------------------------------------
1 | # Class: ScreenSprite
2 |
3 | ## Extends: [PIXI.Container](PIXI.Container.md)
4 |
5 | #### new ScreenSprite ()
6 |
7 | 画面全体を覆うフェードなどのエフェクト用スプライト。
8 |
9 | 関連クラス: [Spriteset_Base](Spriteset_Base.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ------------ | --------------------------------- | -------------------------------------- |
15 | | `YEPWarned` | Boolean | [static] YEP_CoreEngine の警告が必要か |
16 | | `opacity` | [Number](Number.md) | 不透明度 (0〜255) |
17 | | `anchor` | [Point](Point.md) | 基点 |
18 | | `blendMode` | [Number](Number.md) | [[合成方法]](Sprite.md#合成方法) |
19 | | `_graphics` | [PIXI.Graphics](PIXI.Graphics.md) | 画像管理オブジェクト |
20 | | `_red` | [Number](Number.md) | 赤 (0〜255) |
21 | | `_green` | [Number](Number.md) | 緑 (0〜255) |
22 | | `_blue` | [Number](Number.md) | 青 (0〜255) |
23 | | `_colorText` | [String](String.md) | 色文字列(例: 'red') |
24 |
25 | ### Inherited From
26 |
27 | #### [PIXI.DisplayObject](PIXI.DisplayObject.md)
28 |
29 | - [(static) mixin (source)](PIXI.DisplayObject.md#static-mixin-source)
30 | - [\_recursivePostUpdateTransform ()](PIXI.DisplayObject.md#_recursivepostupdatetransform-)
31 | - [displayObjectUpdateTransform ()](PIXI.DisplayObject.md#displayobjectupdatetransform-)
32 | - [getBounds (skipUpdate, rect)](PIXI.DisplayObject.md#getbounds-skipupdate-rect--pixirectangle)
33 | - [getGlobalPosition (point, skipUpdate)](PIXI.DisplayObject.md#getglobalposition-point-skipupdate--pixipoint)
34 | - [getLocalBounds (rect)](PIXI.DisplayObject.md#getlocalbounds-rect--pixirectangle)
35 | - [setParent (container)](PIXI.DisplayObject.md#setparent-container--pixicontainer)
36 | - [setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)](PIXI.DisplayObject.md#settransform-x-y-scalex-scaley-rotation-skewx-skewy-pivotx-pivoty--pixidisplayobject)
37 | - [toGlobal (position, point, skipUpdate)](PIXI.DisplayObject.md#toglobal-position-point-skipupdate--pixipoint)
38 | - [toLocal (position, from, point, skipUpdate)](PIXI.DisplayObject.md#tolocal-position-from-point-skipupdate--pixipoint)
39 |
40 | #### [PIXI.Container](PIXI.Container.md)
41 |
42 | - [\_renderCanvas (renderer)](PIXI.Container.md#_rendercanvas-renderer)
43 | - [\_calculateBounds ()](PIXI.Container.md#_calculatebounds-)
44 | - [\_render (renderer)](PIXI.Container.md#_render-renderer)
45 | - [addChild (child) ](PIXI.Container.md#addchild-child--pixidisplayobject)
46 | - [addChildAt (child, index)](PIXI.Container.md#addchildat-child-index--pixidisplayobject)
47 | - [calculateBounds ()](PIXI.Container.md#calculatebounds-)
48 | - [destroy (options)](PIXI.Container.md#destroy-options)
49 | - [getChildAt (index)](PIXI.Container.md#getchildat-index--pixidisplayobject)
50 | - [getChildByName (name)](PIXI.Container.md#getchildbyname-name--pixidisplayobject)
51 | - [getChildIndex (child)](PIXI.Container.md#getchildindex-child--pixidisplayobject)
52 | - [onChildrenChange ()](PIXI.Container.md#onchildrenchange-)
53 | - [removeChild (child)](PIXI.Container.md#removechild-child--pixidisplayobject)
54 | - [removeChildAt (index)](PIXI.Container.md#removechildat-index--pixidisplayobject)
55 | - [removeChildren (beginIndex, endIndex)](PIXI.Container.md#removechildren-beginindex-endindex--arraypixidisplayobject)
56 | - [render (renderer)](PIXI.Container.md#render-renderer)
57 | - [renderAdvanced (renderer)](PIXI.Container.md#renderadvanced-renderer)
58 | - [setChildIndex (child, index)](PIXI.Container.md#setchildindex-child-index)
59 | - [sortChildren ()](PIXI.Container.md#sortchildren-)
60 | - [swapChildren (child, child2)](PIXI.Container.md#swapchildren-child-child2)
61 | - [updateTransform ()](PIXI.Container.md#updatetransform-)
62 |
63 | ### Methods
64 |
65 | #### (static) warnYep ()
66 |
67 | 必要なら YEP_CoreEngine の警告。
68 |
69 | #### initialize ()
70 |
71 | オブジェクト生成時の初期化。
72 |
73 | #### setBlack ()
74 |
75 | 黒に設定。
76 |
77 | #### setColor (r, g, b)
78 |
79 | 指定した色に設定。
80 |
81 | ##### Parameters:
82 |
83 | | Name | Type | Description |
84 | | ---- | ------------------- | ----------- |
85 | | `r` | [Number](Number.md) | 赤(0〜255) |
86 | | `g` | [Number](Number.md) | 緑(0〜255) |
87 | | `b` | [Number](Number.md) | 青(0〜255) |
88 |
89 | #### setWhite ()
90 |
91 | 白に設定。
92 |
--------------------------------------------------------------------------------
/docs/jsdoc/SoundManager.md:
--------------------------------------------------------------------------------
1 | # Class: SoundManager
2 |
3 | [効果音]で設定された音声を管理する静的クラス。
4 |
5 | データは大域変数 [$dataSystem](global.md#datasystem-rpgsystem) の sounds プロパティに記録されている。
6 |
7 | 関連クラス: [RPG.System](RPG.System.md), [WebAudio](WebAudio.md), [Html5Audio](Html5Audio.md), [RPG.AudioFile](RPG.AudioFile.md)
8 |
9 | ### Methods
10 |
11 | #### (static) loadSystemSound (n)
12 |
13 | 指定番号の音声を読み込む。
14 |
15 | ##### Parameters:
16 |
17 | | Name | Type | Description |
18 | | ---- | ------------------- | ----------- |
19 | | `n` | [Number](Number.md) | 音声番号 |
20 |
21 | #### (static) playActorCollapse ()
22 |
23 | [味方戦闘不能]を再生。
24 |
25 | #### (static) playActorDamage ()
26 |
27 | [味方ダメージ]を再生。
28 |
29 | #### (static) playBattleStart ()
30 |
31 | [戦闘開始]を再生。
32 |
33 | #### (static) playBossCollapse1 ()
34 |
35 | [ボス消滅 1]を再生。
36 |
37 | #### (static) playBossCollapse2 ()
38 |
39 | [ボス消滅 2]を再生。
40 |
41 | #### (static) playBuzzer ()
42 |
43 | [ブザー]を再生。
44 |
45 | #### (static) playCancel ()
46 |
47 | [キャンセル]を再生。
48 |
49 | #### (static) playCursor ()
50 |
51 | [カーソル]を再生。
52 |
53 | #### (static) playEnemyAttack ()
54 |
55 | [敵攻撃]を再生。
56 |
57 | #### (static) playEnemyCollapse ()
58 |
59 | [敵消滅]を再生。
60 |
61 | #### (static) playEnemyDamage ()
62 |
63 | [敵ダメージ]を再生。
64 |
65 | #### (static) playEquip ()
66 |
67 | [装備]を再生。
68 |
69 | #### (static) playEscape ()
70 |
71 | [逃走]を再生。
72 |
73 | #### (static) playEvasion ()
74 |
75 | [回避]を再生。
76 |
77 | #### (static) playLoad ()
78 |
79 | [ロード]を再生。
80 |
81 | #### (static) playMagicEvasion ()
82 |
83 | [魔法回避]を再生。
84 |
85 | #### (static) playMiss ()
86 |
87 | [ミス]を再生。
88 |
89 | #### (static) playOk ()
90 |
91 | [決定]を再生。
92 |
93 | #### (static) playRecovery ()
94 |
95 | [回復]を再生。
96 |
97 | #### (static) playReflection ()
98 |
99 | [魔法反射]を再生。
100 |
101 | #### (static) playSave ()
102 |
103 | [セーブ]を再生。
104 |
105 | #### (static) playShop ()
106 |
107 | [ショップ]を再生。
108 |
109 | #### (static) playSystemSound (n)
110 |
111 | 指定番号の音声を再生。
112 |
113 | ##### Parameters:
114 |
115 | | Name | Type | Description |
116 | | ---- | ------------------- | ----------- |
117 | | `n` | [Number](Number.md) | 音声番号 |
118 |
119 | #### (static) playUseItem ()
120 |
121 | [アイテム使用]を再生。
122 |
123 | #### (static) playUseSkill ()
124 |
125 | [スキル使用]を再生。
126 |
127 | #### (static) preloadImportantSounds ()
128 |
129 | 重要な音声をプリロード。
130 |
--------------------------------------------------------------------------------
/docs/jsdoc/Sprite_Destination.md:
--------------------------------------------------------------------------------
1 | # Class: Sprite_Destination
2 |
3 | ## Extends: [Sprite](Sprite.md)
4 |
5 | ### new Sprite_Destination ()
6 |
7 | タッチ箇所を表示するスプライト。
8 |
9 | 関連クラス: [TouchInput](TouchInput.md), [Spriteset_Map](Spriteset_Map.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | ------------- | ------------------- | ---------------- |
15 | | `_frameCount` | [Number](Number.md) | フレームカウント |
16 |
17 | ### Inherited From
18 |
19 | #### [PIXI.DisplayObject](PIXI.DisplayObject.md)
20 |
21 | - [(static) mixin (source)](PIXI.DisplayObject.md#static-mixin-source)
22 | - [\_recursivePostUpdateTransform ()](PIXI.DisplayObject.md#_recursivepostupdatetransform-)
23 | - [displayObjectUpdateTransform ()](PIXI.DisplayObject.md#displayobjectupdatetransform-)
24 | - [getBounds (skipUpdate, rect)](PIXI.DisplayObject.md#getbounds-skipupdate-rect--pixirectangle)
25 | - [getGlobalPosition (point, skipUpdate)](PIXI.DisplayObject.md#getglobalposition-point-skipupdate--pixipoint)
26 | - [setParent (container)](PIXI.DisplayObject.md#setparent-container--pixicontainer)
27 | - [setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)](PIXI.DisplayObject.md#settransform-x-y-scalex-scaley-rotation-skewx-skewy-pivotx-pivoty--pixidisplayobject)
28 | - [toGlobal (position, point, skipUpdate)](PIXI.DisplayObject.md#toglobal-position-point-skipupdate--pixipoint)
29 | - [toLocal (position, from, point, skipUpdate)](PIXI.DisplayObject.md#tolocal-position-from-point-skipupdate--pixipoint)
30 |
31 | #### [PIXI.Container](PIXI.Container.md)
32 |
33 | - [addChild (child) ](PIXI.Container.md#addchild-child--pixidisplayobject)
34 | - [addChildAt (child, index)](PIXI.Container.md#addchildat-child-index--pixidisplayobject)
35 | - [calculateBounds ()](PIXI.Container.md#calculatebounds-)
36 | - [getChildAt (index)](PIXI.Container.md#getchildat-index--pixidisplayobject)
37 | - [getChildByName (name)](PIXI.Container.md#getchildbyname-name--pixidisplayobject)
38 | - [getChildIndex (child)](PIXI.Container.md#getchildindex-child--pixidisplayobject)
39 | - [onChildrenChange ()](PIXI.Container.md#onchildrenchange-)
40 | - [removeChild (child)](PIXI.Container.md#removechild-child--pixidisplayobject)
41 | - [removeChildAt (index)](PIXI.Container.md#removechildat-index--pixidisplayobject)
42 | - [removeChildren (beginIndex, endIndex)](PIXI.Container.md#removechildren-beginindex-endindex--arraypixidisplayobject)
43 | - [render (renderer)](PIXI.Container.md#render-renderer)
44 | - [renderAdvanced (renderer)](PIXI.Container.md#renderadvanced-renderer)
45 | - [setChildIndex (child, index)](PIXI.Container.md#setchildindex-child-index)
46 | - [sortChildren ()](PIXI.Container.md#sortchildren-)
47 | - [swapChildren (child, child2)](PIXI.Container.md#swapchildren-child-child2)
48 | - [updateTransform ()](PIXI.Container.md#updatetransform-)
49 |
50 | #### [PIXI.Sprite](PIXI.Sprite.md)
51 |
52 | - [(static) from (source, options)](PIXI.Sprite.md#static-from-source-options--pixisprite)
53 | - [\_calculateBounds ()](PIXI.Sprite.md#_calculatebounds-)
54 | - [\_render (renderer)](PIXI.Sprite.md#_render-renderer)
55 | - [calculateTrimmedVertices ()](PIXI.Sprite.md#calculatetrimmedvertices-)
56 | - [calculateVertices ()](PIXI.Sprite.md#calculatevertices-)
57 | - [containsPoint (point)](PIXI.Sprite.md#containspoint-point--boolean)
58 | - [destroy (options)](PIXI.Sprite.md#destroy-options)
59 | - [getLocalBounds (rect)](PIXI.Sprite.md#getlocalbounds-rect--pixirectangle)
60 | - [renderCanvas (renderer)](PIXI.Sprite.md#rendercanvas-renderer)
61 |
62 | #### [Sprite](Sprite.md)
63 |
64 | - [\_createTinter (w, h)](Sprite.md#_createtinter-w-h)
65 | - [\_executeTint (x, y, w, h)](Sprite.md#_executetint-x-y-w-h)
66 | - [\_isInBitmapRect (x, y, w, h)](Sprite.md#_isinbitmaprect-x-y-w-h--boolean)
67 | - [\_needsTint ()](Sprite.md#_needstint---boolean)
68 | - [\_onBitmapLoad ()](Sprite.md#_onbitmapload-)
69 | - [\_refresh ()](Sprite.md#_refresh-)
70 | - [\_renderCanvas (renderer)](Sprite.md#_rendercanvas-renderer)
71 | - [\_renderWebGL (renderer)](Sprite.md#_renderwebgl-renderer)
72 | - [\_speedUpCustomBlendModes (renderer)](Sprite.md#_speedupcustomblendmodes-renderer)
73 | - [getBlendColor ()](Sprite.md#getblendcolor---array)
74 | - [getColorTone ()](Sprite.md#getcolortone---array)
75 | - [move (x, y)](Sprite.md#Sprite.md#move-x-y)
76 | - [setBlendColor (color)](Sprite.md#setblendcolor-color)
77 | - [setColorTone (tone)](Sprite.md#setcolortone-tone)
78 | - [setFrame (x, y, width, height)](Sprite.md#setframe-x-y-width-height)
79 |
80 | ### Methods
81 |
82 | #### createBitmap ()
83 |
84 | タッチ画像を生成。
85 |
86 | #### initialize ()
87 |
88 | Overrides:[Sprite](Sprite.md#initialize-)
89 |
90 | #### update ()
91 |
92 | Overrides:[Sprite](Sprite.md#update-)
93 |
94 | #### updateAnimation ()
95 |
96 | アニメーションのアップデート。
97 |
98 | #### updatePosition ()
99 |
100 | 位置のアップデート。
101 |
--------------------------------------------------------------------------------
/docs/jsdoc/Sprite_Timer.md:
--------------------------------------------------------------------------------
1 | # Class: Sprite_Timer
2 |
3 | ## Extends: [Sprite](Sprite.md)
4 |
5 | ### new Sprite_Timer ()
6 |
7 | | イベントコマンド | オブジェクト |
8 | | ---------------- | --------------------------- |
9 | | [タイマーの操作] | [Game_Timer](Game_Timer.md) |
10 |
11 | 関連クラス: [Game_Interpreter](Game_Interpreter.md), [Spriteset_Base](Spriteset_Base.md)
12 |
13 | ### Properties:
14 |
15 | | Name | Type | Description |
16 | | ---------- | ------------------- | ----------- |
17 | | `_seconds` | [Number](Number.md) | 秒 |
18 |
19 | ### Inherited From
20 |
21 | #### [PIXI.DisplayObject](PIXI.DisplayObject.md)
22 |
23 | - [(static) mixin (source)](PIXI.DisplayObject.md#static-mixin-source)
24 | - [\_recursivePostUpdateTransform ()](PIXI.DisplayObject.md#_recursivepostupdatetransform-)
25 | - [displayObjectUpdateTransform ()](PIXI.DisplayObject.md#displayobjectupdatetransform-)
26 | - [getBounds (skipUpdate, rect)](PIXI.DisplayObject.md#getbounds-skipupdate-rect--pixirectangle)
27 | - [getGlobalPosition (point, skipUpdate)](PIXI.DisplayObject.md#getglobalposition-point-skipupdate--pixipoint)
28 | - [setParent (container)](PIXI.DisplayObject.md#setparent-container--pixicontainer)
29 | - [setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)](PIXI.DisplayObject.md#settransform-x-y-scalex-scaley-rotation-skewx-skewy-pivotx-pivoty--pixidisplayobject)
30 | - [toGlobal (position, point, skipUpdate)](PIXI.DisplayObject.md#toglobal-position-point-skipupdate--pixipoint)
31 | - [toLocal (position, from, point, skipUpdate)](PIXI.DisplayObject.md#tolocal-position-from-point-skipupdate--pixipoint)
32 |
33 | #### [PIXI.Container](PIXI.Container.md)
34 |
35 | - [addChild (child) ](PIXI.Container.md#addchild-child--pixidisplayobject)
36 | - [addChildAt (child, index)](PIXI.Container.md#addchildat-child-index--pixidisplayobject)
37 | - [calculateBounds ()](PIXI.Container.md#calculatebounds-)
38 | - [getChildAt (index)](PIXI.Container.md#getchildat-index--pixidisplayobject)
39 | - [getChildByName (name)](PIXI.Container.md#getchildbyname-name--pixidisplayobject)
40 | - [getChildIndex (child)](PIXI.Container.md#getchildindex-child--pixidisplayobject)
41 | - [onChildrenChange ()](PIXI.Container.md#onchildrenchange-)
42 | - [removeChild (child)](PIXI.Container.md#removechild-child--pixidisplayobject)
43 | - [removeChildAt (index)](PIXI.Container.md#removechildat-index--pixidisplayobject)
44 | - [removeChildren (beginIndex, endIndex)](PIXI.Container.md#removechildren-beginindex-endindex--arraypixidisplayobject)
45 | - [render (renderer)](PIXI.Container.md#render-renderer)
46 | - [renderAdvanced (renderer)](PIXI.Container.md#renderadvanced-renderer)
47 | - [setChildIndex (child, index)](PIXI.Container.md#setchildindex-child-index)
48 | - [sortChildren ()](PIXI.Container.md#sortchildren-)
49 | - [swapChildren (child, child2)](PIXI.Container.md#swapchildren-child-child2)
50 | - [updateTransform ()](PIXI.Container.md#updatetransform-)
51 |
52 | #### [PIXI.Sprite](PIXI.Sprite.md)
53 |
54 | - [(static) from (source, options)](PIXI.Sprite.md#static-from-source-options--pixisprite)
55 | - [\_calculateBounds ()](PIXI.Sprite.md#_calculatebounds-)
56 | - [\_render (renderer)](PIXI.Sprite.md#_render-renderer)
57 | - [calculateTrimmedVertices ()](PIXI.Sprite.md#calculatetrimmedvertices-)
58 | - [calculateVertices ()](PIXI.Sprite.md#calculatevertices-)
59 | - [containsPoint (point)](PIXI.Sprite.md#containspoint-point--boolean)
60 | - [destroy (options)](PIXI.Sprite.md#destroy-options)
61 | - [getLocalBounds (rect)](PIXI.Sprite.md#getlocalbounds-rect--pixirectangle)
62 | - [renderCanvas (renderer)](PIXI.Sprite.md#rendercanvas-renderer)
63 |
64 | #### [Sprite](Sprite.md)
65 |
66 | - [\_createTinter (w, h)](Sprite.md#_createtinter-w-h)
67 | - [\_executeTint (x, y, w, h)](Sprite.md#_executetint-x-y-w-h)
68 | - [\_isInBitmapRect (x, y, w, h)](Sprite.md#_isinbitmaprect-x-y-w-h--boolean)
69 | - [\_needsTint ()](Sprite.md#_needstint---boolean)
70 | - [\_onBitmapLoad ()](Sprite.md#_onbitmapload-)
71 | - [\_refresh ()](Sprite.md#_refresh-)
72 | - [\_renderCanvas (renderer)](Sprite.md#_rendercanvas-renderer)
73 | - [\_renderWebGL (renderer)](Sprite.md#_renderwebgl-renderer)
74 | - [\_speedUpCustomBlendModes (renderer)](Sprite.md#_speedupcustomblendmodes-renderer)
75 | - [getBlendColor ()](Sprite.md#getblendcolor---array)
76 | - [getColorTone ()](Sprite.md#getcolortone---array)
77 | - [move (x, y)](Sprite.md#Sprite.md#move-x-y)
78 | - [setBlendColor (color)](Sprite.md#setblendcolor-color)
79 | - [setColorTone (tone)](Sprite.md#setcolortone-tone)
80 | - [setFrame (x, y, width, height)](Sprite.md#setframe-x-y-width-height)
81 |
82 | ### Methods
83 |
84 | #### createBitmap ()
85 |
86 | 画像の生成。
87 |
88 | #### initialize ()
89 |
90 | Overrides:[Sprite](Sprite.md#initialize-)
91 |
92 | #### redraw ()
93 |
94 | 再描画。
95 |
96 | #### timerText () → {[String](String.md)}
97 |
98 | タイマーを文字列で返す。
99 |
100 | #### update ()
101 |
102 | Overrides:[Sprite](Sprite.md#update-)
103 |
104 | #### updateBitmap ()
105 |
106 | 画像のアップデート。
107 |
108 | #### updatePosition ()
109 |
110 | 位置のアップデート。
111 |
112 | #### updateVisibility ()
113 |
114 | 表示・非表示のアップデート。
115 |
--------------------------------------------------------------------------------
/docs/jsdoc/Stage.md:
--------------------------------------------------------------------------------
1 | # Class: Stage
2 |
3 | ## Extends: [PIXI.Container](PIXI.Container.md)
4 |
5 | ### new Stage ()
6 |
7 | 画面構成オブジェクトのツリーへの追加・削除を行う基礎オブジェクト。
8 |
9 | 関連クラス: [Graphics](Graphics.md)
10 |
11 | ### Sub Classes
12 |
13 | - [Scene_Base](Scene_Base.md)
14 |
15 | ### Inherited From
16 |
17 | #### [PIXI.DisplayObject](PIXI.DisplayObject.md)
18 |
19 | - [(static) mixin (source)](PIXI.DisplayObject.md#static-mixin-source)
20 | - [\_recursivePostUpdateTransform ()](PIXI.DisplayObject.md#_recursivepostupdatetransform-)
21 | - [displayObjectUpdateTransform ()](PIXI.DisplayObject.md#displayobjectupdatetransform-)
22 | - [getBounds (skipUpdate, rect)](PIXI.DisplayObject.md#getbounds-skipupdate-rect--pixirectangle)
23 | - [getGlobalPosition (point, skipUpdate)](PIXI.DisplayObject.md#getglobalposition-point-skipupdate--pixipoint)
24 | - [setParent (container)](PIXI.DisplayObject.md#setparent-container--pixicontainer)
25 | - [setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)](PIXI.DisplayObject.md#settransform-x-y-scalex-scaley-rotation-skewx-skewy-pivotx-pivoty--pixidisplayobject)
26 | - [toGlobal (position, point, skipUpdate)](PIXI.DisplayObject.md#toglobal-position-point-skipupdate--pixipoint)
27 | - [toLocal (position, from, point, skipUpdate)](PIXI.DisplayObject.md#tolocal-position-from-point-skipupdate--pixipoint)
28 |
29 | #### [PIXI.Container](PIXI.Container.md)
30 |
31 | - [addChild (child) ](PIXI.Container.md#addchild-child--pixidisplayobject)
32 | - [addChildAt (child, index)](PIXI.Container.md#addchildat-child-index--pixidisplayobject)
33 | - [calculateBounds ()](PIXI.Container.md#calculatebounds-)
34 | - [destroy ()](PIXI.Container.md#destroy-)
35 | - [getChildAt (index)](PIXI.Container.md#getchildat-index--pixidisplayobject)
36 | - [getChildByName (name)](PIXI.Container.md#getchildbyname-name--pixidisplayobject)
37 | - [getChildIndex (child)](PIXI.Container.md#getchildindex-child--pixidisplayobject)
38 | - [onChildrenChange ()](PIXI.Container.md#onchildrenchange-)
39 | - [removeChild (child)](PIXI.Container.md#removechild-child--pixidisplayobject)
40 | - [removeChildAt (index)](PIXI.Container.md#removechildat-index--pixidisplayobject)
41 | - [removeChildren (beginIndex, endIndex)](PIXI.Container.md#removechildren-beginindex-endindex--arraypixidisplayobject)
42 | - [render (renderer)](PIXI.Container.md#render-renderer)
43 | - [renderAdvanced (renderer)](PIXI.Container.md#renderadvanced-renderer)
44 | - [renderCanvas (renderer)](PIXI.Container.md#rendercanvas-renderer)
45 | - [setChildIndex (child, index)](PIXI.Container.md#setchildindex-child-index)
46 | - [sortChildren ()](PIXI.Container.md#sortchildren-)
47 | - [swapChildren (child, child2)](PIXI.Container.md#swapchildren-child-child2)
48 | - [updateTransform ()](PIXI.Container.md#updatetransform-)
49 |
50 | ### Methods
51 |
52 | #### initialize ()
53 |
54 | オブジェクト生成時の初期化。
55 |
--------------------------------------------------------------------------------
/docs/jsdoc/String.md:
--------------------------------------------------------------------------------
1 | # Class: String
2 |
3 | ### new String ()
4 |
5 | JavaScript の文字列にいくつか RPG ツクール MV 独自のメソッドが追加してある。
6 |
7 | 詳細は [MDN の String のページ](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/String)を見てもらうとして。
8 | ここでは追加されたメソッドのみ解説。
9 |
10 | ### Methods
11 |
12 | #### contains (string) → {Boolean}
13 |
14 | 指定の文字列が含まれるか。
15 |
16 | ##### Parameters:
17 |
18 | | Name | Type | Description |
19 | | -------- | ------------------- | -------------- |
20 | | `string` | [String](String.md) | 検索する文字列 |
21 |
22 | #### format (...args) → {[String](String.md)}
23 |
24 | %1, %2 といった文字列を指定された引数で置き換えて返す。
25 |
26 | 引数には配列ではなく、複数の引数を渡す。
27 |
28 | ##### Parameters:
29 |
30 | | Name | Type | Description |
31 | | --------- | ---- | -------------- |
32 | | `...args` | Any | 入れ替え用の値 |
33 |
34 | #### padZero (length) → {[String](String.md)}
35 |
36 | 0 で埋めて、指定した長さの文字列にして返す。
37 |
38 | ##### Parameters:
39 |
40 | | Name | Type | Description |
41 | | -------- | ------------------- | ------------ |
42 | | `length` | [Number](Number.md) | 文字列の長さ |
43 |
--------------------------------------------------------------------------------
/docs/jsdoc/TilingSprite.md:
--------------------------------------------------------------------------------
1 | # Class: TilingSprite
2 |
3 | ## Extends: PIXI.extras.PictureTilingSprite([PIXI.TilingSprite](http://pixijs.download/release/docs/PIXI.TilingSprite.html))
4 |
5 | ### new TilingSprite (bitmap)
6 |
7 | The sprite object for a tiling image.
8 |
9 | 関連クラス: [Spriteset_Map](Spriteset_Map.md)
10 |
11 | #### Parameters:
12 |
13 | | Name | Type | Description |
14 | | -------- | ------------------- | ------------------------------- |
15 | | `bitmap` | [Bitmap](Bitmap.md) | The image for the tiling sprite |
16 |
17 | ### Properties:
18 |
19 | | Name | Type | Description |
20 | | ------------ | ------------------- | ---------------------------------------------------- |
21 | | `bitmap` | [Bitmap](Bitmap.md) | The image for the tiling sprite. |
22 | | `opacity` | [Number](Number.md) | The opacity of the tiling sprite (0 to 255). |
23 | | `spriteId` | [Number](Number.md) | |
24 | | `origin` | [Point](Point.md) | The origin point of the tiling sprite for scrolling. |
25 | | `x` | [Number](Number.md) | The x coordinate of the tiling sprite. |
26 | | `y` | [Number](Number.md) | The y coordinate of the tiling sprite. |
27 | | `spriteId` | [Number](Number.md) | |
28 | | `visibility` | [Number](Number.md) | The visibility of the tiling sprite. |
29 | | `_bitmap` | [Bitmap](Bitmap.md) | |
30 | | `_width` | [Number](Number.md) | |
31 | | `_height` | [Number](Number.md) | |
32 | | `_frame` | [Number](Number.md) | |
33 |
34 | ### Methods
35 |
36 | #### (static) \_onBitmapLoad ()
37 |
38 | #### (static) \_refresh ()
39 |
40 | #### (static) \_renderCanvas (renderer)
41 |
42 | ##### Parameters:
43 |
44 | | Name | Type | Description |
45 | | ---------- | ------ | ----------- |
46 | | `renderer` | Object | |
47 |
48 | #### (static) \_renderWebGL (renderer)
49 |
50 | ##### Parameters:
51 |
52 | | Name | Type | Description |
53 | | ---------- | ------ | ----------- |
54 | | `renderer` | Object | |
55 |
56 | #### (static) \_renderWebGL (renderer)
57 |
58 | ##### Parameters:
59 |
60 | | Name | Type | Description |
61 | | ---------- | ------ | ----------- |
62 | | `renderer` | Object | |
63 |
64 | #### (static) updateTransform ()
65 |
66 | #### initialize (bitmap)
67 |
68 | オブジェクト生成時の初期化。
69 |
70 | ##### Parameters:
71 |
72 | | Name | Type | Description |
73 | | -------- | ------------------- | ----------- |
74 | | `bitmap` | [Bitmap](Bitmap.md) | |
75 |
76 | #### move (x, y, width, height)
77 |
78 | Sets the x, y, width, and height all at once.
79 |
80 | ##### Parameters:
81 |
82 | | Name | Type | Description |
83 | | -------- | ------------------- | ------------------------------------- |
84 | | `x` | [Number](Number.md) | The x coordinate of the tiling sprite |
85 | | `y` | [Number](Number.md) | The y coordinate of the tiling sprite |
86 | | `width` | [Number](Number.md) | The width of the tiling sprite |
87 | | `height` | [Number](Number.md) | The height of the tiling sprite |
88 |
89 | #### setFrame (x, y, width, height)
90 |
91 | Specifies the region of the image that the tiling sprite will use.
92 |
93 | ##### Parameters:
94 |
95 | | Name | Type | Description |
96 | | -------- | ------------------- | ----------------------------- |
97 | | `x` | [Number](Number.md) | The x coordinate of the frame |
98 | | `y` | [Number](Number.md) | The y coordinate of the frame |
99 | | `width` | [Number](Number.md) | The width of the frame |
100 | | `height` | [Number](Number.md) | The height of the frame |
101 |
102 | #### update ()
103 |
104 | Updates the tiling sprite for each frame.
105 |
--------------------------------------------------------------------------------
/docs/jsdoc/ToneFilter.md:
--------------------------------------------------------------------------------
1 | # Class: ToneFilter
2 |
3 | ## Extends: PIXI.ColorMatrixFilter([PIXI.filters.ColorMatrixFilter](http://pixijs.download/release/docs/PIXI.filters.ColorMatrixFilter.html))
4 |
5 | #### new ToneFilter ()
6 |
7 | The color matrix filter for WebGL.
8 |
9 | 関連クラス: [ToneSprite](ToneSprite.md)
10 |
11 | ### Methods
12 |
13 | #### adjustHue (value)
14 |
15 | Changes the hue.
16 |
17 | ##### Parameters:
18 |
19 | | Name | Type | Description |
20 | | ------- | ------------------- | -------------------------------------- |
21 | | `value` | [Number](Number.md) | The hue value in the range (-360, 360) |
22 |
23 | #### adjustSaturation (value)
24 |
25 | Changes the saturation.
26 |
27 | ##### Parameters:
28 |
29 | | Name | Type | Description |
30 | | ------- | ------------------- | --------------------------------------------- |
31 | | `value` | [Number](Number.md) | The saturation value in the range (-255, 255) |
32 |
33 | #### adjustTone (r, g, b)
34 |
35 | Changes the tone.
36 |
37 | ##### Parameters:
38 |
39 | | Name | Type | Description |
40 | | ---- | ------------------- | ------------------------------------------- |
41 | | `r` | [Number](Number.md) | The red strength in the range (-255, 255) |
42 | | `g` | [Number](Number.md) | The green strength in the range (-255, 255) |
43 | | `b` | [Number](Number.md) | The blue strength in the range (-255, 255) |
44 |
--------------------------------------------------------------------------------
/docs/jsdoc/ToneSprite.md:
--------------------------------------------------------------------------------
1 | # Class: ToneSprite
2 |
3 | ## Extends: [PIXI.Container](PIXI.Container.md)
4 |
5 | ### new ToneSprite ()
6 |
7 | The sprite which changes the screen color in 2D canvas mode.
8 |
9 | 関連クラス: [ToneFilter](ToneFilter.md), [Spriteset_Base](Spriteset_Base.md)
10 |
11 | ### Properties:
12 |
13 | | Name | Type | Description |
14 | | -------- | ------------------- | ----------- |
15 | | `_red` | [Number](Number.md) | |
16 | | `_green` | [Number](Number.md) | |
17 | | `_blue` | [Number](Number.md) | |
18 | | `_gray` | [Number](Number.md) | |
19 |
20 | ### Methods
21 |
22 | #### (static) \_renderCanvas (renderSession)
23 |
24 | ##### Parameters:
25 |
26 | | Name | Type | Description |
27 | | --------------- | ------ | ----------- |
28 | | `renderSession` | Object | |
29 |
30 | #### (static) \_renderWebGL (renderSession)
31 |
32 | ##### Parameters:
33 |
34 | | Name | Type | Description |
35 | | --------------- | ------ | ----------- |
36 | | `renderSession` | Object | |
37 |
38 | #### initialize ()
39 |
40 | オブジェクト生成時の初期化。
41 |
42 | #### reset ()
43 |
44 | Clears the tone.
45 |
46 | #### setTone (r, g, b, gray)
47 |
48 | Sets the tone.
49 |
50 | ##### Parameters:
51 |
52 | | Name | Type | Description |
53 | | ------ | ------------------- | ------------------------------------------- |
54 | | `r` | [Number](Number.md) | The red strength in the range (-255, 255) |
55 | | `g` | [Number](Number.md) | The green strength in the range (-255, 255) |
56 | | `b` | [Number](Number.md) | The blue strength in the range (-255, 255) |
57 | | `gray` | [Number](Number.md) | The grayscale level in the range (0, 255) |
58 |
--------------------------------------------------------------------------------
/docs/jsdoc/Utils.md:
--------------------------------------------------------------------------------
1 | # Class: Utils
2 |
3 | 便利なメソッドを集めた静的クラス。
4 |
5 | ##### Properties:
6 |
7 | | Name | Type | Description |
8 | | ------------------ | ------------------- | ----------------------------------------- |
9 | | `RPGMAKER_NAME` | [String](String.md) | [static] RPG ツクールの名前(規定値: 'MV') |
10 | | `RPGMAKER_VERSION` | [String](String.md) | [static] RPG ツクールのバージョン |
11 |
12 | ### Methods
13 |
14 | #### (static) canReadGameFiles () → {Boolean}
15 |
16 | ゲームのフォルダにあるファイルが読めるか。
17 |
18 | #### (static) generateRuntimeId () → {[Number](Number.md)}
19 |
20 | ランタイム ID を生成して返す。
21 |
22 | #### (static) isAndroidChrome () → {Boolean}
23 |
24 | ブラウザが Android Chrome か。
25 |
26 | #### (static) isMobileDevice () → {Boolean}
27 |
28 | モバイルデバイスか。
29 |
30 | #### (static) isMobileSafari () → {Boolean}
31 |
32 | ブラウザが Mobile Safari か。
33 |
34 | #### (static) isNwjs () → {Boolean}
35 |
36 | 基盤に NW.js を使っているか。
37 |
38 | #### (static) isOptionValid (name) → {Boolean}
39 |
40 | 指定オプション(ブラウザだと URL の?以降の&で区切られたクエリ)が含まれるか。
41 | 'test', 'btest', 'etest', 'onTop', 'devToolOff', 'showfps', 'canvas', 'webgl', 'noaudio'
42 |
43 | ##### Parameters:
44 |
45 | | Name | Type | Description |
46 | | ------ | ------------------- | ---------------- |
47 | | `name` | [String](String.md) | オプション文字列 |
48 |
49 | #### (static) isSupportPassiveEvent () → {Boolean}
50 |
51 | ブラウザがパッシブイベントを採用しているか。
52 |
53 | #### (static) rgbToCssColor (r, g, b) → {[MV.CssColor](MV.CssColor.md)}
54 |
55 | 指定した RGB の色数値から CSS 色文字列を生成して返す。
56 |
57 | ##### Parameters:
58 |
59 | | Name | Type | Description |
60 | | ---- | ------------------- | ----------- |
61 | | `r` | [Number](Number.md) | 赤 (0〜255) |
62 | | `g` | [Number](Number.md) | 緑 (0〜255) |
63 | | `b` | [Number](Number.md) | 青 (0〜255) |
64 |
--------------------------------------------------------------------------------
/docs/jsdoc/Weather.md:
--------------------------------------------------------------------------------
1 | # Class: Weather
2 |
3 | ## Extends: [PIXI.Container](PIXI.Container.md)
4 |
5 | #### new Weather ()
6 |
7 | The weather effect which displays rain, storm, or snow.
8 |
9 | ### Properties:
10 |
11 | | Name | Type | Description |
12 | | --------------- | --------------------------------------------- | ---------------------------------------------- |
13 | | `type` | [String](String.md) | The type of the weather. |
14 | | `power` | [Number](Number.md) | The power of the weather in the range (0, 9). |
15 | | `origin` | [Point](Point.md) | The origin point of the weather for scrolling. |
16 | | `_width` | [Number](Number.md) | |
17 | | `_height` | [Number](Number.md) | |
18 | | `_sprites` | [Array](Array.md).<[Sprite](Sprite.md)> | |
19 | | `_rainBitmap` | [Bitmap](Bitmap.md) | |
20 | | `_stormBitmap` | [Bitmap](Bitmap.md) | |
21 | | `_snowBitmap` | [Bitmap](Bitmap.md) | |
22 | | `_dimmerSprite` | [ScreenSprite](ScreenSprite.md) | |
23 |
24 | #### 天候タイプ
25 |
26 | | type | 天候タイプ |
27 | | ----- | ---------- |
28 | | none | |
29 | | rain | |
30 | | storm | |
31 | | snow | |
32 |
33 | ### Methods
34 |
35 | #### (static) \_addSprite ()
36 |
37 | #### (static) \_createBitmaps ()
38 |
39 | #### (static) \_createDimmer ()
40 |
41 | #### (static) \_rebornSprite (sprite)
42 |
43 | ##### Parameters:
44 |
45 | | Name | Type | Description |
46 | | -------- | ------------------- | ----------- |
47 | | `sprite` | [Sprite](Sprite.md) | |
48 |
49 | #### (static) \_removeSprite ()
50 |
51 | #### (static) \_updateAllSprites ()
52 |
53 | #### (static) \_updateDimmer ()
54 |
55 | #### (static) \_updateRainSprite (sprite)
56 |
57 | ##### Parameters:
58 |
59 | | Name | Type | Description |
60 | | -------- | ------------------- | ----------- |
61 | | `sprite` | [Sprite](Sprite.md) | |
62 |
63 | #### (static) \_updateSnowSprite (sprite)
64 |
65 | ##### Parameters:
66 |
67 | | Name | Type | Description |
68 | | -------- | ------------------- | ----------- |
69 | | `sprite` | [Sprite](Sprite.md) | |
70 |
71 | #### (static) \_updateSprite (sprite)
72 |
73 | ##### Parameters:
74 |
75 | | Name | Type | Description |
76 | | -------- | ------------------- | ----------- |
77 | | `sprite` | [Sprite](Sprite.md) | |
78 |
79 | #### (static) \_updateStormSprite (sprite)
80 |
81 | ##### Parameters:
82 |
83 | | Name | Type | Description |
84 | | -------- | ------------------- | ----------- |
85 | | `sprite` | [Sprite](Sprite.md) | |
86 |
87 | #### initialize ()
88 |
89 | オブジェクト生成時の初期化。
90 |
91 | #### update ()
92 |
93 | Updates the weather for each frame.
94 |
--------------------------------------------------------------------------------
/docs/jsdoc/global.md:
--------------------------------------------------------------------------------
1 | # Global
2 |
3 | 大域(グローバル)変数の一覧。[DataManager](DataManager.md) で生成・管理されている。
4 |
5 | 多くの箇所で参照されるクラスが$から始まる大域変数に格納されていて、次の種類がある。
6 |
7 | - 名前に data が付いた( data フォルダ以下にある JSON ファイルの)データクラス
8 | - 名前に game が付いた管理用のクラス
9 | - そのほかのクラス
10 |
11 | $gameXxx の多くはセーブデータになるが、セーブされないものもある。
12 |
13 | ### Members
14 |
15 | #### $dataActors :[Array](Array.md).<[RPG.Actor](RPG.Actor.md)>
16 |
17 | [アクター]用 JSON( Actors.json )。
18 |
19 | #### $dataAnimations :[Array](Array.md).<[RPG.Animation](RPG.Animation.md)>
20 |
21 | [アニメーション]用 JSON( Animations.json )。
22 |
23 | #### $dataArmors :[Array](Array.md).<[RPG.Armor](RPG.Armor.md)>
24 |
25 | [防具]用 JSON( Armors.json )。
26 |
27 | #### $dataClasses :[Array](Array.md).<[RPG.Class](RPG.Class.md)>
28 |
29 | [職業]用 JSON( Classes.json )。
30 |
31 | #### $dataCommonEvents :[Array](Array.md).<[RPG.CommonEvent](RPG.CommonEvent.md)>
32 |
33 | [コモンイベント]用 JSON( CommonEvents.json )。
34 |
35 | #### $dataEnemies :[Array](Array.md).<[RPG.Enemy](RPG.Enemy.md)>
36 |
37 | [敵キャラ]用 JSON( Enemies.json )。
38 |
39 | #### $dataItems :[Array](Array.md).<[RPG.Item](RPG.Item.md)>
40 |
41 | [アイテム]用 JSON( Items.json )。
42 |
43 | #### $dataMap :[RPG.Map](RPG.Map.md)
44 |
45 | 現在のマップ用 JSON( MapXXX.json( XXX は 3 桁の数値) )。
46 |
47 | #### $dataMapInfos :[Array](Array.md).<[RPG.MapInfo](RPG.MapInfo.md)>
48 |
49 | マップ一覧用 JSON( MapInfo.json )。
50 |
51 | #### $dataSkills :[Array](Array.md).<[RPG.Skill](RPG.Skill.md)>
52 |
53 | [スキル]用 JSON( Skills.json )。
54 |
55 | #### $dataStates :[Array](Array.md).<[RPG.State](RPG.State.md)>
56 |
57 | [ステート]用 JSON( States.json )。
58 |
59 | #### $dataSystem :[RPG.System](RPG.System.md)
60 |
61 | [システム]用 JSON( System.json )。
62 |
63 | #### $dataTilesets :[Array](Array.md).<[RPG.Tileset](RPG.Tileset.md)>
64 |
65 | [タイルセット]用 JSON( Tilesets.json )。
66 |
67 | #### $dataTroops :[Array](Array.md).<[RPG.Troop](RPG.Troop.md)>
68 |
69 | [敵グループ]用 JSON( Troops.json )。
70 |
71 | #### $dataWeapons :[Array](Array.md).<[RPG.Weapon](RPG.Weapon.md)>
72 |
73 | [武器]用 JSON( Weapons.json )。
74 |
75 |
76 |
77 | #### $gameActors :[Game_Actors](Game_Actors.md)
78 |
79 | [アクター]管理用のクラス。※セーブ
80 |
81 | #### $gameMap :[Game_Map](Game_Map.md)
82 |
83 | [マップ]管理用のクラス。※セーブ
84 |
85 | #### $gameMessage :[Game_Message](Game_Message.md)
86 |
87 | [メッセージ]管理用のクラス。
88 |
89 | #### $gameParty :[Game_Party](Game_Party.md)
90 |
91 | [パーティー]管理用のクラス。※セーブ
92 |
93 | #### $gamePlayer :[Game_Player](Game_Player.md)
94 |
95 | [プレイヤー]管理用のクラス。※セーブ
96 |
97 | #### $gameScreen :[Game_Screen](Game_Screen.md)
98 |
99 | 画面管理用のクラス。※セーブ
100 |
101 | #### $gameSelfSwitches :[Game_SelfSwitches](Game_SelfSwitches.md)
102 |
103 | [セルフスイッチ]管理用のクラス。※セーブ
104 |
105 | #### $gameSwitches :[Game_Switches](Game_Switches.md)
106 |
107 | [スイッチ]管理用のクラス。※セーブ
108 |
109 | #### $gameSystem :[Game_System](Game_System.md)
110 |
111 | [システム]管理用のクラス。※セーブ
112 |
113 | #### $gameTemp :[Game_Temp](Game_Temp.md)
114 |
115 | ゲームの一時データを保持しておくクラス。
116 |
117 | #### $gameTimer :[Game_Timer](Game_Timer.md)
118 |
119 | タイマー管理用のクラス。※セーブ
120 |
121 | #### $gameTroop :[Game_Troop](Game_Troop.md)
122 |
123 | [敵グループ]管理用のクラス。
124 |
125 | #### $gameVariables :[Game_Variables](Game_Variables.md)
126 |
127 | [変数]管理用のクラス。※セーブ
128 |
129 |
130 |
131 | #### $plugins :[Array](Array.md).<[MV.PluginSettings](MV.PluginSettings.md)>
132 |
133 | RPG ツクール MV プラグイン設定( js/plugins.js )。
134 |
135 | #### $testEvent :[Array](Array.md).<[RPG.EventCommand](RPG.EventCommand.md)>
136 |
137 | [テスト]を実行した場合に渡される[イベント]。
138 |
--------------------------------------------------------------------------------
/format.js:
--------------------------------------------------------------------------------
1 | const fs = require("fs");
2 | const prettier = require("prettier");
3 |
4 | const markdowns = [
5 | "./docs/index.md",
6 | ...fs.readdirSync("./docs/jsdoc").map((path) => `./docs/jsdoc/${path}`),
7 | ];
8 |
9 | markdowns.forEach((path) => {
10 | const file = fs.readFileSync(path, { encoding: "utf-8" });
11 | const beautified = prettier.format(file, { parser: "markdown" });
12 | fs.writeFileSync(path, beautified);
13 | });
14 |
--------------------------------------------------------------------------------
/jsdocFIles/README.md:
--------------------------------------------------------------------------------
1 | # これは?
2 |
3 | 初版のスクリプトリファレンス自動生成に使用したメタファイル。
4 | もう使用していないが、一応とっておく。
5 |
--------------------------------------------------------------------------------
/jsdocFIles/gulpfile.js:
--------------------------------------------------------------------------------
1 | var gulp = require("gulp");
2 | var htmlbeautify = require("gulp-html-beautify");
3 | var markdown = require("gulp-breakdance");
4 | var rename = require("gulp-rename");
5 | var replace = require("gulp-replace");
6 |
7 | gulp.task("normal", () => {
8 | gulp
9 | .src("./_jsdoc/**/*.html")
10 | .pipe(
11 | htmlbeautify({
12 | preserve_newlines: false
13 | })
14 | )
15 | .pipe(gulp.dest("./_jsdoc/"));
16 | });
17 | gulp.task("convert", () => {
18 | gulp
19 | .src("./_jsdoc/**/*.html")
20 | .pipe(markdown())
21 | .pipe(rename({
22 | extname: ".md"
23 | }))
24 | .pipe(gulp.dest("./docs/jsdoc/"));
25 | });
26 |
27 | gulp.task("replace", () => {
28 | gulp
29 | .src("./docs/jsdoc/**/*.md")
30 | .pipe(replace(/\[(.*?)\]\((.*?)\.html\)/g,"[$1]($2.md)"))
31 | .pipe(gulp.dest("./docs/jsdoc/"));
32 | });
--------------------------------------------------------------------------------
/jsdocFIles/jsdoc.conf.json:
--------------------------------------------------------------------------------
1 | {
2 | "tags": {
3 | "allowUnknownTags": true
4 | },
5 | "source": {
6 | "include": ["src"],
7 | "includePattern": ".+\\.js(doc|x)?$",
8 | "excludePattern": "(^|\\/|\\\\)_"
9 | },
10 | "plugins": [],
11 | "templates": {
12 | "cleverLinks": false,
13 | "monospaceLinks": false,
14 | "default": {
15 | "outputSourceFiles": false,
16 | "layoutFile": "./jsdoc.layout.tmpl"
17 | }
18 | }
19 | }
--------------------------------------------------------------------------------
/jsdocFIles/jsdoc.layout.tmpl:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/package-lock.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "RPGMV-CoreScript-Reference",
3 | "version": "1.0.0",
4 | "lockfileVersion": 2,
5 | "requires": true,
6 | "packages": {
7 | "": {
8 | "name": "RPGMV-CoreScript-Reference",
9 | "version": "1.0.0",
10 | "license": "MIT",
11 | "dependencies": {
12 | "@types/node": "^18.14.1",
13 | "prettier": "^2.8.4"
14 | }
15 | },
16 | "node_modules/@types/node": {
17 | "version": "18.14.1",
18 | "resolved": "https://registry.npmjs.org/@types/node/-/node-18.14.1.tgz",
19 | "integrity": "sha512-QH+37Qds3E0eDlReeboBxfHbX9omAcBCXEzswCu6jySP642jiM3cYSIkU/REqwhCUqXdonHFuBfJDiAJxMNhaQ=="
20 | },
21 | "node_modules/prettier": {
22 | "version": "2.8.4",
23 | "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.4.tgz",
24 | "integrity": "sha512-vIS4Rlc2FNh0BySk3Wkd6xmwxB0FpOndW5fisM5H8hsZSxU2VWVB5CWIkIjWvrHjIhxk2g3bfMKM87zNTrZddw==",
25 | "bin": {
26 | "prettier": "bin-prettier.js"
27 | },
28 | "engines": {
29 | "node": ">=10.13.0"
30 | },
31 | "funding": {
32 | "url": "https://github.com/prettier/prettier?sponsor=1"
33 | }
34 | }
35 | },
36 | "dependencies": {
37 | "@types/node": {
38 | "version": "18.14.1",
39 | "resolved": "https://registry.npmjs.org/@types/node/-/node-18.14.1.tgz",
40 | "integrity": "sha512-QH+37Qds3E0eDlReeboBxfHbX9omAcBCXEzswCu6jySP642jiM3cYSIkU/REqwhCUqXdonHFuBfJDiAJxMNhaQ=="
41 | },
42 | "prettier": {
43 | "version": "2.8.4",
44 | "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.4.tgz",
45 | "integrity": "sha512-vIS4Rlc2FNh0BySk3Wkd6xmwxB0FpOndW5fisM5H8hsZSxU2VWVB5CWIkIjWvrHjIhxk2g3bfMKM87zNTrZddw=="
46 | }
47 | }
48 | }
49 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "RPGMV-CoreScript-Reference",
3 | "version": "1.0.0",
4 | "main": "index.js",
5 | "repository": "https://github.com/katai5plate/RPGMV-CoreScript-Reference.git",
6 | "author": "katai5plate ",
7 | "license": "MIT",
8 | "scripts": {
9 | "format": "node format"
10 | },
11 | "dependencies": {
12 | "@types/node": "^18.14.1",
13 | "prettier": "^2.8.4"
14 | }
15 | }
16 |
--------------------------------------------------------------------------------