Character Animations API discussion

[felixjones]

This discussion carries on from issue #22

The new API has support for both XML and JSON, but there's currently no documentation for either of these formats whilst the API is developed.

Some ideas to discuss:

• QSprite Editor support
• Non-Javascript API
• Easier method of defining animation frames (columns, rows, indexes - like QSprite)
• Additional scripting input $params
• Additional scripting output animation properties
• Plugin command API

---

QSprite Editor

This idea is to have the Plugin read the .JSON format that QSprite uses so the QSprite editor can be utilised. We need to investigate how to capture the full range of QSprite's features. Luckily, QSprite is very basic so feature parity should be easy to achieve.

Non-Javascript API

Javascript is a bit much for just defining animation frames. Perhaps has an alternative system that's similar to what other sprite Plugins do.

Easier method of defining animation frames

The current system is very flexible, however it requires a fair amount of typing. A simpler system - however that may look - could be created.

Additional scripting input/output

Input is probably less important as pretty much any input value you want can be accessed via the scripting interface.

Output probably needs to be expanded. One start would be to look at all the properties a PIXI.js sprite can have and add those into the output structure (opacity, perhaps rotation?).

Plugin Command API

This is the big one. Need a good way to fire-off animations, both one shot and loop. This will likely be a "state set" system, however some additional flexibility might be cool, such as modifying play-back speed via command args or applying a scale.

[vico93]

Will this plugin be usabe without the need of QSprite Editor (aka we will still be able to setup characters manually)?
I already rejected myself using TileD plugin due to unwanted ammount of 3rd party tools needed to make a game, so if we could still define the characters using the XML format similar to what i proposed on #22 and you have defined, it could be an option...

[Neodymiump]

Hello.
First of all, I apologize for my poor English.
I am currently working on mastering the Altimit System. Can I reference the properties of $ params with javascript?

If impossible it will be appreciated if it will be added as a future feature
I appreciate having met a wonderful plugin. Thank you.

[josephdevelops]

I would love to see a way to use this plugin for events / NPCs.