Home Getting Started With Scripts Commands Examples
BracketDumpers BracketHandlers BracketValidators

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
ParameterTypeDescription
Parameter
nutrition
Type
int
Description
No Description Provided
Parameter
saturationModifier
Type
float
Description
No Description Provided

Methods

Return Type: FoodProperties

script.zs
FoodProperties.addEffect(effect as MobEffectInstance, probability as float) as FoodProperties
ParameterTypeDescription
Parameter
effect
Type
MobEffectInstance
Description
No Description Provided
Parameter
probability
Type
float
Description
No Description Provided

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 MobEffectInstance) as FoodProperties
ParameterTypeDescription
Parameter
effect
Type
MobEffectInstance
Description
No Description Provided

Return Type: FoodProperties

script.zs
FoodProperties.setCanAlwaysEat(canAlwaysEat as boolean) as FoodProperties
ParameterTypeDescription
Parameter
canAlwaysEat
Type
boolean
Description
No Description Provided

Return Type: FoodProperties

script.zs
FoodProperties.setIsFastFood(fastFood as boolean) as FoodProperties
ParameterTypeDescription
Parameter
fastFood
Type
boolean
Description
No Description Provided

Return Type: FoodProperties

script.zs
FoodProperties.setIsMeat(isMeat as boolean) as FoodProperties
ParameterTypeDescription
Parameter
isMeat
Type
boolean
Description
No Description Provided

Return Type: FoodProperties

script.zs
FoodProperties.setNutrition(nutrition as int) as FoodProperties
ParameterTypeDescription
Parameter
nutrition
Type
int
Description
No Description Provided

Return Type: FoodProperties

script.zs
FoodProperties.setNutrition(saturationModifier as float) as FoodProperties
ParameterTypeDescription
Parameter
saturationModifier
Type
float
Description
No Description Provided

Properties

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