Difference between revisions of "ShowPerkVaultBoyOnHUD - Game"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Gurgate
m
imported>Qazaaq
(Shouldn't be using double back-slashes, needs to be single slashes (*nix style paths))
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Non-Delayed Native Functions]]
'''Member of:''' [[Game Script]]
'''Member of:''' [[Game Script]]


Plays the specified Perk VaultBoy Swf and sound on the HUD.
Plays the specified [[Perk]] VaultBoy [[Flash File]] and sound on the HUD menu.
 
== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">
Function ShowPerkVaultBoyOnHUD(string aVaultBoySwf, Sound aSoundDescriptor = None) native global
Function ShowPerkVaultBoyOnHUD(string aVaultBoySwf, Sound aSoundDescriptor = None) Native Global
</source>
</source>


== Parameters ==
== Parameters ==
*aVaultBoySwf: the name of the swf file to play. Should end with ".swf"
*aVaultBoySwf: The interface path to a [[Flash File]] to play. Should include the <code>.swf</code> file extension.
*aSoundDescriptor: the sound that goes along with the animation.
*aSoundDescriptor: the sound that goes along with the animation.
**'''Default''': None
**'''Default''': None
Line 21: Line 19:
<source lang="papyrus">
<source lang="papyrus">
; We've triggered the Idiot Savant perk!
; We've triggered the Idiot Savant perk!
Game.ShowPerkVaultBoyOnHUD("Components\\VaultBoys\\Perks\\PerkClip_1d245e.swf", perkSound)
Game.ShowPerkVaultBoyOnHUD("Components/VaultBoys/Perks/PerkClip_1d245e.swf", perkSound)
</source>
</source>


== Notes ==
== 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.
* 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.


== See Also ==
== See Also ==
*[[Game Script]]
*[[Game Script]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Non-Delayed Native Functions]]
[[Category:User Interface]]

Latest revision as of 23:07, 12 May 2018

Member of: Game Script

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

Syntax[edit | edit source]

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

Parameters[edit | edit source]

  • 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[edit | edit source]

None

Examples[edit | edit source]

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

Notes[edit | edit source]

  • 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.

See Also[edit | edit source]