MobEffectInstance

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.

script.zs
import crafttweaker.api.entity.effect.MobEffectInstance;

Implemented Interfaces

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

Static Methods

Return Type: MobEffectInstance

script.zs
MobEffectInstance.load(data as MapData) as MobEffectInstance
ParameterTypeDescription
Parameter
data
Type
MapData
Description
No Description Provided

Methods

Return Type: void

script.zs
MobEffectInstance.applyEffect(entity as LivingEntity) as void
ParameterTypeDescription
Parameter
entity
Type
LivingEntity
Description
No Description Provided

Return Type: int

script.zs
MobEffectInstance.compareTo(other as MobEffectInstance) as int
ParameterTypeDescription
Parameter
other
Type
MobEffectInstance
Description
No Description Provided

Return Type: int

script.zs
// MobEffectInstance.getAmplifier() as int
myMobEffectInstance.getAmplifier();

Return Type: string

script.zs
// MobEffectInstance.getDescriptionId() as string
myMobEffectInstance.getDescriptionId();

Return Type: int

script.zs
// MobEffectInstance.getDuration() as int
myMobEffectInstance.getDuration();

Return Type: MobEffect

script.zs
// MobEffectInstance.getEffect() as MobEffect
myMobEffectInstance.getEffect();

Return Type: boolean

script.zs
// MobEffectInstance.isAmbient() as boolean
myMobEffectInstance.isAmbient();

Return Type: boolean

script.zs
// MobEffectInstance.isNoCounter() as boolean
myMobEffectInstance.isNoCounter();

Return Type: boolean

script.zs
// MobEffectInstance.isVisible() as boolean
myMobEffectInstance.isVisible();

Return Type: MapData

script.zs
MobEffectInstance.save(data as MapData) as MapData
ParameterTypeDescriptionOptionalDefaultValue
Parameter
data
Type
MapData
Description
No Description Provided
Optional
true
DefaultValue

Return Type: void

script.zs
MobEffectInstance.setNoCounter(noCounter as boolean) as void
ParameterTypeDescription
Parameter
noCounter
Type
boolean
Description
No Description Provided

Return Type: boolean

script.zs
// MobEffectInstance.showIcon() as boolean
myMobEffectInstance.showIcon();

Return Type: boolean

script.zs
MobEffectInstance.tick(entity as LivingEntity, onFinish as Runnable) as boolean
ParameterTypeDescriptionOptionalDefaultValue
Parameter
entity
Type
LivingEntity
Description
No Description Provided
Optional
false
DefaultValue
Parameter
onFinish
Type
Runnable
Description
No Description Provided
Optional
true
DefaultValue
() => {}

Return Type: boolean

script.zs
MobEffectInstance.update(instance as MobEffectInstance) as boolean
ParameterTypeDescription
Parameter
instance
Type
MobEffectInstance
Description
No Description Provided

Properties

NameTypeHas GetterHas SetterDescription
Name
ambient
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
amplifier
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
descriptionId
Type
string
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
duration
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
effect
Type
MobEffect
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isNoCounter
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
showIcon
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
visible
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided