Package com.realtime.crossfire.jxclient.settings.options

Class Pickup

java.lang.Object

com.realtime.crossfire.jxclient.settings.options.Pickup

public class Pickup
extends java.lang.Object

Defines constants for pickup mode.

Field Summary

Fields

Modifier and Type	Field	Description
@NotNull PickupOption	armor	Pickup mode: armors.
@NotNull PickupOption	arrow	Pickup mode: arrows.
@NotNull PickupOption	boot	Pickup mode: boots.
@NotNull PickupOption	bow	Pickup mode: bows.
@NotNull PickupOption	cloak	Pickup mode: cloaks.
@NotNull PickupOption	container	Pickup mode: container.
static long	DEFAULT_PICKUP_MODE	The default pickup mode.
@NotNull PickupOption	drink	Pickup mode: drinks.
@NotNull PickupOption	flesh	Pickup mode: flesh.
@NotNull PickupOption	food	Pickup mode: food.
@NotNull PickupOption	glove	Pickup mode: gloves.
@NotNull PickupOption	helmet	Pickup mode: helmets.
@NotNull PickupOption	inhibit	Pickup mode: disable pickup.
@NotNull PickupOption	jewel	Pickup mode: rings and amulets.
@NotNull PickupOption	key	Pickup mode: keys.
@NotNull PickupOption	magicalItem	Pickup mode: magical items.
@NotNull PickupOption	magicDevice	Pickup mode: magic devices.
@NotNull PickupOption	meleeWeapon	Pickup mode: all weapons.
@NotNull PickupOption	missileWeapon	Pickup mode: missile weapons.
@NotNull PickupOption	notCursed	Pickup mode: ignore cursed items.
@NotNull PickupOption	potion	Pickup mode: potions.
static long	PU_DEBUG	Pickup mode: debug.
static long	PU_NOTHING	Pickup mode: nothing.
static long	PU_RATIO	Pickup mode: mask for value/weight ratio.
@NotNull PickupOption	readable	Pickup mode: normal books and scrolls.
@NotNull PickupOption	shield	Pickup mode: shields.
@NotNull PickupOption	skillscroll	Pickup mode: skillscrolls.
@NotNull PickupOption	spellbook	Pickup mode: spellbooks.
@NotNull PickupOption	stop	Pickup mode: stop before pickup.
@NotNull PickupOption	valuables	Pickup mode: money and gems.

Constructor Summary

Constructors

Constructor	Description
Pickup(@NotNull CommandQueue commandQueue, @NotNull OptionManager optionManager)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
long	getPickupMode()	Returns the pickup mode.
void	setPickupMode(long pickupMode, boolean set)	Sets or unsets the pickup mode.
void	updatePickupMode(long pickupMode, boolean sendToServer)	Sets the pickup mode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PICKUP_MODE

public static final long DEFAULT_PICKUP_MODE

The default pickup mode.

See Also:

Constant Field Values

PU_NOTHING

public static final long PU_NOTHING

Pickup mode: nothing.

See Also:

Constant Field Values

PU_RATIO

public static final long PU_RATIO

Pickup mode: mask for value/weight ratio.

See Also:

Constant Field Values

PU_DEBUG

public static final long PU_DEBUG

Pickup mode: debug.

See Also:

Constant Field Values

food

@NotNull
public final @NotNull PickupOption food

Pickup mode: food.

drink

@NotNull
public final @NotNull PickupOption drink

Pickup mode: drinks.

valuables

@NotNull
public final @NotNull PickupOption valuables

Pickup mode: money and gems.

bow

@NotNull
public final @NotNull PickupOption bow

Pickup mode: bows.

arrow

@NotNull
public final @NotNull PickupOption arrow

Pickup mode: arrows.

helmet

@NotNull
public final @NotNull PickupOption helmet

Pickup mode: helmets.

shield

@NotNull
public final @NotNull PickupOption shield

Pickup mode: shields.

armor

@NotNull
public final @NotNull PickupOption armor

Pickup mode: armors.

boot

@NotNull
public final @NotNull PickupOption boot

Pickup mode: boots.

glove

@NotNull
public final @NotNull PickupOption glove

Pickup mode: gloves.

cloak

@NotNull
public final @NotNull PickupOption cloak

Pickup mode: cloaks.

key

@NotNull
public final @NotNull PickupOption key

Pickup mode: keys.

missileWeapon

@NotNull
public final @NotNull PickupOption missileWeapon

Pickup mode: missile weapons.

meleeWeapon

@NotNull
public final @NotNull PickupOption meleeWeapon

Pickup mode: all weapons.

magicalItem

@NotNull
public final @NotNull PickupOption magicalItem

Pickup mode: magical items.

potion

@NotNull
public final @NotNull PickupOption potion

Pickup mode: potions.

spellbook

@NotNull
public final @NotNull PickupOption spellbook

Pickup mode: spellbooks.

skillscroll

@NotNull
public final @NotNull PickupOption skillscroll

Pickup mode: skillscrolls.

readable

@NotNull
public final @NotNull PickupOption readable

Pickup mode: normal books and scrolls.

magicDevice

@NotNull
public final @NotNull PickupOption magicDevice

Pickup mode: magic devices.

notCursed

@NotNull
public final @NotNull PickupOption notCursed

Pickup mode: ignore cursed items.

jewel

@NotNull
public final @NotNull PickupOption jewel

Pickup mode: rings and amulets.

flesh

@NotNull
public final @NotNull PickupOption flesh

Pickup mode: flesh.

container

@NotNull
public final @NotNull PickupOption container

Pickup mode: container.

inhibit

@NotNull
public final @NotNull PickupOption inhibit

Pickup mode: disable pickup.

stop

@NotNull
public final @NotNull PickupOption stop

Pickup mode: stop before pickup.

Constructor Detail

Pickup

public Pickup(@NotNull
              @NotNull CommandQueue commandQueue,
              @NotNull
              @NotNull OptionManager optionManager)
       throws OptionException

Creates a new instance. Registers pickup related options.

Parameters:

commandQueue - the command queue for sending pickup commands

optionManager - the option manager to use

Throws:

OptionException - if an option cannot be registered

Method Detail

updatePickupMode

public void updatePickupMode(long pickupMode,
                             boolean sendToServer)

Sets the pickup mode.

Parameters:

pickupMode - the pickup mode

sendToServer - whether a /pickup command should be sent to the server

getPickupMode

public long getPickupMode()

Returns the pickup mode.

Returns:

the pickup mode

setPickupMode

public void setPickupMode(long pickupMode,
                          boolean set)

Sets or unsets the pickup mode.

Parameters:

pickupMode - the pickup mode(s) to affect

set - true=set, false=unset