MobEffect - CraftTweaker Documentation

Version:

Language:

Home Getting Started With Scripts Commands Examples

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.MobEffect;

Methods

addAttributeModifier

Name: addAttributeModifier

Return Type: MobEffect

ZenScript
 Copy
MobEffect.addAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation) as MobEffect

Parameter	Type	Description
Parameter attribute	Type Attribute	Description No Description Provided
Parameter name	Type string	Description No Description Provided
Parameter value	Type double	Description No Description Provided
Parameter operation	Type AttributeOperation	Description No Description Provided

applyEffectTick

Name: applyEffectTick

Return Type: void

ZenScript
 Copy
MobEffect.applyEffectTick(entity as LivingEntity, amplifier as int) as void

Parameter	Type	Description
Parameter entity	Type LivingEntity	Description No Description Provided
Parameter amplifier	Type int	Description No Description Provided

applyInstantenousEffect

Name: applyInstantenousEffect

Return Type: void

ZenScript
 Copy
MobEffect.applyInstantenousEffect(source as Entity, indirectSource as Entity, target as LivingEntity, amplifier as int, effectiveness as double) as void

Parameter	Type	Description
Parameter source	Type Entity	Description No Description Provided
Parameter indirectSource	Type Entity	Description No Description Provided
Parameter target	Type LivingEntity	Description No Description Provided
Parameter amplifier	Type int	Description No Description Provided
Parameter effectiveness	Type double	Description No Description Provided

getAttributeModifierValue

Name: getAttributeModifierValue

Return Type: double

ZenScript
 Copy
MobEffect.getAttributeModifierValue(amplifier as int, modifier as AttributeModifier) as double

Parameter	Type	Description
Parameter amplifier	Type int	Description No Description Provided
Parameter modifier	Type AttributeModifier	Description No Description Provided

getAttributeModifiers

Name: getAttributeModifiers

Return Type: AttributeModifier[Attribute]

ZenScript
 Copy
// MobEffect.getAttributeModifiers() as AttributeModifier[Attribute]

myMobEffect.getAttributeModifiers();

getCategory

Name: getCategory

Return Type: MobEffectCategory

ZenScript
 Copy
// MobEffect.getCategory() as MobEffectCategory

myMobEffect.getCategory();

getColor

Name: getColor

Return Type: int

ZenScript
 Copy
// MobEffect.getColor() as int

myMobEffect.getColor();

getDescriptionId

Name: getDescriptionId

Return Type: string

ZenScript
 Copy
// MobEffect.getDescriptionId() as string

myMobEffect.getDescriptionId();

getDisplayName

Name: getDisplayName

Return Type: Component

ZenScript
 Copy
// MobEffect.getDisplayName() as Component

myMobEffect.getDisplayName();

isBeneficial

Name: isBeneficial

Return Type: boolean

ZenScript
 Copy
// MobEffect.isBeneficial() as boolean

myMobEffect.isBeneficial();

isDurationEffectTick

Name: isDurationEffectTick

Return Type: boolean

ZenScript
 Copy
MobEffect.isDurationEffectTick(duration as int, amplifier as int) as boolean

Parameter	Type	Description
Parameter duration	Type int	Description No Description Provided
Parameter amplifier	Type int	Description No Description Provided

isInstantenous

Name: isInstantenous

Return Type: boolean

ZenScript
 Copy
// MobEffect.isInstantenous() as boolean

myMobEffect.isInstantenous();

Properties

Name	Type	Has Getter	Has Setter	Description
Name beneficial	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name category	Type MobEffectCategory	Has Getter true	Has Setter false	Description No Description Provided
Name color	Type int	Has Getter true	Has Setter false	Description No Description Provided
Name commandString	Type string	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 displayName	Type Component	Has Getter true	Has Setter false	Description No Description Provided
Name instantenous	Type boolean	Has Getter true	Has Setter false	Description No Description Provided