Skip to content

Commit

Permalink
Improve vision effects docs
Browse files Browse the repository at this point in the history
* Warn that Stealth and Subsurface must be smaller than Main
* Fix the ruleset option name Vision_Layer

See longturn#2459.
  • Loading branch information
lmoureaux authored and jwrober committed Dec 24, 2024
1 parent f50a634 commit 691af7b
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/Modding/Rulesets/effects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -693,20 +693,26 @@ HP_Regen_Min
City_Vision_Radius_Sq
Increase city vision radius in squared distance by AMOUNT tiles.

.. warning::
Vision in the Stealth and Subsurface layers must always be smaller than in the Main layer.

.. note::
This effect is added automatically for VisionLayers other than Main, with a value of 2, and a
VisionLayer=Main requirement is added to any existing instances of this effect. This behaviour can be
turned off by requiring the ``+VisionLayer`` option in :file:`effects.ruleset`, allowing you to use
turned off by requiring the ``+Vision_Layer`` option in :file:`effects.ruleset`, allowing you to use
VisionLayer requirements to specify which layer (Main, Stealth or Subsurface) the effect applies to.

.. _effect-unit-vision-radius-sq:

Unit_Vision_Radius_Sq
Increase unit vision radius in squared distance by AMOUNT tiles.

.. warning::
Vision in the Stealth and Subsurface layers must always be smaller than in the Main layer.

.. note::
A VisionLayer=Main requirement is added automatically to any existing instances of this effect. This
behaviour can be turned off by requiring the ``+VisionLayer`` option in :file:`effects.ruleset`,
behaviour can be turned off by requiring the ``+Vision_Layer`` option in :file:`effects.ruleset`,
allowing you to use VisionLayer requirements to specify which layer (Main, Stealth or Subsurface) the
effect applies to.

Expand Down

0 comments on commit 691af7b

Please sign in to comment.