getAuto: Difference between revisions

From OpenKore Wiki
Jump to navigation Jump to search
m (Clarified dcOnEmpty option, added link to the "boolean flag" value to the appropriate References section.)
m (Conversion script moved page GetAuto to getAuto: Converting page titles to lowercase)
 
(11 intermediate revisions by 5 users not shown)
Line 2: Line 2:


== Syntax ==
== Syntax ==
  getAuto [<item name>] {
  getAuto <item name> {
  minAmount [<amount>]
  [minAmount <number> ]
  maxAmount [<amount>]
[maxAmount <number> ]
  passive [<boolean flag>]
  [batchSize <number> ]
  dcOnEmpty [<boolean flag>]
  [passive   <boolean>]
[dcOnEmpty <boolean>]
  [disabled  <boolean>]
  }
  }


Line 12: Line 14:
----
----


; getAuto [<[[References#Item Names|item name]]>]
; getAuto <[[References#Item_Names|item name]]>
: This option specifies the item to automatically get from the Kafra storage.  
: 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 (<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.
: 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])


; minAmount [<amount>]
; passive <[[References#boolean_flag|boolean]]>
: 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 [<[[References#Basic_Value_and_Parameter_Types|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.
: 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]]>
; dcOnEmpty [<boolean flag>]
: If this option is set true, openkore will disconnect if there are no more items to get from storage.
: If this option is set true, openkore will disconnect if there are no more items to get from storage.


; disabled <[[boolean]]>
: see [[Disabled]].


'''Note:'''
== Notes ==
* The location of the Kafra NPC is defined in [[storageAuto_npc]].
* To determine how to get to and open the storage, the same generic options are used as with [[storageAuto]].




== Example ==
== Example ==
*Get White Potions from storage when there are no more whites in your inventory:
*Get White Potions and Ring from storage when there are no more whites (or Ring) in your inventory:


  # In Config.txt
  # In Config.txt
Line 48: Line 51:
  minAmount 0
  minAmount 0
  maxAmount 100
  maxAmount 100
batchSize
  passive 0
  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]]

Latest revision as of 22:34, 26 April 2021

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.
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
}
White Potion 100 1 0
Ring 6 1 0