Skip to content

Commit

Permalink
Improve the documentation of Enable_Nuke
Browse files Browse the repository at this point in the history
Document what is considered a nuclear weapon. Add links in both
directions between the effect controlling their availability and nuclear
actions.

Requested by Hawk on Discord.
  • Loading branch information
lmoureaux authored and jwrober committed Nov 28, 2024
1 parent 8139f65 commit 81aa4ce
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
12 changes: 12 additions & 0 deletions docs/Modding/Rulesets/actions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -664,6 +664,10 @@ Nuke City
* the actor unit must be on a tile next to the target unless :code:`nuke_city_max_range` allows it to be
further away.

.. note::
Units that can perform this action can only be built when the
:ref:`Enable_Nuke <effect-enable-nuke>` effect is active.

.. _action-conquer-city:

Conquer City
Expand Down Expand Up @@ -1006,6 +1010,10 @@ Nuke Units
* it is in a city.
* it is on a tile with a native Extra.

.. note::
Units that can perform this action can only be built when the
:ref:`Enable_Nuke <effect-enable-nuke>` effect is active.

.. _action-spy-attack:

Spy Attack
Expand Down Expand Up @@ -1047,6 +1055,10 @@ Explode Nuclear
* actor must be on the same tile as the target unless :code:`explode_nuclear_max_range` allows it to be
further away.

.. note::
Units that can perform this action can only be built when the
:ref:`Enable_Nuke <effect-enable-nuke>` effect is active.

.. _action-paradrop-unit:

Paradrop Unit
Expand Down
5 changes: 4 additions & 1 deletion docs/Modding/Rulesets/effects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,10 @@ Gov_Center
.. _effect-enable-nuke:

Enable_Nuke
Allows the production of nuclear weapons.
Allows the production of nuclear weapons (units that can do the
:ref:`Explode Nuclear <action-explode-nuclear>`,
:ref:`Nuke City <action-nuke-city>`, or
:ref:`Nuke Units <action-nuke-units>` actions).

.. _effect-enable-space:

Expand Down

0 comments on commit 81aa4ce

Please sign in to comment.