Project

General

Profile

ISXEQ2 »

EQ2Echo (command)

Syntax

  • EQ2Echo [options] [output parameters]

Description

The command echoes text directly to your chat window(s), the InnerSpace console, or to a file.

  • Note: EQ2Echo will convert any colons to hyphens before sending text to the eq2 chat window. It is important to note that colons are not allowed to be 'echoed' to the eq2 chat window due to technical (in game parsing) restrictions.

Options

  • -chattype <type>
    • By supplying a chattype, you are indicating to your client that the text that is being 'echoed' is that type of chat message. The benefit of this is that your text will have the same color as that 'message type', and that you will be able to use your chat window filters to either filter in or out your ISXEQ2 echo messages.
Chat types recognized by ISXEQ2 are as follows:

default
status
system
error
cmd
cstell
motd
gmotd
gu
gofficerchat
gleaderchat
gonline
gsay
rsay
say
emote
tell
yellforhelp
death
who
ooc
auction
shout
narrative
nonpctell
merchant
reward
petchat
spell
spellfail
spellfcast
spellhcast
spellwoff
spellother
skill
dmg
ds
meleewarning
meleehit
meleehitsme

Output Parameters

Output from your EQ2Echo command can be directed to one of four things: the Innerspace console, the debugger, your chat windows (EQ2 screen), or a file. Basically, it works similarly to a command shell system:

  • > console
    • directs the output to the Innerspace console
  • > screen
    • directs the output to your chat windows (the EQ2 screen)
  • > [filename]
    • directs the output to a file. This syntax will overwrite any file of the same name that already exists.
  • >> [filename]
    • directs the output to a file. This syntax will append the file you specify with your output.
  • >* [filename]
    • directs the output to a file. This syntax is similar to '>' with the exception of that it makes the file created a READ ONLY file. (ie, once the file is created, the '>' and '>*' operators will fail on that particular file thereafter)
  • > debugger
  • >> debugger
    • Redirect output to the debugger. > and >> have the same effect.

Defaults

  • The default 'chat type' for this command is "motd".
  • The default output parameter for this command is to the EQ2 chat windows (screen)
  • The path for created files is the directory where ISXEQ2.dll is located.

Examples

  • EQ2Echo ${Me.Name}
  • EQ2Echo ${Target.Class} -chattype error > console
  • EQ2Echo ${Me.Name}'s stats:\nHealth: ${Me.Health}\n > Mystats.txt
  • EQ2Echo Power: ${Me.Power}\n >> Mystats.txt
  • EQ2Echo I found it! >* Found.txt

Technical Notes

  • To create a new-line within a file, use the '\n' code.
  • To use the '>' symbol in your actual text, use '\\>' instead