Christopher Peers / Player

Player Library

Diff: Player.h

Revision:
14:f2562b193023
Parent:
12:1324d72d12a6
--- a/Player.h	Thu May 04 09:53:40 2017 +0000
+++ b/Player.h	Thu May 04 11:36:13 2017 +0000
@@ -13,9 +13,29 @@
     
     Player();
     ~Player();
+    
+    /** Initialise Player
+    *
+    *   This function initalises the player library.
+    */
     void init();
+    
+    /** Draw
+    *
+    *   This function draws the Player sprite onto the screen at the specified coordinates.
+    */
     void draw(N5110 &lcd);
+    
+    /** Update
+    *
+    *   This function updates the player sprite position on screen.
+    */
     void update(Direction d,float mag);
+    
+    /** Get Position
+    *
+    *   This function obtains the coordinate of the top-left pixel in the player sprite.
+    */
     Vector2D get_pos();