ShowPerkVaultBoyOnHUD - Game

Member of: Game Script

Plays the specified Perk VaultBoy Flash File and sound on the HUD menu.

Syntax

Function ShowPerkVaultBoyOnHUD(string aVaultBoySwf, Sound aSoundDescriptor = None) Native Global

Parameters

• aVaultBoySwf: The interface path to a Flash File to play. Should include the .swf file extension.
• aSoundDescriptor: the sound that goes along with the animation.
  • Default: None

Return Value

None

Examples

; We've triggered the Idiot Savant perk!
Game.ShowPerkVaultBoyOnHUD("Components/VaultBoys/Perks/PerkClip_1d245e.swf", perkSound)

Notes

• SWFs used this way do not seem to support all the features that can be used elsewhere. For example, an SWF which has its frames made out of PNGs with alpha blending will display as a solid colour, even though the same SWF will display just fine in the PipBoy perk screen. One quick solution for this is to use the Trace Bitmap feature in Flash and generate a separate SWF for use in the HUD, but it will result in jagged edges.

• The animated icon when displayed, resizes itself on HUD based on the boundaries of the first frame of the animation. This means if you have an animation that has very small boundaries on first frame, but grows larger in later frames, your icon will likely exceed the boundaries of the bottom HUD menu and clip with other UI features. To avoid this, create a shape in the first frame that has an alpha of 0, and has roughly the same bounds as a base game icon.

See Also

• Game Script