Package com.binaris.wizardry.api.content.spell.properties

Class SpellProperty<T>

java.lang.Object

com.binaris.wizardry.api.content.spell.properties.SpellProperty<T>

Type Parameters:

T - The type of the property's value.

public class SpellProperty<T>
extends Object

A class representing a property of a spell, such as its cost or cooldown. Each property has a type (e.g. Integer, Float, Boolean), a default value, and a current value, these properties are identified by a unique string.

Properties can be created using the static factory methods provided, such as intProperty(String) or booleanProperty(String, boolean). Once created, the property's value can be accessed and modified using the get() and set(Object) methods respectively. (Check DefaultProperties for examples of predefined properties.)

See Also:

• DefaultProperties
• SpellProperties.builder()

Field Summary

Fields

Modifier and Type	Field	Description
protected T	defaultValue
protected String	identifier
protected IPropertyType<T>	type
protected T	value

Method Summary

Modifier and Type	Method	Description
static SpellProperty<Boolean>	booleanProperty(String id)
static SpellProperty<Boolean>	booleanProperty(String id, boolean value)
static SpellProperty<Byte>	byteProperty(String id)
static SpellProperty<Byte>	byteProperty(String id, byte value)
static SpellProperty<Map<String,Boolean>>	contextMapProperty(String id, Map<String,Boolean> value)
SpellProperty<T>	copyOf()
protected static <T> SpellProperty<T>	createProperty(String identifier, T defaultValue, IPropertyType<T> type)
static SpellProperty<Double>	doubleProperty(String id)
static SpellProperty<Double>	doubleProperty(String id, double value)
boolean	equals(Object obj)
static SpellProperty<Float>	floatProperty(String id)
static SpellProperty<Float>	floatProperty(String id, float value)
static @Nullable SpellProperty<?>	fromID(String identifier)
T	get()
T	getDefaultValue()
String	getIdentifier()
static SpellProperty<Integer>	intProperty(String id)
static SpellProperty<Integer>	intProperty(String id, int value)
static SpellProperty<Long>	longProperty(String id)
static SpellProperty<Long>	longProperty(String id, long value)
void	set(T value)
static SpellProperty<Short>	shortProperty(String id)
static SpellProperty<Short>	shortProperty(String id, short value)
static SpellProperty<String>	stringProperty(String id)
static SpellProperty<String>	stringProperty(String id, String value)

Methods inherited from class java.lang.Object

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

Field Details

identifier

protected String identifier

value

protected T value

defaultValue

protected T defaultValue

type

protected IPropertyType<T> type

Method Details

byteProperty

public static SpellProperty<Byte> byteProperty(String id)

shortProperty

public static SpellProperty<Short> shortProperty(String id)

intProperty

public static SpellProperty<Integer> intProperty(String id)

longProperty

public static SpellProperty<Long> longProperty(String id)

floatProperty

public static SpellProperty<Float> floatProperty(String id)

doubleProperty

public static SpellProperty<Double> doubleProperty(String id)

booleanProperty

public static SpellProperty<Boolean> booleanProperty(String id)

stringProperty

public static SpellProperty<String> stringProperty(String id)

byteProperty

public static SpellProperty<Byte> byteProperty(String id,
 byte value)

shortProperty

public static SpellProperty<Short> shortProperty(String id,
 short value)

intProperty

public static SpellProperty<Integer> intProperty(String id,
 int value)

longProperty

public static SpellProperty<Long> longProperty(String id,
 long value)

floatProperty

public static SpellProperty<Float> floatProperty(String id,
 float value)

doubleProperty

public static SpellProperty<Double> doubleProperty(String id,
 double value)

booleanProperty

public static SpellProperty<Boolean> booleanProperty(String id,
 boolean value)

stringProperty

public static SpellProperty<String> stringProperty(String id,
 String value)

contextMapProperty

public static SpellProperty<Map<String,Boolean>> contextMapProperty(String id,
 Map<String,Boolean> value)

createProperty

protected static <T> SpellProperty<T> createProperty(String identifier,
 T defaultValue,
 IPropertyType<T> type)

fromID

@Nullable
public static @Nullable SpellProperty<?> fromID(String identifier)

get

public T get()

getIdentifier

public String getIdentifier()

set

public void set(T value)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getDefaultValue

public T getDefaultValue()

copyOf

public SpellProperty<T> copyOf()