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

FoodPropertiesBuilder

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

Description

A builder to help create new food properties.

Members

alwaysEdible
alwaysEdible() as Builder
Sets the always edible value of the food properties.

Returns: this builder for chaining.

script.zs
// Builder.alwaysEdible() as FoodPropertiesBuilder;
FoodProperties.Builder.of().alwaysEdible();

Return Type: FoodPropertiesBuilder

build
build() as FoodProperties
Builds the food properties.

Returns: The new food properties.

script.zs
// Builder.build() as FoodProperties;
FoodProperties.Builder.of().build();

Return Type: FoodProperties

implicit as FoodProperties
Builds the food properties.
script.zs
// Builder as FoodProperties
FoodProperties.Builder.of() as FoodProperties

Return Type: FoodProperties

effect
effect(effect as MobEffectInstance, probability as float) as Builder
Adds an effect to the food properties.

Returns: this builder for chaining.

script.zs
// Builder.effect(effect as MobEffectInstance, probability as float) as FoodPropertiesBuilder;
FoodProperties.Builder.of().effect(myMobEffectInstance, myFloat);

Parameters:

effect Type: MobEffectInstance - The effect to add.
probability Type: float - The probability of the effect.

Return Type: FoodPropertiesBuilder

fast
fast() as Builder
Sets the fast eat value of the food properties.

Returns: this builder for chaining.

script.zs
// Builder.fast() as FoodPropertiesBuilder;
FoodProperties.Builder.of().fast();

Return Type: FoodPropertiesBuilder

nutrition
nutrition(nutrition as int) as Builder
Sets the nutrition value of the food properties.

Returns: this builder for chaining.

script.zs
// Builder.nutrition(nutrition as int) as FoodPropertiesBuilder;
FoodProperties.Builder.of().nutrition(myInt);

Parameters:

nutrition Type: int - The new nutrition value.

Return Type: FoodPropertiesBuilder

of
static of() as Builder
Creates a new food properties builder.

Returns: The new food properties builder.

script.zs
// Builder.of() as FoodPropertiesBuilder;
FoodPropertiesBuilder.of();

Return Type: FoodPropertiesBuilder

saturationModifier
saturationModifier(saturationModifier as float) as Builder
Sets the saturation modifier of the food properties.

Returns: this builder for chaining.

script.zs
// Builder.saturationModifier(saturationModifier as float) as FoodPropertiesBuilder;
FoodProperties.Builder.of().saturationModifier(myFloat);

Parameters:

saturationModifier Type: float - The new saturation modifier.

Return Type: FoodPropertiesBuilder

Previous
FoodProperties FoodPropertiesPossibleEffect
Next