LUADOC - Farming Simulator 17

Printable Version

FruitUtil

Description
FruitUtil
Functions

registerFruitType

Description
Register fruit type
Definition
registerFruitType(string name, string nameI18N, integer category, boolean needsSeeding, boolean allowsSeeding, boolean useSeedingWidth, float directionSnapAngle, boolean alignsToSun, integer minHarvestingGrowthState, integer maxHarvestingGrowthState, integer cutState, boolean allowsPartialGrowthState, float pricePerLiter, float literPerSqm, float seedUsagePerSqm, boolean showOnPriceTable, string hudOverlayFilename, string hudOverlayFilenameSmall, boolean shownOnMap, float massPerLiter, float maxPhysicalSurfaceAngle, boolean useForFieldJob, integer minForageGrowthState)
Arguments
stringnamename
stringnameI18Nname in I18N
integercategorycategory id
booleanneedsSeedingneeds seeding
booleanallowsSeedingallows seeding
booleanuseSeedingWidthuse seeding width
floatdirectionSnapAngledirection snap angle
booleanalignsToSunaligns to sun
integerminHarvestingGrowthStatemin harvesting growth state
integermaxHarvestingGrowthStatemax harvesting growth state
integercutStatecut state
booleanallowsPartialGrowthStateallows partial growth state
floatpricePerLiterprice per liter
floatliterPerSqmliter per sqm
floatseedUsagePerSqmseed usage per sqm
booleanshowOnPriceTableshow on price table
stringhudOverlayFilenamehud overlay file name
stringhudOverlayFilenameSmallhud overlay file name small
booleanshownOnMapshow on map
floatmassPerLitermass per liter
floatmaxPhysicalSurfaceAnglemax physical surface angle
booleanuseForFieldJobuse for field job
integerminForageGrowthStatemin forage growth state
Return Values
integerfruitTypeIndexfruit type index

registerFruitTypeWindrow

Description
Register fruit type windrow
Definition
registerFruitTypeWindrow(integer fruitType, string windrowName, string windrowNameI18N, integer category, float windrowPricePerLiter, float windrowLiterPerSqm, boolean windrowShowOnPriceTable, string windrowHudOverlayFilename, string windrowHudOverlayFilenameSmall, float massPerLiter, float maxPhysicalSurfaceAngle)
Arguments
integerfruitTypefruit type index
stringwindrowNamewindrow name
stringwindrowNameI18Nwindrow name in I18N
integercategorycategory id
floatwindrowPricePerLiterprice per liter
floatwindrowLiterPerSqmliter per sqm
booleanwindrowShowOnPriceTableshow on price table
stringwindrowHudOverlayFilenamewindrow hud overlay file name
stringwindrowHudOverlayFilenameSmallwindrow hud overlay file name small
floatmassPerLitermass per liter
floatmaxPhysicalSurfaceAnglemax physical surface angle

setFruitTypeWindrow

Description
Set fruit type windrow
Definition
setFruitTypeWindrow(integer fruitType, integer windrowFillType, float litersPerSqm)
Arguments
integerfruitTypefruit type index
integerwindrowFillTypewindrow fill type
floatlitersPerSqmliter per sqm

registerFruitTypePreparing

Description
Register fruit type preparing
Definition
registerFruitTypePreparing(integer fruitType, string preparingOutputName, integer minPreparingGrowthState, integer maxPreparingGrowthState, integer preparedGrowthState)
Arguments
integerfruitTypefruit type index
stringpreparingOutputNamepreparing output name
integerminPreparingGrowthStatemin preparing growth state
integermaxPreparingGrowthStatemax preparing growth state
integerpreparedGrowthStateprepared growth state

registerFruitTypeWindrowForageWagonConversion

Description
Register fruit type windrow forage conversion
Definition
registerFruitTypeWindrowForageWagonConversion(integer fruitTypeSrc, integer fruitTypeDst)
Arguments
integerfruitTypeSrcfruit type source
integerfruitTypeDstfruit type destination

registerFruitTypeGrowth

Description
Register fruit type growth
Definition
registerFruitTypeGrowth(string name, integer witheringNumGrowthStates, integer numGrowthStates, integer growthStateTime, boolean resetsSpray, integer groundTypeChangeGrowthState, integer groundTypeChanged)
Arguments
stringnamename of fruit type
integerwitheringNumGrowthStatesnumber of withering growth states
integernumGrowthStatesnumber of growth states
integergrowthStateTimegrowth state time
booleanresetsSprayreset spray
integergroundTypeChangeGrowthStateground type change growth state
integergroundTypeChangedground type changed

getFillTypeLiterPerSqm

Description
Get fill type liter per sqm
Definition
getFillTypeLiterPerSqm(integer fillType, float defaultValue)
Arguments
integerfillTypefill type
floatdefaultValuedefault value if fill type not found
Return Values
floatliterPerSqmliter per sqm

registerFruitTypeCategory

Description
Register fruit type category
Definition
registerFruitTypeCategory(string name)
Arguments
stringnamename
Return Values
integercategoryIndexindex of category

addFruitTypeToCategory

Description
Add fruit type to category
Definition
addFruitTypeToCategory(integer category, integer fruitType)
Arguments
integercategoryindex of category
integerfruitTypeindex of fruit type

getFruitTypeByCategoryName

Description
Get fruit type by category name
Definition
getFruitTypeByCategoryName(string fruitTypeCategories, string warning)
Arguments
stringfruitTypeCategoriescategory names
stringwarningwarning
Return Values
tablefruitTypesfruit types

getFruitTypesByNames

Description
Get fruit type by category name
Definition
getFruitTypesByNames(string names, string warning)
Arguments
stringnamesfruit type names
stringwarningwarning
Return Values
tablefruitTypesfruit types

registerFruitTypeConverter

Description
Register fruit type conversion
Definition
registerFruitTypeConverter(string name)
Arguments
stringnamename
Return Values
integerconverterIndexindex of converterIndex

addFruitToFillTypeConversion

Description
Add fruit type to fill type conversion
Definition
addFruitToFillTypeConversion(integer category, integer fruitTypeSource, integer fillTypeTarget, float conversionFactor, float windrowConversionFactor)
Arguments
integercategoryindex of category
integerfruitTypeSourcefruit type source
integerfillTypeTargetfill type target
floatconversionFactorfactor of conversion
floatwindrowConversionFactorfactor of windrow conversion