docs

Author: malytomas

csharp/uwapi/prototypes.cs

@@ -54,6 +54,7 @@ public class ProtoUnit : ProtoCommon
         public bool assembler; // the unit must have at least one valid recipe
         public bool emptyNeighbors; // the building requires empty space around
         public bool maximumDistance; // the unit moves to maximum distance when shooting
+        public bool excludeFromMilitary; // the unit is excluded from all-army hotkey
         public bool neutralCategory; // the unit is put in neutral category in lexicon
         public bool explodesWhenAttacks; // suicidal unit
         public bool explodesWhenKilled;

sphinx/source/bots/programOverview.rst

@@ -2,8 +2,38 @@ Program Overview
 ================
 High-level look at basic bot program.
 
-Program Lifecycle
+Accessor Objects
 -----------------
+
+These are globally accessible objects that you use to interact with the game.
+
+.. tab-set::
+   :sync-group: language
+
+   .. tab-item:: Python
+      :sync: python
+
+      - ``uw_admin`` - managing the game server and other players; requires administrator privilege on the game server.
+      - ``uw_commands`` - sending commands and orders to your units, and queries for current orders.
+      - ``uw_events`` - register your callbacks here.
+      - ``uw_game`` - managing game connection, and other settings.
+      - ``uw_map`` - queries about tiles, clusters, etc; data that do *not* change during game.
+      - ``uw_prototypes`` - access to all prototypes; they do *not* change during game.
+      - ``uw_world`` - list all entities, and some additional queries for data that do change during game.
+
+   .. tab-item:: C#
+      :sync: csharp
+
+      - ``Admin`` - managing the game server and other players; requires administrator privilege on the game server.
+      - ``Commands`` - sending commands and orders to your units, and queries for current orders.
+      - ``Events`` - register your callbacks here.
+      - ``Game`` - managing game connection, and other settings.
+      - ``Map`` - queries about tiles, clusters, etc; data that do *not* change during game.
+      - ``Prototypes`` - access to all prototypes; they do *not* change during game.
+      - ``World`` - list all entities, and some additional queries for data that do change during game.
+
+Program Lifetime
+----------------
 At start, you are in full control of the program.
 
 Initialization

sphinx/source/concepts/combat.rst

@@ -1,2 +1,58 @@
 Combat & Upgrades
 =================
+
+Shooting
+--------
+
+todo
+
+Visibility
+^^^^^^^^^^
+
+todo
+
+Elevation
+^^^^^^^^^
+
+todo
+
+Explosions
+----------
+
+A unit may have any combination (or none) of the following triggers:
+
+- ``explodesWhenAttacks`` - suicidal unit.
+- ``explodesWhenKilled`` - explodes when the unit is naturally killed.
+- ``explodesWhenSelfDestructed`` - explodes when the unit receives self-destruct command from owner.
+
+When a unit explodes, it does splash damage in area around it.
+Damage type of the explosion may be different from shooting.
+
+Splash
+------
+
+Splash means the damage is an area-of-effect.
+It is centered at the target of shooting, or at the unit that explodes, and is circular with specified radius.
+
+Damage of splash decreases with distance from center, which is determined by ``splashFractionAtEdge``.
+It may also affect own/ally units, depending on ``splashFractionToFriendly``.
+
+Damage And Armor Types
+----------------------
+
+Each unit has associated armor type, and each shooting (or explosion) has associated damage type.
+The game has a table that defines a fraction for each combination of damage type with each armor type.
+Some values are over 100 % and some are below.
+
+For example, energy shield is designed to be highly resistant to lasers and plasma, which are most often used in long-range guns; and antimatter guns are designed for destroying buildings.
+
+Life Regeneration
+-----------------
+
+Life regeneration has a delay, which is extended whenever the unit is attacked, or whenever the unit itself shoots.
+When the delay expires, the unit starts healing at the specified rate.
+
+Upgrades
+--------
+
+todo

sphinx/source/concepts/entities.rst

@@ -73,7 +73,7 @@ Amount of mana of the unit (or building).
 
 Move Component
 --------------
-Contains information about current movement of the unit.
+Timestamp of when the unit finishes its current movement.
 Information is available for the next neighboring tile only.
 
 Aim Component
@@ -141,7 +141,7 @@ This component contains private information about the force.
 
 Foreign Policy Component
 ------------------------
-This entity declares the policy between two forces.
+This entity declares a policy between two forces.
 
 Diplomacy Proposal Component
 ----------------------------

sphinx/source/concepts/prototypes.rst

@@ -55,3 +55,24 @@ All prototypes may have associated some tags with them.
 Tags are short strings (mapped to unique ids), that are provided by the game/map/mods to help programs understand the nuances of that particular prototype.
 Tags are *not* used by the game, except by the built-in AI/bot, which uses tags to alter behavior of some units.
 Tags may be used by both Bots and Scripts.
+
+- ``ambush`` - walks over additional terrain types.
+- ``artillery`` - longer range than most.
+- ``assault`` - good for front-line combat.
+- ``harassment`` - good for hit-and-run attacks, especially targeting workers.
+- ``home`` - the center of your base. dont let it die.
+- ``miner`` - generates resources, usually from ore deposits.
+- ``navy`` - moves on water only.
+- ``noncombat`` - not intended for combat, even if it has an attack/explosion.
+- ``nonprogression`` - an alternative for another prototype (this tag is used to break cyclic dependencies).
+- ``production`` - produces more units.
+- ``research`` - produces upgrades.
+- ``scout`` - fast and cheap, good as a scout.
+- ``siege`` - designed for destroying buildings.
+- ``splash`` - area-of-effect attack/explosion.
+- ``suicidal`` - sacrifices itself when attacking.
+- ``tank`` - defensive unit with life above typical.
+- ``tower`` - stationary defensive structure.
+- ``volatile`` - may damage own/allied units.
+- ``wall`` - stationary path blocking structure.
+- ``worker`` - carries resources, automatic control by logistics planning.

sphinx/source/concepts/resources.rst

@@ -1,2 +1,4 @@
 Resources & Logistics
 =====================
+
+todo