Browse Source

Added comments to the Chicken example

rsredsq 10 years ago
parent
commit
864b1cce9e

+ 6 - 4
Chickens/Resources/Components/Input.js

@@ -11,13 +11,14 @@ var component = function(self) {
     // Mouse sensitivity as degrees per pixel
     var MOUSE_SENSITIVITY = 0.1;
 
-
+    //start function called when component attached to the node, after constructor
     self.start = function() {
-    
+
         Atomic.audio.listener = node.getComponent("SoundListener");
 
     }
 
+    //update function called once per each frame
     self.update = function(timeStep) {
 
         // Use this frame's mouse motion to adjust camera node yaw and pitch. Clamp the pitch between -90 and 90 degrees
@@ -41,7 +42,7 @@ var component = function(self) {
         if (Atomic.input.getKeyDown(Atomic.KEY_S))
             node.translate([0, 0, -MOVE_SPEED * timeStep]);
         if (Atomic.input.getKeyDown(Atomic.KEY_D))
-            node.translate([MOVE_SPEED * timeStep, 0, 0]);            
+            node.translate([MOVE_SPEED * timeStep, 0, 0]);
         if (Atomic.input.getKeyDown(Atomic.KEY_A))
             node.translate([-MOVE_SPEED * timeStep, 0, 0]);
 
@@ -50,6 +51,7 @@ var component = function(self) {
 
 }
 
+//Math function to get Quaternion from Euler angles
 function QuatFromEuler(x, y, z) {
     var M_PI = 3.14159265358979323846264338327950288;
     var q = [0, 0, 0, 0];
@@ -70,4 +72,4 @@ function QuatFromEuler(x, y, z) {
 }
 
 
-exports.component = component;
+exports.component = component;

+ 9 - 15
Chickens/Resources/Components/Player.js

@@ -5,35 +5,29 @@ var MODEL_ROTATE_SPEED = 100.0;
 
 var component = function(self) {
 
-
     var node = self.node;
     var cluckDelta = Math.random() * 30;
-
+    //Get components
     var animationController = node.getComponent("AnimationController");
     var soundSource = node.getComponent("SoundSource3D");
-
+    //play Walk animation
     animationController.playExclusive("Walk", 0, true);
     animationController.setTime("Walk", Math.random() * 2);
-    
-
-    self.start = function() {
-              
-    }
 
     self.update = function(timeStep) {
-    
+
         if (cluckDelta > 0.0) {
-        
+
             cluckDelta -= timeStep;
-        
+
         } else {
-        
+
             soundSource.play(soundSource.sound);
             cluckDelta = Math.random() * 30 + 2;
-                    
+
         }
-       
 
+        //translate position of node
         node.translate([0, 0, -MODEL_MOVE_SPEED * timeStep]);
 
         var pos = node.position;
@@ -45,4 +39,4 @@ var component = function(self) {
 
 }
 
-exports.component = component;
+exports.component = component;

+ 0 - 16
Chickens/Resources/Components/Spinner.js

@@ -1,16 +0,0 @@
-
-"atomic component";
-
-var inspectorFields = {
-  speed: 1.0
-}
-
-exports.component = function(self) {
-
-  self.update = function(timeStep) {
-
-    self.node.yaw(timeStep * 75 * self.speed);
-
-  }
-
-}

+ 0 - 7
Chickens/Resources/Components/Spinner.js.asset

@@ -1,7 +0,0 @@
-{
-	"version": 1,
-	"guid": "0e0092043026fefe26a773982e4ac9dc",
-	"JavascriptImporter": {
-		"IsComponentFile": true
-	}
-}

+ 2 - 8
Chickens/Resources/Scripts/main.js

@@ -1,10 +1,4 @@
 // This script is the main entry point of the game
 
-var scene = Atomic.player.loadScene("Scenes/Scene.scene");
-
-// called per frame, optional
-function update(timeStep) {
-
-}
-
-exports.update = update;
+//Load a Scene
+Atomic.player.loadScene("Scenes/Scene.scene");