diff --git a/CREDITS.md b/CREDITS.md index 59f87352c..537673166 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -130,6 +130,7 @@ This page lists all the individual contributions to the project by their author. - Implement various controls to customise target lasers line. - Implement various controls to show and customise NavCom queue lines. - Implement customizable mouse cursors and actions. + - Implement a feature for animations to spawn additional animations. - **Kerbiter (Metadorius)**: - Initial documentation setup. - **MarkJFox**: @@ -206,4 +207,5 @@ This page lists all the individual contributions to the project by their author. - Implement required and forbidden houses. - Allow turning off "sticky" technologies. - Allow disabling the ActLike check on construction yards to allow for faction-specific MCVs. + - Finalize the feature for animations to spawn additional animations. diff --git a/docs/New-Features-and-Enhancements.md b/docs/New-Features-and-Enhancements.md index aaa75ab3e..0e822ea89 100644 --- a/docs/New-Features-and-Enhancements.md +++ b/docs/New-Features-and-Enhancements.md @@ -22,10 +22,34 @@ In `RULES.INI`: ```ini [SOMEAIRCRAFT] ; AircraftType ReloadRate= ; float, the rate that this aircraft will reload its ammo when docked with a helipad. Defaults to [General]->ReloadRate. -``` + ## Animations +### Additional Animation Spawning + +- Vinifera implements a new system for AnimTypes, allowing them to spawn additional animations at the start, middle and end of their sequence stages. All animations spawned will be from the center coordinate of the animation spawning these additional animations. + +```{note} +The `` keyword used below can be replaced with: `Start`, `Middle`, `End`. +``` +In `RULES.INI`: +```ini +[AnimType] ; AnimType +Anims= ; list of AnimTypes, list of animations to spawn at the designated stage of the animation sequence. +AnimsMinimum= ; list of integers, the minimum number of animations that can spawn when choosing the random amount for each of the respective entries on the animations list. This list must have the same number of entries as the animations list. Defaults to 1 for each entry. +AnimsMaximum= ; list of integers, the maximum number of animations that can spawn when choosing the random amount for each of the respective entries on the animations list. This list must have the same number of entries as the animations list. Defaults to 1 for each entry. +AnimsCount= ; list of integers, the number of animations to spawn for each of the respective entries on the animations list. This list must have the same number of entries as the animations list. Defaults to 1 for each entry, and takes priority over the Minimum and Maximum entries. +``` + +- In addition to this new system, a new key for setting the logical middle frame (the frame in which the craters etc, are spawned) can now be set. + +In `RULES.INI`: +```ini +[AnimType] ; AnimType +MiddleFrame= ; integer, the frame number in which the animation system will spawn various logics (e.g. craters, scorch marks, fires). Defaults to auto-detect based on the largest frame of the shape file. A special value of -1 can be used to tell the animation system to use the exact middle frame of the shape file (shape file has 30 frames, frame 15 will be used). +``` + ### Various Keys Ported from Red Alert 2 - Vinifera implements various AnimType keys from Red Alert 2. diff --git a/docs/Whats-New.md b/docs/Whats-New.md index c1f4d9e33..bf264ce05 100644 --- a/docs/Whats-New.md +++ b/docs/Whats-New.md @@ -166,6 +166,7 @@ New: - Implement required and forbidden houses (by ZivDero) - Allow turning off "sticky" technologies (by ZivDero) - Allow disabling the ActLike check on construction yards to allow for faction-specific MCVs (by ZivDero) +- Implement a feature for animations to spawn additional animations (by CCHyper/tomsons26, ZivDero) Vanilla fixes: