Difference between revisions of "getAuto"
Jump to navigation
Jump to search
m |
|||
| (15 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | Automatically get items from storage when the specified conditions are met. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | == Syntax == | |
| + | getAuto <item name> { | ||
| + | [minAmount <number> ] | ||
| + | [maxAmount <number> ] | ||
| + | [batchSize <number> ] | ||
| + | [passive <boolean>] | ||
| + | [dcOnEmpty <boolean>] | ||
| + | [disabled <boolean>] | ||
| + | } | ||
| − | + | === Attribute definitions === | |
| + | ---- | ||
| − | : | + | ; getAuto <[[References#Item_Names|item name]]> |
| + | : This option specifies the item to automatically get from the Kafra storage. | ||
| − | : [[ | + | ; minAmount <[[References#number|number]]> |
| + | : If this option is set, this specifies the minimum amount of item in inventory before the auto-get sequence is automatically triggered. Kore will go to the NPC when the number of the specified items left in inventory is less than or equal to this amount. | ||
| + | |||
| + | ; maxAmount <[[References#number|number]]> | ||
| + | : This option specifies the maximum amount of item in inventory that you need. Kore will get an amount equal to the difference between the specified maximum amount and the current amount in inventory. | ||
| + | |||
| + | ; batchSize <[[References#number|number]]> | ||
| + | : This option specifies the maximum amount of the item that can be transferred at each time. Set this option to '''1''' if you are setting up getAuto for equipment (weapons, armors, etc) (see [https://github.com/OpenKore/openkore/pull/2780 PR#2780]) | ||
| + | |||
| + | ; passive <[[References#boolean_flag|boolean]]> | ||
| + | : By default, auto-get will be initiated once the amount of that item specified in this block reaches minAmount. Set this option to '''1''' if you want to get items only during auto-storage. | ||
| + | |||
| + | ; dcOnEmpty <[[References#boolean_flag|boolean]]> | ||
| + | : If this option is set true, openkore will disconnect if there are no more items to get from storage. | ||
| + | |||
| + | ; disabled <[[boolean]]> | ||
| + | : see [[Disabled]]. | ||
| + | |||
| + | == Notes == | ||
| + | * To determine how to get to and open the storage, the same generic options are used as with [[storageAuto]]. | ||
| + | |||
| + | |||
| + | == Example == | ||
| + | *Get White Potions and Ring from storage when there are no more whites (or Ring) in your inventory: | ||
| + | |||
| + | # In Config.txt | ||
| + | storageAuto 1 | ||
| + | storageAuto_npc geffen 120 62 | ||
| + | storageAuto_distance 6 | ||
| + | storageAuto_npc_type 1 | ||
| + | |||
| + | getAuto White Potion { | ||
| + | minAmount 0 | ||
| + | maxAmount 100 | ||
| + | batchSize | ||
| + | passive 0 | ||
| + | dcOnEmpty 0 | ||
| + | disabled 0 | ||
| + | } | ||
| + | getAuto Ring { | ||
| + | minAmount 0 | ||
| + | maxAmount 6 | ||
| + | batchSize 1 | ||
| + | disabled 0 | ||
| + | } | ||
| + | |||
| + | * In the file [[Items_control.txt | items_control.txt]] it is necessary to write: | ||
| + | White Potion 100 1 0 | ||
| + | Ring 6 1 0 | ||
[[Category:config.txt]] | [[Category:config.txt]] | ||
| + | [[Category:items]] | ||
[[Category:storage]] | [[Category:storage]] | ||
| − | [[Category: | + | [[Category:config block]] |
| − | |||
Revision as of 23:47, 6 October 2019
Automatically get items from storage when the specified conditions are met.
Syntax
getAuto <item name> {
[minAmount <number> ]
[maxAmount <number> ]
[batchSize <number> ]
[passive <boolean>]
[dcOnEmpty <boolean>]
[disabled <boolean>]
}
Attribute definitions
- getAuto <item name>
- This option specifies the item to automatically get from the Kafra storage.
- minAmount <number>
- If this option is set, this specifies the minimum amount of item in inventory before the auto-get sequence is automatically triggered. Kore will go to the NPC when the number of the specified items left in inventory is less than or equal to this amount.
- maxAmount <number>
- This option specifies the maximum amount of item in inventory that you need. Kore will get an amount equal to the difference between the specified maximum amount and the current amount in inventory.
- batchSize <number>
- This option specifies the maximum amount of the item that can be transferred at each time. Set this option to 1 if you are setting up getAuto for equipment (weapons, armors, etc) (see PR#2780)
- passive <boolean>
- By default, auto-get will be initiated once the amount of that item specified in this block reaches minAmount. Set this option to 1 if you want to get items only during auto-storage.
- dcOnEmpty <boolean>
- If this option is set true, openkore will disconnect if there are no more items to get from storage.
Notes
- To determine how to get to and open the storage, the same generic options are used as with storageAuto.
Example
- Get White Potions and Ring from storage when there are no more whites (or Ring) in your inventory:
# In Config.txt
storageAuto 1
storageAuto_npc geffen 120 62
storageAuto_distance 6
storageAuto_npc_type 1
getAuto White Potion {
minAmount 0
maxAmount 100
batchSize
passive 0
dcOnEmpty 0
disabled 0
}
getAuto Ring {
minAmount 0
maxAmount 6
batchSize 1
disabled 0
}
- In the file items_control.txt it is necessary to write:
White Potion 100 1 0 Ring 6 1 0
