From 0ef3162b456b08dd17fc525a614f04486bbedf90 Mon Sep 17 00:00:00 2001 From: Marko Lindqvist Date: Wed, 18 Jan 2023 18:52:17 +0200 Subject: [PATCH 40/40] README.effects: Document maximum length of requirement vector See osdn #46451 Signed-off-by: Marko Lindqvist --- common/fc_types.h | 3 ++- doc/README.effects | 10 ++++++---- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/common/fc_types.h b/common/fc_types.h index 038334c4d0..ffc829bf54 100644 --- a/common/fc_types.h +++ b/common/fc_types.h @@ -376,7 +376,8 @@ struct achievement; struct action; -/* Changing these will break network compatibility. */ +/* Changing these will break network compatibility. + * If changing MAX_NUM_REQS, also update user documentation in README.effects. */ #define SP_MAX 20 #define MAX_NUM_REQS 40 diff --git a/doc/README.effects b/doc/README.effects index 6c05a057d9..50c0727f82 100644 --- a/doc/README.effects +++ b/doc/README.effects @@ -14,11 +14,11 @@ reqs = "Building", "Nuclear Plant", "City", FALSE, FALSE } -The text in the brackets is the entry name, which just has to be unique, but +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 +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, those with present = FALSE must not be present. @@ -46,6 +46,8 @@ can be used if the help system's text is unclear or misleading, or if you want to describe the requirement in your own words. The 'quiet' field has no effect on the game rules. +Single requirement vector can have up to 40 requirements. + Requirement types and supported ranges ====================================== -- 2.39.0