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 and Description
PickupOption	armor Pickup mode: armors.
PickupOption	arrow Pickup mode: arrows.
PickupOption	boot Pickup mode: boots.
PickupOption	bow Pickup mode: bows.
PickupOption	cloak Pickup mode: cloaks.
private CommandQueue	commandQueue The command queue for sending pickup commands.
PickupOption	container Pickup mode: container.
static long	DEFAULT_PICKUP_MODE The default pickup mode.
PickupOption	drink Pickup mode: drinks.
PickupOption	flesh Pickup mode: flesh.
PickupOption	food Pickup mode: food.
PickupOption	glove Pickup mode: gloves.
PickupOption	helmet Pickup mode: helmets.
PickupOption	inhibit Pickup mode: disable pickup.
PickupOption	jewel Pickup mode: rings and amulets.
PickupOption	key Pickup mode: keys.
PickupOption	magicalItem Pickup mode: magical items.
PickupOption	magicDevice Pickup mode: magic devices.
PickupOption	meleeWeapon Pickup mode: all weapons.
PickupOption	missileWeapon Pickup mode: missile weapons.
PickupOption	notCursed Pickup mode: ignore cursed items.
private long	pickupMode The pickup mode.
private java.util.Collection<PickupOption>	pickupOptions All pickup options.
PickupOption	potion Pickup mode: potions.
private static long	PU_DEBUG Pickup mode: debug.
private static long	PU_NEW_MODE Pickup mode: enable newpickup mode.
static long	PU_NOTHING Pickup mode: nothing.
static long	PU_RATIO Pickup mode: mask for value/weight ratio.
PickupOption	readable Pickup mode: normal books and scrolls.
PickupOption	shield Pickup mode: shields.
PickupOption	skillscroll Pickup mode: skillscrolls.
PickupOption	spellbook Pickup mode: spellbooks.
PickupOption	stop Pickup mode: stop before pickup.
PickupOption	valuables Pickup mode: money and gems.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
long	getPickupMode() Returns the pickup mode.
private PickupOption	newPickupOption(long option, java.lang.String tooltipText) Creates a new PickupOption.
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

armor

@NotNull
public final PickupOption armor

Pickup mode: armors.

arrow

@NotNull
public final PickupOption arrow

Pickup mode: arrows.

boot

@NotNull
public final PickupOption boot

Pickup mode: boots.

bow

@NotNull
public final PickupOption bow

Pickup mode: bows.

cloak

@NotNull
public final PickupOption cloak

Pickup mode: cloaks.

commandQueue

@NotNull
private final CommandQueue commandQueue

The command queue for sending pickup commands.

container

@NotNull
public final PickupOption container

Pickup mode: container.

DEFAULT_PICKUP_MODE

public static final long DEFAULT_PICKUP_MODE

The default pickup mode.

See Also:

Constant Field Values

drink

@NotNull
public final PickupOption drink

Pickup mode: drinks.

flesh

@NotNull
public final PickupOption flesh

Pickup mode: flesh.

food

@NotNull
public final PickupOption food

Pickup mode: food.

glove

@NotNull
public final PickupOption glove

Pickup mode: gloves.

helmet

@NotNull
public final PickupOption helmet

Pickup mode: helmets.

inhibit

@NotNull
public final PickupOption inhibit

Pickup mode: disable pickup.

jewel

@NotNull
public final PickupOption jewel

Pickup mode: rings and amulets.

key

@NotNull
public final PickupOption key

Pickup mode: keys.

magicalItem

@NotNull
public final PickupOption magicalItem

Pickup mode: magical items.

magicDevice

@NotNull
public final PickupOption magicDevice

Pickup mode: magic devices.

meleeWeapon

@NotNull
public final PickupOption meleeWeapon

Pickup mode: all weapons.

missileWeapon

@NotNull
public final PickupOption missileWeapon

Pickup mode: missile weapons.

notCursed

@NotNull
public final PickupOption notCursed

Pickup mode: ignore cursed items.

pickupMode

private long pickupMode

The pickup mode.

pickupOptions

@NotNull
private final java.util.Collection<PickupOption> pickupOptions

All pickup options.

potion

@NotNull
public final PickupOption potion

Pickup mode: potions.

PU_DEBUG

private static final long PU_DEBUG

Pickup mode: debug.

See Also:

Constant Field Values

PU_NEW_MODE

private static final long PU_NEW_MODE

Pickup mode: enable newpickup 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

readable

@NotNull
public final PickupOption readable

Pickup mode: normal books and scrolls.

shield

@NotNull
public final PickupOption shield

Pickup mode: shields.

skillscroll

@NotNull
public final PickupOption skillscroll

Pickup mode: skillscrolls.

spellbook

@NotNull
public final PickupOption spellbook

Pickup mode: spellbooks.

stop

@NotNull
public final PickupOption stop

Pickup mode: stop before pickup.

valuables

@NotNull
public final PickupOption valuables

Pickup mode: money and gems.

Constructor Detail

Pickup

public Pickup(@NotNull
              CommandQueue commandQueue,
              @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

getPickupMode

public long getPickupMode()

Returns the pickup mode.

Returns:

the pickup mode

newPickupOption

@NotNull
private PickupOption newPickupOption(long option,
                                              @NotNull
                                              java.lang.String tooltipText)

Creates a new PickupOption.

Parameters:

option - the pickup value

tooltipText - the tooltip text to explain this option

Returns:

the pickup option

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

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