Package megamek.common.options

Interface IOption

All Superinterfaces:

IBasicOption, IOptionInfo

All Known Implementing Classes:

Option

public interface IOption
extends IBasicOption, IOptionInfo

Interface of the settable option. The settable option is used for game options which relate to game behavior and as well as pilot options which relate to specific stats about a pilot, such as advantages. Game options are the same across all clients. A settable option's primary purpose is to store a value for the option. Its secondary purpose is to give the desired options dialog enough data to allow the user to set the option.

Since:

April 26, 2002, 10:50 AM

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BOOLEAN	Boolean option type
static final int	CHOICE	Choice option type
static final int	FLOAT	Float option type
static final int	INTEGER	Integer option type
static final int	STRING	String option type

Method Summary

Modifier and Type	Method	Description
boolean	booleanValue()	Return the value as the boolean
void	clearValue()	Resets the value to its "default" state
float	floatValue()	Return the value as the float
Object	getDefault()	Returns default option value
IGameOptions	getOwner()	Returns this option container - GameOptions, PilotOptions etc
int	getType()	Returns option type.
int	intValue()	Return the value as the int
void	setValue(boolean value)	Sets the boolean value
void	setValue(float value)	Sets the float value
void	setValue(int value)	Sets the int value
void	setValue(Object value)	Sets the value
void	setValue(String value)	Sets the String value
String	stringValue()	Return the value as the String

Methods inherited from interface megamek.common.options.IBasicOption

getName, getValue, is, isAnyOf, isNoneOf

Methods inherited from interface megamek.common.options.IOptionInfo

getDescription, getDisplayableName, getDisplayableNameWithValue, getTextFieldLength, isLabelBeforeTextField

Field Details

BOOLEAN

static final int BOOLEAN

Boolean option type

See Also:

• Constant Field Values

INTEGER

static final int INTEGER

Integer option type

See Also:

• Constant Field Values

FLOAT

static final int FLOAT

Float option type

See Also:

• Constant Field Values

STRING

static final int STRING

String option type

See Also:

• Constant Field Values

CHOICE

static final int CHOICE

Choice option type

See Also:

• Constant Field Values

Method Details

getOwner

IGameOptions getOwner()

Returns this option container - GameOptions, PilotOptions etc

Returns:

option container

getType

int getType()

Returns option type.

Returns:

option type

See Also:

• etc

getDefault

Object getDefault()

Returns default option value

Returns:

default option value

booleanValue

boolean booleanValue()

Return the value as the boolean

intValue

int intValue()

Return the value as the int

floatValue

float floatValue()

Return the value as the float

stringValue

String stringValue()

Return the value as the String

setValue

void setValue(Object value)

Sets the value

Parameters:

value - value to set

setValue

void setValue(String value)

Sets the String value

Parameters:

value - value to set

setValue

void setValue(boolean value)

Sets the boolean value

Parameters:

value - value to set

setValue

void setValue(int value)

Sets the int value

Parameters:

value - value to set

setValue

void setValue(float value)

Sets the float value

Parameters:

value - value to set

clearValue

void clearValue()

Resets the value to its "default" state