Constellation (Astral Sorcery)

Description

Create a custom Constellation.

Identifier

Refer to this via any of the following:

mods.astralsorcery.constellation/* Used as page default */
mods.astralsorcery.Constellation
mods.astral.constellation
mods.astral.Constellation

Adding Entries

• Adds to the constellations signature items, which control the Constellation Paper and Mantle of Stars recipes. Only the first 4 will be used.:

  mods.astralsorcery.constellation.addSignatureItem(IConstellation, Collection<IIngredient>)

• Adds to the constellations signature items, which control the Constellation Paper and Mantle of Stars recipes. Only the first 4 will be used.:

  mods.astralsorcery.constellation.addSignatureItem(IConstellation, IIngredient)

• Adds to the constellations signature items, which control the Constellation Paper and Mantle of Stars recipes. Only the first 4 will be used.:

  mods.astralsorcery.constellation.addSignatureItem(IConstellation, IIngredient...)

Recipe Builder

Just like other recipe types, the Constellation also uses a recipe builder.

Don't know what a builder is? Check the builder info page out.

mods.astralsorcery.constellation.constellationBuilder()

• String. Sets the name of the Constellation. Requires not null.

  name(String)

• Constellation.ConstellationBuilder.Type. Sets the type of Constellation.

  weak()
  major()
  minor()

• Color. Sets the color of the Constellation. (Default Major: #2843CC, Weak: #432CB0, Minor: #5D197F).

  color(int)

• List<MoonPhase>. Sets what phase of the moon the Constellation appears in. Only applies if the Constellation type is Minor. Requires greater than or equal to 0.

  phase(MoonPhase)
  phase(MoonPhase...)
  phase(Collection<MoonPhase>)

• List<Constellation.Point2PointConnection>. Sets the stars and connections between stars that map the Constellation. Requires greater than or equal to 0.

  connection(int, int, int, int)

• First validates the builder, outputting errors to the log file if the validation failed, then registers the builder.

  register()

Example

mods.astralsorcery.constellation.constellationBuilder()
    .major()
    .name('square')
    .color(0xE01903)
    .connection(12, 2, 2, 2)
    .connection(12, 12, 12, 2)
    .connection(2, 12, 12, 12)
    .connection(2, 2, 2, 12)
    .register()

mods.astralsorcery.constellation.constellationBuilder()
    .minor()
    .name('slow')
    .connection(10, 5, 5, 5)
    .connection(5, 10, 5, 5)
    .connection(3, 3, 3, 3)
    .phase(MoonPhase.FULL)
    .register()

mods.astralsorcery.constellation.constellationMapEffectBuilder()

• List<ConstellationMapEffectRegistry.PotionMapEffect>. Sets the potion effects and strength available via the Stellar Refraction Table. Requires greater than or equal to 0.

  potionEffect(Potion, int, int)

• IConstellation. Sets the Constellation being modified. Requires not null.

  constellation(IConstellation)

• List<ConstellationMapEffectRegistry.EnchantmentMapEffect>. Sets the enchantments and enchantment levels available via the Stellar Refraction Table. Requires greater than or equal to 0.

  enchantmentEffect(Enchantment, int, int)

• First validates the builder, outputting errors to the log file if the validation failed, then registers the builder.

  register()

Example

mods.astralsorcery.constellation.constellationMapEffectBuilder()
    .constellation(constellation('square'))
    .enchantmentEffect(enchantment('minecraft:luck_of_the_sea'), 1, 3)
    .potionEffect(potion('minecraft:luck'), 1, 2)
    .register()

mods.astralsorcery.constellation.signatureItems()

• List<IIngredient>. Sets the signature items of the Constellation.

  addItem(IIngredient)

• boolean. Sets if the default signature items of the Constellation will be removed before adding new ones. (Default false).

  stripItems()

• IConstellation. Sets the Constellation being modified. Requires not null.

  constellation(IConstellation)

• First validates the builder, outputting errors to the log file if the validation failed, then registers the builder.

  register()

Example

mods.astralsorcery.constellation.signatureItems()
    .constellation(constellation('square'))
    .addItem(ore('gemDiamond'))
    .addItem(item('minecraft:water_bucket'))
    .addItem(item('minecraft:rabbit_foot'))
    .addItem(item('minecraft:fish'))
    .register()

Removing Entries

• Removes the given Constellation and all associated attributes:

  mods.astralsorcery.constellation.remove(IConstellation)

• Removes a Constellation's potion and enchantment effects applied via the Stellar Refraction Table:

  mods.astralsorcery.constellation.removeConstellationMapEffect(IConstellation)

• Removes a Constellation's signature items, to be re-added via addSignatureItem:

  mods.astralsorcery.constellation.removeSignatureItems(IConstellation)

• Removes all Constellations:

  mods.astralsorcery.constellation.removeAll()

• Removes all potion and enchantment effects applied via the Stellar Refraction Table for all Constellations:

  mods.astralsorcery.constellation.removeAllConstellationMapEffect()

• Removes all signature items for all Constellations, to be re-added via addSignatureItem:

  mods.astralsorcery.constellation.removeAllSignatureItems()

Example

mods.astralsorcery.constellation.remove(constellation('bootes'))
mods.astralsorcery.constellation.removeConstellationMapEffect(constellation('discidia'))
mods.astralsorcery.constellation.removeSignatureItems(constellation('discidia'))
mods.astralsorcery.constellation.removeAll()
mods.astralsorcery.constellation.removeAllConstellationMapEffect()
mods.astralsorcery.constellation.removeAllSignatureItems()

Getting the value of entries

• Iterates through every Constellation registered, with the ability to call remove on any element to remove it from the game:

  mods.astralsorcery.constellation.streamConstellations()

Contributors

Waiting Idly Nullpinter

Changelog

Last edited 5 months ago

View full history

481224d-GroovyScript Improvements (#12)

a278ffd-update docs for GroovyScript 1.1.0 (#11)

70357c1-docs(en): migrate grs docs (#2)