Template:VisuMZ Common Event Menu Notetags
Jump to navigation
Jump to search
Contents
Comment Tags
The following are comment tags that have been added through this plugin. These comment tags will not work with your game if this plugin is OFF or not present. To make a comment tag, create a comment inside of the Common Event and type in any of the comment tags seen below for their effects.
---
Basic-Related Comment Tags
---
<Name: text> - Used for: Common Event Comment Tag - Replaces the text that appears in the Common Event Menu List with this instead of the Common Event's name found in the database. - Replace 'text' with the name you want to be displayed in the List Window. - If this comment tag is not used, default to the Common Event's name.
---
<Icon: x> - Used for: Common Event Comment Tag - Sets the icon shown next to this Common Event. - Replace 'x' with a number representing the icon index used for this Common Event. - If this comment tag is not used, default to the Plugin Parameters.
---
<Indent: x> - Used for: Common Event Comment Tag - Indents the name when it appears in the Common Event List. - Replace 'x' with the number of times to indent the name. - Each indent is equal to an icon width.
---
<Picture: filename> - Used for: Common Event Comment Tag - Description - Replace 'filename' with a picture found within your game project's img/pictures/ folder. - Filenames are case sensitive. - Leave out the filename extension from the notetag.
---
Description-Related Comment Tags
---
<Help Description> text text </Help Description> - Used for: Common Event Comment Tag - When this Common Event is selected, display this text in the Help Window. - Replace 'text' with the text you want to display in the Help Window when this Common Event is selected. - You can chain together Comment event commands in the RPG Maker Editor to combine their contents in case you want to add more than 4 lines of text.
---
<Subtext Description> text text </Subtext Description> - Used for: Common Event Comment Tag - When this Common Event is selected, display this text in the Sub Window. - Replace 'text' with the text you want to display in the Sub Window when this Common Event is selected. - You can chain together Comment event commands in the RPG Maker Editor to combine their contents in case you want to add more than 4 lines of text.
---
<Extra Description x> text text </Extra Description x> - Used for: Common Event Comment Tag - When this Common Event is selected, display this text in the Extra Window. - Replace 'x' with a number from 1 to 10 to determine which Extra Window to display the text in. - Replace 'text' with the text you want to display in the Extra Window when this Common Event is selected. - You can chain together Comment event commands in the RPG Maker Editor to combine their contents in case you want to add more than 4 lines of text.
---
Visibility-Related Comment Tags
---
<Show Switch: x> <Show All Switches: x,x,x> <Show Any Switches: x,x,x> - Used for: Common Event Comment Tag - Determines the visible status of the Common Event based on switches. - Replace 'x' with the switch ID to determine the Common Event's visibility. - If 'All' notetag variant is used, the Common Event will be hidden until all switches are ON. Then, it would be shown. - If 'Any' notetag variant is used, the Common Event will be shown if any of the switches are ON. Otherwise, it would be hidden.
---
<Hide Switch: x> <Hide All Switches: x,x,x> <Hide Any Switches: x,x,x> - Used for: Common Event Comment Tag - Determines the visible status of the Common Event based on switches. - Replace 'x' with the switch ID to determine the Common Event's visibility. - If 'All' notetag variant is used, the Common Event will be shown until all switches are ON. Then, it would be hidden. - If 'Any' notetag variant is used, the Common Event will be hidden if any of the switches are ON. Otherwise, it would be shown.
---
JavaScript Comment Tag: Visibility
The following are notetags made for users with JavaScript knowledge to determine if a Common Event is visible in the menu by code.
---
<JS Visible> code code visible = code; </JS Visible> - Used for: Common Event Comment Tag - Determines the visible status of the Common Event based on JavaScript code. - Replace 'code' to determine the type visible status of the Common Event. - You can chain together Comment event commands in the RPG Maker Editor to combine their contents in case you want to add more than 4 lines of code. - The 'visible' variable returns a boolean (true/false) to determine if the Common Event will be visible or not. - All other Common Event conditions must be met in order for this to code to count.
---
Enable-Related Comment Tags
---
<Enable Switch: x> <Enable All Switches: x,x,x> <Enable Any Switches: x,x,x> - Used for: Common Event Comment Tag - Determines the enabled status of the Common Event based on switches. - Replace 'x' with the switch ID to determine if the Common Event's enabled. - If 'All' notetag variant is used, the Common Event will be disabled until all switches are ON. Then, it would be enabled. - If 'Any' notetag variant is used, the Common Event will be enabled if any of the switches are ON. Otherwise, it would be disabled.
---
<Disable Switch: x> <Disable All Switches: x,x,x> <Disable Any Switches: x,x,x> - Used for: Common Event Comment Tag - Determines the enabled status of the Common Event based on switches. - Replace 'x' with the switch ID to determine if the Common Event's enabled. - If 'All' notetag variant is used, the Common Event will be enabled until all switches are ON. Then, it would be disabled. - If 'Any' notetag variant is used, the Common Event will be disabled if any of the switches are ON. Otherwise, it would be enabled.
---
JavaScript Comment Tag: Enable
The following are notetags made for users with JavaScript knowledge to determine if a Common Event can be selectable by code.
---
<JS Enable> code code enabled = code; </JS Enable> - Used for: Common Event Comment Tag - Determines the enabled status of the Common Event based on JavaScript code. - Replace 'code' to determine the type enabled status of the Common Event. - You can chain together Comment event commands in the RPG Maker Editor to combine their contents in case you want to add more than 4 lines of code. - The 'enabled' variable returns a boolean (true/false) to determine if the Common Event will be enabled or not. - All other Common Event conditions must be met in order for this to code to count.
---
