Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve vision effects docs #2461

Merged
merged 1 commit into from
Dec 24, 2024
Merged

Improve vision effects docs #2461

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/Modding/Rulesets/effects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,20 +690,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
Loading