Difference between revisions of "pickupitems.txt"

From OpenKore Wiki
Jump to navigation Jump to search
m
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
If the option [[itemsTakeAuto]] or [[itemsGatherAuto]] in [[config.txt]] is enabled, Kore will automatically pick up loots. However, Kore will not automatically pick up items unless you specify them in the file pickupitems.txt.  
+
Per-item settings for [[itemsTakeAuto|picking up]] and [[itemsGatherAuto|gathering]] items.
 +
 
 +
Empty configuration will result in not picking up any items.
  
 
== Syntax ==
 
== Syntax ==
 
The format of this file is simply a set of lines that observes the following syntax:
 
The format of this file is simply a set of lines that observes the following syntax:
  
  <item name> <pickup flag>
+
  <item name> <value>
  
=== Details ===
+
; <[[References#Item_Names|item name]]>
----
+
: This is the simple name of an item. Keyword "all" can be used to set the default value for all items not specified in configuration.
  
; <[[References#Item Names|item name]]>
+
; <value>
: This is the simple name of an item. You can use the keyword "all" to set the default option for all items.  
+
: Determines picking up and gathering behavior for specified item.
  
'''Notes:'''
+
{|class="TablePager"
* Kore can see unidentified items, so just use normal item names as if they are already identified.
+
|-
* Specify item names without the refine level and compounded cards. For example, if you specified to pick up Stiletto [3], it will pick up all 3-slotted Stilettos, including +9 3-slotted Stilettos and Triple Hurricane Stilettos.
 
 
 
 
 
; <pickup flag>
 
: This is a flag that controls if Kore should pick up the item or not. It takes one of the following values:
 
 
 
{|border="1" cellpadding="2" cellspacing="1"  
 
|- style=background-color:#F9F9F9;
 
 
!Value
 
!Value
 
!Description
 
!Description
 
|-
 
|-
|align=center|-1
+
!-1
 
|Drop the item when it enters your inventory.
 
|Drop the item when it enters your inventory.
 
|-
 
|-
|align=center|0
+
!0
|Do not pick up the item.
+
|Don't pick up / gather the item.
 
|-
 
|-
|align=center|1
+
!1
|Pick up the item.
+
|Pick up / gather the item using normal [[itemsTakeAuto|picking up]] and [[itemsGatherAuto|gathering]] sequences.
 
|-
 
|-
|align=center|2
+
!>=2
|Pick up the item as fast as possible (don't use this on normal, seemingly worthless, items).  
+
|Try to pick up / gather the item as fast as possible when it appears in 5 cell distance around you.
 
|}
 
|}
  
 +
== Notes ==
 +
* Kore can see unidentified items, so just use normal item names as if they are already identified.
 +
* Specify item names without the refine level and compounded cards (simple names). For example, if you specified to pick up Stiletto [3], it will pick up all 3-slotted Stilettos, including +9 3-slotted Stilettos and Triple Hurricane Stilettos.
 +
* Value '''-1''' is useful for Rogues with [http://irowiki.org/wiki/Gank Gank] skill.
 +
* Don't use value '''2''' on normal, seemingly worthless, items.
 +
 +
== API ==
 +
<code>Misc::pickupitems</code>
  
 
== Examples ==
 
== Examples ==

Revision as of 23:36, 6 January 2017

Per-item settings for picking up and gathering items.

Empty configuration will result in not picking up any items.

Syntax

The format of this file is simply a set of lines that observes the following syntax:

<item name> <value>
<item name>
This is the simple name of an item. Keyword "all" can be used to set the default value for all items not specified in configuration.
<value>
Determines picking up and gathering behavior for specified item.
Value Description
-1 Drop the item when it enters your inventory.
0 Don't pick up / gather the item.
1 Pick up / gather the item using normal picking up and gathering sequences.
>=2 Try to pick up / gather the item as fast as possible when it appears in 5 cell distance around you.

Notes

  • Kore can see unidentified items, so just use normal item names as if they are already identified.
  • Specify item names without the refine level and compounded cards (simple names). For example, if you specified to pick up Stiletto [3], it will pick up all 3-slotted Stilettos, including +9 3-slotted Stilettos and Triple Hurricane Stilettos.
  • Value -1 is useful for Rogues with Gank skill.
  • Don't use value 2 on normal, seemingly worthless, items.

API

Misc::pickupitems

Examples

In the following example, kore will pick up Old Blue Boxes and 2-slotted Two-handed Axes as quickly as possible. It will ignore 3-slotted Axes, Traps and Magnifiers and drop those items when they are in the inventory. All other items will be picked up by default.

Old Blue Box 2
Two-handed Axe [2] 2
Axe [3] -1
Magnifier -1
Trap -1

#Pick up all items by default
all 1