Project

Profile

Help

HostedRedmine.com has moved to the Planio platform. All logins and passwords remained the same. All users will be able to login and use Redmine just as before. *Read more...*

Bug #733917

closed

Quiet Field needs documentation

Added by Griffon Spade almost 5 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Sprint/Milestone:
Start date:
Due date:
% Done:

0%

Estimated time:

Description

"Quiet" field does not appear properly documented (2.6) in the readme.effects.

Specifically, it gives an example, but does not explain it.

The effects.ruleset file contains all effects in play in a Freeciv scenario. 

They have the following form (this is perhaps the most complicated example I 

could find):

[effect_hydro_plant]

type  = "Output_Bonus" 

value = 25

reqs  =

    { "type", "name", "range", "present", "quiet" 

      "Building", "Factory", "City", TRUE, FALSE

      "Building", "Hydro Plant", "City", TRUE, FALSE

      "OutputType", "Shield", "Local", TRUE, TRUE

      "Building", "Hoover Dam", "Player", FALSE, FALSE

      "Building", "Nuclear Plant", "City", FALSE, FALSE

    }

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,

those with present = FALSE must not be present.

Value is integral amount parameter for many effects (must be in the range 

-32767 to 32767).

Requirement range may be one of: "None", "Local",

"CAdjacent" (Cardinally Adjacent), "Adjacent", "City", 

"Continent", "Player", "Allied, "World". Some requirement types may only work at 

certain ranges; this is not yet documented. In particular, at present, 

"Continent" effects can affect only cities and units in cities.

A requirement may have a 'survives' field, and if this 'TRUE', the effect

survives destruction. This is supported for only a few conditions and

ranges: wonders (at world or player range), nations, and advances

(both at world range only).

A requirement may have a 'present' field, and if this is 'FALSE',

the requirement is negated (the condition must not be true for the req to be

met).

"Quiet" should also have a similar paragraph to "Survives" and "Present", starting with:

A requirement may have a 'quiet' field, and if this is 'TRUE',
the requirement (exact details)

http://www.hostedredmine.com/projects/freeciv/repository/revisions/32545 describes it thusly:
Added requirement property 'quiet' that can be used to suppress automatic help generation
from adding information about them.

So would the description paragraph be this? Example:
A requirement may have a 'quiet' field, and if this is 'TRUE',
the requirement property suppresses the automatic help
generation from adding information about them.


Files

m-30-26-req-doc-quiet-flag.patch (973 Bytes) m-30-26-req-doc-quiet-flag.patch Jacob Nevins, 2018-05-28 11:26 AM

Related issues

Blocks Freeciv - Feature #698197: Documentation updates for S2_6Closed

Actions
Actions #1

Updated by Griffon Spade almost 5 years ago

Edit: The last word should be 'it', not 'them'.

Actions #2

Updated by Marko Lindqvist almost 5 years ago

Actions #3

Updated by Jacob Nevins over 4 years ago

See gna patch 4723 for original rationale.

Actions #4

Updated by Jacob Nevins over 4 years ago

  • Tracker changed from Task to Bug
Actions #5

Updated by Jacob Nevins over 4 years ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF