Author: sveinung
Date: Thu Aug 7 12:53:51 2014
New Revision: 25843
URL: http://svn.gna.org/viewcvs/freeciv?rev=25843&view=rev
Log:
Rewrite description of action enablers in doc/README.actions
See patch #5018
Modified:
trunk/doc/README.actions
Modified: trunk/doc/README.actions
URL:
http://svn.gna.org/viewcvs/freeciv/trunk/doc/README.actions?rev=25843&r1=25842&r2=25843&view=diff
==============================================================================
--- trunk/doc/README.actions (original)
+++ trunk/doc/README.actions Thu Aug 7 12:53:51 2014
@@ -1,28 +1,39 @@
+Actions
+=======
An action is something a player can do to achieve something in the game.
It has properties like cost, chance of success and effects. Some of those
properties are configurable using effects and other rule set settings. To
learn how to change them read README.effects and the rule set files of
-classic.
+classic. An action enabler allows a player to do an action.
-An action enabler enables a player to do an action. Some actions have rule
-set defined action enablers. For each action that use generalized action
-enablers it is possible to define zero, one or more of them. As long as at
-least one generalized action enabler say it is enabled and nothing in the
-action it self prevents it the player can do the action. If no action
-enablers are defined for an action that use them it is always disabled.
+Generalized action enablers
+===============================
+Some actions have generalized action enablers. An action like that can have
+zero, one or more action enablers defined for it in the ruleset. The player can
+do the action only when at least one generalized action enabler says that the
+action is enabled (and all its hard requirements are fulfilled). A ruleset
+author can therefore disable an action by not defining any action enablers for
+it in his ruleset.
-A generalized action enabler lives in game.ruleset. It consists of the
-action it enables and two requirement vectors. The first requirement
-vector, actor_reqs, applies to the entity doing the action. The second,
-target_reqs, applies to its target. If both requirement vectors are
-fulfilled the action is enabled as far as the action enabler is concerned. A
-hard requirement in the action it self may still disable it. An actions hard
-requirements should be documented.
+A generalized action enabler lives in game.ruleset. It consists of the action
it
+enables and two requirement vectors. The first requirement vector, actor_reqs,
+applies to the entity doing the action. The second, target_reqs, applies to its
+target. If both requirement vectors are fulfilled the action is enabled as far
+as the action enabler is concerned. Note that an action's hard requirements
+still may make it impossible.
+
+In some situations an action controlled by generalized action enablers may be
+impossible because of limitations in Freeciv it self. Those limitations are
+called hard requirements. The hard requirements of each action are documented
+below in the section called "Actions and their hard coded requirements".
If the player don't have the knowledge required to find out if an action is
-enabled or not the action should be shown in case it is. If the player tries
-to do an illegal action the unit will loose a bit movement and the server
-will inform the player that his unit was unable to perform it.
+enabled or not the action is shown to the player in case it is possible. The
+client will indicate the uncertainty to the player.
+
+Should the player order a unit to do an illegal action the unit will loose a
bit
+movement and the server will inform the player that his unit was unable to
+perform the action.
Example
=======
_______________________________________________
Freeciv-commits mailing list
Freeciv-commits@gna.org
https://mail.gna.org/listinfo/freeciv-commits
