Difference between revisions of "getAuto"

From OpenKore Wiki
Jump to navigation Jump to search
m
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 [<amount>]
 +
maxAmount [<amount>]
 +
passive [<boolean flag>]
 +
dcOnEmpty [<boolean flag>]
 +
}
  
: '''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.
 
  
: [[storageAuto|Storage location]] must be defined for this to work.
+
; getAuto [<[[References#Item Names|item name]]>]
 +
: This option specifies the item to automatically get from the Kafra storage.
 +
 
 +
 
 +
; maxAmount (<amount>)
 +
: 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.
 +
 
 +
 
 +
; minAmount [<amount>]
 +
: 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.
 +
 
 +
 
 +
; passive [<boolean flag>]
 +
: 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 flag>]
 +
: If this option is set, disconnect if there are no more items to get from storage.
 +
 
 +
 
 +
'''Note:'''
 +
* The location of the Kafra NPC is defined in [[storageAuto_npc]].
 +
 
 +
 
 +
== 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
 +
}
 +
 
  
 
[[Category:config.txt]]
 
[[Category:config.txt]]
[[Category:storage]]
 
[[Category:auto disconnect]]
 
 
[[Category:items]]
 
[[Category:items]]

Revision as of 00:56, 13 December 2009

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

Syntax

getAuto [<item name>] {
	minAmount [<amount>]
	maxAmount [<amount>]
	passive [<boolean flag>]
	dcOnEmpty [<boolean flag>]
}

Attribute definitions



getAuto [<item name>]
This option specifies the item to automatically get from the Kafra storage.


maxAmount (<amount>)
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.


minAmount [<amount>]
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.


passive [<boolean flag>]
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 flag>]
If this option is set, disconnect if there are no more items to get from storage.


Note:


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
}