Interface MobEffectDefinition.Builder

Enclosing interface:

MobEffectDefinition

@NonExtendable
public static interface MobEffectDefinition.Builder

Builds a MobEffectDefinition.

Since:

0.1.0

Method Summary

Modifier and Type	Method	Description
MobEffectDefinition.Builder	behaviour(MobEffectBehaviour behaviour)
MobEffectDefinition	build()	Returns the definition, to hand to MobEffectRegistry.register(MobEffectDefinition, Plugin).
MobEffectDefinition.Builder	category(MobEffectDefinition.Category category)
MobEffectDefinition.Builder	fallback(TypedKey<MobEffect> fallback)
MobEffectDefinition.Builder	knownBy(Predicate<Player> knownBy)
MobEffectDefinition.Builder	networkId(int networkId)	Asks for a fixed network ID, to match the one the client mod gives the effect.

Method Details

category

MobEffectDefinition.Builder category(MobEffectDefinition.Category category)

Parameters:

category - whether the effect helps or harms; MobEffectDefinition.Category.NEUTRAL by default

Returns:

this builder

Since:

0.1.0

fallback

MobEffectDefinition.Builder fallback(TypedKey<MobEffect> fallback)

Parameters:

fallback - the vanilla effect shown to clients that do not know this one

Returns:

this builder

Throws:

IllegalArgumentException - if fallback is not a vanilla effect

Since:

0.1.0

knownBy

MobEffectDefinition.Builder knownBy(Predicate<Player> knownBy)

Parameters:

knownBy - picks the players whose client knows this effect; nobody by default

Returns:

this builder

Since:

0.1.0

networkId

MobEffectDefinition.Builder networkId(int networkId)

Asks for a fixed network ID, to match the one the client mod gives the effect.

Parameters:

networkId - the network ID, after the vanilla effects

Returns:

this builder

Since:

0.1.0

behaviour

MobEffectDefinition.Builder behaviour(MobEffectBehaviour behaviour)

Parameters:

behaviour - what the effect does; nothing by default

Returns:

this builder

Since:

0.1.0

build

MobEffectDefinition build()

Returns the definition, to hand to MobEffectRegistry.register(MobEffectDefinition, Plugin).

Returns:

the definition, to hand to MobEffectRegistry.register(MobEffectDefinition, Plugin)

Since:

0.1.0