MobEffectInstance

Link to mobeffectinstance

Importing the class

Link to importing-the-class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
Copy
import crafttweaker.api.entity.effect.MobEffectInstance;

Implemented Interfaces

Link to implemented-interfaces

MobEffectInstance implements the following interfaces. That means all methods defined in these interfaces are also available in MobEffectInstance

Name: load

Return Type: MobEffectInstance

ZenScript
Copy
MobEffectInstance.load(data as MapData) as MobEffectInstance
ParameterType
Parameter
data
Type
MapData
ZenScript
Copy
new MobEffectInstance(mobEffect as MobEffect) as MobEffectInstance
new MobEffectInstance(<mobeffect:minecraft:haste>);
ParameterType
Parameter
mobEffect
Type
MobEffect
ZenScript
Copy
new MobEffectInstance(mobEffect as MobEffect, duration as int) as MobEffectInstance
new MobEffectInstance(<mobeffect:minecraft:haste>, 100);
ParameterType
Parameter
mobEffect
Type
MobEffect
Parameter
duration
Type
int
ZenScript
Copy
new MobEffectInstance(mobEffect as MobEffect, duration as int, amplifier as int) as MobEffectInstance
new MobEffectInstance(<mobeffect:minecraft:haste>, 100, 2);
ParameterType
Parameter
mobEffect
Type
MobEffect
Parameter
duration
Type
int
Parameter
amplifier
Type
int
ZenScript
Copy
new MobEffectInstance(mobEffect as MobEffect, duration as int, amplifier as int, ambient as boolean, visible as boolean) as MobEffectInstance
new MobEffectInstance(<mobeffect:minecraft:haste>, 100, 2, true, false);
ParameterType
Parameter
mobEffect
Type
MobEffect
Parameter
duration
Type
int
Parameter
amplifier
Type
int
Parameter
ambient
Type
boolean
Parameter
visible
Type
boolean
ZenScript
Copy
new MobEffectInstance(mobEffect as MobEffect, duration as int, amplifier as int, ambient as boolean, visible as boolean, showIcon as boolean) as MobEffectInstance
new MobEffectInstance(<mobeffect:minecraft:haste>, 100, 2, true, false, false);
ParameterType
Parameter
mobEffect
Type
MobEffect
Parameter
duration
Type
int
Parameter
amplifier
Type
int
Parameter
ambient
Type
boolean
Parameter
visible
Type
boolean
Parameter
showIcon
Type
boolean
ZenScript
Copy
new MobEffectInstance(mobEffect as MobEffect, duration as int, amplifier as int, ambient as boolean, visible as boolean, showIcon as boolean, hiddenEffect as MobEffectInstance) as MobEffectInstance
new MobEffectInstance(<mobeffect:minecraft:haste>, 100, 2, true, false, false, new MobEffectInstance(<mobeffect:minecraft:haste>, 200, 3));
ParameterType
Parameter
mobEffect
Type
MobEffect
Parameter
duration
Type
int
Parameter
amplifier
Type
int
Parameter
ambient
Type
boolean
Parameter
visible
Type
boolean
Parameter
showIcon
Type
boolean
Parameter
hiddenEffect
Type
MobEffectInstance

Name: compareTo

Return Type: int

ZenScript
Copy
MobEffectInstance.compareTo(other as MobEffectInstance) as int
ParameterType
Parameter
other
Type
MobEffectInstance

Name: getAmplifier

Return Type: int

ZenScript
Copy
// MobEffectInstance.getAmplifier() as int

myMobEffectInstance.getAmplifier();

Link to getDescriptionId

Name: getDescriptionId

Return Type: string

ZenScript
Copy
// MobEffectInstance.getDescriptionId() as string

myMobEffectInstance.getDescriptionId();

Name: getDuration

Return Type: int

ZenScript
Copy
// MobEffectInstance.getDuration() as int

myMobEffectInstance.getDuration();

Name: getEffect

Return Type: MobEffect

ZenScript
Copy
// MobEffectInstance.getEffect() as MobEffect

myMobEffectInstance.getEffect();

Name: isAmbient

Return Type: boolean

ZenScript
Copy
// MobEffectInstance.isAmbient() as boolean

myMobEffectInstance.isAmbient();

Name: isVisible

Return Type: boolean

ZenScript
Copy
// MobEffectInstance.isVisible() as boolean

myMobEffectInstance.isVisible();

Name: save

Return Type: MapData

ZenScript
Copy
MobEffectInstance.save(data as MapData?) as MapData
ParameterTypeOptional
Parameter
data
Type
MapData?
Optional
true

Name: showIcon

Return Type: boolean

ZenScript
Copy
// MobEffectInstance.showIcon() as boolean

myMobEffectInstance.showIcon();

Name: tick

Return Type: boolean

ZenScript
Copy
MobEffectInstance.tick(entity as LivingEntity, onFinish as Runnable?) as boolean
ParameterTypeOptionalDefault Value
Parameter
entity
Type
LivingEntity
Optional
false
Default Value
​
Parameter
onFinish
Type
Runnable?
Optional
true
Default Value
null

Name: update

Return Type: boolean

ZenScript
Copy
MobEffectInstance.update(instance as MobEffectInstance) as boolean
ParameterType
Parameter
instance
Type
MobEffectInstance
NameTypeHas GetterHas Setter
Name
ambient
Type
boolean
Has Getter
true
Has Setter
false
Name
amplifier
Type
int
Has Getter
true
Has Setter
false
Name
descriptionId
Type
string
Has Getter
true
Has Setter
false
Name
duration
Type
int
Has Getter
true
Has Setter
false
Name
effect
Type
MobEffect
Has Getter
true
Has Setter
false
Name
showIcon
Type
boolean
Has Getter
true
Has Setter
false
Name
visible
Type
boolean
Has Getter
true
Has Setter
false