Situation Based Ship Animations Wiki Update #31

XessWaffle · 2024-07-25T23:19:51Z

New feature

This is the wiki page which refers to the below pull request
endless-sky/endless-sky#10348

Summary

Update the SpriteData.md wiki to include new details about sprite animation

Co-authored-by: Loymdayddaud <[email protected]>

Wiki update for 10046

…-sky#20)

…MapData (endless-sky#25)

wiki/SpriteData.md

TheGiraffe3 · 2024-08-09T05:11:14Z

wiki/SpriteData.md

@@ -45,17 +45,114 @@ The `<name>` for this sprite is "effect/blaster impact". The `+` in the file nam

 Since **v. 0.9.15**: sprite sets can be universally resized, in case you would like to reuse an existing animation at a different size, with the `"scale"` attribute. The default scale value is `1.0` (i.e. 100%). For the best results, use a power-of-two increase or decrease, e.g. `0.125` (1/8), `0.25` (1/4), or `0.5` (1/2). Scaling factors that result in odd widths and height generally result in a blurry image, as do scales over 100%. (For most effect sprites, this will not be an issue as they are not very detailed anyway.)

-## Animation parameters
+## Ship Sprite Animation
+Ships can have sprites for several different states of flight: Flying, Firing, Landing, Launching, Jumping, Disabled. Each state can be assigned a sprite similar to the above naming convention, but the tag will be different, as shown below:


Suggested change

Ships can have sprites for several different states of flight: Flying, Firing, Landing, Launching, Jumping, Disabled. Each state can be assigned a sprite similar to the above naming convention, but the tag will be different, as shown below:

Ships can have sprites for several different states of flight: Flying, Firing, Landing, Launching, Jumping, and Disabled. Each state can be assigned a sprite similar to the above naming convention, but the tag will be different, as shown below:

TheGiraffe3 · 2024-08-09T05:12:17Z

wiki/SpriteData.md

 * `"frame rate" <fps#>`: frames per second. If no value is provided, a frame rate of 2 will be used.
 * `"frame time" <number#>`: alternative to "frame rate". Specifies the number of game ticks (60 per second) each frame of the animation should last for.
 * `"delay" <number#>`: number of animation frames to delay in between loops of the animation. For example, a four-frame animation with a delay of 4 and a frame rate of 8 FPS will play the animation for half a second, then pause for half a second, then repeat.
 * `"start frame" <number#>`: start at this frame of the animation.
 * `"random start frame"`: start at a random frame of the animation.
 * `"no repeat"`: once the animation has played through once, stay on the last frame until the effect disappears. If this is not defined, the animation loops.
 * `"rewind"`: once the animation has played through to the last frame, play it in reverse. If `"no repeat"` is also defined, the animation will play forward once, then backward once, then stop at the first frame.
+* `"ramp" <up fpsps#> <down fpsps#> `: when the object enters (or exit) a certain state, this allows the frame rate to ramp up (or down) according to the values given in up fpsps (fps per second) and down fpsps.


Suggested change

* `"ramp" <up fpsps#> <down fpsps#> `: when the object enters (or exit) a certain state, this allows the frame rate to ramp up (or down) according to the values given in up fpsps (fps per second) and down fpsps.

* `"ramp" <up fpsps#> <down fpsps#>`: when the object enters (or exit) a certain state, this allows the frame rate to ramp up (or down) according to the values given in up fpsps (fps per second) and down fpsps.

TheGiraffe3 · 2024-08-09T05:13:05Z

wiki/SpriteData.md

+
+#### Parameters for Ship Sprites only
+* `"transition delay" <number#>`: if a ship has requested a transition to a different state, i.e. FIRING to FLYING, wait for a certain number of frames before allowing that transition to occur. This would be used in places where there could be rapid state transitions. For example, if a ship has fired its primary weapon, chances are it might fire its primary weapon again, so instead of immediately transitioning to the flying state, we can wait in the firing state for a certain number of frames before entering the flying state again.
+* `"transition type" <type>`: currently, three transistion types are supported: "immediate", "finish" and "rewind". The default value is set to "immediate", meaning that if a ship changes state e.g. from FIRING to FLYING, the currently used sprite would immediately switch from the FIRING sprite to the FLYING sprite. If it is "finish", the ship will first finish the FIRING animation, up until the last frame, before switching the state to FLYING. And if it is "rewind", the ship will rewind to the first frame of the animation from whichever frame it is on currently before completing the transition to FLYING.


Suggested change

* `"transition type" <type>`: currently, three transistion types are supported: "immediate", "finish" and "rewind". The default value is set to "immediate", meaning that if a ship changes state e.g. from FIRING to FLYING, the currently used sprite would immediately switch from the FIRING sprite to the FLYING sprite. If it is "finish", the ship will first finish the FIRING animation, up until the last frame, before switching the state to FLYING. And if it is "rewind", the ship will rewind to the first frame of the animation from whichever frame it is on currently before completing the transition to FLYING.

* `"transition type" <type>`: currently, three transistion types are supported: "immediate," "finish," and "rewind." The default value is set to "immediate," meaning that if a ship changes state e.g. from FIRING to FLYING, the currently used sprite would immediately switch from the FIRING sprite to the FLYING sprite. If it is "finish," the ship will first finish the FIRING animation, up until the last frame, before switching the state to FLYING. And if it is "rewind," the ship will rewind to the first frame of the animation from whichever frame it is on currently before completing the transition to FLYING.

TheGiraffe3 · 2024-08-09T05:13:33Z

wiki/SpriteData.md

+#### Parameters for Ship Sprites only
+* `"transition delay" <number#>`: if a ship has requested a transition to a different state, i.e. FIRING to FLYING, wait for a certain number of frames before allowing that transition to occur. This would be used in places where there could be rapid state transitions. For example, if a ship has fired its primary weapon, chances are it might fire its primary weapon again, so instead of immediately transitioning to the flying state, we can wait in the firing state for a certain number of frames before entering the flying state again.
+* `"transition type" <type>`: currently, three transistion types are supported: "immediate", "finish" and "rewind". The default value is set to "immediate", meaning that if a ship changes state e.g. from FIRING to FLYING, the currently used sprite would immediately switch from the FIRING sprite to the FLYING sprite. If it is "finish", the ship will first finish the FIRING animation, up until the last frame, before switching the state to FLYING. And if it is "rewind", the ship will rewind to the first frame of the animation from whichever frame it is on currently before completing the transition to FLYING.
+* `"indicate" [<frame#>]`: applying this parameter to your sprite animation means that it must complete the animation before performing the desired action e.g. if you are trying to fire your primary weapon, the animation must reach the desired frame (optional parameter) before the weapons can actually be fired. If the frame number is not given, it will default to the last frame of the animation. This keyword also sets the `"repeat"` flag to false, and forces the animation to start at the zeroth frame.


Suggested change

* `"indicate" [<frame#>]`: applying this parameter to your sprite animation means that it must complete the animation before performing the desired action e.g. if you are trying to fire your primary weapon, the animation must reach the desired frame (optional parameter) before the weapons can actually be fired. If the frame number is not given, it will default to the last frame of the animation. This keyword also sets the `"repeat"` flag to false, and forces the animation to start at the zeroth frame.

* `"indicate" [<frame#>]`: applying this parameter to your sprite animation means that it must complete the animation before performing the desired action, e.g. if you are trying to fire your primary weapon, the animation must reach the desired frame (optional parameter) before the weapons can actually be fired. If the frame number is not given, it will default to the last frame of the animation. This keyword also sets the `"repeat"` flag to false, and forces the animation to start at the zeroth frame.

TheGiraffe3 · 2024-08-09T05:14:04Z

wiki/SpriteData.md

+		has "outfit (installed): <outfit-name>"
+```
+
+There are several preliminary conditions that have been implemented, more to come as they are required:


Suggested change

There are several preliminary conditions that have been implemented, more to come as they are required:

There are several preliminary conditions that have been implemented, with more to come as they are requested:

TheGiraffe3 · 2024-08-09T05:14:18Z

wiki/SpriteData.md

+```
+
+There are several preliminary conditions that have been implemented, more to come as they are required:
+* `"hull"`: Gives the amount of hull currently on the ship


Suggested change

* `"hull"`: Gives the amount of hull currently on the ship

* `"hull"`: Gives the amount of hull currently on the ship.

Others as well?

TheGiraffe3 · 2024-08-09T05:14:50Z

wiki/SpriteData.md

+* `"hull"`: Gives the amount of hull currently on the ship
+* `"shields"`: Gives the amount of shields currently on the ship
+* `"outfit (installed): <outfit-name>"`: Checks whether the outfit is currently installed on the ship
+* `"jump (type): <jump-type>"`: Either "jump" or "hyper", checks whether the next jump is a jump drive jump, or a hyper drive jump.


What if the player doesn't have it mapped yet?

TheGiraffe3 · 2024-08-09T05:15:13Z

wiki/SpriteData.md

+* `"jump (type): <jump-type>"`: Either "jump" or "hyper", checks whether the next jump is a jump drive jump, or a hyper drive jump.
+* `"weapon (firing): <outfit-name>"`: Checks whether the currently equipped outfit/weapon is firing or not.
+
+Trigger sprites are independently animated, meaning that if you want the trigger sprite to have a frame rate of 30, and the default state sprite to also have the same frame rate, both of them would independently need to have the `"frame rate"` parameter defined. This is done in order to make saving trigger sprite animation info more streamlined.


Suggested change

Trigger sprites are independently animated, meaning that if you want the trigger sprite to have a frame rate of 30, and the default state sprite to also have the same frame rate, both of them would independently need to have the `"frame rate"` parameter defined. This is done in order to make saving trigger sprite animation info more streamlined.

Trigger sprites are independently animated, meaning that if you want the trigger sprite to have a frame rate of 30, and the default state sprite to also have the same frame rate, both of them would independently need to have the `"frame rate"` parameter defined. This is done in order to make saving trigger sprite animation info more streamlined.

TheGiraffe3 · 2024-08-09T05:15:47Z

wiki/SpriteData.md

+Doing a run through of the above animation definition:
+
+1. The flying sprite will play at a frame rate of 5.
+1. The firing sprite will ramp up at 20 fps per second until a frame rate of 20. The ship will not be allowed to fire until the last frame of the firing sprite is reached (indicate). Once the ship has stopped firing for 100 frames (transition delay), the animation will rewind until the first frame before transitioning states again.


What happened to successive numbering?

TheGiraffe3 · 2024-09-18T17:05:36Z

wiki/SpriteData.md

+
+#### Parameters for Ship Sprites only
+* `"transition delay" <number#>`: if a ship has requested a transition to a different state, i.e. FIRING to FLYING, wait for a certain number of frames before allowing that transition to occur. This would be used in places where there could be rapid state transitions. For example, if a ship has fired its primary weapon, chances are it might fire its primary weapon again, so instead of immediately transitioning to the flying state, we can wait in the firing state for a certain number of frames before entering the flying state again.
+* `"transition type" <type>`: currently, three transistion types are supported: "immediate", "finish" and "rewind". The default value is set to "immediate", meaning that if a ship changes state e.g. from FIRING to FLYING, the currently used sprite would immediately switch from the FIRING sprite to the FLYING sprite. If it is "finish", the ship will first finish the FIRING animation, up until the last frame, before switching the state to FLYING. And if it is "rewind", the ship will rewind to the first frame of the animation from whichever frame it is on currently before completing the transition to FLYING.


Suggested change

* `"transition type" <type>`: currently, three transistion types are supported: "immediate", "finish" and "rewind". The default value is set to "immediate", meaning that if a ship changes state e.g. from FIRING to FLYING, the currently used sprite would immediately switch from the FIRING sprite to the FLYING sprite. If it is "finish", the ship will first finish the FIRING animation, up until the last frame, before switching the state to FLYING. And if it is "rewind", the ship will rewind to the first frame of the animation from whichever frame it is on currently before completing the transition to FLYING.

* `"transition type" <type>`: currently, three transition types are supported: "immediate", "finish" and "rewind". The default value is set to "immediate", meaning that if a ship changes state e.g. from FIRING to FLYING, the currently used sprite would immediately switch from the FIRING sprite to the FLYING sprite. If it is "finish", the ship will first finish the FIRING animation, up until the last frame, before switching the state to FLYING. And if it is "rewind", the ship will rewind to the first frame of the animation from whichever frame it is on currently before completing the transition to FLYING.

tibetiroka and others added 10 commits June 23, 2024 13:47

things

0c9eeeb

mh

e8192ac

Update CreatingMissions.md

8441532

Update wiki/CreatingMissions.md

7a46982

Co-authored-by: Loymdayddaud <[email protected]>

Update wiki/MapData.md

102b8a5

Co-authored-by: Loymdayddaud <[email protected]>

"can trigger after failure" node for mission triggers (endless-sky#22)

56ce398

Wiki update for 10046

Update to display usage in dialogs and planet descriptions (endless…

290a3af

…-sky#20)

Include default values of planetary "bribe" and tribute threshold in …

09ebef1

…MapData (endless-sky#25)

Add changes for sprite animation

9fa6d59

Update wiki with new parameter data

cd5b5bb

tibetiroka reviewed Jul 27, 2024

View reviewed changes

wiki/SpriteData.md Outdated Show resolved Hide resolved

wiki/SpriteData.md Outdated Show resolved Hide resolved

Clarifications for transition and indicate update

c7505a1

XessWaffle mentioned this pull request Jul 29, 2024

feat(enhancement): Situation based Ship Animations Refactored endless-sky/endless-sky#10348

Open

14 tasks

warp-core added the enhancement Adding documentation about a new feature being PR'd to endless-sky/endless-sky label Jul 30, 2024

TheGiraffe3 suggested changes Aug 9, 2024

View reviewed changes

warp-core force-pushed the master branch from b01866c to d9bb621 Compare August 12, 2024 14:13

Merge branch 'master' into master

ff068e2

TheGiraffe3 suggested changes Sep 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Situation Based Ship Animations Wiki Update #31

Situation Based Ship Animations Wiki Update #31

XessWaffle commented Jul 25, 2024

TheGiraffe3 Aug 9, 2024

TheGiraffe3 Aug 9, 2024

TheGiraffe3 Aug 9, 2024

TheGiraffe3 Aug 9, 2024

TheGiraffe3 Aug 9, 2024

TheGiraffe3 Aug 9, 2024

TheGiraffe3 Aug 9, 2024

TheGiraffe3 Aug 9, 2024

TheGiraffe3 Aug 9, 2024

TheGiraffe3 Sep 18, 2024

	Ships can have sprites for several different states of flight: Flying, Firing, Landing, Launching, Jumping, Disabled. Each state can be assigned a sprite similar to the above naming convention, but the tag will be different, as shown below:
	Ships can have sprites for several different states of flight: Flying, Firing, Landing, Launching, Jumping, and Disabled. Each state can be assigned a sprite similar to the above naming convention, but the tag will be different, as shown below:

	* `"ramp" <up fpsps#> <down fpsps#> `: when the object enters (or exit) a certain state, this allows the frame rate to ramp up (or down) according to the values given in up fpsps (fps per second) and down fpsps.
	* `"ramp" <up fpsps#> <down fpsps#>`: when the object enters (or exit) a certain state, this allows the frame rate to ramp up (or down) according to the values given in up fpsps (fps per second) and down fpsps.

	There are several preliminary conditions that have been implemented, more to come as they are required:
	There are several preliminary conditions that have been implemented, with more to come as they are requested:

	* `"hull"`: Gives the amount of hull currently on the ship
	* `"hull"`: Gives the amount of hull currently on the ship.

	Trigger sprites are independently animated, meaning that if you want the trigger sprite to have a frame rate of 30, and the default state sprite to also have the same frame rate, both of them would independently need to have the `"frame rate"` parameter defined. This is done in order to make saving trigger sprite animation info more streamlined.
	Trigger sprites are independently animated, meaning that if you want the trigger sprite to have a frame rate of 30, and the default state sprite to also have the same frame rate, both of them would independently need to have the `"frame rate"` parameter defined. This is done in order to make saving trigger sprite animation info more streamlined.

Situation Based Ship Animations Wiki Update #31

Are you sure you want to change the base?

Situation Based Ship Animations Wiki Update #31

Conversation

XessWaffle commented Jul 25, 2024

Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment