RPG Maker MV Documentation

https://hat-soft.top/component_notes/RPGMakerMV/html/
Admin
Comprehensive technical documentation and API reference guide for RPG Maker MV game development,...
Tokens:46,865
Snippets:404
Trust Score:4.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Native Modules with nw-gyp

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Environment configuration and commands for building native modules for NW.js.

```bash
＃全局安装nw-gyp
npm install -g nw-gyp
＃设置目标NW.js版本
set npm_config_target=0.31.4
＃设置构建架构，ia32或x64，win10, osx为x64操作系统
set npm_config_arch=x64
set npm_config_runtime=node-webkit
set npm_config_build_from_source=true
set npm_config_node_gyp=C:\Users\NALA\AppData\Roaming\npm\node_modules\nw-gyp\bin\nw-gyp.js
 
#win10下还要设置python路径：
set PYTHON=C:\Users\NALA\.windows-build-tools\python27\python.exe
 
最后 npm install —msvs_version=2015•安装编译不成功，就多试几次，删除package-lock.json
 
```

--------------------------------

### Get Current Window Instance

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Two equivalent ways to retrieve the singleton Window object.

```javascript
var win = require('nw.gui').Window.get();
var win2 = nw.Window.get();
```

--------------------------------

### DataManager.loadGlobalInfo

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Loads the global configuration information, returning an array starting from index 1.

```APIDOC
DataManager.loadGlobalInfo();
```

--------------------------------

### BattleManager.setup

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Initializes a battle encounter.

```APIDOC
## BattleManager.setup(troopId, canEscape, canLose)

### Description
Initializes the battle system with the specified troop ID and configuration flags.

### Parameters
- **troopId** (Number) - The ID of the enemy troop to encounter.
- **canEscape** (Boolean) - Whether the player can escape the battle.
- **canLose** (Boolean) - Whether the player can lose the battle.
```

--------------------------------

### $gameScreen.startShake(power, speed, duration)

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Shakes the screen.

```APIDOC
## $gameScreen.startShake(power, speed, duration)

### Description
Triggers a screen shake effect.

### Parameters
- **power** (number) - Required - The intensity of the shake.
- **speed** (number) - Required - The speed of the shake.
- **duration** (number) - Required - The duration of the shake in frames.
```

--------------------------------

### $gameScreen.startTint(tone, duration)

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Changes the screen color tint.

```APIDOC
## $gameScreen.startTint(tone, duration)

### Description
Applies a color tint to the screen.

### Parameters
- **tone** (array) - Required - An array of 4 numbers representing [Red, Green, Blue, Gray].
- **duration** (number) - Required - The duration of the transition in frames.
```

--------------------------------

### Initialize Game Info Manager

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Instantiates the Game_Infor_Manager with specific parameters.

```javascript
var $gameInfor = new Game_Infor_Manager(1, "美好的美一天", new Data(2021, 3, 15));
```

--------------------------------

### 配置 package.json 窗口属性

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

在 package.json 的 window 配置中禁用边框并开启透明支持。

```json
 "window": {
    "frame": false,
    "transparent": true
  },
```

--------------------------------

### NW.js 游戏打包命令

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

通过命令行将 NW.js 环境与游戏资源包合并为可执行文件。

```bash
copy /b nw.exe+app.nw app.exe
```

--------------------------------

### nw.Window.open()

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Opens a new window with specified URL and configuration.

```APIDOC
## nw.Window.open(url, options, callback)

### Description
Opens a new window. The callback is executed when the new window is created.

### Parameters
- **url** (string) - The URL to load in the new window.
- **options** (object) - Configuration object for the window.
- **callback** (function) - Function called after window creation.
```

--------------------------------

### $gameScreen.startFlash(color, duration)

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Flashes the screen with a specific color.

```APIDOC
## $gameScreen.startFlash(color, duration)

### Description
Flashes the screen with the specified color.

### Parameters
- **color** (array) - Required - An array of 4 numbers representing [Red, Green, Blue, Intensity].
- **duration** (number) - Required - The duration of the flash in frames.
```

--------------------------------

### SceneManager.goto

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Transitions to a new scene, replacing the current one.

```APIDOC
## SceneManager.goto(sceneClass)

### Description
Transitions to a new scene (e.g., Gameover, Title) by replacing the current scene.

### Supported Scenes
- Scene_Gameover
- Scene_Title
```

--------------------------------

### $gameSystem Methods

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Methods for modifying global system settings.

```APIDOC
## $gameSystem Methods

### Description
Methods to control system-wide settings like audio, access permissions, and window appearance.

### Methods
- **setBattleBgm(bgm)** - Sets the battle background music.
- **setVictoryMe(me)** - Sets the victory music effect.
- **setDefeatMe(me)** - Sets the defeat music effect.
- **disableSave() / enableSave()** - Toggles save menu access.
- **disableMenu() / enableMenu()** - Toggles main menu access.
- **disableEncounter() / enableEncounter()** - Toggles random encounters.
- **disableFormation() / enableFormation()** - Toggles formation menu access.
- **setWindowTone(value)** - Sets the window color tone (array of 4 numbers: [r, g, b, gray]).
```

--------------------------------

### nw.Window.get()

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Retrieves the singleton instance of the current window.

```APIDOC
## nw.Window.get()

### Description
Returns the singleton Window object representing the current application window.

### Usage
```javascript
var win = nw.Window.get();
```
```

--------------------------------

### 配置 dependencies 字段

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

定义项目的必要依赖项，支持嵌套结构和版本数组。

```json
"dependencies": {
 		 "webkit": "1.2",
 		 "ssl": {
 			  "gnutls": ["1.0", "2.0"],
 			  "openssl": "0.9.8",
 		 },
}
```

--------------------------------

### 插件指令处理逻辑

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

扩展 Game_Interpreter 的 pluginCommand 方法以支持 FileAccess 指令。

```javascript
var _Game_Interpreter_pluginCommand = Game_Interpreter.prototype.pluginCommand;

Game_Interpreter.prototype.pluginCommand = function (command, args) {
 	_Game_Interpreter_pluginCommand.call(this, command, args);
 	if (command === 'FileAccess') {
 	 	switch (args[0]) {
 	 	 	case 'write':
 	 	 	 	write();
 	 	 		break;
 	 	 	case 'isEqualTo':
 	 	 	 	isEqualTo(args[1]);
 	 	 		break;
 	 	  }
 	  }
};
```

--------------------------------

### Binding Window Commands and Handlers

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Demonstrates adding a custom command to the title window and binding its handler in the scene.

```javascript
Window_TitleCommand.prototype.makeCommandList = function() {



    this.addCommand(TextManager.newGame,   'newGame');



    this.addCommand(TextManager.continue_, 'continue', this.isContinueEnabled());



    this.addCommand(TextManager.options,   'options');



    this.addCommand("测试",   'test');



};







Scene_Title.prototype.createCommandWindow = function() {



    this._commandWindow = new Window_TitleCommand();



    this._commandWindow.setHandler('newGame',  this.commandNewGame.bind(this));



    this._commandWindow.setHandler('continue', this.commandContinue.bind(this));



    this._commandWindow.setHandler('options',  this.commandOptions.bind(this));



    this._commandWindow.setHandler('test',  this.Test.bind(this));



    this.addWindow(this._commandWindow);



};



 



Scene_Title.prototype.Test = function() {



    alert("hello world")



};
```

--------------------------------

### 配置 licenses 字段

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

定义项目的许可证列表，包含许可证类型和对应的 URL。

```json
"licenses": [
{
"type": "GPLv2",
"url": "http://www.example.com/licenses/gpl.html",
}
]
```

--------------------------------

### Open a New Window

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Opens a new window with a callback function triggered upon creation.

```javascript
nw.Window.open('test.html', {}, function (new_win) {
    //新窗口创建时的回调函数
    new_win.on('focus', function () {
        console.log('点击了新窗口！');
    });
});
```

--------------------------------

### 注册全局快捷键

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

通过 nw.Shortcut 对象定义快捷键及其回调函数，并使用 nw.App.registerGlobalHotKey 进行注册。

```javascript
var option = {
    key : "Ctrl+Shift+A",
    active : function() {
        console.log("发现快捷键: " + this.key + " 被激活！"); 
    },
    failed : function(msg) {
        //报错信息
        console.log(msg);
    }
};

var shortcut = new nw.Shortcut(option);
nw.App.registerGlobalHotKey(shortcut);
```

--------------------------------

### $gameScreen.startFadeIn(duration)

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Initiates a screen fade-in effect.

```APIDOC
## $gameScreen.startFadeIn(duration)

### Description
Fades the screen in over the specified duration.

### Parameters
- **duration** (number) - Required - The duration of the fade in frames.
```

--------------------------------

### SceneManager.push

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Navigates to a new scene by pushing it onto the scene stack.

```APIDOC
## SceneManager.push(sceneClass)

### Description
Transitions to a new scene (e.g., Shop, Menu, Save) by pushing it onto the stack.

### Supported Scenes
- Scene_Shop
- Scene_Name
- Scene_Menu
- Scene_Save
```

--------------------------------

### 插件指令扩展

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

通过重写 Game_Interpreter.prototype.pluginCommand 来添加自定义插件指令。

```javascript
//下面这个格式也是固定的
//注意，要是不需要插件指令的话，可以不写
var _Game_Interpreter_pluginCommand = Game_Interpreter.prototype.pluginCommand;
Game_Interpreter.prototype.pluginCommand = function (command, args) {
 	_Game_Interpreter_pluginCommand.call(this, command, args);
 	//设计你的插件指令，command就是你插件指令的名字，当然这个可以不止一个，可以用else来创建多个指令
 	if (command === '插件指令名字') {
 	 	//参数0就是你的第一个参数
 	 	//比如说插件指令为command 第一个参数为one
 	 	//那么指令就是这样调用的  command one 
 	 	switch (args[0]) {
 	 	 	case '某':
 	 	 	 //代码
 	 	 		break;
 	 	 	case '某某某':
 	 	 	 //代码
 	 	 		break;
 	  	}
 	  }
};
```

--------------------------------

### Window State Management

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Methods for full-screen, minimizing, and maximizing the window.

```javascript
nw.Window.get().enterFullscreen();//全屏
nw.Window.get().leaveFullscreen() //退出全屏

nw.Window.get().minimize();//最小化

nw.Window.get().maximize()//最大化
用途:Linux和Window中最大化窗口 , Mac中放大窗口

win.minimize()
用途:Windows/Mac中最小化窗口 , Linux中图标化窗口
```

--------------------------------

### 自定义菜单指令窗体

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

创建一个继承自 Window_Command 的自定义窗体类，并实现辅助说明窗体。

```javascript
(() => {

    //1.自己的自定义窗体
    function Window_Test() {
        this.initialize.apply(this, arguments);
    }

    //2.继承一个窗体类，根据不同需求可以自行改动
    Window_Test.prototype = Object.create(Window_Command.prototype);

    //3.把构造函数指向自己
    Window_Test.prototype.constructor = Window_Test;

    //4.写初始化函数
    Window_Test.prototype.initialize = function (x, y) {
        Window_Command.prototype.initialize.call(this, x, y)//xy代表位置
        this.refresh();//刷新窗口
        this.activate();//激活
    }

    //窗口类的核心方法，自定义代码就在这里写
    Window_Test.prototype.makeCommandList = function () {
        this.addCommand("自定义的指令", '指令名', true);//指令名是代码内部调用的，可以通过setHandler来使用
        //自定义代码，都在这里写。
    }


    //右侧的说明区域
    function 自定义HELP(){
        this.initialize.apply(this, arguments);
    }
    自定义HELP.prototype = Object.create(Window_Base.prototype);
    自定义HELP.prototype.constructor = 自定义HELP;

    自定义HELP.prototype.initialize = function () {
        var x = 250;
        var y = 0;
        var width = 500;
        var height = this.fittingHeight(2);//行宽
        Window_Base.prototype.initialize.call(this, x, y, width, height);
        this._text = '';
    }

    //窗口类的核心方法，自定义代码就在这里写
    自定义HELP.prototype.setInfo = function(text){
        this.contents.clear();
        this._text =text;
        this.drawTextEx(this._text, this.textPadding(), 0);
    }

})
```

--------------------------------

### NW.js 基础配置字段

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

配置 NW.js 应用的入口文件及名称。

```json
"main": "index.html",  
```

--------------------------------

### Display Choices

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Methods to configure and handle user choice menus.

```javascript
$gameMessage.setChoiceBackground(0);
```

```javascript
$gameMessage.setChoicePositionType(positionType);
```

```javascript
 $gameMessage.setChoices(choices, defaultType, cancelType);
```

```javascript
 $gameMessage.setChoiceCallback(callback);
```

```javascript
$gameMessage.setChoices([ "我","是","选","项"],0,2);
$gameMessage.setChoiceBackground(1);
$gameMessage.setChoicePositionType(1);
$gameMessage.setChoiceCallback(function(n){
 	console.log("你选择的是第"+(n+1)+"项！")
});
```

--------------------------------

### Create a Custom Window in Scene_Map

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Implements a custom window on the map screen by hooking into the createDisplayObjects method.

```javascript
(function () {
  //1.创建一个函数，名字就是你自定义窗体的名字
  function 窗体名() {
    this.initialize.apply(this, arguments);
  }
  //2.继承Window_Base类
  窗体名.prototype = Object.create(Window_Base.prototype);
  窗体名.prototype.constructor = 窗体名;

  //3.初始化窗体大小
  窗体名.prototype.initialize = function () {
    Window_Base.prototype.initialize.call(this, 0, 0, 100, 100);//分别代表位置和长宽
    this.drawText('莲华', 5, 5, 100, 'left');
  };

  //4.写创建窗体函数
  Scene_Base.prototype.创建窗体 = function () {
    this.addWindow(new 窗体名());
  };

  //5.创建窗体
  var _Scene_Map_createDisplayObjects = Scene_Map.prototype.createDisplayObjects;
  Scene_Map.prototype.createDisplayObjects = function () {
    _Scene_Map_createDisplayObjects.call(this);
    this.创建窗体();
  };
})();
```

--------------------------------

### $gameMessage.add

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Displays a text message in the game window.

```APIDOC
## $gameMessage.add(text)

### Description
Displays a text message in the game window. Can be preceded by configuration methods for face images, background, and position.

### Parameters
- **text** (string) - Required - The message content to display.

### Example
$gameMessage.setFaceImage("Actor1", 0);
$gameMessage.setBackground(0);
$gameMessage.setPositionType(2);
$gameMessage.add("Hello World");
```

--------------------------------

### NW.js JS 引擎特性配置

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

在 package.json 中通过 js-flags 启用 V8 引擎特性。

```json
{
 	"name": "nw-demo",
 	"main": "index.html",
 	"js-flags": "--harmony_proxies --harmony_collections"
}
```

--------------------------------

### nw.Window.get() Event Handling

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Methods to attach and remove event listeners for window state changes.

```APIDOC
## nw.Window.get() Event Listeners

### Description
Manage window lifecycle events including minimize, maximize, focus, blur, and fullscreen states.

### Methods
- **on(event, callback)**: Registers a listener for the specified window event.
- **removeAllListeners(event)**: Removes all listeners associated with the specified event.

### Supported Events
- `minimize`: Triggered when the window is minimized.
- `maximize`: Triggered when the window is maximized.
- `close`: Triggered when the window is closed.
- `focus`: Triggered when the window gains focus.
- `blur`: Triggered when the window loses focus.
- `enter-fullscreen`: Triggered when the window enters fullscreen mode.
- `devtools-closed`: Triggered when the developer tools are closed.

### Usage Example
```javascript
// Listen for minimize event
nw.Window.get().on('minimize', function() {
  console.log('Window minimized');
});

// Remove all listeners for minimize
nw.Window.get().removeAllListeners('minimize');
```
```

--------------------------------

### 加载 UI 样式

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

动态创建并插入 CSS 样式表链接。

```javascript
RealtimeBattleSystem.loadCSS = function () {
    var stylesheet = document.createElement("link")
    stylesheet.rel = "stylesheet"
    stylesheet.href = "./css/realtimeBattleSystem.css"
    stylesheet.type = "text/css"
    document.head.appendChild(stylesheet)
}
```

--------------------------------

### Check NW.js Version

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Retrieve the current NW.js version string.

```javascript
nw.process.versions.nw
```

--------------------------------

### Focus Window

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Bring the window to the foreground.

```javascript
nw.Window.get().focus()
```

--------------------------------

### 配置键盘按键映射

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

通过修改 Input.keyMapper 对象自定义按键映射，例如添加 WASD 控制方向。

```javascript
Input.keyMapper = {
    9: 'tab',      
    13: 'ok',       
    16: 'shift',    
    17: 'control',  
    18: 'control',  
    27: 'escape',   
    32: 'ok',       
    33: 'pageup',   
    34: 'pagedown', 
    37: 'left',     
    38: 'up',       
    39: 'right',   
    40: 'down',     
    45: 'escape',  
    81: 'pageup',   
    87: 'pagedown', 
    88: 'escape',  
    90: 'ok',      
    96: 'escape',   
    98: 'down',     
    100: 'left',    
    102: 'right',   
    104: 'up',      
    120: 'debug',   
    //WASD的按键
    65: 'left',     // 左箭头键
    87: 'up',       // 上箭头键
    68: 'right',    // 右箭头键
    83: 'down'     // 下箭头键
};
```

--------------------------------

### $gameMessage.setItemChoice

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Opens the item selection window.

```APIDOC
## $gameMessage.setItemChoice(variableId, itemType)

### Description
Prompts the player to select an item from their inventory and stores the ID in a variable.

### Parameters
- **variableId** (number) - Required - The ID of the game variable to store the selected item ID.
- **itemType** (number) - Required - The type of item (1: Normal, 2: Key, 3: Hidden A, 4: Hidden B).
```

--------------------------------

### 文件写入功能

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

使用 Node.js fs 模块将内容写入指定路径，若文件不存在则自动创建。

```javascript
function write() {
 	const fs = require('fs');

 	let folder = Yan.Parameters.folder;
 	let file = Yan.Parameters.file;
 	let extension = Yan.Parameters.extension;
 	let content = Yan.Parameters.content;

 	content = `<!DOCTYPE html>
 	<html lang="ch">
 	<head>
 	 	<meta charset="UTF-8">
 	 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
 	 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
 	 	<title>Document</title>
 	</head>
 	<body>
 	 	hello world
 	</body>
 	</html>
 	`

 	let path = folder + file + "." + extension;
 	//writeFile会覆盖原有的内容,而且若找不到文件,会自己创建一个文件
 	fs.writeFile(path, content, (err) => {
 	 	if (err)
 	 	 	alert("写入失败！");
  });
}
```

--------------------------------

### $gameScreen.startFadeOut(duration)

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Initiates a screen fade-out effect.

```APIDOC
## $gameScreen.startFadeOut(duration)

### Description
Fades the screen out over the specified duration.

### Parameters
- **duration** (number) - Required - The duration of the fade in frames.
```

--------------------------------

### $gameMessage.setChoices

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Configures and displays a choice selection menu.

```APIDOC
## $gameMessage.setChoices(choices, defaultType, cancelType)

### Description
Sets the options for a choice menu and defines the callback function for user selection.

### Parameters
- **choices** (array) - Required - Array of strings representing the choices.
- **defaultType** (number) - Required - Index of the default selected choice.
- **cancelType** (number) - Required - Index of the choice triggered on cancel.

### Example
$gameMessage.setChoices(["Yes", "No"], 0, 1);
$gameMessage.setChoiceCallback(function(n) {
  console.log("Selected index: " + n);
});
```

--------------------------------

### Set Window Position by Preset

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Move the window to a predefined position like center or mouse location.

```javascript
nw.Window.get().setPosition('mouse')//移动窗口到鼠标所在位置
```

--------------------------------

### 调用默认应用与文件操作

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

使用 nw.Shell 模块在默认浏览器打开链接、用默认编辑器打开文件或在资源管理器中定位文件。

```javascript
// 默认浏览器中打开指定URL
nw.Shell.openExternal('https://github.com/nwjs/nw.js');

// 默认编辑器中打开指定文件。
nw.Shell.openItem('test.txt');

// 文件管理器中显示指定文件所在目录。
nw.Shell.showItemInFolder('test.txt');
```

--------------------------------

### 注册自定义菜单指令

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

通过重写 Window_MenuCommand 的 addOriginalCommands 方法添加指令，并在 Scene_Menu 中注册对应的处理函数。

```javascript
    Window_MenuCommand.prototype.addOriginalCommands = function () {//这个方法是专门给我们提供的，可以用来重写。
        //在菜单指令中添加指令，但是要注意，如果只写了这个，是没有效果的，
        //必须在createCommandWindow中，给test注册响应函数才能点进去
        this.addCommand('指令名', 'test', true);
    }

    Scene_Menu.prototype.commandTest = function () {
        SceneManager.push(Scene_Test);
    }

    Scene_Menu.prototype.createCommandWindow = function () {

        this._commandWindow = new Window_MenuCommand(0, 0);
        this._commandWindow.setHandler('item', this.commandItem.bind(this));
        this._commandWindow.setHandler('skill', this.commandPersonal.bind(this));
        this._commandWindow.setHandler('equip', this.commandPersonal.bind(this));
        this._commandWindow.setHandler('status', this.commandPersonal.bind(this));
        this._commandWindow.setHandler('formation', this.commandFormation.bind(this));
        this._commandWindow.setHandler('options', this.commandOptions.bind(this));
        this._commandWindow.setHandler('save', this.commandSave.bind(this));
        this._commandWindow.setHandler('gameEnd', this.commandGameEnd.bind(this));
        this._commandWindow.setHandler('cancel', this.popScene.bind(this));
        this._commandWindow.setHandler('test', this.commandTest.bind(this));
        this.addWindow(this._commandWindow);
    }

})
```

--------------------------------

### RPG Maker MV 鼠标点击触发插件代码

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

包含插件元数据、插件指令处理以及核心的鼠标点击逻辑。通过重写 TouchInput._onMouseDown 实现点击检测，并检查事件备注以决定是否触发。

```javascript
/*:
 * @plugindesc 本插件用于给一个事件添加可以鼠标左键点击的效果
 * 
 * @author 闫辰祥
 * 
 *
 * 
 * @help 
 * 插件指令：
 * 事件点击 开始
 * 事件点击 关闭
 * 
 * 安装好之后，用鼠标点击事件，然后事件就会被触发
 * 对不希望触发的事件，可以在备注加上   <不可点击>  来关闭触发
 *
 *
 * 技术群：529245311
 */

var 闫 = 闫 || {};

闫.Parameters = PluginManager.parameters('闫_鼠标触发事件');


var _Game_Interpreter_pluginCommand = Game_Interpreter.prototype.pluginCommand;
Game_Interpreter.prototype.pluginCommand = function (command, args) {
    _Game_Interpreter_pluginCommand.call(this, command, args);

    if (command === '事件点击') {
        switch (args[0]) {
            case '开始':
                可以开始点了 = true
                break;
            case '关闭':
                可以开始点了 = false
                break;
        }
    }
};

var 可以开始点了 = true
var temp_TouchInput_onMouseDown = TouchInput._onMouseDown

TouchInput._onMouseDown = function (event) {
    temp_TouchInput_onMouseDown.call(this, event)

    if($dataMap == null)
    {
        return
    }
    if (event.button === 0 && 可以开始点了) {
        var x = Graphics.pageToCanvasX(event.pageX);
        var y = Graphics.pageToCanvasY(event.pageY);

        x = $gameMap.canvasToMapX(TouchInput.x);
        y = $gameMap.canvasToMapY(TouchInput.y);

        var event = $gameMap.eventsXy(x, y)[0];

       
        var eventId = $gameMap.eventIdXy(x,y);
        if (!event)
            return
        if(!event.page())
            return
        if ($dataMap.events[eventId].meta.不可点击)
            return

        event.start();
    }
};
```

--------------------------------

### 修改 Scene_MenuBase 背景透明度

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

重写菜单背景创建方法，将背景精灵的透明度设置为 0。

```javascript
Scene_MenuBase.prototype.createBackground = function() {

    this._backgroundSprite = new Sprite();
    //闫修改，增加了这个
    this._backgroundSprite.opacity = 0;

    this._backgroundSprite.bitmap = SceneManager.backgroundBitmap();
    this.addChild(this._backgroundSprite);
};
```

--------------------------------

### 场景切换指令

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

通过 SceneManager 进行场景跳转或压栈。

```javascript
SceneManager.push(Scene_Shop);
```

```javascript
SceneManager.push(Scene_Name);
```

```javascript
SceneManager.push(Scene_Menu);
```

```javascript
SceneManager.push(Scene_Save);
```

```javascript
SceneManager.goto(Scene_Gameover);
```

```javascript
SceneManager.goto(Scene_Title);
```

--------------------------------

### Create a Custom Window in Scene_Menu

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Defines a custom window class and integrates it into the menu scene by overriding createStatusWindow.

```javascript
(function () {
    //1.创建一个函数，名字就是你自定义窗体的名字
    function 窗体名() {
        this.initialize.apply(this, arguments);
    }
    //2.继承Window_Base类
    窗体名.prototype = Object.create(Window_Base.prototype);
    窗体名.prototype.constructor = 窗体名;

    //3.初始化窗体大小
    var statusWindow = {
        x: 240,
        y: 0,
        width: 576,
        height: 624
    };
    窗体名.prototype.initialize = function () {
        Window_Base.prototype.initialize.call(this, statusWindow.x, statusWindow.y,
            statusWindow.width, statusWindow.height);
    };

    //4.写刷新函数，系统会自动调用这个函数
    窗体名.prototype.refresh = function () {
        this.contents.clear();
        this.drawText("hello world", 144, 0, 200);
    };

    //5.将窗口布局到游戏里面
    Scene_Menu.prototype.createStatusWindow = function () {
        this._statusWindow = new 窗体名();
        this.addWindow(this._statusWindow);
    };
})();
```

--------------------------------

### NW.js package.json Configuration

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Standard configuration structure for the package.json file in an NW.js project.

```json
{
    "name": "",
    "main": "index.html",
    "js-flags": "--expose-gc",
    "window": {
        "title": "",
        "toolbar": false,
        "width": 816,
        "height": 624,
        "icon": "icon/icon.png"
    }
}
```

--------------------------------

### Window Manipulation Methods

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Methods for controlling window position, size, and state.

```APIDOC
## Window Manipulation Methods

### Positioning
- `moveTo(x, y)`: Moves window to absolute coordinates.
- `moveBy(x, y)`: Moves window by relative offset.
- `setPosition(position)`: Sets position using presets like 'center' or 'mouse'.

### Resizing
- `resizeTo(width, height)`: Sets window dimensions.
- `resizeBy(width, height)`: Adjusts window dimensions by offset.
- `setMaximumSize(width, height)`: Sets maximum window size.
- `setMinimumSize(width, height)`: Sets minimum window size.
- `setResizable(boolean)`: Enables or disables user resizing.

### State Management
- `focus()`: Brings window to front.
- `setAlwaysOnTop(boolean)`: Toggles window pinning.
- `enterFullscreen()` / `leaveFullscreen()`: Toggles fullscreen mode.
- `minimize()` / `maximize()`: Toggles window state.
- `hide()`: Hides the window.
```

--------------------------------

### $gamePlayer.reserveTransfer(mapId, x, y, d, fadeType)

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Schedules a player transfer to a new map location with a specified fade effect. fadeType: 0 (Black), 1 (White), 2 (None).

```APIDOC
$gamePlayer.reserveTransfer(3, 33, 34, 0, 0);
```

--------------------------------

### 播放视频

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

播放指定路径的视频文件。

```javascript
Graphics.playVideo('movies/PV.webm');
```

--------------------------------

### 配置 RENDER_OPTIONS 透明选项

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

在渲染配置中开启透明选项，并强制设置透明属性为 true。

```javascript
 RENDER_OPTIONS: {
    transparent: true,
```

```javascript
_this.transparent = options.transparent
```

```javascript
_this.transparent = true;
```

--------------------------------

### 设置 index.html 背景透明

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

在 index.html 中将 body 的背景颜色设置为完全透明。

```html
<body style="background-color:rgba(0, 0, 0, 0);">
```

--------------------------------

### 插件命名空间与参数初始化

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

通过命名空间防止变量污染，并使用 PluginManager 获取插件配置参数。

```javascript
//这个一般都是你的名字，但是没有强制要求，
//只要是一个对象就可以
var Yan = Yan || {};
//下面这个就是来注册插件，格式是固定的
//注意名字要和文件名一样
Yan.Parameters = PluginManager.parameters('你插件的名字');

//下面这个就是插件的参数，
Yan.Parameters.参数1 = String(Yan.Parameters['参数'] || '默认值');
Yan.Parameters.参数2 = String(Yan.Parameters['参数2'] || '默认值');
```

--------------------------------

### 窗口色调设置

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

设置窗口色调，参数为包含RGBA值的数组。

```javascript
$gameSystem.setWindowTone(value);
```

```javascript
$gameSystem.setWindowTone([200,100,100,0]);//设置窗口rgb为200，100，100
```

--------------------------------

### 更新战斗 UI

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

根据当前队伍领袖的状态更新 HP、MP、防御力和攻击力显示。

```javascript
RealtimeBattleSystem.updateUI = function () {

    var hpBar = document.querySelector("#hp-bar")
    hpBar.innerHTML = `生命值：${$gameParty.leader()._hp} 之于 ${$gameParty.leader().mhp}`

    var mpBar = document.querySelector("#mp-bar")
    mpBar.innerHTML = `法术值：${$gameParty.leader()._mp} 之于  ${$gameParty.leader().mmp}`

    var defBar = document.querySelector("#def-bar")
    defBar.innerHTML = `防御力：${$gameParty.leader().def}`

    var atkBar = document.querySelector("#atk-bar")
    atkBar.innerHTML = `攻击力：${$gameParty.leader().atk}`
}
```

--------------------------------

### 文件读取与比较功能

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

使用 Node.js fs 模块读取指定路径文件并与传入字符串进行比较。

```javascript
function isEqualTo(string){
 	const fs = require('fs');

 	let folder = Yan.Parameters.folder;
 	let file = Yan.Parameters.file;
 	let extension = Yan.Parameters.extension;
 	let path = folder + file + "." + extension;

 	fs.readFile(path,'utf-8', function (err, data) {
 	 	if (err) 
 	 	 	alert("读取失败！");

 	 	alert(data.toString()=="true");
  });
}
```

--------------------------------

### 禁用鼠标点击

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

通过重写 TouchInput._onMouseDown 方法来禁用鼠标点击事件。

```javascript
TouchInput._onMouseDown = function(event) {
    // 什么都不要写
};
```

--------------------------------

### 完整的 package.json 配置示例

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

展示了包含主程序入口、窗口属性、WebKit 设置及应用元数据的完整 package.json 结构。

```json
{
    /**指定程序的起始页面。*/
    "main": "index.html",

    /**字符串必须是小写字母或者数字，可以包含.或者_或者-不允许带空格。name必须全局唯一。*/
    "name": "demo",

    /**程序描述*/
    "description": "demo app of node-webkit",

    /**程序版本号*/
    "version": "0.1.0",

    /**关键字*/
    "keywords": ["demo","node-webkit"],

    /**bool值，如果设置为false，将禁用webkit的node支持。*/
    "nodejs": true,
    /**
     * 指定一个node.js文件，当程序启动时，该文件会被运行，启动时间要早于node-webkit加载html的时间。
     * 它在node上下文中运行，可以用它来实现类似后台线程的功能。
     * （不需要可注释不用）
     */
    "node-main": "js/node.js",


    /**
     * bool值。默认情况下，如果将node-webkit程序打包发布，那么只能启动一个该应用的实例。
     * 如果你希望允许同时启动多个实例，将该值设置为false。
     */
    "single-instance": true,

    /**窗口属性设置 */
    "window": {
        /**字符串，设置默认title。*/
        "title": "demo",
        /**窗口的icon。*/
        "icon": "link.png",
        /**bool值。是否显示导航栏。*/
        "toolbar": false,
        /**bool值。是否允许调整窗口大小。*/
        "resizable": true,
        /**是否全屏*/
        "fullscreen": false,
        /**是否在win任务栏显示图标*/
        "show_in_taskbar": true,
        /**bool值。如果设置为false，程序将无边框显示。*/
        "frame": true,
        /**字符串。窗口打开时的位置，可以设置为“null”、“center”或者“mouse”。*/
        "position": "center",
        /**主窗口的的宽度。*/
        "width": 800,
        /**主窗口的的高度。*/
        "height": 670,
        /**窗口的最小宽度。*/
        "min_width": 400,
        /**窗口的最小高度。*/
        "min_height": 335,
        /**窗口显示的最大宽度，可不设。*/
        "max_width": 800,
        /**窗口显示的最大高度，可不设。*/
        "max_height": 670,
        /**bool值，如果设置为false，启动时窗口不可见。*/
        "show": true,
        /**是否在任务栏显示图标。*/
        "show_in_taskbar":true,
        /**
         * bool值。是否使用kiosk模式。如果使用kiosk模式，
         * 应用程序将全屏显示，并且阻止用户离开应用。
         * */
        "kiosk": false
    },

    /**webkit设置*/
    "webkit": {
        /**bool值，是否加载插件，如flash，默认值为false。*/
        "plugin": true,
        /**bool值，是否加载Java applets，默认为false。*/
        "java": false,
        /**bool值，是否启用页面缓存，默认为false。*/
        "page-cache": false
  }
}
```

--------------------------------

### 弹幕配置类 DannmakuConfig

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

用于初始化弹幕的各项参数，如时间间隔、速度、颜色和字体大小。

```javascript
class DannmakuConfig {
    constructor(config) {
        config = config || {};
        this.time = config.time || 1;//每隔几秒发送一个弹幕
        this.speed = config.speed || 5;//弹幕速度
        this.color = config.color || 'black';//弹幕颜色
        this.fontSize = config.fontSize || '30px';//弹幕大小
    }
}
```

--------------------------------

### 战斗系统更新循环

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

主更新函数，负责协调攻击检查、回调处理、UI 更新及敌人状态更新。

```javascript
RealtimeBattleSystem.update = function () {
    RealtimeBattleSystem.checkAttack()

    RealtimeBattleSystem.updateEventCallback()

    RealtimeBattleSystem.updateUI()
    RealtimeBattleSystem.updateEnemy()
}
```

--------------------------------

### $gameMessage.setNumberInput

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Opens the number input window.

```APIDOC
## $gameMessage.setNumberInput(variableId, maxDigits)

### Description
Prompts the player to input a number, which is then stored in a game variable.

### Parameters
- **variableId** (number) - Required - The ID of the game variable to store the input.
- **maxDigits** (number) - Required - The maximum number of digits allowed.
```

--------------------------------

### 关闭游戏

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

强制关闭游戏窗口，无确认弹窗。

```javascript
window.close()
```

--------------------------------

### Input Class and Keyboard Mapping

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Methods for detecting keyboard events and configuring key mappings.

```APIDOC
## Input Class

### Input.keyMapper
An object mapping key codes to action names (e.g., 'ok', 'left', 'up', 'right', 'down').

### Input.isPressed(keyName)
Checks if the specified key is currently being pressed.

### Input.isTriggered(keyName)
Checks if the specified key was just pressed.

### Input.isRepeated(keyName)
Checks if the specified key is being clicked repeatedly or is held down.

### Input.isLongPressed(keyName)
Checks if the specified key is held down for a long duration.
```

--------------------------------

### $gameMap.startScroll(direction, distance, speed)

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Initiates a map scroll in a specific direction for a set distance at a defined speed.

```APIDOC
$gameMap.startScroll(2, 1, 4);
```

--------------------------------

### 增减护甲

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

调整队伍持有的护甲数量。

```javascript
$gameParty.gainItem($dataArmors[this._params[0]], value, this._params[4]);
```

--------------------------------

### Set Window Size Constraints

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Define the maximum and minimum allowed dimensions for the window.

```javascript
nw.Window.get().setMaximumSize(width, height)//设置窗口的最大宽高
nw.Window.get().setMinimumSize(width, height)//设置窗口的最小宽高
```

--------------------------------

### Unity WebGL JavaScript 插件定义

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

在 .jslib 文件中定义供 Unity C# 调用的 JavaScript 函数，需放置于 Assets/Plugins/WebGL 目录下。

```javascript
mergeInto(LibraryManager.library, {
 
  Hello: function () {
    window.alert("Hello, world!");
  },
 
  HelloString: function (str) {
    window.alert(Pointer_stringify(str));
  },
 
  PrintFloatArray: function (array, size) {
    for(var i = 0; i < size; i++)
    console.log(HEAPF32[(array >> 2) + i]);
  },
 
  AddNumbers: function (x, y) {
    return x + y;
  },
 
  StringReturnValueFunction: function () {
    var returnStr = "bla";
    var bufferSize = lengthBytesUTF8(returnStr) + 1;
    var buffer = _malloc(bufferSize);
    stringToUTF8(returnStr, buffer, bufferSize);
    return buffer;
  },
 
  BindWebGLTexture: function (texture) {
    GLctx.bindTexture(GLctx.TEXTURE_2D, GL.textures[texture]);
  },
 
});
```

--------------------------------

### 监听窗口最小化事件

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

用于捕获窗口最小化操作并移除相关监听器。

```javascript
// 监听最小化事件
nw.Window.get().on('minimize', function() {
 	console.log('最小化了！');
});
// 移除最小化监听事件
nw.Window.get().removeAllListeners('minimize');
```

--------------------------------

### Utils Environment Detection

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

Methods to detect the current runtime environment or platform.

```APIDOC
Utils.isNwjs(); // Check if running in NW.js
Utils.isMobileDevice(); // Check if running on a mobile device
Utils.isMobileSafari(); // Check if running on mobile Safari
Utils.isAndroidChrome(); // Check if running on Android Chrome
```

--------------------------------

### 即时战斗系统初始化

Source: https://hat-soft.top/component_notes/RPGMakerMV/html/RPGMV%E9%80%9F%E6%9F%A5.html

初始化战斗系统环境，包括窗口最大化、回调队列及 UI 绑定。

```javascript
var RealtimeBattleSystem = RealtimeBattleSystem || {}

// 初始化
RealtimeBattleSystem.init = function () {

    nw.Window.get().maximize()//最大化

    this.attack = true;

    this._callbackQueue = [];//回调函数队列，用于事件触发
    RealtimeBattleSystem.enemyInit()//更新敌人

    RealtimeBattleSystem.bindUpdate()

    RealtimeBattleSystem.UIInit()
}
```
Tokens:
Raw