Skip to content

Ship decor nodes - #195

Open
Amazinite wants to merge 2 commits into
endless-sky:masterfrom
Amazinite:ship-decor
Open

Ship decor nodes#195
Amazinite wants to merge 2 commits into
endless-sky:masterfrom
Amazinite:ship-decor

Conversation

@Amazinite

Copy link
Copy Markdown
Contributor

Comment thread wiki/CreatingShips.md Outdated
* `"leak" <effect> [<openPeriod#>] [<closePeriod#>]`: an effect to create when the ship is dying. The open period of the leak is the random chance each frame (1 / openPeriod) that a new leak will start, while the close period is the random chance each frame (1 / closePeriod) that an active leak will end. Differs from `"explode"` in that leak effects are emitted from the edge of the ship's sprite, as if the ship's atmosphere is leaking as it dies.
* `"leak" <effect> [<openPeriod#>] [<closePeriod#>]`: an effect to create when the ship is dying. The open period of the leak is the random chance each frame (1 / openPeriod) that a new leak will start, while the close period is the random chance each frame (1 / closePeriod) that an active leak will end. Differs from `"explode"` in that leak effects are emitted from the edge of the ship's sprite, as if the ship's atmosphere is leaking as it dies. Beginning in **v. 0.10.17**, this supports the following child nodes:

* `(active | disabled | exploding | "always on")...`: tags that influence when the leak effect appears. Multiple different tags can be provided at once. By default, leaks only appear when the ship is exploding.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are the ellipses here for?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's used in various locations to represent that you can have multiple values. Although this might imply they can be stacked on one line, when in actuality they should be on separate lines.

@TheGiraffe3 TheGiraffe3 added the enhancement Adding documentation about a new feature being PR'd to endless-sky/endless-sky label Dec 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Adding documentation about a new feature being PR'd to endless-sky/endless-sky

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants