Cleanup and documentation

01010111 · 01010111 · commit ba5a231fd2ad · 2019-01-08T11:45:26.000-05:00
diff --git a/zero/ext/flx/FlxTilemapExt.hx b/zero/ext/flx/FlxTilemapExt.hx
@@ -2,20 +2,41 @@ package zero.ext.flx;
 
 import flixel.tile.FlxTilemap;
 import flixel.math.FlxPoint;
-import zero.util.IntPoint;
-import zero.util.Vector;
 
 using Math;
-using zero.ext.FloatExt;
-using zero.ext.flx.FlxPointExt;
 using zero.ext.flx.FlxTilemapExt;
 
 class FlxTilemapExt
 {
 
+	/**
+	 * Returns the tile index at a given point
+	 * @param t	tilemap
+	 * @param p point
+	 * @return Int
+	 */
 	public static inline function get_index_from_point(t:FlxTilemap, p:FlxPoint):Int return t.getTile((p.x / t.get_tile_width()).floor(), (p.y / t.get_tile_height()).floor());
+
+	/**
+	 * Returns a tile's allowCollisions value at a given point
+	 * @param t	tilemap
+	 * @param p	point
+	 * @return Int
+	 */
 	public static inline function get_collisions_from_point(t:FlxTilemap, p:FlxPoint):Int return t.getTileCollisions(t.get_index_from_point(p));
-	public static inline function get_tile_width(t:FlxTilemap) return t.width / t.widthInTiles;
-	public static inline function get_tile_height(t:FlxTilemap) return t.height / t.heightInTiles;
+
+	/**
+	 * Returns the tile width of a tilemap
+	 * @param t tilemap
+	 * @return return
+	 */
+	public static inline function get_tile_width(t:FlxTilemap):Float return t.width / t.widthInTiles;
+
+	/**
+	 * Returns the tile height of a tilemap
+	 * @param t tilemap
+	 * @return return
+	 */
+	public static inline function get_tile_height(t:FlxTilemap):Float return t.height / t.heightInTiles;
 
 }
diff --git a/zero/flxutil/ecs/components/CallbackAfterTimer.hx b/zero/flxutil/ecs/components/CallbackAfterTimer.hx
@@ -8,17 +8,27 @@ class CallbackAfterTimer extends Component
 	var timer:Float = 0;
 	var callback: Void -> Void;
 
+	/**
+	 * Creates a timer object that executes a callback function when time has run out. Use reset() to start timer.
+	 * @param callback	callback function
+	 * @param name 		component name
+	 */
 	public function new(callback:Void -> Void, name:String = 'callback_after_timer')
 	{
 		super(name);
 		this.callback = callback;
 	}
 
+	/**
+	 * Start the timer with a given time
+	 * @param time 
+	 */
 	public function reset(time:Float)
 	{
 		timer = time;
 	}
 
+	@:dox(hide)
 	override public function update(dt:Float)
 	{
 		if (timer <= 0) return;
diff --git a/zero/flxutil/ecs/components/KillAfterAnimation.hx b/zero/flxutil/ecs/components/KillAfterAnimation.hx
@@ -5,14 +5,13 @@ import zero.flxutil.ecs.Component;
 class KillAfterAnimation extends Component
 {
 
-	public function new()
-	{
-		super('kill_after_animation');
-	}
+	/**
+	 * Kills an entity after it's animation is finished
+	 * @return super('kill_after_animation')
+	 */
+	public function new() super('kill_after_animation');
 
-	override public function update(dt:Float)
-	{
-		if (entity.animation.finished) entity.kill();
-	}
+	@:dox(hide)
+	override public function update(dt:Float) if (entity.animation.finished) entity.kill();
 
 }
diff --git a/zero/flxutil/ecs/components/KillAfterTimer.hx b/zero/flxutil/ecs/components/KillAfterTimer.hx
@@ -3,9 +3,10 @@ package zero.flxutil.ecs.components;
 class KillAfterTimer extends CallbackAfterTimer
 { 
 	
-	public function new()
-	{
-		super(function() { entity.kill(); }, 'kill_after_timer');
-	}
+	/**
+	 * Kills an entity after a timer. Use reset() to start timer.
+	 * @return super(function()
+	 */
+	public function new() super(function() { entity.kill(); }, 'kill_after_timer');
 
 }
diff --git a/zero/flxutil/ecs/components/PlatformerWalker.hx b/zero/flxutil/ecs/components/PlatformerWalker.hx
@@ -33,7 +33,8 @@ class PlatformerWalker extends Component
 		entity.maxVelocity.x = walk_speed;
 		drag.x = drag_amt;
 	}
-
+	
+	@:dox(hide)
 	override public function update(dt:Float)
 	{
 		acceleration.x = 0;
diff --git a/zero/flxutil/ecs/components/TopDownWalker.hx b/zero/flxutil/ecs/components/TopDownWalker.hx
@@ -35,7 +35,8 @@ class TopDownWalker extends Component
 		entity.maxVelocity.set(walk_speed, walk_speed);
 		drag.set(drag_amt, drag_amt);
 	}
-
+	
+	@:dox(hide)
 	override public function update(dt:Float)
 	{
 		acceleration.set();
diff --git a/zero/flxutil/formats/BitsyFont.hx b/zero/flxutil/formats/BitsyFont.hx
@@ -1,6 +1,5 @@
 package zero.flxutil.formats;
 
-import haxe.Json;
 import openfl.Assets;
 import flixel.math.FlxPoint;
 import flixel.system.FlxAssets;
diff --git a/zero/flxutil/formats/OgmoLoader.hx b/zero/flxutil/formats/OgmoLoader.hx
@@ -10,7 +10,18 @@ using zero.ext.StringExt;
 class OgmoLoader extends FlxOgmoLoader
 {
 
+	/**
+	 * Returns 2D array of tile ids of a given tile layer
+	 * @param tile_layer 
+	 * @return
+	 */
 	public function get_tilemap_array(tile_layer:String = 'tiles'):Array<Array<Int>> return _fastXml.node.resolve(tile_layer).innerData.csv_to_2d_int_array();
+
+	/**
+	 * Returns CSV of tile ids of a given tile layer
+	 * @param tile_layer 
+	 * @return
+	 */
 	public function get_tilemap_csv(tile_layer:String = 'tiles'):String return _fastXml.node.resolve(tile_layer).innerData;
 
 }
diff --git a/zero/flxutil/formats/ZFont.hx b/zero/flxutil/formats/ZFont.hx
@@ -1,7 +1,6 @@
 package zero.flxutil.formats;
 
 import flixel.math.FlxPoint;
-import flixel.system.FlxAssets;
 import flixel.text.FlxText.FlxTextAlign;
 import haxe.Json;
 import openfl.Assets;
diff --git a/zero/flxutil/shaders/ColorMix.hx b/zero/flxutil/shaders/ColorMix.hx
@@ -19,6 +19,10 @@ class ColorMix extends FlxShader
         }'
     )
 
+    /**
+     * Mixes a sprite with a given color - use color and uMix to update the color and mix amount.
+     * @param color 
+     */
     public function new(color:Int = 0xFFFFFFFF)
     {
         super();
diff --git a/zero/flxutil/shaders/FourColor.hx b/zero/flxutil/shaders/FourColor.hx
@@ -29,12 +29,20 @@ class FourColor extends FlxShader
         }'
     )
 
+    /**
+     * Creates a 4 color palette shader - useful for gameboy-like games!
+     * @param palette 
+     */
     public function new(palette:Array<Int>)
     {
         super();
         set_palette(palette);
     }
 
+	/**
+	 * Sets the palette using an array of four colors (Ints), colors should be ordered from dark to light
+	 * @param palette 
+	 */
 	public function set_palette(palette:Array<Int>)
 	{
 		if (palette.length != 4)
@@ -48,6 +56,11 @@ class FourColor extends FlxShader
 		set_color(WHITE, palette[3]);
 	}
 
+	/**
+	 * Set a specific palette index to the given color
+	 * @param index 
+	 * @param color 
+	 */
 	public function set_color(index:PaletteIndex, color:Int)
 	{
 		switch (index) {
diff --git a/zero/flxutil/sprites/Grid.hx b/zero/flxutil/sprites/Grid.hx
@@ -9,6 +9,10 @@ using Math;
 class Grid extends FlxSprite
 {
 
+	/**
+	 * Creates a sprite and draws a grid on it using given options.
+	 * @param options 
+	 */
 	public function new(options:GridOptions)
 	{
 		super(options.x, options.y);
diff --git a/zero/flxutil/sprites/Stack.hx b/zero/flxutil/sprites/Stack.hx
@@ -21,6 +21,10 @@ class Stack extends FlxSprite
 
 	public var z_offset:Float;
 	
+	/**
+	 * Creates a stack - a set of sprites that fake 3D by layering and offsetting sprites. Use this.add() to add to state!
+	 * @param options 
+	 */
 	public function new(options:StackOptions)
 	{
 		super(options.position.x, options.position.y);
@@ -61,8 +65,14 @@ class Stack extends FlxSprite
 		slice_post_init(slice);
 	}
 
+	/**
+	 * Adds stack to the given state.
+	 * @param state 
+	 * @return state.add(group)
+	 */
 	public function add(state:FlxState) state.add(group);
 
+	@:dox(hide)
 	override public function update(dt:Float)
 	{
 		super.update(dt);
@@ -81,6 +91,10 @@ class Stack extends FlxSprite
 		slice.angle = angle;
 	}
 
+	/**
+	 * Combines this stack with a given stack
+	 * @param stack 
+	 */
 	public function combine(stack:Stack)
 	{
 		StackManager.i.base_group.remove(stack);
@@ -90,6 +104,7 @@ class Stack extends FlxSprite
 	
 }
 
+@:dox(hide)
 class StackGroup extends FlxTypedGroup<FlxSprite>
 {
 
@@ -111,6 +126,7 @@ class StackGroup extends FlxTypedGroup<FlxSprite>
 
 }
 
+@:dox(hide)
 class StackManager
 {
 
diff --git a/zero/flxutil/ui/BitmapText.hx b/zero/flxutil/ui/BitmapText.hx
@@ -1,18 +1,13 @@
 package zero.flxutil.ui;
 
-import haxe.Json;
-import openfl.Assets;
 import flixel.graphics.frames.FlxBitmapFont;
 import flixel.math.FlxPoint;
 import flixel.system.FlxAssets;
 import flixel.text.FlxBitmapText;
 import flixel.text.FlxText.FlxTextAlign;
 import flixel.FlxG;
-import openfl.display.BitmapData;
-import haxe.Utf8;
 
 using Math;
-using StringTools;
 
 /**
  * A wrapper for FlxBitmapText that makes it easy to use a monospaced bitmap font image
diff --git a/zero/flxutil/ui/NineSliceBox.hx b/zero/flxutil/ui/NineSliceBox.hx
@@ -1,17 +1,10 @@
 package zero.flxutil.ui;
 
-import flixel.addons.ui.FlxSlider;
-import flixel.math.FlxRect;
 import flixel.system.FlxAssets;
 import flixel.FlxSprite;
 import flixel.math.FlxPoint;
 import openfl.display.BitmapData;
-import zero.flxutil.util.GameLog.*;
-import zero.util.IntPoint;
 
-using flixel.util.FlxSpriteUtil;
-using zero.ext.FloatExt;
-using zero.ext.flx.FlxSpriteExt;
 using Math;
 
 class NineSliceBox extends FlxSprite
diff --git a/zero/flxutil/ui/RichText.hx b/zero/flxutil/ui/RichText.hx
@@ -1,7 +1,6 @@
 package zero.flxutil.ui;
 
 import flixel.FlxG;
-import flixel.FlxSprite;
 import flixel.group.FlxGroup.FlxTypedGroup;
 import flixel.system.FlxAssets;
 import zero.util.IntPoint;
@@ -31,6 +30,10 @@ class RichText extends FlxTypedGroup<RichTextChar>
 	var override_type_effect:Bool = false;
 	var wiggle_timer:Float = 0;
 
+	/**
+	 * Creates a rich text object for animated text.
+	 * @param options 
+	 */
 	public function new(options:RichTextOptions)
 	{
 		super();
@@ -44,7 +47,7 @@ class RichText extends FlxTypedGroup<RichTextChar>
 		FlxG.watch.add(this, 'wiggle_timer', 'WT:');
 	}
 
-	public function create_defaults(options:RichTextOptions)
+	function create_defaults(options:RichTextOptions)
 	{
 		if (options.position == null) options.position = FlxPoint.get(0, 0);
 		
@@ -84,10 +87,14 @@ class RichText extends FlxTypedGroup<RichTextChar>
 		return options;
 	}
 
-	public function get_anim_options():RichTextAnimOptions return anim_options;
-	public function get_current_color():Int return current_color;
-	public function get_wiggle_timer():Float return wiggle_timer;
+	@:dox(hide) public function get_anim_options():RichTextAnimOptions return anim_options;
+	@:dox(hide) public function get_current_color():Int return current_color;
+	@:dox(hide) public function get_wiggle_timer():Float return wiggle_timer;
 
+	/**
+	 * Enqueues text to be parsed and displayed
+	 * @param s 
+	 */
 	public function queue(s:String)
 	{
 		if (s.length == 0) return;
@@ -96,7 +103,7 @@ class RichText extends FlxTypedGroup<RichTextChar>
 		state = READY;
 	}
 
-	public function parse_input(s:String):Array<String>
+	function parse_input(s:String):Array<String>
 	{	
 		var out = [];
 		var temp_s = parse_new_line_chars(remove_unavailable_characters(s));
@@ -172,6 +179,10 @@ class RichText extends FlxTypedGroup<RichTextChar>
 		return lines.join(' ');
 	}
 
+	/**
+	 * Invokes queued text to be displayed, returns true if there is still text enqueued. Call during text output to interrupt/show all text.
+	 * @return Bool
+	 */
 	public function invoke():Bool
 	{
 		switch (state)
@@ -197,6 +208,7 @@ class RichText extends FlxTypedGroup<RichTextChar>
 		}
 	}
 
+	@:dox(hide)
 	override public function update(dt)
 	{
 		wiggle_timer = (wiggle_timer + dt) % 1;
@@ -312,6 +324,7 @@ class RichText extends FlxTypedGroup<RichTextChar>
 
 }
 
+@:dox(hide)
 class RichTextChar extends Particle
 {
 

Original file line number	Diff line number	Diff line change
`@@ -8,17 +8,27 @@ class CallbackAfterTimer extends Component`
`8`	`8`	`var timer:Float = 0;`
`9`	`9`	`var callback: Void -> Void;`
`10`	`10`
	`11`	`+ /**`
	`12`	`+ * Creates a timer object that executes a callback function when time has run out. Use reset() to start timer.`
	`13`	`+ * @param callback callback function`
	`14`	`+ * @param name component name`
	`15`	`+ */`
`11`	`16`	`public function new(callback:Void -> Void, name:String = 'callback_after_timer')`
`12`	`17`	`{`
`13`	`18`	`super(name);`
`14`	`19`	`this.callback = callback;`
`15`	`20`	`}`
`16`	`21`
	`22`	`+ /**`
	`23`	`+ * Start the timer with a given time`
	`24`	`+ * @param time`
	`25`	`+ */`
`17`	`26`	`public function reset(time:Float)`
`18`	`27`	`{`
`19`	`28`	`timer = time;`
`20`	`29`	`}`
`21`	`30`
	`31`	`+ @:dox(hide)`
`22`	`32`	`override public function update(dt:Float)`
`23`	`33`	`{`
`24`	`34`	`if (timer <= 0) return;`
Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,10 @@ package zero.flxutil.ecs.components;`
`3`	`3`	`class KillAfterTimer extends CallbackAfterTimer`
`4`	`4`	`{`
`5`	`5`
`6`		`- public function new()`
`7`		`- {`
`8`		`- super(function() { entity.kill(); }, 'kill_after_timer');`
`9`		`- }`
	`6`	`+ /**`
	`7`	`+ * Kills an entity after a timer. Use reset() to start timer.`
	`8`	`+ * @return super(function()`
	`9`	`+ */`
	`10`	`+ public function new() super(function() { entity.kill(); }, 'kill_after_timer');`
`10`	`11`
`11`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,8 @@ class PlatformerWalker extends Component`
`33`	`33`	`entity.maxVelocity.x = walk_speed;`
`34`	`34`	`drag.x = drag_amt;`
`35`	`35`	`}`
`36`		`-`
	`36`	`+`
	`37`	`+ @:dox(hide)`
`37`	`38`	`override public function update(dt:Float)`
`38`	`39`	`{`
`39`	`40`	`acceleration.x = 0;`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,8 @@ class TopDownWalker extends Component`
`35`	`35`	`entity.maxVelocity.set(walk_speed, walk_speed);`
`36`	`36`	`drag.set(drag_amt, drag_amt);`
`37`	`37`	`}`
`38`		`-`
	`38`	`+`
	`39`	`+ @:dox(hide)`
`39`	`40`	`override public function update(dt:Float)`
`40`	`41`	`{`
`41`	`42`	`acceleration.set();`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,10 @@ class ColorMix extends FlxShader`
`19`	`19`	`}'`
`20`	`20`	`)`
`21`	`21`
	`22`	`+ /**`
	`23`	`+ * Mixes a sprite with a given color - use color and uMix to update the color and mix amount.`
	`24`	`+ * @param color`
	`25`	`+ */`
`22`	`26`	`public function new(color:Int = 0xFFFFFFFF)`
`23`	`27`	`{`
`24`	`28`	`super();`