Home Commands Examples Getting Started With Scripts Global Keywords

FoodProperties

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.food.FoodProperties;

Static Methods

Return Type: FoodProperties

script.zs
FoodProperties.create(nutrition as int, saturationModifier as float) as FoodProperties
ParameterType
Parameter
nutrition
Type
int
Parameter
saturationModifier
Type
float

Methods

Return Type: FoodProperties

script.zs
FoodProperties.addEffect(effect as MobEffectInstance, probability as float) as FoodProperties
ParameterType
Parameter
effect
Type
MobEffectInstance
Parameter
probability
Type
float

Return Type: boolean

script.zs
// FoodProperties.canAlwaysEat() as boolean
myFoodProperties.canAlwaysEat();

Return Type: stdlib.List<Pair<MobEffectInstance,float?>>

script.zs
// FoodProperties.getEffects() as stdlib.List<Pair<MobEffectInstance,float?>>
myFoodProperties.getEffects();

Return Type: int

script.zs
// FoodProperties.getNutrition() as int
myFoodProperties.getNutrition();

Return Type: float

script.zs
// FoodProperties.getSaturationModifier() as float
myFoodProperties.getSaturationModifier();

Return Type: boolean

script.zs
// FoodProperties.isFastFood() as boolean
myFoodProperties.isFastFood();

Return Type: boolean

script.zs
// FoodProperties.isMeat() as boolean
myFoodProperties.isMeat();

Return Type: FoodProperties

script.zs
FoodProperties.removeEffect(effect as MobEffect) as FoodProperties
ParameterType
Parameter
effect
Type
MobEffect

Return Type: FoodProperties

script.zs
FoodProperties.removeEffect(effect as MobEffectInstance) as FoodProperties
ParameterType
Parameter
effect
Type
MobEffectInstance

Return Type: FoodProperties

script.zs
FoodProperties.setCanAlwaysEat(canAlwaysEat as boolean) as FoodProperties
ParameterType
Parameter
canAlwaysEat
Type
boolean

Return Type: FoodProperties

script.zs
FoodProperties.setIsFastFood(fastFood as boolean) as FoodProperties
ParameterType
Parameter
fastFood
Type
boolean

Return Type: FoodProperties

script.zs
FoodProperties.setIsMeat(isMeat as boolean) as FoodProperties
ParameterType
Parameter
isMeat
Type
boolean

Return Type: FoodProperties

script.zs
FoodProperties.setNutrition(nutrition as int) as FoodProperties
ParameterType
Parameter
nutrition
Type
int

Return Type: FoodProperties

script.zs
FoodProperties.setSaturationModifier(saturationModifier as float) as FoodProperties
ParameterType
Parameter
saturationModifier
Type
float

Properties

NameTypeHas GetterHas Setter
Name
canAlwaysEat
Type
boolean
Has Getter
true
Has Setter
true
Name
effects
Type
stdlib.List<Pair<MobEffectInstance,float?>>
Has Getter
true
Has Setter
false
Name
isFastFood
Type
boolean
Has Getter
true
Has Setter
true
Name
isMeat
Type
boolean
Has Getter
true
Has Setter
true
Name
nutrition
Type
int
Has Getter
true
Has Setter
true
Name
saturationModifier
Type
float
Has Getter
true
Has Setter
true