Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
FoodData FoodProperties FoodPropertiesBuilder FoodPropertiesPossibleEffect
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
FoodData FoodPropertiesBuilder
Next

FoodProperties

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

Members

canAlwaysEat
Getter
script.zs
// FoodProperties.canAlwaysEat as bool
myFoodProperties.canAlwaysEat

Return Type: bool

create
static create(nutrition as int, saturation as float, canAlwaysEat as bool, eatSeconds as float) as FoodProperties
script.zs
// FoodProperties.create(nutrition as int, saturation as float, canAlwaysEat as bool, eatSeconds as float) as FoodProperties;
FoodProperties.create(myInt, myFloat, myBool, myFloat);

Parameters:

nutrition Type: int
saturation Type: float
canAlwaysEat Type: bool
eatSeconds Type: float

Return Type: FoodProperties

static create(nutrition as int, saturation as float, canAlwaysEat as bool, eatSeconds as float, usingConvertsTo as IItemStack) as FoodProperties
script.zs
// FoodProperties.create(nutrition as int, saturation as float, canAlwaysEat as bool, eatSeconds as float, usingConvertsTo as IItemStack) as FoodProperties;
FoodProperties.create(myInt, myFloat, myBool, myFloat, myIItemStack);

Parameters:

nutrition Type: int
saturation Type: float
canAlwaysEat Type: bool
eatSeconds Type: float
usingConvertsTo Type: IItemStack

Return Type: FoodProperties

static create(nutrition as int, saturation as float, canAlwaysEat as bool, eatSeconds as float, usingConvertsTo as IItemStack, effects as List<PossibleEffect>) as FoodProperties
script.zs
// FoodProperties.create(nutrition as int, saturation as float, canAlwaysEat as bool, eatSeconds as float, usingConvertsTo as IItemStack, effects as List<FoodPropertiesPossibleEffect>) as FoodProperties;
FoodProperties.create(myInt, myFloat, myBool, myFloat, myIItemStack, myList);

Parameters:

nutrition Type: int
saturation Type: float
canAlwaysEat Type: bool
eatSeconds Type: float
usingConvertsTo Type: IItemStack
effects Type: List<FoodPropertiesPossibleEffect>

Return Type: FoodProperties

eatSeconds
Getter
script.zs
// FoodProperties.eatSeconds as float
myFoodProperties.eatSeconds

Return Type: float

effects
Getter
script.zs
// FoodProperties.effects as List<FoodPropertiesPossibleEffect>
myFoodProperties.effects

Return Type: List<FoodPropertiesPossibleEffect>

nutrition
Getter
script.zs
// FoodProperties.nutrition as int
myFoodProperties.nutrition

Return Type: int

saturationModifier
Getter
script.zs
// FoodProperties.saturationModifier as float
myFoodProperties.saturationModifier

Return Type: float

usingConvertsTo
Getter
script.zs
// FoodProperties.usingConvertsTo as IItemStack
myFoodProperties.usingConvertsTo

Return Type: IItemStack

withCanAlwaysEat
withCanAlwaysEat(canAlwaysEat as bool) as FoodProperties
script.zs
// FoodProperties.withCanAlwaysEat(canAlwaysEat as bool) as FoodProperties;
myFoodProperties.withCanAlwaysEat(myBool);

Parameters:

canAlwaysEat Type: bool

Return Type: FoodProperties

withEatSeconds
withEatSeconds(eatSeconds as int) as FoodProperties
script.zs
// FoodProperties.withEatSeconds(eatSeconds as int) as FoodProperties;
myFoodProperties.withEatSeconds(myInt);

Parameters:

eatSeconds Type: int

Return Type: FoodProperties

withEffect
withEffect(effect as MobEffectInstance, probability as float) as FoodProperties
script.zs
// FoodProperties.withEffect(effect as MobEffectInstance, probability as float) as FoodProperties;
myFoodProperties.withEffect(myMobEffectInstance, myFloat);

Parameters:

effect Type: MobEffectInstance
probability Type: float

Return Type: FoodProperties

withEffect(effect as PossibleEffect) as FoodProperties
script.zs
// FoodProperties.withEffect(effect as FoodPropertiesPossibleEffect) as FoodProperties;
myFoodProperties.withEffect(myPossibleEffect);

Parameters:

effect Type: FoodPropertiesPossibleEffect

Return Type: FoodProperties

withEffects
withEffects(effects as List<PossibleEffect>) as FoodProperties
script.zs
// FoodProperties.withEffects(effects as List<FoodPropertiesPossibleEffect>) as FoodProperties;
myFoodProperties.withEffects(myList);

Parameters:

effects Type: List<FoodPropertiesPossibleEffect>

Return Type: FoodProperties

withNutrition
withNutrition(nutrition as int) as FoodProperties
script.zs
// FoodProperties.withNutrition(nutrition as int) as FoodProperties;
myFoodProperties.withNutrition(myInt);

Parameters:

nutrition Type: int

Return Type: FoodProperties

withoutEffect
withoutEffect(effect as MobEffect) as FoodProperties
script.zs
// FoodProperties.withoutEffect(effect as MobEffect) as FoodProperties;
myFoodProperties.withoutEffect(myMobEffect);

Parameters:

effect Type: MobEffect

Return Type: FoodProperties

withoutEffect(effect as PossibleEffect) as FoodProperties
script.zs
// FoodProperties.withoutEffect(effect as FoodPropertiesPossibleEffect) as FoodProperties;
myFoodProperties.withoutEffect(myPossibleEffect);

Parameters:

effect Type: FoodPropertiesPossibleEffect

Return Type: FoodProperties

withSaturation
withSaturation(saturation as float) as FoodProperties
script.zs
// FoodProperties.withSaturation(saturation as float) as FoodProperties;
myFoodProperties.withSaturation(myFloat);

Parameters:

saturation Type: float

Return Type: FoodProperties

withUsingConvertsTo
withUsingConvertsTo(usingConvertsTo as IItemStack) as FoodProperties
script.zs
// FoodProperties.withUsingConvertsTo(usingConvertsTo as IItemStack) as FoodProperties;
myFoodProperties.withUsingConvertsTo(myIItemStack);

Parameters:

usingConvertsTo Type: IItemStack

Return Type: FoodProperties

Previous
FoodData FoodPropertiesBuilder
Next