Difference between revisions of "getAuto"

From OpenKore Wiki
Jump to navigation Jump to search
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
; getAuto [<item>] {
+
Automatically get items from storage when the specified conditions are met.
::; minAmount [<integer>]
 
::; maxAmount [<integer>]
 
::; passive [<boolean>]
 
::; dcOnEmpty [<boolean>] ''(v1.9.0)''
 
; }
 
  
: Enables auto get to get '''maxAmount''' of specified item from your storage when there is less than '''minAmount''' left.
+
== Syntax ==
 +
getAuto <item name> {
 +
[minAmount <number>]
 +
[maxAmount <number>]
 +
[passive <boolean>]
 +
[dcOnEmpty <boolean>]
 +
[disabled <boolean>]
 +
}
  
: '''passive''' disables triggering [[storageAuto|auto storage]] by this block (so it will be processed when auto storage triggers by something else).
+
=== Attribute definitions ===
 +
----
  
: '''dcOnEmpty''' enables auto quit when there are no more items to get.
+
; 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.
 +
 
 +
; 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 from storage when there are no more whites 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
 +
passive 0
 +
dcOnEmpty 0
 +
disabled 0
 +
}
  
: [[storageAuto|Storage location]] must be defined for this to work.
 
  
 
[[Category:config.txt]]
 
[[Category:config.txt]]
 +
[[Category:items]]
 
[[Category:storage]]
 
[[Category:storage]]
[[Category:auto disconnect]]
+
[[Category:config block]]

Revision as of 20:52, 6 July 2019

Automatically get items from storage when the specified conditions are met.

Syntax

getAuto <item name> {
	[minAmount <number>]
	[maxAmount <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.
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.
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 from storage when there are no more whites 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
	passive 0
	dcOnEmpty 0
	disabled 0
}