さまざまな拡張機能が含まれるプラグイン – AES_Core.js

タイトル
Contains several enhancements for various aspects of RMMV.
作者名
ヘルプ
For terms of use, see: https://github.com/Aesica/RMMV/blob/master/README.md
Support me on Patreon: https://www.patreon.com/aesica

IMPORTANT - NOTE TAGS: The note tags used by this plugin are flexible,
allowing for two different interchangeable formats:
Format 1: <Note Tag: x>
Format 2: <Note Tag>x</Note Tag>
When using eval in note tags (specifically the > sign) the second format is
necessary if you want to avoid closing the tag prematurely.

<Note>value > 5</Note> Eval: "value > 5" (good)
<Note: value > 5> Eval: "value " (bad)

Since this plugin offers so many things, the design is presented in a modular
format. Disabling each section in the plugin parameters will prevent any of
the associated components from even loading, so if you disable something
like Combat Formulas, none of the functions provided by that section will
be available. This is mainly done so that any conflicts with other plugins
can be resolved by switching that component off here.

The following components are always on and should not have conflicts with
other plugins:
- Note tag parsing functions
- Plugin command exec function
- Self switch manipulation
- Forced vehicle exit
- Instant Text

The components for Instant Text is always on, however it can be switched
off and ignored if their effects aren't wanted/needed.

List of crap this plugin can do:

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

Configuration Manager Tweaks
By default, when your game is opened for the first time, the volumes as well
as "always dash" and "command remember" are set to specific values and you
can't control these initial settings. Now you can. You can also use this
to customize what shows and what doesn't, as well as setting the volume
increment to something other than 20, however a multiple of 5 is recommended
with 10 being ideal.

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

Instant Text Rendering
Allows you to remove the typewriter text effect and render text instantly.
Can also be switched on or off temporarily via Plugin Commands, making it
a useful alternative to the per-line message parameter for certain event
sequences.

Plugin Commands:

InstantText 0
- Turns off instant text rendering

InstantText 1
- Turns on instant text rendering

Note that this setting spans ALL saved games since it's handled by the
config manager.

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

Uniform Obtain Item Framework
Allows you to easily give an item to players and inform them about what
they got in a consistent way. This bypasses the need to pop up a message
window, play a sound, etc in the exact same way every time they open a chest,
are given something by an npc, etc.

Plugin Commands:

ObtainItem id quantity
- Gives the player one or more of the specified item and displays a message

ObtainWeapon id quantity
- Gives the player one or more of the specified weapon and displays a message

ObtainArmor id quantity
- Gives the player one or more of the specified armor and displays a message

ObtainGold quantity
- Gives the player the specified amount of gold and displays a message
----------------------------------------------------------------------

ForceExitVehicle moveForward (0 or 1)
This plugin command will force the player out of a vehicle, regardless of
location or terrain rules.
- ForceExitVehicle 0: Player will be ejected from the vehicle without moving.
- ForceExitVehicle 1: Player will exit the vehicle and take a step forward
unless they're on the airship.

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

Plugin Command execution function
An easy (easier, anyway) way to execute plugin commands via script calls
using the exact same syntax used in events. Examples:

Event version:
Plugin Command : Butts 1 2

Script version:
Aesica.Core.pluginCommand("Butts 1 2");

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

Mass-Forget Skills
This is a way to remove every skill on an actor with a single plugin command
Note that certain skills can be locked (and thus, not removed) using the
<Permanent Skill> note tag. Here are the various ways this plugin command
can be used:

ForgetSkills variable actorIdVariable removedSkillCountVariable
This version removes all the skills from the actor id contained in the
specified variable

ForgetSkills actor actorId removedSkillCountVariable
This version removes all the skills from the specified actor id

ForgetSkills party removedSkillCountVariable
This version removes all skills from the entire party (!)

Unless omitted, the number of skills removed will be stored in
removedSkillCountVariable. Examples of use:

ForgetSkills party 5
All skills are removed and the number removed is stored in variable 5

ForgetSkills actor 1
Remove all skills from actor 1, but don't bother storing the results in
a variable

ForgetSkills variable 4 5
Remove all skills from the actor id stored in variable 4, then save the
number of skills removed in variable 5

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

Self-Switch Manipulation
This is a collection of functions for reading or manipulating many self
switches at once. With the exception of selfSwitchesOff, they only work for
events on the current map.

Aesica.Core.selfSwitchesOff(mapID, eventID, switchID)
- mapID: map id number
- eventID: event id number
- switchID: Switch ID (A, B, C, D, or beyond)
Setting any of these values to 0 will function as a wildcard, so:
Aesica.Core.selfSwitchesOff(0, 0, "D") Sets all D self switches to false
Aesica.Core.selfSwitchesOff(5, 3) Sets all self switches on the event
found on map id 5 with event id 3 to false
Aesica.Core.selfSwitchesOff(5, 0, "D") Sets all D switches on map 5
to false
Aesica.Core.selfSwitchesOff(5) Sets all self switch on map 5 to false
Aesica.Core.selfSwitchesOff() Sets ALL self switches to false

Aesica.Core.setSelfSwitchesByTag(switchID, noteTag, newValue)
Allows you to enable/disable a self switch (switchID) for every event on the
current map with the specified note tag (noteTag)

Aesica.Core.getSelfSwitchCountByTag(switchID, noteTag, value)
Returns a count of every self switch (switchID) on the current map with the
specified note tag (noteTag) that is either on or off (value)

Aesica.Core.getEventCountByTag(noteTag)
Returns a count of every event on the current map with the specified noteTag
パラメータ
param Config Manager
desc Enable the Config Manager initial settings tweaks provided by this plugin?
type boolean
on Enable
off Disable
default true

param Always Dash
parent Config Manager
desc Enable 'Always Dash' by default the first time the game is run?
type boolean
default false
on On
off Off

param Show Always Dash
parent Config Manager
desc Show "Always Dash" setting in the options menu?
type boolean
default true
on Show
off Hide

param Remember Commands
parent Config Manager
desc Enable 'Remember Commands' by default the first time the game is run?
type boolean
default false
on On
off Off

param Show Command Remember
parent Config Manager
desc Show "Remember Commands" setting in the options menu?
type boolean
default true
on Show
off Hide

param Screen Mode Label
parent Config Manager
desc Label for screen mode setting. Leave blank to disable.
type text
default Screen Mode

param Screen Mode Options
parent Config Manager
desc Options for screen mode setting.
type text[]
default ["Windowed","Fullscreen","Fullscreen (Fit)"]

param Default Screen Mode
parent Config Manager
desc Set screen mode default for the first time the game is run
type select
option Windowed (Default)
option Fullscreen
option Fullscreen (Fit)
default Windowed (Default)

param Master Volume Label
parent Config Manager
desc Label for Master Volume setting. Leave blank to disable.
type text
default Master Volume

param Default Master Volume
parent Config Manager
desc Default master volume when the game is run for the first time.
type number
default 100
min 0
max 100

param Default BGM Volume
parent Config Manager
desc Default BGM volume when the game is run for the first time.
type number
default 100
min 0
max 100

param Default BGS Volume
parent Config Manager
desc Default BGS volume when the game is run for the first time.
type number
default 100
min 0
max 100

param Default ME Volume
parent Config Manager
desc Default ME volume when the game is run for the first time.
type number
default 100
min 0
max 100

param Default SE Volume
parent Config Manager
desc Default SE volume when the game is run for the first time.
type number
default 100
min 0
max 100

param Individual Volume Controls
parent Config Manager
desc Show the individual controls for BGM, BGS, ME, and SE?
type boolean
default true
on Show
off Hide

param Volume Adjustment Offset
parent Config Manager
desc Number to increment/decrement by when adjusting volume. A multiple of 5 is recommended
type number
default 20
min 0
max 100

param Instant Text
parent Config Manager
desc Default setting for instant text rendering. This can be changed ingame via plugin commands.
type boolean
on Instant
off Standard
default true

param Show Instant Text
parent Config Manager
desc Show the Instant Text option in the config manager?
type boolean
on Show
off Hide
default true

param Universal Obtain Item
desc Enable the universal "Obtain Item" functionality provided by this plugin?
type boolean
on Enable
off Disable
default true

param Currency Icon
parent Universal Obtain Item
desc Icon displayed with "ObtainGold" command. 0 = no icon or YEP_CoreEngine default (if installed)
type number
min 0
default 314

param Item Obtain Message
parent Universal Obtain Item
desc i% = item icon, n% = item name, %q = item quantity
default Obtained %i%n x%q

param Item Obtain Sound
parent Universal Obtain Item
desc Sound effect to play when obtaining an item
default Sword1

param Item Obtain Volume
parent Universal Obtain Item
desc Volume for item obtain sound effect
type number
min 0
max 100
default 70

param Bush Depth/Opacity Settings
desc Enable the custom settings for bushes provided by this plugin?
type boolean
on Enable
off Disable
default true

param Bush Opacity
parent Bush Depth/Opacity Settings
desc Opacity for the character's lower half when walking through bushes (0-255). Default: 128
type number
min = 0
max = 255
default 128

param Bush Depth
parent Bush Depth/Opacity Settings
desc Height in pixels obscured by bushes. Default: 12
type number
min = 0
default 12

ライセンス表記
Unless omitted, the number of skills removed will be stored in

紹介ページ https://github.com/Aesica/RMMV/blob/master/AES_Core.js