Changes between Version 62 and Version 63 of EnglishStyleGuide

Timestamp:

Aug 26, 2019, 9:40:20 AM (5 years ago)

Author:

Nescio

Comment:

aura types

EnglishStyleGuide

@@ -206 +206 @@
 
 === Auras
-Auras are JSON files located inside `simulation/data/auras/`.
-
-Use a standarized phrasing in the following contexts:
-
-||='''context'''=||='''phrasing'''=||='''examples'''=||
+Auras are JSON files located inside `simulation/data/auras/`. Auras are temporary, their effects disappear when the aura entity is lost. 
+The shared format for the `auraDescription` is: **"[player] [class] [change] [attributes] [requirements]"**:
+* **[player]**: if and only if an `affectedPlayers` entry is specified; by default auras affect only their own player. Other options are ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/components/Player.js Player.js]): 
+  * `Ally`: player is our ally → Allied and Own
+  * `ExclusiveAlly`: player is our ally excluding ourself → Allied
+  * `MutualAlly`: player is our ally, and we are its ally → Allied and Own
+  * `ExclusiveMutualAlly`: player is our ally, and we are its ally, excluding ourself → Allied
+  * `Enemy`: player is our enemy → Enemy
+* **[class]**: the affected class(es), e.g.:
+  * `"Citizen Infantry"` → Citizen Infantry
+  * `"Siege", "Structure"` → Structures and Siege Engines
+* **[change]**: the actual modifications, e.g.:
+  * `"replace": 0` → have 0
+  * `"multiply": 1.1` → +10%
+  * `"multiply": 0.85` → −15%
+  * `"add": 1` → +1
+  * `"add": -25` → −25
+* **[attributes]**: the modified stats; see [[EnglishStyleGuide#Stats | above]]
+* **[requirements]**: if and only if a `requiredTechnology` is set; specifies the `genericName` of the required technology; e.g.:
+  * `"pop_wonder"` → (requires the “Glorious Expansion” technology) ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/structures/wonder_pop_2.json Glorious Expansion aura])
+ 
+The exact format depends on the aura `type` (see [https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/components/Auras.js Auras.js]):
+* player
+* global
+* range
+* formation
+* garrisonedUnits
+* garrison
+||='''type'''=||='''format'''=||='''examples'''=||
 ||Aura description||[class] [change] [attributes] ([requirements])||Garrisoned Siege Engines +3 health regeneration rate.[[br]]Structures −10% technology resource costs and research time.[[br]]Garrisoned Soldiers +3 armor and +20 vision range.[[br]]+40 maximum population limit (requires the “Glorious Expansion” technology).||
 ||Hero aura description||[class] [change] [attributes]||Workers +15% build rate.[[br]]Temples −25% stone cost and +2 garrison heal rate.[[br]]Soldiers in his formation +3 armor and +15% movement speed.[[br]]Ship he is garrisoned in −30% batch training time and +50% movement speed.[[br]]Champions +2.0 capture attack strength, +20% melee and ranged attack damage, and +10% movement speed.[[br]]Temple of Amun +20% resource costs and build time; Amun Guards +20% resource costs and training time.||
 
 === Technologies
-Technologies are JSON files located inside `simulation/data/technologies/`. All technologies are global and irreversible. Please follow the **"[player] [class] [change] [attributes]"** format, e.g.:
+Technologies are JSON files located inside `simulation/data/technologies/`. All technologies are global and irreversible. Please follow the **"[player] [class] [change] [attributes]"** format (see auras [[EnglishStyleGuide#Auras above]]), e.g.:
 
 `       "tooltip": "Siege Engines +2 hack armor.",` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/technologies/siege_armor.json siege armor])