From ea2587792b1b46eaaeab58c445abde9edbf163fd Mon Sep 17 00:00:00 2001 From: George FunBook Date: Tue, 28 May 2024 23:45:51 -0500 Subject: [PATCH] prevent breaking changes + doc --- flixel/path/FlxBasePath.hx | 64 +++++++++++++++-------------- flixel/path/FlxPath.hx | 83 ++++++++++++++++++++------------------ 2 files changed, 78 insertions(+), 69 deletions(-) diff --git a/flixel/path/FlxBasePath.hx b/flixel/path/FlxBasePath.hx index 8dfb483d41..96a7b20f79 100644 --- a/flixel/path/FlxBasePath.hx +++ b/flixel/path/FlxBasePath.hx @@ -10,7 +10,8 @@ import flixel.util.FlxSignal; import flixel.util.FlxSpriteUtil; import openfl.display.Graphics; -class FlxBasePath extends FlxBasic implements IFlxDestroyable +typedef FlxBasePath = FlxTypedBasePath; +class FlxTypedBasePath extends FlxBasic implements IFlxDestroyable { /** * The list of FlxPoints that make up the path data. @@ -22,24 +23,31 @@ class FlxBasePath extends FlxBasic implements IFlxDestroyable public var length(get, never):Int; public var finished(get, never):Bool; - public var onComplete(default, null) = new FlxTypedSignal<(FlxBasePath)->Void>(); + /** Called whenenever the end is reached, for YOYO this means both ends */ + public var onPathComplete(default, null) = new FlxTypedSignal<(FlxTypedBasePath)->Void>(); - /** - * Tracks which node of the path this object is currently moving toward. - */ + /** The index of the last node the target has reached */ public var currentIndex(default, null):Int = 0; + /** The index of the node the target is currently moving toward */ public var nextIndex(default, null):Null = null; + /** The last node the target has reached */ public var current(get, never):Null; + /** The node the target is currently moving toward */ public var next(get, never):Null; - /** - * Path behavior flag (like looping, yoyo, etc) - */ + /** Behavior when the end(s) are reached */ public var loop:FlxPathLoop = LOOP; - public var direction = FlxPathDirection.FORWARD; + /** The direction the list of nodes is being traversed. `FORWARD` leads to the last node */ + public var direction(default, null) = FlxPathDirection.FORWARD; + /** + * Creates a new path + * + * @param nodes An Optional array of nodes + * @param target + */ public function new (?nodes:Array, ?target:TTarget) { this.nodes = nodes; @@ -50,17 +58,14 @@ class FlxBasePath extends FlxBasic implements IFlxDestroyable restartPath(); } - /** - * Clean up memory. - */ override function destroy():Void { FlxDestroyUtil.putArray(nodes); nodes = null; - onComplete.removeAll(); + onPathComplete.removeAll(); } - public function restartPath(direction = FlxPathDirection.FORWARD):FlxBasePath + public function restartPath(direction = FlxPathDirection.FORWARD):FlxTypedBasePath { this.direction = direction; currentIndex = getStartingNode(); @@ -86,6 +91,10 @@ class FlxBasePath extends FlxBasic implements IFlxDestroyable setNextIndex(); } + /** + * Determines the next index based on the current index and direction. + * Fires onPathComplete if the end is reached + */ function setNextIndex() { // reached last @@ -99,7 +108,7 @@ class FlxBasePath extends FlxBasic implements IFlxDestroyable direction = BACKWARD; currentIndex - 1; } - onComplete.dispatch(this); + onPathComplete.dispatch(this); return; } @@ -114,7 +123,7 @@ class FlxBasePath extends FlxBasic implements IFlxDestroyable direction = FORWARD; currentIndex + 1; } - onComplete.dispatch(this); + onPathComplete.dispatch(this); return; } @@ -124,9 +133,10 @@ class FlxBasePath extends FlxBasic implements IFlxDestroyable /** * Change the path node this object is currently at. * - * @param index The index of the new node out of path.nodes. + * @param index The index of the new node out of path.nodes. + * @param direction Whether to head towards the head or the tail */ - public function startAt(index:Int, ?direction:FlxPathDirection):FlxBasePath + public function startAt(index:Int, ?direction:FlxPathDirection):FlxTypedBasePath { if (direction != null) this.direction = direction; @@ -149,6 +159,8 @@ class FlxBasePath extends FlxBasic implements IFlxDestroyable if (isTargetAtNext(elapsed)) { advance(); + if (finished) + return; } updateTarget(elapsed); @@ -183,8 +195,6 @@ class FlxBasePath extends FlxBasic implements IFlxDestroyable return nodes != null ? nodes[nextIndex] : null; } - - #if FLX_DEBUG /** * Specify a debug display color for the path. Default is WHITE. @@ -310,19 +320,13 @@ class FlxBasePath extends FlxBasic implements IFlxDestroyable */ enum abstract FlxPathLoop(Int) from Int to Int { - /** - * Move from the start of the path to the end then stop. - */ + /** Stops when reaching the end */ var ONCE = 0x000000; - /** - * Move from the start of the path to the end then directly back to the start, and start over. - */ + /** When the end is reached, go back to the other end and start again */ var LOOP = 0x000010; - /** - * Move from the start of the path to the end then turn around and go back to the start, over and over. - */ + /** When the end is reached, change direction and continue */ var YOYO = 0x001000; } @@ -331,7 +335,7 @@ enum abstract FlxPathDirection(Bool) var FORWARD = true; var BACKWARD = false; - public function toInt() + inline public function toInt() { return this ? 1 : -1; } diff --git a/flixel/path/FlxPath.hx b/flixel/path/FlxPath.hx index 1349fe42a0..2fdbd0a126 100644 --- a/flixel/path/FlxPath.hx +++ b/flixel/path/FlxPath.hx @@ -1,9 +1,9 @@ package flixel.path; -import flixel.path.FlxBasePath; import flixel.FlxG; import flixel.FlxObject; import flixel.math.FlxPoint; +import flixel.path.FlxBasePath; import flixel.util.FlxAxes; import flixel.util.FlxColor; import flixel.util.FlxDestroyUtil; @@ -73,7 +73,7 @@ enum CenterMode * object.path = new FlxPath([new FlxPoint(0, 0), new FlxPoint(100, 0)]).start(); * ``` */ -class FlxPath extends FlxBasePath +class FlxPath extends FlxBasePath { /** * Move from the start of the path to the end then stop. @@ -159,6 +159,7 @@ class FlxPath extends FlxBasePath */ public var angleOffset:Float = 0; + public var onComplete:FlxPath->Void; /** * Tracks which node of the path this object is currently moving toward. */ @@ -196,6 +197,11 @@ class FlxPath extends FlxBasePath super(nodes != null ? nodes.copy() : []); active = false; + onPathComplete.add(function (_) + { + if (onComplete != null) + onComplete(this); + }); } /** @@ -417,47 +423,46 @@ class FlxPath extends FlxBasePath */ function advancePath(snap:Bool = true):FlxPoint { - if (snap) + advance(); + + return current; + } + + override function advance() + { + if (axes.x) { - var oldNode:FlxPoint = nodes[nodeIndex]; - if (oldNode != null) + object.x = next.x; + switch (centerMode) { - if (axes.x) - { - object.x = oldNode.x; - switch (centerMode) - { - case ORIGIN: - if (object is FlxSprite) - object.x -= (cast object:FlxSprite).origin.x; - case CUSTOM(offset): - object.x -= offset.x; - case CENTER: - object.x -= object.width * 0.5; - case TOP_LEFT: - } - } - if (axes.y) - { - object.y = oldNode.y; - switch (centerMode) - { - case ORIGIN: - if (object is FlxSprite) - object.y -= (cast object:FlxSprite).origin.y; - case CUSTOM(offset): - object.y -= offset.y; - case CENTER: - object.y -= object.height * 0.5; - case TOP_LEFT: - } - } + case ORIGIN: + if (object is FlxSprite) + object.x -= (cast object:FlxSprite).origin.x; + case CUSTOM(offset): + object.x -= offset.x; + case CENTER: + object.x -= object.width * 0.5; + case TOP_LEFT: } } - - advance(); - - return nodes[nodeIndex]; + + if (axes.y) + { + object.y = next.y; + switch (centerMode) + { + case ORIGIN: + if (object is FlxSprite) + object.y -= (cast object:FlxSprite).origin.y; + case CUSTOM(offset): + object.y -= offset.y; + case CENTER: + object.y -= object.height * 0.5; + case TOP_LEFT: + } + } + + super.advance(); } /**