home *** CD-ROM | disk | FTP | other *** search
/ PC Active 2009 July/August / PC Active NR.227.iso / Software / Games / windows / Freeciv-2.1.9-win32-gtk2-setup.exe / doc / README.effects < prev    next >
Encoding:
Text File  |  2009-03-25  |  8.6 KB  |  295 lines
  1. The effects.ruleset file contains all effects in play in a Freeciv scenario. 
  2. They have the following form (this is perhaps the most complicated example I 
  3. could find):
  4.  
  5. [effect_hydro_plant]
  6. name  = "Output_Bonus"
  7. value = 25
  8. reqs  =
  9.     { "type", "name", "range"
  10.       "Building", "Factory", "City"
  11.       "Building", "Hydro Plant", "City"
  12.       "OutputType", "Shield", "Local"
  13.     }
  14. nreqs =
  15.     { "type", "name", "range"
  16.       "Building", "Hoover Dam", "Player"
  17.       "Building", "Nuclear Plant", "City"
  18.     }
  19.  
  20. The text in the brackets is the entry name, which just has to be unique, but 
  21. is otherwise not used. The name field tells Freeciv which effect you are 
  22. defining.  The value is the effect's value, which depends on which effect it 
  23. is. The reqs table contain a list of requirements for this effect being in 
  24. effect. You need to satisfy all requirements listed here for this effect to 
  25. take effect in the game.  Lastly there is the nreqs table which is the 
  26. opposite of the reqs field, these are conditions which prevent the effect from 
  27. taking place. Any one of the nreq conditions will prevent the effect from 
  28. taking effect.
  29.  
  30. Value is integral amount parameter for many effects (must be in the range 
  31. -32767 to 32767).
  32.  
  33. Requirement range may be one of: "None", "Local", "Adjacent", "City", 
  34. "Continent", "Player", "World". Some requirement types may only work at 
  35. certain ranges; this is not yet documented. In particular, at present, 
  36. "Continent" effects can affect only cities and units in cities.
  37.  
  38. A requirement may have a survives field, and if this is '1', the effect 
  39. survives destruction (wonders only).
  40.  
  41. A requirement type is the type of the requirement and can be one of "None" 
  42. (default), "Tech", "Gov", "Building", "Special", "Terrain", "UnitType", 
  43. "UnitFlag", "UnitClass", "Nation", "OutputType" and "MinSize". MinSize is the 
  44. minimum size of a city required.
  45.  
  46. Effect types 
  47. ============
  48.  
  49. Tech_Parasite
  50.     Gain any advance known already by amount number of other players. Note 
  51. that if you have two such effects, they combine into one much worse effect 
  52. (the number of players required to gain an advance is increased).
  53.  
  54. Airlift
  55.     Allow airlift to/from a city.
  56.  
  57. Any_Government
  58.     Allow instant government changes.
  59.  
  60. Capital_City
  61.     The city with this effect is the capital city.
  62.  
  63. Enable_Nuke
  64.     Allows the production of nuclear weapons.
  65.  
  66. Enable_Space
  67.     Allows the production of space components.
  68.  
  69. Specialist_Output
  70.     Specify what outputs a specialist is producing. Should be used with an 
  71. OutputType requirement.
  72.  
  73. Output_Bonus
  74.     City production is increased by amount percent.
  75.  
  76. Output_Bonus_2
  77.     City production is increased by amount percent after Output_Bonus, so is 
  78. multiplicative with it.
  79.  
  80. Output_Add_Tile
  81.     Add amount to each worked tile.
  82.  
  83. Output_Inc_Tile
  84.     Add amount to each worked tile that already has at least 1 output.
  85.  
  86. Output_Per_Tile
  87.     Increase tile output by amount percent.
  88.  
  89. Output_Waste_Pct
  90.     Reduce waste by amount percent.
  91.  
  92. Force_Content
  93.     Make amount' unhappy citizens content. Applied after martial law and unit 
  94. penalties.
  95.  
  96. Give_Imm_Tech
  97.     Give amount techs immediately.
  98.  
  99. Growth_Food
  100.     Food left after cities grow or shrink is amount percent of the capacity of 
  101. the city's foodbox.
  102.  
  103. Have_Embassies
  104.     Like having embassies with all other players.
  105.  
  106. Make_Content
  107.     Make amount unhappy citizens content. Applied before martial law and unit 
  108. penalties.
  109.  
  110. Make_Content_Mil
  111.     Make amount unhappy citizens caused by units outside of a city content.
  112.  
  113. Make_Content_Mil_Per
  114.     Make amount per unit of unhappy citizens caused by units outside of a city 
  115. content.
  116.  
  117. Make_Happy
  118.     Make amount citizens happy.
  119.  
  120. No_Anarchy
  121.     No period of anarchy between government changes.
  122.  
  123. No_Sink_Deep
  124.     Triremes no longer sink when on dangerous seas.
  125.  
  126. Nuke_Proof
  127.     City is nuke proof.
  128.  
  129. Pollu_Pop_Pct
  130.     Increases pollution caused by population by amount percent.
  131.  
  132. Pollu_Prod_Pct
  133.     Increases pollution caused by shields by amount percent.
  134.  
  135. Reveal_Cities
  136.     Immediately make all cities known.
  137.  
  138. Reveal_Map
  139.     Immediately make entire map known.
  140.  
  141. Incite_Cost_Pct
  142.     Increases revolt cost by amount percent.
  143.  
  144. Size_Adj
  145.     Increase maximum size of a city by amount.
  146.  
  147. Size_Unlimit
  148.     Make the size of a city unlimited.
  149.  
  150. SS_Structural, SS_Component and SS_Module
  151.     A part of a spaceship; this is a "Local" ranged effect. It (for now) 
  152. applies to improvements which cannot be built unless "Enable_Space" is felt. 
  153. Buildings which have this effect should probably not be given any other 
  154. effects.
  155.  
  156. Spy_Resistant
  157.     If a spy specifies a target for sabotage, then she has an AMOUNT percent 
  158. chance to fail. Also in diplomatic combat defending diplomatic units in cities 
  159. will get an AMOUNT percent bonus. All Spy_Resistant's are summed before being 
  160. applied.
  161.  
  162. Move_Bonus
  163.     Add amount movement to units. Use UnitClass' requirement with range of 
  164. 'Local' to give it a specific class of units only.
  165.  
  166. Unit_No_Lose_Pop
  167.     No population lost when a city's defender is lost.
  168.  
  169. Unit_Recover
  170.     Units recover amount extra hitpoints per turn.
  171.  
  172. Upgrade_Unit
  173.     Upgrade amount obsolete units per turn.
  174.  
  175. Upkeep_Free
  176.     Improvements with amount or less upkeep cost become free to upkeep (others 
  177. are unaffected).
  178.  
  179. No_Unhappy
  180.     No citizens in the city are ever unhappy.
  181.  
  182. Veteran_Build
  183.     New land units of this type have veteran class 1. The amount value is 
  184. ignored, so that you can have multiple Veteran_Build effects, and units will 
  185. only get 1 free veterancy level. This is considered a feature at the moment.
  186.  
  187. Veteran_Combat
  188.     Increases the chance of units of this type becoming veteran after combat 
  189. by amount percent.
  190.  
  191. HP_Regen
  192.     Units that do not move recover amount percentage of their full hitpoints 
  193. per turn.
  194.  
  195. City_Vision_Radius_Sq
  196.     Increase city vision radius in squared distance by amount tiles.
  197.  
  198. Unit_Vision_Radius_Sq
  199.     Increase unit vision radius in squared distance by amount tiles.
  200.  
  201. Defend_Bonus
  202.     Increases defensive bonuses of units. Any unit requirements on this effect 
  203. will be applied to the _attacking_ unit.
  204.  
  205. No_Incite
  206.     City cannot be incited.
  207.  
  208. Gain_AI_Love
  209.     Gain amount points of "AI love" with AI(s).
  210.  
  211. Slow_Down_Timeline
  212.     Slow down the timeline based on the AMOUNT. If AMOUNT >= 3 the timeline 
  213. will be 1 year/turn; with AMOUNT == 2 it is 2 years/turn; with AMOUNT == 1 it 
  214. is 5 years/turn; with AMOUNT <= 0 the timeline is unaffected. The effect will 
  215. be ignored if game.spacerace isn't set.
  216.  
  217. Civil_War_Chance
  218.     Chance of player splitting due to civil war when capital captured is 
  219. increased by amount.
  220.  
  221. Empire_Size_Mod
  222.     Once your civilization has more cities than amount + the server setting 
  223. 'cityfactor', each city gets one more unhappy citizen.
  224.  
  225. Empire_Size_Step
  226.     After your civilization reaches Empire_Size_Base size, it gets one more 
  227. unhappy citizen for each amount of cities it gets above that. Set to zero to 
  228. disable. You can use Empire_Size_Step even though Empire_Size_Base is zero.
  229.  
  230. Max_Rates
  231.     The maximum setting for each tax rate is amount.
  232.  
  233. Martial_Law_Each
  234.     The amount of citizens pacified by each military unit giving martial law.
  235.  
  236. Martial_Law_Max
  237.     The maximum amount of units that will give martial law in city.
  238.  
  239. Rapture_Grow
  240.     Can rapture grow cities.
  241.  
  242. Unbribable_Units
  243.     Units cannot be bribed.
  244.  
  245. Revolution_When_Unhappy
  246.     If a city owned by this player is in revolt for more than two turns, 
  247. government falls.
  248.  
  249. Has_Senate
  250.     Has a senate that prevents declarations of war in most cases.
  251.  
  252. Inspire_Partisans
  253.     Partisan units (defined in units.ruleset) may spring up when this player's 
  254. cities are taken.
  255.  
  256. Happiness_To_Gold
  257.     Make all Make_Content and Force_Content effects instead generate gold.
  258.  
  259. Fanatics
  260.     Special case for Fanatics unit only.
  261.  
  262. No_Diplomacy
  263.     Cannot use any diplomacy.
  264.  
  265. Trade_Revenue_Bonus
  266.     Trade revenue is multiplied by pow(2, amount/1000). The amount value is 
  267. taken from the caravan's home city.
  268.  
  269. Unhappy_Factor
  270.     Multiply unhappy unit upkeep by amount.
  271.  
  272. Upkeep_Factor
  273.     Multiply unit upkeep by amount.
  274.  
  275. Unit_Upkeep_Free_Per_City
  276.     In each city amount of units are free from upkeep. As usual, you can use 
  277. with OutputType requirement to specify which kind of upkeep this should be.
  278.  
  279. Output_Waste
  280.     Base amount in percentage that each city has in waste. Waste can be used 
  281. with any output type, use an OutputType requirement to specify which.
  282.  
  283. Output_Waste_By_Distance
  284.     For each tile in real distance that a city is from your capital, it gets 
  285. amount of extra waste.
  286.  
  287. Output_Penalty_Tile
  288.     When a tile yields more output than amount, it gets a penalty of -1.
  289.  
  290. Output_Inc_Tile_Celebrate
  291.     Tiles get amount extra output when city working them is celebrating.
  292.  
  293. Visible_Wall
  294.     Positive amount only instructs clients to use wall graphics for city.
  295.