Flixel Actions #1741

larsiusprime · 2016-02-23T21:40:43Z

This is a big commit, so for a broad-strokes overview, see this:
https://github.com/larsiusprime/haxeflixel/blob/actions_/flixel/input/actions/FlxActionManager.hx#L24

(That giant info dump probably needs to go somewhere other than the code itself, I just put it there for now, probably would eventually just go in the flixel docs).

This has been tested and works on my machine, but I don't currently have a demo for it. The syntax to use it is this:

1: Simple Digital Action

var JUMP = new FlxActionDigital("jump", onJump);
JUMP.addInput(new FlxActionInputDigitalMouse(FlxMouseButtonID.LEFT, JUST_PRESSED);
JUMP.addInput(new FlxActionInputDigitalKeyboard(FlxKey.SPACE, JUST_PRESSED);
JUMP.addInput(new FlxActionInputDigitalGamepad(FlxGamepadInputID.A, JUST_PRESSED);

This will trigger "JUMP" on left mouse click, spacebar press, or pressing the bottom face button on the (first active) gamepad.

In your update loop:

JUMP.update();                 //if you're relying on callbacks
if(JUMP.check()) { doJump(); } //to do the check directly yourself

2: Simple Analog Action

var MOVE = new FlxActionAnalog("move",onMove);
MOVE.addInput(new FlxActionInputAnalogMouse(FlxAnalogState.MOVED, FlxAnalogAxis.EITHER);
MOVE.addInput(new FlxActionInputAnalogGamepad(FlxGamepadInputID.LEFT_ANALOG_STICK, FlxAnalogState.MOVED, FlxAnalogAxis.EITHER);

In your update loop:

MOVE.update();  //mandatory for analog if you rely on callbacks or want JUST_MOVED / JUST_STOPPED to behave correctly
if(MOVE.check()) { doMove(MOVE.x, MOVE.y);} //to do the check directly yourself

3: Using the Action Manager

var actionManager = new FlxActionManager();
FlxG.inputs.add(actionManager);
var menuActions = new FlxActionSet("menuActions", someDigitalActions, someAnalogActions);
var battleActions = new FlxActionSet("battleActions", otherDigitalActions, otherAnalogActions);
var menuIndex = actionManager.addSet(menuActions);
var battleIndex = actionManager.addSet(battleActions);

if(inMenu)
{
    //activate menu action set for all devices
    actionManager.activate(menuIndex, FlxInputDevice.ALL, FlxInputDeviceID.ALL);
}
else if(inBattle)
{
    //activate battle action set for all devices
    actionManager.activate(battleIndex, FlxInputDevice.ALL, FlxInputDeviceID.ALL);
}

4: Using the Action Manager with Steam Controllers

First, install the steamwrap library, and follow all the steps in the SteamWorks documentation to get the basics set up.

Then:

var actionManager = new FlxActionManager();
FlxG.inputs.add(actionManager);

var vdfText:String = Assets.getText("assets/xml/game_actions_XYZ.vdf");
actionManager.initSteam(steamwrap.data.ControllerConfig.fromVDF(vdfText)), 
    function(ad:FlxActionDigital):Void
    {
        trace("digital " + ad.name);
    },
    function(aa:FlxActionAnalog):Void
    {
        trace("analog " + aa.name);
    }
);

var menuIndex = actionManager.getSetIndex("MenuControls");  //"MenuControls" is an action set defined in the .vdf file

//get a list of connected steam controllers from the Steam API:
var controllers = Steam.controllers.getConnectedControllers();

//we must activate an action set for a steam controller to use:
actionManager.activateSet(menuIndex, FlxInputDevice.SteamController, controllers[0]);

//Let's add some non-steam inputs to the action sets we generated from the steam vdf file.
//This block is TOTALLY optional, I'm just doing it to show off how to add regular
//inputs to action set structure generated from Steam VDF data:

var menuSet = actionManager.getSet(menuIndex);
for (action in menuSet.digitalActions)
{
    switch(action.name)
    {
        case "menu_down":  action.addInput(new FlxActionInputDigitalKeyboard(FlxKey.DOWN, JUST_PRESSED));
                           action.addInput(new FlxActionInputDigitalGamepad(FlxGamepadInputID.DPAD_DOWN, JUST_PRESSED));

        case "menu_left":  action.addInput(new FlxActionInputDigitalKeyboard(FlxKey.LEFT, JUST_PRESSED));
                           action.addInput(new FlxActionInputDigitalGamepad(FlxGamepadInputID.DPAD_LEFT, JUST_PRESSED));

        case "menu_right": action.addInput(new FlxActionInputDigitalKeyboard(FlxKey.RIGHT, JUST_PRESSED));
                           action.addInput(new FlxActionInputDigitalGamepad(FlxGamepadInputID.DPAD_RIGHT, JUST_PRESSED));

        case "menu_up":    action.addInput(new FlxActionInputDigitalKeyboard(FlxKey.UP,    JUST_PRESSED));
                           action.addInput(new FlxActionInputDigitalGamepad(FlxGamepadInputID.DPAD_UP, JUST_PRESSED));

        case "menu_select": action.addInput(new FlxActionInputDigitalKeyboard(FlxKey.ENTER, JUST_PRESSED));
                           action.addInput(new FlxActionInputDigitalGamepad(FlxGamepadInputID.A, JUST_PRESSED));

        case "menu_cancel": action.addInput(new FlxActionInputDigitalKeyboard(FlxKey.ESCAPE, JUST_PRESSED));
                           action.addInput(new FlxActionInputDigitalGamepad(FlxGamepadInputID.B, JUST_PRESSED));
    }
}

Squashed commit: [fb923a4] Getting close to final version of FlxAction stuff [58fcfba] more cleanup [750f177] cleanup [f15193f] Flixel Actions -- first commit (+2 squashed commit) Squashed commit: [9025228] cleanup [a516cfd] Flixel Actions -- first commit

larsiusprime · 2016-02-23T22:35:27Z

I'll fix travis when i can, 99% sure its missing #if steamwrap blocks

larsiusprime · 2016-02-24T04:19:10Z

Okay, Travis is finally satisfied, if @Gama11 or anybody else has any comments on the PR itself.

MSGhero · 2016-02-24T05:10:48Z

Does this preclude the current input system(s), or is this purely an addition to make life easier/enable steam controller?

Also, needs a crossinput demo.

IBwWG · 2016-02-24T07:39:58Z

This looks nice even if you're not using steam controllers :)

larsiusprime · 2016-02-24T14:07:43Z

@MSGhero: This builds directly on top of existing input stuff, so all that still works. You can use this instead of, or in combination with, existing input methods. It's the only sensible way to enable the steam controller, but it's still useful for regular input styles.

Tiago-Ling · 2016-02-24T14:12:33Z

Awesome work - this will be a time saver and a allow a better organization
for all projects!

Are the update function calls mandatory (e.g. action.update() ) ? Or are
they needed only if you're using single actions (i.e. when using the
manager you don't need to update actions directly)?

Tiago Ling Alexandre
Tel: +55 41 8819-3191

2016-02-24 11:07 GMT-03:00 Lars Doucet [email protected]:

@MSGhero https://github.com/msghero: This builds directly on top of
existing input stuff, so all that still works. You can use this instead of,
or in combination with, existing input methods.

—
Reply to this email directly or view it on GitHub
#1741 (comment).

larsiusprime · 2016-02-24T14:18:40Z

@Tiago-Ling: it will need a bit of testing to verify, but I'm 99% sure:

update() needs to be called on an action (or the action set it belongs to if you're using an action set), when:

you're relying on callbacks
you are using analog actions and need accurate JUST_MOVED / JUST_STOPPED logic
you are using steam controllers

Otherwise you can just use a naked FlxAction and call check() on it whenever you want to check. Digital actions have their JUST_PRESSED / JUST_RELEASED updated properly by flixel itself, but analog & steam controllers need constant update() logic to do that properly.

If I KNEW the user was always calling check() every frame, then I could make it behave like update and check, which would make those guarantees implicitly -- but it's hard to know if that's how they're using it.

But yes, as designed you can use actions by themselves, actions as parts of sets, or the manager. And if you use the manager, and add it to FlxG.inputs, you don't have to call update on anything, it's automatic.

larsiusprime · 2016-02-24T22:51:12Z

Update -- I just looked at things, and it seems that calling check() also implicitly calls update(), and also fires callbacks if they are present!

This means that if the user is using a "naked" FlxAction (not used as part of a FlxActionSet or a FlxActionmanager) and calls check() every flixel update, there's literally no reason to also call FlxAction.update() -- in fact doing so could cause multiple erroneous callbacks, given the current implementation.

So a "safe" pattern could very well be to just call check() every frame. There's a few problems though:

The user might NOT call check() every frame, in which case your JUST_* states won't be accurate and callbacks won't be called even when the physical input conditions have been met, if a check() wasn't run on that frame
The user might call check() multiple times per frame, which would be wasteful (perhaps not important, I haven't profiled), but would also trigger multiple callbacks in one frame, which would be a problem.

Issue 1. might not be a real problem -- it's the "user's fault". But 2 seems like bad implementation. Is there a way in flixel to get a timestamp for the current frame or some other way to check that we're still at this point in time, so I can put some internal logic to make the internal updating logic short-circuit if it tries to run more than once on the same update frame?

larsiusprime · 2016-02-24T23:33:45Z

Okay, now I'm fairly confident two usage patterns should suffice:

call check() every frame

On actions, sets, or even the manager. Will return true/false and fire callbacks if they exist. Will properly update JUST_* state information so long as its called every frame.
use the manager, add to FlxG.inputs

Then updating & callbacks happen automatically

…ment IFlxDestroyable

- HaxeFlixel/flixel#1741 - HaxeFlixel/flixel#1746

larsiusprime · 2016-02-27T01:02:13Z

Question: I could make FlxActions (and FlxActionSets) extend FlxBasic, which would let you add() them to the current state, automating update()'ing and ensuring they get destroy()'ed on state switch. Good idea or no?

MSGhero · 2016-02-27T01:46:25Z

I mean everything else extends FlxBasic. Destroying key inputs is a bit awkward, but I guess it kinda makes sense given that your state should have differently named actions, even if they use the same keys.

MSGhero · 2016-02-27T01:48:31Z

I would also like the demo to use the relative mouse stuff just to see how it works.

Gama11 · 2016-02-27T08:39:44Z

I brought that FlxBasic idea up in the context of timers / tweens (#1087). It was pretty much decided against, and we should probably be consistent about that..

larsiusprime · 2016-02-28T01:07:05Z

@Gama11 : I get this is a huge PR, and it'll take the time it takes to review, so no rush, but is there anything I can do in the meantime? Also maybe we should bring in some other people to review to lighten the load?

Gama11 · 2016-02-28T09:43:18Z

There are some code style issues I've noticed but not commented on since I wanted to have a look at the high-level structure of this whole thing first. I haven't gotten to that though.

A few general things:

I don't like the usage of @:noCompletion - IDEs like FlashDevelop don't care about that, and technically, those classes are still public API that have to be considered for breaking changes etc. Why not make the classes private instead?
Variables should be declared at the top of the class, not the bottom.
There shouldn't be any empty lines between the doc comment of a field and the field itself.

/**
 *
 */

var example:Int;

vs

/**
 *
 */
var example:Int;

larsiusprime · 2016-03-05T02:55:18Z

@Gama11: style fix in.

larsiusprime · 2016-03-05T04:10:07Z

Travis says neko is failing but I crawled all over the log and can't seem to find the failure?

Gama11 · 2016-03-05T08:33:20Z

This happens at the end of the munit tests:

pure virtual method called
terminate called without an active exception
Aborted (core dumped)

larsiusprime · 2016-03-05T14:46:32Z

What does that mean?

Gama11 · 2016-03-05T14:48:28Z

I have no idea, but I restarted that particular job and now it's green.

larsiusprime · 2016-03-05T14:48:53Z

Weird :)

MSGhero · 2016-04-02T17:25:18Z

@larsiusprime https://github.com/blog/2141-squash-your-commits

larsiusprime · 2016-04-02T20:02:33Z

Heh, well I have to fix all the codeclimate checks now, thanks pointing that out @MSGhero :)

larsiusprime · 2016-04-05T01:20:21Z

Squashed, see here:
#1805

larsiusprime added 2 commits February 23, 2016 15:20

Compile fix for travis

3bffdac

Gama11 added the New Feature label Feb 23, 2016

Gama11 added this to the 4.1.0 milestone Feb 23, 2016

larsiusprime added 2 commits February 23, 2016 21:18

make compiler happy if !steamwrap

86e6383

put in FLX_NO_MOUSE, FLX_NO_GAMEPAD, FLX_NO_KEYBOARD checks...

90b9a38

Minor docs fix. (Analog actions are always analog!)

cddaf2f

avoid double updates on check

5bfdbc9

larsiusprime added 3 commits February 25, 2016 16:23

Fix some bugs with the steam controller

5da62ef

Add generic IFlxInput digital action input, make FlxActionInput imple…

44b5dee

…ment IFlxDestroyable

Merge branch 'dev' of https://github.com/HaxeFlixel/flixel into actions_

572f71e

larsiusprime added a commit to larsiusprime/flixel-demos that referenced this pull request Feb 26, 2016

Added FlxAction demo, depends on these PR's to HaxeFlixel:

822cf6e

- HaxeFlixel/flixel#1741 - HaxeFlixel/flixel#1746

larsiusprime mentioned this pull request Feb 26, 2016

Added FlxAction demo HaxeFlixel/flixel-demos#219

Closed

larsiusprime added 2 commits February 26, 2016 13:01

fix analog inputs

223bcca

relative mouse analog input

934949f

larsiusprime added 2 commits February 27, 2016 12:17

fix sticky analog action x/y

4d7bc92

small tweak

31f8114

style fix

3a27887

larsiusprime added 4 commits March 9, 2016 09:11

Added two new action inputs

5d6a620

Merge branch 'dev' of https://github.com/HaxeFlixel/flixel into actions_

734a24a

travis fix for flxactions

4f1f752

Merge branch 'dev' of https://github.com/HaxeFlixel/flixel into actions_

9413ced

larsiusprime closed this Apr 5, 2016

larsiusprime deleted the actions_ branch April 8, 2016 14:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Flixel Actions #1741

Flixel Actions #1741

larsiusprime commented Feb 23, 2016

larsiusprime commented Feb 23, 2016

larsiusprime commented Feb 24, 2016

MSGhero commented Feb 24, 2016

IBwWG commented Feb 24, 2016

larsiusprime commented Feb 24, 2016

Tiago-Ling commented Feb 24, 2016

larsiusprime commented Feb 24, 2016

larsiusprime commented Feb 24, 2016

larsiusprime commented Feb 24, 2016

larsiusprime commented Feb 27, 2016

MSGhero commented Feb 27, 2016

MSGhero commented Feb 27, 2016

Gama11 commented Feb 27, 2016

larsiusprime commented Feb 28, 2016

Gama11 commented Feb 28, 2016

larsiusprime commented Mar 5, 2016

larsiusprime commented Mar 5, 2016

Gama11 commented Mar 5, 2016

larsiusprime commented Mar 5, 2016

Gama11 commented Mar 5, 2016

larsiusprime commented Mar 5, 2016

MSGhero commented Apr 2, 2016

larsiusprime commented Apr 2, 2016

larsiusprime commented Apr 5, 2016

Flixel Actions #1741

Flixel Actions #1741

Conversation

larsiusprime commented Feb 23, 2016

1: Simple Digital Action

2: Simple Analog Action

3: Using the Action Manager

4: Using the Action Manager with Steam Controllers

larsiusprime commented Feb 23, 2016

larsiusprime commented Feb 24, 2016

MSGhero commented Feb 24, 2016

IBwWG commented Feb 24, 2016

larsiusprime commented Feb 24, 2016

Tiago-Ling commented Feb 24, 2016

larsiusprime commented Feb 24, 2016

larsiusprime commented Feb 24, 2016

larsiusprime commented Feb 24, 2016

larsiusprime commented Feb 27, 2016

MSGhero commented Feb 27, 2016

MSGhero commented Feb 27, 2016

Gama11 commented Feb 27, 2016

larsiusprime commented Feb 28, 2016

Gama11 commented Feb 28, 2016

larsiusprime commented Mar 5, 2016

larsiusprime commented Mar 5, 2016

Gama11 commented Mar 5, 2016

larsiusprime commented Mar 5, 2016

Gama11 commented Mar 5, 2016

larsiusprime commented Mar 5, 2016

MSGhero commented Apr 2, 2016

larsiusprime commented Apr 2, 2016

larsiusprime commented Apr 5, 2016