Added "Modifying actors" blurb to Battles.md (#420)

FullScreenShenanigans · Feb 21, 2017 · 91258b6 · 91258b6
1 parent dda2eae
commit 91258b6
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/docs/Battles.md b/src/docs/Battles.md
@@ -73,3 +73,12 @@ FSP.battles.startBattle({
 });
 ```
 
+### Modifying actors
+
+Each actor has a `statistics` object with an `{ current: number, normal: number }` describing one of the actor's statistics.
+You can change an actor's statistic by directly modifying those objects via `FSP.battleMover`'s current `battleInfo`.
+
+```javascript
+// Changes the player's current actor to have 9001 attack
+FSP.battleMover.getBattleInfo().teams.player.actors[0].statistics.attack.current = 9001;
+```