[Documentation] Flash messages in BattleScape for scripts

[memmaker]

Enables scripts to communicate strings with integer values back to the user using the battlescape warning text feature.

Example usage, display hit information:

Code: [Select]

extended:
  scripts:
    damageUnit:
      - offset: 99
        code: |
          if gt to_health 0;
            battle_game.flashMessage "STR_DAMAGE_DEALT" to_health to_armor;
          end;
          return;

extraStrings:
  - type: en-US
    strings:
      STR_DAMAGE_DEALT: "HP: {0} / Armor: {1}"


[ohartenstein23]

This and the other additions to scripting you've been documenting look like useful extensions. Makes me wish I had more time to write some mod features that use them, keep it up!

[Nord]

This can be used to indicate shield strength.

[Solarius Scorch]

This can be used to indicate shield strength.

Good point. Well, I would only display something like "Their shields are holding!", but it's still an important indicator.

[Yankes]

Headshot!

Only correct usage of this new feature

[ohartenstein23]

Only correct usage of this new feature

Not true, there's one more:

[Finnik]

Not true, there's one more:

if that would be possible I would be SO happy!

[ohartenstein23]

Those aren't edited clips, that's a mod I made using scripts: https://openxcom.mod.io/death-splash-messages

The flash messages would make it a lot easier to do this and lets you do longer messages.

[Nord]

So for anyone who tired of unknown shields strength:

Code: [Select]

#YANKES SCRIPT
          # Make the unit flash a color to denote shield was hit
          if and gt temp 0 eq power 0; # But only if shield is left over
           
            battle_game.flashMessage "STR_SHIELD" temp; #THIS IS NEW

            battle_game.getAnimFrame temp;
            unit.setTag Tag.UNIT_RECOLOR_START_FRAME temp;
            unit.setTag Tag.UNIT_RECOLOR_FRAME_LENGTH 3;

            armorRuleset.getTag temp Tag.ARMOR_ENERGY_SHIELD_FLASH_COLOR;
            if eq temp 0;
              set temp COLOR_X1_BLUE1; # Default color is bright blue
            end;
            unit.setTag Tag.UNIT_RECOLOR_COLOR temp;
          else; #AND THIS IS NEW
            battle_game.flashMessage "STR_SHIELD_DOWN"; #Display that shield breached #AND THIS
          end;

[Finnik]

OK, I looked at replacing a unit sprite with a message and i think i would like to see something else for my XCF flashbangs - more like vanilla bleeding icon. Replacing unit sprite looks too brutal to me...

[Solarius Scorch]

Next step: whenever an agent dies, this song plays

[Finnik]

Next step: whenever an agent dies, this song plays

you can always change death sound)))

[Solarius Scorch]

you can always change death sound)))

Sure, but no proper scream kinda kils the mood...