Package com.pixelmonmod.pixelmon.battles.api.rules.property

Class BooleanBattleProperty

java.lang.Object

com.pixelmonmod.pixelmon.battles.api.rules.property.type.AbstractBooleanProperty

com.pixelmonmod.pixelmon.battles.api.rules.property.BooleanBattleProperty

All Implemented Interfaces:

BattleProperty<Boolean>

public class BooleanBattleProperty
extends AbstractBooleanProperty

Constructor Summary

Constructors

Constructor	Description
BooleanBattleProperty(String id, boolean requiredByClient, Boolean defaultValue)

Method Summary

Modifier and Type	Method	Description
Optional<PropertyValue<Boolean>>	getDefault()	Gets the default value when not supplied If returning an empty optional this means it isn't always required
String	getId()	The id of the property
boolean	requiredByClient()	If the property's value is required by the client for UI logic

Methods inherited from class com.pixelmonmod.pixelmon.battles.api.rules.property.type.AbstractBooleanProperty

getInstance, parse

Methods inherited from class java.lang.Object

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

Constructor Details

BooleanBattleProperty

public BooleanBattleProperty(String id,
 boolean requiredByClient,
 @Nullable
 Boolean defaultValue)

Method Details

getId

public String getId()

Description copied from interface: BattleProperty

The id of the property

Returns:

The id

requiredByClient

public boolean requiredByClient()

Description copied from interface: BattleProperty

If the property's value is required by the client for UI logic

Returns:

True if required by the client

getDefault

public Optional<PropertyValue<Boolean>> getDefault()

Description copied from interface: BattleProperty

Gets the default value when not supplied If returning an empty optional this means it isn't always required

Specified by:

getDefault in interface BattleProperty<Boolean>

Overrides:

getDefault in class AbstractBooleanProperty

Returns:

The default Optional<PropertyValue<T>>