Documentation Changes.

[grimjack]

Here are some things I have found that need to be changed in the documentation.

Edit: /memspell is now working.

/who [pc|npc|corpse|any] [range <min> <max>] [radius <radius>] [guild] [lfg] [name] [alert #] [noalert #]

I would recomend noting that if you use the [pc|npc|corpse|any] and a name that both should be at the end of the line. For some reason if you don't some of the filters don't work.

Example:
/who npc noalert 1 giant
Does not seem to work properly.
/who noalert 1 npc giant
Does.

I believe this is the same with /target and /alert. They may also need an update in the documentation.

Aliases are shorter versions of a command. For instance, /mana is a build in alias.

We should change this to say something like this:

Aliases are user defined names for Macroquest commands. They are designed to simplify commonly used commands a user may type, or use in a script. An example of an alias is /mana. /mana is an alias defined in the macroquest.ini for the command "/echo Current Mana: $char(mana,cur) -- Max Mana: $char(mana,max)"

/mouseto [+,-] <x> <y>
Moves the mouse to a position (+|- make it relative)

I don't think the +,- is used anymore.

/mouseto <x> <y> <rel>
Moves the mouse to a position (rel makes it relative)

I may be wrong on the syntax for relative. I never use it.
Generaly /mouse and /click may need a major overhaul in the documentation. I just don't use either enough to do it.

/hslider <value>
Sets the slider to a specific value, or it's max value if too high

I don't think this works at the moment. It should probably be noted in the documentation that it is broke or removed.

/delay <time> <s, m>
Fully pauses macro for a set amount of time
time: Time in 10ths of a second (or suffixes s/m)

This should be changed to something like this:

/delay <time><s,m>
Fully pauses the macro for a set ammount of time.
time: Time is in 10ths of a second unless specified with s or m.
Example /delay 10s for seconds /delay 10m for minutes.

$combat
Returns TRUE if you are in attack mode.

This should be changed to something like this:

$combat
Returns TRUE if you are in Attack mode or the Ranged Attack button is depressed.

$if([n,]cond,truestr,falsestr)
If cond is true (n does a numeric comparison), returns truestr else returns falsestr
Generally used for min/max (ie. $if(n,$v99<$v98,$v99,$v98) will return the smaller of v99/v98)
or plurals (ie. /echo There $if(n,$l0==1,is,are) $l0 fl$if(n,$l0==1,y,ies) here. will format the string correctly depending if l0 is 1 or not)

This one seems to return the Falsestr no matter what. I would guess it is broke.

$l#
Returns a local variable.

This should be expanded.

$l#
Returns a local variable. Only l0-l9 are available per Sub Routine.
example:

Code: Select all

Sub Main
   /varset l0 "foo"
   /echo $l0
   /call Bar
   /echo $l0
/return

Sub Bar
   /varset l0 "bar"
   /echo $l0
/return

The output of this would be:
foo
bar
foo

Notice that we did not have to set l0 back to foo once it returned to the Main sub.