com.pixelmonmod.pixelmon.battles.api.rules

Interface BattleProperty<T>

Type Parameters:

T - The type of the property

All Known Implementing Classes:

AbstractBooleanProperty, AbstractIntegerProperty, BattleTypeProperty, ClausesProperty, FullHealProperty, LevelCapProperty, NumPokemonProperty, OldGenModeProperty, RaiseToCapProperty, TeamPreviewProperty, TeamSelectProperty, TierProperty, TurnTimeProperty

public interface BattleProperty<T>

An interface representing a property (rule) of a battle with the given type

Method Summary

Modifier and Type	Method and Description
java.util.Optional<PropertyValue<T>>	getDefault() Gets the default value when not supplied If returning an empty optional this means it isn't always required
java.lang.String	getId() The id of the property
PropertyValue<T>	getInstance() Gets a new instanceof the PropertyValue
java.util.Optional<PropertyValue<T>>	parse(java.lang.Object o) Attempts to parse the object into a PropertyValue Will return Optional.empty() if fails to parse
boolean	requiredByClient() If the property's value is required by the client for UI logic

Method Detail

getId

java.lang.String getId()

The id of the property

Returns:

The id

requiredByClient

boolean requiredByClient()

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

Returns:

True if required by the client

parse

java.util.Optional<PropertyValue<T>> parse(java.lang.Object o)

Attempts to parse the object into a PropertyValue Will return Optional.empty() if fails to parse

Parameters:

o - The object being parsed

Returns:

The optional PropertyValue

getDefault

java.util.Optional<PropertyValue<T>> getDefault()

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

Returns:

The default Optional>

getInstance

PropertyValue<T> getInstance()

Gets a new instanceof the PropertyValue

Returns:

The new value instance