Difference between revisions of "PlayBink - Game"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jlundin
(Created page with ''''Member of:''' Game Script Plays the specified bink file. == Syntax == <source lang="papyrus"> Function PlayBink(string asFileName, bool abInterruptible = false, bool abM…')
 
 
Line 36: Line 36:
== Notes ==
== Notes ==
When the movie is playing, the game (including Papyrus) is completely frozen, so use with care. It will not return until the movie is over, or the user has canceled the movie.
When the movie is playing, the game (including Papyrus) is completely frozen, so use with care. It will not return until the movie is over, or the user has canceled the movie.
On platform ORBIS(PS4), this function is broken and crashes the game with a ASYNC failure.


== See Also ==
== See Also ==

Latest revision as of 17:58, 4 December 2021

Member of: Game Script

Plays the specified bink file.

Syntax[edit | edit source]

Function PlayBink(string asFileName, bool abInterruptible = false, bool abMuteAudio = true, bool abMuteMusic = true, \
  bool abLetterbox = true) native global

Parameters[edit | edit source]

  • asFileName: The bink file to play
  • abInterruptible: Is the movie interruptable?
    • Default: False
  • abMuteAudio: Should the normal game audio be muted?
    • Default: True
  • abMuteMusic: Should the game music be muted?
    • Default: True
  • abLetterbox: Should the movie be letterboxed, if necessary?
    • Default: True

Return Value[edit | edit source]

None.

Examples[edit | edit source]

; Play the cool movie
Game.PlayBink("CoolMovie.bik")


; Play the cool movie, but allow it to be interrupted
Game.PlayBink("CoolMovie.bik", true)

Notes[edit | edit source]

When the movie is playing, the game (including Papyrus) is completely frozen, so use with care. It will not return until the movie is over, or the user has canceled the movie.

On platform ORBIS(PS4), this function is broken and crashes the game with a ASYNC failure.

See Also[edit | edit source]