hedgewars/uVisualGears.pas
changeset 5121 2d34ec60992c
parent 5065 0c2c509ccc7b
child 5151 cbadb9fa52fc
--- a/hedgewars/uVisualGears.pas	Thu Apr 07 14:13:11 2011 -0400
+++ b/hedgewars/uVisualGears.pas	Thu Apr 07 23:54:09 2011 +0200
@@ -19,6 +19,15 @@
 {$INCLUDE "options.inc"}
 
 unit uVisualGears;
+(*
+ * This unit defines the behavior and the appearance of visual gears.
+ *
+ * Visual gears are "things"/"objects" in the game that do not need to be
+ * perfectly synchronized over all clients since their effect is only
+ * of visual nature.
+ *
+ * E.g.: background flakes, visual effects: explosion, smoke trails, etc.
+ *)
 interface
 uses uConsts, uFloat, GLunit, uTypes;
 
@@ -42,6 +51,8 @@
 
 const cExplFrameTicks = 110;
 
+// For better maintainability the step handlers of visual gears are stored
+// in a separate file.
 {$INCLUDE "VGSHandlers.inc"}
 
 procedure AddDamageTag(X, Y, Damage, Color: LongWord);