Research Pages (Astral Sorcery)

Description

Add custom Research Pages to the Astral Sorcery Book.

Identifier

Refer to this via any of the following:

mods.astralsorcery.research/* Used as page default */
mods.astralsorcery.Research
mods.astral.research
mods.astral.Research

Adding Entries

• Adds a new node to the given category in the format category, node:

  mods.astralsorcery.research.addNode(ResearchProgression, ResearchNode)

• Adds a connection between two nodes:

  mods.astralsorcery.research.connectNodes(String, String)

• Moves the node with the given name to the x and y co-ords specified in the format name, x, z:

  mods.astralsorcery.research.moveNode(String, int, int)

Example

mods.astralsorcery.research.connectNodes('MY_TEST_RESEARCH2', 'ENHANCED_COLLECTOR')
mods.astralsorcery.research.moveNode('SOOTYMARBLE', 5, 6)

Recipe Builder

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

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

Research Builder

---

• Create a builder to create research pages.

  mods.astralsorcery.research.researchBuilder()

---

• String. Sets the unlocalized name of the node. Requires not null.

  name(String)

• ItemStack. Sets the itemstack representing the node in the category. Requires not null.

  icon(ItemStack)

• List<IJournalPage>. Sets the pages visible within the node.

  page(IJournalPage)

• ResearchProgression. Sets the page the node is located on. Requires not null.

  radiance()
  discovery()
  attunement()
  brilliance()
  exploration()
  constellation()

• Point. Sets the location of the node. Requires not null.

  point(int, int)

• List<ResearchNode>. Sets what other nodes this node is connected to.

  connectionFrom(String)
  connectionFrom(ResearchNode)

---

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

  register()

---

Example

mods.astralsorcery.research.researchBuilder()
    .name('MY_TEST_RESEARCH')
    .point(5,5)
    .icon(item('minecraft:pumpkin'))
    .discovery()
    .page(mods.astralsorcery.research.pageBuilder().textPage('GROOVYSCRIPT.RESEARCH.PAGE.TEST'))
    .page(mods.astralsorcery.research.pageBuilder().emptyPage())
    .connectionFrom('ALTAR1')
    .register()

mods.astralsorcery.research.researchBuilder()
    .name('MY_TEST_RESEARCH2')
    .point(5,5)
    .icon(item('minecraft:pumpkin'))
    .constellation()
    .page(mods.astralsorcery.research.pageBuilder().textPage('GROOVYSCRIPT.RESEARCH.PAGE.TEST2'))
    .page(mods.astralsorcery.research.pageBuilder().constellationRecipePage(item('minecraft:pumpkin')))
    .register()

Removing Entries

• Removes a connection between two nodes:

  mods.astralsorcery.research.disconnectNodes(String, String)

• Removes the node with the given name:

  mods.astralsorcery.research.removeNode(String)

Example

mods.astralsorcery.research.disconnectNodes('MY_TEST_RESEARCH', 'ALTAR1')
mods.astralsorcery.research.removeNode('CPAPER')

Getting the value of entries

• Returns the node with the given name:

  mods.astralsorcery.research.getNode(String)

Contributors

Waiting Idly Nullpinter

Last edited 3 months ago

View full history

80c153e-update docs for GroovyScript 1.2.4 (#38)

481224d-GroovyScript Improvements (#12)

a278ffd-update docs for GroovyScript 1.1.0 (#11)

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