diff --git a/docs/xml/bombcostumes.md b/docs/xml/bombcostumes.md index 3af49d74b..35125d54d 100644 --- a/docs/xml/bombcostumes.md +++ b/docs/xml/bombcostumes.md @@ -1,31 +1,50 @@ # File "bombcostumes.xml" [ ](#){: .rep .tooltip .badge } -This page needs some content. You can contribute to it using the Edit Button! +Used to apply costumes to bomb relative to their TearFlags. -**Resource-Folder**{: .xmlInfo }: Using this file in a resource folder of a mod is not tested yet. +**Resource-Folder**{: .xmlInfo .red}: Using this file in a resource folder of a mod will replace the original file. -**Content-Folder**{: .xmlInfo }: Using this file in a content folder of a mod is not tested yet. +**Content-Folder**{: .xmlInfo .green}: Using this file in a content folder of a mod will add new bomb costumes. ## "bomb" Tag | Variable-Name | Possible Values | Description | |:--|:--|:--| -|variant|int|| +|variant|int|[BombVariant](../enums/BombVariant.md) for which the costumes should be applied| ## "rule" Tag -| Variable-Name | Possible Values | Description | -|:--|:--|:--| -|includeFlags|int|All TearFlag bits required to be resent for layer to be added| -|excludeFlags|int|All TearFlag bits required to be absent for layer to be added| -|back|string|path to the anm2 file, relative to the given anm2root. Example: `flame.anm2`| -|body|string|path to the anm2 file, relative to the given anm2root. Example: `bomb.anm2`| -|body2|string|path to the anm2 file, relative to the given anm2root. Example: `homing.anm2`| -|front|string|path to the anm2 file, relative to the given anm2root. Example: `tears_blood.anm2`| -|front2|string|path to the anm2 file, relative to the given anm2root. Example: `fast.anm2`| -|overlay|string|path to the anm2 file, relative to the given anm2root. Example: `glitter_sparkle.anm2`| -|suffix|string|suffix to be added at the end of a filepath, before `.anm2` (Usage currently unknown, only presumed)| -|suffix2|string|suffix to be added at the end of a filepath, after `suffix` and before `.anm2`. Example: `_gold`| +???- info ".anm2 files" + For every .anm2-file specified you need to create 4 .anm2-files, one for every bomb size: + mini-bomb from Scatter Bombs, mini-bomb from Scatter Bombs with Mr. Mega, normal size bomb and Mr. Mega-size bomb + For example, when you specify `bomb.anm2`, you actually require the files `bomb0.anm2`, `bomb1.anm2`, `bomb2.anm2` and `bomb3.anm2`. +???- info "Rule precedence" + The rules you include in this file will be listed after the default rules of the respective variant. Bomb costumes will be applied from the tags within these rules (i.e. `body`, `front`, etc.) + The tag of the last applicable rule that has it will always be the one to be applied. + Example: Having the Items Blood Bombs and Bomber Boy will cause placed bombs to look like Blood bombs, as both rules specify the tag `body` and the rule for Blood Bombs is listed below the rule for Bomber Boy. +| Variable-Name | Possible Values | Description | +|:--|:--|:--| +|includeFlags|int|All [TearFlag bits](../enums/TearFlags.md) required to be resent for layer to be added (seperate with spaces)| +|excludeFlags|int|All [TearFlag bits](../enums/TearFlags.md) required to be absent for layer to be added (seperate with spaces)| +|back|string|path to the .anm2 files, relative to the given anm2root, that will be displayed behind the bomb. Example: `flame.anm2`| +|body|string|path to the .anm2 files, relative to the given anm2root, that will replace the main bomb sprite. Example: `bomb.anm2`| +|body2|string|path to the .anm2 file, relative to the given anm2root, that will be displayed along the main bomb sprite. Example: `homing.anm2`| +|front|string|path to the .anm2 file, relative to the given anm2root, that will be applied on top of the main bomb sprite. Example: `tears_blood.anm2`| +|front2|string|path to the .anm2 file, relative to the given anm2root, that will be applied on top of the main bomb sprite. Example: `fast.anm2`
Use this when you don't want an already applied `front`-animation to be overriden.| +|overlay|string|path to the .anm2 file, relative to the given anm2root, that will be displayed on top of the entire bomb. Example: `glitter_sparkle.anm2`| +|suffix|string|suffix to be added at the end of an image-filepath, before `.png`, that will replace the spritesheet-image associated with LayerID 0
Example: `_gold` will replace the spritesheet-image `bomb.png` with `bomb_gold.png`| +|suffix2|string|suffix to be added at the end of an image-filepath, after `suffix` and before `.png`, that will replace the spritesheet-image associated with LayerID 0
Example: `_gold` will replace the spritesheet-image `bomb.png` with `bomb_gold.png`| + + +Example of a `bombcostumes.xml` file: +```xml + + + + + + +```