Skip to content

Document Sprite.filename specifics #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Arecher wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Document Sprite.filename specifics #172

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c1e5279
Document Sprite.filename specifics
Arecher Aug 27, 2026
f0a762d
Merge branch 'main' into document-sprite-filename-specifics
Arecher Aug 27, 2026
ad09001
Update Sprite.filename specifics
Arecher Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions api/sprite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,18 @@ local name = sprite.filename
sprite.filename = newName
```

Gets or sets the name of the file from which this sprite was loaded or
saved, or returns the sprite title if it's a new sprite without an
associated file.
Gets or sets the name of the file from which this sprite was loaded or was saved to.
For saved files the filename returns the full filepath (`C:\Aseprite\myfile.ase`), while
for unsaved Sprites and Sprites without an [Associated File](sprite.md#spritehasassociatedfile) it returns only the title (`Sprite-0001`).

Use [app.fs.fileTitle(filename)](app_fs.md#appfsfiletitle) to retrieve the Sprite's title as
shown on the ui.

Changing this value for an active sprite will not [open](app.md#appopen) or switch to the file
at the given filename, but does change where this file is saved when calling
`app.command.SaveFile()`.

Changes to the filename will create a `'filenamechange'` event in [Sprite.events]{sprite.md#spriteevents}.

## Sprite.id

Expand Down