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.
import crafttweaker.api.food.FoodProperties;Description
Represents the properties of a food item.Members
Getter
Gets whether the food can always be eaten.script.zs
// FoodProperties.canAlwaysEat as boolFoodProperties.create(1, 1.0, true, 1.0).canAlwaysEat
Return Type:
bool
static create(nutrition as int, saturation as float, canAlwaysEat as bool, eatSeconds as float) as FoodProperties
Creates a new food properties.script.zs
Returns: The new food properties.
// FoodProperties.create(nutrition as int, saturation as float, canAlwaysEat as bool, eatSeconds as float) as FoodProperties;FoodProperties.create(myInt, myFloat, myBool, myFloat);Parameters:
nutrition: int Type: int
- The nutrition value. saturation: float Type: float
- The saturation value. canAlwaysEat: bool Type: bool
- Whether the food can always be eaten. eatSeconds: float Type: float
- The number of seconds it takes to eat the food.
Return Type:
FoodProperties
static create(nutrition as int, saturation as float, canAlwaysEat as bool, eatSeconds as float, usingConvertsTo as IItemStack) as FoodProperties
Creates a new food properties.script.zs
Returns: The new food properties.
// 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: int Type: int
- The nutrition value. saturation: float Type: float
- The saturation value. canAlwaysEat: bool Type: bool
- Whether the food can always be eaten. eatSeconds: float Type: float
- The number of seconds it takes to eat the food.
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
Creates a new food properties.script.zs
Returns: The new food properties.
// 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: int Type: int
- The nutrition value. saturation: float Type: float
- The saturation value. canAlwaysEat: bool Type: bool
- Whether the food can always be eaten. eatSeconds: float Type: float
- The number of seconds it takes to eat the food. effects: List<FoodPropertiesPossibleEffect> Type: List<FoodPropertiesPossibleEffect>
- The effects that the food applies when eaten.
Return Type:
FoodProperties
Getter
Gets the number of seconds it takes to eat the food.script.zs
// FoodProperties.eatSeconds as floatFoodProperties.create(1, 1.0, true, 1.0).eatSeconds
Return Type:
float
Getter
Gets the effects of the food properties.script.zs
FoodProperties.create(1, 1.0, true, 1.0).effects
Return Type:
List<FoodPropertiesPossibleEffect>
Getter
Gets the nutrition value of the food properties.script.zs
// FoodProperties.nutrition as intFoodProperties.create(1, 1.0, true, 1.0).nutrition
Return Type:
int
Getter
Gets the saturation modifier of the food properties.script.zs
// FoodProperties.saturationModifier as floatFoodProperties.create(1, 1.0, true, 1.0).saturationModifier
Return Type:
float
Getter
Gets the item that the food converts to when eaten.script.zs
// FoodProperties.usingConvertsTo as IItemStackFoodProperties.create(1, 1.0, true, 1.0).usingConvertsTo
Return Type:
IItemStack
withCanAlwaysEat(canAlwaysEat as bool) as FoodProperties
Creates a new food properties based on this instance, with the given can always eat value.script.zs
Returns: The new food properties.
FoodProperties.create(1, 1.0, true, 1.0).withCanAlwaysEat(myBool);Parameters:
canAlwaysEat: bool Type: bool
- The new can always eat value.
Return Type:
FoodProperties
withEatSeconds(eatSeconds as int) as FoodProperties
Creates a new food properties based on this instance, with the given eat seconds value.script.zs
Returns: The new food properties.
FoodProperties.create(1, 1.0, true, 1.0).withEatSeconds(myInt);Parameters:
eatSeconds: int Type: int
- The new eat seconds value.
Return Type:
FoodProperties
withEffect(effect as MobEffectInstance, probability as float) as FoodProperties
Creates a new food properties based on this instance, with the given effect.script.zs
Returns: The new food properties.
FoodProperties.create(1, 1.0, true, 1.0).withEffect(myMobEffectInstance, myFloat);Parameters:
probability: float Type: float
- The probability of the effect.
Return Type:
FoodProperties
withEffect(effect as PossibleEffect) as FoodProperties
Creates a new food properties based on this instance, with the given effect.script.zs
Returns: The new food properties.
FoodProperties.create(1, 1.0, true, 1.0).withEffect(myPossibleEffect);Parameters:
Return Type:
FoodProperties
withEffects(effects as List<PossibleEffect>) as FoodProperties
Creates a new food properties based on this instance, with the given effects.script.zs
Returns: The new food properties.
FoodProperties.create(1, 1.0, true, 1.0).withEffects(myList);Parameters:
effects: List<FoodPropertiesPossibleEffect> Type: List<FoodPropertiesPossibleEffect>
- The new effects.
Return Type:
FoodProperties
withNutrition(nutrition as int) as FoodProperties
Creates a new food properties based on this instance, with the given nutrition value.script.zs
Returns: The new food properties.
FoodProperties.create(1, 1.0, true, 1.0).withNutrition(myInt);Parameters:
nutrition: int Type: int
- The new nutrition value.
Return Type:
FoodProperties
withoutEffect(effect as MobEffect) as FoodProperties
Creates a new food properties based on this instance, without the given effect.script.zs
Returns: The new food properties.
FoodProperties.create(1, 1.0, true, 1.0).withoutEffect(myMobEffect);
Return Type:
FoodProperties
withoutEffect(effect as PossibleEffect) as FoodProperties
Creates a new food properties based on this instance, without the given effect.script.zs
Returns: The new food properties.
FoodProperties.create(1, 1.0, true, 1.0).withoutEffect(myPossibleEffect);Parameters:
Return Type:
FoodProperties
withSaturation(saturation as float) as FoodProperties
Creates a new food properties based on this instance, with the given saturation modifier.script.zs
Returns: The new food properties.
FoodProperties.create(1, 1.0, true, 1.0).withSaturation(myFloat);Parameters:
saturation: float Type: float
- The new saturation modifier.
Return Type:
FoodProperties
withUsingConvertsTo(usingConvertsTo as IItemStack) as FoodProperties
Creates a new food properties based on this instance, with the given using converts to value.script.zs
Returns: The new food properties.
FoodProperties.create(1, 1.0, true, 1.0).withUsingConvertsTo(myIItemStack);Parameters:
Return Type:
FoodProperties