ISXEQ2:announce (command)
From ISMods Wiki
Contents |
[edit]
ISXEQ2 information for ISXEQ2:announce (command) has moved
[edit]
Please see: http://eq2.isxgames.com/wiki for up-to-date content.
[edit]
Syntax
- announce <text> [options]
[edit]
Optional Parameters
- announce <text> [Timer]
- By using the announce command with one float or numerical argument, you are indicating that you would like the announcement to stay on the screen for [Timer] number of seconds. (Note: The default timer (when announce is used without an argument) is 4.5 seconds.)
- announce <text> [Timer] [SoundEffect]
- By using the announce command with two arguments, you are indicating that you would like the announcement to stay on the screen for [Timer] number of seconds, and then to have a specified sound effect accompany it.
- [SoundEffect] is given as a number, using the chart below:
1 = 'skill up' sound effect 2 = 'quest update' sound effect 3 = 'level ding' sound effect 4 = 'call for help' sound effect 5 = 'harvest rare' sound effect 6 = 'quest complete' sound effect 7 = 'location discovery' sound effect 8 = 'Send Mail Failed' sound effect 9 = 'Send Mail Success' sound effect
[edit]
Description
This command initiates an 'on screen announcement' window similar to those seen throughout the playing of EQ2.
[edit]
Examples
- announce "ISXEQ2 by Amadeus\nLoaded"
- Announces ISXEQ2 by Amadeus centered on one line, followed by Loaded on a second line, centered. It will be in white text, with no sound effect, and stay on the screen for 4.5 seconds.
- announce "ISXEQ2 by Amadeus\nLoaded" 2.0
- Announces ISXEQ2 by Amadeus centered on one line, followed by Loaded on a second line, centered. It will be in white text, with no sound effect, and stay on the screen for 2.0 seconds.
- announce "ISXEQ2 by Amadeus\nLoaded" 2.0 2
- Announces ISXEQ2 by Amadeus centered on one line, followed by Loaded on a second line, centered. It will be in white text, with the quest update sound effect, and stay on the screen for 2.0 seconds.
- announce "ISXEQ2 by Amadeus\n\\#FF6E6ELoaded" 2.0 3
- Announces ISXEQ2 by Amadeus centered on one line, followed by Loaded on a second line, centered. The first line will be in a white text with the second line being in a light red, using the level ding sound effect, and stay on the screen for 2.0 seconds.
[edit]
Technical Notes
- Color is added to text using the RGB format, initiated with \\#. For example, to make a line of text a light red, then you would use the command announce "\\#FF6E6EThis rules".
- To change color in the middle of a string, simple enter a new color code.
- Color codes do not take up any spaces in the string; therefore, you will not want to leave a blank space inbetween the code and your text.
- To do a forced line break in a text, simply use the \n code (as shown in the examples above).
- Announcement <text> must be enclosed in quotation marks if it is longer than one word.
- The maximum [Timer] is 10.0 seconds right now. If anyone thinks of a reason why this should be raised, let me know.
- In order to enter a [SoundEffect], you must use the [Timer] argument. (ie, you can't skip over the [Timer] argument.)
[edit]
