From 691af7b5f4fa141b74a30aec19bfa2e28c930436 Mon Sep 17 00:00:00 2001 From: Louis Moureaux Date: Mon, 23 Dec 2024 04:24:14 +0100 Subject: [PATCH] Improve vision effects docs * Warn that Stealth and Subsurface must be smaller than Main * Fix the ruleset option name Vision_Layer See #2459. --- docs/Modding/Rulesets/effects.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/Modding/Rulesets/effects.rst b/docs/Modding/Rulesets/effects.rst index 3e33c0c082..6bf5a661c9 100644 --- a/docs/Modding/Rulesets/effects.rst +++ b/docs/Modding/Rulesets/effects.rst @@ -693,10 +693,13 @@ 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: @@ -704,9 +707,12 @@ City_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.