aseprite / aseprite/api

MoveCel command parameters?

Open
#58 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
307
Forks
68
PR merge metrics
No merged PRs in 30d

Description

Would it be possible to update the API documentation with the parameters for [app.command.MoveCel](https://github.com/aseprite/api/blob/main/api/app_command.md)?

Unfortunately it doesn't have any relevant information in [gui.xml](https://github.com/aseprite/aseprite/blob/main/data/gui.xml) and decoding the source for it in [cmd_move_cel.cpp](https://github.com/aseprite/aseprite/blob/main/src/app/commands/cmd_move_cel.cpp) and the timeline/context scripts was far beyond my skill and knowledge.

I tried quite a few combination of parameter names based on those pages, seeing if I'd hit the jackpot (srcLayer, srcFrame, toFrame, passing numbers, passing ranges, layer/frame objects, etc, etc.) seeing if I'd get a result, but nope. I scrubbed all Aseprite scripts and the examples seeing if there was a reference, but no luck either.

Reason I'm asking is that I'm writing a couple QoL scripts that involve moving cels around, tagging, etc. to automate how I get sprites for my game and the lack of API documentation regarding moving cels has made me do things in awkward manners: Currently, my code 1) copies the cels one by one, 2) deletes the original cels, 3) checks if they have to be relinked 4) relinks them. This isn't very efficient. If I could just pass a range or something, it would be a lot easier, but not so without a little more info.

Apologies if this is not the place to be asking.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with api/app_command.md and compare the app.command.MoveCel entry with src/app/commands/cmd_move_cel.cpp, then inspect the timeline and context scripts mentioned in the issue for parameter usage. Document the supported parameters and expected values, and verify that the API reference reflects the command behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.