Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
InstantenousMobEffect MobEffect MobEffectCategory MobEffectInstance MobEffectUtil
Entity EntityAccess EntityDimensions EntityIngredient EntityType HumanoidArm INameTagFunction LivingEntity MobCategory MobSpawnType NameTagResult RemovalReason Shearable Targeting
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
MobEffectCategory MobEffectUtil
Next

MobEffectInstance

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

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

Implements

Undocumented Interfaces

Comparable<MobEffectInstance>

Members

ambient
Getter
script.zs
// MobEffectInstance.ambient as bool
myMobEffectInstance.ambient

Return Type: bool

ambient() as bool
script.zs
// MobEffectInstance.ambient() as bool;
myMobEffectInstance.ambient();

Return Type: bool

amplifier
Getter
script.zs
// MobEffectInstance.amplifier as int
myMobEffectInstance.amplifier

Return Type: int

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

Return Type: int

compareTo
compareTo(other as MobEffectInstance) as int
script.zs
// MobEffectInstance.compareTo(other as MobEffectInstance) as int;
myMobEffectInstance.compareTo(myMobEffectInstance);

Parameters:

other Type: MobEffectInstance

Return Type: int

descriptionId
Getter
script.zs
// MobEffectInstance.descriptionId as string
myMobEffectInstance.descriptionId

Return Type: string

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

Return Type: string

duration
Getter
script.zs
// MobEffectInstance.duration as int
myMobEffectInstance.duration

Return Type: int

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

Return Type: int

effect
Getter
script.zs
// MobEffectInstance.effect as MobEffect
myMobEffectInstance.effect

Return Type: MobEffect

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

Return Type: MobEffect

load
static load(data as MapData) as MobEffectInstance
script.zs
// MobEffectInstance.load(data as MapData) as MobEffectInstance;
MobEffectInstance.load(myMapData);

Parameters:

data Type: MapData

Return Type: MobEffectInstance

of
static of(mobEffect as MobEffect, duration as int = 0, amplifier as int = 0, ambient as bool = false, visible as bool = true, showIcon as bool = true, hiddenEffect as MobEffectInstance = null) as MobEffectInstance
script.zs
// MobEffectInstance.of(mobEffect as MobEffect, duration as int = 0, amplifier as int = 0, ambient as bool = false, visible as bool = true, showIcon as bool = true, hiddenEffect as MobEffectInstance = null) as MobEffectInstance;
MobEffectInstance.of(myMobEffect, myInt, myInt, myBool, myBool, myBool, myMobEffectInstance);

Parameters:

mobEffect Type: MobEffect
duration (optional) Type: int

Default Value: 0

amplifier (optional) Type: int

Default Value: 0

ambient (optional) Type: bool

Default Value: false

visible (optional) Type: bool

Default Value: true

showIcon (optional) Type: bool

Default Value: true

hiddenEffect (optional) Type: MobEffectInstance

Default Value: null

Return Type: MobEffectInstance

save
save() as MapData
script.zs
// MobEffectInstance.save() as MapData;
myMobEffectInstance.save();

Return Type: MapData

showIcon
Getter
script.zs
// MobEffectInstance.showIcon as bool
myMobEffectInstance.showIcon

Return Type: bool

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

Return Type: bool

tick
tick(entity as LivingEntity, onFinish as Runnable = null) as bool
script.zs
// MobEffectInstance.tick(entity as LivingEntity, onFinish as Runnable = null) as bool;
myMobEffectInstance.tick(myLivingEntity, myRunnable);

Parameters:

entity Type: LivingEntity
onFinish (optional) Type: Runnable

Default Value: null

Return Type: bool

update
update(instance as MobEffectInstance) as bool
script.zs
// MobEffectInstance.update(instance as MobEffectInstance) as bool;
myMobEffectInstance.update(myMobEffectInstance);

Parameters:

instance Type: MobEffectInstance

Return Type: bool

visible
Getter
script.zs
// MobEffectInstance.visible as bool
myMobEffectInstance.visible

Return Type: bool

visible() as bool
script.zs
// MobEffectInstance.visible() as bool;
myMobEffectInstance.visible();

Return Type: bool

Previous
MobEffectCategory MobEffectUtil
Next