Difference between revisions of "Eqset"
From BatWiki
BlackSmith (Talk | contribs) (Saving this raw info) |
|||
Line 12: | Line 12: | ||
|- | |- | ||
| eqset add <setname> <item>[,item...] | | eqset add <setname> <item>[,item...] | ||
− | |||
<setname> is any name you want to use to id the set (no spaces) | <setname> is any name you want to use to id the set (no spaces) | ||
− | |||
<item> is either the name of an item to add to the set, or | <item> is either the name of an item to add to the set, or | ||
− | |||
all, eq, unkept, etc .. see 'help handling'. | all, eq, unkept, etc .. see 'help handling'. | ||
− | |||
You can add multiple items separated by commas. | You can add multiple items separated by commas. | ||
− | |||
− | |||
− | |||
|- | |- | ||
| eqset radd <setname> <handle> | | eqset radd <setname> <handle> | ||
− | |||
Works like 'eqset add', but allows you to specify the preferred | Works like 'eqset add', but allows you to specify the preferred | ||
− | |||
unique handle for handling the item. This can be useful when using | unique handle for handling the item. This can be useful when using | ||
− | |||
'eqset foreach' or 'eqset command', as some automatically chosen | 'eqset foreach' or 'eqset command', as some automatically chosen | ||
− | |||
handles may be problematic. | handles may be problematic. | ||
Line 38: | Line 27: | ||
|- | |- | ||
| eqset delete <setname> <item>[,item...] | | eqset delete <setname> <item>[,item...] | ||
− | |||
Delete <item> from the given <setname>. | Delete <item> from the given <setname>. | ||
− | |||
You can remove multiple items separated by commas. | You can remove multiple items separated by commas. | ||
− | |||
− | |||
− | |||
|- | |- | ||
| eqset delete <setname> | | eqset delete <setname> | ||
− | |||
Delete the entire eqset by the given name. | Delete the entire eqset by the given name. | ||
− | |||
* shortcut: you can just use del instead of delete if you like. | * shortcut: you can just use del instead of delete if you like. | ||
− | |||
− | |||
− | |||
|- | |- | ||
| eqset wear <setname> | | eqset wear <setname> | ||
− | |||
Wear all the items in the eqset, it will remove the current eqset first. | Wear all the items in the eqset, it will remove the current eqset first. | ||
− | |||
− | |||
− | |||
|- | |- | ||
| eqset wear <setname> noremove | | eqset wear <setname> noremove | ||
− | |||
Wear the specified eqset, but do NOT remove the old set first. | Wear the specified eqset, but do NOT remove the old set first. | ||
− | |||
− | |||
− | |||
|- | |- | ||
| eqset remove <setname> | | eqset remove <setname> | ||
− | |||
Remove/unwear all items belonging to this eqset | Remove/unwear all items belonging to this eqset | ||
− | |||
− | |||
− | |||
|- | |- | ||
| eqset list | | eqset list | ||
− | |||
This will list the names of all eqsets you have created. | This will list the names of all eqsets you have created. | ||
− | |||
− | |||
− | |||
|- | |- | ||
| eqset view <setname> | | eqset view <setname> | ||
− | |||
Show what items are in the given eqset. | Show what items are in the given eqset. | ||
− | |||
− | |||
− | |||
|- | |- | ||
| eqset validate <setname> [clear] | | eqset validate <setname> [clear] | ||
− | |||
See the rather lengthy explanation for this at the end of this help | See the rather lengthy explanation for this at the end of this help | ||
− | |||
file. | file. | ||
− | |||
− | |||
− | |||
|- | |- | ||
| eqset foreach <setname> <cmd string> | | eqset foreach <setname> <cmd string> | ||
− | |||
Executes the cmd string with each item in the set as the target | Executes the cmd string with each item in the set as the target | ||
− | |||
Optional: if you put -verbose as a prefix to the command, then | Optional: if you put -verbose as a prefix to the command, then | ||
− | |||
the command will be echoed for each item, example: | the command will be echoed for each item, example: | ||
− | |||
'eqset foreach testset -verbose look at' | 'eqset foreach testset -verbose look at' | ||
− | |||
− | |||
NOTICE! You can also use a special <item>-tag to specify where | NOTICE! You can also use a special <item>-tag to specify where | ||
− | |||
in the command string you want the item handle to be. For example: | in the command string you want the item handle to be. For example: | ||
− | |||
'eqset foreach testset put <item> in chest' | 'eqset foreach testset put <item> in chest' | ||
− | |||
or | or | ||
− | |||
'eqset foreach testset get <item> from chest' | 'eqset foreach testset get <item> from chest' | ||
− | |||
− | |||
− | |||
|- | |- | ||
| eqset command <setname> <cmd string> | | eqset command <setname> <cmd string> | ||
− | |||
Works similarly to 'foreach', but concatenates items to one argument | Works similarly to 'foreach', but concatenates items to one argument | ||
− | |||
like ring,tabard,shoes and so on. For example: | like ring,tabard,shoes and so on. For example: | ||
− | |||
'eqset command testset put <item> in chest' | 'eqset command testset put <item> in chest' | ||
− | |||
− | |||
− | |||
|- | |- | ||
| eqset rename <oldname> <newname> | | eqset rename <oldname> <newname> | ||
− | |||
Renames eqset named <oldname> to <newname>. | Renames eqset named <oldname> to <newname>. | ||
− | |||
− | |||
− | |||
|- | |- | ||
! VALIDATE SET OPTION | ! VALIDATE SET OPTION | ||
− | |||
|- | |- | ||
| When you add an item to your eqset, it has an unique id which allows the | | When you add an item to your eqset, it has an unique id which allows the | ||
− | |||
eqset command to know which items you are carrying are part of the set; | eqset command to know which items you are carrying are part of the set; | ||
− | |||
however, it is possible and likely that over time you will have items | however, it is possible and likely that over time you will have items | ||
− | |||
that are part of your set that you no longer even possess. These items | that are part of your set that you no longer even possess. These items | ||
− | |||
will still count towards you 40 items per set. Because you no longer | will still count towards you 40 items per set. Because you no longer | ||
− | |||
have the item (or maybe you just dont feel like unchesting it) it is not | have the item (or maybe you just dont feel like unchesting it) it is not | ||
− | |||
possible to remove the item from the set with the normal eqset delete | possible to remove the item from the set with the normal eqset delete | ||
− | |||
command. | command. | ||
− | |||
− | |||
By using the validate command, the eqset program will compare all items | By using the validate command, the eqset program will compare all items | ||
− | |||
it thinks should be in your set to what you are carrying. Any items | it thinks should be in your set to what you are carrying. Any items | ||
− | |||
that should be in your set but are not being carried by you will be | that should be in your set but are not being carried by you will be | ||
− | |||
deleted from the set. So, if you are still confused about this here is | deleted from the set. So, if you are still confused about this here is | ||
− | |||
an example: | an example: | ||
− | |||
− | |||
You add a bracelet to your eqset called 'offense', but let's say you | You add a bracelet to your eqset called 'offense', but let's say you | ||
− | |||
sell the bracelet and didn't remove it from your set first. Now you | sell the bracelet and didn't remove it from your set first. Now you | ||
− | |||
have this 'phantom' item stored in your eqset, and it is taking up one | have this 'phantom' item stored in your eqset, and it is taking up one | ||
− | |||
of your allowed slots. It is perfectly fine to leave it there forever, | of your allowed slots. It is perfectly fine to leave it there forever, | ||
− | |||
but it is taking up a slot in the set, so effectively you can now have | but it is taking up a slot in the set, so effectively you can now have | ||
− | |||
only 39 items in the set. | only 39 items in the set. | ||
− | |||
− | |||
By default, 'eqset validate' will not change the eqset, but instead just | By default, 'eqset validate' will not change the eqset, but instead just | ||
− | |||
tells you what would be done. You need to specify 'clear' parameter to | tells you what would be done. You need to specify 'clear' parameter to | ||
− | |||
validate in order to actually remove the items from the eqset. | validate in order to actually remove the items from the eqset. | ||
− | |||
− | |||
To remove it, you would use 'eqset validate offense clear'. As a side | To remove it, you would use 'eqset validate offense clear'. As a side | ||
− | |||
note, validating a set NEVER does anything to your actual items. ie it | note, validating a set NEVER does anything to your actual items. ie it | ||
− | |||
won't make them be destroyed or anything. The absolute worse thing that | won't make them be destroyed or anything. The absolute worse thing that | ||
− | |||
could happen is your eqset would be cleared. That's the best I can | could happen is your eqset would be cleared. That's the best I can | ||
− | |||
explain it, play with it, you'll figure it out. Basically, I wouldn't | explain it, play with it, you'll figure it out. Basically, I wouldn't | ||
− | |||
even bother using the 'validate' command until eqset tells you there are | even bother using the 'validate' command until eqset tells you there are | ||
− | |||
too many items in the set and you think there are not. ++Duke | too many items in the set and you think there are not. ++Duke | ||
|- | |- | ||
! NOTE | ! NOTE | ||
− | |||
|- | |- | ||
| Eqsets work ONLY for armours, they do not work for weapons. If you add a | | Eqsets work ONLY for armours, they do not work for weapons. If you add a | ||
− | |||
weapon to your set, it will be 'worn' not wielded. | weapon to your set, it will be 'worn' not wielded. | ||
− | |||
− | |||
Each player can define a maximum of 7 to 10 sets, depending on his | Each player can define a maximum of 7 to 10 sets, depending on his | ||
− | |||
level. | level. | ||
− | |||
− | |||
Each set can contain 40 items. | Each set can contain 40 items. | ||
− | |||
− | |||
If you use the noremove option when wearing an eqset, and you do this | If you use the noremove option when wearing an eqset, and you do this | ||
− | |||
several times it is up to you to remove the old eqsets. Because eqset | several times it is up to you to remove the old eqsets. Because eqset | ||
− | |||
system will remove the last set you put on automatically when you wear a | system will remove the last set you put on automatically when you wear a | ||
− | |||
set without the noremove option. | set without the noremove option. | ||
− | |||
− | |||
− | |||
|- | |- | ||
! FOREACH PITFALLS | ! FOREACH PITFALLS | ||
− | |||
|- | |- | ||
| The way 'eqset foreach' and object handling generally operates may lead | | The way 'eqset foreach' and object handling generally operates may lead | ||
− | |||
to unintuitive and confusing results with certain operations. Consider | to unintuitive and confusing results with certain operations. Consider | ||
− | |||
the command: | the command: | ||
− | |||
− | |||
eqset foreach get <item> from chest | eqset foreach get <item> from chest | ||
− | |||
− | |||
Simple enough, but the eqset command does not directly know what items | Simple enough, but the eqset command does not directly know what items | ||
− | |||
the chest contains, it simply runs the 'get x from chest' command for | the chest contains, it simply runs the 'get x from chest' command for | ||
− | |||
each item defined in the eqset. This can lead to problems if there are | each item defined in the eqset. This can lead to problems if there are | ||
− | |||
items with _same_ handle in the chest that do not belong to the eqset -- | items with _same_ handle in the chest that do not belong to the eqset -- | ||
− | |||
depending on the item order, the item got may not be the item that | depending on the item order, the item got may not be the item that | ||
− | |||
belongs to the eqset! Unfortunately there is no 100% good solution to | belongs to the eqset! Unfortunately there is no 100% good solution to | ||
− | |||
this problem. | this problem. | ||
− | |||
− | |||
|- | |- | ||
! SHORT CUTS | ! SHORT CUTS | ||
− | |||
|- | |- | ||
| eqset - this command by itself is the same as eqset list | | eqset - this command by itself is the same as eqset list | ||
− | |||
eqset <setname> - this command is the same as eqset wear <setname> | eqset <setname> - this command is the same as eqset wear <setname> | ||
|} | |} |
Latest revision as of 11:12, 26 May 2015
NAME |
---|
eqset - Create and manage equipment sets |
SYNOPSIS |
subcommand> [options] |
DESCRIPTION |
eqset add <setname> <item>[,item...]
<setname> is any name you want to use to id the set (no spaces) <item> is either the name of an item to add to the set, or all, eq, unkept, etc .. see 'help handling'. You can add multiple items separated by commas. |
eqset radd <setname> <handle>
Works like 'eqset add', but allows you to specify the preferred unique handle for handling the item. This can be useful when using 'eqset foreach' or 'eqset command', as some automatically chosen handles may be problematic.
|
eqset delete <setname> <item>[,item...]
Delete <item> from the given <setname>. You can remove multiple items separated by commas. |
eqset delete <setname>
Delete the entire eqset by the given name. * shortcut: you can just use del instead of delete if you like. |
eqset wear <setname>
Wear all the items in the eqset, it will remove the current eqset first. |
eqset wear <setname> noremove
Wear the specified eqset, but do NOT remove the old set first. |
eqset remove <setname>
Remove/unwear all items belonging to this eqset |
eqset list
This will list the names of all eqsets you have created. |
eqset view <setname>
Show what items are in the given eqset. |
eqset validate <setname> [clear]
See the rather lengthy explanation for this at the end of this help file. |
eqset foreach <setname> <cmd string>
Executes the cmd string with each item in the set as the target Optional: if you put -verbose as a prefix to the command, then the command will be echoed for each item, example: 'eqset foreach testset -verbose look at' NOTICE! You can also use a special <item>-tag to specify where in the command string you want the item handle to be. For example: 'eqset foreach testset put <item> in chest' or 'eqset foreach testset get <item> from chest' |
eqset command <setname> <cmd string>
Works similarly to 'foreach', but concatenates items to one argument like ring,tabard,shoes and so on. For example: 'eqset command testset put <item> in chest' |
eqset rename <oldname> <newname>
Renames eqset named <oldname> to <newname>. |
VALIDATE SET OPTION |
When you add an item to your eqset, it has an unique id which allows the
eqset command to know which items you are carrying are part of the set; however, it is possible and likely that over time you will have items that are part of your set that you no longer even possess. These items will still count towards you 40 items per set. Because you no longer have the item (or maybe you just dont feel like unchesting it) it is not possible to remove the item from the set with the normal eqset delete command. By using the validate command, the eqset program will compare all items it thinks should be in your set to what you are carrying. Any items that should be in your set but are not being carried by you will be deleted from the set. So, if you are still confused about this here is an example: You add a bracelet to your eqset called 'offense', but let's say you sell the bracelet and didn't remove it from your set first. Now you have this 'phantom' item stored in your eqset, and it is taking up one of your allowed slots. It is perfectly fine to leave it there forever, but it is taking up a slot in the set, so effectively you can now have only 39 items in the set. By default, 'eqset validate' will not change the eqset, but instead just tells you what would be done. You need to specify 'clear' parameter to validate in order to actually remove the items from the eqset. To remove it, you would use 'eqset validate offense clear'. As a side note, validating a set NEVER does anything to your actual items. ie it won't make them be destroyed or anything. The absolute worse thing that could happen is your eqset would be cleared. That's the best I can explain it, play with it, you'll figure it out. Basically, I wouldn't even bother using the 'validate' command until eqset tells you there are too many items in the set and you think there are not. ++Duke |
NOTE |
Eqsets work ONLY for armours, they do not work for weapons. If you add a
weapon to your set, it will be 'worn' not wielded. Each player can define a maximum of 7 to 10 sets, depending on his level. Each set can contain 40 items. If you use the noremove option when wearing an eqset, and you do this several times it is up to you to remove the old eqsets. Because eqset system will remove the last set you put on automatically when you wear a set without the noremove option. |
FOREACH PITFALLS |
The way 'eqset foreach' and object handling generally operates may lead
to unintuitive and confusing results with certain operations. Consider the command: eqset foreach get <item> from chest Simple enough, but the eqset command does not directly know what items the chest contains, it simply runs the 'get x from chest' command for each item defined in the eqset. This can lead to problems if there are items with _same_ handle in the chest that do not belong to the eqset -- depending on the item order, the item got may not be the item that belongs to the eqset! Unfortunately there is no 100% good solution to this problem. |
SHORT CUTS |
eqset - this command by itself is the same as eqset list
eqset <setname> - this command is the same as eqset wear <setname> |