-
Notifications
You must be signed in to change notification settings - Fork 1
/
MKP_InputKeyExtend.js
519 lines (481 loc) · 13.8 KB
/
MKP_InputKeyExtend.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
/*!
* MKP_InputKeyExtend - v0.1.0
* Updated : 2024-03-27T00:56:00+0800
*
* MIT License
*
* Copyright (C) 2019-2024 Mikan(MikanHako)
* https://github.com/MikanHako1024
*
* Released under the MIT License.
* http://opensource.org/licenses/mit-license.php
*/
/*:
* ================================================================
* [Twitter] https://twitter.com/_MikanHako/
* -[GitHub] https://github.com/MikanHako1024/
* ---[Blog] Coming soon
* -----[QQ] 312859582
* ================================================================
*
* @plugindesc Input按键拓展 <MKP_InputKeyExtend> v0.1.0
* @author Mikan(MikanHako)
* @url https://github.com/MikanHako1024/RPGMaker-plugins-public
* @version
* v0.1.0 (2024-03-27T00:56:00+0800)
* 完成基本功能
* v0.0.0 (2024-03-26T23:31:00+0800) Init File
* 项目计划中
*
* @sourcecode 发布版插件可能压缩了代码,如有需要源代码,可以联系插件作者
*
*
*
*
* @target MV MZ
*
*
* @help
*
* Input按键拓展 <MKP_InputKeyExtend> v0.1.0
* Updated : 2024-03-27T00:56:00+0800
*
*
* ## 简要说明
*
* 本插件拓展了 Input类
* 通过Input检测按键时,可以区分具体的按键
* (仅脚本)
*
* `Input.isTriggered('escape:88')`
* + 检测是否刚按下按键 X键
* + 其他按键如 Esc键 则无效
* - 原版逻辑中 X键 和 Esc键 都可以取消或打开菜单
*
* `Input.isTriggered('escape:27')`
* + 检测是否刚按下按键 Esc键
* + 其他按键如 X键 则无效
* - 原版逻辑中 X键 和 Esc键 都可以取消或打开菜单
*
* [兼容原版的检测方法]
* `Input.isTriggered('escape')`
* + 检测是否刚按下按键 X键 或 Esc键 等取消键
* + 和原版一样
*
*
* ## 其他说明
*
* #### 一些按键key
*
* | key | desc |
* | :---------- | :---------- |
* | ok:13 | enter |
* | ok:32 | space |
* | ok:90 | Z |
* | ----------- | ----------- |
* | control:17 | control |
* | control:18 | alt |
* | ----------- | ----------- |
* | escape:27 | escape |
* | escape:45 | insert |
* | escape:88 | X |
* | escape:96 | numpad 0 |
* | ----------- | ----------- |
* | pageup:33 | pageup |
* | pageup:81 | Q |
* | ----------- | ----------- |
* | pagedown:34 | pagedown |
* | pagedown:87 | W |
* | ----------- | ----------- |
* | left:37 | left arrow |
* | left:100 | numpad 4 |
* | ----------- | ----------- |
* | up:38 | up arrow |
* | up:104 | numpad 8 |
* | ----------- | ----------- |
* | right:39 | right arrow |
* | right:102 | numpad 6 |
* | ----------- | ----------- |
* | down:40 | down arrow |
* | down:98 | numpad 2 |
*
*
* ## 版本支持
*
* 开发环境 : RPG Maker MV v1.6.2 + RPG Maker MZ v1.8.0
* + MV : 支持
* + MZ : 支持
*
*
* ## 脚本说明
*
* 修改了部分 `Input.keyMapper` 内容
* 详见代码
*
*
* ## 联系方式
* [Twitter] https://twitter.com/_MikanHako/
* -[GitHub] https://github.com/MikanHako1024/
* ---[Blog] Coming soon
* -----[QQ] 312859582
*
* 我的公开插件仓库:
* https://github.com/MikanHako1024/RPGMaker-plugins-public
*
* 如需在鸣谢名单中显示插件作者名,可以显示此ID :
* Mikan(MikanHako)
*
*
* ## 使用规约
* MIT License
* Copyright (C) 2019-2024 Mikan(MikanHako)
* http://opensource.org/licenses/mit-license.php
*
* 本插件使用 MIT协议
* 这意味着:
* 1. 任何人可以使用、修改、复制、分发本插件。
* 2. 使用形式不受限制,可以用于交流学习或者用于商用。
* 3. 插件原作者不对使用本插件的创作作品做担保和负责。
* 4. 在插件和插件的所有副本中都必须包含以上版权声明和本许可声明。
*
* --------------------------------
* ENDLINE
*
*
*
*
* @param ---- startline ----
*
* @param ---- endline ----
*
*/
"use strict";
var MK_PluginData = MK_PluginData || {};
;(function() {
// core
const pluginData = {
MikanPluginDataCoreUpdatedTime : '2024-01-01T013:00:00+0800',
pluginName : 'MKP_InputKeyExtend',
pluginVersion : 'v0.1.0',
pluginUpdatedTime : '2024-03-27T00:56:00+0800',
support : {
supportForMV : true,
notSupportForMV : false,
engineNameMV : 'MV',
engineVersionMV : '1.6.2',
supportForMZ : true,
notSupportForMZ : false,
engineNameMZ : 'MZ',
engineVersionMZ : '1.8.0',
},
paramParser : {
numberParser : function(str, defVal) {
if (str === '') return defVal;
if (typeof(str) !== 'string' && typeof(str) !== 'number') return defVal;
var val = Number(str);
return !Number.isNaN(val) ? val : defVal;
},
stringParser : function(str, defVal) {
if (typeof(str) !== 'string' && typeof(str) !== 'number') return defVal;
return String(str);
},
booleanParser : function(str, defVal) {
if (str === 'true') return true;
else if (str === 'false') return false;
else return !!defVal;
},
structParser : function(str) {
var data = null;
try {
data = JSON.parse(str || '{}');
}
catch (e) {
console.warn(`Failed to parse json "${str}".`);
data = null;
}
return data;
},
listParser : function(parser, str, defVals, ...args) {
var data = null;
try {
data = JSON.parse(str || '[]');
}
catch (e) {
console.warn(`Failed to parse json "${str}".`);
data = null;
}
if (Array.isArray(data)) {
data = Array.isArray(defVals)
? data.map((each, i) => parser(each, defVals[i], ...args))
: data.map(each => parser(each, defVals, ...args));
}
else {
console.warn(`Json data "${str}" is not a array data.`);
data = null;
}
return data;
},
},
paramSource : null,
param : {},
class : {},
datas : {},
getRealPluginName : function(pluginName) {
var param = PluginManager._parameters[(pluginName || '').toLowerCase()];
if (!param) {
var list = $plugins.filter(function (i) {
return i.description.contains('<' + pluginName + '>');
});
for (var i = 0, l = list.length; i < l; ++i) {
var realPluginName = list[i].name;
if (realPluginName !== pluginName)
return realPluginName;
}
return '';
}
else {
return pluginName;
}
},
fetchMyRealPluginName : function() {
if (!this.realPluginName) {
var realPluginName = this.getRealPluginName(this.pluginName);
if (!realPluginName) {
console.warn(`Don't found real plugin name by plugin name "${this.pluginName}".`);
realPluginName = this.pluginName;
}
this.realPluginName = realPluginName;
}
return this.realPluginName;
},
getPluginParam : function(realPluginName) {
var param = PluginManager.parameters(realPluginName);
return param;
},
fetchMyPluginParam : function() {
this.paramSource = this.getPluginParam(this.fetchMyRealPluginName());
return this.paramSource;
},
checkRpgmakerEngine : function(name, version) {
return !!Utils
&& ((name || Utils.RPGMAKER_NAME) === Utils.RPGMAKER_NAME)
&& ((version || Utils.RPGMAKER_VERSION) === Utils.RPGMAKER_VERSION);
},
calRpgmakerEngine : function() {
const EngineSupport = this.support;
const PLUGIN_NAME = this.pluginName;
const keyNone = '';
const keyMV = 'MV';
const keyMZ = 'MZ';
if (!Utils) {
console.error(`Load plugin "${PLUGIN_NAME}" failed, not found "Utils".`);
return keyNone;
}
else if (this.checkRpgmakerEngine(keyMV, undefined)) {
if (EngineSupport.notSupportForMV) {
console.error(`Plugin "${PLUGIN_NAME}" don't support for "RPG Maker ${Utils.RPGMAKER_NAME}".`);
return keyNone;
}
else if (!EngineSupport.supportForMV) {
console.warn(`Maybe plugin "${PLUGIN_NAME}" don't support for "RPG Maker ${Utils.RPGMAKER_NAME}".`);
return keyMV;
}
else {
return keyMV;
}
}
else if (this.checkRpgmakerEngine(keyMZ, undefined)) {
if (EngineSupport.notSupportForMZ) {
console.error(`Plugin "${PLUGIN_NAME}" don't support for "RPG Maker ${Utils.RPGMAKER_NAME}".`);
return keyNone;
}
else if (!EngineSupport.supportForMZ) {
console.warn(`Maybe plugin "${PLUGIN_NAME}" don't support for "RPG Maker ${Utils.RPGMAKER_NAME}".`);
return keyMZ;
}
else {
return keyMZ;
}
}
else {
console.error(`Plugin "${PLUGIN_NAME}" don't support for unknown engine "RPG Maker ${Utils.RPGMAKER_NAME}".`);
return keyNone;
}
},
currentRpgmakerEngine : undefined,
getRpgmakerEngine : function() {
if (this.currentRpgmakerEngine === undefined) {
try {
this.currentRpgmakerEngine = this.calRpgmakerEngine();
}
catch (e) {
console.warn(`Calculate rpgmaker engine failed.\n${e}`);
this.currentRpgmakerEngine = '';
}
}
return this.currentRpgmakerEngine;
},
};
MK_PluginData[pluginData.pluginName] = pluginData;
})();
;(function() {
// logic
const PLUGIN_NAME = 'MKP_InputKeyExtend';
const CURRENT_ENGINE = (function() {
const pluginData = MK_PluginData[PLUGIN_NAME];
return pluginData.getRpgmakerEngine();
})();
/**
* Input 区分具体按键
*
* keyNameA: Input内部按键状态key
* keyNameB: 检测按键key
*
* 玩家按了Z键 Input内部标记按键状态 ok:90
* 此时通过 Input.isPressed 检测按键 ok
* 将会调用 _keyNameAIsBCompatible 检查按键名是否兼容 A = ok:90 , B = ok
* 'ok:90'(A) 开头包含 'ok:'(B:) 所以结果是按键名兼容 返回 true
*
* 玩家按了space键(空格键) Input内部标记按键状态 ok:32
* 此时通过 Input.isPressed 检测按键 ok:32
* 将会调用 _keyNameAIsBCompatible 检查按键名是否兼容 A = ok:32 , B = ok:32
* 'ok:32'(A) 完全等于 'ok:32'(B) 所以结果是按键名兼容 返回 true
*
* 玩家按了enter键(回车键) Input内部标记按键状态 ok:13
* 此时通过 Input.isPressed 检测按键 ok:90
* 将会调用 _keyNameAIsBCompatible 检查按键名是否兼容 A = ok:13 , B = ok:90
* 'ok:13'(A) 不完全等于 'ok:90'(B) 同时 开头不包含 'ok:90:'(B:)
* 所以结果是按键名不兼容 返回 false
*
* @method _keyNameAIsBCompatible
* @for Input
* @static
* @param {string} Input内部按键状态key
* @param {string} 检测按键key
* @return {boolean} 按键名是否兼容
*/
Input._keyNameAIsBCompatible = function(keyNameA, keyNameB) {
return keyNameA === keyNameB
|| (typeof keyNameA === 'string' && keyNameA.startsWith(keyNameB + ':'));
};
Input.isPressed = function(keyName) {
// copy from : rpg_core.js - Input.isPressed
if (this._isEscapeCompatible(keyName) && this.isPressed('escape')) {
return true;
} else if (this._currentState[keyName]) {
return true;
} else {
for (const name in this._currentState) {
if (this._currentState[name]) {
if (this._keyNameAIsBCompatible(name, keyName)) {
return true;
}
}
}
return false;
}
};
Input.isTriggered = function(keyName) {
// copy from : rpg_core.js - Input.isTriggered
if (this._isEscapeCompatible(keyName) && this.isTriggered('escape')) {
return true;
} else {
return this._keyNameAIsBCompatible(this._latestButton, keyName)
&& this._pressedTime === 0;
}
};
Input.isRepeated = function(keyName) {
// copy from : rpg_core.js - Input.isRepeated
if (this._isEscapeCompatible(keyName) && this.isRepeated('escape')) {
return true;
} else {
return (this._keyNameAIsBCompatible(this._latestButton, keyName)
&& (this._pressedTime === 0
|| (this._pressedTime >= this.keyRepeatWait &&
this._pressedTime % this.keyRepeatInterval === 0)
));
}
};
Input.isLongPressed = function(keyName) {
// copy from : rpg_core.js - Input.isLongPressed
if (this._isEscapeCompatible(keyName) && this.isLongPressed('escape')) {
return true;
} else {
return this._keyNameAIsBCompatible(this._latestButton, keyName)
&& this._pressedTime >= this.keyRepeatWait;
}
};
(function() {
const keyMapper = Input.keyMapper;
keyMapper[13] = 'ok:13'; // enter
keyMapper[17] = 'control:17'; // control
keyMapper[18] = 'control:18'; // alt
keyMapper[27] = 'escape:27'; // escape
keyMapper[32] = 'ok:32'; // space
keyMapper[33] = 'pageup:33'; // pageup
keyMapper[34] = 'pagedown:34'; // pagedown
keyMapper[37] = 'left:37'; // left arrow
keyMapper[38] = 'up:38'; // up arrow
keyMapper[39] = 'right:39'; // right arrow
keyMapper[40] = 'down:40'; // down arrow
keyMapper[45] = 'escape:45'; // insert
keyMapper[81] = 'pageup:81'; // Q
keyMapper[87] = 'pagedown:87'; // W
keyMapper[88] = 'escape:88'; // X
keyMapper[90] = 'ok:90'; // Z
keyMapper[96] = 'escape:96'; // numpad 0
keyMapper[98] = 'down:98'; // numpad 2
keyMapper[100] = 'left:100'; // numpad 4
keyMapper[102] = 'right:102'; // numpad 6
keyMapper[104] = 'up:104'; // numpad 8
})();
(function() {
return;
// for debug
const _MK_Scene_Map_updateMain = Scene_Map.prototype.updateMain;
Scene_Map.prototype.updateMain = function() {
//_MK_Scene_Map_updateMain.apply(this, arguments);
const list = [
'ok',
'control',
'escape',
'pageup',
'pagedown',
'left',
'up',
'right',
'down',
'ok:13',
'control:17',
'control:18',
'escape:27',
'ok:32',
'pageup:33',
'pagedown:34',
'left:37',
'up:38',
'right:39',
'down:40',
'escape:45',
'pageup:81',
'pagedown:87',
'escape:88',
'ok:90',
'escape:96',
'down:98',
'left:100',
'right:102',
'up:104',
];
const triggered = [];
for (const key of list) {
if (Input.isTriggered(key)) {
triggered.push(key);
}
}
if (triggered.length > 0) {
console.log(triggered.join(' '));
}
};
})();
})();