more documentation on blocks/items

Pokecube-Development · Mar 3, 2021 · ddb2eaa · ddb2eaa
1 parent 45a5c94
commit ddb2eaa
Show file tree

Hide file tree

Showing 11 changed files with 109 additions and 14 deletions.
diff --git a/source/_images/machines_items/afa.png b/source/_images/machines_items/afa.png
diff --git a/source/_images/machines_items/afa_ability_set.png b/source/_images/machines_items/afa_ability_set.png
diff --git a/source/_images/machines_items/afa_no_set.png b/source/_images/machines_items/afa_no_set.png
diff --git a/source/_images/machines_items/afa_shiny_set.png b/source/_images/machines_items/afa_shiny_set.png
diff --git a/source/_images/machines_items/commander.png b/source/_images/machines_items/commander.png
diff --git a/source/_images/machines_items/commander_gui.png b/source/_images/machines_items/commander_gui.png
diff --git a/source/machines_and_items/ability_field_amplifier.rst b/source/machines_and_items/ability_field_amplifier.rst
@@ -4,6 +4,41 @@
 Ability Field Amplifier
 ***********************
 
+.. image:: ../_images/machines_items/afa.*
 
+This block uses Forge Energy to work, and can be powered with the :ref:`siphon`.
+
+The Ability Field Amplifier (AFA) has two uses:
+
+1.  Broadcast an Ability over a volume around the block
+2.  Broadcast Shiny Charm effect around the block (second worst use for shiny charm)
+
+.. figure:: ../_images/machines_items/afa_no_set.png
+   :alt: AFA Gui
+   :name: afa_no_set
+   :width: 600
+
+   The Empty GUI for the AFA, this shows the item slot, as well as the ``<`` and ``>`` buttons used for selecting the range of effect. The Power display is ordered: ``needed/provided``, so if the second number is smaller than the first, then you need to provide more power for the block to work.
+
+To broadcast an ability over a volume, you must first capture a |pokemob| which has the required ability, below are some example abilities, and their effects:
+
+-   ``Honey Gather`` - Applies bonemeal effect on random blocks in range
+-   ``Damp`` - Prevents explosions from detonating in the range
+
+.. figure:: ../_images/machines_items/afa_ability_set.png
+   :alt: AFA Gui with Honey Gather
+   :name: afa_ability_set
+   :width: 600
+
+   Here is an example of setting the ability to Honey Gather, the range is set to 4 blocks, and it currently requires 4 energy per tick, 0 of which is provided.
+
+For the use with a shiny charm, place the charm in the slot, and then select the range in a similar manner.
+
+.. figure:: ../_images/machines_items/afa_shiny_set.png
+   :alt: AFA Gui with Shiny Charm
+   :name: afa_shiny_set
+   :width: 600
+
+   Here is the second worst application of the shiny charm displayed.
 
 .. include:: ../.shared.rst
diff --git a/source/machines_and_items/genetics_machines.rst b/source/machines_and_items/genetics_machines.rst
@@ -28,7 +28,7 @@ This block is used to extract DNA from various sources, including:
 
 .. image:: ../_images/machines_items/gene_extractor_gui.*
 
-To use the extractor, place the source of the DNA in the left most slot (source slot), and then a bottle of water in the bottle slot (top slot). Next place the required selector in the book slot (bottom slot). The machine will then consume Forge Energy, and attempt to extract the selected DNA from the Source into the bottle.
+To use the extractor, place the source of the DNA in the left most slot (source slot), and then a bottle of water in the bottle slot (top slot). Next place the required :ref:`selector <gene_selector>` in the book slot (bottom slot). The machine will then consume Forge Energy, and attempt to extract the selected DNA from the Source into the bottle.
 
 .. warning:: Use with Legendary |pokemobs| is not advised, their DNA is volatile, and liable to be destroyed on extraction!
 

diff --git a/source/machines_and_items/items.rst b/source/machines_and_items/items.rst
@@ -0,0 +1,50 @@
+
+
+************
+Useful Items
+************
+
+.. _location_linker:
+
+###############
+Location Linker
+###############
+
+The location linker is an item which is used to link blocks and mobs to locations. When a block is right clicked with this item, one of two things will occur:
+
+1. In most cases, the location of the block will be stored to the linker, it will also be copied to clipboard, so that it can be pasted into certain GUIs.
+2. In the cases of blocks which accept links, the link interaction for that block will apply instead.
+
+##########
+Exp. Share
+##########
+
+This item will give additional exp to the |pokemob| holding it, so long as a |pokemob| with the same owner gains exp from battle. The |pokemob| holding the Exp. Share must be outside of its |pokecube|, and must not be set to ``Sitting``.
+
+You can get a free Exp. Share from the :ref:`watch_career` page if your pokewatch, and you can buy additional ones from pokemarts when that one breaks.
+
+Note: Currently Exp. Shares have a tendency to break rarely on use, most often when the holder dies with it!
+
+######
+Revive
+######
+
+Revives can be either bought in stores, or crafted by brewing oran berries into bottles of water. Revives have 2 methods of use:
+
+1.  Craft with the |pokecube| containing a fainted |pokemob|, this will revive it.
+2.  Right click a dead |pokemob| before it vanishes, this will revive it.
+
+###########
+Shiny Charm
+###########
+
+This item has 3 uses, only one of which is actually a good idea:
+
+1.  Crafting ingredient for the :ref:`gene_splicer` <-- This is what you should use it for!
+2.  Placing in the :ref:`AFA <afa>` to increase expressions of shiny genes in the area
+3.  Can be wasted on a single |pokemob| to toggle its expressed shiny gene, this is generally a bad idea unless you have too many emeralds
+
+
+
+
+.. include:: ../.shared.rst
diff --git a/source/machines_and_items/location_linker.rst b/source/machines_and_items/location_linker.rst
diff --git a/source/machines_and_items/pokemob_command_block.rst b/source/machines_and_items/pokemob_command_block.rst
@@ -4,7 +4,30 @@
 |Pokemob| Command Block
 ***********************
 
+.. image:: ../_images/machines_items/commander.*
 
+This block allows using redstone signals, or a ComputerCraft interface to issue commands to a |pokemob|. To link a |pokemob| to the commander, you right click it with the cube containing said mob, this page will mostly discuss the redstone signal applications.
 
+.. image:: ../_images/machines_items/commander_gui.*
+
+The commander block has a very simple GUI. It contains the command type to send, and then the arguments for those commands. The arguments will be discussed below for each type of command:
+
+-   ``ATTACKENTITY`` - ``<id>`` - Attacks mob with given entity ID, not really useful as no way to get this with just |Pokecube|
+-   ``ATTACKLOCATION`` - ``<X> <Y> <Z>`` - Tells the |pokemob| to attack the given location, the :ref:`location_linker` can be used to get these coordinates
+-   ``ATTACKNOTHING`` - No arguments, just uses the attack, this can be used for healing/self moves, etc
+-   ``CHANGEMOVEINDEX`` - ``<Index>`` - Changes the selected move for the |pokemob|
+-   ``CHANGEFORM`` - Commands your |pokemob| to change form, similar to the mega evolve key
+-   ``MOVETO`` - ``<X> <Y> <Z> <S>`` - Tells the |pokemob| to move to the given location, with a speed specified by ``<S>``
+-   ``STANCE`` - ``<value> <state>`` - this changes the "stance" of the |pokemob|, ``<value>`` is ``true`` (for on) or ``false`` for (off), and ``<state>`` is one of the following:
+
+    -   ``0``   - Stay on/off
+    -   ``1``   - Guard on/off
+    -   ``2``   - Sit on/off
+    -   ``3``   - Using G/Z Move on/off
+
+-   ``SWAPMOVES`` - ``<A> <B>`` - Swaps moves of index ``<A>`` and ``<B>``
+-   ``TELEPORT``  - No arguments, tells the |pokemob| to use teleport, this will mosty likely teleport the owner to the last selected teleport location, not very useful in general
+
+The command is applied by sending a redstone pulse to the block. Multiple commander blocks can be linked to the same |pokemob|.
 
 .. include:: ../.shared.rst