Skip to content

Commit

Permalink
Revert "Add disabled status to FlxButton (HaxeFlixel#3087)"
Browse files Browse the repository at this point in the history 
This reverts commit 6cd83e7.
  • Loading branch information
@charlesisfeline
charlesisfeline committed Apr 6, 2024
1 parent 0747471 commit 8cceda1
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 66 deletions.
Binary file modified assets/images/ui/button.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
86 changes: 27 additions & 59 deletions flixel/ui/FlxButton.hx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,6 @@ import flixel.util.FlxDestroyUtil;
import flixel.input.touch.FlxTouch;
#end

enum abstract FlxButtonState(Int) to Int
{
/** The button is not highlighted or pressed */
var NORMAL = 0;

/** The button is selected, usually meaning the mouse is hovering over it */
var HIGHLIGHT = 1;

/** The button is being pressed usually by a mouse */
var PRESSED = 2;

/** The button is not interactible */
var DISABLED = 3;
}

/**
* A simple button class that calls a function when clicked by the mouse.
*/
Expand All @@ -41,30 +26,17 @@ class FlxButton extends FlxTypedButton<FlxText>
/**
* Used with public variable status, means not highlighted or pressed.
*/
@:dox(hide) @:noCompletion
@:deprecated("FlxButton.NORMAL is deprecated, use FlxButtonState.NORMAL")
public static inline var NORMAL = FlxButtonState.NORMAL;
public static inline var NORMAL:Int = 0;

/**
* Used with public variable status, means highlighted (usually from mouse over).
*/
@:dox(hide) @:noCompletion
@:deprecated("FlxButton.HIGHLIGHT is deprecated, use FlxButtonState.HIGHLIGHT")
public static inline var HIGHLIGHT = FlxButtonState.HIGHLIGHT;
public static inline var HIGHLIGHT:Int = 1;

/**
* Used with public variable status, means pressed (usually from mouse click).
*/
@:dox(hide) @:noCompletion
@:deprecated("FlxButton.PRESSED is deprecated, use FlxButtonState.PRESSED")
public static inline var PRESSED = FlxButtonState.PRESSED;

/**
* Used with public variable status, means non interactible.
*/
@:dox(hide) @:noCompletion
@:deprecated("FlxButton.DISABLED is deprecated, use FlxButtonState.DISABLED")
public static inline var DISABLED = FlxButtonState.DISABLED;
public static inline var PRESSED:Int = 2;

/**
* Shortcut to setting label.text
Expand Down Expand Up @@ -108,7 +80,7 @@ class FlxButton extends FlxTypedButton<FlxText>
{
if (Text != null)
{
label = new FlxText(x + labelOffsets[FlxButtonState.NORMAL].x, y + labelOffsets[FlxButtonState.NORMAL].y, 80, Text);
label = new FlxText(x + labelOffsets[NORMAL].x, y + labelOffsets[NORMAL].y, 80, Text);
label.setFormat(null, 8, 0x333333, "center");
label.alpha = labelAlphas[status];
label.drawFrame(true);
Expand Down Expand Up @@ -150,19 +122,19 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
/**
* What offsets the `label` should have for each status.
*/
public var labelOffsets:Array<FlxPoint> = [FlxPoint.get(), FlxPoint.get(), FlxPoint.get(0, 1), FlxPoint.get()];
public var labelOffsets:Array<FlxPoint> = [FlxPoint.get(), FlxPoint.get(), FlxPoint.get(0, 1)];

/**
* What alpha value the label should have for each status. Default is `[0.8, 1.0, 0.5]`.
* Multiplied with the button's `alpha`.
*/
public var labelAlphas:Array<Float> = [0.8, 1.0, 0.5, 0.3];
public var labelAlphas:Array<Float> = [0.8, 1.0, 0.5];

/**
* What animation should be played for each status.
* Default is ["normal", "highlight", "pressed"].
*/
public var statusAnimations:Array<String> = ["normal", "highlight", "pressed", "disabled"];
public var statusAnimations:Array<String> = ["normal", "highlight", "pressed"];

/**
* Whether you can press the button simply by releasing the touch / mouse button over it (default).
Expand All @@ -185,10 +157,10 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
public var maxInputMovement:Float = Math.POSITIVE_INFINITY;

/**
* Shows the current state of the button, either `NORMAL`,
* `HIGHLIGHT` or `PRESSED`.
* Shows the current state of the button, either `FlxButton.NORMAL`,
* `FlxButton.HIGHLIGHT` or `FlxButton.PRESSED`.
*/
public var status(default, set):FlxButtonState;
public var status(default, set):Int;

/**
* The properties of this button's `onUp` event (callback function, sound).
Expand Down Expand Up @@ -250,7 +222,7 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
onOver = new FlxButtonEvent();
onOut = new FlxButtonEvent();

status = NORMAL;
status = FlxButton.NORMAL;

// Since this is a UI element, the default scrollFactor is (0, 0)
scrollFactor.set();
Expand All @@ -260,8 +232,8 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
#end

#if FLX_NO_MOUSE // no need for highlight frame without mouse input
statusAnimations[HIGHLIGHT] = "normal";
labelAlphas[HIGHLIGHT] = 1;
statusAnimations[FlxButton.HIGHLIGHT] = "normal";
labelAlphas[FlxButton.HIGHLIGHT] = 1;
#end

input = new FlxInput(0);
Expand All @@ -271,10 +243,9 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
{
super.graphicLoaded();

setupAnimation("normal", NORMAL);
setupAnimation("highlight", HIGHLIGHT);
setupAnimation("pressed", PRESSED);
setupAnimation("disabled", DISABLED);
setupAnimation("normal", FlxButton.NORMAL);
setupAnimation("highlight", FlxButton.HIGHLIGHT);
setupAnimation("pressed", FlxButton.PRESSED);
}

function loadDefaultGraphic():Void
Expand Down Expand Up @@ -413,9 +384,6 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
*/
function updateButton():Void
{
// Prevent interactions with this input if it's currently disabled
if (status == DISABLED)
return;
// We're looking for any touch / mouse overlaps with this button
var overlapFound = checkMouseOverlap();
if (!overlapFound)
Expand All @@ -426,7 +394,7 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
onUpHandler();
}

if (status != NORMAL && (!overlapFound || (currentInput != null && currentInput.justReleased)))
if (status != FlxButton.NORMAL && (!overlapFound || (currentInput != null && currentInput.justReleased)))
{
onOutHandler();
}
Expand Down Expand Up @@ -496,7 +464,7 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
currentInput = input;
onDownHandler();
}
else if (status == NORMAL)
else if (status == FlxButton.NORMAL)
{
// Allow "swiping" to press a button (dragging it over the button while pressed)
if (allowSwiping && input.pressed)
Expand All @@ -521,7 +489,7 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput

function updateLabelAlpha()
{
if (_spriteLabel != null && labelAlphas.length > (status : Int))
if (_spriteLabel != null && labelAlphas.length > status)
{
_spriteLabel.alpha = alpha * labelAlphas[status];
}
Expand All @@ -534,7 +502,7 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
#if FLX_MOUSE
function onUpEventListener(_):Void
{
if (visible && exists && active && status == PRESSED)
if (visible && exists && active && status == FlxButton.PRESSED)
{
onUpHandler();
}
Expand All @@ -546,7 +514,7 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
*/
function onUpHandler():Void
{
status = HIGHLIGHT;
status = FlxButton.HIGHLIGHT;
input.release();
currentInput = null;
// Order matters here, because onUp.fire() could cause a state change and destroy this object.
Expand All @@ -558,7 +526,7 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
*/
function onDownHandler():Void
{
status = PRESSED;
status = FlxButton.PRESSED;
input.press();
// Order matters here, because onDown.fire() could cause a state change and destroy this object.
onDown.fire();
Expand All @@ -574,11 +542,11 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
// by remaining in the normal state (until mouse input is re-enabled).
if (!FlxG.mouse.enabled)
{
status = NORMAL;
status = FlxButton.NORMAL;
return;
}
#end
status = HIGHLIGHT;
status = FlxButton.HIGHLIGHT;
// Order matters here, because onOver.fire() could cause a state change and destroy this object.
onOver.fire();
}
Expand All @@ -588,7 +556,7 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
*/
function onOutHandler():Void
{
status = NORMAL;
status = FlxButton.NORMAL;
input.release();
// Order matters here, because onOut.fire() could cause a state change and destroy this object.
onOut.fire();
Expand All @@ -611,9 +579,9 @@ class FlxTypedButton<T:FlxSprite> extends FlxSprite implements IFlxInput
return Value;
}

function set_status(value:FlxButtonState):FlxButtonState
function set_status(Value:Int):Int
{
status = value;
status = Value;
updateLabelAlpha();
return status;
}
Expand Down
13 changes: 6 additions & 7 deletions tests/unit/src/flixel/ui/FlxButtonTest.hx
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
package flixel.ui;

import flixel.FlxSprite;
import flixel.ui.FlxButton;
import openfl.display.BitmapData;
import flixel.FlxSprite;
import massive.munit.Assert;

class FlxButtonTest extends FlxTest
Expand Down Expand Up @@ -46,9 +45,9 @@ class FlxButtonTest extends FlxTest

function assertStatusAnimationsExist()
{
var normalName:String = button.statusAnimations[NORMAL];
var highlightName:String = button.statusAnimations[HIGHLIGHT];
var pressedName:String = button.statusAnimations[PRESSED];
var normalName:String = button.statusAnimations[FlxButton.NORMAL];
var highlightName:String = button.statusAnimations[FlxButton.HIGHLIGHT];
var pressedName:String = button.statusAnimations[FlxButton.PRESSED];

Assert.isNotNull(button.animation.getByName(normalName));
Assert.isNotNull(button.animation.getByName(highlightName));
Expand All @@ -75,7 +74,7 @@ class FlxButtonTest extends FlxTest

button.setPosition();
step(1);
Assert.areEqual(HIGHLIGHT, button.status);
Assert.areEqual(FlxButton.HIGHLIGHT, button.status);

FlxG.state.remove(button);
}
Expand All @@ -88,7 +87,7 @@ class FlxButtonTest extends FlxTest
FlxG.state.add(button);
step(2);

Assert.areEqual(NORMAL, button.status);
Assert.areEqual(FlxButton.NORMAL, button.status);
Assert.areEqual("normal", button.animation.curAnim.name);
Assert.areEqual(false, button.animation.finished);
step(10);
Expand Down

0 comments on commit 8cceda1

Please sign in to comment.