Quickchat (Slash Command): Difference between revisions
imported>SpaceNut (New page: ==SlashCommand== {{SlashCommandArticle|command=quickchat|note=Pops up the quickchat menu.}}) |
BlackSpectre (talk | contribs) No edit summary |
||
(28 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{TOCright}} | |||
==SlashCommand== | ==SlashCommand== | ||
{{SlashCommandArticle|command=quickchat|note=Pops up the quickchat menu.}} | {{SlashCommandArticle|command=quickchat|note=Pops up the quickchat menu.}} | ||
* By default this command is bound to the APOSTROPHE (') key. | |||
* Click here for a copy of the default [[Default Quickchat Menu|quickchat menu]]. | |||
== Customizing the QuickChat Menu == | |||
Custom Quickchat Menus can be created by placing a properly formatted text file named '''quickchat.mnu''' in the following directory and then restarting COH after completely exiting to the desktop: | |||
''<COH_INSTALL_DIRECTORY>''\data\texts\''<LANGUAGE>''\Menus\ | |||
'''<tt>''<LANGUAGE>''</tt>''' may be one of the following and needs to match the language of the version of City of Heroes that is installed: | |||
* ''ChineseTraditional'' | |||
* ''English'' | |||
* ''French'' | |||
* ''German'' | |||
* ''Japanese'' | |||
* ''Korean'' | |||
* ''uk'' | |||
=== Syntax === | |||
MNU files can be created and edited in any text editor. QuickChat Menus have the following general structure: | |||
// Opening comment line for the QuickChat Menu | |||
Menu QuickChat | |||
{ | |||
{{color|gray|Title ''TitleName''}} | |||
Option ''OptionName'' ''Command'' | |||
{{color|gray|Divider}} | |||
{{color|gray|Title ''TitleName''}} | |||
Option ''OptionName'' ''Command'' | |||
Menu ''SubMenuName'' | |||
{ | |||
{{color|gray|Title ''SubMenuTitleName''}} | |||
Option ''OptionName'' ''Command'' | |||
{{color|gray|Divider}} | |||
Option ''OptionName'' ''Command'' | |||
} | |||
} | |||
* '''<tt>Menu</tt>''' defines a group of '''<tt>Option</tt>'''s. Menus can be nested, but each sub-menu requires its own pair of curly braces. | |||
** To create a submenu name of more than one word with spaces between them, enclose it in quotes. | |||
* '''<tt>Option</tt>''' is a selectable command within a menu. | |||
** One letter in '''''<tt>OptionName</tt>''''' can be designated as a hotkey by prefixing an ampersand (&). | |||
** To create an option name of more than one word with spaces between them, enclose it in quotes. | |||
** '''''<tt>Command</tt>''''' is one or more [[slash commands]] (separated by '''<tt>$$</tt>'''). | |||
* '''<tt>Title</tt>''' is an optional element. | |||
** '''''<tt>TitleName</tt>''''' labels a menu, or a section of a menu. Titles are not selectable. | |||
** Menus can have more than one Title. | |||
* '''<tt>Divider</tt>''' places a horizontal line in the menu. | |||
===LockedOption syntax:=== | |||
LockedOption is alternative to the Option syntax above and checks to see if an item is currently available given certain conditions. If the condition is not met, the option will be grayed out and unavailable. | |||
LockedOption | |||
{ | |||
DisplayName OptionName | |||
Command OptionCommand | |||
Authbit AuthIdentifiers | |||
Badge BadgeIdentifiers | |||
Icon IconName | |||
PowerReady InternalPowerName | |||
RewardToken RewardIdentifiers | |||
StoreProduct ProductIdentifiers | |||
} | |||
The conditions under which the item is available is specified with either Authbit, Badge, Icon, PowerReady, RewardToken, or StoreProduct. You only need one, but you can use multiple. | |||
* '''Authbit''' checks some state of your account (mostly historical and doesn't apply to Homecoming): | |||
** RogueAccess: Purchased Going Rogue | |||
** RogueCompleteBox: Purchased Going Rogue Complete Collection | |||
** CyborgPack: Purchased Super Booster I: Cyborg | |||
** MagicPack: Purchased Super Booster II: Magic | |||
** SuperSciencePack: Purchased Super Booster III: Superscience | |||
** MutantPack: Purchased Super Booster IV: Mutant | |||
** MartialArtsPack: Purchased Super Booster V: Martial Arts | |||
** WeddingPack: Puchased the Wedding Pack | |||
** [[Popmenu (Slash Command)/List of Authbit Identifiers|List of Authbit Identifiers]] | |||
* '''Badge''' checks whether you've earned a certain badge. For example: | |||
**CouncilRobotBadge: Burkholder's Bane | |||
**StMartialTour1: Johnny's Go To Guy | |||
**SnowflakeEmoteBadge: Invisible badge gained from the Candy Keeper during the Winter Event | |||
**MayhemOutlaw: Outlaw | |||
**ArchitectAccolade: Mission Engineer | |||
** [[Settitle (Slash Command)/listing|List of badge names]] (in '''BadgeGrant tag''' column) | |||
** [http://sites.google.com/site/blanketyblankman/r0/lockedoption-badge-names-hidden.txt List of hidden badge names] (9/9/2010) | |||
* '''Icon''' checks whether the icon is available to click. [[Macro image (Slash Command)|List of icon names]] | |||
* '''PowerReady''' checks whether the power is available to use. | |||
** '''''<tt>InternalPowerName</tt>''''' is the name of the power the game uses internally, which can be found at the [https://cod.uberguy.net/html/index.html City of Data 2 site] '''{{red|IMPORTANT:}}''' The power name in the URL is correct, not the one on the page. E.g "temporary_powers.temporary_powers.envenomed_dagger" '''won't''' work, but "temporary_powers.temporary_powers.''invention_''envenomed_dagger" '''will''' work. | |||
* '''RewardToken''' checks that you've earned a specific reward. [[Popmenu (Slash Command)/List of RewardToken Identifiers|List of RewardToken Identifiers]] | |||
* '''StoreProduct''' checks against a purchase in the store (also mostly historical). [[Popmenu (Slash Command)/List of StoreProduct Identifiers|List of StoreProduct Identifiers]] | |||
=== Notes === | |||
* MNU files allow comments. Use a double forward slash (<tt>//</tt>) anywhere on a line to force the client to ignore anything between the double slash and the line return. | |||
* '''{{red|IMPORTANT:}}''' MNU files must have at least one line containing a carriage-return at the end of the line above the first "Menu" entry. It can be blank, a full comment, or just the comment tag (//) or any number of those lines otherwise it will not function. | |||
* Changes to custom menus require you to exit the client in order for the changes to take effect. | |||
* Custom menus are accessible by all characters on the same machine. By extension, you can send custom menu files to other people so that they can use them as well. | |||
* '''<tt>Option</tt>''' and its parameters must be on one line. Otherwise, the menu will not function. | |||
** If the command string contains spaces, the entire command portion must be enclosed in either quotation marks (" "), or less-than/greater-than brackets and ampersands (<& &>). This last option is especially useful if multiple quotation marks are generating errors in the command. For example: <code>Option "Celebrate" <span style="color:blue"><&</span>emote dance$$local "Let's Party!"<span style="color:blue">&></span></code> will work, but <code>Option "Celebrate" "emote dance$$local "Let's Party!""</code> will not. | |||
** Inspiration and power names with spaces can be used in commands by replacing the spaces with an underscore (for example, Catch_a_Breath). | |||
** When using a command that sends a message, any spaces in the message portion can be replaced by the HTML code for a non-breaking space <code>&_N_B_S_P_;</code> (without underscores) in order to avoid enclosing the message in quotation marks. | |||
** Multiple '''<tt>Commands</tt>''' can be executed by one '''<tt>Option</tt>''' by joining them with <tt>$$</tt>, just as they would be on the client command line. | |||
* Listing multiple identifiers for any of the checks except PowerReady produces a logical OR: Badge CouncilRobotBadge StMartialTour1 means "Burkholder's Bane badge OR Johnny's Go To Guy badge". | |||
==See Also== | |||
* {{slashcommand|popmenu}} | |||
* {{slashcommand|contextmenu}} | |||
* {{slashcommand|custom_window}} | |||
==External Links== | |||
* [http://web.archive.org/web/20120905021611/http://boards.cityofheroes.com/showthread.php?p=867593 Customizing the QuickChat Menu] by Fleeting_Whisper | |||
{{Navbox Communication}} | |||
{{Navbox Context Menu Commands}} | |||
{{Navbox Binds}} | |||
[[Category:Context Menu Commands]] | |||
[[Category:Bind Commands]] | |||
[[Category:Slash Commands]] | |||
[[Category:Communication Commands]] |
Latest revision as of 14:41, 28 December 2022
SlashCommand
Pops up the quickchat menu.
- By default this command is bound to the APOSTROPHE (') key.
- Click here for a copy of the default quickchat menu.
Customizing the QuickChat Menu
Custom Quickchat Menus can be created by placing a properly formatted text file named quickchat.mnu in the following directory and then restarting COH after completely exiting to the desktop:
<COH_INSTALL_DIRECTORY>\data\texts\<LANGUAGE>\Menus\
<LANGUAGE> may be one of the following and needs to match the language of the version of City of Heroes that is installed:
- ChineseTraditional
- English
- French
- German
- Japanese
- Korean
- uk
Syntax
MNU files can be created and edited in any text editor. QuickChat Menus have the following general structure:
// Opening comment line for the QuickChat Menu Menu QuickChat { Title TitleName Option OptionName Command Divider Title TitleName Option OptionName Command Menu SubMenuName { Title SubMenuTitleName Option OptionName Command Divider Option OptionName Command } }
- Menu defines a group of Options. Menus can be nested, but each sub-menu requires its own pair of curly braces.
- To create a submenu name of more than one word with spaces between them, enclose it in quotes.
- Option is a selectable command within a menu.
- One letter in OptionName can be designated as a hotkey by prefixing an ampersand (&).
- To create an option name of more than one word with spaces between them, enclose it in quotes.
- Command is one or more slash commands (separated by $$).
- Title is an optional element.
- TitleName labels a menu, or a section of a menu. Titles are not selectable.
- Menus can have more than one Title.
- Divider places a horizontal line in the menu.
LockedOption syntax:
LockedOption is alternative to the Option syntax above and checks to see if an item is currently available given certain conditions. If the condition is not met, the option will be grayed out and unavailable.
LockedOption { DisplayName OptionName Command OptionCommand Authbit AuthIdentifiers Badge BadgeIdentifiers Icon IconName PowerReady InternalPowerName RewardToken RewardIdentifiers StoreProduct ProductIdentifiers }
The conditions under which the item is available is specified with either Authbit, Badge, Icon, PowerReady, RewardToken, or StoreProduct. You only need one, but you can use multiple.
- Authbit checks some state of your account (mostly historical and doesn't apply to Homecoming):
- RogueAccess: Purchased Going Rogue
- RogueCompleteBox: Purchased Going Rogue Complete Collection
- CyborgPack: Purchased Super Booster I: Cyborg
- MagicPack: Purchased Super Booster II: Magic
- SuperSciencePack: Purchased Super Booster III: Superscience
- MutantPack: Purchased Super Booster IV: Mutant
- MartialArtsPack: Purchased Super Booster V: Martial Arts
- WeddingPack: Puchased the Wedding Pack
- List of Authbit Identifiers
- Badge checks whether you've earned a certain badge. For example:
- CouncilRobotBadge: Burkholder's Bane
- StMartialTour1: Johnny's Go To Guy
- SnowflakeEmoteBadge: Invisible badge gained from the Candy Keeper during the Winter Event
- MayhemOutlaw: Outlaw
- ArchitectAccolade: Mission Engineer
- List of badge names (in BadgeGrant tag column)
- List of hidden badge names (9/9/2010)
- Icon checks whether the icon is available to click. List of icon names
- PowerReady checks whether the power is available to use.
- InternalPowerName is the name of the power the game uses internally, which can be found at the City of Data 2 site IMPORTANT: The power name in the URL is correct, not the one on the page. E.g "temporary_powers.temporary_powers.envenomed_dagger" won't work, but "temporary_powers.temporary_powers.invention_envenomed_dagger" will work.
- RewardToken checks that you've earned a specific reward. List of RewardToken Identifiers
- StoreProduct checks against a purchase in the store (also mostly historical). List of StoreProduct Identifiers
Notes
- MNU files allow comments. Use a double forward slash (//) anywhere on a line to force the client to ignore anything between the double slash and the line return.
- IMPORTANT: MNU files must have at least one line containing a carriage-return at the end of the line above the first "Menu" entry. It can be blank, a full comment, or just the comment tag (//) or any number of those lines otherwise it will not function.
- Changes to custom menus require you to exit the client in order for the changes to take effect.
- Custom menus are accessible by all characters on the same machine. By extension, you can send custom menu files to other people so that they can use them as well.
- Option and its parameters must be on one line. Otherwise, the menu will not function.
- If the command string contains spaces, the entire command portion must be enclosed in either quotation marks (" "), or less-than/greater-than brackets and ampersands (<& &>). This last option is especially useful if multiple quotation marks are generating errors in the command. For example:
Option "Celebrate" <&emote dance$$local "Let's Party!"&>
will work, butOption "Celebrate" "emote dance$$local "Let's Party!""
will not. - Inspiration and power names with spaces can be used in commands by replacing the spaces with an underscore (for example, Catch_a_Breath).
- When using a command that sends a message, any spaces in the message portion can be replaced by the HTML code for a non-breaking space
&_N_B_S_P_;
(without underscores) in order to avoid enclosing the message in quotation marks. - Multiple Commands can be executed by one Option by joining them with $$, just as they would be on the client command line.
- If the command string contains spaces, the entire command portion must be enclosed in either quotation marks (" "), or less-than/greater-than brackets and ampersands (<& &>). This last option is especially useful if multiple quotation marks are generating errors in the command. For example:
- Listing multiple identifiers for any of the checks except PowerReady produces a logical OR: Badge CouncilRobotBadge StMartialTour1 means "Burkholder's Bane badge OR Johnny's Go To Guy badge".
See Also
External Links
- Customizing the QuickChat Menu by Fleeting_Whisper