forestry.api.genetics

Interface IAlleleFactory

All Known Implementing Classes:

AlleleFactory

public interface IAlleleFactory

Creates new alleles with smart localization.

UID is created like this: modId + '.' + category + WordUtils.capitalize(valueName); For Example: modId:forestry, category:height, valueName:smallest => forestry.heightSmallest This is mainly for legacy compatibility and may change in future major versions.

The default localization uses: [modId].allele.[valueName]

Languages that need category-specific names can override it by defining: [modId].allele.[category].[valueName]

For example: en_US forestry.allele.smallest=Smallest ru_RU forestry.allele.smallest=????? ????????? forestry.allele.height.smallest=????? ??????

Method Summary

Modifier and Type	Method and Description
IAlleleArea	createArea(java.lang.String modId, java.lang.String category, java.lang.String valueName, net.minecraft.util.math.Vec3i value, boolean isDominant, IChromosomeType... types)
IAlleleBoolean	createBoolean(java.lang.String modId, java.lang.String category, boolean value, boolean isDominant, IChromosomeType... types)
IAlleleFloat	createFloat(java.lang.String modId, java.lang.String category, java.lang.String valueName, float value, boolean isDominant, IChromosomeType... types)
IAlleleFlowers	createFlowers(java.lang.String modId, java.lang.String category, java.lang.String valueName, IFlowerProvider value, boolean isDominant, IChromosomeType... types)
IAlleleInteger	createInteger(java.lang.String modId, java.lang.String category, java.lang.String valueName, int value, boolean isDominant, IChromosomeType... types)

Method Detail

createFloat

IAlleleFloat createFloat(java.lang.String modId,
                         java.lang.String category,
                         java.lang.String valueName,
                         float value,
                         boolean isDominant,
                         IChromosomeType... types)

Parameters:

modId - mod prefix for uid and localization (i.e. "forestry")

category - allele category for uid and localization (i.e. "height")

valueName - allele value name for uid and localization (i.e. "smallest")

value - allele float value

isDominant - allele dominance

types - allele chromosome type for registration (i.e. EnumTreeChromosome.HEIGHT)

Returns:

a new IAlleleFloat, registered with the allele registry.

Since:

Forestry 4.2

createArea

IAlleleArea createArea(java.lang.String modId,
                       java.lang.String category,
                       java.lang.String valueName,
                       net.minecraft.util.math.Vec3i value,
                       boolean isDominant,
                       IChromosomeType... types)

Parameters:

modId - mod prefix for uid and localization (i.e. "forestry")

category - allele category for uid and localization (i.e. "territory")

valueName - allele value name for uid and localization (i.e. "large")

value - allele area x, y, z size

isDominant - allele dominance

types - allele chromosome type for registration (i.e. EnumBeeChromosome.TERRITORY)

Returns:

a new IAlleleArea, registered with the allele registry.

Since:

Forestry 4.2

createInteger

IAlleleInteger createInteger(java.lang.String modId,
                             java.lang.String category,
                             java.lang.String valueName,
                             int value,
                             boolean isDominant,
                             IChromosomeType... types)

Parameters:

modId - mod prefix for uid and localization (i.e. "forestry")

category - allele category for uid and localization (i.e. "fertility")

valueName - allele value name for uid and localization (i.e. "low")

value - allele int value

isDominant - allele dominance

types - allele chromosome type for registration (i.e. EnumBeeChromosome.FERTILITY)

Returns:

a new IAlleleInteger, registered with the allele registry.

Since:

Forestry 4.2

createBoolean

IAlleleBoolean createBoolean(java.lang.String modId,
                             java.lang.String category,
                             boolean value,
                             boolean isDominant,
                             IChromosomeType... types)

Parameters:

modId - mod prefix for uid and localization (i.e. "forestry")

category - allele category for uid and localization (i.e. "fireproof")

value - allele boolean value

isDominant - allele dominance

types - allele chromosome type for registration (i.e. EnumTreeChromosome.FIREPROOF)

Returns:

a new IAlleleBoolean, registered with the allele registry. Note that valueName will always be "true" or "false"

Since:

Forestry 4.2

createFlowers

IAlleleFlowers createFlowers(java.lang.String modId,
                             java.lang.String category,
                             java.lang.String valueName,
                             IFlowerProvider value,
                             boolean isDominant,
                             IChromosomeType... types)

Parameters:

modId - mod prefix for uid (i.e. "forestry")

category - allele category for uid (i.e. "flowers")

valueName - allele value name for uid (i.e. "vanilla")

value - allele IFlowerProvider value

isDominant - allele dominance

types - allele chromosome type for registration (i.e. EnumBeeChromosome.FLOWER_PROVIDER)

Returns:

a new IAlleleFlowers, registered with the allele registry. IAlleleFlowers localization is handled by the IFlowerProvider.getDescription(), unlike the other alleles.

Since:

Forestry 4.2