From 513763c00243268742b0878949fbc5d0a6117399 Mon Sep 17 00:00:00 2001 From: Marko Lindqvist Date: Thu, 24 Aug 2023 14:03:03 +0300 Subject: [PATCH 7/7] README.effects: Clarify that effect values are cumulative Generally rewrite the chapter about effect ruleset entry fields. Reported by omero See osdn #48374 Signed-off-by: Marko Lindqvist --- doc/README.effects | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/README.effects b/doc/README.effects index dcfe8184e9..175822c646 100644 --- a/doc/README.effects +++ b/doc/README.effects @@ -15,11 +15,14 @@ reqs = } The text in the brackets is the entry name, which just has to be unique, but -is otherwise not used. The type field tells Freeciv which effect you are -defining. The value is the effect's value, which depends on which effect it -is. The reqs table contain a list of requirements for this effect being in -effect. You need to satisfy all requirements listed here for this effect to -take effect in the game. Requirements with present = TRUE must be present, +is otherwise not used. The 'type' tells Freeciv which effect type +is being added. If effect is active, 'value' gets added to the total of +the effect type's current value (i.e. values of individial effect entries +are cumulataive.) What that (total) value is actually used for depends +on effect type. The 'reqs' table contain a list of requirements for +this effect being in active. You need to satisfy all requirements +listed here for this effect to take effect in the game. +Requirements with present = TRUE must be present, those with present = FALSE must not be present. Value is integral amount parameter for many effects (must be in the range -- 2.40.1