Crossfire JXClient, Trunk: com.realtime.crossfire.jxclient.settings.options.Pickup Class Reference

Crossfire JXClient, Trunk

Collaboration diagram for com.realtime.crossfire.jxclient.settings.options.Pickup:

Collaboration graph

Public Member Functions
long	getPickupMode ()

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

void	setPickupModeNewMode (final long pickupMode, final boolean set)

void	setPickupModeOldMode (final long pickupMode)

void	updatePickupMode (final long pickupMode, final boolean sendToServer)

Static Public Attributes
static final long	PU_EVERYTHING = 4

static final long	PU_NEW_MODE = 0x80000000L

static final long	PU_NOTHING = 0

Private Member Functions
PickupOption	newPickupOptionNewMode (final long option, @NotNull final String tooltipText)

PickupOption	newPickupOptionOldMode (final long mode, @NotNull final String tooltipText)

Private Attributes
final CommandQueue	commandQueue

long	pickupMode = PU_NOTHING

final Collection< PickupOption >	pickupOptions = new LinkedList<>()

Static Private Attributes
static final long	PU_DEBUG = 0x10000000L

static final long	PU_RATIO = 0x0000000FL

Detailed Description

Defines constants for pickup mode.

Author: Andreas Kirschbaum

Definition at line 34 of file Pickup.java.

Constructor & Destructor Documentation

◆ Pickup()

com.realtime.crossfire.jxclient.settings.options.Pickup.Pickup	(	@NotNull final CommandQueue	commandQueue,
		@NotNull final 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

Exceptions

OptionException if an option cannot be registered

Definition at line 84 of file Pickup.java.

References com.realtime.crossfire.jxclient.settings.options.Pickup.commandQueue, com.realtime.crossfire.jxclient.settings.options.Pickup.newPickupOptionNewMode(), com.realtime.crossfire.jxclient.settings.options.Pickup.newPickupOptionOldMode(), com.realtime.crossfire.jxclient.settings.options.Pickup.PU_EVERYTHING, and com.realtime.crossfire.jxclient.settings.options.Pickup.PU_NOTHING.

Here is the call graph for this function:

Member Function Documentation

◆ getPickupMode()

long com.realtime.crossfire.jxclient.settings.options.Pickup.getPickupMode ( )

Returns the pickup mode.

Returns: the pickup mode

Definition at line 188 of file Pickup.java.

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

Referenced by com.realtime.crossfire.jxclient.settings.options.PickupOptionOldMode.execute(), and com.realtime.crossfire.jxclient.window.JXCConnection.setCharacter().

Here is the caller graph for this function:

◆ newPickupOptionNewMode()

PickupOption com.realtime.crossfire.jxclient.settings.options.Pickup.newPickupOptionNewMode	(	final long	option,
		@NotNull final String	tooltipText
	)

private

Creates a new PickupOption for a PU_NEW_MODE bit.

Parameters

option	the pickup value
tooltipText	the tooltip text to explain this option

Returns: the pickup option

Definition at line 152 of file Pickup.java.

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

Referenced by com.realtime.crossfire.jxclient.settings.options.Pickup.Pickup().

Here is the caller graph for this function:

◆ newPickupOptionOldMode()

PickupOption com.realtime.crossfire.jxclient.settings.options.Pickup.newPickupOptionOldMode	(	final long	mode,
		@NotNull final String	tooltipText
	)

private

Creates a new PickupOption outside PU_NEW_MODE.

Parameters

mode	the pickup mode
tooltipText	the tooltip text to explain this option

Returns: the pickup option

Definition at line 139 of file Pickup.java.

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

Referenced by com.realtime.crossfire.jxclient.settings.options.Pickup.Pickup().

Here is the caller graph for this function:

◆ setPickupModeNewMode()

void com.realtime.crossfire.jxclient.settings.options.Pickup.setPickupModeNewMode	(	final long	pickupMode,
		final boolean	set
	)

Sets or unsets the pickup mode in Pickup#PU_NEW_MODE.

Parameters

pickupMode	the pickup mode(s) to affect
set

Definition at line 205 of file Pickup.java.

References com.realtime.crossfire.jxclient.settings.options.Pickup.pickupMode, com.realtime.crossfire.jxclient.settings.options.Pickup.PU_NEW_MODE, and com.realtime.crossfire.jxclient.settings.options.Pickup.updatePickupMode().

Referenced by com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPickupModeOldMode()

void com.realtime.crossfire.jxclient.settings.options.Pickup.setPickupModeOldMode ( final long pickupMode )

Sets or unsets the pickup mode without Pickup#PU_NEW_MODE.

Parameters

pickupMode the pickup mode to set

Definition at line 196 of file Pickup.java.

References com.realtime.crossfire.jxclient.settings.options.Pickup.pickupMode, and com.realtime.crossfire.jxclient.settings.options.Pickup.updatePickupMode().

Referenced by com.realtime.crossfire.jxclient.settings.options.PickupOptionOldMode.execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updatePickupMode()

void com.realtime.crossfire.jxclient.settings.options.Pickup.updatePickupMode	(	final long	pickupMode,
		final boolean	sendToServer
	)

Sets the pickup mode.

Parameters

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

Definition at line 164 of file Pickup.java.

References com.realtime.crossfire.jxclient.settings.options.Pickup.commandQueue, com.realtime.crossfire.jxclient.settings.options.Pickup.pickupMode, com.realtime.crossfire.jxclient.settings.options.Pickup.pickupOptions, com.realtime.crossfire.jxclient.settings.options.Pickup.PU_DEBUG, com.realtime.crossfire.jxclient.settings.options.Pickup.PU_NEW_MODE, com.realtime.crossfire.jxclient.settings.options.Pickup.PU_NOTHING, com.realtime.crossfire.jxclient.settings.options.Pickup.PU_RATIO, and com.realtime.crossfire.jxclient.queue.CommandQueue.sendNcom().

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.setCharacter(), com.realtime.crossfire.jxclient.settings.options.Pickup.setPickupModeNewMode(), and com.realtime.crossfire.jxclient.settings.options.Pickup.setPickupModeOldMode().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ commandQueue

final CommandQueue com.realtime.crossfire.jxclient.settings.options.Pickup.commandQueue

private

The command queue for sending pickup commands.

Definition at line 71 of file Pickup.java.

Referenced by com.realtime.crossfire.jxclient.settings.options.Pickup.Pickup(), and com.realtime.crossfire.jxclient.settings.options.Pickup.updatePickupMode().

◆ pickupMode

long com.realtime.crossfire.jxclient.settings.options.Pickup.pickupMode = PU_NOTHING

private

The pickup mode.

Definition at line 76 of file Pickup.java.

Referenced by com.realtime.crossfire.jxclient.settings.options.Pickup.getPickupMode(), com.realtime.crossfire.jxclient.settings.options.Pickup.setPickupModeNewMode(), com.realtime.crossfire.jxclient.settings.options.Pickup.setPickupModeOldMode(), and com.realtime.crossfire.jxclient.settings.options.Pickup.updatePickupMode().

◆ pickupOptions

final Collection<PickupOption> com.realtime.crossfire.jxclient.settings.options.Pickup.pickupOptions = new LinkedList<>()

private

All pickup options.

Definition at line 65 of file Pickup.java.

Referenced by com.realtime.crossfire.jxclient.settings.options.Pickup.newPickupOptionNewMode(), com.realtime.crossfire.jxclient.settings.options.Pickup.newPickupOptionOldMode(), and com.realtime.crossfire.jxclient.settings.options.Pickup.updatePickupMode().

◆ PU_DEBUG

final long com.realtime.crossfire.jxclient.settings.options.Pickup.PU_DEBUG = 0x10000000L

staticprivate

Pickup mode: debug.

Definition at line 54 of file Pickup.java.

Referenced by com.realtime.crossfire.jxclient.settings.options.Pickup.updatePickupMode().

◆ PU_EVERYTHING

final long com.realtime.crossfire.jxclient.settings.options.Pickup.PU_EVERYTHING = 4

static

Pickup mode: everything.

Definition at line 44 of file Pickup.java.

Referenced by com.realtime.crossfire.jxclient.settings.options.PickupOptionOldMode.execute(), and com.realtime.crossfire.jxclient.settings.options.Pickup.Pickup().

◆ PU_NEW_MODE

final long com.realtime.crossfire.jxclient.settings.options.Pickup.PU_NEW_MODE = 0x80000000L

static

Pickup mode: enable newpickup mode.

Definition at line 59 of file Pickup.java.

Referenced by com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.setPickupMode(), com.realtime.crossfire.jxclient.settings.options.Pickup.setPickupModeNewMode(), and com.realtime.crossfire.jxclient.settings.options.Pickup.updatePickupMode().

◆ PU_NOTHING

final long com.realtime.crossfire.jxclient.settings.options.Pickup.PU_NOTHING = 0

static

Pickup mode: nothing.

Definition at line 39 of file Pickup.java.

Referenced by com.realtime.crossfire.jxclient.settings.options.PickupOptionOldMode.execute(), com.realtime.crossfire.jxclient.settings.SettingsEntries.getPickupSettingsEntry(), com.realtime.crossfire.jxclient.settings.options.Pickup.Pickup(), com.realtime.crossfire.jxclient.window.JXCConnection.setCharacter(), and com.realtime.crossfire.jxclient.settings.options.Pickup.updatePickupMode().

◆ PU_RATIO

final long com.realtime.crossfire.jxclient.settings.options.Pickup.PU_RATIO = 0x0000000FL

staticprivate

Pickup mode: mask for value/weight ratio.

Definition at line 49 of file Pickup.java.

Referenced by com.realtime.crossfire.jxclient.settings.options.Pickup.updatePickupMode().

The documentation for this class was generated from the following file:

src/gui/src/main/java/com/realtime/crossfire/jxclient/settings/options/Pickup.java