FlixelCommunity / flixel

Community fork of Adam “Atomic” Saltsman's popular game engine Flixel. Distilled from a variety of Flash games he worked on over the last couple years, including Gravity Hook, Fathom and Canabalt, its primary function is to provide some useful base classes that you can extend to make your own game objects.
http://flixelcommunity.org/
Other
84 stars 17 forks source link

Fix regression with FlxText regarding the "moves" property. #180

Closed Dovyski closed 11 years ago

Dovyski commented 11 years ago

By default any FlxText was able to move, but some change we did changed that. We explicitly set "moves" to false, which made all FlxText to stop moving unless otherwise specified.

I removed the "moves = false" from FlxText's contructor and everything is working as before.

moly commented 11 years ago

The documentation for moves in FlxObject needs to be changed. It currently says that FlxText defaults to false.

Dovyski commented 11 years ago

You are right, @moly . If the documentation in FlxObject says that FlxText defaults to false, then that's the right behavior. FlxText was moving by mistake.

We can ignore and close this pull request, maintaining the current moves = false in FlxText.

IQAndreas commented 11 years ago

We can ignore and close this pull request, maintaining the current moves = false in FlxText.

How common do you think it is for developers to have used moving text in their Flixel games? If we are trying to make v2.56 as compatible with v2.55 games as possible, should we leave the documentation "incorrect" just for this version, and then "fix" the default value in the next one?

Or is it better to just provide a notice: in the changelog for the few developers this will affect?

Dovyski commented 11 years ago

I think it's more common than we can estimate. When I've first discovered about the velocity property, I assumed every class with it could move (which included FlxText).

Flixel Community 2.56 should be as retro compatible as possible, so I've been thinking we should remove the moves = false from FlxText updating the documentation to say it does move. It will ensure retro compatibility and Mode will work out of the box.

IQAndreas commented 11 years ago

Flixel Community 2.56 should be as retro compatible as possible, so I've been thinking we should remove the moves = false from FlxText updating the documentation to say it does move.

I agree, go ahead and add a commit updating the documentation, and we can merge this.